Chapter 3. RapidIO driver interface

Table of Contents

Functions

Drivers are provided a set of calls in order to interface with the subsystem to gather info on devices, request/map memory region resources, and manage mailboxes/doorbells.

Functions

rio_local_read_config_32 — Read 32 bits from local configuration space
rio_local_write_config_32 — Write 32 bits to local configuration space
rio_local_read_config_16 — Read 16 bits from local configuration space
rio_local_write_config_16 — Write 16 bits to local configuration space
rio_local_read_config_8 — Read 8 bits from local configuration space
rio_local_write_config_8 — Write 8 bits to local configuration space
rio_read_config_32 — Read 32 bits from configuration space
rio_write_config_32 — Write 32 bits to configuration space
rio_read_config_16 — Read 16 bits from configuration space
rio_write_config_16 — Write 16 bits to configuration space
rio_read_config_8 — Read 8 bits from configuration space
rio_write_config_8 — Write 8 bits to configuration space
rio_send_doorbell — Send a doorbell message to a device
rio_init_mbox_res — Initialize a RIO mailbox resource
rio_init_dbell_res — Initialize a RIO doorbell resource
RIO_DEVICE — macro used to describe a specific RIO device
rio_add_outb_message — Add RIO message to an outbound mailbox queue
rio_add_inb_buffer — Add buffer to an inbound mailbox queue
rio_get_inb_message — Get A RIO message from an inbound mailbox queue
rio_name — Get the unique RIO device identifier
rio_get_drvdata — Get RIO driver specific data
rio_set_drvdata — Set RIO driver specific data
rio_dev_get — Increments the reference count of the RIO device structure
rio_dev_put — Release a use of the RIO device structure
rio_register_driver — register a new RIO driver
rio_unregister_driver — unregister a RIO driver
rio_local_get_device_id — Get the base/extended device id for a port
rio_query_mport — Query mport device attributes
rio_alloc_net — Allocate and initialize a new RIO network data structure
rio_local_set_device_id — Set the base/extended device id for a port
rio_add_device — Adds a RIO device to the device model
rio_request_inb_mbox — request inbound mailbox service
rio_release_inb_mbox — release inbound mailbox message service
rio_request_outb_mbox — request outbound mailbox service
rio_release_outb_mbox — release outbound mailbox message service
rio_request_inb_dbell — request inbound doorbell message service
rio_release_inb_dbell — release inbound doorbell message service
rio_request_outb_dbell — request outbound doorbell message range
rio_release_outb_dbell — release outbound doorbell message range
rio_add_mport_pw_handler — add port-write message handler into the list of mport specific pw handlers
rio_del_mport_pw_handler — remove port-write message handler from the list of mport specific pw handlers
rio_request_inb_pwrite — request inbound port-write message service for specific RapidIO device
rio_release_inb_pwrite — release inbound port-write message service associated with specific RapidIO device
rio_pw_enable — Enables/disables port-write handling by a master port
rio_map_inb_region — - Map inbound memory region.
rio_unmap_inb_region — - Unmap the inbound memory region
rio_map_outb_region — - Map outbound memory region.
rio_unmap_outb_region — - Unmap the inbound memory region
rio_mport_get_physefb — Helper function that returns register offset for Physical Layer Extended Features Block.
rio_get_comptag — Begin or continue searching for a RIO device by component tag
rio_set_port_lockout — Sets/clears LOCKOUT bit (RIO EM 1.3) for a switch port.
rio_enable_rx_tx_port — enable input receiver and output transmitter of given port
rio_mport_chk_dev_access — Validate access to the specified device.
rio_inb_pwrite_handler — inbound port-write message handler
rio_mport_get_efb — get pointer to next extended features block
rio_mport_get_feature — query for devices' extended features
rio_get_asm — Begin or continue searching for a RIO device by vid/did/asm_vid/asm_did
rio_get_device — Begin or continue searching for a RIO device by vid/did
rio_lock_device — Acquires host device lock for specified device
rio_unlock_device — Releases host device lock for specified device
rio_route_add_entry — Add a route entry to a switch routing table
rio_route_get_entry — Read an entry from a switch routing table
rio_route_clr_table — Clear a switch routing table
rio_request_mport_dma — request RapidIO capable DMA channel associated with specified local RapidIO mport device.
rio_request_dma — request RapidIO capable DMA channel that supports specified target RapidIO device.
rio_release_dma — release specified DMA channel
rio_dma_prep_xfer — RapidIO specific wrapper for device_prep_slave_sg callback defined by DMAENGINE.
rio_dma_prep_slave_sg — RapidIO specific wrapper for device_prep_slave_sg callback defined by DMAENGINE.
rio_register_scan — enumeration/discovery method registration interface
rio_unregister_scan — removes enumeration/discovery method from mport