[usb-driver] / usb-driver.h

#if __WORDSIZE == 32
#define VERSION			0x910
#define LICENSE			0x952
#define TRANSFER		0x98c
#define USB_TRANSFER		0x983
#define EVENT_UNREGISTER	0x987
#define INT_DISABLE		0x91f
#define INT_WAIT		0x94b
#define CARD_REGISTER		0x9a4
#define EVENT_REGISTER		0x9a5
#define CARD_UNREGISTER		0x92b
#define USB_GET_DEVICE_DATA	0x9a7
#define INT_ENABLE		0x98e
#define EVENT_PULL		0x988
#define USB_SET_INTERFACE	0x981
#define CARD_REGISTER_OLD	0x97d
#define INT_ENABLE_OLD		0x91e
#define USB_GET_DEVICE_DATA_OLD	0x980
#define EVENT_REGISTER_OLD	0x986
#define TRANSFER_OLD		0x903
#else
#define VERSION			0xc0000910
#define LICENSE			0xc0000952
#define TRANSFER		0xc000098c
#define USB_TRANSFER		0xc0000983
#define EVENT_UNREGISTER	0xc0000987
#define INT_DISABLE		0xc000091f
#define INT_WAIT		0xc000094b
#define CARD_REGISTER		0xc00009a4
#define EVENT_REGISTER		0xc00009a5
#define CARD_UNREGISTER		0xc000092b
#define USB_GET_DEVICE_DATA	0xc00009a7
#define INT_ENABLE		0xc000098e
#define EVENT_PULL		0xc0000988
#define USB_SET_INTERFACE	0xc0000981
#define CARD_REGISTER_OLD	0xc000097d
#define INT_ENABLE_OLD		0xc000091e
#define USB_GET_DEVICE_DATA_OLD	0xc0000980
#define EVENT_REGISTER_OLD	0xc0000986
#define TRANSFER_OLD		0xc0000903
#endif

#define MAGIC 0xa410b413UL

#define WDU_GET_MAX_PACKET_SIZE(x)                ((unsigned short) (((x) & 0x7ff) * (1 + (((x) & 0x1800) >> 11))))

/* http://www.jungo.com/support/documentation/windriver/811/wdusb_man_mhtml/node78.html#SECTION001734000000000000000 */

struct header_struct {
	unsigned long magic;
	void* data;
	unsigned long size;
};

struct version_struct {
	unsigned long versionul;
	char version[128];
};

struct license_struct {
	char cLicense[128]; // Buffer with license string to put.
	// If empty string then get current license setting
	// into dwLicense.
	unsigned long dwLicense;  // Returns license settings: LICENSE_DEMO, LICENSE_WD
	// etc..., or 0 for invalid license.
	unsigned long dwLicense2; // Returns additional license settings, if dwLicense
	// could not hold all the information.
	// Then dwLicense will return 0.
};

typedef struct
{
	unsigned long dwVendorId;
	unsigned long dwDeviceId;
} WD_PCI_ID;

typedef struct
{
	unsigned long dwBus;
	unsigned long dwSlot;
	unsigned long dwFunction;
} WD_PCI_SLOT;

typedef struct
{
	unsigned long dwVendorId;
	unsigned long dwProductId;
} WD_USB_ID;

typedef struct
{
	unsigned short VendorId;
	unsigned short ProductId;
	unsigned char bDeviceClass;
	unsigned char bDeviceSubClass;
	unsigned char bInterfaceClass;
	unsigned char bInterfaceSubClass;
	unsigned char bInterfaceProtocol;
} WDU_MATCH_TABLE;

typedef struct
{
	unsigned long dwNumber;        // Pipe 0 is the default pipe
	unsigned long dwMaximumPacketSize;
	unsigned long type;            // USB_PIPE_TYPE
	unsigned long direction;       // WDU_DIR
	// Isochronous, Bulk, Interrupt are either USB_DIR_IN or USB_DIR_OUT
	// Control are USB_DIR_IN_OUT
	unsigned long dwInterval;      // interval in ms relevant to Interrupt pipes
} WD_USB_PIPE_INFO, WD_USB_PIPE_INFO_V43, WDU_PIPE_INFO;

#define WD_USB_MAX_PIPE_NUMBER 32

typedef struct
{
	unsigned long dwPipes;
	WD_USB_PIPE_INFO Pipe[WD_USB_MAX_PIPE_NUMBER];
} WD_USB_DEVICE_INFO, WD_USB_DEVICE_INFO_V43;

