[mirror_ubuntu-bionic-kernel.git] / drivers / staging / vme / vme.h

#ifndef _VME_H_
#define _VME_H_

/* Resource Type */
enum vme_resource_type {
	VME_MASTER,
	VME_SLAVE,
	VME_DMA
};

/* VME Address Spaces */
typedef u32 vme_address_t;
#define VME_A16		0x1
#define VME_A24		0x2
#define	VME_A32		0x4
#define VME_A64		0x8
#define VME_CRCSR	0x10
#define VME_USER1	0x20
#define VME_USER2	0x40
#define VME_USER3	0x80
#define VME_USER4	0x100

#define VME_A16_MAX	0x10000ULL
#define VME_A24_MAX	0x1000000ULL
#define VME_A32_MAX	0x100000000ULL
#define VME_A64_MAX	0x10000000000000000ULL
#define VME_CRCSR_MAX	0x1000000ULL


/* VME Cycle Types */
typedef u32 vme_cycle_t;
#define VME_SCT		0x1
#define VME_BLT		0x2
#define VME_MBLT	0x4
#define VME_2eVME	0x8
#define VME_2eSST	0x10
#define VME_2eSSTB	0x20

#define VME_2eSST160	0x100
#define VME_2eSST267	0x200
#define VME_2eSST320	0x400

#define	VME_SUPER	0x1000
#define	VME_USER	0x2000
#define	VME_PROG	0x4000
#define	VME_DATA	0x8000

/* VME Data Widths */
typedef u32 vme_width_t;
#define VME_D8		0x1
#define VME_D16		0x2
#define VME_D32		0x4
#define VME_D64		0x8

/* Arbitration Scheduling Modes */
typedef u32 vme_arbitration_t;
#define VME_R_ROBIN_MODE	0x1
#define VME_PRIORITY_MODE	0x2

typedef u32 vme_dma_t;
#define VME_DMA_PATTERN			(1<<0)
#define VME_DMA_PCI			(1<<1)
#define VME_DMA_VME			(1<<2)

typedef u32 vme_pattern_t;
#define VME_DMA_PATTERN_BYTE		(1<<0)
#define VME_DMA_PATTERN_WORD		(1<<1)
#define VME_DMA_PATTERN_INCREMENT	(1<<2)

struct vme_dma_attr {
	vme_dma_t type;
	void *private;
};

struct vme_resource {
	enum vme_resource_type type;
	struct list_head *entry;
};

extern struct bus_type vme_bus_type;

struct vme_device_id {
	int bus;
	int slot;
};

struct vme_driver {
	struct list_head node;
	char *name;
	const struct vme_device_id *bind_table;
	int (*probe)  (struct device *, int, int);
	int (*remove) (struct device *, int, int);
	void (*shutdown) (void);
	struct device_driver    driver;
};

void * vme_alloc_consistent(struct vme_resource *, size_t, dma_addr_t *);
void vme_free_consistent(struct vme_resource *, size_t,  void *,
	dma_addr_t);

size_t vme_get_size(struct vme_resource *);

struct vme_resource * vme_slave_request(struct device *, vme_address_t, vme_cycle_t);
int vme_slave_set (struct vme_resource *, int, unsigned long long,
	unsigned long long, dma_addr_t, vme_address_t, vme_cycle_t);
int vme_slave_get (struct vme_resource *, int *, unsigned long long *,
	unsigned long long *, dma_addr_t *, vme_address_t *, vme_cycle_t *);
void vme_slave_free(struct vme_resource *);

struct vme_resource * vme_master_request(struct device *, vme_address_t, vme_cycle_t,
	vme_width_t);
int vme_master_set (struct vme_resource *, int, unsigned long long,
	unsigned long long, vme_address_t, vme_cycle_t, vme_width_t);
int vme_master_get (struct vme_resource *, int *, unsigned long long *,
	unsigned long long *, vme_address_t *, vme_cycle_t *, vme_width_t *);
ssize_t vme_master_read(struct vme_resource *, void *, size_t, loff_t);
ssize_t vme_master_write(struct vme_resource *, void *, size_t, loff_t);
unsigned int vme_master_rmw (struct vme_resource *, unsigned int, unsigned int,
	unsigned int, loff_t);
