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_device_probe – Tell if a RIO device structure has a matching RIO device id structure Synopsis int rio_device_probe(struct device *dev); Arguments dev the RIO device structure to match against Description return 0 and set rio_dev->driver when drv claims rio_dev, else error Author Matt Porter <mporter [at] kernel.crashing.org>, <mporter [at] mvista.com> Author. Copyright
rio_device_has_destid – Test if a device contains a destination ID register Synopsis int rio_device_has_destid(struct rio_mport *port, int src_ops, int dst_ops); Arguments port Master port to issue transaction src_ops RIO device source operations 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…
rio_dev_put – Release a use of the RIO device structure Synopsis void rio_dev_put(struct rio_dev *rdev); Arguments 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. Author Matt Porter…
rio_dev_get – Increments the reference count of the RIO device structure Synopsis struct rio_dev *rio_dev_get(struct rio_dev *rdev); Arguments 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…
rio_destid_reserve – Reserve the specivied destID Synopsis int rio_destid_reserve(struct rio_net *net, u16 destid); Arguments net RIO network destid destID to reserve Description Tries to reserve the specified destID. Returns 0 if successful. Author Matt Porter <mporter [at] kernel.crashing.org>, <mporter [at] mvista.com> Author. Copyright
rio_destid_next – return next destID in use Synopsis u16 rio_destid_next(struct rio_net * net, u16 from); Arguments net RIO network from destination ID from which search shall continue Author Matt Porter <mporter [at] kernel.crashing.org>, <mporter [at] mvista.com> Author. Copyright
rio_destid_free – free a previously allocated destID Synopsis void rio_destid_free(struct rio_net *net, u16 destid); Arguments net RIO network destid destID to free Description Makes the specified destID available for use. Author Matt Porter <mporter [at] kernel.crashing.org>, <mporter [at] mvista.com> Author. Copyright
rio_destid_first – return first destID in use Synopsis u16 rio_destid_first(struct rio_net * net); Arguments net RIO network Author Matt Porter <mporter [at] kernel.crashing.org>, <mporter [at] mvista.com> Author. Copyright
rio_destid_alloc – Allocate next available destID for given network Synopsis u16 rio_destid_alloc(struct rio_net * net); Arguments 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. Author Matt Porter <mporter [at] kernel.crashing.org>, <mporter [at] mvista.com> Author. Copyright
rio_del_mport_pw_handler – remove port-write message handler from the list of mport specific pw handlers Synopsis 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)); Arguments mport RIO master port to bind the portwrite callback context Registered handler specific context to pass on event pwcback Registered callback function…
rio_create_sysfs_dev_files – create RIO specific sysfs files Synopsis int rio_create_sysfs_dev_files(struct rio_dev *rdev); Arguments rdev device whose entries should be created Description Create files when rdev is added to sysfs. Author Matt Porter <mporter [at] kernel.crashing.org>, <mporter [at] mvista.com> Author. Copyright
rio_clr_err_stopped – Clears port Error-stopped states. Synopsis int rio_clr_err_stopped(struct rio_dev *rdev, u32 pnum, u32 err_status); Arguments 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) Description TODO: Currently this routine is not compatible with recovery process specified for idt_gen3 RapidIO…
rio_clear_locks – Release all host locks and signal enumeration complete Synopsis int rio_clear_locks(struct rio_net *net); Arguments 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….
rio_chk_dev_route – Validate route to the specified device. Synopsis int rio_chk_dev_route(struct rio_dev *rdev, struct rio_dev **nrdev, int *npnum); Arguments 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 Description Follows a route to the specified RIO device to determine the…
rio_chk_dev_access – Validate access to the specified device. Synopsis int rio_chk_dev_access(struct rio_dev *rdev); Arguments rdev Pointer to RIO device control structure Author Matt Porter <mporter [at] kernel.crashing.org>, <mporter [at] mvista.com> Author. Copyright
rio_bus_init – Register the RapidIO bus with the device model Synopsis int rio_bus_init(void); Arguments void no arguments Description Registers the RIO mport device class and RIO bus type with the Linux device model. Author Matt Porter <mporter [at] kernel.crashing.org>, <mporter [at] mvista.com> Author. Copyright
rio_build_route_tables – Generate route tables from switch route entries Synopsis void rio_build_route_tables(struct rio_net *net); Arguments 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. Author Matt Porter <mporter [at] kernel.crashing.org>, <mporter [at] mvista.com> Author. Copyright
rio_basic_attach – Synopsis int rio_basic_attach(void); Arguments 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…
rio_alloc_net – Allocate and initialize a new RIO network data structure Synopsis struct rio_net *rio_alloc_net(struct rio_mport *mport); Arguments 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…
rio_add_outb_message – Add RIO message to an outbound mailbox queue Synopsis int rio_add_outb_message(struct rio_mport *mport, struct rio_dev *rdev, int mbox, void *buffer, size_t len); Arguments 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…