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