]> git.openfabrics.org - ~shefty/rdma-dev.git/blob - include/linux/rio.h
rapidio: fix RapidIO sysfs hierarchy
[~shefty/rdma-dev.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
24 #define RIO_NO_HOPCOUNT         -1
25 #define RIO_INVALID_DESTID      0xffff
26
27 #define RIO_MAX_MPORT_RESOURCES 16
28 #define RIO_MAX_DEV_RESOURCES   16
29
30 #define RIO_GLOBAL_TABLE        0xff    /* Indicates access of a switch's
31                                            global routing table if it
32                                            has multiple (or per port)
33                                            tables */
34
35 #define RIO_INVALID_ROUTE       0xff    /* Indicates that a route table
36                                            entry is invalid (no route
37                                            exists for the device ID) */
38
39 #define RIO_MAX_ROUTE_ENTRIES(size)     (size ? (1 << 16) : (1 << 8))
40 #define RIO_ANY_DESTID(size)            (size ? 0xffff : 0xff)
41
42 #define RIO_MAX_MBOX            4
43 #define RIO_MAX_MSG_SIZE        0x1000
44
45 /*
46  * Error values that may be returned by RIO functions.
47  */
48 #define RIO_SUCCESSFUL                  0x00
49 #define RIO_BAD_SIZE                    0x81
50
51 /*
52  * For RIO devices, the region numbers are assigned this way:
53  *
54  *      0       RapidIO outbound doorbells
55  *      1-15    RapidIO memory regions
56  *
57  * For RIO master ports, the region number are assigned this way:
58  *
59  *      0       RapidIO inbound doorbells
60  *      1       RapidIO inbound mailboxes
61  *      1       RapidIO outbound mailboxes
62  */
63 #define RIO_DOORBELL_RESOURCE   0
64 #define RIO_INB_MBOX_RESOURCE   1
65 #define RIO_OUTB_MBOX_RESOURCE  2
66
67 #define RIO_PW_MSG_SIZE         64
68
69 extern struct bus_type rio_bus_type;
70 extern struct device rio_bus;
71 extern struct list_head rio_devices;    /* list of all devices */
72
73 struct rio_mport;
74 union rio_pw_msg;
75
76 /**
77  * struct rio_dev - RIO device info
78  * @global_list: Node in list of all RIO devices
79  * @net_list: Node in list of RIO devices in a network
80  * @net: Network this device is a part of
81  * @did: Device ID
82  * @vid: Vendor ID
83  * @device_rev: Device revision
84  * @asm_did: Assembly device ID
85  * @asm_vid: Assembly vendor ID
86  * @asm_rev: Assembly revision
87  * @efptr: Extended feature pointer
88  * @pef: Processing element features
89  * @swpinfo: Switch port info
90  * @src_ops: Source operation capabilities
91  * @dst_ops: Destination operation capabilities
92  * @comp_tag: RIO component tag
93  * @phys_efptr: RIO device extended features pointer
94  * @em_efptr: RIO Error Management features pointer
95  * @dma_mask: Mask of bits of RIO address this device implements
96  * @rswitch: Pointer to &struct rio_switch if valid for this device
97  * @driver: Driver claiming this device
98  * @dev: Device model device
99  * @riores: RIO resources this device owns
100  * @pwcback: port-write callback function for this device
101  * @destid: Network destination ID
102  */
103 struct rio_dev {
104         struct list_head global_list;   /* node in list of all RIO devices */
105         struct list_head net_list;      /* node in per net list */
106         struct rio_net *net;    /* RIO net this device resides in */
107         u16 did;
108         u16 vid;
109         u32 device_rev;
110         u16 asm_did;
111         u16 asm_vid;
112         u16 asm_rev;
113         u16 efptr;
114         u32 pef;
115         u32 swpinfo;            /* Only used for switches */
116         u32 src_ops;
117         u32 dst_ops;
118         u32 comp_tag;
119         u32 phys_efptr;
120         u32 em_efptr;
121         u64 dma_mask;
122         struct rio_switch *rswitch;     /* RIO switch info */
123         struct rio_driver *driver;      /* RIO driver claiming this device */
124         struct device dev;      /* LDM device structure */
125         struct resource riores[RIO_MAX_DEV_RESOURCES];
126         int (*pwcback) (struct rio_dev *rdev, union rio_pw_msg *msg, int step);
127         u16 destid;
128 };
129
130 #define rio_dev_g(n) list_entry(n, struct rio_dev, global_list)
131 #define rio_dev_f(n) list_entry(n, struct rio_dev, net_list)
132 #define to_rio_dev(n) container_of(n, struct rio_dev, dev)
133
134 /**
135  * struct rio_msg - RIO message event
136  * @res: Mailbox resource
137  * @mcback: Message event callback
138  */
139 struct rio_msg {
140         struct resource *res;
141         void (*mcback) (struct rio_mport * mport, void *dev_id, int mbox, int slot);
142 };
143
144 /**
145  * struct rio_dbell - RIO doorbell event
146  * @node: Node in list of doorbell events
147  * @res: Doorbell resource
148  * @dinb: Doorbell event callback
149  * @dev_id: Device specific pointer to pass on event
150  */
151 struct rio_dbell {
152         struct list_head node;
153         struct resource *res;
154         void (*dinb) (struct rio_mport *mport, void *dev_id, u16 src, u16 dst, u16 info);
155         void *dev_id;
156 };
157
158 enum rio_phy_type {
159         RIO_PHY_PARALLEL,
160         RIO_PHY_SERIAL,
161 };
162
163 /**
164  * struct rio_mport - RIO master port info
165  * @dbells: List of doorbell events
166  * @node: Node in global list of master ports
167  * @nnode: Node in network list of master ports
168  * @iores: I/O mem resource that this master port interface owns
169  * @riores: RIO resources that this master port interfaces owns
170  * @inb_msg: RIO inbound message event descriptors
171  * @outb_msg: RIO outbound message event descriptors
172  * @host_deviceid: Host device ID associated with this master port
173  * @ops: configuration space functions
174  * @id: Port ID, unique among all ports
175  * @index: Port index, unique among all port interfaces of the same type
176  * @sys_size: RapidIO common transport system size
177  * @phy_type: RapidIO phy type
178  * @name: Port name string
179  * @priv: Master port private data
180  */
181 struct rio_mport {
182         struct list_head dbells;        /* list of doorbell events */
183         struct list_head node;  /* node in global list of ports */
184         struct list_head nnode; /* node in net list of ports */
185         struct resource iores;
186         struct resource riores[RIO_MAX_MPORT_RESOURCES];
187         struct rio_msg inb_msg[RIO_MAX_MBOX];
188         struct rio_msg outb_msg[RIO_MAX_MBOX];
189         int host_deviceid;      /* Host device ID */
190         struct rio_ops *ops;    /* maintenance transaction functions */
191         unsigned char id;       /* port ID, unique among all ports */
192         unsigned char index;    /* port index, unique among all port
193                                    interfaces of the same type */
194         unsigned int sys_size;  /* RapidIO common transport system size.
195                                  * 0 - Small size. 256 devices.
196                                  * 1 - Large size, 65536 devices.
197                                  */
198         enum rio_phy_type phy_type;     /* RapidIO phy type */
199         unsigned char name[40];
200         void *priv;             /* Master port private data */
201 };
202
203 /**
204  * struct rio_net - RIO network info
205  * @node: Node in global list of RIO networks
206  * @devices: List of devices in this network
207  * @mports: List of master ports accessing this network
208  * @hport: Default port for accessing this network
209  * @id: RIO network ID
210  */
211 struct rio_net {
212         struct list_head node;  /* node in list of networks */
213         struct list_head devices;       /* list of devices in this net */
214         struct list_head mports;        /* list of ports accessing net */
215         struct rio_mport *hport;        /* primary port for accessing net */
216         unsigned char id;       /* RIO network ID */
217 };
218
219 /**
220  * struct rio_switch - RIO switch info
221  * @node: Node in global list of switches
222  * @switchid: Switch ID that is unique across a network
223  * @hopcount: Hopcount to this switch
224  * @destid: Associated destid in the path
225  * @route_table: Copy of switch routing table
226  * @port_ok: Status of each port (one bit per port) - OK=1 or UNINIT=0
227  * @add_entry: Callback for switch-specific route add function
228  * @get_entry: Callback for switch-specific route get function
229  * @clr_table: Callback for switch-specific clear route table function
230  * @set_domain: Callback for switch-specific domain setting function
231  * @get_domain: Callback for switch-specific domain get function
232  * @em_init: Callback for switch-specific error management initialization function
233  * @em_handle: Callback for switch-specific error management handler function
234  */
235 struct rio_switch {
236         struct list_head node;
237         u16 switchid;
238         u16 hopcount;
239         u16 destid;
240         u8 *route_table;
241         u32 port_ok;
242         int (*add_entry) (struct rio_mport * mport, u16 destid, u8 hopcount,
243                           u16 table, u16 route_destid, u8 route_port);
244         int (*get_entry) (struct rio_mport * mport, u16 destid, u8 hopcount,
245                           u16 table, u16 route_destid, u8 * route_port);
246         int (*clr_table) (struct rio_mport *mport, u16 destid, u8 hopcount,
247                           u16 table);
248         int (*set_domain) (struct rio_mport *mport, u16 destid, u8 hopcount,
249                            u8 sw_domain);
250         int (*get_domain) (struct rio_mport *mport, u16 destid, u8 hopcount,
251                            u8 *sw_domain);
252         int (*em_init) (struct rio_dev *dev);
253         int (*em_handle) (struct rio_dev *dev, u8 swport);
254 };
255
256 /* Low-level architecture-dependent routines */
257
258 /**
259  * struct rio_ops - Low-level RIO configuration space operations
260  * @lcread: Callback to perform local (master port) read of config space.
261  * @lcwrite: Callback to perform local (master port) write of config space.
262  * @cread: Callback to perform network read of config space.
263  * @cwrite: Callback to perform network write of config space.
264  * @dsend: Callback to send a doorbell message.
265  * @pwenable: Callback to enable/disable port-write message handling.
266  */
267 struct rio_ops {
268         int (*lcread) (struct rio_mport *mport, int index, u32 offset, int len,
269                         u32 *data);
270         int (*lcwrite) (struct rio_mport *mport, int index, u32 offset, int len,
271                         u32 data);
272         int (*cread) (struct rio_mport *mport, int index, u16 destid,
273                         u8 hopcount, u32 offset, int len, u32 *data);
274         int (*cwrite) (struct rio_mport *mport, int index, u16 destid,
275                         u8 hopcount, u32 offset, int len, u32 data);
276         int (*dsend) (struct rio_mport *mport, int index, u16 destid, u16 data);
277         int (*pwenable) (struct rio_mport *mport, int enable);
278 };
279
280 #define RIO_RESOURCE_MEM        0x00000100
281 #define RIO_RESOURCE_DOORBELL   0x00000200
282 #define RIO_RESOURCE_MAILBOX    0x00000400
283
284 #define RIO_RESOURCE_CACHEABLE  0x00010000
285 #define RIO_RESOURCE_PCI        0x00020000
286
287 #define RIO_RESOURCE_BUSY       0x80000000
288
289 /**
290  * struct rio_driver - RIO driver info
291  * @node: Node in list of drivers
292  * @name: RIO driver name
293  * @id_table: RIO device ids to be associated with this driver
294  * @probe: RIO device inserted
295  * @remove: RIO device removed
296  * @suspend: RIO device suspended
297  * @resume: RIO device awakened
298  * @enable_wake: RIO device enable wake event
299  * @driver: LDM driver struct
300  *
301  * Provides info on a RIO device driver for insertion/removal and
302  * power management purposes.
303  */
304 struct rio_driver {
305         struct list_head node;
306         char *name;
307         const struct rio_device_id *id_table;
308         int (*probe) (struct rio_dev * dev, const struct rio_device_id * id);
309         void (*remove) (struct rio_dev * dev);
310         int (*suspend) (struct rio_dev * dev, u32 state);
311         int (*resume) (struct rio_dev * dev);
312         int (*enable_wake) (struct rio_dev * dev, u32 state, int enable);
313         struct device_driver driver;
314 };
315
316 #define to_rio_driver(drv) container_of(drv,struct rio_driver, driver)
317
318 /**
319  * struct rio_device_id - RIO device identifier
320  * @did: RIO device ID
321  * @vid: RIO vendor ID
322  * @asm_did: RIO assembly device ID
323  * @asm_vid: RIO assembly vendor ID
324  *
325  * Identifies a RIO device based on both the device/vendor IDs and
326  * the assembly device/vendor IDs.
327  */
328 struct rio_device_id {
329         u16 did, vid;
330         u16 asm_did, asm_vid;
331 };
332
333 /**
334  * struct rio_switch_ops - Per-switch operations
335  * @vid: RIO vendor ID
336  * @did: RIO device ID
337  * @init_hook: Callback that performs switch device initialization
338  *
339  * Defines the operations that are necessary to initialize/control
340  * a particular RIO switch device.
341  */
342 struct rio_switch_ops {
343         u16 vid, did;
344         int (*init_hook) (struct rio_dev *rdev, int do_enum);
345 };
346
347 union rio_pw_msg {
348         struct {
349                 u32 comptag;    /* Component Tag CSR */
350                 u32 errdetect;  /* Port N Error Detect CSR */
351                 u32 is_port;    /* Implementation specific + PortID */
352                 u32 ltlerrdet;  /* LTL Error Detect CSR */
353                 u32 padding[12];
354         } em;
355         u32 raw[RIO_PW_MSG_SIZE/sizeof(u32)];
356 };
357
358 /* Architecture and hardware-specific functions */
359 extern int rio_init_mports(void);
360 extern void rio_register_mport(struct rio_mport *);
361 extern int rio_hw_add_outb_message(struct rio_mport *, struct rio_dev *, int,
362                                    void *, size_t);
363 extern int rio_hw_add_inb_buffer(struct rio_mport *, int, void *);
364 extern void *rio_hw_get_inb_message(struct rio_mport *, int);
365 extern int rio_open_inb_mbox(struct rio_mport *, void *, int, int);
366 extern void rio_close_inb_mbox(struct rio_mport *, int);
367 extern int rio_open_outb_mbox(struct rio_mport *, void *, int, int);
368 extern void rio_close_outb_mbox(struct rio_mport *, int);
369
370 #endif                          /* LINUX_RIO_H */