]> Matt Porter

mporter@kernel.crashing.org mporter@mvista.com

2005 MontaVista Software, Inc. This documentation is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA For more details see the file COPYING in the source distribution of Linux. RapidIO is a high speed switched fabric interconnect with features aimed at the embedded market. RapidIO provides support for memory-mapped I/O as well as message-based transactions over the switched fabric network. RapidIO has a standardized discovery mechanism not unlike the PCI bus standard that allows simple detection of devices in a network. This documentation is provided for developers intending to support RapidIO on new architectures, write new drivers, or to understand the subsystem internals. None. ;) Access/management of RapidIO memory regions is not supported Multiple host enumeration is not supported 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. Kernel Hackers Manual July 2017 rio_local_read_config_32 9 4.1.27 rio_local_read_config_32 Read 32 bits from local configuration space int rio_local_read_config_32 struct rio_mport * port u32 offset u32 * data port Master port offset Offset into local configuration space data Pointer to read data into Reads 32 bits of data from the specified offset within the local device's configuration space. Kernel Hackers Manual July 2017 rio_local_write_config_32 9 4.1.27 rio_local_write_config_32 Write 32 bits to local configuration space int rio_local_write_config_32 struct rio_mport * port u32 offset u32 data port Master port offset Offset into local configuration space data Data to be written Writes 32 bits of data to the specified offset within the local device's configuration space. Kernel Hackers Manual July 2017 rio_local_read_config_16 9 4.1.27 rio_local_read_config_16 Read 16 bits from local configuration space int rio_local_read_config_16 struct rio_mport * port u32 offset u16 * data port Master port offset Offset into local configuration space data Pointer to read data into Reads 16 bits of data from the specified offset within the local device's configuration space. Kernel Hackers Manual July 2017 rio_local_write_config_16 9 4.1.27 rio_local_write_config_16 Write 16 bits to local configuration space int rio_local_write_config_16 struct rio_mport * port u32 offset u16 data port Master port offset Offset into local configuration space data Data to be written Writes 16 bits of data to the specified offset within the local device's configuration space. Kernel Hackers Manual July 2017 rio_local_read_config_8 9 4.1.27 rio_local_read_config_8 Read 8 bits from local configuration space int rio_local_read_config_8 struct rio_mport * port u32 offset u8 * data port Master port offset Offset into local configuration space data Pointer to read data into Reads 8 bits of data from the specified offset within the local device's configuration space. Kernel Hackers Manual July 2017 rio_local_write_config_8 9 4.1.27 rio_local_write_config_8 Write 8 bits to local configuration space int rio_local_write_config_8 struct rio_mport * port u32 offset u8 data port Master port offset Offset into local configuration space data Data to be written Writes 8 bits of data to the specified offset within the local device's configuration space. Kernel Hackers Manual July 2017 rio_read_config_32 9 4.1.27 rio_read_config_32 Read 32 bits from configuration space int rio_read_config_32 struct rio_dev * rdev u32 offset u32 * data rdev RIO device offset Offset into device configuration space data Pointer to read data into Reads 32 bits of data from the specified offset within the RIO device's configuration space. Kernel Hackers Manual July 2017 rio_write_config_32 9 4.1.27 rio_write_config_32 Write 32 bits to configuration space int rio_write_config_32 struct rio_dev * rdev u32 offset u32 data rdev RIO device offset Offset into device configuration space data Data to be written Writes 32 bits of data to the specified offset within the RIO device's configuration space. Kernel Hackers Manual July 2017 rio_read_config_16 9 4.1.27 rio_read_config_16 Read 16 bits from configuration space int rio_read_config_16 struct rio_dev * rdev u32 offset u16 * data rdev RIO device offset Offset into device configuration space data Pointer to read data into Reads 16 bits of data from the specified offset within the RIO device's configuration space. Kernel Hackers Manual July 2017 rio_write_config_16 9 4.1.27 rio_write_config_16 Write 16 bits to configuration space int rio_write_config_16 struct rio_dev * rdev u32 offset u16 data rdev RIO device offset Offset into device configuration space data Data to be written Writes 16 bits of data to the specified offset within the RIO device's configuration space. Kernel Hackers Manual July 2017 rio_read_config_8 9 4.1.27 rio_read_config_8 Read 8 bits from configuration space int rio_read_config_8 struct rio_dev * rdev u32 offset u8 * data rdev RIO device offset Offset into device configuration space data Pointer to read data into Reads 8 bits of data from the specified offset within the RIO device's configuration space. Kernel Hackers Manual July 2017 rio_write_config_8 9 4.1.27 rio_write_config_8 Write 8 bits to configuration space int rio_write_config_8 struct rio_dev * rdev u32 offset u8 data rdev RIO device offset Offset into device configuration space data Data to be written Writes 8 bits of data to the specified offset within the RIO device's configuration space. Kernel Hackers Manual July 2017 rio_send_doorbell 9 4.1.27 rio_send_doorbell Send a doorbell message to a device int rio_send_doorbell struct rio_dev * rdev u16 data rdev RIO device data Doorbell message data Send a doorbell message to a RIO device. The doorbell message has a 16-bit info field provided by the data argument. Kernel Hackers Manual July 2017 rio_init_mbox_res 9 4.1.27 rio_init_mbox_res Initialize a RIO mailbox resource void rio_init_mbox_res struct resource * res int start int end res resource struct start start of mailbox range end end of mailbox range This function is used to initialize the fields of a resource for use as a mailbox resource. It initializes a range of mailboxes using the start and end arguments. Kernel Hackers Manual July 2017 rio_init_dbell_res 9 4.1.27 rio_init_dbell_res Initialize a RIO doorbell resource void rio_init_dbell_res struct resource * res u16 start u16 end res resource struct start start of doorbell range end end of doorbell range This function is used to initialize the fields of a resource for use as a doorbell resource. It initializes a range of doorbell messages using the start and end arguments. Kernel Hackers Manual July 2017 RIO_DEVICE 9 4.1.27 RIO_DEVICE macro used to describe a specific RIO device RIO_DEVICE dev ven dev the 16 bit RIO device ID ven the 16 bit RIO vendor ID This macro is used to create a struct rio_device_id that matches a specific device. The assembly vendor and assembly device fields will be set to RIO_ANY_ID. Kernel Hackers Manual July 2017 rio_add_outb_message 9 4.1.27 rio_add_outb_message Add RIO message to an outbound mailbox queue int rio_add_outb_message struct rio_mport * mport struct rio_dev * rdev int mbox void * buffer size_t len mport RIO master port containing the outbound queue rdev RIO device the message is be sent to mbox The outbound mailbox queue buffer Pointer to the message buffer len Length of the message buffer Adds a RIO message buffer to an outbound mailbox queue for transmission. Returns 0 on success. Kernel Hackers Manual July 2017 rio_add_inb_buffer 9 4.1.27 rio_add_inb_buffer Add buffer to an inbound mailbox queue int rio_add_inb_buffer struct rio_mport * mport int mbox void * buffer mport Master port containing the inbound mailbox mbox The inbound mailbox number buffer Pointer to the message buffer Adds a buffer to an inbound mailbox queue for reception. Returns 0 on success. Kernel Hackers Manual July 2017 rio_get_inb_message 9 4.1.27 rio_get_inb_message Get A RIO message from an inbound mailbox queue void * rio_get_inb_message struct rio_mport * mport int mbox mport Master port containing the inbound mailbox mbox The inbound mailbox number Get a RIO message from an inbound mailbox queue. Returns 0 on success. Kernel Hackers Manual July 2017 rio_name 9 4.1.27 rio_name Get the unique RIO device identifier const char * rio_name struct rio_dev * rdev rdev RIO device Get the unique RIO device identifier. Returns the device identifier string. Kernel Hackers Manual July 2017 rio_get_drvdata 9 4.1.27 rio_get_drvdata Get RIO driver specific data void * rio_get_drvdata struct rio_dev * rdev rdev RIO device Get RIO driver specific data. Returns a pointer to the driver specific data. Kernel Hackers Manual July 2017 rio_set_drvdata 9 4.1.27 rio_set_drvdata Set RIO driver specific data void rio_set_drvdata struct rio_dev * rdev void * data rdev RIO device data Pointer to driver specific data Set RIO driver specific data. device struct driver data pointer is set to the data argument. Kernel Hackers Manual July 2017 rio_dev_get 9 4.1.27 rio_dev_get Increments the reference count of the RIO device structure struct rio_dev * rio_dev_get struct rio_dev * rdev rdev RIO device being referenced Each live reference to a device should be refcounted. Drivers for RIO devices should normally record such references in their probe methods, when they bind to a device, and release them by calling rio_dev_put, in their disconnect methods. Kernel Hackers Manual July 2017 rio_dev_put 9 4.1.27 rio_dev_put Release a use of the RIO device structure void rio_dev_put struct rio_dev * rdev rdev RIO device being disconnected Must be called when a user of a device is finished with it. When the last user of the device calls this function, the memory of the device is freed. Kernel Hackers Manual July 2017 rio_register_driver 9 4.1.27 rio_register_driver register a new RIO driver int rio_register_driver struct rio_driver * rdrv rdrv the RIO driver structure to register Adds a struct rio_driver to the list of registered drivers. Returns a negative value on error, otherwise 0. If no error occurred, the driver remains registered even if no device was claimed during registration. Kernel Hackers Manual July 2017 rio_unregister_driver 9 4.1.27 rio_unregister_driver unregister a RIO driver void rio_unregister_driver struct rio_driver * rdrv rdrv the RIO driver structure to unregister Deletes the struct rio_driver from the list of registered RIO drivers, gives it a chance to clean up by calling its remove function for each device it was responsible for, and marks those devices as driverless. Kernel Hackers Manual July 2017 rio_local_get_device_id 9 4.1.27 rio_local_get_device_id Get the base/extended device id for a port u16 rio_local_get_device_id struct rio_mport * port port RIO master port from which to get the deviceid Reads the base/extended device id from the local device implementing the master port. Returns the 8/16-bit device id. Kernel Hackers Manual July 2017 rio_add_device 9 4.1.27 rio_add_device Adds a RIO device to the device model int rio_add_device struct rio_dev * rdev rdev RIO device Adds the RIO device to the global device list and adds the RIO device to the RIO device list. Creates the generic sysfs nodes for an RIO device. Kernel Hackers Manual July 2017 rio_request_inb_mbox 9 4.1.27 rio_request_inb_mbox request inbound mailbox service int rio_request_inb_mbox struct rio_mport * mport void * dev_id int mbox int entries void (*minb) struct rio_mport * mport, void *dev_id, int mbox, int slot mport RIO master port from which to allocate the mailbox resource dev_id Device specific pointer to pass on event mbox Mailbox number to claim entries Number of entries in inbound mailbox queue minb Callback to execute when inbound message is received Requests ownership of an inbound mailbox resource and binds a callback function to the resource. Returns 0 on success. Kernel Hackers Manual July 2017 rio_release_inb_mbox 9 4.1.27 rio_release_inb_mbox release inbound mailbox message service int rio_release_inb_mbox struct rio_mport * mport int mbox mport RIO master port from which to release the mailbox resource mbox Mailbox number to release Releases ownership of an inbound mailbox resource. Returns 0 if the request has been satisfied. Kernel Hackers Manual July 2017 rio_request_outb_mbox 9 4.1.27 rio_request_outb_mbox request outbound mailbox service int rio_request_outb_mbox struct rio_mport * mport void * dev_id int mbox int entries void (*moutb) struct rio_mport * mport, void *dev_id, int mbox, int slot mport RIO master port from which to allocate the mailbox resource dev_id Device specific pointer to pass on event mbox Mailbox number to claim entries Number of entries in outbound mailbox queue moutb Callback to execute when outbound message is sent Requests ownership of an outbound mailbox resource and binds a callback function to the resource. Returns 0 on success. Kernel Hackers Manual July 2017 rio_release_outb_mbox 9 4.1.27 rio_release_outb_mbox release outbound mailbox message service int rio_release_outb_mbox struct rio_mport * mport int mbox mport RIO master port from which to release the mailbox resource mbox Mailbox number to release Releases ownership of an inbound mailbox resource. Returns 0 if the request has been satisfied. Kernel Hackers Manual July 2017 rio_request_inb_dbell 9 4.1.27 rio_request_inb_dbell request inbound doorbell message service int rio_request_inb_dbell struct rio_mport * mport void * dev_id u16 start u16 end void (*dinb) struct rio_mport * mport, void *dev_id, u16 src, u16 dst, u16 info mport RIO master port from which to allocate the doorbell resource dev_id Device specific pointer to pass on event start Doorbell info range start end Doorbell info range end dinb Callback to execute when doorbell is received Requests ownership of an inbound doorbell resource and binds a callback function to the resource. Returns 0 if the request has been satisfied. Kernel Hackers Manual July 2017 rio_release_inb_dbell 9 4.1.27 rio_release_inb_dbell release inbound doorbell message service int rio_release_inb_dbell struct rio_mport * mport u16 start u16 end mport RIO master port from which to release the doorbell resource start Doorbell info range start end Doorbell info range end Releases ownership of an inbound doorbell resource and removes callback from the doorbell event list. Returns 0 if the request has been satisfied. Kernel Hackers Manual July 2017 rio_request_outb_dbell 9 4.1.27 rio_request_outb_dbell request outbound doorbell message range struct resource * rio_request_outb_dbell struct rio_dev * rdev u16 start u16 end rdev RIO device from which to allocate the doorbell resource start Doorbell message range start end Doorbell message range end Requests ownership of a doorbell message range. Returns a resource if the request has been satisfied or NULL on failure. Kernel Hackers Manual July 2017 rio_release_outb_dbell 9 4.1.27 rio_release_outb_dbell release outbound doorbell message range int rio_release_outb_dbell struct rio_dev * rdev struct resource * res rdev RIO device from which to release the doorbell resource res Doorbell resource to be freed Releases ownership of a doorbell message range. Returns 0 if the request has been satisfied. Kernel Hackers Manual July 2017 rio_request_inb_pwrite 9 4.1.27 rio_request_inb_pwrite request inbound port-write message service int rio_request_inb_pwrite struct rio_dev * rdev int (*pwcback) struct rio_dev *rdev, union rio_pw_msg *msg, int step rdev RIO device to which register inbound port-write callback routine pwcback Callback routine to execute when port-write is received Binds a port-write callback function to the RapidIO device. Returns 0 if the request has been satisfied. Kernel Hackers Manual July 2017 rio_release_inb_pwrite 9 4.1.27 rio_release_inb_pwrite release inbound port-write message service int rio_release_inb_pwrite struct rio_dev * rdev rdev RIO device which registered for inbound port-write callback Removes callback from the rio_dev structure. Returns 0 if the request has been satisfied. Kernel Hackers Manual July 2017 rio_map_inb_region 9 4.1.27 rio_map_inb_region - Map inbound memory region. int rio_map_inb_region struct rio_mport * mport dma_addr_t local u64 rbase u32 size u32 rflags mport Master port. local physical address of memory region to be mapped rbase RIO base address assigned to this window size Size of the memory region rflags Flags for mapping. 0 -- Success. This function will create the mapping from RIO space to local memory. Kernel Hackers Manual July 2017 rio_unmap_inb_region 9 4.1.27 rio_unmap_inb_region - Unmap the inbound memory region void rio_unmap_inb_region struct rio_mport * mport dma_addr_t lstart mport Master port lstart physical address of memory region to be unmapped Kernel Hackers Manual July 2017 rio_mport_get_physefb 9 4.1.27 rio_mport_get_physefb Helper function that returns register offset for Physical Layer Extended Features Block. u32 rio_mport_get_physefb struct rio_mport * port int local u16 destid u8 hopcount port Master port to issue transaction local Indicate a local master port or remote device access destid Destination ID of the device hopcount Number of switch hops to the device Kernel Hackers Manual July 2017 rio_get_comptag 9 4.1.27 rio_get_comptag Begin or continue searching for a RIO device by component tag struct rio_dev * rio_get_comptag u32 comp_tag struct rio_dev * from comp_tag RIO component tag to match from Previous RIO device found in search, or NULL for new search Iterates through the list of known RIO devices. If a RIO device is found with a matching comp_tag, a pointer to its device structure is returned. Otherwise, NULL is returned. A new search is initiated by passing NULL to the from argument. Otherwise, if from is not NULL, searches continue from next device on the global list. Kernel Hackers Manual July 2017 rio_set_port_lockout 9 4.1.27 rio_set_port_lockout Sets/clears LOCKOUT bit (RIO EM 1.3) for a switch port. int rio_set_port_lockout struct rio_dev * rdev u32 pnum int lock rdev Pointer to RIO device control structure pnum Switch port number to set LOCKOUT bit lock Operation : set (=1) or clear (=0) Kernel Hackers Manual July 2017 rio_enable_rx_tx_port 9 4.1.27 rio_enable_rx_tx_port enable input receiver and output transmitter of given port int rio_enable_rx_tx_port struct rio_mport * port int local u16 destid u8 hopcount u8 port_num port Master port associated with the RIO network local local=1 select local port otherwise a far device is reached destid Destination ID of the device to check host bit hopcount Number of hops to reach the target port_num Port (-number on switch) to enable on a far end device Returns 0 or 1 from on General Control Command and Status Register (EXT_PTR+0x3C) Kernel Hackers Manual July 2017 rio_mport_chk_dev_access 9 4.1.27 rio_mport_chk_dev_access Validate access to the specified device. int rio_mport_chk_dev_access struct rio_mport * mport u16 destid u8 hopcount mport Master port to send transactions destid Device destination ID in network hopcount Number of hops into the network Kernel Hackers Manual July 2017 rio_inb_pwrite_handler 9 4.1.27 rio_inb_pwrite_handler process inbound port-write message int rio_inb_pwrite_handler union rio_pw_msg * pw_msg pw_msg pointer to inbound port-write message Processes an inbound port-write message. Returns 0 if the request has been satisfied. Kernel Hackers Manual July 2017 rio_mport_get_efb 9 4.1.27 rio_mport_get_efb get pointer to next extended features block u32 rio_mport_get_efb struct rio_mport * port int local u16 destid u8 hopcount u32 from port Master port to issue transaction local Indicate a local master port or remote device access destid Destination ID of the device hopcount Number of switch hops to the device from Offset of current Extended Feature block header (if 0 starts from ExtFeaturePtr) Kernel Hackers Manual July 2017 rio_mport_get_feature 9 4.1.27 rio_mport_get_feature query for devices' extended features u32 rio_mport_get_feature struct rio_mport * port int local u16 destid u8 hopcount int ftr port Master port to issue transaction local Indicate a local master port or remote device access destid Destination ID of the device hopcount Number of switch hops to the device ftr Extended feature code Tell if a device supports a given RapidIO capability. Returns the offset of the requested extended feature block within the device's RIO configuration space or 0 in case the device does not support it. Possible values for ftr: RIO_EFB_PAR_EP_ID LP/LVDS EP Devices RIO_EFB_PAR_EP_REC_ID LP/LVDS EP Recovery Devices RIO_EFB_PAR_EP_FREE_ID LP/LVDS EP Free Devices RIO_EFB_SER_EP_ID LP/Serial EP Devices RIO_EFB_SER_EP_REC_ID LP/Serial EP Recovery Devices RIO_EFB_SER_EP_FREE_ID LP/Serial EP Free Devices Kernel Hackers Manual July 2017 rio_get_asm 9 4.1.27 rio_get_asm Begin or continue searching for a RIO device by vid/did/asm_vid/asm_did struct rio_dev * rio_get_asm u16 vid u16 did u16 asm_vid u16 asm_did struct rio_dev * from vid RIO vid to match or RIO_ANY_ID to match all vids did RIO did to match or RIO_ANY_ID to match all dids asm_vid RIO asm_vid to match or RIO_ANY_ID to match all asm_vids asm_did RIO asm_did to match or RIO_ANY_ID to match all asm_dids from Previous RIO device found in search, or NULL for new search Iterates through the list of known RIO devices. If a RIO device is found with a matching vid, did, asm_vid, asm_did, the reference count to the device is incrememted and a pointer to its device structure is returned. Otherwise, NULL is returned. A new search is initiated by passing NULL to the from argument. Otherwise, if from is not NULL, searches continue from next device on the global list. The reference count for from is always decremented if it is not NULL. Kernel Hackers Manual July 2017 rio_get_device 9 4.1.27 rio_get_device Begin or continue searching for a RIO device by vid/did struct rio_dev * rio_get_device u16 vid u16 did struct rio_dev * from vid RIO vid to match or RIO_ANY_ID to match all vids did RIO did to match or RIO_ANY_ID to match all dids from Previous RIO device found in search, or NULL for new search Iterates through the list of known RIO devices. If a RIO device is found with a matching vid and did, the reference count to the device is incrememted and a pointer to its device structure is returned. Otherwise, NULL is returned. A new search is initiated by passing NULL to the from argument. Otherwise, if from is not NULL, searches continue from next device on the global list. The reference count for from is always decremented if it is not NULL. Kernel Hackers Manual July 2017 rio_lock_device 9 4.1.27 rio_lock_device Acquires host device lock for specified device int rio_lock_device struct rio_mport * port u16 destid u8 hopcount int wait_ms port Master port to send transaction destid Destination ID for device/switch hopcount Hopcount to reach switch wait_ms Max wait time in msec (0 = no timeout) Attepts to acquire host device lock for specified device Returns 0 if device lock acquired or EINVAL if timeout expires. Kernel Hackers Manual July 2017 rio_unlock_device 9 4.1.27 rio_unlock_device Releases host device lock for specified device int rio_unlock_device struct rio_mport * port u16 destid u8 hopcount port Master port to send transaction destid Destination ID for device/switch hopcount Hopcount to reach switch Returns 0 if device lock released or EINVAL if fails. Kernel Hackers Manual July 2017 rio_route_add_entry 9 4.1.27 rio_route_add_entry Add a route entry to a switch routing table int rio_route_add_entry struct rio_dev * rdev u16 table u16 route_destid u8 route_port int lock rdev RIO device table Routing table ID route_destid Destination ID to be routed route_port Port number to be routed lock apply a hardware lock on switch device flag (1=lock, 0=no_lock) If available calls the switch specific add_entry method to add a route entry into a switch routing table. Otherwise uses standard RT update method as defined by RapidIO specification. A specific routing table can be selected using the table argument if a switch has per port routing tables or the standard (or global) table may be used by passing RIO_GLOBAL_TABLE in table. Returns 0 on success or -EINVAL on failure. Kernel Hackers Manual July 2017 rio_route_get_entry 9 4.1.27 rio_route_get_entry Read an entry from a switch routing table int rio_route_get_entry struct rio_dev * rdev u16 table u16 route_destid u8 * route_port int lock rdev RIO device table Routing table ID route_destid Destination ID to be routed route_port Pointer to read port number into lock apply a hardware lock on switch device flag (1=lock, 0=no_lock) If available calls the switch specific get_entry method to fetch a route entry from a switch routing table. Otherwise uses standard RT read method as defined by RapidIO specification. A specific routing table can be selected using the table argument if a switch has per port routing tables or the standard (or global) table may be used by passing RIO_GLOBAL_TABLE in table. Returns 0 on success or -EINVAL on failure. Kernel Hackers Manual July 2017 rio_route_clr_table 9 4.1.27 rio_route_clr_table Clear a switch routing table int rio_route_clr_table struct rio_dev * rdev u16 table int lock rdev RIO device table Routing table ID lock apply a hardware lock on switch device flag (1=lock, 0=no_lock) If available calls the switch specific clr_table method to clear a switch routing table. Otherwise uses standard RT write method as defined by RapidIO specification. A specific routing table can be selected using the table argument if a switch has per port routing tables or the standard (or global) table may be used by passing RIO_GLOBAL_TABLE in table. Returns 0 on success or -EINVAL on failure. Kernel Hackers Manual July 2017 rio_request_mport_dma 9 4.1.27 rio_request_mport_dma request RapidIO capable DMA channel associated with specified local RapidIO mport device. struct dma_chan * rio_request_mport_dma struct rio_mport * mport mport RIO mport to perform DMA data transfers Returns pointer to allocated DMA channel or NULL if failed. Kernel Hackers Manual July 2017 rio_request_dma 9 4.1.27 rio_request_dma request RapidIO capable DMA channel that supports specified target RapidIO device. struct dma_chan * rio_request_dma struct rio_dev * rdev rdev RIO device associated with DMA transfer Returns pointer to allocated DMA channel or NULL if failed. Kernel Hackers Manual July 2017 rio_release_dma 9 4.1.27 rio_release_dma release specified DMA channel void rio_release_dma struct dma_chan * dchan dchan DMA channel to release Kernel Hackers Manual July 2017 rio_dma_prep_xfer 9 4.1.27 rio_dma_prep_xfer RapidIO specific wrapper for device_prep_slave_sg callback defined by DMAENGINE. struct dma_async_tx_descriptor * rio_dma_prep_xfer struct dma_chan * dchan u16 destid struct rio_dma_data * data enum dma_transfer_direction direction unsigned long flags dchan DMA channel to configure destid target RapidIO device destination ID data RIO specific data descriptor direction DMA data transfer direction (TO or FROM the device) flags dmaengine defined flags Initializes RapidIO capable DMA channel for the specified data transfer. Uses DMA channel private extension to pass information related to remote target RIO device. Returns pointer to DMA transaction descriptor or NULL if failed. Kernel Hackers Manual July 2017 rio_dma_prep_slave_sg 9 4.1.27 rio_dma_prep_slave_sg RapidIO specific wrapper for device_prep_slave_sg callback defined by DMAENGINE. struct dma_async_tx_descriptor * rio_dma_prep_slave_sg struct rio_dev * rdev struct dma_chan * dchan struct rio_dma_data * data enum dma_transfer_direction direction unsigned long flags rdev RIO device control structure dchan DMA channel to configure data RIO specific data descriptor direction DMA data transfer direction (TO or FROM the device) flags dmaengine defined flags Initializes RapidIO capable DMA channel for the specified data transfer. Uses DMA channel private extension to pass information related to remote target RIO device. Returns pointer to DMA transaction descriptor or NULL if failed. Kernel Hackers Manual July 2017 rio_register_scan 9 4.1.27 rio_register_scan enumeration/discovery method registration interface int rio_register_scan int mport_id struct rio_scan * scan_ops mport_id mport device ID for which fabric scan routine has to be set (RIO_MPORT_ANY = set for all available mports) scan_ops enumeration/discovery operations structure Registers enumeration/discovery operations with RapidIO subsystem and attaches it to the specified mport device (or all available mports if RIO_MPORT_ANY is specified). Returns error if the mport already has an enumerator attached to it. In case of RIO_MPORT_ANY skips mports with valid scan routines (no error). Kernel Hackers Manual July 2017 rio_unregister_scan 9 4.1.27 rio_unregister_scan removes enumeration/discovery method from mport int rio_unregister_scan int mport_id struct rio_scan * scan_ops mport_id mport device ID for which fabric scan routine has to be unregistered (RIO_MPORT_ANY = apply to all mports that use the specified scan_ops) scan_ops enumeration/discovery operations structure Removes enumeration or discovery method assigned to the specified mport device. If RIO_MPORT_ANY is specified, removes the specified operations from all mports that have them attached. This chapter contains the autogenerated documentation of the RapidIO subsystem. Kernel Hackers Manual July 2017 struct rio_switch 9 4.1.27 struct rio_switch RIO switch info struct rio_switch { struct list_head node; u8 * route_table; u32 port_ok; struct rio_switch_ops * ops; spinlock_t lock; struct rio_dev * nextdev[0]; }; node Node in global list of switches route_table Copy of switch routing table port_ok Status of each port (one bit per port) - OK=1 or UNINIT=0 ops pointer to switch-specific operations lock lock to serialize operations updates nextdev[0] Array of per-port pointers to the next attached device Kernel Hackers Manual July 2017 struct rio_switch_ops 9 4.1.27 struct rio_switch_ops Per-switch operations struct rio_switch_ops { struct module * owner; int (* add_entry) (struct rio_mport *mport, u16 destid, u8 hopcount,u16 table, u16 route_destid, u8 route_port); int (* get_entry) (struct rio_mport *mport, u16 destid, u8 hopcount,u16 table, u16 route_destid, u8 *route_port); int (* clr_table) (struct rio_mport *mport, u16 destid, u8 hopcount,u16 table); int (* set_domain) (struct rio_mport *mport, u16 destid, u8 hopcount,u8 sw_domain); int (* get_domain) (struct rio_mport *mport, u16 destid, u8 hopcount,u8 *sw_domain); int (* em_init) (struct rio_dev *dev); int (* em_handle) (struct rio_dev *dev, u8 swport); }; owner The module owner of this structure add_entry Callback for switch-specific route add function get_entry Callback for switch-specific route get function clr_table Callback for switch-specific clear route table function set_domain Callback for switch-specific domain setting function get_domain Callback for switch-specific domain get function em_init Callback for switch-specific error management init function em_handle Callback for switch-specific error management handler function Defines the operations that are necessary to initialize/control a particular RIO switch device. Kernel Hackers Manual July 2017 struct rio_dev 9 4.1.27 struct rio_dev RIO device info struct rio_dev { struct list_head global_list; struct list_head net_list; struct rio_net * net; bool do_enum; u16 did; u16 vid; u32 device_rev; u16 asm_did; u16 asm_vid; u16 asm_rev; u16 efptr; u32 pef; u32 swpinfo; u32 src_ops; u32 dst_ops; u32 comp_tag; u32 phys_efptr; u32 em_efptr; u64 dma_mask; struct rio_driver * driver; struct device dev; struct resource riores[RIO_MAX_DEV_RESOURCES]; int (* pwcback) (struct rio_dev *rdev, union rio_pw_msg *msg, int step); u16 destid; u8 hopcount; struct rio_dev * prev; struct rio_switch rswitch[0]; }; global_list Node in list of all RIO devices net_list Node in list of RIO devices in a network net Network this device is a part of do_enum Enumeration flag did Device ID vid Vendor ID device_rev Device revision asm_did Assembly device ID asm_vid Assembly vendor ID asm_rev Assembly revision efptr Extended feature pointer pef Processing element features swpinfo Switch port info src_ops Source operation capabilities dst_ops Destination operation capabilities comp_tag RIO component tag phys_efptr RIO device extended features pointer em_efptr RIO Error Management features pointer dma_mask Mask of bits of RIO address this device implements driver Driver claiming this device dev Device model device riores[RIO_MAX_DEV_RESOURCES] RIO resources this device owns pwcback port-write callback function for this device destid Network destination ID (or associated destid for switch) hopcount Hopcount to this device prev Previous RIO device connected to the current one rswitch[0] struct rio_switch (if valid for this device) Kernel Hackers Manual July 2017 struct rio_msg 9 4.1.27 struct rio_msg RIO message event struct rio_msg { struct resource * res; void (* mcback) (struct rio_mport * mport, void *dev_id, int mbox, int slot); }; res Mailbox resource mcback Message event callback Kernel Hackers Manual July 2017 struct rio_dbell 9 4.1.27 struct rio_dbell RIO doorbell event struct rio_dbell { struct list_head node; struct resource * res; void (* dinb) (struct rio_mport *mport, void *dev_id, u16 src, u16 dst, u16 info); void * dev_id; }; node Node in list of doorbell events res Doorbell resource dinb Doorbell event callback dev_id Device specific pointer to pass on event Kernel Hackers Manual July 2017 struct rio_mport 9 4.1.27 struct rio_mport RIO master port info struct rio_mport { struct list_head dbells; struct list_head node; struct list_head nnode; struct resource iores; struct resource riores[RIO_MAX_MPORT_RESOURCES]; struct rio_msg inb_msg[RIO_MAX_MBOX]; struct rio_msg outb_msg[RIO_MAX_MBOX]; int host_deviceid; struct rio_ops * ops; unsigned char id; unsigned char index; unsigned int sys_size; enum rio_phy_type phy_type; u32 phys_efptr; unsigned char name[RIO_MAX_MPORT_NAME]; struct device dev; void * priv; #ifdef CONFIG_RAPIDIO_DMA_ENGINE struct dma_device dma; #endif struct rio_scan * nscan; }; dbells List of doorbell events node Node in global list of master ports nnode Node in network list of master ports iores I/O mem resource that this master port interface owns riores[RIO_MAX_MPORT_RESOURCES] RIO resources that this master port interfaces owns inb_msg[RIO_MAX_MBOX] RIO inbound message event descriptors outb_msg[RIO_MAX_MBOX] RIO outbound message event descriptors host_deviceid Host device ID associated with this master port ops configuration space functions id Port ID, unique among all ports index Port index, unique among all port interfaces of the same type sys_size RapidIO common transport system size phy_type RapidIO phy type phys_efptr RIO port extended features pointer name[RIO_MAX_MPORT_NAME] Port name string dev device structure associated with an mport priv Master port private data dma DMA device associated with mport nscan RapidIO network enumeration/discovery operations Kernel Hackers Manual July 2017 struct rio_net 9 4.1.27 struct rio_net RIO network info struct rio_net { struct list_head node; struct list_head devices; struct list_head switches; struct list_head mports; struct rio_mport * hport; unsigned char id; struct rio_id_table destid_table; }; node Node in global list of RIO networks devices List of devices in this network switches List of switches in this netowrk mports List of master ports accessing this network hport Default port for accessing this network id RIO network ID destid_table destID allocation table Kernel Hackers Manual July 2017 struct rio_ops 9 4.1.27 struct rio_ops Low-level RIO configuration space operations struct rio_ops { int (* lcread) (struct rio_mport *mport, int index, u32 offset, int len,u32 *data); int (* lcwrite) (struct rio_mport *mport, int index, u32 offset, int len,u32 data); int (* cread) (struct rio_mport *mport, int index, u16 destid,u8 hopcount, u32 offset, int len, u32 *data); int (* cwrite) (struct rio_mport *mport, int index, u16 destid,u8 hopcount, u32 offset, int len, u32 data); int (* dsend) (struct rio_mport *mport, int index, u16 destid, u16 data); int (* pwenable) (struct rio_mport *mport, int enable); int (* open_outb_mbox) (struct rio_mport *mport, void *dev_id,int mbox, int entries); void (* close_outb_mbox) (struct rio_mport *mport, int mbox); int (* open_inb_mbox) (struct rio_mport *mport, void *dev_id,int mbox, int entries); void (* close_inb_mbox) (struct rio_mport *mport, int mbox); int (* add_outb_message) (struct rio_mport *mport, struct rio_dev *rdev,int mbox, void *buffer, size_t len); int (* add_inb_buffer) (struct rio_mport *mport, int mbox, void *buf); void *(* get_inb_message) (struct rio_mport *mport, int mbox); int (* map_inb) (struct rio_mport *mport, dma_addr_t lstart,u64 rstart, u32 size, u32 flags); void (* unmap_inb) (struct rio_mport *mport, dma_addr_t lstart); }; lcread Callback to perform local (master port) read of config space. lcwrite Callback to perform local (master port) write of config space. cread Callback to perform network read of config space. cwrite Callback to perform network write of config space. dsend Callback to send a doorbell message. pwenable Callback to enable/disable port-write message handling. open_outb_mbox Callback to initialize outbound mailbox. close_outb_mbox Callback to shut down outbound mailbox. open_inb_mbox Callback to initialize inbound mailbox. close_inb_mbox Callback to shut down inbound mailbox. add_outb_message Callback to add a message to an outbound mailbox queue. add_inb_buffer Callback to add a buffer to an inbound mailbox queue. get_inb_message Callback to get a message from an inbound mailbox queue. map_inb Callback to map RapidIO address region into local memory space. unmap_inb Callback to unmap RapidIO address region mapped with map_inb. Kernel Hackers Manual July 2017 struct rio_driver 9 4.1.27 struct rio_driver RIO driver info struct rio_driver { struct list_head node; char * name; const struct rio_device_id * id_table; int (* probe) (struct rio_dev * dev, const struct rio_device_id * id); void (* remove) (struct rio_dev * dev); int (* suspend) (struct rio_dev * dev, u32 state); int (* resume) (struct rio_dev * dev); int (* enable_wake) (struct rio_dev * dev, u32 state, int enable); struct device_driver driver; }; node Node in list of drivers name RIO driver name id_table RIO device ids to be associated with this driver probe RIO device inserted remove RIO device removed suspend RIO device suspended resume RIO device awakened enable_wake RIO device enable wake event driver LDM driver struct Provides info on a RIO device driver for insertion/removal and power management purposes. Kernel Hackers Manual July 2017 struct rio_scan 9 4.1.27 struct rio_scan RIO enumeration and discovery operations struct rio_scan { struct module * owner; int (* enumerate) (struct rio_mport *mport, u32 flags); int (* discover) (struct rio_mport *mport, u32 flags); }; owner The module owner of this structure enumerate Callback to perform RapidIO fabric enumeration. discover Callback to perform RapidIO fabric discovery. Kernel Hackers Manual July 2017 struct rio_scan_node 9 4.1.27 struct rio_scan_node list node to register RapidIO enumeration and discovery methods with RapidIO core. struct rio_scan_node { int mport_id; struct list_head node; struct rio_scan * ops; }; mport_id ID of an mport (net) serviced by this enumerator node node in global list of registered enumerators ops RIO enumeration and discovery operations Kernel Hackers Manual July 2017 rio_destid_alloc 9 4.1.27 rio_destid_alloc Allocate next available destID for given network u16 rio_destid_alloc struct rio_net * net net RIO network Returns next available device destination ID for the specified RIO network. Marks allocated ID as one in use. Returns RIO_INVALID_DESTID if new destID is not available. Kernel Hackers Manual July 2017 rio_destid_reserve 9 4.1.27 rio_destid_reserve Reserve the specivied destID int rio_destid_reserve struct rio_net * net u16 destid net RIO network destid destID to reserve Tries to reserve the specified destID. Returns 0 if successfull. Kernel Hackers Manual July 2017 rio_destid_free 9 4.1.27 rio_destid_free free a previously allocated destID void rio_destid_free struct rio_net * net u16 destid net RIO network destid destID to free Makes the specified destID available for use. Kernel Hackers Manual July 2017 rio_destid_first 9 4.1.27 rio_destid_first return first destID in use u16 rio_destid_first struct rio_net * net net RIO network Kernel Hackers Manual July 2017 rio_destid_next 9 4.1.27 rio_destid_next return next destID in use u16 rio_destid_next struct rio_net * net u16 from net RIO network from destination ID from which search shall continue Kernel Hackers Manual July 2017 rio_get_device_id 9 4.1.27 rio_get_device_id Get the base/extended device id for a device u16 rio_get_device_id struct rio_mport * port u16 destid u8 hopcount port RIO master port destid Destination ID of device hopcount Hopcount to device Reads the base/extended device id from a device. Returns the 8/16-bit device ID. Kernel Hackers Manual July 2017 rio_set_device_id 9 4.1.27 rio_set_device_id Set the base/extended device id for a device void rio_set_device_id struct rio_mport * port u16 destid u8 hopcount u16 did port RIO master port destid Destination ID of device hopcount Hopcount to device did Device ID value to be written Writes the base/extended device id from a device. Kernel Hackers Manual July 2017 rio_local_set_device_id 9 4.1.27 rio_local_set_device_id Set the base/extended device id for a port void rio_local_set_device_id struct rio_mport * port u16 did port RIO master port did Device ID value to be written Writes the base/extended device id from a device. Kernel Hackers Manual July 2017 rio_clear_locks 9 4.1.27 rio_clear_locks Release all host locks and signal enumeration complete int rio_clear_locks struct rio_net * net net RIO network to run on Marks the component tag CSR on each device with the enumeration complete flag. When complete, it then release the host locks on each device. Returns 0 on success or -EINVAL on failure. Kernel Hackers Manual July 2017 rio_enum_host 9 4.1.27 rio_enum_host Set host lock and initialize host destination ID int rio_enum_host struct rio_mport * port port Master port to issue transaction Sets the local host master port lock and destination ID register with the host device ID value. The host device ID value is provided by the platform. Returns 0 on success or -1 on failure. Kernel Hackers Manual July 2017 rio_device_has_destid 9 4.1.27 rio_device_has_destid Test if a device contains a destination ID register int rio_device_has_destid struct rio_mport * port int src_ops int dst_ops port Master port to issue transaction src_ops RIO device source operations dst_ops RIO device destination operations Checks the provided src_ops and dst_ops for the necessary transaction capabilities that indicate whether or not a device will implement a destination ID register. Returns 1 if true or 0 if false. Kernel Hackers Manual July 2017 rio_release_dev 9 4.1.27 rio_release_dev Frees a RIO device struct void rio_release_dev struct device * dev dev LDM device associated with a RIO device struct Gets the RIO device struct associated a RIO device struct. The RIO device struct is freed. Kernel Hackers Manual July 2017 rio_is_switch 9 4.1.27 rio_is_switch Tests if a RIO device has switch capabilities int rio_is_switch struct rio_dev * rdev rdev RIO device Gets the RIO device Processing Element Features register contents and tests for switch capabilities. Returns 1 if the device is a switch or 0 if it is not a switch. The RIO device struct is freed. Kernel Hackers Manual July 2017 rio_setup_device 9 4.1.27 rio_setup_device Allocates and sets up a RIO device struct rio_dev * rio_setup_device struct rio_net * net struct rio_mport * port u16 destid u8 hopcount int do_enum net RIO network port Master port to send transactions destid Current destination ID hopcount Current hopcount do_enum Enumeration/Discovery mode flag Allocates a RIO device and configures fields based on configuration space contents. If device has a destination ID register, a destination ID is either assigned in enumeration mode or read from configuration space in discovery mode. If the device has switch capabilities, then a switch is allocated and configured appropriately. Returns a pointer to a RIO device on success or NULL on failure. Kernel Hackers Manual July 2017 rio_sport_is_active 9 4.1.27 rio_sport_is_active Tests if a switch port has an active connection. int rio_sport_is_active struct rio_mport * port u16 destid u8 hopcount int sport port Master port to send transaction destid Associated destination ID for switch hopcount Hopcount to reach switch sport Switch port number Reads the port error status CSR for a particular switch port to determine if the port has an active link. Returns RIO_PORT_N_ERR_STS_PORT_OK if the port is active or 0 if it is inactive. Kernel Hackers Manual July 2017 rio_get_host_deviceid_lock 9 4.1.27 rio_get_host_deviceid_lock Reads the Host Device ID Lock CSR on a device u16 rio_get_host_deviceid_lock struct rio_mport * port u8 hopcount port Master port to send transaction hopcount Number of hops to the device Used during enumeration to read the Host Device ID Lock CSR on a RIO device. Returns the value of the lock register. Kernel Hackers Manual July 2017 rio_enum_peer 9 4.1.27 rio_enum_peer Recursively enumerate a RIO network through a master port int rio_enum_peer struct rio_net * net struct rio_mport * port u8 hopcount struct rio_dev * prev int prev_port net RIO network being enumerated port Master port to send transactions hopcount Number of hops into the network prev Previous RIO device connected to the enumerated one prev_port Port on previous RIO device Recursively enumerates a RIO network. Transactions are sent via the master port passed in port. Kernel Hackers Manual July 2017 rio_enum_complete 9 4.1.27 rio_enum_complete Tests if enumeration of a network is complete int rio_enum_complete struct rio_mport * port port Master port to send transaction Tests the PGCCSR discovered bit for non-zero value (enumeration complete flag). Return 1 if enumeration is complete or 0 if enumeration is incomplete. Kernel Hackers Manual July 2017 rio_disc_peer 9 4.1.27 rio_disc_peer Recursively discovers a RIO network through a master port int rio_disc_peer struct rio_net * net struct rio_mport * port u16 destid u8 hopcount struct rio_dev * prev int prev_port net RIO network being discovered port Master port to send transactions destid Current destination ID in network hopcount Number of hops into the network prev previous rio_dev prev_port previous port number Recursively discovers a RIO network. Transactions are sent via the master port passed in port. Kernel Hackers Manual July 2017 rio_mport_is_active 9 4.1.27 rio_mport_is_active Tests if master port link is active int rio_mport_is_active struct rio_mport * port port Master port to test Reads the port error status CSR for the master port to determine if the port has an active link. Returns RIO_PORT_N_ERR_STS_PORT_OK if the master port is active or 0 if it is inactive. Kernel Hackers Manual July 2017 rio_alloc_net 9 4.1.27 rio_alloc_net Allocate and configure a new RIO network struct rio_net * rio_alloc_net struct rio_mport * port int do_enum u16 start port Master port associated with the RIO network do_enum Enumeration/Discovery mode flag start logical minimal start id for new net Allocates a RIO network structure, initializes per-network list heads, and adds the associated master port to the network list of associated master ports. Returns a RIO network pointer on success or NULL on failure. Kernel Hackers Manual July 2017 rio_update_route_tables 9 4.1.27 rio_update_route_tables Updates route tables in switches void rio_update_route_tables struct rio_net * net net RIO network to run update on For each enumerated device, ensure that each switch in a system has correct routing entries. Add routes for devices that where unknown dirung the first enumeration pass through the switch. Kernel Hackers Manual July 2017 rio_init_em 9 4.1.27 rio_init_em Initializes RIO Error Management (for switches) void rio_init_em struct rio_dev * rdev rdev RIO device For each enumerated switch, call device-specific error management initialization routine (if supplied by the switch driver). Kernel Hackers Manual July 2017 rio_pw_enable 9 4.1.27 rio_pw_enable Enables/disables port-write handling by a master port void rio_pw_enable struct rio_mport * port int enable port Master port associated with port-write handling enable 1=enable, 0=disable Kernel Hackers Manual July 2017 rio_enum_mport 9 4.1.27 rio_enum_mport Start enumeration through a master port int rio_enum_mport struct rio_mport * mport u32 flags mport Master port to send transactions flags Enumeration control flags Starts the enumeration process. If somebody has enumerated our master port device, then give up. If not and we have an active link, then start recursive peer enumeration. Returns 0 if enumeration succeeds or -EBUSY if enumeration fails. Kernel Hackers Manual July 2017 rio_build_route_tables 9 4.1.27 rio_build_route_tables Generate route tables from switch route entries void rio_build_route_tables struct rio_net * net net RIO network to run route tables scan on For each switch device, generate a route table by copying existing route entries from the switch. Kernel Hackers Manual July 2017 rio_disc_mport 9 4.1.27 rio_disc_mport Start discovery through a master port int rio_disc_mport struct rio_mport * mport u32 flags mport Master port to send transactions flags discovery control flags Starts the discovery process. If we have an active link, then wait for the signal that enumeration is complete (if wait is allowed). When enumeration completion is signaled, start recursive peer discovery. Returns 0 if discovery succeeds or -EBUSY on failure. Kernel Hackers Manual July 2017 rio_basic_attach 9 4.1.27 rio_basic_attach int rio_basic_attach void void no arguments When this enumeration/discovery method is loaded as a module this function registers its specific enumeration and discover routines for all available RapidIO mport devices. The scan command line parameter controls ability of the module to start RapidIO enumeration/discovery automatically. Returns 0 for success or -EIO if unable to register itself. This enumeration/discovery method cannot be unloaded and therefore does not provide a matching cleanup_module routine. Kernel Hackers Manual July 2017 rio_setup_inb_dbell 9 4.1.27 rio_setup_inb_dbell bind inbound doorbell callback int rio_setup_inb_dbell struct rio_mport * mport void * dev_id struct resource * res void (*dinb) struct rio_mport * mport, void *dev_id, u16 src, u16 dst, u16 info mport RIO master port to bind the doorbell callback dev_id Device specific pointer to pass on event res Doorbell message resource dinb Callback to execute when doorbell is received Adds a doorbell resource/callback pair into a port's doorbell event list. Returns 0 if the request has been satisfied. Kernel Hackers Manual July 2017 rio_chk_dev_route 9 4.1.27 rio_chk_dev_route Validate route to the specified device. int rio_chk_dev_route struct rio_dev * rdev struct rio_dev ** nrdev int * npnum rdev RIO device failed to respond nrdev Last active device on the route to rdev npnum nrdev's port number on the route to rdev Follows a route to the specified RIO device to determine the last available device (and corresponding RIO port) on the route. Kernel Hackers Manual July 2017 rio_chk_dev_access 9 4.1.27 rio_chk_dev_access Validate access to the specified device. int rio_chk_dev_access struct rio_dev * rdev rdev Pointer to RIO device control structure Kernel Hackers Manual July 2017 rio_get_input_status 9 4.1.27 rio_get_input_status Sends a Link-Request/Input-Status control symbol and returns link-response (if requested). int rio_get_input_status struct rio_dev * rdev int pnum u32 * lnkresp rdev RIO devive to issue Input-status command pnum Device port number to issue the command lnkresp Response from a link partner Kernel Hackers Manual July 2017 rio_clr_err_stopped 9 4.1.27 rio_clr_err_stopped Clears port Error-stopped states. int rio_clr_err_stopped struct rio_dev * rdev u32 pnum u32 err_status rdev Pointer to RIO device control structure pnum Switch port number to clear errors err_status port error status (if 0 reads register from device) Kernel Hackers Manual July 2017 rio_std_route_add_entry 9 4.1.27 rio_std_route_add_entry Add switch route table entry using standard registers defined in RIO specification rev.1.3 int rio_std_route_add_entry struct rio_mport * mport u16 destid u8 hopcount u16 table u16 route_destid u8 route_port mport Master port to issue transaction destid Destination ID of the device hopcount Number of switch hops to the device table routing table ID (global or port-specific) route_destid destID entry in the RT route_port destination port for specified destID Kernel Hackers Manual July 2017 rio_std_route_get_entry 9 4.1.27 rio_std_route_get_entry Read switch route table entry (port number) associated with specified destID using standard registers defined in RIO specification rev.1.3 int rio_std_route_get_entry struct rio_mport * mport u16 destid u8 hopcount u16 table u16 route_destid u8 * route_port mport Master port to issue transaction destid Destination ID of the device hopcount Number of switch hops to the device table routing table ID (global or port-specific) route_destid destID entry in the RT route_port returned destination port for specified destID Kernel Hackers Manual July 2017 rio_std_route_clr_table 9 4.1.27 rio_std_route_clr_table Clear swotch route table using standard registers defined in RIO specification rev.1.3. int rio_std_route_clr_table struct rio_mport * mport u16 destid u8 hopcount u16 table mport Master port to issue transaction destid Destination ID of the device hopcount Number of switch hops to the device table routing table ID (global or port-specific) Kernel Hackers Manual July 2017 rio_find_mport 9 4.1.27 rio_find_mport find RIO mport by its ID struct rio_mport * rio_find_mport int mport_id mport_id number (ID) of mport device Given a RIO mport number, the desired mport is located in the global list of mports. If the mport is found, a pointer to its data structure is returned. If no mport is found, NULL is returned. Kernel Hackers Manual July 2017 rio_mport_scan 9 4.1.27 rio_mport_scan execute enumeration/discovery on the specified mport int rio_mport_scan int mport_id mport_id number (ID) of mport device Kernel Hackers Manual July 2017 RIO_LOP_READ 9 4.1.27 RIO_LOP_READ Generate rio_local_read_config_* functions RIO_LOP_READ size type len size Size of configuration space read (8, 16, 32 bits) type C type of value argument len Length of configuration space read (1, 2, 4 bytes) Generates rio_local_read_config_* functions used to access configuration space registers on the local device. Kernel Hackers Manual July 2017 RIO_LOP_WRITE 9 4.1.27 RIO_LOP_WRITE Generate rio_local_write_config_* functions RIO_LOP_WRITE size type len size Size of configuration space write (8, 16, 32 bits) type C type of value argument len Length of configuration space write (1, 2, 4 bytes) Generates rio_local_write_config_* functions used to access configuration space registers on the local device. Kernel Hackers Manual July 2017 RIO_OP_READ 9 4.1.27 RIO_OP_READ Generate rio_mport_read_config_* functions RIO_OP_READ size type len size Size of configuration space read (8, 16, 32 bits) type C type of value argument len Length of configuration space read (1, 2, 4 bytes) Generates rio_mport_read_config_* functions used to access configuration space registers on the local device. Kernel Hackers Manual July 2017 RIO_OP_WRITE 9 4.1.27 RIO_OP_WRITE Generate rio_mport_write_config_* functions RIO_OP_WRITE size type len size Size of configuration space write (8, 16, 32 bits) type C type of value argument len Length of configuration space write (1, 2, 4 bytes) Generates rio_mport_write_config_* functions used to access configuration space registers on the local device. Kernel Hackers Manual July 2017 rio_match_device 9 4.1.27 rio_match_device Tell if a RIO device has a matching RIO device id structure const struct rio_device_id * rio_match_device const struct rio_device_id * id const struct rio_dev * rdev id the RIO device id structure to match against rdev the RIO device structure to match against Used from driver probe and bus matching to check whether a RIO device matches a device id structure provided by a RIO driver. Returns the matching struct rio_device_id or NULL if there is no match. Kernel Hackers Manual July 2017 rio_device_probe 9 4.1.27 rio_device_probe Tell if a RIO device structure has a matching RIO device id structure int rio_device_probe struct device * dev dev the RIO device structure to match against return 0 and set rio_dev->driver when drv claims rio_dev, else error Kernel Hackers Manual July 2017 rio_device_remove 9 4.1.27 rio_device_remove Remove a RIO device from the system int rio_device_remove struct device * dev dev the RIO device structure to match against Remove a RIO device from the system. If it has an associated driver, then run the driver remove method. Then update the reference count. Kernel Hackers Manual July 2017 rio_match_bus 9 4.1.27 rio_match_bus Tell if a RIO device structure has a matching RIO driver device id structure int rio_match_bus struct device * dev struct device_driver * drv dev the standard device structure to match against drv the standard driver structure containing the ids to match against Used by a driver to check whether a RIO device present in the system is in its list of supported devices. Returns 1 if there is a matching struct rio_device_id or 0 if there is no match. Kernel Hackers Manual July 2017 rio_bus_init 9 4.1.27 rio_bus_init Register the RapidIO bus with the device model int rio_bus_init void void no arguments Registers the RIO mport device class and RIO bus type with the Linux device model. Kernel Hackers Manual July 2017 rio_create_sysfs_dev_files 9 4.1.27 rio_create_sysfs_dev_files create RIO specific sysfs files int rio_create_sysfs_dev_files struct rio_dev * rdev rdev device whose entries should be created Create files when rdev is added to sysfs. Kernel Hackers Manual July 2017 rio_remove_sysfs_dev_files 9 4.1.27 rio_remove_sysfs_dev_files cleanup RIO specific sysfs files void rio_remove_sysfs_dev_files struct rio_dev * rdev rdev device whose entries we should free Cleanup when rdev is removed from sysfs. Kernel Hackers Manual July 2017 fsl_local_config_read 9 4.1.27 fsl_local_config_read Generate a MPC85xx local config space read int fsl_local_config_read struct rio_mport * mport int index u32 offset int len u32 * data mport RapidIO master port info index ID of RapdiIO interface offset Offset into configuration space len Length (in bytes) of the maintenance transaction data Value to be read into Generates a MPC85xx local configuration space read. Returns 0 on success or -EINVAL on failure. Kernel Hackers Manual July 2017 fsl_local_config_write 9 4.1.27 fsl_local_config_write Generate a MPC85xx local config space write int fsl_local_config_write struct rio_mport * mport int index u32 offset int len u32 data mport RapidIO master port info index ID of RapdiIO interface offset Offset into configuration space len Length (in bytes) of the maintenance transaction data Value to be written Generates a MPC85xx local configuration space write. Returns 0 on success or -EINVAL on failure. Kernel Hackers Manual July 2017 fsl_rio_config_read 9 4.1.27 fsl_rio_config_read Generate a MPC85xx read maintenance transaction int fsl_rio_config_read struct rio_mport * mport int index u16 destid u8 hopcount u32 offset int len u32 * val mport RapidIO master port info index ID of RapdiIO interface destid Destination ID of transaction hopcount Number of hops to target device offset Offset into configuration space len Length (in bytes) of the maintenance transaction val Location to be read into Generates a MPC85xx read maintenance transaction. Returns 0 on success or -EINVAL on failure. Kernel Hackers Manual July 2017 fsl_rio_config_write 9 4.1.27 fsl_rio_config_write Generate a MPC85xx write maintenance transaction int fsl_rio_config_write struct rio_mport * mport int index u16 destid u8 hopcount u32 offset int len u32 val mport RapidIO master port info index ID of RapdiIO interface destid Destination ID of transaction hopcount Number of hops to target device offset Offset into configuration space len Length (in bytes) of the maintenance transaction val Value to be written Generates an MPC85xx write maintenance transaction. Returns 0 on success or -EINVAL on failure. Kernel Hackers Manual July 2017 fsl_rio_setup 9 4.1.27 fsl_rio_setup Setup Freescale PowerPC RapidIO interface int fsl_rio_setup struct platform_device * dev dev platform_device pointer Initializes MPC85xx RapidIO hardware interface, configures master port with system-specific info, and registers the master port with the RapidIO subsystem. The following people have contributed to the RapidIO subsystem directly or indirectly: Matt Portermporter@kernel.crashing.org Randy Vinsonrvinson@mvista.com Dan Malekdan@embeddedalley.com The following people have contributed to this document: Matt Portermporter@kernel.crashing.org