1/*
2 * RapidIO interconnect services
3 * (RapidIO Interconnect Specification, http://www.rapidio.org)
4 *
5 * Copyright 2005 MontaVista Software, Inc.
6 * Matt Porter <mporter@kernel.crashing.org>
7 *
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.
12 */
13
14#ifndef LINUX_RIO_H
15#define LINUX_RIO_H
16
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>
26#endif
27
28#define RIO_NO_HOPCOUNT -1
29#define RIO_INVALID_DESTID 0xffff
30
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
35
36#define RIO_GLOBAL_TABLE 0xff /* Indicates access of a switch's
37 global routing table if it
38 has multiple (or per port)
39 tables */
40
41#define RIO_INVALID_ROUTE 0xff /* Indicates that a route table
42 entry is invalid (no route
43 exists for the device ID) */
44
45#define RIO_MAX_ROUTE_ENTRIES(size) (size ? (1 << 16) : (1 << 8))
46#define RIO_ANY_DESTID(size) (size ? 0xffff : 0xff)
47
48#define RIO_MAX_MBOX 4
49#define RIO_MAX_MSG_SIZE 0x1000
50
51/*
52 * Error values that may be returned by RIO functions.
53 */
54#define RIO_SUCCESSFUL 0x00
55#define RIO_BAD_SIZE 0x81
56
57/*
58 * For RIO devices, the region numbers are assigned this way:
59 *
60 * 0 RapidIO outbound doorbells
61 * 1-15 RapidIO memory regions
62 *
63 * For RIO master ports, the region number are assigned this way:
64 *
65 * 0 RapidIO inbound doorbells
66 * 1 RapidIO inbound mailboxes
67 * 2 RapidIO outbound mailboxes
68 */
69#define RIO_DOORBELL_RESOURCE 0
70#define RIO_INB_MBOX_RESOURCE 1
71#define RIO_OUTB_MBOX_RESOURCE 2
72
73#define RIO_PW_MSG_SIZE 64
74
75/*
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.
81 */
82#define RIO_CTAG_RESRVD 0xfffe0000 /* Reserved */
83#define RIO_CTAG_UDEVID 0x0001ffff /* Unique device identifier */
84
85extern struct bus_type rio_bus_type;
86extern struct class rio_mport_class;
87
88struct rio_mport;
89struct rio_dev;
90union rio_pw_msg;
91
92/**
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
100 */
101struct rio_switch {
102 struct list_head node;
103 u8 *route_table;
104 u32 port_ok;
105 struct rio_switch_ops *ops;
106 spinlock_t lock;
107 struct rio_dev *nextdev[0];
108};
109
110/**
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
120 *
121 * Defines the operations that are necessary to initialize/control
122 * a particular RIO switch device.
123 */
124struct 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,
131 u16 table);
132 int (*set_domain) (struct rio_mport *mport, u16 destid, u8 hopcount,
133 u8 sw_domain);
134 int (*get_domain) (struct rio_mport *mport, u16 destid, u8 hopcount,
135 u8 *sw_domain);
136 int (*em_init) (struct rio_dev *dev);
137 int (*em_handle) (struct rio_dev *dev, u8 swport);
138};
139
140enum rio_device_state {
141 RIO_DEVICE_INITIALIZING,
142 RIO_DEVICE_RUNNING,
143 RIO_DEVICE_GONE,
144 RIO_DEVICE_SHUTDOWN,
145};
146
147/**
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
153 * @did: Device ID
154 * @vid: Vendor ID
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 * @phys_rmap: LP-Serial Register Map Type (1 or 2)
167 * @em_efptr: RIO Error Management features pointer
168 * @dma_mask: Mask of bits of RIO address this device implements
169 * @driver: Driver claiming this device
170 * @dev: Device model device
171 * @riores: RIO resources this device owns
172 * @pwcback: port-write callback function for this device
173 * @destid: Network destination ID (or associated destid for switch)
174 * @hopcount: Hopcount to this device
175 * @prev: Previous RIO device connected to the current one
176 * @state: device state
177 * @rswitch: struct rio_switch (if valid for this device)
178 */
179struct rio_dev {
180 struct list_head global_list; /* node in list of all RIO devices */
181 struct list_head net_list; /* node in per net list */
182 struct rio_net *net; /* RIO net this device resides in */
183 bool do_enum;
184 u16 did;
185 u16 vid;
186 u32 device_rev;
187 u16 asm_did;
188 u16 asm_vid;
189 u16 asm_rev;
190 u16 efptr;
191 u32 pef;
192 u32 swpinfo;
193 u32 src_ops;
194 u32 dst_ops;
195 u32 comp_tag;
196 u32 phys_efptr;
197 u32 phys_rmap;
198 u32 em_efptr;
199 u64 dma_mask;
200 struct rio_driver *driver; /* RIO driver claiming this device */
201 struct device dev; /* LDM device structure */
202 struct resource riores[RIO_MAX_DEV_RESOURCES];
203 int (*pwcback) (struct rio_dev *rdev, union rio_pw_msg *msg, int step);
204 u16 destid;
205 u8 hopcount;
206 struct rio_dev *prev;
207 atomic_t state;
208 struct rio_switch rswitch[0]; /* RIO switch info */
209};
210
211#define rio_dev_g(n) list_entry(n, struct rio_dev, global_list)
212#define rio_dev_f(n) list_entry(n, struct rio_dev, net_list)
213#define to_rio_dev(n) container_of(n, struct rio_dev, dev)
214#define sw_to_rio_dev(n) container_of(n, struct rio_dev, rswitch[0])
215#define to_rio_mport(n) container_of(n, struct rio_mport, dev)
216#define to_rio_net(n) container_of(n, struct rio_net, dev)
217
218/**
219 * struct rio_msg - RIO message event
220 * @res: Mailbox resource
221 * @mcback: Message event callback
222 */
223struct rio_msg {
224 struct resource *res;
225 void (*mcback) (struct rio_mport * mport, void *dev_id, int mbox, int slot);
226};
227
228/**
229 * struct rio_dbell - RIO doorbell event
230 * @node: Node in list of doorbell events
231 * @res: Doorbell resource
232 * @dinb: Doorbell event callback
233 * @dev_id: Device specific pointer to pass on event
234 */
235struct rio_dbell {
236 struct list_head node;
237 struct resource *res;
238 void (*dinb) (struct rio_mport *mport, void *dev_id, u16 src, u16 dst, u16 info);
239 void *dev_id;
240};
241
242/**
243 * struct rio_mport - RIO master port info
244 * @dbells: List of doorbell events
245 * @pwrites: List of portwrite events
246 * @node: Node in global list of master ports
247 * @nnode: Node in network list of master ports
248 * @net: RIO net this mport is attached to
249 * @lock: lock to synchronize lists manipulations
250 * @iores: I/O mem resource that this master port interface owns
251 * @riores: RIO resources that this master port interfaces owns
252 * @inb_msg: RIO inbound message event descriptors
253 * @outb_msg: RIO outbound message event descriptors
254 * @host_deviceid: Host device ID associated with this master port
255 * @ops: configuration space functions
256 * @id: Port ID, unique among all ports
257 * @index: Port index, unique among all port interfaces of the same type
258 * @sys_size: RapidIO common transport system size
259 * @phys_efptr: RIO port extended features pointer
260 * @phys_rmap: LP-Serial EFB Register Mapping type (1 or 2).
261 * @name: Port name string
262 * @dev: device structure associated with an mport
263 * @priv: Master port private data
264 * @dma: DMA device associated with mport
265 * @nscan: RapidIO network enumeration/discovery operations
266 * @state: mport device state
267 * @pwe_refcnt: port-write enable ref counter to track enable/disable requests
268 */
269struct rio_mport {
270 struct list_head dbells; /* list of doorbell events */
271 struct list_head pwrites; /* list of portwrite events */
272 struct list_head node; /* node in global list of ports */
273 struct list_head nnode; /* node in net list of ports */
274 struct rio_net *net; /* RIO net this mport is attached to */
275 struct mutex lock;
276 struct resource iores;
277 struct resource riores[RIO_MAX_MPORT_RESOURCES];
278 struct rio_msg inb_msg[RIO_MAX_MBOX];
279 struct rio_msg outb_msg[RIO_MAX_MBOX];
280 int host_deviceid; /* Host device ID */
281 struct rio_ops *ops; /* low-level architecture-dependent routines */
282 unsigned char id; /* port ID, unique among all ports */
283 unsigned char index; /* port index, unique among all port
284 interfaces of the same type */
285 unsigned int sys_size; /* RapidIO common transport system size.
286 * 0 - Small size. 256 devices.
287 * 1 - Large size, 65536 devices.
288 */
289 u32 phys_efptr;
290 u32 phys_rmap;
291 unsigned char name[RIO_MAX_MPORT_NAME];
292 struct device dev;
293 void *priv; /* Master port private data */
294#ifdef CONFIG_RAPIDIO_DMA_ENGINE
295 struct dma_device dma;
296#endif
297 struct rio_scan *nscan;
298 atomic_t state;
299 unsigned int pwe_refcnt;
300};
301
302static inline int rio_mport_is_running(struct rio_mport *mport)
303{
304 return atomic_read(&mport->state) == RIO_DEVICE_RUNNING;
305}
306
307/*
308 * Enumeration/discovery control flags
309 */
310#define RIO_SCAN_ENUM_NO_WAIT 0x00000001 /* Do not wait for enum completed */
311
312/**
313 * struct rio_net - RIO network info
314 * @node: Node in global list of RIO networks
315 * @devices: List of devices in this network
316 * @switches: List of switches in this network
317 * @mports: List of master ports accessing this network
318 * @hport: Default port for accessing this network
319 * @id: RIO network ID
320 * @dev: Device object
321 * @enum_data: private data specific to a network enumerator
322 * @release: enumerator-specific release callback
323 */
324struct rio_net {
325 struct list_head node; /* node in list of networks */
326 struct list_head devices; /* list of devices in this net */
327 struct list_head switches; /* list of switches in this net */
328 struct list_head mports; /* list of ports accessing net */
329 struct rio_mport *hport; /* primary port for accessing net */
330 unsigned char id; /* RIO network ID */
331 struct device dev;
332 void *enum_data; /* private data for enumerator of the network */
333 void (*release)(struct rio_net *net);
334};
335
336enum rio_link_speed {
337 RIO_LINK_DOWN = 0, /* SRIO Link not initialized */
338 RIO_LINK_125 = 1, /* 1.25 GBaud */
339 RIO_LINK_250 = 2, /* 2.5 GBaud */
340 RIO_LINK_312 = 3, /* 3.125 GBaud */
341 RIO_LINK_500 = 4, /* 5.0 GBaud */
342 RIO_LINK_625 = 5 /* 6.25 GBaud */
343};
344
345enum rio_link_width {
346 RIO_LINK_1X = 0,
347 RIO_LINK_1XR = 1,
348 RIO_LINK_2X = 3,
349 RIO_LINK_4X = 2,
350 RIO_LINK_8X = 4,
351 RIO_LINK_16X = 5
352};
353
354enum rio_mport_flags {
355 RIO_MPORT_DMA = (1 << 0), /* supports DMA data transfers */
356 RIO_MPORT_DMA_SG = (1 << 1), /* DMA supports HW SG mode */
357 RIO_MPORT_IBSG = (1 << 2), /* inbound mapping supports SG */
358};
359
360/**
361 * struct rio_mport_attr - RIO mport device attributes
362 * @flags: mport device capability flags
363 * @link_speed: SRIO link speed value (as defined by RapidIO specification)
364 * @link_width: SRIO link width value (as defined by RapidIO specification)
365 * @dma_max_sge: number of SG list entries that can be handled by DMA channel(s)
366 * @dma_max_size: max number of bytes in single DMA transfer (SG entry)
367 * @dma_align: alignment shift for DMA operations (as for other DMA operations)
368 */
369struct rio_mport_attr {
370 int flags;
371 int link_speed;
372 int link_width;
373
374 /* DMA capability info: valid only if RIO_MPORT_DMA flag is set */
375 int dma_max_sge;
376 int dma_max_size;
377 int dma_align;
378};
379
380/* Low-level architecture-dependent routines */
381
382/**
383 * struct rio_ops - Low-level RIO configuration space operations
384 * @lcread: Callback to perform local (master port) read of config space.
385 * @lcwrite: Callback to perform local (master port) write of config space.
386 * @cread: Callback to perform network read of config space.
387 * @cwrite: Callback to perform network write of config space.
388 * @dsend: Callback to send a doorbell message.
389 * @pwenable: Callback to enable/disable port-write message handling.
390 * @open_outb_mbox: Callback to initialize outbound mailbox.
391 * @close_outb_mbox: Callback to shut down outbound mailbox.
392 * @open_inb_mbox: Callback to initialize inbound mailbox.
393 * @close_inb_mbox: Callback to shut down inbound mailbox.
394 * @add_outb_message: Callback to add a message to an outbound mailbox queue.
395 * @add_inb_buffer: Callback to add a buffer to an inbound mailbox queue.
396 * @get_inb_message: Callback to get a message from an inbound mailbox queue.
397 * @map_inb: Callback to map RapidIO address region into local memory space.
398 * @unmap_inb: Callback to unmap RapidIO address region mapped with map_inb().
399 * @query_mport: Callback to query mport device attributes.
400 * @map_outb: Callback to map outbound address region into local memory space.
401 * @unmap_outb: Callback to unmap outbound RapidIO address region.
402 */
403struct rio_ops {
404 int (*lcread) (struct rio_mport *mport, int index, u32 offset, int len,
405 u32 *data);
406 int (*lcwrite) (struct rio_mport *mport, int index, u32 offset, int len,
407 u32 data);
408 int (*cread) (struct rio_mport *mport, int index, u16 destid,
409 u8 hopcount, u32 offset, int len, u32 *data);
410 int (*cwrite) (struct rio_mport *mport, int index, u16 destid,
411 u8 hopcount, u32 offset, int len, u32 data);
412 int (*dsend) (struct rio_mport *mport, int index, u16 destid, u16 data);
413 int (*pwenable) (struct rio_mport *mport, int enable);
414 int (*open_outb_mbox)(struct rio_mport *mport, void *dev_id,
415 int mbox, int entries);
416 void (*close_outb_mbox)(struct rio_mport *mport, int mbox);
417 int (*open_inb_mbox)(struct rio_mport *mport, void *dev_id,
418 int mbox, int entries);
419 void (*close_inb_mbox)(struct rio_mport *mport, int mbox);
420 int (*add_outb_message)(struct rio_mport *mport, struct rio_dev *rdev,
421 int mbox, void *buffer, size_t len);
422 int (*add_inb_buffer)(struct rio_mport *mport, int mbox, void *buf);
423 void *(*get_inb_message)(struct rio_mport *mport, int mbox);
424 int (*map_inb)(struct rio_mport *mport, dma_addr_t lstart,
425 u64 rstart, u64 size, u32 flags);
426 void (*unmap_inb)(struct rio_mport *mport, dma_addr_t lstart);
427 int (*query_mport)(struct rio_mport *mport,
428 struct rio_mport_attr *attr);
429 int (*map_outb)(struct rio_mport *mport, u16 destid, u64 rstart,
430 u32 size, u32 flags, dma_addr_t *laddr);
431 void (*unmap_outb)(struct rio_mport *mport, u16 destid, u64 rstart);
432};
433
434#define RIO_RESOURCE_MEM 0x00000100
435#define RIO_RESOURCE_DOORBELL 0x00000200
436#define RIO_RESOURCE_MAILBOX 0x00000400
437
438#define RIO_RESOURCE_CACHEABLE 0x00010000
439#define RIO_RESOURCE_PCI 0x00020000
440
441#define RIO_RESOURCE_BUSY 0x80000000
442
443/**
444 * struct rio_driver - RIO driver info
445 * @node: Node in list of drivers
446 * @name: RIO driver name
447 * @id_table: RIO device ids to be associated with this driver
448 * @probe: RIO device inserted
449 * @remove: RIO device removed
450 * @shutdown: shutdown notification callback
451 * @suspend: RIO device suspended
452 * @resume: RIO device awakened
453 * @enable_wake: RIO device enable wake event
454 * @driver: LDM driver struct
455 *
456 * Provides info on a RIO device driver for insertion/removal and
457 * power management purposes.
458 */
459struct rio_driver {
460 struct list_head node;
461 char *name;
462 const struct rio_device_id *id_table;
463 int (*probe) (struct rio_dev * dev, const struct rio_device_id * id);
464 void (*remove) (struct rio_dev * dev);
465 void (*shutdown)(struct rio_dev *dev);
466 int (*suspend) (struct rio_dev * dev, u32 state);
467 int (*resume) (struct rio_dev * dev);
468 int (*enable_wake) (struct rio_dev * dev, u32 state, int enable);
469 struct device_driver driver;
470};
471
472#define to_rio_driver(drv) container_of(drv,struct rio_driver, driver)
473
474union rio_pw_msg {
475 struct {
476 u32 comptag; /* Component Tag CSR */
477 u32 errdetect; /* Port N Error Detect CSR */
478 u32 is_port; /* Implementation specific + PortID */
479 u32 ltlerrdet; /* LTL Error Detect CSR */
480 u32 padding[12];
481 } em;
482 u32 raw[RIO_PW_MSG_SIZE/sizeof(u32)];
483};
484
485#ifdef CONFIG_RAPIDIO_DMA_ENGINE
486
487/*
488 * enum rio_write_type - RIO write transaction types used in DMA transfers
489 *
490 * Note: RapidIO specification defines write (NWRITE) and
491 * write-with-response (NWRITE_R) data transfer operations.
492 * Existing DMA controllers that service RapidIO may use one of these operations
493 * for entire data transfer or their combination with only the last data packet
494 * requires response.
495 */
496enum rio_write_type {
497 RDW_DEFAULT, /* default method used by DMA driver */
498 RDW_ALL_NWRITE, /* all packets use NWRITE */
499 RDW_ALL_NWRITE_R, /* all packets use NWRITE_R */
500 RDW_LAST_NWRITE_R, /* last packet uses NWRITE_R, others - NWRITE */
501};
502
503struct rio_dma_ext {
504 u16 destid;
505 u64 rio_addr; /* low 64-bits of 66-bit RapidIO address */
506 u8 rio_addr_u; /* upper 2-bits of 66-bit RapidIO address */
507 enum rio_write_type wr_type; /* preferred RIO write operation type */
508};
509
510struct rio_dma_data {
511 /* Local data (as scatterlist) */
512 struct scatterlist *sg; /* I/O scatter list */
513 unsigned int sg_len; /* size of scatter list */
514 /* Remote device address (flat buffer) */
515 u64 rio_addr; /* low 64-bits of 66-bit RapidIO address */
516 u8 rio_addr_u; /* upper 2-bits of 66-bit RapidIO address */
517 enum rio_write_type wr_type; /* preferred RIO write operation type */
518};
519
520static inline struct rio_mport *dma_to_mport(struct dma_device *ddev)
521{
522 return container_of(ddev, struct rio_mport, dma);
523}
524#endif /* CONFIG_RAPIDIO_DMA_ENGINE */
525
526/**
527 * struct rio_scan - RIO enumeration and discovery operations
528 * @owner: The module owner of this structure
529 * @enumerate: Callback to perform RapidIO fabric enumeration.
530 * @discover: Callback to perform RapidIO fabric discovery.
531 */
532struct rio_scan {
533 struct module *owner;
534 int (*enumerate)(struct rio_mport *mport, u32 flags);
535 int (*discover)(struct rio_mport *mport, u32 flags);
536};
537
538/**
539 * struct rio_scan_node - list node to register RapidIO enumeration and
540 * discovery methods with RapidIO core.
541 * @mport_id: ID of an mport (net) serviced by this enumerator
542 * @node: node in global list of registered enumerators
543 * @ops: RIO enumeration and discovery operations
544 */
545struct rio_scan_node {
546 int mport_id;
547 struct list_head node;
548 struct rio_scan *ops;
549};
550
551/* Architecture and hardware-specific functions */
552extern int rio_mport_initialize(struct rio_mport *);
553extern int rio_register_mport(struct rio_mport *);
554extern int rio_unregister_mport(struct rio_mport *);
555extern int rio_open_inb_mbox(struct rio_mport *, void *, int, int);
556extern void rio_close_inb_mbox(struct rio_mport *, int);
557extern int rio_open_outb_mbox(struct rio_mport *, void *, int, int);
558extern void rio_close_outb_mbox(struct rio_mport *, int);
559extern int rio_query_mport(struct rio_mport *port,
560 struct rio_mport_attr *mport_attr);
561
562#endif /* LINUX_RIO_H */
563