Merge ath-next from ath.git
[deliverable/linux.git] / include / linux / rio.h
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
85 extern struct bus_type rio_bus_type;
86 extern struct class rio_mport_class;
87
88 struct rio_mport;
89 struct rio_dev;
90 union 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 */
101 struct 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 */
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,
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
140 enum 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 * @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)
177 */
178 struct rio_dev {
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 */
182 bool do_enum;
183 u16 did;
184 u16 vid;
185 u32 device_rev;
186 u16 asm_did;
187 u16 asm_vid;
188 u16 asm_rev;
189 u16 efptr;
190 u32 pef;
191 u32 swpinfo;
192 u32 src_ops;
193 u32 dst_ops;
194 u32 comp_tag;
195 u32 phys_efptr;
196 u32 em_efptr;
197 u64 dma_mask;
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);
202 u16 destid;
203 u8 hopcount;
204 struct rio_dev *prev;
205 atomic_t state;
206 struct rio_switch rswitch[0]; /* RIO switch info */
207 };
208
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)
215
216 /**
217 * struct rio_msg - RIO message event
218 * @res: Mailbox resource
219 * @mcback: Message event callback
220 */
221 struct rio_msg {
222 struct resource *res;
223 void (*mcback) (struct rio_mport * mport, void *dev_id, int mbox, int slot);
224 };
225
226 /**
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
232 */
233 struct rio_dbell {
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);
237 void *dev_id;
238 };
239
240 enum rio_phy_type {
241 RIO_PHY_PARALLEL,
242 RIO_PHY_SERIAL,
243 };
244
245 /**
246 * struct rio_mport - RIO master port info
247 * @dbells: List of doorbell events
248 * @pwrites: List of portwrite events
249 * @node: Node in global list of master ports
250 * @nnode: Node in network list of master ports
251 * @net: RIO net this mport is attached to
252 * @lock: lock to synchronize lists manipulations
253 * @iores: I/O mem resource that this master port interface owns
254 * @riores: RIO resources that this master port interfaces owns
255 * @inb_msg: RIO inbound message event descriptors
256 * @outb_msg: RIO outbound message event descriptors
257 * @host_deviceid: Host device ID associated with this master port
258 * @ops: configuration space functions
259 * @id: Port ID, unique among all ports
260 * @index: Port index, unique among all port interfaces of the same type
261 * @sys_size: RapidIO common transport system size
262 * @phy_type: RapidIO phy type
263 * @phys_efptr: RIO port extended features pointer
264 * @name: Port name string
265 * @dev: device structure associated with an mport
266 * @priv: Master port private data
267 * @dma: DMA device associated with mport
268 * @nscan: RapidIO network enumeration/discovery operations
269 * @state: mport device state
270 * @pwe_refcnt: port-write enable ref counter to track enable/disable requests
271 */
272 struct rio_mport {
273 struct list_head dbells; /* list of doorbell events */
274 struct list_head pwrites; /* list of portwrite events */
275 struct list_head node; /* node in global list of ports */
276 struct list_head nnode; /* node in net list of ports */
277 struct rio_net *net; /* RIO net this mport is attached to */
278 struct mutex lock;
279 struct resource iores;
280 struct resource riores[RIO_MAX_MPORT_RESOURCES];
281 struct rio_msg inb_msg[RIO_MAX_MBOX];
282 struct rio_msg outb_msg[RIO_MAX_MBOX];
283 int host_deviceid; /* Host device ID */
284 struct rio_ops *ops; /* low-level architecture-dependent routines */
285 unsigned char id; /* port ID, unique among all ports */
286 unsigned char index; /* port index, unique among all port
287 interfaces of the same type */
288 unsigned int sys_size; /* RapidIO common transport system size.
289 * 0 - Small size. 256 devices.
290 * 1 - Large size, 65536 devices.
291 */
292 enum rio_phy_type phy_type; /* RapidIO phy type */
293 u32 phys_efptr;
294 unsigned char name[RIO_MAX_MPORT_NAME];
295 struct device dev;
296 void *priv; /* Master port private data */
297 #ifdef CONFIG_RAPIDIO_DMA_ENGINE
298 struct dma_device dma;
299 #endif
300 struct rio_scan *nscan;
301 atomic_t state;
302 unsigned int pwe_refcnt;
303 };
304
305 static inline int rio_mport_is_running(struct rio_mport *mport)
306 {
307 return atomic_read(&mport->state) == RIO_DEVICE_RUNNING;
308 }
309
310 /*
311 * Enumeration/discovery control flags
312 */
313 #define RIO_SCAN_ENUM_NO_WAIT 0x00000001 /* Do not wait for enum completed */
314
315 /**
316 * struct rio_net - RIO network info
317 * @node: Node in global list of RIO networks
318 * @devices: List of devices in this network
319 * @switches: List of switches in this network
320 * @mports: List of master ports accessing this network
321 * @hport: Default port for accessing this network
322 * @id: RIO network ID
323 * @dev: Device object
324 * @enum_data: private data specific to a network enumerator
325 * @release: enumerator-specific release callback
326 */
327 struct rio_net {
328 struct list_head node; /* node in list of networks */
329 struct list_head devices; /* list of devices in this net */
330 struct list_head switches; /* list of switches in this net */
331 struct list_head mports; /* list of ports accessing net */
332 struct rio_mport *hport; /* primary port for accessing net */
333 unsigned char id; /* RIO network ID */
334 struct device dev;
335 void *enum_data; /* private data for enumerator of the network */
336 void (*release)(struct rio_net *net);
337 };
338
339 enum rio_link_speed {
340 RIO_LINK_DOWN = 0, /* SRIO Link not initialized */
341 RIO_LINK_125 = 1, /* 1.25 GBaud */
342 RIO_LINK_250 = 2, /* 2.5 GBaud */
343 RIO_LINK_312 = 3, /* 3.125 GBaud */
344 RIO_LINK_500 = 4, /* 5.0 GBaud */
345 RIO_LINK_625 = 5 /* 6.25 GBaud */
346 };
347
348 enum rio_link_width {
349 RIO_LINK_1X = 0,
350 RIO_LINK_1XR = 1,
351 RIO_LINK_2X = 3,
352 RIO_LINK_4X = 2,
353 RIO_LINK_8X = 4,
354 RIO_LINK_16X = 5
355 };
356
357 enum rio_mport_flags {
358 RIO_MPORT_DMA = (1 << 0), /* supports DMA data transfers */
359 RIO_MPORT_DMA_SG = (1 << 1), /* DMA supports HW SG mode */
360 RIO_MPORT_IBSG = (1 << 2), /* inbound mapping supports SG */
361 };
362
363 /**
364 * struct rio_mport_attr - RIO mport device attributes
365 * @flags: mport device capability flags
366 * @link_speed: SRIO link speed value (as defined by RapidIO specification)
367 * @link_width: SRIO link width value (as defined by RapidIO specification)
368 * @dma_max_sge: number of SG list entries that can be handled by DMA channel(s)
369 * @dma_max_size: max number of bytes in single DMA transfer (SG entry)
370 * @dma_align: alignment shift for DMA operations (as for other DMA operations)
371 */
372 struct rio_mport_attr {
373 int flags;
374 int link_speed;
375 int link_width;
376
377 /* DMA capability info: valid only if RIO_MPORT_DMA flag is set */
378 int dma_max_sge;
379 int dma_max_size;
380 int dma_align;
381 };
382
383 /* Low-level architecture-dependent routines */
384
385 /**
386 * struct rio_ops - Low-level RIO configuration space operations
387 * @lcread: Callback to perform local (master port) read of config space.
388 * @lcwrite: Callback to perform local (master port) write of config space.
389 * @cread: Callback to perform network read of config space.
390 * @cwrite: Callback to perform network write of config space.
391 * @dsend: Callback to send a doorbell message.
392 * @pwenable: Callback to enable/disable port-write message handling.
393 * @open_outb_mbox: Callback to initialize outbound mailbox.
394 * @close_outb_mbox: Callback to shut down outbound mailbox.
395 * @open_inb_mbox: Callback to initialize inbound mailbox.
396 * @close_inb_mbox: Callback to shut down inbound mailbox.
397 * @add_outb_message: Callback to add a message to an outbound mailbox queue.
398 * @add_inb_buffer: Callback to add a buffer to an inbound mailbox queue.
399 * @get_inb_message: Callback to get a message from an inbound mailbox queue.
400 * @map_inb: Callback to map RapidIO address region into local memory space.
401 * @unmap_inb: Callback to unmap RapidIO address region mapped with map_inb().
402 * @query_mport: Callback to query mport device attributes.
403 * @map_outb: Callback to map outbound address region into local memory space.
404 * @unmap_outb: Callback to unmap outbound RapidIO address region.
405 */
406 struct rio_ops {
407 int (*lcread) (struct rio_mport *mport, int index, u32 offset, int len,
408 u32 *data);
409 int (*lcwrite) (struct rio_mport *mport, int index, u32 offset, int len,
410 u32 data);
411 int (*cread) (struct rio_mport *mport, int index, u16 destid,
412 u8 hopcount, u32 offset, int len, u32 *data);
413 int (*cwrite) (struct rio_mport *mport, int index, u16 destid,
414 u8 hopcount, u32 offset, int len, u32 data);
415 int (*dsend) (struct rio_mport *mport, int index, u16 destid, u16 data);
416 int (*pwenable) (struct rio_mport *mport, int enable);
417 int (*open_outb_mbox)(struct rio_mport *mport, void *dev_id,
418 int mbox, int entries);
419 void (*close_outb_mbox)(struct rio_mport *mport, int mbox);
420 int (*open_inb_mbox)(struct rio_mport *mport, void *dev_id,
421 int mbox, int entries);
422 void (*close_inb_mbox)(struct rio_mport *mport, int mbox);
423 int (*add_outb_message)(struct rio_mport *mport, struct rio_dev *rdev,
424 int mbox, void *buffer, size_t len);
425 int (*add_inb_buffer)(struct rio_mport *mport, int mbox, void *buf);
426 void *(*get_inb_message)(struct rio_mport *mport, int mbox);
427 int (*map_inb)(struct rio_mport *mport, dma_addr_t lstart,
428 u64 rstart, u32 size, u32 flags);
429 void (*unmap_inb)(struct rio_mport *mport, dma_addr_t lstart);
430 int (*query_mport)(struct rio_mport *mport,
431 struct rio_mport_attr *attr);
432 int (*map_outb)(struct rio_mport *mport, u16 destid, u64 rstart,
433 u32 size, u32 flags, dma_addr_t *laddr);
434 void (*unmap_outb)(struct rio_mport *mport, u16 destid, u64 rstart);
435 };
436
437 #define RIO_RESOURCE_MEM 0x00000100
438 #define RIO_RESOURCE_DOORBELL 0x00000200
439 #define RIO_RESOURCE_MAILBOX 0x00000400
440
441 #define RIO_RESOURCE_CACHEABLE 0x00010000
442 #define RIO_RESOURCE_PCI 0x00020000
443
444 #define RIO_RESOURCE_BUSY 0x80000000
445
446 /**
447 * struct rio_driver - RIO driver info
448 * @node: Node in list of drivers
449 * @name: RIO driver name
450 * @id_table: RIO device ids to be associated with this driver
451 * @probe: RIO device inserted
452 * @remove: RIO device removed
453 * @shutdown: shutdown notification callback
454 * @suspend: RIO device suspended
455 * @resume: RIO device awakened
456 * @enable_wake: RIO device enable wake event
457 * @driver: LDM driver struct
458 *
459 * Provides info on a RIO device driver for insertion/removal and
460 * power management purposes.
461 */
462 struct rio_driver {
463 struct list_head node;
464 char *name;
465 const struct rio_device_id *id_table;
466 int (*probe) (struct rio_dev * dev, const struct rio_device_id * id);
467 void (*remove) (struct rio_dev * dev);
468 void (*shutdown)(struct rio_dev *dev);
469 int (*suspend) (struct rio_dev * dev, u32 state);
470 int (*resume) (struct rio_dev * dev);
471 int (*enable_wake) (struct rio_dev * dev, u32 state, int enable);
472 struct device_driver driver;
473 };
474
475 #define to_rio_driver(drv) container_of(drv,struct rio_driver, driver)
476
477 union rio_pw_msg {
478 struct {
479 u32 comptag; /* Component Tag CSR */
480 u32 errdetect; /* Port N Error Detect CSR */
481 u32 is_port; /* Implementation specific + PortID */
482 u32 ltlerrdet; /* LTL Error Detect CSR */
483 u32 padding[12];
484 } em;
485 u32 raw[RIO_PW_MSG_SIZE/sizeof(u32)];
486 };
487
488 #ifdef CONFIG_RAPIDIO_DMA_ENGINE
489
490 /*
491 * enum rio_write_type - RIO write transaction types used in DMA transfers
492 *
493 * Note: RapidIO specification defines write (NWRITE) and
494 * write-with-response (NWRITE_R) data transfer operations.
495 * Existing DMA controllers that service RapidIO may use one of these operations
496 * for entire data transfer or their combination with only the last data packet
497 * requires response.
498 */
499 enum rio_write_type {
500 RDW_DEFAULT, /* default method used by DMA driver */
501 RDW_ALL_NWRITE, /* all packets use NWRITE */
502 RDW_ALL_NWRITE_R, /* all packets use NWRITE_R */
503 RDW_LAST_NWRITE_R, /* last packet uses NWRITE_R, others - NWRITE */
504 };
505
506 struct rio_dma_ext {
507 u16 destid;
508 u64 rio_addr; /* low 64-bits of 66-bit RapidIO address */
509 u8 rio_addr_u; /* upper 2-bits of 66-bit RapidIO address */
510 enum rio_write_type wr_type; /* preferred RIO write operation type */
511 };
512
513 struct rio_dma_data {
514 /* Local data (as scatterlist) */
515 struct scatterlist *sg; /* I/O scatter list */
516 unsigned int sg_len; /* size of scatter list */
517 /* Remote device address (flat buffer) */
518 u64 rio_addr; /* low 64-bits of 66-bit RapidIO address */
519 u8 rio_addr_u; /* upper 2-bits of 66-bit RapidIO address */
520 enum rio_write_type wr_type; /* preferred RIO write operation type */
521 };
522
523 static inline struct rio_mport *dma_to_mport(struct dma_device *ddev)
524 {
525 return container_of(ddev, struct rio_mport, dma);
526 }
527 #endif /* CONFIG_RAPIDIO_DMA_ENGINE */
528
529 /**
530 * struct rio_scan - RIO enumeration and discovery operations
531 * @owner: The module owner of this structure
532 * @enumerate: Callback to perform RapidIO fabric enumeration.
533 * @discover: Callback to perform RapidIO fabric discovery.
534 */
535 struct rio_scan {
536 struct module *owner;
537 int (*enumerate)(struct rio_mport *mport, u32 flags);
538 int (*discover)(struct rio_mport *mport, u32 flags);
539 };
540
541 /**
542 * struct rio_scan_node - list node to register RapidIO enumeration and
543 * discovery methods with RapidIO core.
544 * @mport_id: ID of an mport (net) serviced by this enumerator
545 * @node: node in global list of registered enumerators
546 * @ops: RIO enumeration and discovery operations
547 */
548 struct rio_scan_node {
549 int mport_id;
550 struct list_head node;
551 struct rio_scan *ops;
552 };
553
554 /* Architecture and hardware-specific functions */
555 extern int rio_mport_initialize(struct rio_mport *);
556 extern int rio_register_mport(struct rio_mport *);
557 extern int rio_unregister_mport(struct rio_mport *);
558 extern int rio_open_inb_mbox(struct rio_mport *, void *, int, int);
559 extern void rio_close_inb_mbox(struct rio_mport *, int);
560 extern int rio_open_outb_mbox(struct rio_mport *, void *, int, int);
561 extern void rio_close_outb_mbox(struct rio_mport *, int);
562 extern int rio_query_mport(struct rio_mport *port,
563 struct rio_mport_attr *mport_attr);
564
565 #endif /* LINUX_RIO_H */
This page took 0.066936 seconds and 5 git commands to generate.