1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef _VME_H_
3#define _VME_H_
4
5/* Resource Type */
6enum vme_resource_type {
7 VME_MASTER,
8 VME_SLAVE,
9 VME_DMA,
10 VME_LM
11};
12
13/* VME Address Spaces */
14#define VME_A16 0x1
15#define VME_A24 0x2
16#define VME_A32 0x4
17#define VME_A64 0x8
18#define VME_CRCSR 0x10
19#define VME_USER1 0x20
20#define VME_USER2 0x40
21#define VME_USER3 0x80
22#define VME_USER4 0x100
23
24#define VME_A16_MAX 0x10000ULL
25#define VME_A24_MAX 0x1000000ULL
26#define VME_A32_MAX 0x100000000ULL
27#define VME_A64_MAX 0x10000000000000000ULL
28#define VME_CRCSR_MAX 0x1000000ULL
29
30
31/* VME Cycle Types */
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#define VME_D8 0x1
50#define VME_D16 0x2
51#define VME_D32 0x4
52#define VME_D64 0x8
53
54/* Arbitration Scheduling Modes */
55#define VME_R_ROBIN_MODE 0x1
56#define VME_PRIORITY_MODE 0x2
57
58#define VME_DMA_PATTERN (1<<0)
59#define VME_DMA_PCI (1<<1)
60#define VME_DMA_VME (1<<2)
61
62#define VME_DMA_PATTERN_BYTE (1<<0)
63#define VME_DMA_PATTERN_WORD (1<<1)
64#define VME_DMA_PATTERN_INCREMENT (1<<2)
65
66#define VME_DMA_VME_TO_MEM (1<<0)
67#define VME_DMA_MEM_TO_VME (1<<1)
68#define VME_DMA_VME_TO_VME (1<<2)
69#define VME_DMA_MEM_TO_MEM (1<<3)
70#define VME_DMA_PATTERN_TO_VME (1<<4)
71#define VME_DMA_PATTERN_TO_MEM (1<<5)
72
73struct vme_dma_attr {
74 u32 type;
75 void *private;
76};
77
78struct vme_resource {
79 enum vme_resource_type type;
80 struct list_head *entry;
81};
82
83extern struct bus_type vme_bus_type;
84
85/* Number of VME interrupt vectors */
86#define VME_NUM_STATUSID 256
87
88/* VME_MAX_BRIDGES comes from the type of vme_bus_numbers */
89#define VME_MAX_BRIDGES (sizeof(unsigned int)*8)
90#define VME_MAX_SLOTS 32
91
92#define VME_SLOT_CURRENT -1
93#define VME_SLOT_ALL -2
94
95/**
96 * struct vme_dev - Structure representing a VME device
97 * @num: The device number
98 * @bridge: Pointer to the bridge device this device is on
99 * @dev: Internal device structure
100 * @drv_list: List of devices (per driver)
101 * @bridge_list: List of devices (per bridge)
102 */
103struct vme_dev {
104 int num;
105 struct vme_bridge *bridge;
106 struct device dev;
107 struct list_head drv_list;
108 struct list_head bridge_list;
109};
110
111/**
112 * struct vme_driver - Structure representing a VME driver
113 * @name: Driver name, should be unique among VME drivers and usually the same
114 * as the module name.
115 * @match: Callback used to determine whether probe should be run.
116 * @probe: Callback for device binding, called when new device is detected.
117 * @remove: Callback, called on device removal.
118 * @driver: Underlying generic device driver structure.
119 * @devices: List of VME devices (struct vme_dev) associated with this driver.
120 */
121struct vme_driver {
122 const char *name;
123 int (*match)(struct vme_dev *);
124 int (*probe)(struct vme_dev *);
125 int (*remove)(struct vme_dev *);
126 struct device_driver driver;
127 struct list_head devices;
128};
129
130void *vme_alloc_consistent(struct vme_resource *, size_t, dma_addr_t *);
131void vme_free_consistent(struct vme_resource *, size_t, void *,
132 dma_addr_t);
133
134size_t vme_get_size(struct vme_resource *);
135int vme_check_window(u32 aspace, unsigned long long vme_base,
136 unsigned long long size);
137
138struct vme_resource *vme_slave_request(struct vme_dev *, u32, u32);
139int vme_slave_set(struct vme_resource *, int, unsigned long long,
140 unsigned long long, dma_addr_t, u32, u32);
141int vme_slave_get(struct vme_resource *, int *, unsigned long long *,
142 unsigned long long *, dma_addr_t *, u32 *, u32 *);
143void vme_slave_free(struct vme_resource *);
144
145struct vme_resource *vme_master_request(struct vme_dev *, u32, u32, u32);
146int vme_master_set(struct vme_resource *, int, unsigned long long,
147 unsigned long long, u32, u32, u32);
148int vme_master_get(struct vme_resource *, int *, unsigned long long *,
149 unsigned long long *, u32 *, u32 *, u32 *);
150ssize_t vme_master_read(struct vme_resource *, void *, size_t, loff_t);
151ssize_t vme_master_write(struct vme_resource *, void *, size_t, loff_t);
152unsigned int vme_master_rmw(struct vme_resource *, unsigned int, unsigned int,
153 unsigned int, loff_t);
154int vme_master_mmap(struct vme_resource *resource, struct vm_area_struct *vma);
155void vme_master_free(struct vme_resource *);
156
157struct vme_resource *vme_dma_request(struct vme_dev *, u32);
158struct vme_dma_list *vme_new_dma_list(struct vme_resource *);
159struct vme_dma_attr *vme_dma_pattern_attribute(u32, u32);
160struct vme_dma_attr *vme_dma_pci_attribute(dma_addr_t);
161struct vme_dma_attr *vme_dma_vme_attribute(unsigned long long, u32, u32, u32);
162void vme_dma_free_attribute(struct vme_dma_attr *);
163int vme_dma_list_add(struct vme_dma_list *, struct vme_dma_attr *,
164 struct vme_dma_attr *, size_t);
165int vme_dma_list_exec(struct vme_dma_list *);
166int vme_dma_list_free(struct vme_dma_list *);
167int vme_dma_free(struct vme_resource *);
168
169int vme_irq_request(struct vme_dev *, int, int,
170 void (*callback)(int, int, void *), void *);
171void vme_irq_free(struct vme_dev *, int, int);
172int vme_irq_generate(struct vme_dev *, int, int);
173
174struct vme_resource *vme_lm_request(struct vme_dev *);
175int vme_lm_count(struct vme_resource *);
176int vme_lm_set(struct vme_resource *, unsigned long long, u32, u32);
177int vme_lm_get(struct vme_resource *, unsigned long long *, u32 *, u32 *);
178int vme_lm_attach(struct vme_resource *, int, void (*callback)(void *), void *);
179int vme_lm_detach(struct vme_resource *, int);
180void vme_lm_free(struct vme_resource *);
181
182int vme_slot_num(struct vme_dev *);
183int vme_bus_num(struct vme_dev *);
184
185int vme_register_driver(struct vme_driver *, unsigned int);
186void vme_unregister_driver(struct vme_driver *);
187
188
189#endif /* _VME_H_ */
190
191