struct usb_transfer
{
	unsigned long dwUniqueID;
	unsigned long dwPipeNum;    // Pipe number on device.
	unsigned long fRead;        // TRUE for read (IN) transfers; FALSE for write (OUT) transfers.
	unsigned long dwOptions;    // USB_TRANSFER options:
	// USB_ISOCH_FULL_PACKETS_ONLY - For isochronous
	// transfers only. If set, only full packets will be
	// transmitted and the transfer function will return
	// when the amount of bytes left to transfer is less
	// than the maximum packet size for the pipe (the
	// function will return without transmitting the
	// remaining bytes).
	void* pBuffer;    // Pointer to buffer to read/write.
	unsigned long dwBufferSize; // Amount of bytes to transfer.
	unsigned long dwBytesTransferred; // Returns the number of bytes actually read/written
	unsigned char SetupPacket[8];          // Setup packet for control pipe transfer.
	unsigned long dwTimeout;    // Timeout for the transfer in milliseconds. Set to 0 for infinite wait.
};


struct event {
	unsigned long handle;
	unsigned long dwAction; // WD_EVENT_ACTION
	unsigned long dwStatus; // EVENT_STATUS
	unsigned long dwEventId;
	unsigned long dwCardType; //WD_BUS_PCI, WD_BUS_USB, WD_BUS_PCMCIA
	unsigned long hKernelPlugIn;
	unsigned long dwOptions; // WD_EVENT_OPTION
	union
	{
		struct
		{
			WD_PCI_ID cardId;
			WD_PCI_SLOT pciSlot;
		} Pci;
		struct
		{
			WD_USB_ID deviceId;
			unsigned long dwUniqueID;
		} Usb;
	} u;
	unsigned long dwEventVer;
	unsigned long dwNumMatchTables;
	WDU_MATCH_TABLE matchTables[1];
};

typedef struct
{
	unsigned long dwBusType;        // Bus Type: ISA, EISA, PCI, PCMCIA.
	unsigned long dwBusNum;         // Bus number.
	unsigned long dwSlotFunc;       // Slot number on Bus.
} WD_BUS, WD_BUS_V30;

typedef struct
{
	unsigned long item; // ITEM_TYPE
	unsigned long fNotSharable;
	unsigned long dwReserved; // Reserved for internal use
	unsigned long dwOptions; // WD_ITEM_OPTIONS
	union
	{
		struct
		{ // ITEM_MEMORY
			unsigned long dwPhysicalAddr;     // Physical address on card.
			unsigned long dwBytes;            // Address range.
			void* dwTransAddr;         // Returns the address to pass on to transfer commands.
			void* dwUserDirectAddr;   // Returns the address for direct user read/write.
			unsigned long dwCpuPhysicalAddr;  // Returns the CPU physical address
			unsigned long dwBar;              // Base Address Register number of PCI card.
		} Mem;
		struct
		{ // ITEM_IO
			void* dwAddr;          // Beginning of io address.
			unsigned long dwBytes;        // IO range.
			unsigned long dwBar;          // Base Address Register number of PCI card.
		} IO;
		struct
		{ // ITEM_INTERRUPT
			unsigned long dwInterrupt; // Number of interrupt to install.
			unsigned long dwOptions;   // Interrupt options. For level sensitive
			// interrupts - set to: INTERRUPT_LEVEL_SENSITIVE.
			unsigned long hInterrupt;  // Returns the handle of the interrupt installed.
		} Int;
		WD_BUS Bus; // ITEM_BUS
		struct
		{
			unsigned long dw1, dw2, dw3, dw4; // Reserved for internal use
			void* dw5; // Reserved for internal use
		} Val;
	} I;
} WD_ITEMS, WD_ITEMS_V30;

#define WD_CARD_ITEMS	20

typedef struct
{
	unsigned long dwItems;
	WD_ITEMS Item[WD_CARD_ITEMS];
} WD_CARD, WD_CARD_V30;

enum { CARD_VX_NO_MMU_INIT = 0x4000000 };

struct card_register
{
	WD_CARD Card;           // Card to register.
	unsigned long fCheckLockOnly;   // Only check if card is lockable, return hCard=1 if OK.
	unsigned long hCard;            // Handle of card.
	unsigned long dwOptions;        // Should be zero.
	char cName[32];         // Name of card.
	char cDescription[100]; // Description.
};

typedef struct
{
	void* dwPort;       // IO port for transfer or kernel memory address.
	unsigned long cmdTrans;    // Transfer command WD_TRANSFER_CMD.

	// Parameters used for string transfers:
	unsigned long dwBytes;     // For string transfer.
	unsigned long fAutoinc;    // Transfer from one port/address
	// or use incremental range of addresses.
	unsigned long dwOptions;   // Must be 0.
	union
	{
		unsigned char Byte;     // Use for 8 bit transfer.
		unsigned short Word;     // Use for 16 bit transfer.
		uint32_t Dword;   // Use for 32 bit transfer.
		uint64_t Qword;  // Use for 64 bit transfer.
		void* pBuffer; // Use for string transfer.
	} Data;
} WD_TRANSFER, WD_TRANSFER_V61;

