add another ioctl-stub
[usb-driver] / usb-driver.h
1 #define VERSION 0x910
2 #define LICENSE 0x952
3 #define TRANSFER 0x98c
4 #define MULTI_TRANSFER 0x98d
5 #define USB_TRANSFER 0x983
6 #define EVENT_UNREGISTER 0x987
7 #define INT_DISABLE 0x91f
8 #define INT_WAIT 0x94b
9 #define CARD_REGISTER 0x9a4
10 #define EVENT_REGISTER 0x9a5
11 #define CARD_UNREGISTER 0x92b
12 #define USB_GET_DEVICE_DATA 0x9a7
13 #define INT_ENABLE 0x98e
14 #define EVENT_PULL 0x988
15 #define USB_SET_INTERFACE 0x981
16 #define CARD_REGISTER_OLD 0x97d
17 #define INT_ENABLE_OLD 0x91e
18 #define USB_GET_DEVICE_DATA_OLD 0x980
19 #define EVENT_REGISTER_OLD 0x986
20 #define TRANSFER_OLD 0x903
21
22 #define MAGIC 0xa410b413UL
23
24 #define WDU_GET_MAX_PACKET_SIZE(x) ((unsigned short) (((x) & 0x7ff) * (1 + (((x) & 0x1800) >> 11))))
25
26 /* http://www.jungo.com/support/documentation/windriver/811/wdusb_man_mhtml/node78.html#SECTION001734000000000000000 */
27
28 struct header_struct {
29 unsigned long magic;
30 void* data;
31 unsigned long size;
32 };
33
34 struct version_struct {
35 unsigned long versionul;
36 char version[128];
37 };
38
39 struct license_struct {
40 char cLicense[128]; // Buffer with license string to put.
41 // If empty string then get current license setting
42 // into dwLicense.
43 unsigned long dwLicense; // Returns license settings: LICENSE_DEMO, LICENSE_WD
44 // etc..., or 0 for invalid license.
45 unsigned long dwLicense2; // Returns additional license settings, if dwLicense
46 // could not hold all the information.
47 // Then dwLicense will return 0.
48 };
49
50 typedef struct
51 {
52 unsigned long dwVendorId;
53 unsigned long dwDeviceId;
54 } WD_PCI_ID;
55
56 typedef struct
57 {
58 unsigned long dwBus;
59 unsigned long dwSlot;
60 unsigned long dwFunction;
61 } WD_PCI_SLOT;
62
63 typedef struct
64 {
65 unsigned long dwVendorId;
66 unsigned long dwProductId;
67 } WD_USB_ID;
68
69 typedef struct
70 {
71 unsigned short VendorId;
72 unsigned short ProductId;
73 unsigned char bDeviceClass;
74 unsigned char bDeviceSubClass;
75 unsigned char bInterfaceClass;
76 unsigned char bInterfaceSubClass;
77 unsigned char bInterfaceProtocol;
78 } WDU_MATCH_TABLE;
79
80 typedef struct
81 {
82 unsigned long dwNumber; // Pipe 0 is the default pipe
83 unsigned long dwMaximumPacketSize;
84 unsigned long type; // USB_PIPE_TYPE
85 unsigned long direction; // WDU_DIR
86 // Isochronous, Bulk, Interrupt are either USB_DIR_IN or USB_DIR_OUT
87 // Control are USB_DIR_IN_OUT
88 unsigned long dwInterval; // interval in ms relevant to Interrupt pipes
89 } WD_USB_PIPE_INFO, WD_USB_PIPE_INFO_V43, WDU_PIPE_INFO;
90
91 #define WD_USB_MAX_PIPE_NUMBER 32
92
93 typedef struct
94 {
95 unsigned long dwPipes;
96 WD_USB_PIPE_INFO Pipe[WD_USB_MAX_PIPE_NUMBER];
97 } WD_USB_DEVICE_INFO, WD_USB_DEVICE_INFO_V43;
98
99 struct usb_transfer
100 {
101 unsigned long dwUniqueID;
102 unsigned long dwPipeNum; // Pipe number on device.
103 unsigned long fRead; // TRUE for read (IN) transfers; FALSE for write (OUT) transfers.
104 unsigned long dwOptions; // USB_TRANSFER options:
105 // USB_ISOCH_FULL_PACKETS_ONLY - For isochronous
106 // transfers only. If set, only full packets will be
107 // transmitted and the transfer function will return
108 // when the amount of bytes left to transfer is less
109 // than the maximum packet size for the pipe (the
110 // function will return without transmitting the
111 // remaining bytes).
112 void* pBuffer; // Pointer to buffer to read/write.
113 unsigned long dwBufferSize; // Amount of bytes to transfer.
114 unsigned long dwBytesTransferred; // Returns the number of bytes actually read/written
115 unsigned char SetupPacket[8]; // Setup packet for control pipe transfer.
116 unsigned long dwTimeout; // Timeout for the transfer in milliseconds. Set to 0 for infinite wait.
117 };
118
119
120
121
122 struct event {
123 unsigned long handle;
124 unsigned long dwAction; // WD_EVENT_ACTION
125 unsigned long dwStatus; // EVENT_STATUS
126 unsigned long dwEventId;
127 unsigned long dwCardType; //WD_BUS_PCI, WD_BUS_USB, WD_BUS_PCMCIA
128 unsigned long hKernelPlugIn;
129 unsigned long dwOptions; // WD_EVENT_OPTION
130 union
131 {
132 struct
133 {
134 WD_PCI_ID cardId;
135 WD_PCI_SLOT pciSlot;
136 } Pci;
137 struct
138 {
139 WD_USB_ID deviceId;
140 unsigned long dwUniqueID;
141 } Usb;
142 } u;
143 unsigned long dwEventVer;
144 unsigned long dwNumMatchTables;
145 WDU_MATCH_TABLE matchTables[1];
146 };
147
148 typedef struct
149 {
150 unsigned long dwBusType; // Bus Type: ISA, EISA, PCI, PCMCIA.
151 unsigned long dwBusNum; // Bus number.
152 unsigned long dwSlotFunc; // Slot number on Bus.
153 } WD_BUS, WD_BUS_V30;
154
155 typedef struct
156 {
157 unsigned long item; // ITEM_TYPE
158 unsigned long fNotSharable;
159 unsigned long dwReserved; // Reserved for internal use
160 unsigned long dwOptions; // WD_ITEM_OPTIONS
161 union
162 {
163 struct
164 { // ITEM_MEMORY
165 unsigned long dwPhysicalAddr; // Physical address on card.
166 unsigned long dwBytes; // Address range.
167 void* dwTransAddr; // Returns the address to pass on to transfer commands.
168 void* dwUserDirectAddr; // Returns the address for direct user read/write.
169 unsigned long dwCpuPhysicalAddr; // Returns the CPU physical address
170 unsigned long dwBar; // Base Address Register number of PCI card.
171 } Mem;
172 struct
173 { // ITEM_IO
174 void* dwAddr; // Beginning of io address.
175 unsigned long dwBytes; // IO range.
176 unsigned long dwBar; // Base Address Register number of PCI card.
177 } IO;
178 struct
179 { // ITEM_INTERRUPT
180 unsigned long dwInterrupt; // Number of interrupt to install.
181 unsigned long dwOptions; // Interrupt options. For level sensitive
182 // interrupts - set to: INTERRUPT_LEVEL_SENSITIVE.
183 unsigned long hInterrupt; // Returns the handle of the interrupt installed.
184 } Int;
185 WD_BUS Bus; // ITEM_BUS
186 struct
187 {
188 unsigned long dw1, dw2, dw3, dw4; // Reserved for internal use
189 void* dw5; // Reserved for internal use
190 } Val;
191 } I;
192 } WD_ITEMS, WD_ITEMS_V30;
193
194 #define WD_CARD_ITEMS 20
195
196 typedef struct
197 {
198 unsigned long dwItems;
199 WD_ITEMS Item[WD_CARD_ITEMS];
200 } WD_CARD, WD_CARD_V30;
201
202 enum { CARD_VX_NO_MMU_INIT = 0x4000000 };
203
204 struct card_register
205 {
206 WD_CARD Card; // Card to register.
207 unsigned long fCheckLockOnly; // Only check if card is lockable, return hCard=1 if OK.
208 unsigned long hCard; // Handle of card.
209 unsigned long dwOptions; // Should be zero.
210 char cName[32]; // Name of card.
211 char cDescription[100]; // Description.
212 };
213
214 typedef struct
215 {
216 void* dwPort; // IO port for transfer or kernel memory address.
217 unsigned long cmdTrans; // Transfer command WD_TRANSFER_CMD.
218
219 // Parameters used for string transfers:
220 unsigned long dwBytes; // For string transfer.
221 unsigned long fAutoinc; // Transfer from one port/address
222 // or use incremental range of addresses.
223 unsigned long dwOptions; // Must be 0.
224 union
225 {
226 unsigned char Byte; // Use for 8 bit transfer.
227 unsigned short Word; // Use for 16 bit transfer.
228 uint32_t Dword; // Use for 32 bit transfer.
229 uint64_t Qword; // Use for 64 bit transfer.
230 void* pBuffer; // Use for string transfer.
231 } Data;
232 } WD_TRANSFER, WD_TRANSFER_V61;
233
234 typedef struct
235 {
236 unsigned long hKernelPlugIn;
237 unsigned long dwMessage;
238 void* pData;
239 unsigned long dwResult;
240 } WD_KERNEL_PLUGIN_CALL, WD_KERNEL_PLUGIN_CALL_V40;
241
242
243 struct interrupt
244 {
245 unsigned long hInterrupt; // Handle of interrupt.
246 unsigned long dwOptions; // Interrupt options: can be INTERRUPT_CMD_COPY
247
248 WD_TRANSFER *Cmd; // Commands to do on interrupt.
249 unsigned long dwCmds; // Number of commands.
250
251 // For WD_IntEnable():
252 WD_KERNEL_PLUGIN_CALL kpCall; // Kernel PlugIn call.
253 unsigned long fEnableOk; // TRUE if interrupt was enabled (WD_IntEnable() succeed).
254
255 // For WD_IntWait() and WD_IntCount():
256 unsigned long dwCounter; // Number of interrupts received.
257 unsigned long dwLost; // Number of interrupts not yet dealt with.
258 unsigned long fStopped; // Was interrupt disabled during wait.
259 };
260
261 struct usb_set_interface
262 {
263 unsigned long dwUniqueID;
264 unsigned long dwInterfaceNum;
265 unsigned long dwAlternateSetting;
266 unsigned long dwOptions;
267 };
268
269 struct usb_get_device_data
270 {
271 unsigned long dwUniqueID;
272 void* pBuf;
273 unsigned long dwBytes;
274 unsigned long dwOptions;
275 };
276
277 #define WD_USB_MAX_INTERFACES 30
278
279 typedef struct
280 {
281 unsigned char bLength;
282 unsigned char bDescriptorType;
283 unsigned char bInterfaceNumber;
284 unsigned char bAlternateSetting;
285 unsigned char bNumEndpoints;
286 unsigned char bInterfaceClass;
287 unsigned char bInterfaceSubClass;
288 unsigned char bInterfaceProtocol;
289 unsigned char iInterface;
290 } WDU_INTERFACE_DESCRIPTOR;
291
292 typedef struct
293 {
294 unsigned char bLength;
295 unsigned char bDescriptorType;
296 unsigned char bEndpointAddress;
297 unsigned char bmAttributes;
298 unsigned short wMaxPacketSize;
299 unsigned char bInterval;
300 } WDU_ENDPOINT_DESCRIPTOR;
301
302 typedef struct
303 {
304 unsigned char bLength;
305 unsigned char bDescriptorType;
306 unsigned short wTotalLength;
307 unsigned char bNumInterfaces;
308 unsigned char bConfigurationValue;
309 unsigned char iConfiguration;
310 unsigned char bmAttributes;
311 unsigned char MaxPower;
312 } WDU_CONFIGURATION_DESCRIPTOR;
313
314 typedef struct
315 {
316 unsigned char bLength;
317 unsigned char bDescriptorType;
318 unsigned short bcdUSB;
319 unsigned char bDeviceClass;
320 unsigned char bDeviceSubClass;
321 unsigned char bDeviceProtocol;
322 unsigned char bMaxPacketSize0;
323
324 unsigned short idVendor;
325 unsigned short idProduct;
326 unsigned short bcdDevice;
327 unsigned char iManufacturer;
328 unsigned char iProduct;
329 unsigned char iSerialNumber;
330 unsigned char bNumConfigurations;
331 } WDU_DEVICE_DESCRIPTOR;
332
333 typedef struct
334 {
335 WDU_INTERFACE_DESCRIPTOR Descriptor;
336 WDU_ENDPOINT_DESCRIPTOR *pEndpointDescriptors;
337 WDU_PIPE_INFO *pPipes;
338 } WDU_ALTERNATE_SETTING;
339
340 typedef struct
341 {
342 WDU_ALTERNATE_SETTING *pAlternateSettings;
343 unsigned long dwNumAltSettings;
344 WDU_ALTERNATE_SETTING *pActiveAltSetting;
345 } WDU_INTERFACE;
346
347 typedef struct
348 {
349 WDU_CONFIGURATION_DESCRIPTOR Descriptor;
350 unsigned long dwNumInterfaces;
351 WDU_INTERFACE *pInterfaces;
352 } WDU_CONFIGURATION;
353
354 struct usb_device_info {
355 WDU_DEVICE_DESCRIPTOR Descriptor;
356 WDU_PIPE_INFO Pipe0;
357 WDU_CONFIGURATION *pConfigs;
358 WDU_CONFIGURATION *pActiveConfig;
359 WDU_INTERFACE *pActiveInterface[WD_USB_MAX_INTERFACES];
360 };
361
362 typedef enum {
363 WDU_DIR_IN = 1,
364 WDU_DIR_OUT = 2,
365 WDU_DIR_IN_OUT = 3
366 } WDU_DIR;
367
368 typedef enum {
369 PIPE_TYPE_CONTROL = 0,
370 PIPE_TYPE_ISOCHRONOUS = 1,
371 PIPE_TYPE_BULK = 2,
372 PIPE_TYPE_INTERRUPT = 3
373 } USB_PIPE_TYPE;
Impressum, Datenschutz