[deliverable/linux.git] / include / linux / rio.h

/*
 * RapidIO interconnect services
 * (RapidIO Interconnect Specification, http://www.rapidio.org)
 *
 * Copyright 2005 MontaVista Software, Inc.
 * Matt Porter <mporter@kernel.crashing.org>
 *
 * This program is free software; you can redistribute  it and/or modify it
 * under  the terms of  the GNU General  Public License as published by the
 * Free Software Foundation;  either version 2 of the  License, or (at your
 * option) any later version.
 */

#ifndef LINUX_RIO_H
#define LINUX_RIO_H

#include <linux/types.h>
#include <linux/ioport.h>
#include <linux/list.h>
#include <linux/errno.h>
#include <linux/device.h>
#include <linux/rio_regs.h>

#define RIO_NO_HOPCOUNT		-1
#define RIO_INVALID_DESTID	0xffff

#define RIO_MAX_MPORT_RESOURCES	16
#define RIO_MAX_DEV_RESOURCES	16

#define RIO_GLOBAL_TABLE	0xff	/* Indicates access of a switch's
					   global routing table if it
					   has multiple (or per port)
					   tables */

#define RIO_INVALID_ROUTE	0xff	/* Indicates that a route table
					   entry is invalid (no route
					   exists for the device ID) */

#define RIO_MAX_ROUTE_ENTRIES(size)	(size ? (1 << 16) : (1 << 8))
#define RIO_ANY_DESTID(size)		(size ? 0xffff : 0xff)

#define RIO_MAX_MBOX		4
#define RIO_MAX_MSG_SIZE	0x1000

/*
 * Error values that may be returned by RIO functions.
 */
#define RIO_SUCCESSFUL			0x00
#define RIO_BAD_SIZE			0x81

/*
 * For RIO devices, the region numbers are assigned this way:
 *
 *	0	RapidIO outbound doorbells
 *      1-15	RapidIO memory regions
 *
 * For RIO master ports, the region number are assigned this way:
 *
 *	0	RapidIO inbound doorbells
 *	1	RapidIO inbound mailboxes
 *	1	RapidIO outbound mailboxes
 */
#define RIO_DOORBELL_RESOURCE	0
#define RIO_INB_MBOX_RESOURCE	1
#define RIO_OUTB_MBOX_RESOURCE	2

#define RIO_PW_MSG_SIZE		64

extern struct bus_type rio_bus_type;
extern struct list_head rio_devices;	/* list of all devices */

struct rio_mport;
union rio_pw_msg;

/**
 * struct rio_dev - RIO device info
 * @global_list: Node in list of all RIO devices
 * @net_list: Node in list of RIO devices in a network
 * @net: Network this device is a part of
 * @did: Device ID
 * @vid: Vendor ID
 * @device_rev: Device revision
 * @asm_did: Assembly device ID
 * @asm_vid: Assembly vendor ID
 * @asm_rev: Assembly revision
 * @efptr: Extended feature pointer
 * @pef: Processing element features
 * @swpinfo: Switch port info
 * @src_ops: Source operation capabilities
 * @dst_ops: Destination operation capabilities
 * @dma_mask: Mask of bits of RIO address this device implements
 * @rswitch: Pointer to &struct rio_switch if valid for this device
 * @driver: Driver claiming this device
 * @dev: Device model device
 * @riores: RIO resources this device owns
 * @destid: Network destination ID
 */
struct rio_dev {
	struct list_head global_list;	/* node in list of all RIO devices */
	struct list_head net_list;	/* node in per net list */
	struct rio_net *net;	/* RIO net this device resides in */
	u16 did;
	u16 vid;
	u32 device_rev;
	u16 asm_did;
	u16 asm_vid;
	u16 asm_rev;
	u16 efptr;
	u32 pef;
	u32 swpinfo;		/* Only used for switches */
	u32 src_ops;
	u32 dst_ops;
	u32 comp_tag;
	u32 phys_efptr;
	u32 em_efptr;
	u64 dma_mask;
	struct rio_switch *rswitch;	/* RIO switch info */
	struct rio_driver *driver;	/* RIO driver claiming this device */
	struct device dev;	/* LDM device structure */
	struct resource riores[RIO_MAX_DEV_RESOURCES];
	int (*pwcback) (struct rio_dev *rdev, union rio_pw_msg *msg, int step);
	u16 destid;
};

#define rio_dev_g(n) list_entry(n, struct rio_dev, global_list)
#define rio_dev_f(n) list_entry(n, struct rio_dev, net_list)
#define	to_rio_dev(n) container_of(n, struct rio_dev, dev)

