Parameters

structrio_mport*port

Master port

u32offset

Offset into local configuration space

u32*data

Pointer to read data into

Description

Reads 32 bits of data from the specified offset within the localdevice’s configuration space.

Parameters

structrio_mport*port

Master port

u32offset

Offset into local configuration space

u32data

Data to be written

Description

Writes 32 bits of data to the specified offset within the localdevice’s configuration space.

Parameters

structrio_mport*port

Master port

u32offset

Offset into local configuration space

u16*data

Pointer to read data into

Description

Reads 16 bits of data from the specified offset within the localdevice’s configuration space.

Parameters

structrio_mport*port

Master port

u32offset

Offset into local configuration space

u16data

Data to be written

Description

Writes 16 bits of data to the specified offset within the localdevice’s configuration space.

Parameters

structrio_mport*port

Master port

u32offset

Offset into local configuration space

u8*data

Pointer to read data into

Description

Reads 8 bits of data from the specified offset within the localdevice’s configuration space.

Parameters

structrio_mport*port

Master port

u32offset

Offset into local configuration space

u8data

Data to be written

Description

Writes 8 bits of data to the specified offset within the localdevice’s configuration space.

Parameters

structrio_dev*rdev

RIO device

u32offset

Offset into device configuration space

u32*data

Pointer to read data into

Description

Reads 32 bits of data from the specified offset within theRIO device’s configuration space.

Parameters

structrio_dev*rdev

RIO device

u32offset

Offset into device configuration space

u32data

Data to be written

Description

Writes 32 bits of data to the specified offset within theRIO device’s configuration space.

Parameters

structrio_dev*rdev

RIO device

u32offset

Offset into device configuration space

u16*data

Pointer to read data into

Description

Reads 16 bits of data from the specified offset within theRIO device’s configuration space.

Parameters

structrio_dev*rdev

RIO device

u32offset

Offset into device configuration space

u16data

Data to be written

Description

Writes 16 bits of data to the specified offset within theRIO device’s configuration space.

Parameters

structrio_dev*rdev

RIO device

u32offset

Offset into device configuration space

u8*data

Pointer to read data into

Description

Reads 8 bits of data from the specified offset within theRIO device’s configuration space.

Parameters

structrio_dev*rdev

RIO device

u32offset

Offset into device configuration space

u8data

Data to be written

Description

Writes 8 bits of data to the specified offset within theRIO device’s configuration space.

Parameters

structrio_dev*rdev

RIO device

u16data

Doorbell message data

Description

Send a doorbell message to a RIO device. The doorbell messagehas a 16-bit info field provided by thedata argument.

Parameters

structresource*res

resource struct

intstart

start of mailbox range

intend

end of mailbox range

Description

This function is used to initialize the fields of a resourcefor use as a mailbox resource. It initializes a range ofmailboxes using the start and end arguments.

Parameters

structresource*res

resource struct

u16start

start of doorbell range

u16end

end of doorbell range

Description

This function is used to initialize the fields of a resourcefor use as a doorbell resource. It initializes a range ofdoorbell messages using the start and end arguments.

Parameters

dev

the 16 bit RIO device ID

ven

the 16 bit RIO vendor ID

Description

This macro is used to create astructrio_device_id that matches aspecific device. The assembly vendor and assembly device fieldswill be set toRIO_ANY_ID.

Parameters

structrio_mport*mport

RIO master port containing the outbound queue

structrio_dev*rdev

RIO device the message is be sent to

intmbox

The outbound mailbox queue

void*buffer

Pointer to the message buffer

size_tlen

Length of the message buffer

Description

Adds a RIO message buffer to an outbound mailbox queue fortransmission. Returns 0 on success.

Parameters

structrio_mport*mport

Master port containing the inbound mailbox

intmbox

The inbound mailbox number

void*buffer

Pointer to the message buffer

Description

Adds a buffer to an inbound mailbox queue for reception. Returns0 on success.

Parameters

structrio_mport*mport

Master port containing the inbound mailbox

intmbox

The inbound mailbox number

Description

Get a RIO message from an inbound mailbox queue. Returns 0 on success.

Parameters

structrio_dev*rdev

RIO device

Description

Get the unique RIO device identifier. Returns the deviceidentifier string.

Parameters

structrio_dev*rdev

RIO device

Description

