RapidIO Subsystem Guide¶
| Author: | Matt Porter |
|---|
Introduction¶
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.
Known Bugs and Limitations¶
Bugs¶
None. ;)
Limitations¶
- Access/management of RapidIO memory regions is not supported
- Multiple host enumeration is not supported
RapidIO driver interface¶
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¶
-
int
rio_local_read_config_32(struct rio_mport * port, u32 offset, u32 * data)¶ Read 32 bits from local configuration space
Parameters
struct rio_mport * port- Master port
u32 offset- Offset into local configuration space
u32 * data- Pointer to read data into
Description
Reads 32 bits of data from the specified offset within the local device’s configuration space.
-
int
rio_local_write_config_32(struct rio_mport * port, u32 offset, u32 data)¶ Write 32 bits to local configuration space
Parameters
struct rio_mport * port- Master port
u32 offset- Offset into local configuration space
u32 data- Data to be written
Description
Writes 32 bits of data to the specified offset within the local device’s configuration space.
-
int
rio_local_read_config_16(struct rio_mport * port, u32 offset, u16 * data)¶ Read 16 bits from local configuration space
Parameters
struct rio_mport * port- Master port
u32 offset- Offset into local configuration space
u16 * data- Pointer to read data into
Description
Reads 16 bits of data from the specified offset within the local device’s configuration space.
-
int
rio_local_write_config_16(struct rio_mport * port, u32 offset, u16 data)¶ Write 16 bits to local configuration space
Parameters
struct rio_mport * port- Master port
u32 offset- Offset into local configuration space
u16 data- Data to be written
Description
Writes 16 bits of data to the specified offset within the local device’s configuration space.
-
int
rio_local_read_config_8(struct rio_mport * port, u32 offset, u8 * data)¶ Read 8 bits from local configuration space
Parameters
struct rio_mport * port- Master port
u32 offset- Offset into local configuration space
u8 * data- Pointer to read data into
Description
Reads 8 bits of data from the specified offset within the local device’s configuration space.
-
int
rio_local_write_config_8(struct rio_mport * port, u32 offset, u8 data)¶ Write 8 bits to local configuration space
Parameters
struct rio_mport * port- Master port
u32 offset- Offset into local configuration space
u8 data- Data to be written
Description
Writes 8 bits of data to the specified offset within the local device’s configuration space.
-
int
rio_read_config_32(struct rio_dev * rdev, u32 offset, u32 * data)¶ Read 32 bits from configuration space
Parameters
struct rio_dev * rdev- RIO device
u32 offset- Offset into device configuration space
u32 * data- Pointer to read data into
Description
Reads 32 bits of data from the specified offset within the RIO device’s configuration space.
-
int
rio_write_config_32(struct rio_dev * rdev, u32 offset, u32 data)¶ Write 32 bits to configuration space
Parameters
struct rio_dev * rdev- RIO device
u32 offset- Offset into device configuration space
u32 data- Data to be written
Description
Writes 32 bits of data to the specified offset within the RIO device’s configuration space.
-
int
rio_read_config_16(struct rio_dev * rdev, u32 offset, u16 * data)¶ Read 16 bits from configuration space
Parameters
struct rio_dev * rdev- RIO device
u32 offset- Offset into device configuration space
u16 * data- Pointer to read data into
Description
Reads 16 bits of data from the specified offset within the RIO device’s configuration space.
-
int
rio_write_config_16(struct rio_dev * rdev, u32 offset, u16 data)¶ Write 16 bits to configuration space
Parameters
struct rio_dev * rdev- RIO device
u32 offset- Offset into device configuration space
u16 data- Data to be written
Description
Writes 16 bits of data to the specified offset within the RIO device’s configuration space.
-
int
rio_read_config_8(struct rio_dev * rdev, u32 offset, u8 * data)¶ Read 8 bits from configuration space
Parameters
struct rio_dev * rdev- RIO device
u32 offset- Offset into device configuration space
u8 * data- Pointer to read data into
Description
Reads 8 bits of data from the specified offset within the RIO device’s configuration space.
-
int
rio_write_config_8(struct rio_dev * rdev, u32 offset, u8 data)¶ Write 8 bits to configuration space
Parameters
struct rio_dev * rdev- RIO device
u32 offset- Offset into device configuration space
u8 data- Data to be written
Description
Writes 8 bits of data to the specified offset within the RIO device’s configuration space.
Parameters
struct rio_dev * rdev- RIO device
u16 data- Doorbell message data
Description
Send a doorbell message to a RIO device. The doorbell message has a 16-bit info field provided by the data argument.
-
void
rio_init_mbox_res(struct resource * res, int start, int end)¶ Initialize a RIO mailbox resource
Parameters
struct resource * res- resource struct
int start- start of mailbox range
int end- end of mailbox range
Description
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.
-
void
rio_init_dbell_res(struct resource * res, u16 start, u16 end)¶ Initialize a RIO doorbell resource
Parameters
struct resource * res- resource struct
u16 start- start of doorbell range
u16 end- end of doorbell range
Description
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.
-
RIO_DEVICE(dev, ven)¶ macro used to describe a specific RIO device
Parameters
dev- the 16 bit RIO device ID
ven- the 16 bit RIO vendor ID
Description
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.
-
int
rio_add_outb_message(struct rio_mport * mport, struct rio_dev * rdev, int mbox, void * buffer, size_t len)¶ Add RIO message to an outbound mailbox queue
Parameters
struct rio_mport * mport- RIO master port containing the outbound queue
struct rio_dev * rdev- RIO device the message is be sent to
int mbox- The outbound mailbox queue
void * buffer- Pointer to the message buffer
size_t len- Length of the message buffer
Description
Adds a RIO message buffer to an outbound mailbox queue for transmission. Returns 0 on success.
-
int
rio_add_inb_buffer(struct rio_mport * mport, int mbox, void * buffer)¶ Add buffer to an inbound mailbox queue
Parameters
struct rio_mport * mport- Master port containing the inbound mailbox
int mbox- The inbound mailbox number
void * buffer- Pointer to the message buffer
Description
Adds a buffer to an inbound mailbox queue for reception. Returns 0 on success.
-
void *
rio_get_inb_message(struct rio_mport * mport, int mbox)¶ Get A RIO message from an inbound mailbox queue
Parameters
struct rio_mport * mport- Master port containing the inbound mailbox
int mbox- The inbound mailbox number
Description
Get a RIO message from an inbound mailbox queue. Returns 0 on success.
Parameters
struct rio_dev * rdev- RIO device
Description
Get the unique RIO device identifier. Returns the device identifier string.
Parameters
struct rio_dev * rdev- RIO device
Description
Get RIO driver specific data. Returns a pointer to the driver specific data.
Parameters
struct rio_dev * rdev- RIO device
void * data- Pointer to driver specific data
Description
Set RIO driver specific data. device struct driver data pointer is set to the data argument.
-
struct rio_dev *
rio_dev_get(struct rio_dev * rdev)¶ Increments the reference count of the RIO device structure
Parameters
struct rio_dev * rdev- RIO device being referenced
Description
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.
Parameters
struct rio_dev * rdev- RIO device being disconnected
Description
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.
-
int
rio_register_driver(struct rio_driver * rdrv)¶ register a new RIO driver
Parameters
struct rio_driver * rdrv- the RIO driver structure to register
Description
Adds astruct rio_driverto 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.
-
void
rio_unregister_driver(struct rio_driver * rdrv)¶ unregister a RIO driver
Parameters
struct rio_driver * rdrv- the RIO driver structure to unregister
Description
Deletes thestruct rio_driverfrom the list of registered RIO drivers, gives it a chance to clean up by calling itsremove()function for each device it was responsible for, and marks those devices as driverless.
Parameters
struct rio_mport * port- RIO master port from which to get the deviceid
Description
Reads the base/extended device id from the local device implementing the master port. Returns the 8/16-bit device id.
-
int
rio_query_mport(struct rio_mport * port, struct rio_mport_attr * mport_attr)¶ Query mport device attributes
Parameters
struct rio_mport * port- mport device to query
struct rio_mport_attr * mport_attr- mport attributes data structure
Description
Returns attributes of specified mport through the pointer to attributes data structure.
-
struct rio_net *
rio_alloc_net(struct rio_mport * mport)¶ Allocate and initialize a new RIO network data structure
Parameters
struct rio_mport * mport- Master port associated with the RIO network
Description
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.
-
void
rio_local_set_device_id(struct rio_mport * port, u16 did)¶ Set the base/extended device id for a port
Parameters
struct rio_mport * port- RIO master port
u16 did- Device ID value to be written
Description
Writes the base/extended device id from a device.
Parameters
struct rio_dev * rdev- RIO device
Description
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.
-
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)¶ request inbound mailbox service
Parameters
struct rio_mport * mport- RIO master port from which to allocate the mailbox resource
void * dev_id- Device specific pointer to pass on event
int mbox- Mailbox number to claim
int entries- Number of entries in inbound mailbox queue
void (*) (struct rio_mport * mport, void *dev_id, int mbox, int slot) minb- Callback to execute when inbound message is received
Description
Requests ownership of an inbound mailbox resource and binds
a callback function to the resource. Returns 0 on success.
-
int
rio_release_inb_mbox(struct rio_mport * mport, int mbox)¶ release inbound mailbox message service
Parameters
struct rio_mport * mport- RIO master port from which to release the mailbox resource
int mbox- Mailbox number to release
Description
Releases ownership of an inbound mailbox resource. Returns 0 if the request has been satisfied.
-
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)¶ request outbound mailbox service
Parameters
struct rio_mport * mport- RIO master port from which to allocate the mailbox resource
void * dev_id- Device specific pointer to pass on event
int mbox- Mailbox number to claim
int entries- Number of entries in outbound mailbox queue
void (*) (struct rio_mport * mport, void *dev_id, int mbox, int slot) moutb- Callback to execute when outbound message is sent
Description
Requests ownership of an outbound mailbox resource and binds a callback function to the resource. Returns 0 on success.
-
int
rio_release_outb_mbox(struct rio_mport * mport, int mbox)¶ release outbound mailbox message service
Parameters
struct rio_mport * mport- RIO master port from which to release the mailbox resource
int mbox- Mailbox number to release
Description
Releases ownership of an inbound mailbox resource. Returns 0 if the request has been satisfied.
-
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)¶ request inbound doorbell message service
Parameters
struct rio_mport * mport- RIO master port from which to allocate the doorbell resource
void * dev_id- Device specific pointer to pass on event
u16 start- Doorbell info range start
u16 end- Doorbell info range end
void (*) (struct rio_mport * mport, void *dev_id, u16 src, u16 dst, u16 info) dinb- Callback to execute when doorbell is received
Description
Requests ownership of an inbound doorbell resource and binds a callback function to the resource. Returns 0 if the request has been satisfied.
-
int
rio_release_inb_dbell(struct rio_mport * mport, u16 start, u16 end)¶ release inbound doorbell message service
Parameters
struct rio_mport * mport- RIO master port from which to release the doorbell resource
u16 start- Doorbell info range start
u16 end- Doorbell info range end
Description
Releases ownership of an inbound doorbell resource and removes callback from the doorbell event list. Returns 0 if the request has been satisfied.
-
struct resource *
rio_request_outb_dbell(struct rio_dev * rdev, u16 start, u16 end)¶ request outbound doorbell message range
Parameters
struct rio_dev * rdev- RIO device from which to allocate the doorbell resource
u16 start- Doorbell message range start
u16 end- Doorbell message range end
Description
Requests ownership of a doorbell message range. Returns a resource
if the request has been satisfied or NULL on failure.
-
int
rio_release_outb_dbell(struct rio_dev * rdev, struct resource * res)¶ release outbound doorbell message range
Parameters
struct rio_dev * rdev- RIO device from which to release the doorbell resource
struct resource * res- Doorbell resource to be freed
Description
Releases ownership of a doorbell message range. Returns 0 if the request has been satisfied.
-
int
rio_add_mport_pw_handler(struct rio_mport * mport, void * context, int (*pwcback) (struct rio_mport *mport, void *context, union rio_pw_msg *msg, int step)¶ add port-write message handler into the list of mport specific pw handlers
Parameters
struct rio_mport * mport- RIO master port to bind the portwrite callback
void * context- Handler specific context to pass on event
int (*)(struct rio_mport *mport, void *context, union rio_pw_msg *msg, int step) pwcback- Callback to execute when portwrite is received
Description
Returns 0 if the request has been satisfied.
-
int
rio_del_mport_pw_handler(struct rio_mport * mport, void * context, int (*pwcback) (struct rio_mport *mport, void *context, union rio_pw_msg *msg, int step)¶ remove port-write message handler from the list of mport specific pw handlers
Parameters
struct rio_mport * mport- RIO master port to bind the portwrite callback
void * context- Registered handler specific context to pass on event
int (*)(struct rio_mport *mport, void *context, union rio_pw_msg *msg, int step) pwcback- Registered callback function
Description
Returns 0 if the request has been satisfied.
-
int
rio_request_inb_pwrite(struct rio_dev * rdev, int (*pwcback) (struct rio_dev *rdev, union rio_pw_msg *msg, int step)¶ request inbound port-write message service for specific RapidIO device
Parameters
struct rio_dev * rdev- RIO device to which register inbound port-write callback routine
int (*)(struct rio_dev *rdev, union rio_pw_msg *msg, int step) pwcback- Callback routine to execute when port-write is received
Description
Binds a port-write callback function to the RapidIO device. Returns 0 if the request has been satisfied.
-
int
rio_release_inb_pwrite(struct rio_dev * rdev)¶ release inbound port-write message service associated with specific RapidIO device
Parameters
struct rio_dev * rdev- RIO device which registered for inbound port-write callback
Description
Removes callback from the rio_dev structure. Returns 0 if the request has been satisfied.
-
void
rio_pw_enable(struct rio_mport * mport, int enable)¶ Enables/disables port-write handling by a master port
Parameters
struct rio_mport * mport- Master port associated with port-write handling
int enable- 1=enable, 0=disable
-
int
rio_map_inb_region(struct rio_mport * mport, dma_addr_t local, u64 rbase, u32 size, u32 rflags)¶ - Map inbound memory region.
Parameters
struct rio_mport * mport- Master port.
dma_addr_t local- physical address of memory region to be mapped
u64 rbase- RIO base address assigned to this window
u32 size- Size of the memory region
u32 rflags- Flags for mapping.
Return
0 – Success.
This function will create the mapping from RIO space to local memory.
-
void
rio_unmap_inb_region(struct rio_mport * mport, dma_addr_t lstart)¶ - Unmap the inbound memory region
Parameters
struct rio_mport * mport- Master port
dma_addr_t lstart- physical address of memory region to be unmapped
-
int
rio_map_outb_region(struct rio_mport * mport, u16 destid, u64 rbase, u32 size, u32 rflags, dma_addr_t * local)¶ - Map outbound memory region.
Parameters
struct rio_mport * mport- Master port.
u16 destid- destination id window points to
u64 rbase- RIO base address window translates to
u32 size- Size of the memory region
u32 rflags- Flags for mapping.
dma_addr_t * local- physical address of memory region mapped
Return
0 – Success.
This function will create the mapping from RIO space to local memory.
-
void
rio_unmap_outb_region(struct rio_mport * mport, u16 destid, u64 rstart)¶ - Unmap the inbound memory region
Parameters
struct rio_mport * mport- Master port
u16 destid- destination id mapping points to
u64 rstart- RIO base address window translates to
-
u32
rio_mport_get_physefb(struct rio_mport * port, int local, u16 destid, u8 hopcount, u32 * rmap)¶ Helper function that returns register offset for Physical Layer Extended Features Block.
Parameters
struct rio_mport * port- Master port to issue transaction
int local- Indicate a local master port or remote device access
u16 destid- Destination ID of the device
u8 hopcount- Number of switch hops to the device
u32 * rmap- pointer to location to store register map type info
-
struct rio_dev *
rio_get_comptag(u32 comp_tag, struct rio_dev * from)¶ Begin or continue searching for a RIO device by component tag
Parameters
u32 comp_tag- RIO component tag to match
struct rio_dev * from- Previous RIO device found in search, or
NULLfor new search
Description
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.
-
int
rio_set_port_lockout(struct rio_dev * rdev, u32 pnum, int lock)¶ Sets/clears LOCKOUT bit (RIO EM 1.3) for a switch port.
Parameters
struct rio_dev * rdev- Pointer to RIO device control structure
u32 pnum- Switch port number to set LOCKOUT bit
int lock- Operation : set (=1) or clear (=0)
-
int
rio_enable_rx_tx_port(struct rio_mport * port, int local, u16 destid, u8 hopcount, u8 port_num)¶ enable input receiver and output transmitter of given port
Parameters
struct rio_mport * port- Master port associated with the RIO network
int local- local=1 select local port otherwise a far device is reached
u16 destid- Destination ID of the device to check host bit
u8 hopcount- Number of hops to reach the target
u8 port_num- Port (-number on switch) to enable on a far end device
Description
Returns 0 or 1 from on General Control Command and Status Register (EXT_PTR+0x3C)
-
int
rio_mport_chk_dev_access(struct rio_mport * mport, u16 destid, u8 hopcount)¶ Validate access to the specified device.
Parameters
struct rio_mport * mport- Master port to send transactions
u16 destid- Device destination ID in network
u8 hopcount- Number of hops into the network
-
int
rio_inb_pwrite_handler(struct rio_mport * mport, union rio_pw_msg * pw_msg)¶ inbound port-write message handler
Parameters
struct rio_mport * mport- mport device associated with port-write
union rio_pw_msg * pw_msg- pointer to inbound port-write message
Description
Processes an inbound port-write message. Returns 0 if the request has been satisfied.
-
u32
rio_mport_get_efb(struct rio_mport * port, int local, u16 destid, u8 hopcount, u32 from)¶ get pointer to next extended features block
Parameters
struct rio_mport * port- Master port to issue transaction
int local- Indicate a local master port or remote device access
u16 destid- Destination ID of the device
u8 hopcount- Number of switch hops to the device
u32 from- Offset of current Extended Feature block header (if 0 starts from ExtFeaturePtr)
-
u32
rio_mport_get_feature(struct rio_mport * port, int local, u16 destid, u8 hopcount, int ftr)¶ query for devices’ extended features
Parameters
struct rio_mport * port- Master port to issue transaction
int local- Indicate a local master port or remote device access
u16 destid- Destination ID of the device
u8 hopcount- Number of switch hops to the device
int ftr- Extended feature code
Description
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.
-
struct rio_dev *
rio_get_asm(u16 vid, u16 did, u16 asm_vid, u16 asm_did, struct rio_dev * from)¶ Begin or continue searching for a RIO device by vid/did/asm_vid/asm_did
Parameters
u16 vid- RIO vid to match or
RIO_ANY_IDto match all vids u16 did- RIO did to match or
RIO_ANY_IDto match all dids u16 asm_vid- RIO asm_vid to match or
RIO_ANY_IDto match all asm_vids u16 asm_did- RIO asm_did to match or
RIO_ANY_IDto match all asm_dids struct rio_dev * from- Previous RIO device found in search, or
NULLfor new search
Description
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.
-
struct rio_dev *
rio_get_device(u16 vid, u16 did, struct rio_dev * from)¶ Begin or continue searching for a RIO device by vid/did
Parameters
u16 vid- RIO vid to match or
RIO_ANY_IDto match all vids u16 did- RIO did to match or
RIO_ANY_IDto match all dids struct rio_dev * from- Previous RIO device found in search, or
NULLfor new search
Description
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.
-
int
rio_lock_device(struct rio_mport * port, u16 destid, u8 hopcount, int wait_ms)¶ Acquires host device lock for specified device
Parameters
struct rio_mport * port- Master port to send transaction
u16 destid- Destination ID for device/switch
u8 hopcount- Hopcount to reach switch
int wait_ms- Max wait time in msec (0 = no timeout)
Description
Attepts to acquire host device lock for specified device Returns 0 if device lock acquired or EINVAL if timeout expires.
-
int
rio_unlock_device(struct rio_mport * port, u16 destid, u8 hopcount)¶ Releases host device lock for specified device
Parameters
struct rio_mport * port- Master port to send transaction
u16 destid- Destination ID for device/switch
u8 hopcount- Hopcount to reach switch
Description
Returns 0 if device lock released or EINVAL if fails.
-
int
rio_route_add_entry(struct rio_dev * rdev, u16 table, u16 route_destid, u8 route_port, int lock)¶ Add a route entry to a switch routing table
Parameters
struct rio_dev * rdev- RIO device
u16 table- Routing table ID
u16 route_destid- Destination ID to be routed
u8 route_port- Port number to be routed
int lock- apply a hardware lock on switch device flag (1=lock, 0=no_lock)
Description
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.
-
int
rio_route_get_entry(struct rio_dev * rdev, u16 table, u16 route_destid, u8 * route_port, int lock)¶ Read an entry from a switch routing table
Parameters
struct rio_dev * rdev- RIO device
u16 table- Routing table ID
u16 route_destid- Destination ID to be routed
u8 * route_port- Pointer to read port number into
int lock- apply a hardware lock on switch device flag (1=lock, 0=no_lock)
Description
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.
Parameters
struct rio_dev * rdev- RIO device
u16 table- Routing table ID
int lock- apply a hardware lock on switch device flag (1=lock, 0=no_lock)
Description
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.
-
struct dma_chan *
rio_request_mport_dma(struct rio_mport * mport)¶ request RapidIO capable DMA channel associated with specified local RapidIO mport device.
Parameters
struct rio_mport * mport- RIO mport to perform DMA data transfers
Description
Returns pointer to allocated DMA channel or NULL if failed.
-
struct dma_chan *
rio_request_dma(struct rio_dev * rdev)¶ request RapidIO capable DMA channel that supports specified target RapidIO device.
Parameters
struct rio_dev * rdev- RIO device associated with DMA transfer
Description
Returns pointer to allocated DMA channel or NULL if failed.
-
void
rio_release_dma(struct dma_chan * dchan)¶ release specified DMA channel
Parameters
struct dma_chan * dchan- DMA channel to release
-
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)¶ RapidIO specific wrapper for device_prep_slave_sg callback defined by DMAENGINE.
Parameters
struct dma_chan * dchan- DMA channel to configure
u16 destid- target RapidIO device destination ID
struct rio_dma_data * data- RIO specific data descriptor
enum dma_transfer_direction direction- DMA data transfer direction (TO or FROM the device)
unsigned long flags- dmaengine defined flags
Description
Initializes RapidIO capable DMA channel for the specified data transfer. Uses DMA channel private extension to pass information related to remote target RIO device.
Return
- pointer to DMA transaction descriptor if successful,
- error-valued pointer or NULL if failed.
-
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)¶ RapidIO specific wrapper for device_prep_slave_sg callback defined by DMAENGINE.
Parameters
struct rio_dev * rdev- RIO device control structure
struct dma_chan * dchan- DMA channel to configure
struct rio_dma_data * data- RIO specific data descriptor
enum dma_transfer_direction direction- DMA data transfer direction (TO or FROM the device)
unsigned long flags- dmaengine defined flags
Description
Initializes RapidIO capable DMA channel for the specified data transfer. Uses DMA channel private extension to pass information related to remote target RIO device.
Return
- pointer to DMA transaction descriptor if successful,
- error-valued pointer or NULL if failed.
-
int
rio_register_scan(int mport_id, struct rio_scan * scan_ops)¶ enumeration/discovery method registration interface
Parameters
int mport_id- mport device ID for which fabric scan routine has to be set (RIO_MPORT_ANY = set for all available mports)
struct rio_scan * scan_ops- enumeration/discovery operations structure
Description
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).
-
int
rio_unregister_scan(int mport_id, struct rio_scan * scan_ops)¶ removes enumeration/discovery method from mport
Parameters
int 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)
struct rio_scan * scan_ops- enumeration/discovery operations structure
Description
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.
Internals¶
This chapter contains the autogenerated documentation of the RapidIO subsystem.
Structures¶
-
struct
rio_switch¶ RIO switch info
Definition
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;
};
Members
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- Array of per-port pointers to the next attached device
-
struct
rio_switch_ops¶ Per-switch operations
Definition
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);
};
Members
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
Description
Defines the operations that are necessary to initialize/control a particular RIO switch device.
-
struct
rio_dev¶ RIO device info
Definition
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 phys_rmap;
u32 em_efptr;
u64 dma_mask;
struct rio_driver * driver;
struct device dev;
struct resource riores;
int (* pwcback) (struct rio_dev *rdev, union rio_pw_msg *msg, int step);
u16 destid;
u8 hopcount;
struct rio_dev * prev;
atomic_t state;
struct rio_switch rswitch;
};
Members
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
phys_rmap- LP-Serial Register Map Type (1 or 2)
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 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
state- device state
rswitch- struct rio_switch (if valid for this device)
-
struct
rio_msg¶ RIO message event
Definition
struct rio_msg {
struct resource * res;
void (* mcback) (struct rio_mport * mport, void *dev_id, int mbox, int slot);
};
Members
res- Mailbox resource
mcback- Message event callback
-
struct
rio_dbell¶ RIO doorbell event
Definition
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;
};
Members
node- Node in list of doorbell events
res- Doorbell resource
dinb- Doorbell event callback
dev_id- Device specific pointer to pass on event
-
struct
rio_mport¶ RIO master port info
Definition
struct rio_mport {
struct list_head dbells;
struct list_head pwrites;
struct list_head node;
struct list_head nnode;
struct rio_net * net;
struct mutex lock;
struct resource iores;
struct resource riores;
struct rio_msg inb_msg;
struct rio_msg outb_msg;
int host_deviceid;
struct rio_ops * ops;
unsigned char id;
unsigned char index;
unsigned int sys_size;
u32 phys_efptr;
u32 phys_rmap;
unsigned char name;
struct device dev;
void * priv;
#ifdef CONFIG_RAPIDIO_DMA_ENGINE
struct dma_device dma;
#endif
struct rio_scan * nscan;
atomic_t state;
unsigned int pwe_refcnt;
};
Members
dbells- List of doorbell events
pwrites- List of portwrite events
node- Node in global list of master ports
nnode- Node in network list of master ports
net- RIO net this mport is attached to
lock- lock to synchronize lists manipulations
iores- I/O mem resource that this master port interface owns
riores- RIO resources that this master port interfaces owns
inb_msg- RIO inbound message event descriptors
outb_msg- 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
phys_efptr- RIO port extended features pointer
phys_rmap- LP-Serial EFB Register Mapping type (1 or 2).
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
state- mport device state
pwe_refcnt- port-write enable ref counter to track enable/disable requests
-
struct
rio_net¶ RIO network info
Definition
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 device dev;
void * enum_data;
void (* release) (struct rio_net *net);
};
Members
node- Node in global list of RIO networks
devices- List of devices in this network
switches- List of switches in this network
mports- List of master ports accessing this network
hport- Default port for accessing this network
id- RIO network ID
dev- Device object
enum_data- private data specific to a network enumerator
release- enumerator-specific release callback
-
struct
rio_mport_attr¶ RIO mport device attributes
Definition
struct rio_mport_attr {
int flags;
int link_speed;
int link_width;
int dma_max_sge;
int dma_max_size;
int dma_align;
};
Members
flags- mport device capability flags
link_speed- SRIO link speed value (as defined by RapidIO specification)
link_width- SRIO link width value (as defined by RapidIO specification)
dma_max_sge- number of SG list entries that can be handled by DMA channel(s)
dma_max_size- max number of bytes in single DMA transfer (SG entry)
dma_align- alignment shift for DMA operations (as for other DMA operations)
-
struct
rio_ops¶ Low-level RIO configuration space operations
Definition
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, u64 size, u32 flags);
void (* unmap_inb) (struct rio_mport *mport, dma_addr_t lstart);
int (* query_mport) (struct rio_mport *mport, struct rio_mport_attr *attr);
int (* map_outb) (struct rio_mport *mport, u16 destid, u64 rstart, u32 size, u32 flags, dma_addr_t *laddr);
void (* unmap_outb) (struct rio_mport *mport, u16 destid, u64 rstart);
};
Members
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(). query_mport- Callback to query mport device attributes.
map_outb- Callback to map outbound address region into local memory space.
unmap_outb- Callback to unmap outbound RapidIO address region.
-
struct
rio_driver¶ RIO driver info
Definition
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);
void (* shutdown) (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;
};
Members
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
shutdown- shutdown notification callback
suspend- RIO device suspended
resume- RIO device awakened
enable_wake- RIO device enable wake event
driver- LDM driver struct
Description
Provides info on a RIO device driver for insertion/removal and power management purposes.
-
struct
rio_scan¶ RIO enumeration and discovery operations
Definition
struct rio_scan {
struct module * owner;
int (* enumerate) (struct rio_mport *mport, u32 flags);
int (* discover) (struct rio_mport *mport, u32 flags);
};
Members
owner- The module owner of this structure
enumerate- Callback to perform RapidIO fabric enumeration.
discover- Callback to perform RapidIO fabric discovery.
-
struct
rio_scan_node¶ list node to register RapidIO enumeration and discovery methods with RapidIO core.
Definition
struct rio_scan_node {
int mport_id;
struct list_head node;
struct rio_scan * ops;
};
Members
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
Enumeration and Discovery¶
Parameters
struct rio_net * net- RIO network
Description
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.
Parameters
struct rio_net * net- RIO network
u16 destid- destID to reserve
Description
Tries to reserve the specified destID. Returns 0 if successful.
Parameters
struct rio_net * net- RIO network
u16 destid- destID to free
Description
Makes the specified destID available for use.
Parameters
struct rio_net * net- RIO network
Parameters
struct rio_net * net- RIO network
u16 from- destination ID from which search shall continue
-
u16
rio_get_device_id(struct rio_mport * port, u16 destid, u8 hopcount)¶ Get the base/extended device id for a device
Parameters
struct rio_mport * port- RIO master port
u16 destid- Destination ID of device
u8 hopcount- Hopcount to device
Description
Reads the base/extended device id from a device. Returns the 8/16-bit device ID.
-
void
rio_set_device_id(struct rio_mport * port, u16 destid, u8 hopcount, u16 did)¶ Set the base/extended device id for a device
Parameters
struct rio_mport * port- RIO master port
u16 destid- Destination ID of device
u8 hopcount- Hopcount to device
u16 did- Device ID value to be written
Description
Writes the base/extended device id from a device.
Parameters
struct rio_net * net- RIO network to run on
Description
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.
Parameters
struct rio_mport * port- Master port to issue transaction
Description
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.
-
int
rio_device_has_destid(struct rio_mport * port, int src_ops, int dst_ops)¶ Test if a device contains a destination ID register
Parameters
struct rio_mport * port- Master port to issue transaction
int src_ops- RIO device source operations
int dst_ops- RIO device destination operations
Description
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.
Parameters
struct device * dev- LDM device associated with a RIO device struct
Description
Gets the RIO device struct associated a RIO device struct. The RIO device struct is freed.
Parameters
struct rio_dev * rdev- RIO device
Description
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.
-
struct rio_dev *
rio_setup_device(struct rio_net * net, struct rio_mport * port, u16 destid, u8 hopcount, int do_enum)¶ Allocates and sets up a RIO device
Parameters
struct rio_net * net- RIO network
struct rio_mport * port- Master port to send transactions
u16 destid- Current destination ID
u8 hopcount- Current hopcount
int do_enum- Enumeration/Discovery mode flag
Description
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.
-
int
rio_sport_is_active(struct rio_dev * rdev, int sp)¶ Tests if a switch port has an active connection.
Parameters
struct rio_dev * rdev- RapidIO device object
int sp- Switch port number
Description
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.
-
u16
rio_get_host_deviceid_lock(struct rio_mport * port, u8 hopcount)¶ Reads the Host Device ID Lock CSR on a device
Parameters
struct rio_mport * port- Master port to send transaction
u8 hopcount- Number of hops to the device
Description
Used during enumeration to read the Host Device ID Lock CSR on a RIO device. Returns the value of the lock register.
-
int
rio_enum_peer(struct rio_net * net, struct rio_mport * port, u8 hopcount, struct rio_dev * prev, int prev_port)¶ Recursively enumerate a RIO network through a master port
Parameters
struct rio_net * net- RIO network being enumerated
struct rio_mport * port- Master port to send transactions
u8 hopcount- Number of hops into the network
struct rio_dev * prev- Previous RIO device connected to the enumerated one
int prev_port- Port on previous RIO device
Description
Recursively enumerates a RIO network. Transactions are sent via the master port passed in port.
Parameters
struct rio_mport * port- Master port to send transaction
Description
Tests the PGCCSR discovered bit for non-zero value (enumeration
complete flag). Return 1 if enumeration is complete or 0 if
enumeration is incomplete.
-
int
rio_disc_peer(struct rio_net * net, struct rio_mport * port, u16 destid, u8 hopcount, struct rio_dev * prev, int prev_port)¶ Recursively discovers a RIO network through a master port
Parameters
struct rio_net * net- RIO network being discovered
struct rio_mport * port- Master port to send transactions
u16 destid- Current destination ID in network
u8 hopcount- Number of hops into the network
struct rio_dev * prev- previous rio_dev
int prev_port- previous port number
Description
Recursively discovers a RIO network. Transactions are sent via the master port passed in port.
Parameters
struct rio_mport * port- Master port to test
Description
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.
Parameters
struct rio_net * net- RIO network to run update on
Description
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.
Parameters
struct rio_dev * rdev- RIO device
Description
For each enumerated switch, call device-specific error management initialization routine (if supplied by the switch driver).
Parameters
struct rio_mport * mport- Master port to send transactions
u32 flags- Enumeration control flags
Description
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.
Parameters
struct rio_net * net- RIO network to run route tables scan on
Description
For each switch device, generate a route table by copying existing route entries from the switch.
Parameters
struct rio_mport * mport- Master port to send transactions
u32 flags- discovery control flags
Description
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.
-
int
rio_basic_attach(void)¶
Parameters
void- no arguments
Description
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.
Driver functionality¶
-
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)¶ bind inbound doorbell callback
Parameters
struct rio_mport * mport- RIO master port to bind the doorbell callback
void * dev_id- Device specific pointer to pass on event
struct resource * res- Doorbell message resource
void (*) (struct rio_mport * mport, void *dev_id, u16 src, u16 dst, u16 info) dinb- Callback to execute when doorbell is received
Description
Adds a doorbell resource/callback pair into a port’s doorbell event list. Returns 0 if the request has been satisfied.
-
int
rio_chk_dev_route(struct rio_dev * rdev, struct rio_dev ** nrdev, int * npnum)¶ Validate route to the specified device.
Parameters
struct rio_dev * rdev- RIO device failed to respond
struct rio_dev ** nrdev- Last active device on the route to rdev
int * npnum- nrdev’s port number on the route to rdev
Description
Follows a route to the specified RIO device to determine the last available device (and corresponding RIO port) on the route.
Parameters
struct rio_dev * rdev- Pointer to RIO device control structure
-
int
rio_get_input_status(struct rio_dev * rdev, int pnum, u32 * lnkresp)¶ Sends a Link-Request/Input-Status control symbol and returns link-response (if requested).
Parameters
struct rio_dev * rdev- RIO devive to issue Input-status command
int pnum- Device port number to issue the command
u32 * lnkresp- Response from a link partner
-
int
rio_clr_err_stopped(struct rio_dev * rdev, u32 pnum, u32 err_status)¶ Clears port Error-stopped states.
Parameters
struct rio_dev * rdev- Pointer to RIO device control structure
u32 pnum- Switch port number to clear errors
u32 err_status- port error status (if 0 reads register from device)
Description
TODO: Currently this routine is not compatible with recovery process specified for idt_gen3 RapidIO switch devices. It has to be reviewed to implement universal recovery process that is compatible full range off available devices. IDT gen3 switch driver now implements HW-specific error handler that issues soft port reset to the port to reset ERR_STOP bits and ackIDs.
-
int
rio_std_route_add_entry(struct rio_mport * mport, u16 destid, u8 hopcount, u16 table, u16 route_destid, u8 route_port)¶ Add switch route table entry using standard registers defined in RIO specification rev.1.3
Parameters
struct rio_mport * mport- Master port to issue transaction
u16 destid- Destination ID of the device
u8 hopcount- Number of switch hops to the device
u16 table- routing table ID (global or port-specific)
u16 route_destid- destID entry in the RT
u8 route_port- destination port for specified destID
-
int
rio_std_route_get_entry(struct rio_mport * mport, u16 destid, u8 hopcount, u16 table, u16 route_destid, u8 * route_port)¶ Read switch route table entry (port number) associated with specified destID using standard registers defined in RIO specification rev.1.3
Parameters
struct rio_mport * mport- Master port to issue transaction
u16 destid- Destination ID of the device
u8 hopcount- Number of switch hops to the device
u16 table- routing table ID (global or port-specific)
u16 route_destid- destID entry in the RT
u8 * route_port- returned destination port for specified destID
-
int
rio_std_route_clr_table(struct rio_mport * mport, u16 destid, u8 hopcount, u16 table)¶ Clear swotch route table using standard registers defined in RIO specification rev.1.3.
Parameters
struct rio_mport * mport- Master port to issue transaction
u16 destid- Destination ID of the device
u8 hopcount- Number of switch hops to the device
u16 table- routing table ID (global or port-specific)
Parameters
int mport_id- number (ID) of mport device
Description
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.
-
int
rio_mport_scan(int mport_id)¶ execute enumeration/discovery on the specified mport
Parameters
int mport_id- number (ID) of mport device
-
RIO_LOP_READ(size, type, len)¶ Generate rio_local_read_config_* functions
Parameters
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)
Description
Generates rio_local_read_config_* functions used to access configuration space registers on the local device.
-
RIO_LOP_WRITE(size, type, len)¶ Generate rio_local_write_config_* functions
Parameters
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)
Description
Generates rio_local_write_config_* functions used to access configuration space registers on the local device.
-
RIO_OP_READ(size, type, len)¶ Generate rio_mport_read_config_* functions
Parameters
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)
Description
Generates rio_mport_read_config_* functions used to access configuration space registers on the local device.
-
RIO_OP_WRITE(size, type, len)¶ Generate rio_mport_write_config_* functions
Parameters
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)
Description
Generates rio_mport_write_config_* functions used to access configuration space registers on the local device.
Device model support¶
-
const struct rio_device_id *
rio_match_device(const struct rio_device_id * id, const struct rio_dev * rdev)¶ Tell if a RIO device has a matching RIO device id structure
Parameters
const struct rio_device_id * id- the RIO device id structure to match against
const struct rio_dev * rdev- the RIO device structure to match against
Description
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 matchingstruct rio_device_idorNULLif there is no match.
-
int
rio_device_probe(struct device * dev)¶ Tell if a RIO device structure has a matching RIO device id structure
Parameters
struct device * dev- the RIO device structure to match against
Description
return 0 and set rio_dev->driver when drv claims rio_dev, else error
Parameters
struct device * dev- the RIO device structure to match against
Description
Remove a RIO device from the system. If it has an associated
driver, then run the driver remove() method. Then update
the reference count.
-
int
rio_match_bus(struct device * dev, struct device_driver * drv)¶ Tell if a RIO device structure has a matching RIO driver device id structure
Parameters
struct device * dev- the standard device structure to match against
struct device_driver * drv- the standard driver structure containing the ids to match against
Description
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 matchingstruct rio_device_idor 0 if there is no match.
-
int
rio_bus_init(void)¶ Register the RapidIO bus with the device model
Parameters
void- no arguments
Description
Registers the RIO mport device class and RIO bus type with the Linux device model.
PPC32 support¶
-
int
fsl_local_config_read(struct rio_mport * mport, int index, u32 offset, int len, u32 * data)¶ Generate a MPC85xx local config space read
Parameters
struct rio_mport * mport- RapidIO master port info
int index- ID of RapdiIO interface
u32 offset- Offset into configuration space
int len- Length (in bytes) of the maintenance transaction
u32 * data- Value to be read into
Description
Generates a MPC85xx local configuration space read. Returns 0 on
success or -EINVAL on failure.
-
int
fsl_local_config_write(struct rio_mport * mport, int index, u32 offset, int len, u32 data)¶ Generate a MPC85xx local config space write
Parameters
struct rio_mport * mport- RapidIO master port info
int index- ID of RapdiIO interface
u32 offset- Offset into configuration space
int len- Length (in bytes) of the maintenance transaction
u32 data- Value to be written
Description
Generates a MPC85xx local configuration space write. Returns 0 on
success or -EINVAL on failure.
-
int
fsl_rio_config_read(struct rio_mport * mport, int index, u16 destid, u8 hopcount, u32 offset, int len, u32 * val)¶ Generate a MPC85xx read maintenance transaction
Parameters
struct rio_mport * mport- RapidIO master port info
int index- ID of RapdiIO interface
u16 destid- Destination ID of transaction
u8 hopcount- Number of hops to target device
u32 offset- Offset into configuration space
int len- Length (in bytes) of the maintenance transaction
u32 * val- Location to be read into
Description
Generates a MPC85xx read maintenance transaction. Returns 0 on
success or -EINVAL on failure.
-
int
fsl_rio_config_write(struct rio_mport * mport, int index, u16 destid, u8 hopcount, u32 offset, int len, u32 val)¶ Generate a MPC85xx write maintenance transaction
Parameters
struct rio_mport * mport- RapidIO master port info
int index- ID of RapdiIO interface
u16 destid- Destination ID of transaction
u8 hopcount- Number of hops to target device
u32 offset- Offset into configuration space
int len- Length (in bytes) of the maintenance transaction
u32 val- Value to be written
Description
Generates an MPC85xx write maintenance transaction. Returns 0 on
success or -EINVAL on failure.
-
int
fsl_rio_setup(struct platform_device * dev)¶ Setup Freescale PowerPC RapidIO interface
Parameters
struct platform_device * dev- platform_device pointer
Description
Initializes MPC85xx RapidIO hardware interface, configures master port with system-specific info, and registers the master port with the RapidIO subsystem.
Credits¶
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