Staging: netwave: add TODO file
[linux-2.6.git] / 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 struct vme_dma_attr {
72         vme_dma_t type;
73         void *private;
74 };
75
76 struct vme_resource {
77         enum vme_resource_type type;
78         struct list_head *entry;
79 };
80
81 extern struct bus_type vme_bus_type;
82
83 #define VME_SLOT_CURRENT        -1
84 #define VME_SLOT_ALL            -2
85
86 struct vme_device_id {
87         int bus;
88         int slot;
89 };
90
91 struct vme_driver {
92         struct list_head node;
93         char *name;
94         const struct vme_device_id *bind_table;
95         int (*probe)  (struct device *, int, int);
96         int (*remove) (struct device *, int, int);
97         void (*shutdown) (void);
98         struct device_driver    driver;
99 };
100
101 void * vme_alloc_consistent(struct vme_resource *, size_t, dma_addr_t *);
102 void vme_free_consistent(struct vme_resource *, size_t,  void *,
103         dma_addr_t);
104
105 size_t vme_get_size(struct vme_resource *);
106
107 struct vme_resource * vme_slave_request(struct device *, vme_address_t, vme_cycle_t);
108 int vme_slave_set (struct vme_resource *, int, unsigned long long,
109         unsigned long long, dma_addr_t, vme_address_t, vme_cycle_t);
110 int vme_slave_get (struct vme_resource *, int *, unsigned long long *,
111         unsigned long long *, dma_addr_t *, vme_address_t *, vme_cycle_t *);
112 void vme_slave_free(struct vme_resource *);
113
114 struct vme_resource * vme_master_request(struct device *, vme_address_t, vme_cycle_t,
115         vme_width_t);
116 int vme_master_set (struct vme_resource *, int, unsigned long long,
117         unsigned long long, vme_address_t, vme_cycle_t, vme_width_t);
118 int vme_master_get (struct vme_resource *, int *, unsigned long long *,
119         unsigned long long *, vme_address_t *, vme_cycle_t *, vme_width_t *);
120 ssize_t vme_master_read(struct vme_resource *, void *, size_t, loff_t);
121 ssize_t vme_master_write(struct vme_resource *, void *, size_t, loff_t);
122 unsigned int vme_master_rmw (struct vme_resource *, unsigned int, unsigned int,
123         unsigned int, loff_t);
124 void vme_master_free(struct vme_resource *);
125
126 struct vme_resource *vme_request_dma(struct device *);
127 struct vme_dma_list *vme_new_dma_list(struct vme_resource *);
128 struct vme_dma_attr *vme_dma_pattern_attribute(u32, vme_pattern_t);
129 struct vme_dma_attr *vme_dma_pci_attribute(dma_addr_t);
130 struct vme_dma_attr *vme_dma_vme_attribute(unsigned long long, vme_address_t,
131         vme_cycle_t, vme_width_t);
132 void vme_dma_free_attribute(struct vme_dma_attr *);
133 int vme_dma_list_add(struct vme_dma_list *, struct vme_dma_attr *,
134         struct vme_dma_attr *, size_t);
135 int vme_dma_list_exec(struct vme_dma_list *);
136 int vme_dma_list_free(struct vme_dma_list *);
137 int vme_dma_free(struct vme_resource *);
138
139 int vme_request_irq(struct device *, int, int,
140         void (*callback)(int, int, void *), void *);
141 void vme_free_irq(struct device *, int, int);
142 int vme_generate_irq(struct device *, int, int);
143
144 struct vme_resource * vme_lm_request(struct device *);
145 int vme_lm_count(struct vme_resource *);
146 int vme_lm_set(struct vme_resource *, unsigned long long, vme_address_t,
147         vme_cycle_t);
148 int vme_lm_get(struct vme_resource *, unsigned long long *, vme_address_t *,
149         vme_cycle_t *);
150 int vme_lm_attach(struct vme_resource *, int, void (*callback)(int));
151 int vme_lm_detach(struct vme_resource *, int);
152 void vme_lm_free(struct vme_resource *);
153
154 int vme_slot_get(struct device *);
155
156 int vme_register_driver (struct vme_driver *);
157 void vme_unregister_driver (struct vme_driver *);
158
159
160 #endif /* _VME_H_ */
161