/**
 * struct rio_msg - RIO message event
 * @res: Mailbox resource
 * @mcback: Message event callback
 */
struct rio_msg {
	struct resource *res;
	void (*mcback) (struct rio_mport * mport, void *dev_id, int mbox, int slot);
};

/**
 * struct rio_dbell - RIO doorbell event
 * @node: Node in list of doorbell events
 * @res: Doorbell resource
 * @dinb: Doorbell event callback
 * @dev_id: Device specific pointer to pass on event
 */
struct rio_dbell {
	struct list_head node;
	struct resource *res;
	void (*dinb) (struct rio_mport *mport, void *dev_id, u16 src, u16 dst, u16 info);
	void *dev_id;
};

enum rio_phy_type {
	RIO_PHY_PARALLEL,
	RIO_PHY_SERIAL,
};

/**
 * struct rio_mport - RIO master port info
 * @dbells: List of doorbell events
 * @node: Node in global list of master ports
 * @nnode: Node in network list of master ports
 * @iores: I/O mem resource that this master port interface owns
 * @riores: RIO resources that this master port interfaces owns
 * @inb_msg: RIO inbound message event descriptors
 * @outb_msg: RIO outbound message event descriptors
 * @host_deviceid: Host device ID associated with this master port
 * @ops: configuration space functions
 * @id: Port ID, unique among all ports
 * @index: Port index, unique among all port interfaces of the same type
 * @sys_size: RapidIO common transport system size
 * @phy_type: RapidIO phy type
 * @name: Port name string
 * @priv: Master port private data
 */
struct rio_mport {
	struct list_head dbells;	/* list of doorbell events */
	struct list_head node;	/* node in global list of ports */
	struct list_head nnode;	/* node in net list of ports */
	struct resource iores;
	struct resource riores[RIO_MAX_MPORT_RESOURCES];
	struct rio_msg inb_msg[RIO_MAX_MBOX];
	struct rio_msg outb_msg[RIO_MAX_MBOX];
	int host_deviceid;	/* Host device ID */
	struct rio_ops *ops;	/* maintenance transaction functions */
	unsigned char id;	/* port ID, unique among all ports */
	unsigned char index;	/* port index, unique among all port
				   interfaces of the same type */
	unsigned int sys_size;	/* RapidIO common transport system size.
				 * 0 - Small size. 256 devices.
				 * 1 - Large size, 65536 devices.
				 */
	enum rio_phy_type phy_type;	/* RapidIO phy type */
	unsigned char name[40];
	void *priv;		/* Master port private data */
};

/**
 * struct rio_net - RIO network info
 * @node: Node in global list of RIO networks
 * @devices: List of devices in this network
 * @mports: List of master ports accessing this network
 * @hport: Default port for accessing this network
 * @id: RIO network ID
 */
struct rio_net {
	struct list_head node;	/* node in list of networks */
	struct list_head devices;	/* list of devices in this net */
	struct list_head mports;	/* list of ports accessing net */
	struct rio_mport *hport;	/* primary port for accessing net */
	unsigned char id;	/* RIO network ID */
};

/**
 * struct rio_switch - RIO switch info
 * @node: Node in global list of switches
 * @switchid: Switch ID that is unique across a network
 * @hopcount: Hopcount to this switch
 * @destid: Associated destid in the path
 * @route_table: Copy of switch routing table
 * @port_ok: Status of each port (one bit per port) - OK=1 or UNINIT=0
 * @add_entry: Callback for switch-specific route add function
 * @get_entry: Callback for switch-specific route get function
 * @clr_table: Callback for switch-specific clear route table function
 * @em_init: Callback for switch-specific error management initialization function
 * @em_handle: Callback for switch-specific error management handler function
 */
struct rio_switch {
	struct list_head node;
	u16 switchid;
	u16 hopcount;
	u16 destid;
	u8 *route_table;
	u32 port_ok;
	int (*add_entry) (struct rio_mport * mport, u16 destid, u8 hopcount,
			  u16 table, u16 route_destid, u8 route_port);
	int (*get_entry) (struct rio_mport * mport, u16 destid, u8 hopcount,
			  u16 table, u16 route_destid, u8 * route_port);
	int (*clr_table) (struct rio_mport *mport, u16 destid, u8 hopcount,
			  u16 table);
	int (*set_domain) (struct rio_mport *mport, u16 destid, u8 hopcount,
			   u8 sw_domain);
	int (*get_domain) (struct rio_mport *mport, u16 destid, u8 hopcount,
			   u8 *sw_domain);
	int (*em_init) (struct rio_dev *dev);
	int (*em_handle) (struct rio_dev *dev, u8 swport);
};

