drivers/staging/vme/vme.h

   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         VME_LM
  10 };
  11
  12 /* VME Address Spaces */
  13 typedef u32 vme_address_t;
  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 typedef u32 vme_cycle_t;
  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 typedef u32 vme_width_t;
  51 #define VME_D8          0x1
  52 #define VME_D16         0x2
  53 #define VME_D32         0x4
  54 #define VME_D64         0x8
  55
  56 /* Arbitration Scheduling Modes */
  57 typedef u32 vme_arbitration_t;
  58 #define VME_R_ROBIN_MODE        0x1
  59 #define VME_PRIORITY_MODE       0x2
  60
  61 typedef u32 vme_dma_t;
  62 #define VME_DMA_PATTERN                 (1<<0)
  63 #define VME_DMA_PCI                     (1<<1)
  64 #define VME_DMA_VME                     (1<<2)
  65
  66 typedef u32 vme_pattern_t;
  67 #define VME_DMA_PATTERN_BYTE            (1<<0)
  68 #define VME_DMA_PATTERN_WORD            (1<<1)
  69 #define VME_DMA_PATTERN_INCREMENT       (1<<2)
  70
  71 typedef u32 vme_dma_route_t;
  72 #define VME_DMA_VME_TO_MEM              (1<<0)
  73 #define VME_DMA_MEM_TO_VME              (1<<1)
  74 #define VME_DMA_VME_TO_VME              (1<<2)
  75 #define VME_DMA_MEM_TO_MEM              (1<<3)
  76 #define VME_DMA_PATTERN_TO_VME          (1<<4)
  77 #define VME_DMA_PATTERN_TO_MEM          (1<<5)
  78
  79 struct vme_dma_attr {
  80         vme_dma_t type;
  81         void *private;
  82 };
  83
  84 struct vme_resource {
  85         enum vme_resource_type type;
  86         struct list_head *entry;
  87 };
  88
  89 extern struct bus_type vme_bus_type;
  90
  91 /* VME_MAX_BRIDGES comes from the type of vme_bus_numbers */
  92 #define VME_MAX_BRIDGES         (sizeof(unsigned int)*8)
  93 #define VME_MAX_SLOTS           32
  94
  95 #define VME_SLOT_CURRENT        -1
  96 #define VME_SLOT_ALL            -2
  97
  98 /**
  99  * Structure representing a VME device
 100  * @id: The ID of the device (currently the bus and slot number)
 101  * @bridge: Pointer to the bridge device this device is on
 102  * @dev: Internal device structure
 103  * @drv_list: List of devices (per driver)
 104  * @bridge_list: List of devices (per bridge)
 105  */
 106 struct vme_dev {
 107         int num;
 108         struct vme_bridge *bridge;
 109         struct device dev;
 110         struct list_head drv_list;
 111         struct list_head bridge_list;
 112 };
 113
 114 struct vme_driver {
 115         struct list_head node;
 116         const char *name;
 117         int (*match)(struct vme_dev *);
 118         int (*probe)(struct vme_dev *);
 119         int (*remove)(struct vme_dev *);
 120         void (*shutdown)(void);
 121         struct device_driver driver;
 122         struct list_head devices;
 123 };
 124
 125 void *vme_alloc_consistent(struct vme_resource *, size_t, dma_addr_t *);
 126 void vme_free_consistent(struct vme_resource *, size_t,  void *,
 127         dma_addr_t);
 128
 129 size_t vme_get_size(struct vme_resource *);
 130
 131 struct vme_resource *vme_slave_request(struct vme_dev *, vme_address_t,
 132         vme_cycle_t);
 133 int vme_slave_set(struct vme_resource *, int, unsigned long long,
 134         unsigned long long, dma_addr_t, vme_address_t, vme_cycle_t);
 135 int vme_slave_get(struct vme_resource *, int *, unsigned long long *,
 136         unsigned long long *, dma_addr_t *, vme_address_t *, vme_cycle_t *);
 137 void vme_slave_free(struct vme_resource *);
 138
 139 struct vme_resource *vme_master_request(struct vme_dev *, vme_address_t,
 140         vme_cycle_t, vme_width_t);
 141 int vme_master_set(struct vme_resource *, int, unsigned long long,
 142         unsigned long long, vme_address_t, vme_cycle_t, vme_width_t);
 143 int vme_master_get(struct vme_resource *, int *, unsigned long long *,
 144         unsigned long long *, vme_address_t *, vme_cycle_t *, vme_width_t *);
 145 ssize_t vme_master_read(struct vme_resource *, void *, size_t, loff_t);
 146 ssize_t vme_master_write(struct vme_resource *, void *, size_t, loff_t);
 147 unsigned int vme_master_rmw(struct vme_resource *, unsigned int, unsigned int,
 148         unsigned int, loff_t);
 149 void vme_master_free(struct vme_resource *);
 150
 151 struct vme_resource *vme_dma_request(struct vme_dev *, vme_dma_route_t);
 152 struct vme_dma_list *vme_new_dma_list(struct vme_resource *);
 153 struct vme_dma_attr *vme_dma_pattern_attribute(u32, vme_pattern_t);
 154 struct vme_dma_attr *vme_dma_pci_attribute(dma_addr_t);
 155 struct vme_dma_attr *vme_dma_vme_attribute(unsigned long long, vme_address_t,
 156         vme_cycle_t, vme_width_t);
 157 void vme_dma_free_attribute(struct vme_dma_attr *);
 158 int vme_dma_list_add(struct vme_dma_list *, struct vme_dma_attr *,
 159         struct vme_dma_attr *, size_t);
 160 int vme_dma_list_exec(struct vme_dma_list *);
 161 int vme_dma_list_free(struct vme_dma_list *);
 162 int vme_dma_free(struct vme_resource *);
 163
 164 int vme_irq_request(struct vme_dev *, int, int,
 165         void (*callback)(int, int, void *), void *);
 166 void vme_irq_free(struct vme_dev *, int, int);
 167 int vme_irq_generate(struct vme_dev *, int, int);
 168
 169 struct vme_resource * vme_lm_request(struct vme_dev *);
 170 int vme_lm_count(struct vme_resource *);
 171 int vme_lm_set(struct vme_resource *, unsigned long long, vme_address_t,
 172         vme_cycle_t);
 173 int vme_lm_get(struct vme_resource *, unsigned long long *, vme_address_t *,
 174         vme_cycle_t *);
 175 int vme_lm_attach(struct vme_resource *, int, void (*callback)(int));
 176 int vme_lm_detach(struct vme_resource *, int);
 177 void vme_lm_free(struct vme_resource *);
 178
 179 int vme_slot_get(struct vme_dev *);
 180
 181 int vme_register_driver(struct vme_driver *, unsigned int);
 182 void vme_unregister_driver(struct vme_driver *);
 183
 184
 185 #endif /* _VME_H_ */
 186