Get RIO driver specific data. Returns a pointer to thedriver specific data.

Parameters

structrio_dev*rdev

RIO device

void*data

Pointer to driver specific data

Description

Set RIO driver specific data. devicestructdriver data pointeris set to thedata argument.

Parameters

structrio_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 intheirprobe() methods, when they bind to a device, and releasethem by callingrio_dev_put(), in theirdisconnect() methods.

Parameters

structrio_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, thememory of the device is freed.

Parameters

structrio_driver*rdrv

the RIO driver structure to register

Description

Adds astructrio_driver to the list of registered drivers.Returns a negative value on error, otherwise 0. If no erroroccurred, the driver remains registered even if no devicewas claimed during registration.

Parameters

structrio_driver*rdrv

the RIO driver structure to unregister

Description

Deletes thestructrio_driver from the list of registered RIOdrivers, gives it a chance to clean up by calling itsremove()function for each device it was responsible for, and marks thosedevices as driverless.

Parameters

structrio_mport*port

RIO master port from which to get the deviceid

Description

Reads the base/extended device id from the local deviceimplementing the master port. Returns the 8/16-bit deviceid.

Parameters

structrio_mport*port

mport device to query

structrio_mport_attr*mport_attr

mport attributes data structure

Description

Returns attributes of specified mport through thepointer to attributes data structure.

Parameters

structrio_mport*mport

Master port associated with the RIO network

Description

Allocates a RIO network structure, initializes per-networklist heads, and adds the associated master port to thenetwork list of associated master ports. Returns aRIO network pointer on success orNULL on failure.

Parameters

structrio_mport*port

RIO master port

u16did

Device ID value to be written

Description

Writes the base/extended device id from a device.

Parameters

structrio_dev*rdev

RIO device

Description

Adds the RIO device to the global device list and adds the RIOdevice to the RIO device list. Creates the generic sysfs nodesfor an RIO device.

Parameters

structrio_mport*mport

RIO master port from which to allocate the mailbox resource

void*dev_id

Device specific pointer to pass on event

intmbox

Mailbox number to claim

intentries

Number of entries in inbound mailbox queue

void(*minb)(structrio_mport*mport,void*dev_id,intmbox,intslot)

Callback to execute when inbound message is received

Description

Requests ownership of an inbound mailbox resource and bindsa callback function to the resource. Returns0 on success.

Parameters

structrio_mport*mport

RIO master port from which to release the mailbox resource

intmbox

Mailbox number to release

Description

Releases ownership of an inbound mailbox resource. Returns 0if the request has been satisfied.

Parameters

structrio_mport*mport

RIO master port from which to allocate the mailbox resource

void*dev_id

Device specific pointer to pass on event

intmbox

Mailbox number to claim

intentries

Number of entries in outbound mailbox queue

void(*moutb)(structrio_mport*mport,void*dev_id,intmbox,intslot)

Callback to execute when outbound message is sent

Description

Requests ownership of an outbound mailbox resource and bindsa callback function to the resource. Returns 0 on success.

Parameters

structrio_mport*mport

RIO master port from which to release the mailbox resource

intmbox

Mailbox number to release

Description

Releases ownership of an inbound mailbox resource. Returns 0if the request has been satisfied.

Parameters

structrio_mport*mport

RIO master port from which to allocate the doorbell resource

void*dev_id

Device specific pointer to pass on event

u16start

Doorbell info range start

u16end

Doorbell info range end

void(*dinb)(structrio_mport*mport,void*dev_id,u16src,u16dst,u16info)

Callback to execute when doorbell is received

Description

Requests ownership of an inbound doorbell resource and bindsa callback function to the resource. Returns 0 if the requesthas been satisfied.

Parameters

structrio_mport*mport

RIO master port from which to release the doorbell resource

u16start

Doorbell info range start

u16end

Doorbell info range end

Description

Releases ownership of an inbound doorbell resource and removescallback from the doorbell event list. Returns 0 if the requesthas been satisfied.

Parameters

structrio_dev*rdev

RIO device from which to allocate the doorbell resource

u16start

Doorbell message range start

u16end

Doorbell message range end

Description

Requests ownership of a doorbell message range. Returns a resourceif the request has been satisfied orNULL on failure.

Parameters

structrio_dev*rdev

RIO device from which to release the doorbell resource

structresource*res