/* Low-level architecture-dependent routines */

/**
 * struct rio_ops - Low-level RIO configuration space operations
 * @lcread: Callback to perform local (master port) read of config space.
 * @lcwrite: Callback to perform local (master port) write of config space.
 * @cread: Callback to perform network read of config space.
 * @cwrite: Callback to perform network write of config space.
 * @dsend: Callback to send a doorbell message.
 * @pwenable: Callback to enable/disable port-write message handling.
 */
struct rio_ops {
	int (*lcread) (struct rio_mport *mport, int index, u32 offset, int len,
			u32 *data);
	int (*lcwrite) (struct rio_mport *mport, int index, u32 offset, int len,
			u32 data);
	int (*cread) (struct rio_mport *mport, int index, u16 destid,
			u8 hopcount, u32 offset, int len, u32 *data);
	int (*cwrite) (struct rio_mport *mport, int index, u16 destid,
			u8 hopcount, u32 offset, int len, u32 data);
	int (*dsend) (struct rio_mport *mport, int index, u16 destid, u16 data);
	int (*pwenable) (struct rio_mport *mport, int enable);
};

#define RIO_RESOURCE_MEM	0x00000100
#define RIO_RESOURCE_DOORBELL	0x00000200
#define RIO_RESOURCE_MAILBOX	0x00000400

#define RIO_RESOURCE_CACHEABLE	0x00010000
#define RIO_RESOURCE_PCI	0x00020000

#define RIO_RESOURCE_BUSY	0x80000000

/**
 * struct rio_driver - RIO driver info
 * @node: Node in list of drivers
 * @name: RIO driver name
 * @id_table: RIO device ids to be associated with this driver
 * @probe: RIO device inserted
 * @remove: RIO device removed
 * @suspend: RIO device suspended
 * @resume: RIO device awakened
 * @enable_wake: RIO device enable wake event
 * @driver: LDM driver struct
 *
 * Provides info on a RIO device driver for insertion/removal and
 * power management purposes.
 */
struct rio_driver {
	struct list_head node;
	char *name;
	const struct rio_device_id *id_table;
	int (*probe) (struct rio_dev * dev, const struct rio_device_id * id);
	void (*remove) (struct rio_dev * dev);
	int (*suspend) (struct rio_dev * dev, u32 state);
	int (*resume) (struct rio_dev * dev);
	int (*enable_wake) (struct rio_dev * dev, u32 state, int enable);
	struct device_driver driver;
};

#define	to_rio_driver(drv) container_of(drv,struct rio_driver, driver)

/**
 * struct rio_device_id - RIO device identifier
 * @did: RIO device ID
 * @vid: RIO vendor ID
 * @asm_did: RIO assembly device ID
 * @asm_vid: RIO assembly vendor ID
 *
 * Identifies a RIO device based on both the device/vendor IDs and
 * the assembly device/vendor IDs.
 */
struct rio_device_id {
	u16 did, vid;
	u16 asm_did, asm_vid;
};

/**
 * struct rio_switch_ops - Per-switch operations
 * @vid: RIO vendor ID
 * @did: RIO device ID
 * @init_hook: Callback that performs switch device initialization
 *
 * Defines the operations that are necessary to initialize/control
 * a particular RIO switch device.
 */
struct rio_switch_ops {
	u16 vid, did;
	int (*init_hook) (struct rio_dev *rdev, int do_enum);
};

union rio_pw_msg {
	struct {
		u32 comptag;	/* Component Tag CSR */
		u32 errdetect;	/* Port N Error Detect CSR */
		u32 is_port;	/* Implementation specific + PortID */
		u32 ltlerrdet;	/* LTL Error Detect CSR */
		u32 padding[12];
	} em;
	u32 raw[RIO_PW_MSG_SIZE/sizeof(u32)];
};

/* Architecture and hardware-specific functions */
extern int rio_init_mports(void);
extern void rio_register_mport(struct rio_mport *);
extern int rio_hw_add_outb_message(struct rio_mport *, struct rio_dev *, int,
				   void *, size_t);
extern int rio_hw_add_inb_buffer(struct rio_mport *, int, void *);
extern void *rio_hw_get_inb_message(struct rio_mport *, int);
extern int rio_open_inb_mbox(struct rio_mport *, void *, int, int);
extern void rio_close_inb_mbox(struct rio_mport *, int);
extern int rio_open_outb_mbox(struct rio_mport *, void *, int, int);
extern void rio_close_outb_mbox(struct rio_mport *, int);

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