[mirror_ubuntu-zesty-kernel.git] / drivers / vme / vme_bridge.h

#ifndef _VME_BRIDGE_H_
#define _VME_BRIDGE_H_

#define VME_CRCSR_BUF_SIZE (508*1024)
/*
 * Resource structures
 */
struct vme_master_resource {
	struct list_head list;
	struct vme_bridge *parent;
	/*
	 * We are likely to need to access the VME bus in interrupt context, so
	 * protect master routines with a spinlock rather than a mutex.
	 */
	spinlock_t lock;
	int locked;
	int number;
	u32 address_attr;
	u32 cycle_attr;
	u32 width_attr;
	struct resource bus_resource;
	void __iomem *kern_base;
};

struct vme_slave_resource {
	struct list_head list;
	struct vme_bridge *parent;
	struct mutex mtx;
	int locked;
	int number;
	u32 address_attr;
	u32 cycle_attr;
};

struct vme_dma_pattern {
	u32 pattern;
	u32 type;
};

struct vme_dma_pci {
	dma_addr_t address;
};

struct vme_dma_vme {
	unsigned long long address;
	u32 aspace;
	u32 cycle;
	u32 dwidth;
};

struct vme_dma_list {
	struct list_head list;
	struct vme_dma_resource *parent;
	struct list_head entries;
	struct mutex mtx;
};

struct vme_dma_resource {
	struct list_head list;
	struct vme_bridge *parent;
	struct mutex mtx;
	int locked;
	int number;
	struct list_head pending;
	struct list_head running;
	u32 route_attr;
};

struct vme_lm_resource {
	struct list_head list;
	struct vme_bridge *parent;
	struct mutex mtx;
	int locked;
	int number;
	int monitors;
};

struct vme_error_handler {
	struct list_head list;
	unsigned long long start;	/* Beginning of error window */
	unsigned long long end;		/* End of error window */
	unsigned long long first_error;	/* Address of the first error */
	u32 aspace;			/* Address space of error window*/
	unsigned num_errors;		/* Number of errors */
};

struct vme_callback {
	void (*func)(int, int, void*);
	void *priv_data;
};

struct vme_irq {
	int count;
	struct vme_callback callback[255];
};

/* Allow 16 characters for name (including null character) */
#define VMENAMSIZ 16

/* This structure stores all the information about one bridge
 * The structure should be dynamically allocated by the driver and one instance
 * of the structure should be present for each VME chip present in the system.
 */
struct vme_bridge {
	char name[VMENAMSIZ];
	int num;
	struct list_head master_resources;
	struct list_head slave_resources;
	struct list_head dma_resources;
	struct list_head lm_resources;

	/* List for registered errors handlers */
	struct list_head vme_error_handlers;
	/* List of devices on this bridge */
	struct list_head devices;

	/* Bridge Info - XXX Move to private structure? */
	struct device *parent;	/* Parent device (eg. pdev->dev for PCI) */
	void *driver_priv;	/* Private pointer for the bridge driver */
	struct list_head bus_list; /* list of VME buses */

	/* Interrupt callbacks */
	struct vme_irq irq[7];
	/* Locking for VME irq callback configuration */
	struct mutex irq_mtx;

	/* Slave Functions */
	int (*slave_get) (struct vme_slave_resource *, int *,
		unsigned long long *, unsigned long long *, dma_addr_t *,
		u32 *, u32 *);
	int (*slave_set) (struct vme_slave_resource *, int, unsigned long long,
		unsigned long long, dma_addr_t, u32, u32);

	/* Master Functions */
	int (*master_get) (struct vme_master_resource *, int *,
		unsigned long long *, unsigned long long *, u32 *, u32 *,
		u32 *);
	int (*master_set) (struct vme_master_resource *, int,
		unsigned long long, unsigned long long,  u32, u32, u32);
	ssize_t (*master_read) (struct vme_master_resource *, void *, size_t,
		loff_t);
	ssize_t (*master_write) (struct vme_master_resource *, void *, size_t,
		loff_t);
	unsigned int (*master_rmw) (struct vme_master_resource *, unsigned int,
		unsigned int, unsigned int, loff_t);

	/* DMA Functions */
	int (*dma_list_add) (struct vme_dma_list *, struct vme_dma_attr *,
		struct vme_dma_attr *, size_t);
	int (*dma_list_exec) (struct vme_dma_list *);
	int (*dma_list_empty) (struct vme_dma_list *);

	/* Interrupt Functions */
	void (*irq_set) (struct vme_bridge *, int, int, int);
	int (*irq_generate) (struct vme_bridge *, int, int);

	/* Location monitor functions */
	int (*lm_set) (struct vme_lm_resource *, unsigned long long, u32, u32);
	int (*lm_get) (struct vme_lm_resource *, unsigned long long *, u32 *,
		u32 *);
	int (*lm_attach) (struct vme_lm_resource *, int, void (*callback)(int));
	int (*lm_detach) (struct vme_lm_resource *, int);

	/* CR/CSR space functions */
	int (*slot_get) (struct vme_bridge *);

	/* Bridge parent interface */
	void *(*alloc_consistent)(struct device *dev, size_t size,
		dma_addr_t *dma);
	void (*free_consistent)(struct device *dev, size_t size,
		void *vaddr, dma_addr_t dma);
};

void vme_bus_error_handler(struct vme_bridge *bridge,
			   unsigned long long address, int am);
void vme_irq_handler(struct vme_bridge *, int, int);

int vme_register_bridge(struct vme_bridge *);
void vme_unregister_bridge(struct vme_bridge *);
struct vme_error_handler *vme_register_error_handler(
	struct vme_bridge *bridge, u32 aspace,
	unsigned long long address, size_t len);
void vme_unregister_error_handler(struct vme_error_handler *handler);

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