Doorbell resource to be freed

Description

Releases ownership of a doorbell message range. Returns 0 if therequest has been satisfied.

Parameters

structrio_mport*mport

RIO master port to bind the portwrite callback

void*context

Handler specific context to pass on event

int(*pwcback)(structrio_mport*mport,void*context,unionrio_pw_msg*msg,intstep)

Callback to execute when portwrite is received

Description

Returns 0 if the request has been satisfied.

Parameters

structrio_mport*mport

RIO master port to bind the portwrite callback

void*context

Registered handler specific context to pass on event

int(*pwcback)(structrio_mport*mport,void*context,unionrio_pw_msg*msg,intstep)

Registered callback function

Description

Returns 0 if the request has been satisfied.

Parameters

structrio_dev*rdev

RIO device to which register inbound port-write callback routine

int(*pwcback)(structrio_dev*rdev,unionrio_pw_msg*msg,intstep)

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.

Parameters

structrio_dev*rdev

RIO device which registered for inbound port-write callback

Description

Removes callback from the rio_dev structure. Returns 0 if the requesthas been satisfied.

Parameters

structrio_mport*mport

Master port associated with port-write handling

intenable

1=enable, 0=disable

Parameters

structrio_mport*mport

Master port.

dma_addr_tlocal

physical address of memory region to be mapped

u64rbase

RIO base address assigned to this window

u32size

Size of the memory region

u32rflags

Flags for mapping.

Return

0 -- Success.

Description

This function will create the mapping from RIO space to local memory.

Parameters

structrio_mport*mport

Master port

dma_addr_tlstart

physical address of memory region to be unmapped

Parameters

structrio_mport*mport

Master port.

u16destid

destination id window points to

u64rbase

RIO base address window translates to

u32size

Size of the memory region

u32rflags

Flags for mapping.

dma_addr_t*local

physical address of memory region mapped

Return

0 -- Success.

Description

This function will create the mapping from RIO space to local memory.

Parameters

structrio_mport*mport

Master port

u16destid

destination id mapping points to

u64rstart

RIO base address window translates to

Parameters

structrio_mport*port

Master port to issue transaction

intlocal

Indicate a local master port or remote device access

u16destid

Destination ID of the device

u8hopcount

Number of switch hops to the device

u32*rmap

pointer to location to store register map type info

Parameters

u32comp_tag

RIO component tag to match

structrio_dev*from

Previous RIO device found in search, orNULL for new search

Description

Iterates through the list of known RIO devices. If a RIO device isfound with a matchingcomp_tag, a pointer to its devicestructure is returned. Otherwise,NULL is returned. A new searchis initiated by passingNULL to thefrom argument. Otherwise, iffrom is notNULL, searches continue from next device on the globallist.

Parameters

structrio_dev*rdev

Pointer to RIO device control structure

u32pnum

Switch port number to set LOCKOUT bit

intlock

Operation : set (=1) or clear (=0)

Parameters

structrio_mport*port

Master port associated with the RIO network

intlocal

local=1 select local port otherwise a far device is reached

u16destid

Destination ID of the device to check host bit

u8hopcount

Number of hops to reach the target

u8port_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)

Parameters

structrio_mport*mport

Master port to send transactions

u16destid

Device destination ID in network

u8hopcount

Number of hops into the network

Parameters

structrio_mport*mport

mport device associated with port-write

unionrio_pw_msg*pw_msg

pointer to inbound port-write message

Description

Processes an inbound port-write message. Returns 0 if the requesthas been satisfied.

Parameters

structrio_mport*port

Master port to issue transaction

intlocal

Indicate a local master port or remote device access

u16destid

Destination ID of the device

u8hopcount

Number of switch hops to the device

u32from

Offset of current Extended Feature block header (if 0 startsfrom ExtFeaturePtr)

Parameters

structrio_mport*port

Master port to issue transaction

intlocal

Indicate a local master port or remote device access

u16destid

Destination ID of the device

u8hopcount

Number of switch hops to the device

intftr

Extended feature code

Description

Tell if a device supports a given RapidIO capability.Returns the offset of the requested extended featureblock within the device’s RIO configuration space or0 in case the device does not support it.

Parameters

structrio_mport*port

Master port to send transaction

u16destid

Destination ID for device/switch

u8hopcount

Hopcount to reach switch

intwait_ms

