The Linux Manuals (man pages) document is an important part of Linux documents. Linux Manuals are organized as several sections. Each section has a group of commands for a specific area in Linux usage, administration or development.
rio_inb_pwrite_handler – inbound port-write message handler Synopsis int rio_inb_pwrite_handler(struct rio_mport *mport, union rio_pw_msg *pw_msg); Arguments mport mport device associated with port-write pw_msg pointer to inbound port-write message Description Processes an inbound port-write message. Returns 0 if the request has been satisfied. Author Matt Porter <mporter [at] kernel.crashing.org>, <mporter [at] mvista.com> Author. Copyright
rio_get_input_status – Sends a Link-Request/Input-Status control symbol and returns link-response (if requested). Synopsis int rio_get_input_status(struct rio_dev *rdev, int pnum, u32 *lnkresp); Arguments rdev RIO devive to issue Input-status command pnum Device port number to issue the command lnkresp Response from a link partner Author Matt Porter <mporter [at] kernel.crashing.org>, <mporter [at] mvista.com> Author. Copyright
rio_get_inb_message – Get A RIO message from an inbound mailbox queue Synopsis void *rio_get_inb_message(struct rio_mport *mport, int mbox); Arguments mport Master port containing the inbound mailbox mbox The inbound mailbox number Description Get a RIO message from an inbound mailbox queue. Returns 0 on success. Author Matt Porter <mporter [at] kernel.crashing.org>, <mporter [at] mvista.com> Author….
rio_get_host_deviceid_lock – Reads the Host Device ID Lock CSR on a device Synopsis u16 rio_get_host_deviceid_lock(struct rio_mport * port, u8 hopcount); Arguments port Master port to send transaction 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. Author…
rio_get_drvdata – Get RIO driver specific data Synopsis void *rio_get_drvdata(struct rio_dev *rdev); Arguments rdev RIO device Description Get RIO driver specific data. Returns a pointer to the driver specific data. Author Matt Porter <mporter [at] kernel.crashing.org>, <mporter [at] mvista.com> Author. Copyright
rio_get_device_id – Get the base/extended device id for a device Synopsis u16 rio_get_device_id(struct rio_mport * port, u16 destid, u8 hopcount); Arguments port RIO master port destid Destination ID of device hopcount Hopcount to device Description Reads the base/extended device id from a device. Returns the 8/16-bit device ID. Author Matt Porter <mporter [at] kernel.crashing.org>, <mporter [at] mvista.com> Author. Copyright
rio_get_device – Begin or continue searching for a RIO device by vid/did Synopsis struct rio_dev * rio_get_device(u16 vid, u16 did, struct rio_dev * from); Arguments 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…
rio_get_comptag – Begin or continue searching for a RIO device by component tag Synopsis struct rio_dev *rio_get_comptag(u32 comp_tag, struct rio_dev *from); Arguments comp_tag RIO component tag to match from Previous RIO device found in search, or NULL for new search Description Iterates through the list of known RIO devices. If a RIO device is found…
rio_get_asm – Begin or continue searching for a RIO device by vid/did/asm_vid/asm_did Synopsis struct rio_dev * rio_get_asm(u16 vid, u16 did, u16 asm_vid, u16 asm_did, struct rio_dev * from); Arguments 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…
rio_find_mport – find RIO mport by its ID Synopsis struct rio_mport *rio_find_mport(int mport_id); Arguments 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,…
rio_enum_peer – Recursively enumerate a RIO network through a master port Synopsis int rio_enum_peer(struct rio_net *net, struct rio_mport *port, u8 hopcount, struct rio_dev *prev, int prev_port); Arguments 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…
rio_enum_mport – Start enumeration through a master port Synopsis int rio_enum_mport(struct rio_mport *mport, u32 flags); Arguments mport Master port to send transactions 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….
rio_enum_host – Set host lock and initialize host destination ID Synopsis int rio_enum_host(struct rio_mport *port); Arguments 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…
rio_enum_complete – Tests if enumeration of a network is complete Synopsis int rio_enum_complete(struct rio_mport *port); Arguments 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. Author Matt Porter <mporter [at] kernel.crashing.org>, <mporter [at] mvista.com>…
rio_enable_rx_tx_port – enable input receiver and output transmitter of given port Synopsis int rio_enable_rx_tx_port(struct rio_mport *port, int local, u16 destid, u8 hopcount, u8 port_num); Arguments 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…
rio_dma_prep_xfer – RapidIO specific wrapper for device_prep_slave_sg callback defined by DMAENGINE. Synopsis 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); Arguments 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)…
rio_dma_prep_slave_sg – RapidIO specific wrapper for device_prep_slave_sg callback defined by DMAENGINE. Synopsis 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); Arguments 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)…
rio_disc_peer – Recursively discovers a RIO network through a master port Synopsis int rio_disc_peer(struct rio_net *net, struct rio_mport *port, u16 destid, u8 hopcount, struct rio_dev *prev, int prev_port); Arguments 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_disc_mport – Start discovery through a master port Synopsis int rio_disc_mport(struct rio_mport *mport, u32 flags); Arguments mport Master port to send transactions 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,…
rio_device_remove – Remove a RIO device from the system Synopsis int rio_device_remove(struct device *dev); Arguments 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. Author Matt Porter <mporter [at] kernel.crashing.org>, <mporter…