Merge tag 'mmc-updates-for-3.11-rc1' of git://git.kernel.org/pub/scm/linux/kernel...
[firefly-linux-kernel-4.4.55.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 device rio_bus;
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 /**
141  * struct rio_dev - RIO device info
142  * @global_list: Node in list of all RIO devices
143  * @net_list: Node in list of RIO devices in a network
144  * @net: Network this device is a part of
145  * @do_enum: Enumeration flag
146  * @did: Device ID
147  * @vid: Vendor ID
148  * @device_rev: Device revision
149  * @asm_did: Assembly device ID
150  * @asm_vid: Assembly vendor ID
151  * @asm_rev: Assembly revision
152  * @efptr: Extended feature pointer
153  * @pef: Processing element features
154  * @swpinfo: Switch port info
155  * @src_ops: Source operation capabilities
156  * @dst_ops: Destination operation capabilities
157  * @comp_tag: RIO component tag
158  * @phys_efptr: RIO device extended features pointer
159  * @em_efptr: RIO Error Management features pointer
160  * @dma_mask: Mask of bits of RIO address this device implements
161  * @driver: Driver claiming this device
162  * @dev: Device model device
163  * @riores: RIO resources this device owns
164  * @pwcback: port-write callback function for this device
165  * @destid: Network destination ID (or associated destid for switch)
166  * @hopcount: Hopcount to this device
167  * @prev: Previous RIO device connected to the current one
168  * @rswitch: struct rio_switch (if valid for this device)
169  */
170 struct rio_dev {
171         struct list_head global_list;   /* node in list of all RIO devices */
172         struct list_head net_list;      /* node in per net list */
173         struct rio_net *net;    /* RIO net this device resides in */
174         bool do_enum;
175         u16 did;
176         u16 vid;
177         u32 device_rev;
178         u16 asm_did;
179         u16 asm_vid;
180         u16 asm_rev;
181         u16 efptr;
182         u32 pef;
183         u32 swpinfo;
184         u32 src_ops;
185         u32 dst_ops;
186         u32 comp_tag;
187         u32 phys_efptr;
188         u32 em_efptr;
189         u64 dma_mask;
190         struct rio_driver *driver;      /* RIO driver claiming this device */
191         struct device dev;      /* LDM device structure */
192         struct resource riores[RIO_MAX_DEV_RESOURCES];
193         int (*pwcback) (struct rio_dev *rdev, union rio_pw_msg *msg, int step);
194         u16 destid;
195         u8 hopcount;
196         struct rio_dev *prev;
197         struct rio_switch rswitch[0];   /* RIO switch info */
198 };
199
200 #define rio_dev_g(n) list_entry(n, struct rio_dev, global_list)
201 #define rio_dev_f(n) list_entry(n, struct rio_dev, net_list)
202 #define to_rio_dev(n) container_of(n, struct rio_dev, dev)
203 #define sw_to_rio_dev(n) container_of(n, struct rio_dev, rswitch[0])
204
205 /**
206  * struct rio_msg - RIO message event
207  * @res: Mailbox resource
208  * @mcback: Message event callback
209  */
210 struct rio_msg {
211         struct resource *res;
212         void (*mcback) (struct rio_mport * mport, void *dev_id, int mbox, int slot);
213 };
214
215 /**
216  * struct rio_dbell - RIO doorbell event
217  * @node: Node in list of doorbell events
218  * @res: Doorbell resource
219  * @dinb: Doorbell event callback
220  * @dev_id: Device specific pointer to pass on event
221  */
222 struct rio_dbell {
223         struct list_head node;
224         struct resource *res;
225         void (*dinb) (struct rio_mport *mport, void *dev_id, u16 src, u16 dst, u16 info);
226         void *dev_id;
227 };
228
229 enum rio_phy_type {
230         RIO_PHY_PARALLEL,
231         RIO_PHY_SERIAL,
232 };
233
234 /**
235  * struct rio_mport - RIO master port info
236  * @dbells: List of doorbell events
237  * @node: Node in global list of master ports
238  * @nnode: Node in network list of master ports
239  * @iores: I/O mem resource that this master port interface owns
240  * @riores: RIO resources that this master port interfaces owns
241  * @inb_msg: RIO inbound message event descriptors
242  * @outb_msg: RIO outbound message event descriptors
243  * @host_deviceid: Host device ID associated with this master port
244  * @ops: configuration space functions
245  * @id: Port ID, unique among all ports
246  * @index: Port index, unique among all port interfaces of the same type
247  * @sys_size: RapidIO common transport system size
248  * @phy_type: RapidIO phy type
249  * @phys_efptr: RIO port extended features pointer
250  * @name: Port name string
251  * @priv: Master port private data
252  * @dma: DMA device associated with mport
253  * @nscan: RapidIO network enumeration/discovery operations
254  */
255 struct rio_mport {
256         struct list_head dbells;        /* list of doorbell events */
257         struct list_head node;  /* node in global list of ports */
258         struct list_head nnode; /* node in net list of ports */
259         struct resource iores;
260         struct resource riores[RIO_MAX_MPORT_RESOURCES];
261         struct rio_msg inb_msg[RIO_MAX_MBOX];
262         struct rio_msg outb_msg[RIO_MAX_MBOX];
263         int host_deviceid;      /* Host device ID */
264         struct rio_ops *ops;    /* low-level architecture-dependent routines */
265         unsigned char id;       /* port ID, unique among all ports */
266         unsigned char index;    /* port index, unique among all port
267                                    interfaces of the same type */
268         unsigned int sys_size;  /* RapidIO common transport system size.
269                                  * 0 - Small size. 256 devices.
270                                  * 1 - Large size, 65536 devices.
271                                  */
272         enum rio_phy_type phy_type;     /* RapidIO phy type */
273         u32 phys_efptr;
274         unsigned char name[RIO_MAX_MPORT_NAME];
275         void *priv;             /* Master port private data */
276 #ifdef CONFIG_RAPIDIO_DMA_ENGINE
277         struct dma_device       dma;
278 #endif
279         struct rio_scan *nscan;
280 };
281
282 /*
283  * Enumeration/discovery control flags
284  */
285 #define RIO_SCAN_ENUM_NO_WAIT   0x00000001 /* Do not wait for enum completed */
286
287 struct rio_id_table {
288         u16 start;      /* logical minimal id */
289         u32 max;        /* max number of IDs in table */
290         spinlock_t lock;
291         unsigned long *table;
292 };
293
294 /**
295  * struct rio_net - RIO network info
296  * @node: Node in global list of RIO networks
297  * @devices: List of devices in this network
298  * @switches: List of switches in this netowrk
299  * @mports: List of master ports accessing this network
300  * @hport: Default port for accessing this network
301  * @id: RIO network ID
302  * @destid_table: destID allocation table
303  */
304 struct rio_net {
305         struct list_head node;  /* node in list of networks */
306         struct list_head devices;       /* list of devices in this net */
307         struct list_head switches;      /* list of switches in this net */
308         struct list_head mports;        /* list of ports accessing net */
309         struct rio_mport *hport;        /* primary port for accessing net */
310         unsigned char id;       /* RIO network ID */
311         struct rio_id_table destid_table;  /* destID allocation table */
312 };
313
314 /* Low-level architecture-dependent routines */
315
316 /**
317  * struct rio_ops - Low-level RIO configuration space operations
318  * @lcread: Callback to perform local (master port) read of config space.
319  * @lcwrite: Callback to perform local (master port) write of config space.
320  * @cread: Callback to perform network read of config space.
321  * @cwrite: Callback to perform network write of config space.
322  * @dsend: Callback to send a doorbell message.
323  * @pwenable: Callback to enable/disable port-write message handling.
324  * @open_outb_mbox: Callback to initialize outbound mailbox.
325  * @close_outb_mbox: Callback to shut down outbound mailbox.
326  * @open_inb_mbox: Callback to initialize inbound mailbox.
327  * @close_inb_mbox: Callback to shut down inbound mailbox.
328  * @add_outb_message: Callback to add a message to an outbound mailbox queue.
329  * @add_inb_buffer: Callback to add a buffer to an inbound mailbox queue.
330  * @get_inb_message: Callback to get a message from an inbound mailbox queue.
331  * @map_inb: Callback to map RapidIO address region into local memory space.
332  * @unmap_inb: Callback to unmap RapidIO address region mapped with map_inb().
333  */
334 struct rio_ops {
335         int (*lcread) (struct rio_mport *mport, int index, u32 offset, int len,
336                         u32 *data);
337         int (*lcwrite) (struct rio_mport *mport, int index, u32 offset, int len,
338                         u32 data);
339         int (*cread) (struct rio_mport *mport, int index, u16 destid,
340                         u8 hopcount, u32 offset, int len, u32 *data);
341         int (*cwrite) (struct rio_mport *mport, int index, u16 destid,
342                         u8 hopcount, u32 offset, int len, u32 data);
343         int (*dsend) (struct rio_mport *mport, int index, u16 destid, u16 data);
344         int (*pwenable) (struct rio_mport *mport, int enable);
345         int (*open_outb_mbox)(struct rio_mport *mport, void *dev_id,
346                               int mbox, int entries);
347         void (*close_outb_mbox)(struct rio_mport *mport, int mbox);
348         int  (*open_inb_mbox)(struct rio_mport *mport, void *dev_id,
349                              int mbox, int entries);
350         void (*close_inb_mbox)(struct rio_mport *mport, int mbox);
351         int  (*add_outb_message)(struct rio_mport *mport, struct rio_dev *rdev,
352                                  int mbox, void *buffer, size_t len);
353         int (*add_inb_buffer)(struct rio_mport *mport, int mbox, void *buf);
354         void *(*get_inb_message)(struct rio_mport *mport, int mbox);
355         int (*map_inb)(struct rio_mport *mport, dma_addr_t lstart,
356                         u64 rstart, u32 size, u32 flags);
357         void (*unmap_inb)(struct rio_mport *mport, dma_addr_t lstart);
358 };
359
360 #define RIO_RESOURCE_MEM        0x00000100
361 #define RIO_RESOURCE_DOORBELL   0x00000200
362 #define RIO_RESOURCE_MAILBOX    0x00000400
363
364 #define RIO_RESOURCE_CACHEABLE  0x00010000
365 #define RIO_RESOURCE_PCI        0x00020000
366
367 #define RIO_RESOURCE_BUSY       0x80000000
368
369 /**
370  * struct rio_driver - RIO driver info
371  * @node: Node in list of drivers
372  * @name: RIO driver name
373  * @id_table: RIO device ids to be associated with this driver
374  * @probe: RIO device inserted
375  * @remove: RIO device removed
376  * @suspend: RIO device suspended
377  * @resume: RIO device awakened
378  * @enable_wake: RIO device enable wake event
379  * @driver: LDM driver struct
380  *
381  * Provides info on a RIO device driver for insertion/removal and
382  * power management purposes.
383  */
384 struct rio_driver {
385         struct list_head node;
386         char *name;
387         const struct rio_device_id *id_table;
388         int (*probe) (struct rio_dev * dev, const struct rio_device_id * id);
389         void (*remove) (struct rio_dev * dev);
390         int (*suspend) (struct rio_dev * dev, u32 state);
391         int (*resume) (struct rio_dev * dev);
392         int (*enable_wake) (struct rio_dev * dev, u32 state, int enable);
393         struct device_driver driver;
394 };
395
396 #define to_rio_driver(drv) container_of(drv,struct rio_driver, driver)
397
398 union rio_pw_msg {
399         struct {
400                 u32 comptag;    /* Component Tag CSR */
401                 u32 errdetect;  /* Port N Error Detect CSR */
402                 u32 is_port;    /* Implementation specific + PortID */
403                 u32 ltlerrdet;  /* LTL Error Detect CSR */
404                 u32 padding[12];
405         } em;
406         u32 raw[RIO_PW_MSG_SIZE/sizeof(u32)];
407 };
408
409 #ifdef CONFIG_RAPIDIO_DMA_ENGINE
410
411 /*
412  * enum rio_write_type - RIO write transaction types used in DMA transfers
413  *
414  * Note: RapidIO specification defines write (NWRITE) and
415  * write-with-response (NWRITE_R) data transfer operations.
416  * Existing DMA controllers that service RapidIO may use one of these operations
417  * for entire data transfer or their combination with only the last data packet
418  * requires response.
419  */
420 enum rio_write_type {
421         RDW_DEFAULT,            /* default method used by DMA driver */
422         RDW_ALL_NWRITE,         /* all packets use NWRITE */
423         RDW_ALL_NWRITE_R,       /* all packets use NWRITE_R */
424         RDW_LAST_NWRITE_R,      /* last packet uses NWRITE_R, others - NWRITE */
425 };
426
427 struct rio_dma_ext {
428         u16 destid;
429         u64 rio_addr;   /* low 64-bits of 66-bit RapidIO address */
430         u8  rio_addr_u;  /* upper 2-bits of 66-bit RapidIO address */
431         enum rio_write_type wr_type; /* preferred RIO write operation type */
432 };
433
434 struct rio_dma_data {
435         /* Local data (as scatterlist) */
436         struct scatterlist      *sg;    /* I/O scatter list */
437         unsigned int            sg_len; /* size of scatter list */
438         /* Remote device address (flat buffer) */
439         u64 rio_addr;   /* low 64-bits of 66-bit RapidIO address */
440         u8  rio_addr_u;  /* upper 2-bits of 66-bit RapidIO address */
441         enum rio_write_type wr_type; /* preferred RIO write operation type */
442 };
443
444 static inline struct rio_mport *dma_to_mport(struct dma_device *ddev)
445 {
446         return container_of(ddev, struct rio_mport, dma);
447 }
448 #endif /* CONFIG_RAPIDIO_DMA_ENGINE */
449
450 /**
451  * struct rio_scan - RIO enumeration and discovery operations
452  * @owner: The module owner of this structure
453  * @enumerate: Callback to perform RapidIO fabric enumeration.
454  * @discover: Callback to perform RapidIO fabric discovery.
455  */
456 struct rio_scan {
457         struct module *owner;
458         int (*enumerate)(struct rio_mport *mport, u32 flags);
459         int (*discover)(struct rio_mport *mport, u32 flags);
460 };
461
462 /**
463  * struct rio_scan_node - list node to register RapidIO enumeration and
464  * discovery methods with RapidIO core.
465  * @mport_id: ID of an mport (net) serviced by this enumerator
466  * @node: node in global list of registered enumerators
467  * @ops: RIO enumeration and discovery operations
468  */
469 struct rio_scan_node {
470         int mport_id;
471         struct list_head node;
472         struct rio_scan *ops;
473 };
474
475 /* Architecture and hardware-specific functions */
476 extern int rio_register_mport(struct rio_mport *);
477 extern int rio_open_inb_mbox(struct rio_mport *, void *, int, int);
478 extern void rio_close_inb_mbox(struct rio_mport *, int);
479 extern int rio_open_outb_mbox(struct rio_mport *, void *, int, int);
480 extern void rio_close_outb_mbox(struct rio_mport *, int);
481
482 #endif                          /* LINUX_RIO_H */