[linux.git] / drivers / vme / vme_bridge.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _VME_BRIDGE_H_
#define _VME_BRIDGE_H_

#include <linux/vme.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[VME_NUM_STATUSID];
};

/* 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)(void *), void *);
	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);

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