typedef struct
{
	unsigned long hKernelPlugIn;
	unsigned long dwMessage;
	void* pData;
	unsigned long dwResult;
} WD_KERNEL_PLUGIN_CALL, WD_KERNEL_PLUGIN_CALL_V40;


struct interrupt
{
	unsigned long hInterrupt;    // Handle of interrupt.
	unsigned long dwOptions;     // Interrupt options: can be INTERRUPT_CMD_COPY

	WD_TRANSFER *Cmd;    // Commands to do on interrupt.
	unsigned long dwCmds;        // Number of commands.

	// For WD_IntEnable():
	WD_KERNEL_PLUGIN_CALL kpCall; // Kernel PlugIn call.
	unsigned long fEnableOk;     // TRUE if interrupt was enabled (WD_IntEnable() succeed).

	// For WD_IntWait() and WD_IntCount():
	unsigned long dwCounter;     // Number of interrupts received.
	unsigned long dwLost;        // Number of interrupts not yet dealt with.
	unsigned long fStopped;      // Was interrupt disabled during wait.
};

struct usb_set_interface
{
	unsigned long dwUniqueID;
	unsigned long dwInterfaceNum;
	unsigned long dwAlternateSetting;
	unsigned long dwOptions;
};

struct usb_get_device_data
{
	unsigned long dwUniqueID;
	void* pBuf;
	unsigned long dwBytes;
	unsigned long dwOptions;
};

#define WD_USB_MAX_INTERFACES 30

typedef struct
{
	unsigned char bLength;
	unsigned char bDescriptorType;
	unsigned char bInterfaceNumber;
	unsigned char bAlternateSetting;
	unsigned char bNumEndpoints;
	unsigned char bInterfaceClass;
	unsigned char bInterfaceSubClass;
	unsigned char bInterfaceProtocol;
	unsigned char iInterface;
} WDU_INTERFACE_DESCRIPTOR;

typedef struct
{
	unsigned char bLength;
	unsigned char bDescriptorType;
	unsigned char bEndpointAddress;
	unsigned char bmAttributes;
	unsigned short wMaxPacketSize;
	unsigned char bInterval;
} WDU_ENDPOINT_DESCRIPTOR;

typedef struct
{
	unsigned char bLength;
	unsigned char bDescriptorType;
	unsigned short wTotalLength;
	unsigned char bNumInterfaces;
	unsigned char bConfigurationValue;
	unsigned char iConfiguration;
	unsigned char bmAttributes;
	unsigned char MaxPower;
} WDU_CONFIGURATION_DESCRIPTOR;

typedef struct
{
	unsigned char bLength;
	unsigned char bDescriptorType;
	unsigned short bcdUSB;
	unsigned char bDeviceClass;
	unsigned char bDeviceSubClass;
	unsigned char bDeviceProtocol;
	unsigned char bMaxPacketSize0;

	unsigned short idVendor;
	unsigned short idProduct;
	unsigned short bcdDevice;
	unsigned char iManufacturer;
	unsigned char iProduct;
	unsigned char iSerialNumber;
	unsigned char bNumConfigurations;
} WDU_DEVICE_DESCRIPTOR;

typedef struct
{
	WDU_INTERFACE_DESCRIPTOR Descriptor;
	WDU_ENDPOINT_DESCRIPTOR *pEndpointDescriptors;
	WDU_PIPE_INFO *pPipes;
} WDU_ALTERNATE_SETTING;

typedef struct
{
	WDU_ALTERNATE_SETTING *pAlternateSettings;
	unsigned long dwNumAltSettings;
	WDU_ALTERNATE_SETTING *pActiveAltSetting;
} WDU_INTERFACE;

typedef struct
{
	WDU_CONFIGURATION_DESCRIPTOR Descriptor;
	unsigned long dwNumInterfaces;
	WDU_INTERFACE *pInterfaces;
} WDU_CONFIGURATION;

struct usb_device_info {
	WDU_DEVICE_DESCRIPTOR Descriptor;
	WDU_PIPE_INFO Pipe0;
	WDU_CONFIGURATION *pConfigs;
	WDU_CONFIGURATION *pActiveConfig;
	WDU_INTERFACE *pActiveInterface[WD_USB_MAX_INTERFACES];
};

typedef enum {
	WDU_DIR_IN     = 1,
	WDU_DIR_OUT    = 2,
	WDU_DIR_IN_OUT = 3
} WDU_DIR;

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