staging/vme_user/vme.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 #ifndef _VME_H_
0003 #define _VME_H_
0004
0005 /* Resource Type */
0006 enum vme_resource_type {
0007     VME_MASTER,
0008     VME_SLAVE,
0009     VME_DMA,
0010     VME_LM
0011 };
0012
0013 /* VME Address Spaces */
0014 #define VME_A16     0x1
0015 #define VME_A24     0x2
0016 #define VME_A32     0x4
0017 #define VME_A64     0x8
0018 #define VME_CRCSR   0x10
0019 #define VME_USER1   0x20
0020 #define VME_USER2   0x40
0021 #define VME_USER3   0x80
0022 #define VME_USER4   0x100
0023
0024 #define VME_A16_MAX 0x10000ULL
0025 #define VME_A24_MAX 0x1000000ULL
0026 #define VME_A32_MAX 0x100000000ULL
0027 #define VME_A64_MAX 0x10000000000000000ULL
0028 #define VME_CRCSR_MAX   0x1000000ULL
0029
0030
0031 /* VME Cycle Types */
0032 #define VME_SCT     0x1
0033 #define VME_BLT     0x2
0034 #define VME_MBLT    0x4
0035 #define VME_2eVME   0x8
0036 #define VME_2eSST   0x10
0037 #define VME_2eSSTB  0x20
0038
0039 #define VME_2eSST160    0x100
0040 #define VME_2eSST267    0x200
0041 #define VME_2eSST320    0x400
0042
0043 #define VME_SUPER   0x1000
0044 #define VME_USER    0x2000
0045 #define VME_PROG    0x4000
0046 #define VME_DATA    0x8000
0047
0048 /* VME Data Widths */
0049 #define VME_D8      0x1
0050 #define VME_D16     0x2
0051 #define VME_D32     0x4
0052 #define VME_D64     0x8
0053
0054 /* Arbitration Scheduling Modes */
0055 #define VME_R_ROBIN_MODE    0x1
0056 #define VME_PRIORITY_MODE   0x2
0057
0058 #define VME_DMA_PATTERN         (1<<0)
0059 #define VME_DMA_PCI         (1<<1)
0060 #define VME_DMA_VME         (1<<2)
0061
0062 #define VME_DMA_PATTERN_BYTE        (1<<0)
0063 #define VME_DMA_PATTERN_WORD        (1<<1)
0064 #define VME_DMA_PATTERN_INCREMENT   (1<<2)
0065
0066 #define VME_DMA_VME_TO_MEM      (1<<0)
0067 #define VME_DMA_MEM_TO_VME      (1<<1)
0068 #define VME_DMA_VME_TO_VME      (1<<2)
0069 #define VME_DMA_MEM_TO_MEM      (1<<3)
0070 #define VME_DMA_PATTERN_TO_VME      (1<<4)
0071 #define VME_DMA_PATTERN_TO_MEM      (1<<5)
0072
0073 struct vme_dma_attr {
0074     u32 type;
0075     void *private;
0076 };
0077
0078 struct vme_resource {
0079     enum vme_resource_type type;
0080     struct list_head *entry;
0081 };
0082
0083 extern struct bus_type vme_bus_type;
0084
0085 /* Number of VME interrupt vectors */
0086 #define VME_NUM_STATUSID    256
0087
0088 /* VME_MAX_BRIDGES comes from the type of vme_bus_numbers */
0089 #define VME_MAX_BRIDGES     (sizeof(unsigned int)*8)
0090 #define VME_MAX_SLOTS       32
0091
0092 #define VME_SLOT_CURRENT    -1
0093 #define VME_SLOT_ALL        -2
0094
0095 /**
0096  * struct vme_dev - Structure representing a VME device
0097  * @num: The device number
0098  * @bridge: Pointer to the bridge device this device is on
0099  * @dev: Internal device structure
0100  * @drv_list: List of devices (per driver)
0101  * @bridge_list: List of devices (per bridge)
0102  */
0103 struct vme_dev {
0104     int num;
0105     struct vme_bridge *bridge;
0106     struct device dev;
0107     struct list_head drv_list;
0108     struct list_head bridge_list;
0109 };
0110
0111 /**
0112  * struct vme_driver - Structure representing a VME driver
0113  * @name: Driver name, should be unique among VME drivers and usually the same
0114  *        as the module name.
0115  * @match: Callback used to determine whether probe should be run.
0116  * @probe: Callback for device binding, called when new device is detected.
0117  * @remove: Callback, called on device removal.
0118  * @driver: Underlying generic device driver structure.
0119  * @devices: List of VME devices (struct vme_dev) associated with this driver.
0120  */
0121 struct vme_driver {
0122     const char *name;
0123     int (*match)(struct vme_dev *);
0124     int (*probe)(struct vme_dev *);
0125     void (*remove)(struct vme_dev *);
0126     struct device_driver driver;
0127     struct list_head devices;
0128 };
0129
0130 void *vme_alloc_consistent(struct vme_resource *, size_t, dma_addr_t *);
0131 void vme_free_consistent(struct vme_resource *, size_t,  void *,
0132     dma_addr_t);
0133
0134 size_t vme_get_size(struct vme_resource *);
0135 int vme_check_window(u32 aspace, unsigned long long vme_base,
0136              unsigned long long size);
0137
0138 struct vme_resource *vme_slave_request(struct vme_dev *, u32, u32);
0139 int vme_slave_set(struct vme_resource *, int, unsigned long long,
0140     unsigned long long, dma_addr_t, u32, u32);
0141 int vme_slave_get(struct vme_resource *, int *, unsigned long long *,
0142     unsigned long long *, dma_addr_t *, u32 *, u32 *);
0143 void vme_slave_free(struct vme_resource *);
0144
0145 struct vme_resource *vme_master_request(struct vme_dev *, u32, u32, u32);
0146 int vme_master_set(struct vme_resource *, int, unsigned long long,
0147     unsigned long long, u32, u32, u32);
0148 int vme_master_get(struct vme_resource *, int *, unsigned long long *,
0149     unsigned long long *, u32 *, u32 *, u32 *);
0150 ssize_t vme_master_read(struct vme_resource *, void *, size_t, loff_t);
0151 ssize_t vme_master_write(struct vme_resource *, void *, size_t, loff_t);
0152 unsigned int vme_master_rmw(struct vme_resource *, unsigned int, unsigned int,
0153     unsigned int, loff_t);
0154 int vme_master_mmap(struct vme_resource *resource, struct vm_area_struct *vma);
0155 void vme_master_free(struct vme_resource *);
0156
0157 struct vme_resource *vme_dma_request(struct vme_dev *, u32);
0158 struct vme_dma_list *vme_new_dma_list(struct vme_resource *);
0159 struct vme_dma_attr *vme_dma_pattern_attribute(u32, u32);
0160 struct vme_dma_attr *vme_dma_pci_attribute(dma_addr_t);
0161 struct vme_dma_attr *vme_dma_vme_attribute(unsigned long long, u32, u32, u32);
0162 void vme_dma_free_attribute(struct vme_dma_attr *);
0163 int vme_dma_list_add(struct vme_dma_list *, struct vme_dma_attr *,
0164     struct vme_dma_attr *, size_t);
0165 int vme_dma_list_exec(struct vme_dma_list *);
0166 int vme_dma_list_free(struct vme_dma_list *);
0167 int vme_dma_free(struct vme_resource *);
0168
0169 int vme_irq_request(struct vme_dev *, int, int,
0170     void (*callback)(int, int, void *), void *);
0171 void vme_irq_free(struct vme_dev *, int, int);
0172 int vme_irq_generate(struct vme_dev *, int, int);
0173
0174 struct vme_resource *vme_lm_request(struct vme_dev *);
0175 int vme_lm_count(struct vme_resource *);
0176 int vme_lm_set(struct vme_resource *, unsigned long long, u32, u32);
0177 int vme_lm_get(struct vme_resource *, unsigned long long *, u32 *, u32 *);
0178 int vme_lm_attach(struct vme_resource *, int, void (*callback)(void *), void *);
0179 int vme_lm_detach(struct vme_resource *, int);
0180 void vme_lm_free(struct vme_resource *);
0181
0182 int vme_slot_num(struct vme_dev *);
0183 int vme_bus_num(struct vme_dev *);
0184
0185 int vme_register_driver(struct vme_driver *, unsigned int);
0186 void vme_unregister_driver(struct vme_driver *);
0187
0188
0189 #endif /* _VME_H_ */
0190