blob: ff681ebba5854c8a074a90ef68c994c0d4578e3b [file] [log] [blame]
Matt Porter70a50eb2005-11-07 01:00:16 -08001/*
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
Matt Porter70a50eb2005-11-07 01:00:16 -080017#include <linux/types.h>
Matt Porter70a50eb2005-11-07 01:00:16 -080018#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
Matt Porter70a50eb2005-11-07 01:00:16 -080024#define RIO_NO_HOPCOUNT -1
Alexandre Bouninec70555b2007-02-10 01:46:47 -080025#define RIO_INVALID_DESTID 0xffff
Matt Porter70a50eb2005-11-07 01:00:16 -080026
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
Zhang Weie0423232008-04-18 13:33:42 -070039#define RIO_MAX_ROUTE_ENTRIES(size) (size ? (1 << 16) : (1 << 8))
40#define RIO_ANY_DESTID(size) (size ? 0xffff : 0xff)
Matt Porter70a50eb2005-11-07 01:00:16 -080041
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
Alexandre Bouninee5cabeb2010-05-26 14:43:59 -070067#define RIO_PW_MSG_SIZE 64
68
Alexandre Bouninee6536922011-01-12 17:00:40 -080069/*
70 * A component tag value (stored in the component tag CSR) is used as device's
71 * unique identifier assigned during enumeration. Besides being used for
72 * identifying switches (which do not have device ID register), it also is used
73 * by error management notification and therefore has to be assigned
74 * to endpoints as well.
75 */
76#define RIO_CTAG_RESRVD 0xfffe0000 /* Reserved */
77#define RIO_CTAG_UDEVID 0x0001ffff /* Unique device identifier */
78
Matt Porter70a50eb2005-11-07 01:00:16 -080079extern struct bus_type rio_bus_type;
Alexandre Bounine2c70f022010-10-27 15:34:26 -070080extern struct device rio_bus;
Matt Porter70a50eb2005-11-07 01:00:16 -080081extern struct list_head rio_devices; /* list of all devices */
82
83struct rio_mport;
Alexandre Bounineded05782011-01-12 17:00:39 -080084struct rio_dev;
Alexandre Bouninee5cabeb2010-05-26 14:43:59 -070085union rio_pw_msg;
Matt Porter70a50eb2005-11-07 01:00:16 -080086
87/**
Alexandre Bounineded05782011-01-12 17:00:39 -080088 * struct rio_switch - RIO switch info
89 * @node: Node in global list of switches
90 * @switchid: Switch ID that is unique across a network
91 * @route_table: Copy of switch routing table
92 * @port_ok: Status of each port (one bit per port) - OK=1 or UNINIT=0
93 * @add_entry: Callback for switch-specific route add function
94 * @get_entry: Callback for switch-specific route get function
95 * @clr_table: Callback for switch-specific clear route table function
96 * @set_domain: Callback for switch-specific domain setting function
97 * @get_domain: Callback for switch-specific domain get function
98 * @em_init: Callback for switch-specific error management init function
99 * @em_handle: Callback for switch-specific error management handler function
100 * @sw_sysfs: Callback that initializes switch-specific sysfs attributes
101 * @nextdev: Array of per-port pointers to the next attached device
102 */
103struct rio_switch {
104 struct list_head node;
105 u16 switchid;
106 u8 *route_table;
107 u32 port_ok;
108 int (*add_entry) (struct rio_mport *mport, u16 destid, u8 hopcount,
109 u16 table, u16 route_destid, u8 route_port);
110 int (*get_entry) (struct rio_mport *mport, u16 destid, u8 hopcount,
111 u16 table, u16 route_destid, u8 *route_port);
112 int (*clr_table) (struct rio_mport *mport, u16 destid, u8 hopcount,
113 u16 table);
114 int (*set_domain) (struct rio_mport *mport, u16 destid, u8 hopcount,
115 u8 sw_domain);
116 int (*get_domain) (struct rio_mport *mport, u16 destid, u8 hopcount,
117 u8 *sw_domain);
118 int (*em_init) (struct rio_dev *dev);
119 int (*em_handle) (struct rio_dev *dev, u8 swport);
120 int (*sw_sysfs) (struct rio_dev *dev, int create);
121 struct rio_dev *nextdev[0];
122};
123
124/**
Matt Porter70a50eb2005-11-07 01:00:16 -0800125 * struct rio_dev - RIO device info
126 * @global_list: Node in list of all RIO devices
127 * @net_list: Node in list of RIO devices in a network
128 * @net: Network this device is a part of
129 * @did: Device ID
130 * @vid: Vendor ID
131 * @device_rev: Device revision
132 * @asm_did: Assembly device ID
133 * @asm_vid: Assembly vendor ID
134 * @asm_rev: Assembly revision
135 * @efptr: Extended feature pointer
136 * @pef: Processing element features
137 * @swpinfo: Switch port info
138 * @src_ops: Source operation capabilities
139 * @dst_ops: Destination operation capabilities
Randy Dunlap97ef6f72010-05-28 15:08:08 -0700140 * @comp_tag: RIO component tag
141 * @phys_efptr: RIO device extended features pointer
142 * @em_efptr: RIO Error Management features pointer
Matt Porterfa78cc52005-11-07 01:00:18 -0800143 * @dma_mask: Mask of bits of RIO address this device implements
Matt Porter70a50eb2005-11-07 01:00:16 -0800144 * @driver: Driver claiming this device
145 * @dev: Device model device
146 * @riores: RIO resources this device owns
Randy Dunlap97ef6f72010-05-28 15:08:08 -0700147 * @pwcback: port-write callback function for this device
Alexandre Bouninea93192a2011-01-12 17:00:38 -0800148 * @destid: Network destination ID (or associated destid for switch)
149 * @hopcount: Hopcount to this device
Alexandre Bounine68fe4df2010-10-27 15:34:29 -0700150 * @prev: Previous RIO device connected to the current one
Alexandre Bounineded05782011-01-12 17:00:39 -0800151 * @rswitch: struct rio_switch (if valid for this device)
Matt Porter70a50eb2005-11-07 01:00:16 -0800152 */
153struct rio_dev {
154 struct list_head global_list; /* node in list of all RIO devices */
155 struct list_head net_list; /* node in per net list */
156 struct rio_net *net; /* RIO net this device resides in */
157 u16 did;
158 u16 vid;
159 u32 device_rev;
160 u16 asm_did;
161 u16 asm_vid;
162 u16 asm_rev;
163 u16 efptr;
164 u32 pef;
Alexandre Bounineae05cbd2010-10-27 15:34:29 -0700165 u32 swpinfo;
Matt Porter70a50eb2005-11-07 01:00:16 -0800166 u32 src_ops;
167 u32 dst_ops;
Alexandre Bouninee5cabeb2010-05-26 14:43:59 -0700168 u32 comp_tag;
169 u32 phys_efptr;
170 u32 em_efptr;
Matt Porterfa78cc52005-11-07 01:00:18 -0800171 u64 dma_mask;
Matt Porter70a50eb2005-11-07 01:00:16 -0800172 struct rio_driver *driver; /* RIO driver claiming this device */
173 struct device dev; /* LDM device structure */
174 struct resource riores[RIO_MAX_DEV_RESOURCES];
Alexandre Bouninee5cabeb2010-05-26 14:43:59 -0700175 int (*pwcback) (struct rio_dev *rdev, union rio_pw_msg *msg, int step);
Matt Porter70a50eb2005-11-07 01:00:16 -0800176 u16 destid;
Alexandre Bouninea93192a2011-01-12 17:00:38 -0800177 u8 hopcount;
Alexandre Bounine68fe4df2010-10-27 15:34:29 -0700178 struct rio_dev *prev;
Alexandre Bounineded05782011-01-12 17:00:39 -0800179 struct rio_switch rswitch[0]; /* RIO switch info */
Matt Porter70a50eb2005-11-07 01:00:16 -0800180};
181
182#define rio_dev_g(n) list_entry(n, struct rio_dev, global_list)
183#define rio_dev_f(n) list_entry(n, struct rio_dev, net_list)
184#define to_rio_dev(n) container_of(n, struct rio_dev, dev)
Alexandre Bounineded05782011-01-12 17:00:39 -0800185#define sw_to_rio_dev(n) container_of(n, struct rio_dev, rswitch[0])
Matt Porter70a50eb2005-11-07 01:00:16 -0800186
187/**
188 * struct rio_msg - RIO message event
189 * @res: Mailbox resource
190 * @mcback: Message event callback
191 */
192struct rio_msg {
193 struct resource *res;
Matt Porter6978bbc2005-11-07 01:00:20 -0800194 void (*mcback) (struct rio_mport * mport, void *dev_id, int mbox, int slot);
Matt Porter70a50eb2005-11-07 01:00:16 -0800195};
196
197/**
198 * struct rio_dbell - RIO doorbell event
199 * @node: Node in list of doorbell events
200 * @res: Doorbell resource
201 * @dinb: Doorbell event callback
Matt Porter6978bbc2005-11-07 01:00:20 -0800202 * @dev_id: Device specific pointer to pass on event
Matt Porter70a50eb2005-11-07 01:00:16 -0800203 */
204struct rio_dbell {
205 struct list_head node;
206 struct resource *res;
Matt Porter6978bbc2005-11-07 01:00:20 -0800207 void (*dinb) (struct rio_mport *mport, void *dev_id, u16 src, u16 dst, u16 info);
208 void *dev_id;
Matt Porter70a50eb2005-11-07 01:00:16 -0800209};
210
Zhang Wei61b26912008-04-18 13:33:44 -0700211enum rio_phy_type {
212 RIO_PHY_PARALLEL,
213 RIO_PHY_SERIAL,
214};
215
Matt Porter70a50eb2005-11-07 01:00:16 -0800216/**
217 * struct rio_mport - RIO master port info
218 * @dbells: List of doorbell events
219 * @node: Node in global list of master ports
220 * @nnode: Node in network list of master ports
221 * @iores: I/O mem resource that this master port interface owns
222 * @riores: RIO resources that this master port interfaces owns
223 * @inb_msg: RIO inbound message event descriptors
224 * @outb_msg: RIO outbound message event descriptors
225 * @host_deviceid: Host device ID associated with this master port
226 * @ops: configuration space functions
227 * @id: Port ID, unique among all ports
228 * @index: Port index, unique among all port interfaces of the same type
Randy Dunlap9941d942008-04-30 16:45:58 -0700229 * @sys_size: RapidIO common transport system size
230 * @phy_type: RapidIO phy type
Alexandre Bounineaf84ca32010-10-27 15:34:34 -0700231 * @phys_efptr: RIO port extended features pointer
Matt Porter70a50eb2005-11-07 01:00:16 -0800232 * @name: Port name string
Zhang Weiad1e9382008-04-18 13:33:41 -0700233 * @priv: Master port private data
Matt Porter70a50eb2005-11-07 01:00:16 -0800234 */
235struct rio_mport {
236 struct list_head dbells; /* list of doorbell events */
237 struct list_head node; /* node in global list of ports */
238 struct list_head nnode; /* node in net list of ports */
239 struct resource iores;
240 struct resource riores[RIO_MAX_MPORT_RESOURCES];
241 struct rio_msg inb_msg[RIO_MAX_MBOX];
242 struct rio_msg outb_msg[RIO_MAX_MBOX];
243 int host_deviceid; /* Host device ID */
244 struct rio_ops *ops; /* maintenance transaction functions */
245 unsigned char id; /* port ID, unique among all ports */
246 unsigned char index; /* port index, unique among all port
247 interfaces of the same type */
Zhang Weie0423232008-04-18 13:33:42 -0700248 unsigned int sys_size; /* RapidIO common transport system size.
249 * 0 - Small size. 256 devices.
250 * 1 - Large size, 65536 devices.
251 */
Zhang Wei61b26912008-04-18 13:33:44 -0700252 enum rio_phy_type phy_type; /* RapidIO phy type */
Alexandre Bounineaf84ca32010-10-27 15:34:34 -0700253 u32 phys_efptr;
Matt Porter70a50eb2005-11-07 01:00:16 -0800254 unsigned char name[40];
Zhang Weiad1e9382008-04-18 13:33:41 -0700255 void *priv; /* Master port private data */
Matt Porter70a50eb2005-11-07 01:00:16 -0800256};
257
258/**
259 * struct rio_net - RIO network info
260 * @node: Node in global list of RIO networks
261 * @devices: List of devices in this network
262 * @mports: List of master ports accessing this network
263 * @hport: Default port for accessing this network
264 * @id: RIO network ID
265 */
266struct rio_net {
267 struct list_head node; /* node in list of networks */
268 struct list_head devices; /* list of devices in this net */
269 struct list_head mports; /* list of ports accessing net */
270 struct rio_mport *hport; /* primary port for accessing net */
271 unsigned char id; /* RIO network ID */
272};
273
Alexandre Bounineac38d722010-10-27 15:34:31 -0700274/* Definitions used by switch sysfs initialization callback */
275#define RIO_SW_SYSFS_CREATE 1 /* Create switch attributes */
276#define RIO_SW_SYSFS_REMOVE 0 /* Remove switch attributes */
277
Matt Porter70a50eb2005-11-07 01:00:16 -0800278/* Low-level architecture-dependent routines */
279
280/**
281 * struct rio_ops - Low-level RIO configuration space operations
282 * @lcread: Callback to perform local (master port) read of config space.
283 * @lcwrite: Callback to perform local (master port) write of config space.
284 * @cread: Callback to perform network read of config space.
285 * @cwrite: Callback to perform network write of config space.
286 * @dsend: Callback to send a doorbell message.
Alexandre Bouninee5cabeb2010-05-26 14:43:59 -0700287 * @pwenable: Callback to enable/disable port-write message handling.
Matt Porter70a50eb2005-11-07 01:00:16 -0800288 */
289struct rio_ops {
Zhang Weiad1e9382008-04-18 13:33:41 -0700290 int (*lcread) (struct rio_mport *mport, int index, u32 offset, int len,
291 u32 *data);
292 int (*lcwrite) (struct rio_mport *mport, int index, u32 offset, int len,
293 u32 data);
294 int (*cread) (struct rio_mport *mport, int index, u16 destid,
295 u8 hopcount, u32 offset, int len, u32 *data);
296 int (*cwrite) (struct rio_mport *mport, int index, u16 destid,
297 u8 hopcount, u32 offset, int len, u32 data);
298 int (*dsend) (struct rio_mport *mport, int index, u16 destid, u16 data);
Alexandre Bouninee5cabeb2010-05-26 14:43:59 -0700299 int (*pwenable) (struct rio_mport *mport, int enable);
Matt Porter70a50eb2005-11-07 01:00:16 -0800300};
301
302#define RIO_RESOURCE_MEM 0x00000100
303#define RIO_RESOURCE_DOORBELL 0x00000200
304#define RIO_RESOURCE_MAILBOX 0x00000400
305
306#define RIO_RESOURCE_CACHEABLE 0x00010000
307#define RIO_RESOURCE_PCI 0x00020000
308
309#define RIO_RESOURCE_BUSY 0x80000000
310
311/**
312 * struct rio_driver - RIO driver info
313 * @node: Node in list of drivers
314 * @name: RIO driver name
315 * @id_table: RIO device ids to be associated with this driver
316 * @probe: RIO device inserted
317 * @remove: RIO device removed
318 * @suspend: RIO device suspended
319 * @resume: RIO device awakened
320 * @enable_wake: RIO device enable wake event
321 * @driver: LDM driver struct
322 *
323 * Provides info on a RIO device driver for insertion/removal and
324 * power management purposes.
325 */
326struct rio_driver {
327 struct list_head node;
328 char *name;
329 const struct rio_device_id *id_table;
330 int (*probe) (struct rio_dev * dev, const struct rio_device_id * id);
331 void (*remove) (struct rio_dev * dev);
332 int (*suspend) (struct rio_dev * dev, u32 state);
333 int (*resume) (struct rio_dev * dev);
334 int (*enable_wake) (struct rio_dev * dev, u32 state, int enable);
335 struct device_driver driver;
336};
337
338#define to_rio_driver(drv) container_of(drv,struct rio_driver, driver)
339
340/**
341 * struct rio_device_id - RIO device identifier
342 * @did: RIO device ID
343 * @vid: RIO vendor ID
344 * @asm_did: RIO assembly device ID
345 * @asm_vid: RIO assembly vendor ID
346 *
347 * Identifies a RIO device based on both the device/vendor IDs and
348 * the assembly device/vendor IDs.
349 */
350struct rio_device_id {
351 u16 did, vid;
352 u16 asm_did, asm_vid;
353};
354
355/**
Alexandre Bounine058f88d2010-05-26 14:44:03 -0700356 * struct rio_switch_ops - Per-switch operations
Matt Porter70a50eb2005-11-07 01:00:16 -0800357 * @vid: RIO vendor ID
358 * @did: RIO device ID
Alexandre Bounine058f88d2010-05-26 14:44:03 -0700359 * @init_hook: Callback that performs switch device initialization
Matt Porter70a50eb2005-11-07 01:00:16 -0800360 *
Alexandre Bounine058f88d2010-05-26 14:44:03 -0700361 * Defines the operations that are necessary to initialize/control
362 * a particular RIO switch device.
Matt Porter70a50eb2005-11-07 01:00:16 -0800363 */
Alexandre Bounine058f88d2010-05-26 14:44:03 -0700364struct rio_switch_ops {
Matt Porter70a50eb2005-11-07 01:00:16 -0800365 u16 vid, did;
Alexandre Bounine058f88d2010-05-26 14:44:03 -0700366 int (*init_hook) (struct rio_dev *rdev, int do_enum);
Alexandre Bouninee5cabeb2010-05-26 14:43:59 -0700367};
368
369union rio_pw_msg {
370 struct {
371 u32 comptag; /* Component Tag CSR */
372 u32 errdetect; /* Port N Error Detect CSR */
373 u32 is_port; /* Implementation specific + PortID */
374 u32 ltlerrdet; /* LTL Error Detect CSR */
375 u32 padding[12];
376 } em;
377 u32 raw[RIO_PW_MSG_SIZE/sizeof(u32)];
378};
379
Matt Porter70a50eb2005-11-07 01:00:16 -0800380/* Architecture and hardware-specific functions */
381extern int rio_init_mports(void);
382extern void rio_register_mport(struct rio_mport *);
383extern int rio_hw_add_outb_message(struct rio_mport *, struct rio_dev *, int,
384 void *, size_t);
385extern int rio_hw_add_inb_buffer(struct rio_mport *, int, void *);
386extern void *rio_hw_get_inb_message(struct rio_mport *, int);
Matt Porter6978bbc2005-11-07 01:00:20 -0800387extern int rio_open_inb_mbox(struct rio_mport *, void *, int, int);
Matt Porter70a50eb2005-11-07 01:00:16 -0800388extern void rio_close_inb_mbox(struct rio_mport *, int);
Matt Porter6978bbc2005-11-07 01:00:20 -0800389extern int rio_open_outb_mbox(struct rio_mport *, void *, int, int);
Matt Porter70a50eb2005-11-07 01:00:16 -0800390extern void rio_close_outb_mbox(struct rio_mport *, int);
391
Matt Porter70a50eb2005-11-07 01:00:16 -0800392#endif /* LINUX_RIO_H */