Max wait time in msec (0 = no timeout)

Description

Attepts to acquire host device lock for specified deviceReturns 0 if device lock acquired or EINVAL if timeout expires.

Parameters

structrio_mport*port

Master port to send transaction

u16destid

Destination ID for device/switch

u8hopcount

Hopcount to reach switch

Description

Returns 0 if device lock released or EINVAL if fails.

Parameters

structrio_dev*rdev

RIO device

u16table

Routing table ID

u16route_destid

Destination ID to be routed

u8route_port

Port number to be routed

intlock

apply a hardware lock on switch device flag (1=lock, 0=no_lock)

Description

If available calls the switch specificadd_entry() method to add a routeentry into a switch routing table. Otherwise uses standard RT update methodas defined by RapidIO specification. A specific routing table can be selectedusing thetable argument if a switch has per port routing tables orthe standard (or global) table may be used by passingRIO_GLOBAL_TABLE intable.

Returns0 on success or-EINVAL on failure.

Parameters

structrio_dev*rdev

RIO device

u16table

Routing table ID

u16route_destid

Destination ID to be routed

u8*route_port

Pointer to read port number into

intlock

apply a hardware lock on switch device flag (1=lock, 0=no_lock)

Description

If available calls the switch specificget_entry() method to fetch a routeentry from a switch routing table. Otherwise uses standard RT read methodas defined by RapidIO specification. A specific routing table can be selectedusing thetable argument if a switch has per port routing tables orthe standard (or global) table may be used by passingRIO_GLOBAL_TABLE intable.

Returns0 on success or-EINVAL on failure.

Parameters

structrio_dev*rdev

RIO device

u16table

Routing table ID

intlock

apply a hardware lock on switch device flag (1=lock, 0=no_lock)

Description

If available calls the switch specificclr_table() method to clear a switchrouting table. Otherwise uses standard RT write method as defined by RapidIOspecification. A specific routing table can be selected using thetableargument if a switch has per port routing tables or the standard (or global)table may be used by passingRIO_GLOBAL_TABLE intable.

Returns0 on success or-EINVAL on failure.

Parameters

structrio_mport*mport

RIO mport to perform DMA data transfers

Description

Returns pointer to allocated DMA channel or NULL if failed.

Parameters

structdma_chan*dchan

DMA channel to release

Parameters

structdma_chan*dchan

DMA channel to configure

u16destid

target RapidIO device destination ID

structrio_dma_data*data

RIO specific data descriptor

enumdma_transfer_directiondirection

DMA data transfer direction (TO or FROM the device)

unsignedlongflags

dmaengine defined flags

Description

Initializes RapidIO capable DMA channel for the specified data transfer.Uses DMA channel private extension to pass information related to remotetarget RIO device.

Return

pointer to DMA transaction descriptor if successful,error-valued pointer or NULL if failed.

Parameters

intmport_id

mport device ID for which fabric scan routine has to be set(RIO_MPORT_ANY = set for all available mports)

structrio_scan*scan_ops

enumeration/discovery operations structure

Description

