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

source code of linux/drivers/staging/vme_user/vme.h