| /* SPDX-License-Identifier: GPL-2.0-or-later */ |
| /* |
| * RapidIO interconnect services |
| * (RapidIO Interconnect Specification, http://www.rapidio.org) |
| * |
| * Copyright 2005 MontaVista Software, Inc. |
| * Matt Porter <mporter@kernel.crashing.org> |
| */ |
| |
| #ifndef LINUX_RIO_H |
| #define LINUX_RIO_H |
| |
| #include <linux/types.h> |
| #include <linux/ioport.h> |
| #include <linux/list.h> |
| #include <linux/errno.h> |
| #include <linux/device.h> |
| #include <linux/rio_regs.h> |
| #include <linux/mod_devicetable.h> |
| #ifdef CONFIG_RAPIDIO_DMA_ENGINE |
| #include <linux/dmaengine.h> |
| #endif |
| |
| #define RIO_NO_HOPCOUNT -1 |
| #define RIO_INVALID_DESTID 0xffff |
| |
| #define RIO_MAX_MPORTS 8 |
| #define RIO_MAX_MPORT_RESOURCES 16 |
| #define RIO_MAX_DEV_RESOURCES 16 |
| #define RIO_MAX_MPORT_NAME 40 |
| |
| #define RIO_GLOBAL_TABLE 0xff /* Indicates access of a switch's |
| global routing table if it |
| has multiple (or per port) |
| tables */ |
| |
| #define RIO_INVALID_ROUTE 0xff /* Indicates that a route table |
| entry is invalid (no route |
| exists for the device ID) */ |
| |
| #define RIO_MAX_ROUTE_ENTRIES(size) (size ? (1 << 16) : (1 << 8)) |
| #define RIO_ANY_DESTID(size) (size ? 0xffff : 0xff) |
| |
| #define RIO_MAX_MBOX 4 |
| #define RIO_MAX_MSG_SIZE 0x1000 |
| |
| /* |
| * Error values that may be returned by RIO functions. |
| */ |
| #define RIO_SUCCESSFUL 0x00 |
| #define RIO_BAD_SIZE 0x81 |
| |
| /* |
| * For RIO devices, the region numbers are assigned this way: |
| * |
| * 0 RapidIO outbound doorbells |
| * 1-15 RapidIO memory regions |
| * |
| * For RIO master ports, the region number are assigned this way: |
| * |
| * 0 RapidIO inbound doorbells |
| * 1 RapidIO inbound mailboxes |
| * 2 RapidIO outbound mailboxes |
| */ |
| #define RIO_DOORBELL_RESOURCE 0 |
| #define RIO_INB_MBOX_RESOURCE 1 |
| #define RIO_OUTB_MBOX_RESOURCE 2 |
| |
| #define RIO_PW_MSG_SIZE 64 |
| |
| /* |
| * A component tag value (stored in the component tag CSR) is used as device's |
| * unique identifier assigned during enumeration. Besides being used for |
| * identifying switches (which do not have device ID register), it also is used |
| * by error management notification and therefore has to be assigned |
| * to endpoints as well. |
| */ |
| #define RIO_CTAG_RESRVD 0xfffe0000 /* Reserved */ |
| #define RIO_CTAG_UDEVID 0x0001ffff /* Unique device identifier */ |
| |
| extern struct bus_type rio_bus_type; |
| extern struct class rio_mport_class; |
| |
| struct rio_mport; |
| struct rio_dev; |
| union rio_pw_msg; |
| |
| /** |
| * struct rio_switch - RIO switch info |
| * @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 { |
| struct list_head node; |
| u8 *route_table; |
| u32 port_ok; |
| struct rio_switch_ops *ops; |
| spinlock_t lock; |
| struct rio_dev *nextdev[]; |
| }; |
| |
| /** |
| * struct rio_switch_ops - Per-switch operations |
| * @owner: The module owner of this structure |
| * @add_entry: Callback for switch-specific route add function |
| * @get_entry: Callback for switch-specific route get function |
| * @clr_table: Callback for switch-specific clear route table function |
| * @set_domain: Callback for switch-specific domain setting function |
| * @get_domain: Callback for switch-specific domain get function |
| * @em_init: Callback for switch-specific error management init function |
| * @em_handle: Callback for switch-specific error management handler function |
| * |
| * Defines the operations that are necessary to initialize/control |
| * a particular RIO switch device. |
| */ |
| 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); |
| }; |
| |
| enum rio_device_state { |
| RIO_DEVICE_INITIALIZING, |
| RIO_DEVICE_RUNNING, |
| RIO_DEVICE_GONE, |
| RIO_DEVICE_SHUTDOWN, |
| }; |
| |
| /** |
| * struct rio_dev - RIO device info |
| * @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_dev { |
| struct list_head global_list; /* node in list of all RIO devices */ |
| struct list_head net_list; /* node in per net list */ |
| struct rio_net *net; /* RIO net this device resides in */ |
| 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; /* RIO driver claiming this device */ |
| struct device dev; /* LDM device structure */ |
| 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[]; /* RIO switch info */ |
| }; |
| |
| #define rio_dev_g(n) list_entry(n, struct rio_dev, global_list) |
| #define rio_dev_f(n) list_entry(n, struct rio_dev, net_list) |
| #define to_rio_dev(n) container_of(n, struct rio_dev, dev) |
| #define sw_to_rio_dev(n) container_of(n, struct rio_dev, rswitch[0]) |
| #define to_rio_mport(n) container_of(n, struct rio_mport, dev) |
| #define to_rio_net(n) container_of(n, struct rio_net, dev) |
| |
| /** |
| * struct rio_msg - RIO message event |
| * @res: Mailbox resource |
| * @mcback: Message event callback |
| */ |
| struct rio_msg { |
| struct resource *res; |
| void (*mcback) (struct rio_mport * mport, void *dev_id, int mbox, int slot); |
| }; |
| |
| /** |
| * struct rio_dbell - RIO doorbell event |
| * @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_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; |
| }; |
| |
| /** |
| * struct rio_mport - RIO master port info |
| * @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_mport { |
| struct list_head dbells; /* list of doorbell events */ |
| struct list_head pwrites; /* list of portwrite events */ |
| struct list_head node; /* node in global list of ports */ |
| struct list_head nnode; /* node in net list of ports */ |
| struct rio_net *net; /* RIO net this mport is attached to */ |
| 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; /* Host device ID */ |
| struct rio_ops *ops; /* low-level architecture-dependent routines */ |
| unsigned char id; /* port ID, unique among all ports */ |
| unsigned char index; /* port index, unique among all port |
| interfaces of the same type */ |
| unsigned int sys_size; /* RapidIO common transport system size. |
| * 0 - Small size. 256 devices. |
| * 1 - Large size, 65536 devices. |
| */ |
| u32 phys_efptr; |
| u32 phys_rmap; |
| unsigned char name[RIO_MAX_MPORT_NAME]; |
| struct device dev; |
| void *priv; /* Master port private data */ |
| #ifdef CONFIG_RAPIDIO_DMA_ENGINE |
| struct dma_device dma; |
| #endif |
| struct rio_scan *nscan; |
| atomic_t state; |
| unsigned int pwe_refcnt; |
| }; |
| |
| static inline int rio_mport_is_running(struct rio_mport *mport) |
| { |
| return atomic_read(&mport->state) == RIO_DEVICE_RUNNING; |
| } |
| |
| /* |
| * Enumeration/discovery control flags |
| */ |
| #define RIO_SCAN_ENUM_NO_WAIT 0x00000001 /* Do not wait for enum completed */ |
| |
| /** |
| * struct rio_net - RIO network info |
| * @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_net { |
| struct list_head node; /* node in list of networks */ |
| struct list_head devices; /* list of devices in this net */ |
| struct list_head switches; /* list of switches in this net */ |
| struct list_head mports; /* list of ports accessing net */ |
| struct rio_mport *hport; /* primary port for accessing net */ |
| unsigned char id; /* RIO network ID */ |
| struct device dev; |
| void *enum_data; /* private data for enumerator of the network */ |
| void (*release)(struct rio_net *net); |
| }; |
| |
| enum rio_link_speed { |
| RIO_LINK_DOWN = 0, /* SRIO Link not initialized */ |
| RIO_LINK_125 = 1, /* 1.25 GBaud */ |
| RIO_LINK_250 = 2, /* 2.5 GBaud */ |
| RIO_LINK_312 = 3, /* 3.125 GBaud */ |
| RIO_LINK_500 = 4, /* 5.0 GBaud */ |
| RIO_LINK_625 = 5 /* 6.25 GBaud */ |
| }; |
| |
| enum rio_link_width { |
| RIO_LINK_1X = 0, |
| RIO_LINK_1XR = 1, |
| RIO_LINK_2X = 3, |
| RIO_LINK_4X = 2, |
| RIO_LINK_8X = 4, |
| RIO_LINK_16X = 5 |
| }; |
| |
| enum rio_mport_flags { |
| RIO_MPORT_DMA = (1 << 0), /* supports DMA data transfers */ |
| RIO_MPORT_DMA_SG = (1 << 1), /* DMA supports HW SG mode */ |
| RIO_MPORT_IBSG = (1 << 2), /* inbound mapping supports SG */ |
| }; |
| |
| /** |
| * struct rio_mport_attr - RIO mport device attributes |
| * @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_mport_attr { |
| int flags; |
| int link_speed; |
| int link_width; |
| |
| /* DMA capability info: valid only if RIO_MPORT_DMA flag is set */ |
| int dma_max_sge; |
| int dma_max_size; |
| int dma_align; |
| }; |
| |
| /* Low-level architecture-dependent routines */ |
| |
| /** |
| * struct rio_ops - Low-level RIO configuration space operations |
| * @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_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); |
| }; |
| |
| #define RIO_RESOURCE_MEM 0x00000100 |
| #define RIO_RESOURCE_DOORBELL 0x00000200 |
| #define RIO_RESOURCE_MAILBOX 0x00000400 |
| |
| #define RIO_RESOURCE_CACHEABLE 0x00010000 |
| #define RIO_RESOURCE_PCI 0x00020000 |
| |
| #define RIO_RESOURCE_BUSY 0x80000000 |
| |
| /** |
| * struct rio_driver - RIO driver info |
| * @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 |
| * |
| * Provides info on a RIO device driver for insertion/removal and |
| * power management purposes. |
| */ |
| 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; |
| }; |
| |
| #define to_rio_driver(drv) container_of(drv,struct rio_driver, driver) |
| |
| union rio_pw_msg { |
| struct { |
| u32 comptag; /* Component Tag CSR */ |
| u32 errdetect; /* Port N Error Detect CSR */ |
| u32 is_port; /* Implementation specific + PortID */ |
| u32 ltlerrdet; /* LTL Error Detect CSR */ |
| u32 padding[12]; |
| } em; |
| u32 raw[RIO_PW_MSG_SIZE/sizeof(u32)]; |
| }; |
| |
| #ifdef CONFIG_RAPIDIO_DMA_ENGINE |
| |
| /* |
| * enum rio_write_type - RIO write transaction types used in DMA transfers |
| * |
| * Note: RapidIO specification defines write (NWRITE) and |
| * write-with-response (NWRITE_R) data transfer operations. |
| * Existing DMA controllers that service RapidIO may use one of these operations |
| * for entire data transfer or their combination with only the last data packet |
| * requires response. |
| */ |
| enum rio_write_type { |
| RDW_DEFAULT, /* default method used by DMA driver */ |
| RDW_ALL_NWRITE, /* all packets use NWRITE */ |
| RDW_ALL_NWRITE_R, /* all packets use NWRITE_R */ |
| RDW_LAST_NWRITE_R, /* last packet uses NWRITE_R, others - NWRITE */ |
| }; |
| |
| struct rio_dma_ext { |
| u16 destid; |
| u64 rio_addr; /* low 64-bits of 66-bit RapidIO address */ |
| u8 rio_addr_u; /* upper 2-bits of 66-bit RapidIO address */ |
| enum rio_write_type wr_type; /* preferred RIO write operation type */ |
| }; |
| |
| struct rio_dma_data { |
| /* Local data (as scatterlist) */ |
| struct scatterlist *sg; /* I/O scatter list */ |
| unsigned int sg_len; /* size of scatter list */ |
| /* Remote device address (flat buffer) */ |
| u64 rio_addr; /* low 64-bits of 66-bit RapidIO address */ |
| u8 rio_addr_u; /* upper 2-bits of 66-bit RapidIO address */ |
| enum rio_write_type wr_type; /* preferred RIO write operation type */ |
| }; |
| |
| static inline struct rio_mport *dma_to_mport(struct dma_device *ddev) |
| { |
| return container_of(ddev, struct rio_mport, dma); |
| } |
| #endif /* CONFIG_RAPIDIO_DMA_ENGINE */ |
| |
| /** |
| * struct rio_scan - RIO enumeration and discovery operations |
| * @owner: The module owner of this structure |
| * @enumerate: Callback to perform RapidIO fabric enumeration. |
| * @discover: Callback to perform RapidIO fabric discovery. |
| */ |
| struct rio_scan { |
| struct module *owner; |
| int (*enumerate)(struct rio_mport *mport, u32 flags); |
| int (*discover)(struct rio_mport *mport, u32 flags); |
| }; |
| |
| /** |
| * struct rio_scan_node - list node to register RapidIO enumeration and |
| * discovery methods with RapidIO core. |
| * @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 |
| */ |
| struct rio_scan_node { |
| int mport_id; |
| struct list_head node; |
| struct rio_scan *ops; |
| }; |
| |
| /* Architecture and hardware-specific functions */ |
| extern int rio_mport_initialize(struct rio_mport *); |
| extern int rio_register_mport(struct rio_mport *); |
| extern int rio_unregister_mport(struct rio_mport *); |
| extern int rio_open_inb_mbox(struct rio_mport *, void *, int, int); |
| extern void rio_close_inb_mbox(struct rio_mport *, int); |
| extern int rio_open_outb_mbox(struct rio_mport *, void *, int, int); |
| extern void rio_close_outb_mbox(struct rio_mport *, int); |
| extern int rio_query_mport(struct rio_mport *port, |
| struct rio_mport_attr *mport_attr); |
| |
| #endif /* LINUX_RIO_H */ |