PageRenderTime 28ms CodeModel.GetById 11ms app.highlight 12ms RepoModel.GetById 1ms app.codeStats 1ms

/include/linux/rio.h

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