2 * RapidIO interconnect services
3 * (RapidIO Interconnect Specification, http://www.rapidio.org)
5 * Copyright 2005 MontaVista Software, Inc.
6 * Matt Porter <mporter@kernel.crashing.org>
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version.
17 #include <linux/types.h>
18 #include <linux/ioport.h>
19 #include <linux/list.h>
20 #include <linux/errno.h>
21 #include <linux/device.h>
22 #include <linux/rio_regs.h>
23 #include <linux/mod_devicetable.h>
24 #ifdef CONFIG_RAPIDIO_DMA_ENGINE
25 #include <linux/dmaengine.h>
28 #define RIO_NO_HOPCOUNT -1
29 #define RIO_INVALID_DESTID 0xffff
31 #define RIO_MAX_MPORTS 8
32 #define RIO_MAX_MPORT_RESOURCES 16
33 #define RIO_MAX_DEV_RESOURCES 16
34 #define RIO_MAX_MPORT_NAME 40
36 #define RIO_GLOBAL_TABLE 0xff /* Indicates access of a switch's
37 global routing table if it
38 has multiple (or per port)
41 #define RIO_INVALID_ROUTE 0xff /* Indicates that a route table
42 entry is invalid (no route
43 exists for the device ID) */
45 #define RIO_MAX_ROUTE_ENTRIES(size) (size ? (1 << 16) : (1 << 8))
46 #define RIO_ANY_DESTID(size) (size ? 0xffff : 0xff)
48 #define RIO_MAX_MBOX 4
49 #define RIO_MAX_MSG_SIZE 0x1000
52 * Error values that may be returned by RIO functions.
54 #define RIO_SUCCESSFUL 0x00
55 #define RIO_BAD_SIZE 0x81
58 * For RIO devices, the region numbers are assigned this way:
60 * 0 RapidIO outbound doorbells
61 * 1-15 RapidIO memory regions
63 * For RIO master ports, the region number are assigned this way:
65 * 0 RapidIO inbound doorbells
66 * 1 RapidIO inbound mailboxes
67 * 2 RapidIO outbound mailboxes
69 #define RIO_DOORBELL_RESOURCE 0
70 #define RIO_INB_MBOX_RESOURCE 1
71 #define RIO_OUTB_MBOX_RESOURCE 2
73 #define RIO_PW_MSG_SIZE 64
76 * A component tag value (stored in the component tag CSR) is used as device's
77 * unique identifier assigned during enumeration. Besides being used for
78 * identifying switches (which do not have device ID register), it also is used
79 * by error management notification and therefore has to be assigned
80 * to endpoints as well.
82 #define RIO_CTAG_RESRVD 0xfffe0000 /* Reserved */
83 #define RIO_CTAG_UDEVID 0x0001ffff /* Unique device identifier */
85 extern struct bus_type rio_bus_type
;
86 extern struct class rio_mport_class
;
93 * struct rio_switch - RIO switch info
94 * @node: Node in global list of switches
95 * @route_table: Copy of switch routing table
96 * @port_ok: Status of each port (one bit per port) - OK=1 or UNINIT=0
97 * @ops: pointer to switch-specific operations
98 * @lock: lock to serialize operations updates
99 * @nextdev: Array of per-port pointers to the next attached device
102 struct list_head node
;
105 struct rio_switch_ops
*ops
;
107 struct rio_dev
*nextdev
[0];
111 * struct rio_switch_ops - Per-switch operations
112 * @owner: The module owner of this structure
113 * @add_entry: Callback for switch-specific route add function
114 * @get_entry: Callback for switch-specific route get function
115 * @clr_table: Callback for switch-specific clear route table function
116 * @set_domain: Callback for switch-specific domain setting function
117 * @get_domain: Callback for switch-specific domain get function
118 * @em_init: Callback for switch-specific error management init function
119 * @em_handle: Callback for switch-specific error management handler function
121 * Defines the operations that are necessary to initialize/control
122 * a particular RIO switch device.
124 struct rio_switch_ops
{
125 struct module
*owner
;
126 int (*add_entry
) (struct rio_mport
*mport
, u16 destid
, u8 hopcount
,
127 u16 table
, u16 route_destid
, u8 route_port
);
128 int (*get_entry
) (struct rio_mport
*mport
, u16 destid
, u8 hopcount
,
129 u16 table
, u16 route_destid
, u8
*route_port
);
130 int (*clr_table
) (struct rio_mport
*mport
, u16 destid
, u8 hopcount
,
132 int (*set_domain
) (struct rio_mport
*mport
, u16 destid
, u8 hopcount
,
134 int (*get_domain
) (struct rio_mport
*mport
, u16 destid
, u8 hopcount
,
136 int (*em_init
) (struct rio_dev
*dev
);
137 int (*em_handle
) (struct rio_dev
*dev
, u8 swport
);
140 enum rio_device_state
{
141 RIO_DEVICE_INITIALIZING
,
148 * struct rio_dev - RIO device info
149 * @global_list: Node in list of all RIO devices
150 * @net_list: Node in list of RIO devices in a network
151 * @net: Network this device is a part of
152 * @do_enum: Enumeration flag
155 * @device_rev: Device revision
156 * @asm_did: Assembly device ID
157 * @asm_vid: Assembly vendor ID
158 * @asm_rev: Assembly revision
159 * @efptr: Extended feature pointer
160 * @pef: Processing element features
161 * @swpinfo: Switch port info
162 * @src_ops: Source operation capabilities
163 * @dst_ops: Destination operation capabilities
164 * @comp_tag: RIO component tag
165 * @phys_efptr: RIO device extended features pointer
166 * @em_efptr: RIO Error Management features pointer
167 * @dma_mask: Mask of bits of RIO address this device implements
168 * @driver: Driver claiming this device
169 * @dev: Device model device
170 * @riores: RIO resources this device owns
171 * @pwcback: port-write callback function for this device
172 * @destid: Network destination ID (or associated destid for switch)
173 * @hopcount: Hopcount to this device
174 * @prev: Previous RIO device connected to the current one
175 * @state: device state
176 * @rswitch: struct rio_switch (if valid for this device)
179 struct list_head global_list
; /* node in list of all RIO devices */
180 struct list_head net_list
; /* node in per net list */
181 struct rio_net
*net
; /* RIO net this device resides in */
198 struct rio_driver
*driver
; /* RIO driver claiming this device */
199 struct device dev
; /* LDM device structure */
200 struct resource riores
[RIO_MAX_DEV_RESOURCES
];
201 int (*pwcback
) (struct rio_dev
*rdev
, union rio_pw_msg
*msg
, int step
);
204 struct rio_dev
*prev
;
206 struct rio_switch rswitch
[0]; /* RIO switch info */
209 #define rio_dev_g(n) list_entry(n, struct rio_dev, global_list)
210 #define rio_dev_f(n) list_entry(n, struct rio_dev, net_list)
211 #define to_rio_dev(n) container_of(n, struct rio_dev, dev)
212 #define sw_to_rio_dev(n) container_of(n, struct rio_dev, rswitch[0])
213 #define to_rio_mport(n) container_of(n, struct rio_mport, dev)
214 #define to_rio_net(n) container_of(n, struct rio_net, dev)
217 * struct rio_msg - RIO message event
218 * @res: Mailbox resource
219 * @mcback: Message event callback
222 struct resource
*res
;
223 void (*mcback
) (struct rio_mport
* mport
, void *dev_id
, int mbox
, int slot
);
227 * struct rio_dbell - RIO doorbell event
228 * @node: Node in list of doorbell events
229 * @res: Doorbell resource
230 * @dinb: Doorbell event callback
231 * @dev_id: Device specific pointer to pass on event
234 struct list_head node
;
235 struct resource
*res
;
236 void (*dinb
) (struct rio_mport
*mport
, void *dev_id
, u16 src
, u16 dst
, u16 info
);
246 * struct rio_mport - RIO master port info
247 * @dbells: List of doorbell events
248 * @node: Node in global list of master ports
249 * @nnode: Node in network list of master ports
250 * @net: RIO net this mport is attached to
251 * @iores: I/O mem resource that this master port interface owns
252 * @riores: RIO resources that this master port interfaces owns
253 * @inb_msg: RIO inbound message event descriptors
254 * @outb_msg: RIO outbound message event descriptors
255 * @host_deviceid: Host device ID associated with this master port
256 * @ops: configuration space functions
257 * @id: Port ID, unique among all ports
258 * @index: Port index, unique among all port interfaces of the same type
259 * @sys_size: RapidIO common transport system size
260 * @phy_type: RapidIO phy type
261 * @phys_efptr: RIO port extended features pointer
262 * @name: Port name string
263 * @dev: device structure associated with an mport
264 * @priv: Master port private data
265 * @dma: DMA device associated with mport
266 * @nscan: RapidIO network enumeration/discovery operations
267 * @state: mport device state
270 struct list_head dbells
; /* list of doorbell events */
271 struct list_head node
; /* node in global list of ports */
272 struct list_head nnode
; /* node in net list of ports */
273 struct rio_net
*net
; /* RIO net this mport is attached to */
274 struct resource iores
;
275 struct resource riores
[RIO_MAX_MPORT_RESOURCES
];
276 struct rio_msg inb_msg
[RIO_MAX_MBOX
];
277 struct rio_msg outb_msg
[RIO_MAX_MBOX
];
278 int host_deviceid
; /* Host device ID */
279 struct rio_ops
*ops
; /* low-level architecture-dependent routines */
280 unsigned char id
; /* port ID, unique among all ports */
281 unsigned char index
; /* port index, unique among all port
282 interfaces of the same type */
283 unsigned int sys_size
; /* RapidIO common transport system size.
284 * 0 - Small size. 256 devices.
285 * 1 - Large size, 65536 devices.
287 enum rio_phy_type phy_type
; /* RapidIO phy type */
289 unsigned char name
[RIO_MAX_MPORT_NAME
];
291 void *priv
; /* Master port private data */
292 #ifdef CONFIG_RAPIDIO_DMA_ENGINE
293 struct dma_device dma
;
295 struct rio_scan
*nscan
;
299 static inline int rio_mport_is_running(struct rio_mport
*mport
)
301 return atomic_read(&mport
->state
) == RIO_DEVICE_RUNNING
;
305 * Enumeration/discovery control flags
307 #define RIO_SCAN_ENUM_NO_WAIT 0x00000001 /* Do not wait for enum completed */
310 * struct rio_net - RIO network info
311 * @node: Node in global list of RIO networks
312 * @devices: List of devices in this network
313 * @switches: List of switches in this network
314 * @mports: List of master ports accessing this network
315 * @hport: Default port for accessing this network
316 * @id: RIO network ID
317 * @dev: Device object
318 * @enum_data: private data specific to a network enumerator
319 * @release: enumerator-specific release callback
322 struct list_head node
; /* node in list of networks */
323 struct list_head devices
; /* list of devices in this net */
324 struct list_head switches
; /* list of switches in this net */
325 struct list_head mports
; /* list of ports accessing net */
326 struct rio_mport
*hport
; /* primary port for accessing net */
327 unsigned char id
; /* RIO network ID */
329 void *enum_data
; /* private data for enumerator of the network */
330 void (*release
)(struct rio_net
*net
);
333 enum rio_link_speed
{
334 RIO_LINK_DOWN
= 0, /* SRIO Link not initialized */
335 RIO_LINK_125
= 1, /* 1.25 GBaud */
336 RIO_LINK_250
= 2, /* 2.5 GBaud */
337 RIO_LINK_312
= 3, /* 3.125 GBaud */
338 RIO_LINK_500
= 4, /* 5.0 GBaud */
339 RIO_LINK_625
= 5 /* 6.25 GBaud */
342 enum rio_link_width
{
351 enum rio_mport_flags
{
352 RIO_MPORT_DMA
= (1 << 0), /* supports DMA data transfers */
353 RIO_MPORT_DMA_SG
= (1 << 1), /* DMA supports HW SG mode */
354 RIO_MPORT_IBSG
= (1 << 2), /* inbound mapping supports SG */
358 * struct rio_mport_attr - RIO mport device attributes
359 * @flags: mport device capability flags
360 * @link_speed: SRIO link speed value (as defined by RapidIO specification)
361 * @link_width: SRIO link width value (as defined by RapidIO specification)
362 * @dma_max_sge: number of SG list entries that can be handled by DMA channel(s)
363 * @dma_max_size: max number of bytes in single DMA transfer (SG entry)
364 * @dma_align: alignment shift for DMA operations (as for other DMA operations)
366 struct rio_mport_attr
{
371 /* DMA capability info: valid only if RIO_MPORT_DMA flag is set */
377 /* Low-level architecture-dependent routines */
380 * struct rio_ops - Low-level RIO configuration space operations
381 * @lcread: Callback to perform local (master port) read of config space.
382 * @lcwrite: Callback to perform local (master port) write of config space.
383 * @cread: Callback to perform network read of config space.
384 * @cwrite: Callback to perform network write of config space.
385 * @dsend: Callback to send a doorbell message.
386 * @pwenable: Callback to enable/disable port-write message handling.
387 * @open_outb_mbox: Callback to initialize outbound mailbox.
388 * @close_outb_mbox: Callback to shut down outbound mailbox.
389 * @open_inb_mbox: Callback to initialize inbound mailbox.
390 * @close_inb_mbox: Callback to shut down inbound mailbox.
391 * @add_outb_message: Callback to add a message to an outbound mailbox queue.
392 * @add_inb_buffer: Callback to add a buffer to an inbound mailbox queue.
393 * @get_inb_message: Callback to get a message from an inbound mailbox queue.
394 * @map_inb: Callback to map RapidIO address region into local memory space.
395 * @unmap_inb: Callback to unmap RapidIO address region mapped with map_inb().
396 * @query_mport: Callback to query mport device attributes.
399 int (*lcread
) (struct rio_mport
*mport
, int index
, u32 offset
, int len
,
401 int (*lcwrite
) (struct rio_mport
*mport
, int index
, u32 offset
, int len
,
403 int (*cread
) (struct rio_mport
*mport
, int index
, u16 destid
,
404 u8 hopcount
, u32 offset
, int len
, u32
*data
);
405 int (*cwrite
) (struct rio_mport
*mport
, int index
, u16 destid
,
406 u8 hopcount
, u32 offset
, int len
, u32 data
);
407 int (*dsend
) (struct rio_mport
*mport
, int index
, u16 destid
, u16 data
);
408 int (*pwenable
) (struct rio_mport
*mport
, int enable
);
409 int (*open_outb_mbox
)(struct rio_mport
*mport
, void *dev_id
,
410 int mbox
, int entries
);
411 void (*close_outb_mbox
)(struct rio_mport
*mport
, int mbox
);
412 int (*open_inb_mbox
)(struct rio_mport
*mport
, void *dev_id
,
413 int mbox
, int entries
);
414 void (*close_inb_mbox
)(struct rio_mport
*mport
, int mbox
);
415 int (*add_outb_message
)(struct rio_mport
*mport
, struct rio_dev
*rdev
,
416 int mbox
, void *buffer
, size_t len
);
417 int (*add_inb_buffer
)(struct rio_mport
*mport
, int mbox
, void *buf
);
418 void *(*get_inb_message
)(struct rio_mport
*mport
, int mbox
);
419 int (*map_inb
)(struct rio_mport
*mport
, dma_addr_t lstart
,
420 u64 rstart
, u32 size
, u32 flags
);
421 void (*unmap_inb
)(struct rio_mport
*mport
, dma_addr_t lstart
);
422 int (*query_mport
)(struct rio_mport
*mport
,
423 struct rio_mport_attr
*attr
);
426 #define RIO_RESOURCE_MEM 0x00000100
427 #define RIO_RESOURCE_DOORBELL 0x00000200
428 #define RIO_RESOURCE_MAILBOX 0x00000400
430 #define RIO_RESOURCE_CACHEABLE 0x00010000
431 #define RIO_RESOURCE_PCI 0x00020000
433 #define RIO_RESOURCE_BUSY 0x80000000
436 * struct rio_driver - RIO driver info
437 * @node: Node in list of drivers
438 * @name: RIO driver name
439 * @id_table: RIO device ids to be associated with this driver
440 * @probe: RIO device inserted
441 * @remove: RIO device removed
442 * @shutdown: shutdown notification callback
443 * @suspend: RIO device suspended
444 * @resume: RIO device awakened
445 * @enable_wake: RIO device enable wake event
446 * @driver: LDM driver struct
448 * Provides info on a RIO device driver for insertion/removal and
449 * power management purposes.
452 struct list_head node
;
454 const struct rio_device_id
*id_table
;
455 int (*probe
) (struct rio_dev
* dev
, const struct rio_device_id
* id
);
456 void (*remove
) (struct rio_dev
* dev
);
457 void (*shutdown
)(struct rio_dev
*dev
);
458 int (*suspend
) (struct rio_dev
* dev
, u32 state
);
459 int (*resume
) (struct rio_dev
* dev
);
460 int (*enable_wake
) (struct rio_dev
* dev
, u32 state
, int enable
);
461 struct device_driver driver
;
464 #define to_rio_driver(drv) container_of(drv,struct rio_driver, driver)
468 u32 comptag
; /* Component Tag CSR */
469 u32 errdetect
; /* Port N Error Detect CSR */
470 u32 is_port
; /* Implementation specific + PortID */
471 u32 ltlerrdet
; /* LTL Error Detect CSR */
474 u32 raw
[RIO_PW_MSG_SIZE
/sizeof(u32
)];
477 #ifdef CONFIG_RAPIDIO_DMA_ENGINE
480 * enum rio_write_type - RIO write transaction types used in DMA transfers
482 * Note: RapidIO specification defines write (NWRITE) and
483 * write-with-response (NWRITE_R) data transfer operations.
484 * Existing DMA controllers that service RapidIO may use one of these operations
485 * for entire data transfer or their combination with only the last data packet
488 enum rio_write_type
{
489 RDW_DEFAULT
, /* default method used by DMA driver */
490 RDW_ALL_NWRITE
, /* all packets use NWRITE */
491 RDW_ALL_NWRITE_R
, /* all packets use NWRITE_R */
492 RDW_LAST_NWRITE_R
, /* last packet uses NWRITE_R, others - NWRITE */
497 u64 rio_addr
; /* low 64-bits of 66-bit RapidIO address */
498 u8 rio_addr_u
; /* upper 2-bits of 66-bit RapidIO address */
499 enum rio_write_type wr_type
; /* preferred RIO write operation type */
502 struct rio_dma_data
{
503 /* Local data (as scatterlist) */
504 struct scatterlist
*sg
; /* I/O scatter list */
505 unsigned int sg_len
; /* size of scatter list */
506 /* Remote device address (flat buffer) */
507 u64 rio_addr
; /* low 64-bits of 66-bit RapidIO address */
508 u8 rio_addr_u
; /* upper 2-bits of 66-bit RapidIO address */
509 enum rio_write_type wr_type
; /* preferred RIO write operation type */
512 static inline struct rio_mport
*dma_to_mport(struct dma_device
*ddev
)
514 return container_of(ddev
, struct rio_mport
, dma
);
516 #endif /* CONFIG_RAPIDIO_DMA_ENGINE */
519 * struct rio_scan - RIO enumeration and discovery operations
520 * @owner: The module owner of this structure
521 * @enumerate: Callback to perform RapidIO fabric enumeration.
522 * @discover: Callback to perform RapidIO fabric discovery.
525 struct module
*owner
;
526 int (*enumerate
)(struct rio_mport
*mport
, u32 flags
);
527 int (*discover
)(struct rio_mport
*mport
, u32 flags
);
531 * struct rio_scan_node - list node to register RapidIO enumeration and
532 * discovery methods with RapidIO core.
533 * @mport_id: ID of an mport (net) serviced by this enumerator
534 * @node: node in global list of registered enumerators
535 * @ops: RIO enumeration and discovery operations
537 struct rio_scan_node
{
539 struct list_head node
;
540 struct rio_scan
*ops
;
543 /* Architecture and hardware-specific functions */
544 extern int rio_mport_initialize(struct rio_mport
*);
545 extern int rio_register_mport(struct rio_mport
*);
546 extern int rio_unregister_mport(struct rio_mport
*);
547 extern int rio_open_inb_mbox(struct rio_mport
*, void *, int, int);
548 extern void rio_close_inb_mbox(struct rio_mport
*, int);
549 extern int rio_open_outb_mbox(struct rio_mport
*, void *, int, int);
550 extern void rio_close_outb_mbox(struct rio_mport
*, int);
551 extern int rio_query_mport(struct rio_mport
*port
,
552 struct rio_mport_attr
*mport_attr
);
554 #endif /* LINUX_RIO_H */
This page took 0.041587 seconds and 6 git commands to generate.