void vme_master_free(struct vme_resource *);

struct vme_resource *vme_request_dma(struct device *);
struct vme_dma_list *vme_new_dma_list(struct vme_resource *);
struct vme_dma_attr *vme_dma_pattern_attribute(u32, vme_pattern_t);
struct vme_dma_attr *vme_dma_pci_attribute(dma_addr_t);
struct vme_dma_attr *vme_dma_vme_attribute(unsigned long long, vme_address_t,
	vme_cycle_t, vme_width_t);
void vme_dma_free_attribute(struct vme_dma_attr *);
int vme_dma_list_add(struct vme_dma_list *, struct vme_dma_attr *,
	struct vme_dma_attr *, size_t);
int vme_dma_list_exec(struct vme_dma_list *);
int vme_dma_list_free(struct vme_dma_list *);
int vme_dma_free(struct vme_resource *);

int vme_request_irq(struct device *, int, int,
	void (*callback)(int, int, void *), void *);
void vme_free_irq(struct device *, int, int);
int vme_generate_irq(struct device *, int, int);

int vme_lm_set(struct device *, unsigned long long, vme_address_t, vme_cycle_t);
int vme_lm_get(struct device *, unsigned long long *, vme_address_t *,
	vme_cycle_t *);
int vme_lm_attach(struct device *, int, void (*callback)(int));
int vme_lm_detach(struct device *, int);

int vme_slot_get(struct device *);

int vme_register_driver (struct vme_driver *);
void vme_unregister_driver (struct vme_driver *);


#endif /* _VME_H_ */
Commit	Line	Data
a17a75e2 MW	1	#ifndef _VME_H_
	2	#define _VME_H_
	3
	4	/* Resource Type */
	5	enum vme_resource_type {
	6	VME_MASTER,
	7	VME_SLAVE,
	8	VME_DMA
	9	};
	10
	11	/* VME Address Spaces */
	12	typedef u32 vme_address_t;
	13	#define VME_A16 0x1
	14	#define VME_A24 0x2
	15	#define VME_A32 0x4
	16	#define VME_A64 0x8
	17	#define VME_CRCSR 0x10
	18	#define VME_USER1 0x20
	19	#define VME_USER2 0x40
	20	#define VME_USER3 0x80
	21	#define VME_USER4 0x100
	22
	23	#define VME_A16_MAX 0x10000ULL
	24	#define VME_A24_MAX 0x1000000ULL
	25	#define VME_A32_MAX 0x100000000ULL
	26	#define VME_A64_MAX 0x10000000000000000ULL
	27	#define VME_CRCSR_MAX 0x1000000ULL
	28
	29
	30	/* VME Cycle Types */
	31	typedef u32 vme_cycle_t;
	32	#define VME_SCT 0x1
	33	#define VME_BLT 0x2
	34	#define VME_MBLT 0x4
	35	#define VME_2eVME 0x8
	36	#define VME_2eSST 0x10
	37	#define VME_2eSSTB 0x20
	38
	39	#define VME_2eSST160 0x100
	40	#define VME_2eSST267 0x200
	41	#define VME_2eSST320 0x400
	42
	43	#define VME_SUPER 0x1000
	44	#define VME_USER 0x2000
	45	#define VME_PROG 0x4000
	46	#define VME_DATA 0x8000
	47
	48	/* VME Data Widths */
	49	typedef u32 vme_width_t;
	50	#define VME_D8 0x1
	51	#define VME_D16 0x2
	52	#define VME_D32 0x4
	53	#define VME_D64 0x8
	54
	55	/* Arbitration Scheduling Modes */
	56	typedef u32 vme_arbitration_t;
	57	#define VME_R_ROBIN_MODE 0x1
	58	#define VME_PRIORITY_MODE 0x2
	59
	60	typedef u32 vme_dma_t;
	61	#define VME_DMA_PATTERN (1<<0)
	62	#define VME_DMA_PCI (1<<1)
	63	#define VME_DMA_VME (1<<2)
	64
