1#ifndef _VME_BRIDGE_H_
  2#define _VME_BRIDGE_H_
  3
  4#include <linux/vme.h>
  5
  6#define VME_CRCSR_BUF_SIZE (508*1024)
  7/*
  8 * Resource structures
  9 */
 10struct vme_master_resource {
 11	struct list_head list;
 12	struct vme_bridge *parent;
 13	/*
 14	 * We are likely to need to access the VME bus in interrupt context, so
 15	 * protect master routines with a spinlock rather than a mutex.
 16	 */
 17	spinlock_t lock;
 18	int locked;
 19	int number;
 20	u32 address_attr;
 21	u32 cycle_attr;
 22	u32 width_attr;
 23	struct resource bus_resource;
 24	void __iomem *kern_base;
 25};
 26
 27struct vme_slave_resource {
 28	struct list_head list;
 29	struct vme_bridge *parent;
 30	struct mutex mtx;
 31	int locked;
 32	int number;
 33	u32 address_attr;
 34	u32 cycle_attr;
 35};
 36
 37struct vme_dma_pattern {
 38	u32 pattern;
 39	u32 type;
 40};
 41
 42struct vme_dma_pci {
 43	dma_addr_t address;
 44};
 45
 46struct vme_dma_vme {
 47	unsigned long long address;
 48	u32 aspace;
 49	u32 cycle;
 50	u32 dwidth;
 51};
 52
 53struct vme_dma_list {
 54	struct list_head list;
 55	struct vme_dma_resource *parent;
 56	struct list_head entries;
 57	struct mutex mtx;
 58};
 59
 60struct vme_dma_resource {
 61	struct list_head list;
 62	struct vme_bridge *parent;
 63	struct mutex mtx;
 64	int locked;
 65	int number;
 66	struct list_head pending;
 67	struct list_head running;
 68	u32 route_attr;
 69};
 70
 71struct vme_lm_resource {
 72	struct list_head list;
 73	struct vme_bridge *parent;
 74	struct mutex mtx;
 75	int locked;
 76	int number;
 77	int monitors;
 78};
 79
 80struct vme_error_handler {
 81	struct list_head list;
 82	unsigned long long start;	/* Beginning of error window */
 83	unsigned long long end;		/* End of error window */
 84	unsigned long long first_error;	/* Address of the first error */
 85	u32 aspace;			/* Address space of error window*/
 86	unsigned num_errors;		/* Number of errors */
 87};
 88
 89struct vme_callback {
 90	void (*func)(int, int, void*);
 91	void *priv_data;
 92};
 93
 94struct vme_irq {
 95	int count;
 96	struct vme_callback callback[VME_NUM_STATUSID];
 97};
 98
 99/* Allow 16 characters for name (including null character) */
100#define VMENAMSIZ 16
101
102/* This structure stores all the information about one bridge
103 * The structure should be dynamically allocated by the driver and one instance
104 * of the structure should be present for each VME chip present in the system.
105 */
106struct vme_bridge {
107	char name[VMENAMSIZ];
108	int num;
109	struct list_head master_resources;
110	struct list_head slave_resources;
111	struct list_head dma_resources;
112	struct list_head lm_resources;
113
114	/* List for registered errors handlers */
115	struct list_head vme_error_handlers;
116	/* List of devices on this bridge */
117	struct list_head devices;
118
119	/* Bridge Info - XXX Move to private structure? */
120	struct device *parent;	/* Parent device (eg. pdev->dev for PCI) */
121	void *driver_priv;	/* Private pointer for the bridge driver */
122	struct list_head bus_list; /* list of VME buses */
123
124	/* Interrupt callbacks */
125	struct vme_irq irq[7];
126	/* Locking for VME irq callback configuration */
127	struct mutex irq_mtx;
128
129	/* Slave Functions */
130	int (*slave_get) (struct vme_slave_resource *, int *,
131		unsigned long long *, unsigned long long *, dma_addr_t *,
132		u32 *, u32 *);
133	int (*slave_set) (struct vme_slave_resource *, int, unsigned long long,
134		unsigned long long, dma_addr_t, u32, u32);
135
136	/* Master Functions */
137	int (*master_get) (struct vme_master_resource *, int *,
138		unsigned long long *, unsigned long long *, u32 *, u32 *,
139		u32 *);
140	int (*master_set) (struct vme_master_resource *, int,
141		unsigned long long, unsigned long long,  u32, u32, u32);
142	ssize_t (*master_read) (struct vme_master_resource *, void *, size_t,
143		loff_t);
144	ssize_t (*master_write) (struct vme_master_resource *, void *, size_t,
145		loff_t);
146	unsigned int (*master_rmw) (struct vme_master_resource *, unsigned int,
147		unsigned int, unsigned int, loff_t);
148
149	/* DMA Functions */
150	int (*dma_list_add) (struct vme_dma_list *, struct vme_dma_attr *,
151		struct vme_dma_attr *, size_t);
152	int (*dma_list_exec) (struct vme_dma_list *);
153	int (*dma_list_empty) (struct vme_dma_list *);
154
155	/* Interrupt Functions */
156	void (*irq_set) (struct vme_bridge *, int, int, int);
157	int (*irq_generate) (struct vme_bridge *, int, int);
158
159	/* Location monitor functions */
160	int (*lm_set) (struct vme_lm_resource *, unsigned long long, u32, u32);
161	int (*lm_get) (struct vme_lm_resource *, unsigned long long *, u32 *,
162		u32 *);
163	int (*lm_attach) (struct vme_lm_resource *, int, void (*callback)(int));
164	int (*lm_detach) (struct vme_lm_resource *, int);
165
166	/* CR/CSR space functions */
167	int (*slot_get) (struct vme_bridge *);
168
169	/* Bridge parent interface */
170	void *(*alloc_consistent)(struct device *dev, size_t size,
171		dma_addr_t *dma);
172	void (*free_consistent)(struct device *dev, size_t size,
173		void *vaddr, dma_addr_t dma);
174};
175
176void vme_bus_error_handler(struct vme_bridge *bridge,
177			   unsigned long long address, int am);
178void vme_irq_handler(struct vme_bridge *, int, int);
179
180int vme_register_bridge(struct vme_bridge *);
181void vme_unregister_bridge(struct vme_bridge *);
182struct vme_error_handler *vme_register_error_handler(
183	struct vme_bridge *bridge, u32 aspace,
184	unsigned long long address, size_t len);
185void vme_unregister_error_handler(struct vme_error_handler *handler);
186
187#endif /* _VME_BRIDGE_H_ */