Registers enumeration/discovery operations with RapidIO subsystem andattaches it to the specified mport device (or all available mportsif 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).

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

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

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[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;    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

structrio_switch (if valid for this device)

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

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

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[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;    u32 phys_efptr;    u32 phys_rmap;    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;    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

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

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)

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 withmap_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.

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

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.

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

Parameters

structrio_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

structrio_net*net

RIO network

u16destid

destID to reserve

Description

Tries to reserve the specified destID.Returns 0 if successful.

Parameters

structrio_net*net

RIO network

u16destid

destID to free

Description

Makes the specified destID available for use.

Parameters

structrio_net*net

RIO network

Parameters

structrio_net*net

RIO network

u16from

destination ID from which search shall continue

Parameters

structrio_mport*port

RIO master port

u16destid

Destination ID of device

u8hopcount

Hopcount to device

Description

Reads the base/extended device id from a device. Returns the8/16-bit device ID.

Parameters

structrio_mport*port

RIO master port

u16destid

Destination ID of device

u8hopcount

Hopcount to device

u16did

Device ID value to be written

Description

Writes the base/extended device id from a device.

Parameters

structrio_net*net

RIO network to run on

Description

Marks the component tag CSR on each device with the enumerationcomplete flag. When complete, it then release the host locks oneach device. Returns 0 on success or-EINVAL on failure.

Parameters

structrio_mport*port

Master port to issue transaction

Description

Sets the local host master port lock and destination ID registerwith the host device ID value. The host device ID value is providedby the platform. Returns0 on success or-1 on failure.

Parameters

structrio_mport*port

Master port to issue transaction

intsrc_ops

RIO device source operations

intdst_ops

RIO device destination operations

Description

Checks the providedsrc_ops anddst_ops for the necessary transactioncapabilities that indicate whether or not a device will implement adestination ID register. Returns 1 if true or 0 if false.

Parameters

structdevice*dev

LDM device associated with a RIO device struct

Description

Gets the RIO devicestructassociated a RIO device struct.The RIO devicestructis freed.

Parameters

structrio_dev*rdev

RIO device

Description

Gets the RIO device Processing Element Features registercontents and tests for switch capabilities. Returns 1 ifthe device is a switch or 0 if it is not a switch.The RIO devicestructis freed.

Parameters

structrio_net*net

RIO network

structrio_mport*port

Master port to send transactions

u16destid

Current destination ID

u8hopcount

Current hopcount

intdo_enum

Enumeration/Discovery mode flag

Description

Allocates a RIO device and configures fields based on configurationspace contents. If device has a destination ID register, a destinationID is either assigned in enumeration mode or read from configurationspace in discovery mode. If the device has switch capabilities, thena switch is allocated and configured appropriately. Returns a pointerto a RIO device on success or NULL on failure.

Parameters

structrio_dev*rdev

RapidIO device object

intsp

Switch port number

Description

Reads the port error status CSR for a particular switch port todetermine if the port has an active link. ReturnsRIO_PORT_N_ERR_STS_PORT_OK if the port is active or0 if it isinactive.

Parameters

structrio_mport*port

Master port to send transaction

u8hopcount

Number of hops to the device

Description

Used during enumeration to read the Host Device ID Lock CSR on aRIO device. Returns the value of the lock register.

Parameters

structrio_net*net

RIO network being enumerated

structrio_mport*port

Master port to send transactions

u8hopcount

Number of hops into the network

structrio_dev*prev

Previous RIO device connected to the enumerated one

intprev_port

Port on previous RIO device

Description

Recursively enumerates a RIO network. Transactions are sent via themaster port passed inport.

Parameters

structrio_mport*port

Master port to send transaction

Description

Tests the PGCCSR discovered bit for non-zero value (enumerationcomplete flag). Return1 if enumeration is complete or0 ifenumeration is incomplete.

Parameters

structrio_net*net

RIO network being discovered

structrio_mport*port

Master port to send transactions

u16destid

Current destination ID in network

u8hopcount

Number of hops into the network

structrio_dev*prev

previous rio_dev

intprev_port

previous port number

Description

Recursively discovers a RIO network. Transactions are sent via themaster port passed inport.

Parameters

structrio_mport*port

Master port to test

Description

Reads the port error status CSR for the master port todetermine if the port has an active link. ReturnsRIO_PORT_N_ERR_STS_PORT_OK if the master port is activeor0 if it is inactive.

Parameters

structrio_net*net

RIO network to run update on

Description

For each enumerated device, ensure that each switch in a systemhas correct routing entries. Add routes for devices that whereunknown during the first enumeration pass through the switch.

Parameters

structrio_dev*rdev

RIO device

Description

For each enumerated switch, call device-specific error managementinitialization routine (if supplied by the switch driver).

Parameters

structrio_mport*mport

Master port to send transactions

u32flags

Enumeration control flags

Description

Starts the enumeration process. If somebody has enumerated ourmaster port device, then give up. If not and we have an activelink, then start recursive peer enumeration. Returns0 ifenumeration succeeds or-EBUSY if enumeration fails.

Parameters

structrio_net*net

RIO network to run route tables scan on

Description

For each switch device, generate a route table by copying existingroute entries from the switch.

Parameters

structrio_mport*mport

Master port to send transactions

u32flags

discovery control flags

Description

Starts the discovery process. If we have an active link,then wait for the signal that enumeration is complete (if waitis allowed).When enumeration completion is signaled, start recursivepeer discovery. Returns0 if discovery succeeds or-EBUSYon failure.

Parameters

void

no arguments

Description

When this enumeration/discovery method is loaded as a module this functionregisters its specific enumeration and discover routines for all availableRapidIO mport devices. The “scan” command line parameter controls ability ofthe 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 notprovide a matching cleanup_module routine.

Parameters

structrio_mport*mport

RIO master port to bind the doorbell callback

void*dev_id

Device specific pointer to pass on event

structresource*res

Doorbell message resource

void(*dinb)(structrio_mport*mport,void*dev_id,u16src,u16dst,u16info)

Callback to execute when doorbell is received

Description

Adds a doorbell resource/callback pair into a port’sdoorbell event list. Returns 0 if the request has beensatisfied.

Parameters

structrio_dev*rdev

RIO device failed to respond

structrio_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 availabledevice (and corresponding RIO port) on the route.

Parameters

structrio_dev*rdev

Pointer to RIO device control structure

Parameters

structrio_dev*rdev

RIO devive to issue Input-status command

intpnum

Device port number to issue the command

u32*lnkresp

Response from a link partner

Parameters

structrio_dev*rdev

Pointer to RIO device control structure

u32pnum

Switch port number to clear errors

u32err_status

port error status (if 0 reads register from device)

Description

TODO: Currently this routine is not compatible with recovery processspecified for idt_gen3 RapidIO switch devices. It has to be reviewedto implement universal recovery process that is compatible full rangeoff available devices.IDT gen3 switch driver now implements HW-specific error handler thatissues soft port reset to the port to reset ERR_STOP bits and ackIDs.

Parameters

structrio_mport*mport

Master port to issue transaction

u16destid

Destination ID of the device

u8hopcount

Number of switch hops to the device

u16table

routing table ID (global or port-specific)

u16route_destid

destID entry in the RT

u8route_port

destination port for specified destID

Parameters

structrio_mport*mport

Master port to issue transaction

u16destid

Destination ID of the device

u8hopcount

Number of switch hops to the device

u16table

routing table ID (global or port-specific)

u16route_destid

destID entry in the RT

u8*route_port

returned destination port for specified destID

Parameters

structrio_mport*mport

Master port to issue transaction

u16destid

Destination ID of the device

u8hopcount

Number of switch hops to the device

u16table

routing table ID (global or port-specific)

Parameters

intmport_id

number (ID) of mport device

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 accessconfiguration space registers on the local device.

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 accessconfiguration space registers on the local device.

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 accessconfiguration space registers on the local device.

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 accessconfiguration space registers on the local device.

Parameters

conststructrio_device_id*id

the RIO device id structure to match against

conststructrio_dev*rdev

the RIO device structure to match against

Description

Used from driver probe and bus matching to check whether a RIO devicematches a device id structure provided by a RIO driver. Returns thematchingstructrio_device_id orNULL if there is no match.

Parameters

structdevice*dev

the RIO device structure to match against

Description

return 0 and set rio_dev->driver when drv claims rio_dev, else error

Parameters

structdevice*dev

the RIO device structure to match against

Description

Remove a RIO device from the system. If it has an associateddriver, then run the driverremove() method. Then updatethe reference count.

Parameters

structdevice*dev

the standard device structure to match against

conststructdevice_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 thesystem is in its list of supported devices. Returns 1 ifthere is a matchingstructrio_device_id or 0 if there isno match.

Parameters

void

no arguments

Description

Registers the RIO mport device class and RIO bus type with the Linuxdevice model.

Parameters

structrio_mport*mport

RapidIO master port info

intindex

ID of RapdiIO interface

u32offset

Offset into configuration space

intlen

Length (in bytes) of the maintenance transaction

u32*data

Value to be read into

Description

Generates a MPC85xx local configuration space read. Returns0 onsuccess or-EINVAL on failure.

Parameters

structrio_mport*mport

RapidIO master port info

intindex

ID of RapdiIO interface

u32offset

Offset into configuration space

intlen

Length (in bytes) of the maintenance transaction

u32data

Value to be written

Description

Generates a MPC85xx local configuration space write. Returns0 onsuccess or-EINVAL on failure.

Parameters

structrio_mport*mport

RapidIO master port info

intindex

ID of RapdiIO interface

u16destid

Destination ID of transaction

u8hopcount

Number of hops to target device

u32offset

Offset into configuration space

intlen

Length (in bytes) of the maintenance transaction

u32*val

Location to be read into