65	typedef u32 vme_pattern_t;
66	#define VME_DMA_PATTERN_BYTE (1<<0)
67	#define VME_DMA_PATTERN_WORD (1<<1)
68	#define VME_DMA_PATTERN_INCREMENT (1<<2)
69
70	struct vme_dma_attr {
71	vme_dma_t type;
72	void *private;
73	};
74
75	struct vme_resource {
76	enum vme_resource_type type;
77	struct list_head *entry;
78	};
79
80	extern struct bus_type vme_bus_type;
81
82	struct vme_device_id {
83	int bus;
84	int slot;
85	};
86
87	struct vme_driver {
88	struct list_head node;
89	char *name;
90	const struct vme_device_id *bind_table;
91	int (probe) (struct device , int, int);
92	int (remove) (struct device , int, int);
93	void (*shutdown) (void);
94	struct device_driver driver;
95	};
96
97	void * vme_alloc_consistent(struct vme_resource , size_t, dma_addr_t );
98	void vme_free_consistent(struct vme_resource , size_t, void ,
99	dma_addr_t);
100
101	size_t vme_get_size(struct vme_resource *);
102
103	struct vme_resource * vme_slave_request(struct device *, vme_address_t, vme_cycle_t);
104	int vme_slave_set (struct vme_resource *, int, unsigned long long,
105	unsigned long long, dma_addr_t, vme_address_t, vme_cycle_t);
106	int vme_slave_get (struct vme_resource , int , unsigned long long *,
107	unsigned long long , dma_addr_t , vme_address_t , vme_cycle_t );
108	void vme_slave_free(struct vme_resource *);
109
110	struct vme_resource * vme_master_request(struct device *, vme_address_t, vme_cycle_t,
111	vme_width_t);
112	int vme_master_set (struct vme_resource *, int, unsigned long long,
113	unsigned long long, vme_address_t, vme_cycle_t, vme_width_t);
114	int vme_master_get (struct vme_resource , int , unsigned long long *,
115	unsigned long long , vme_address_t , vme_cycle_t , vme_width_t );
116	ssize_t vme_master_read(struct vme_resource , void , size_t, loff_t);
117	ssize_t vme_master_write(struct vme_resource , void , size_t, loff_t);
118	unsigned int vme_master_rmw (struct vme_resource *, unsigned int, unsigned int,
119	unsigned int, loff_t);
120	void vme_master_free(struct vme_resource *);
121
122	struct vme_resource vme_request_dma(struct device );
123	struct vme_dma_list vme_new_dma_list(struct vme_resource );
124	struct vme_dma_attr *vme_dma_pattern_attribute(u32, vme_pattern_t);
125	struct vme_dma_attr *vme_dma_pci_attribute(dma_addr_t);
126	struct vme_dma_attr *vme_dma_vme_attribute(unsigned long long, vme_address_t,
127	vme_cycle_t, vme_width_t);
128	void vme_dma_free_attribute(struct vme_dma_attr *);
129	int vme_dma_list_add(struct vme_dma_list , struct vme_dma_attr ,
130	struct vme_dma_attr *, size_t);
131	int vme_dma_list_exec(struct vme_dma_list *);
132	int vme_dma_list_free(struct vme_dma_list *);
133	int vme_dma_free(struct vme_resource *);
134
135	int vme_request_irq(struct device *, int, int,
136	void (callback)(int, int, void ), void *);
137	void vme_free_irq(struct device *, int, int);
138	int vme_generate_irq(struct device *, int, int);
139
140	int vme_lm_set(struct device *, unsigned long long, vme_address_t, vme_cycle_t);
141	int vme_lm_get(struct device , unsigned long long , vme_address_t *,
142	vme_cycle_t *);
143	int vme_lm_attach(struct device , int, void (callback)(int));
144	int vme_lm_detach(struct device *, int);
145
146	int vme_slot_get(struct device *);
147
148	int vme_register_driver (struct vme_driver *);
149	void vme_unregister_driver (struct vme_driver *);
150
151
152	#endif /* _VME_H_ */
153