Jungo WinDriver  
Official Documentation
windrvr.h
Go to the documentation of this file.
1/* @JUNGO_COPYRIGHT@ */
2
3/*
4 * W i n D r i v e r
5 * =================
6 *
7 * FOR DETAILS ON THE WinDriver FUNCTIONS, PLEASE SEE THE WinDriver MANUAL
8 * OR INCLUDED HELP FILES.
9 *
10 * This file may not be distributed, it may only be used for development
11 * or evaluation purposes. The only exception is distribution to Linux.
12 * For details refer to \WinDriver\docs\license.txt.
13 *
14 * Web site: https://www.jungo.com
15 * Email: [email protected]
16 */
17#ifndef _WINDRVR_H_
18#define _WINDRVR_H_
19
20#if defined(__cplusplus)
21 extern "C" {
22#endif
23
24#include "wd_ver.h"
25
26#if defined(WIN32) && !defined(__MINGW32__)
27 #define DLLCALLCONV __stdcall
28 #if !defined(_SAL_VERSION)
29 #include <sal.h>
30 #endif
31#else
32 #define DLLCALLCONV
33
34 /* the following macros are part of SAL annotations macros in Windows and
35 are used in prototype of API functions, therefore, must be defined in
36 Unix as well */
37 #define _In_
38 #define _Inout_
39 #define _Out_
40 #define _Outptr_
41#endif
42
43#if defined(WIN32)
44 #define WD_DRIVER_NAME_PREFIX "\\\\.\\"
45#elif defined(LINUX)
46 #define WD_DRIVER_NAME_PREFIX "/dev/"
47#else
48 #define WD_DRIVER_NAME_PREFIX ""
49#endif
50
51#if !defined(WIN32)
52 #define __FUNCTION__ __func__
53#endif
54
55#define WD_DEFAULT_DRIVER_NAME_BASE "windrvr" WD_VER_ITOA
56#define WD_DEFAULT_DRIVER_NAME \
57 WD_DRIVER_NAME_PREFIX WD_DEFAULT_DRIVER_NAME_BASE
58
59#define WD_MAX_DRIVER_NAME_LENGTH 128
60#define WD_MAX_KP_NAME_LENGTH 128
61#define WD_VERSION_STR_LENGTH 128
62
63#if defined(WD_DRIVER_NAME_CHANGE)
103 const char* DLLCALLCONV WD_DriverName(const char *sName);
105 #define WD_DRIVER_NAME WD_DriverName(NULL)
106#else
107 #define WD_DRIVER_NAME WD_DEFAULT_DRIVER_NAME
108#endif
109
110#if defined (LOCAL_DEMO)
111#define WD_PROD_NAME "WinDriver (Local Demo)"
112#else
113#define WD_PROD_NAME "WinDriver"
114#endif
115
116#if defined(x86_64)
117#define KERNEL_64BIT
118#elif defined(ARM64)
119#define KERNEL_64BIT
120#elif defined(ARM)
121#elif defined(x86)
122#else
123#error No platform is defined. Please define either x86, x86_64, ARM or ARM64.
124#endif
125#if (defined(x86_64) && defined (ARM64)) || \
126 (defined(x86_64) && defined (ARM)) || \
127 (defined(x86_64) && defined (x86)) || \
128 (defined(ARM64) && defined (x86)) || \
129 (defined(ARM64) && defined (ARM)) || \
130 (defined(x86) && defined(ARM))
131#error Cannot have more than one platform defined in a WinDriver compilation.
132#endif
133
134
135#if defined(x86_64)
136 #define WD_CPU_SPEC " x86_64"
137#elif defined(ARM)
138 #define WD_CPU_SPEC " ARM"
139#elif defined(ARM64)
140 #define WD_CPU_SPEC " ARM64"
141#else
142 #define WD_CPU_SPEC " X86"
143#endif
144
145#if defined(WINNT)
146 #define WD_FILE_FORMAT " sys"
147#elif defined (APPLE)
148 #define WD_FILE_FORMAT " kext"
149#elif defined (LINUX)
150 #define WD_FILE_FORMAT " ko"
151#endif
152
153#if defined(KERNEL_64BIT)
154 #define WD_DATA_MODEL " 64bit"
155#else
156 #define WD_DATA_MODEL " 32bit"
157#endif
158
159#if defined(__KERNEL__) && defined(WINNT)
160 #if (NTDDI_VERSION >= NTDDI_WIN10_VB)
161 #define WD_VER_STR_SUFFIX ""
162 #else
163 #define WD_VER_STR_SUFFIX " for Windows 10 (Build 18632 and Lower)"
164 #endif
165#else
166 #define WD_VER_STR_SUFFIX ""
167#endif
168
169#define WD_VER_STR WD_PROD_NAME " v" WD_VERSION_STR \
170 " Jungo Connectivity (c) 1997 - " COPYRIGHTS_YEAR_STR \
171 " Build Date: " __DATE__ \
172 WD_CPU_SPEC WD_DATA_MODEL WD_FILE_FORMAT WD_VER_STR_SUFFIX
173
174#if !defined(POSIX) && defined(LINUX)
175 #define POSIX
176#endif
177
178#if !defined(UNIX) && defined(POSIX)
179 #define UNIX
180#endif
181
182#if !defined(WIN32) && defined(WINNT)
183 #define WIN32
184#endif
185
186#if !defined(WIN32) && !defined(UNIX) && !defined(APPLE)
187 #define WIN32
188#endif
189
190#if defined(_KERNEL_MODE) && !defined(KERNEL)
191 #define KERNEL
192#endif
193
194#if defined(KERNEL) && !defined(__KERNEL__)
195 #define __KERNEL__
196#endif
197
198#if defined(_KERNEL) && !defined(__KERNEL__)
199 #define __KERNEL__
200#endif
201
202#if defined( __KERNEL__) && !defined(_KERNEL)
203 #define _KERNEL
204#endif
205
206#if defined(LINUX) && defined(__x86_64__) && !defined(__KERNEL__)
207 /* This fixes binary compatibility with older version of GLIBC
208 * (64bit only) */
209 __asm__(".symver memcpy,memcpy@GLIBC_2.2.5");
210#endif
211
212#if defined(UNIX)
213
214
215 #if !defined(__P_TYPES__)
216 #define __P_TYPES__
217 #include <wd_types.h>
218
219 typedef void VOID;
220 typedef unsigned char UCHAR;
221 typedef unsigned short USHORT;
222 typedef unsigned int UINT;
223 #if !defined (APPLE_USB)
224 typedef unsigned long ULONG;
225 #endif
226 typedef u32 BOOL;
227 typedef void *PVOID;
228 typedef unsigned char *PBYTE;
229 typedef char CHAR;
230 typedef char *PCHAR;
231 typedef unsigned short *PWORD;
232 typedef u32 DWORD, *PDWORD;
233 typedef PVOID HANDLE;
234 #endif
235 #if !defined(__KERNEL__)
236 #include <string.h>
237 #include <ctype.h>
238 #include <stdlib.h>
239 #endif
240 #ifndef TRUE
241 #define TRUE 1
242 #endif
243 #ifndef FALSE
244 #define FALSE 0
245 #endif
246 #define __cdecl
247 #define WINAPI
248
249 #if defined(__KERNEL__)
250 #if defined(LINUX)
251 /* For _IO macros and for mapping Linux status codes
252 * to WD status codes */
253 #include <asm-generic/ioctl.h>
254 #include <asm-generic/errno.h>
255 #endif
256 #else
257 #include <unistd.h>
258 #if defined(LINUX)
259 #include <sys/ioctl.h> /* for BSD ioctl() */
260 #include <sys/mman.h>
261 #endif
262 #include <sys/types.h>
263 #include <sys/stat.h>
264 #include <fcntl.h>
265 #endif
266 typedef unsigned long long UINT64;
267 #if defined(APPLE)
268 #include <libkern/OSTypes.h>
269 #include <libkern/OSAtomic.h>
270 typedef UInt16 UINT16;
271 typedef UInt8 UINT8;
272 typedef UInt8 u8;
273 typedef UInt16 u16;
274 typedef UInt32 u32;
275 #include <IOKit/IOTypes.h>
276 #if defined(__KERNEL__)
277 typedef struct OSObject* FILEHANDLE;
278 typedef UInt32 PRCHANDLE;
279 #else
280 #include <IOKit/IOKitLib.h>
281 #endif
282 enum {
283 kWinDriverMethodSyncIoctl = 0,
284 kWinDriverNumOfMethods,
285 };
286 #if !defined(__KERNEL__)
287 #include <string.h>
288 #include <ctype.h>
289 #endif
290 #ifndef TRUE
291 #define TRUE true
292 #endif
293 #ifndef FALSE
294 #define FALSE false
295 #endif
296 #define __cdecl
297 #define WINAPI
298 #ifdef __LP64__
299 #define PTR2INT(value) ((UInt64)(value))
300 #else
301 #define PTR2INT(value) ((UInt32)(value))
302 #endif
303 #define MAC_UC_MAGIC_MASK 0xFF0000FF
304 #define MAC_UC_MAGIC_NUM 0x7E000041
305 #define MAC_UC_64BIT_APP 0x100
306#endif
307
308#elif defined(WIN32)
309 #if defined(__KERNEL__)
310 #if !defined (CMAKE_WD_BUILD)
311 int sprintf(char *buffer, const char *format, ...);
312 #endif
313 #else
314 #include <windows.h>
315 #include <winioctl.h>
316 #endif
317 #define stricmp _stricmp
318 typedef unsigned __int64 UINT64;
319#endif
320
321#if !defined(__KERNEL__)
322 #include <stdarg.h>
323 #if !defined(va_copy) && !defined(__va_copy)
324 #define va_copy(ap2,ap1) (ap2)=(ap1)
325 #endif
326 #if !defined(va_copy) && defined(__va_copy)
327 #define va_copy __va_copy
328 #endif
329#endif
330
331#ifndef WINAPI
332 #define WINAPI
333#endif
334
335#if !defined(_WINDEF_)
336 typedef unsigned char BYTE;
337 typedef unsigned short int WORD;
338#endif
339
340#if !defined(_BASETSD_H_)
341 typedef unsigned int UINT32;
342#endif
343
344
346#if defined(UNIX)
347 #define PRI64 "ll"
348#elif defined(WIN32)
349 #define PRI64 "I64"
350#endif
351
353#if defined(KERNEL_64BIT)
354 #define KPRI PRI64
355 #if defined(WIN32)
356 #if defined(i386)
357 #define UPRI "z"
358 #else
359 #define UPRI KPRI
360 #endif
361 #else
362 #define UPRI "l"
363 #endif
364#else
365 #define KPRI ""
366 #define UPRI "l"
367#endif
368
369/*
370 * The KPTR is guaranteed to be the same size as a kernel-mode pointer
371 * The UPTR is guaranteed to be the same size as a user-mode pointer
372 */
373#if defined(KERNEL_64BIT)
374 typedef UINT64 KPTR;
375#else
376 typedef UINT32 KPTR;
377#endif
378
379#if defined(UNIX)
380 typedef unsigned long UPTR;
381#else
382 typedef size_t UPTR;
383#endif
384
387
388#include "windrvr_usb.h"
389
392typedef enum
393{
398 RP_BYTE = 10,
399 RP_WORD = 11,
400 RP_DWORD = 12,
401 WP_BYTE = 13,
402 WP_WORD = 14,
403 WP_DWORD = 15,
404 RP_QWORD = 16,
405 WP_QWORD = 17,
407 RP_SBYTE = 20,
408 RP_SWORD = 21,
410 WP_SBYTE = 23,
411 WP_SWORD = 24,
416 RM_BYTE = 30,
417 RM_WORD = 31,
418 RM_DWORD = 32,
419 WM_BYTE = 33,
420 WM_WORD = 34,
421 WM_DWORD = 35,
422 RM_QWORD = 36,
423 WM_QWORD = 37,
425 RM_SBYTE = 40,
426 RM_SWORD = 41,
428 WM_SBYTE = 43,
429 WM_SWORD = 44,
432 WM_SQWORD = 47
434
435enum { WD_DMA_PAGES = 256 };
436
437#ifndef DMA_BIT_MASK
438 #define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : ((1ULL<<(n))-1))
439#endif
440
441typedef enum {
445 DMA_KBUF_BELOW_16M = 0x2,
448 DMA_LARGE_BUFFER = 0x4,
456 DMA_KERNEL_ONLY_MAP = 0x10,
459 DMA_FROM_DEVICE = 0x20,
475
486 DMA_TRANSACTION = 0x2000,
489 DMA_GPUDIRECT = 0x4000,
501
502#define DMA_ADDRESS_WIDTH_MASK 0x7f000000
503
504#define DMA_OPTIONS_ALL \
505 (DMA_KERNEL_BUFFER_ALLOC | DMA_KBUF_BELOW_16M | DMA_LARGE_BUFFER \
506 | DMA_ALLOW_CACHE | DMA_KERNEL_ONLY_MAP | DMA_FROM_DEVICE | DMA_TO_DEVICE \
507 | DMA_ALLOW_64BIT_ADDRESS | DMA_ALLOW_NO_HCARD | DMA_GET_EXISTING_BUF \
508 | DMA_RESERVED_MEM | DMA_KBUF_ALLOC_SPECIFY_ADDRESS_WIDTH \
509 | DMA_ADDRESS_WIDTH_MASK)
510
511#define DMA_DIRECTION_MASK DMA_TO_FROM_DEVICE
512
514#define DMA_READ_FROM_DEVICE DMA_FROM_DEVICE
515#define DMA_WRITE_TO_DEVICE DMA_TO_DEVICE
516
517#define DMA_OPTIONS_ADDRESS_WIDTH_SHIFT 24
522enum {
523 WD_MATCH_EXCLUDE = 0x1
524};
525
526#ifndef PAD_TO_64
527/* Use it to pad struct size to 64 bit, when using 32 on 64 bit applications */
528#if defined (i386) && defined(KERNEL_64BIT)
529 #define PAD_TO_64(pName) DWORD dwPad_##pName;
530#else
531 #define PAD_TO_64(pName)
532#endif
533#endif
535typedef struct
536{
537 DMA_ADDR pPhysicalAddr;
538 DWORD dwBytes;
539 PAD_TO_64(dwBytes)
542typedef void (DLLCALLCONV * DMA_TRANSACTION_CALLBACK)(PVOID pData);
544typedef struct
545{
546 DWORD hDma;
547 PAD_TO_64(hDma)
548
549 PVOID pUserAddr;
550 PAD_TO_64(pUserAddr)
552 KPTR pKernelAddr;
553 DWORD dwBytes;
554 DWORD dwOptions;
557 DWORD dwPages;
558 DWORD hCard;
561 /* Windows: The following 6 parameters are used for DMA transaction only */
562
563 DMA_TRANSACTION_CALLBACK DMATransactionCallback;
564 PAD_TO_64(DMATransactionCallback)
565
566 PVOID DMATransactionCallbackCtx;
567 PAD_TO_64(DMATransactionCallbackCtx)
569 DWORD dwAlignment;
570 DWORD dwMaxTransferSize;
571 DWORD dwTransferElementSize;
572 DWORD dwBytesTransferred;
576
577typedef enum {
578 /* KER_BUF_ALLOC_NON_CONTIG and KER_BUF_GET_EXISTING_BUF options are valid
579 * only as part of "WinDriver for Server" API and require
580 * "WinDriver for Server" license.
581 * @note "WinDriver for Server" APIs are included in WinDriver evaluation
582 * version. */
584 KER_BUF_ALLOC_CONTIG = 0x0002,
585 KER_BUF_ALLOC_CACHED = 0x0004,
589typedef struct
591 DWORD hKerBuf;
592 DWORD dwOptions;
593 UINT64 qwBytes;
594 KPTR pKernelAddr;
595 UPTR pUserAddr;
596 PAD_TO_64(pUserAddr)
599typedef struct
600{
601 KPTR pPort;
602 DWORD cmdTrans;
603 PAD_TO_64(cmdTrans)
605 /* Parameters used for string transfers: */
606 UINT64 u64Bytes;
607 DWORD fAutoinc;
609 DWORD dwOptions;
610 union
612 BYTE Byte;
613 WORD Word;
614 UINT32 Dword;
615 UINT64 Qword;
616 PVOID pBuffer;
617 } Data;
619
620enum {
621 INTERRUPT_LATCHED = 0x00,
624 INTERRUPT_CMD_COPY = 0x02,
629 INTERRUPT_CE_INT_ID = 0x04,
631 INTERRUPT_MESSAGE = 0x10,
632 INTERRUPT_MESSAGE_X = 0x20,
636};
638typedef struct
640 DWORD hKernelPlugIn;
641 DWORD dwMessage;
642 PVOID pData;
644 DWORD dwResult;
645 PAD_TO_64(dwResult)
648typedef enum {
655typedef struct
656{
657 DWORD hInterrupt;
658 DWORD dwOptions;
660 WD_TRANSFER *Cmd;
661 PAD_TO_64(Cmd)
662 DWORD dwCmds;
663 PAD_TO_64(dwCmds)
665 /* For WD_IntEnable(): */
666 WD_KERNEL_PLUGIN_CALL kpCall;
667 DWORD fEnableOk;
670 /* For WD_IntWait() and WD_IntCount(): */
671 DWORD dwCounter;
672 DWORD dwLost;
673 DWORD fStopped;
674 DWORD dwLastMessage;
675 DWORD dwEnabledIntType;
685
686#define WD_ENABLED_INT_TYPE_MASK 0x3f
687#define WD_ENABLED_INT_TYPE_GET_ENABLED_INT_TYPE_BITS(dwEnabledIntType) \
688 (dwEnabledIntType & WD_ENABLED_INT_TYPE_MASK)
689#define WD_ENABLED_INT_TYPE_NUM_VECTORS_POSITION_BITS 20
691typedef struct
693 DWORD dwVer;
696
697#define WD_LICENSE_LENGTH 3072
698typedef struct
699{
700 CHAR cLicense[WD_LICENSE_LENGTH];
703enum
705 WD_BUS_USB = (int)0xfffffffe,
707 WD_BUS_ISA = 1,
709 WD_BUS_PCI = 5,
711typedef DWORD WD_BUS_TYPE;
713typedef struct
715 WD_BUS_TYPE dwBusType;
716 DWORD dwDomainNum;
717 DWORD dwBusNum;
718 DWORD dwSlotFunc;
721typedef enum
724 ITEM_INTERRUPT = 1,
726 ITEM_IO = 3,
728} ITEM_TYPE;
729
730typedef enum
731{
741typedef struct
743 DWORD item;
744 DWORD fNotSharable;
745 union I
746 {
748 struct Mem
750 PHYS_ADDR pPhysicalAddr;
751 UINT64 qwBytes;
752 KPTR pTransAddr;
756 UPTR pUserDirectAddr;
760 PAD_TO_64(pUserDirectAddr)
761 DWORD dwBar;
762 DWORD dwOptions;
764 KPTR pReserved;
766
768 struct IO
770 KPTR pAddr;
771 DWORD dwBytes;
772 DWORD dwBar;
773 } IO;
774
776 struct Int
777 {
778 DWORD dwInterrupt;
779 DWORD dwOptions;
784 DWORD hInterrupt;
786 DWORD dwReserved1;
787 KPTR pReserved2;
788 } Int;
789 WD_BUS Bus;
790 } I;
793enum { WD_CARD_ITEMS = 128 };
795typedef struct
797 DWORD dwItems;
798 PAD_TO_64(dwItems)
802typedef struct
803{
804 WD_CARD Card;
805 DWORD fCheckLockOnly;
807 DWORD hCard;
808 DWORD dwOptions;
809 CHAR cName[32];
810 CHAR cDescription[100];
812
813#define WD_PROCESS_NAME_LENGTH 128
814typedef struct
816 CHAR cProcessName[WD_PROCESS_NAME_LENGTH];
817 DWORD dwSubGroupID;
818 DWORD dwGroupID;
822 DWORD hIpc;
825typedef struct
827 WD_IPC_PROCESS procInfo;
828 DWORD dwOptions;
831enum { WD_IPC_MAX_PROCS = 0x40 };
833typedef struct
834{
835 DWORD hIpc;
838 DWORD dwNumProcs;
842enum
844 WD_IPC_UID_UNICAST = 0x1,
847};
849typedef struct
850{
851 DWORD hIpc;
852 DWORD dwOptions;
855 DWORD dwRecipientID;
856 DWORD dwMsgID;
857 UINT64 qwMsgData;
860typedef struct
862 DWORD hCard;
865 PAD_TO_64(Cmd)
866 DWORD dwCmds;
867 DWORD dwOptions;
870enum { WD_FORCE_CLEANUP = 0x1 };
872enum { WD_PCI_CARDS = 256 };
874typedef struct
876 DWORD dwDomain;
878 DWORD dwBus;
879 DWORD dwSlot;
880 DWORD dwFunction;
883typedef struct
884{
885 DWORD dwVendorId;
886 DWORD dwDeviceId;
887} WD_PCI_ID;
888
889typedef struct
890{
892 WD_PCI_ID searchId;
895 DWORD dwCards;
898 WD_PCI_ID cardId[WD_PCI_CARDS];
902 DWORD dwOptions;
905typedef enum {
912enum { WD_PCI_MAX_CAPS = 50 };
914enum { WD_PCI_CAP_ID_ALL = 0x0 };
916typedef struct
917{
918 DWORD dwCapId;
919 DWORD dwCapOffset;
921
922typedef enum {
927
928typedef struct
931 WD_PCI_SLOT pciSlot;
932 DWORD dwCapId;
934 DWORD dwOptions;
938 DWORD dwNumCaps;
939 WD_PCI_CAP pciCaps[WD_PCI_MAX_CAPS];
943typedef struct
945 WD_PCI_SLOT pciSlot;
946 DWORD dwNumVFs;
949typedef struct
951 WD_PCI_SLOT pciSlot;
952 WD_CARD Card;
955typedef enum
957 PCI_ACCESS_OK = 0,
959 PCI_BAD_BUS = 2,
963typedef struct
964{
965 WD_PCI_SLOT pciSlot;
966 PVOID pBuffer;
967 PAD_TO_64(pBuffer)
968
969 DWORD dwOffset;
970 DWORD dwBytes;
972 DWORD fIsRead;
973 DWORD dwResult;
975
976enum { SLEEP_BUSY = 0, SLEEP_NON_BUSY = 1 };
977typedef struct
979 DWORD dwMicroSeconds;
981 DWORD dwOptions;
984typedef enum
986 D_OFF = 0,
987 D_ERROR = 1,
989 D_INFO = 3,
993typedef enum
995 S_ALL = (int)0xffffffff,
996 S_IO = 0x00000008,
997 S_MEM = 0x00000010,
998 S_INT = 0x00000020,
999 S_PCI = 0x00000040,
1000 S_DMA = 0x00000080,
1001 S_MISC = 0x00000100,
1002 S_LICENSE = 0x00000200,
1003 S_PNP = 0x00001000,
1004 S_CARD_REG = 0x00002000,
1005 S_KER_DRV = 0x00004000,
1006 S_USB = 0x00008000,
1007 S_KER_PLUG = 0x00010000,
1008 S_EVENT = 0x00020000,
1009 S_IPC = 0x00040000,
1010 S_KER_BUF = 0x00080000,
1013typedef enum
1028typedef struct
1029{
1030 DWORD dwCmd;
1032 /* used for DEBUG_SET_FILTER */
1033 DWORD dwLevel;
1035 DWORD dwSection;
1037 DWORD dwLevelMessageBox;
1038 /* used for DEBUG_SET_BUFFER */
1039 DWORD dwBufferSize;
1041
1042#define DEBUG_USER_BUF_LEN 2048
1043typedef struct
1044{
1045 CHAR cBuffer[DEBUG_USER_BUF_LEN];
1048typedef struct
1050 CHAR pcBuffer[256];
1051 DWORD dwLevel;
1052 DWORD dwSection;
1055typedef struct
1057 DWORD hKernelPlugIn;
1058 CHAR cDriverName[WD_MAX_KP_NAME_LENGTH];
1059 CHAR cDriverPath[WD_MAX_KP_NAME_LENGTH];
1063 PAD_TO_64(hKernelPlugIn) /* 64 bit app has a 4 byte hole here */
1064 PVOID pOpenData;
1065 PAD_TO_64(pOpenData)
1067
1069typedef enum
1071 WD_DEVICE_PCI = 0x1,
1074
1075typedef struct
1077 union
1079 HANDLE hDevice;
1080 DWORD dwUniqueID;
1081 } h;
1082 PAD_TO_64(hDevice)
1083 PVOID pBuf;
1085 DWORD dwBytes;
1086 DWORD dwProperty;
1087 DWORD dwOptions;
1088 PAD_TO_64(dwOptions)
1091typedef enum {
1093 WD_STATUS_INVALID_WD_HANDLE = (int)0xffffffff,
1095 WD_WINDRIVER_STATUS_ERROR = 0x20000000L,
1097 WD_INVALID_HANDLE = 0x20000001L,
1110 WD_READ_WRITE_CONFLICT = 0x20000003L,
1113 WD_ZERO_PACKET_SIZE = 0x20000004L,
1115 WD_INSUFFICIENT_RESOURCES = 0x20000005L,
1120 WD_UNKNOWN_PIPE_TYPE = 0x20000006L,
1121 WD_SYSTEM_INTERNAL_ERROR = 0x20000007L,
1123 WD_DATA_MISMATCH = 0x20000008L,
1127 WD_NO_LICENSE = 0x20000009L,
1133 WD_NOT_IMPLEMENTED = 0x2000000aL,
1138 WD_KERPLUG_FAILURE = 0x2000000bL,
1142 WD_FAILED_ENABLING_INTERRUPT = 0x2000000cL,
1153 WD_INTERRUPT_NOT_ENABLED = 0x2000000dL,
1160 WD_RESOURCE_OVERLAP = 0x2000000eL,
1166 WD_DEVICE_NOT_FOUND = 0x2000000fL,
1169 WD_WRONG_UNIQUE_ID = 0x20000010L,
1172 WD_OPERATION_ALREADY_DONE = 0x20000011L,
1178 WD_USB_DESCRIPTOR_ERROR = 0x20000012L,
1186 WD_SET_CONFIGURATION_FAILED = 0x20000013L,
1191 WD_CANT_OBTAIN_PDO = 0x20000014L,
1192 WD_TIME_OUT_EXPIRED = 0x20000015L,
1196 WD_IRP_CANCELED = 0x20000016L,
1199 WD_FAILED_USER_MAPPING = 0x20000017L,
1208 WD_FAILED_KERNEL_MAPPING = 0x20000018L,
1218 WD_NO_RESOURCES_ON_DEVICE = 0x20000019L,
1228 WD_NO_EVENTS = 0x2000001aL,
1232 WD_INVALID_PARAMETER = 0x2000001bL,
1236 WD_INCORRECT_VERSION = 0x2000001cL,
1242 WD_TRY_AGAIN = 0x2000001dL,
1246 WD_WINDRIVER_NOT_FOUND = 0x2000001eL,
1247 WD_INVALID_IOCTL = 0x2000001fL,
1252 WD_OPERATION_FAILED = 0x20000020L,
1256 WD_INVALID_32BIT_APP = 0x20000021L,
1262 WD_TOO_MANY_HANDLES = 0x20000022L,
1268 WD_NO_DEVICE_OBJECT = 0x20000023L,
1281 WD_MORE_PROCESSING_REQUIRED = (int)0xC0000016L,
1289 /* The following status codes are returned by USBD:
1290 USBD status types: */
1294 WD_USBD_STATUS_ERROR = (int)0x80000000L,
1295 WD_USBD_STATUS_HALTED = (int)0xC0000000L,
1297 /* USBD status codes: */
1298 /* @note The following status codes are comprised of one of the status
1299 * types above and an error code [i.e. 0xXYYYYYYYL - where: X = status type;
1300 * YYYYYYY = error code].
1301 * The same error codes may also appear with one of the other status types
1302 * as well. */
1303
1304 /* HC (Host Controller) status codes.
1305 @note These status codes use the WD_USBD_STATUS_HALTED status type]: */
1306 WD_USBD_STATUS_CRC = (int)0xC0000001L,
1308 WD_USBD_STATUS_BTSTUFF = (int)0xC0000002L,
1314 WD_USBD_STATUS_STALL_PID = (int)0xC0000004L,
1316 WD_USBD_STATUS_DEV_NOT_RESPONDING = (int)0xC0000005L,
1319 WD_USBD_STATUS_PID_CHECK_FAILURE = (int)0xC0000006L,
1322 WD_USBD_STATUS_UNEXPECTED_PID = (int)0xC0000007L,
1325 WD_USBD_STATUS_DATA_OVERRUN = (int)0xC0000008L,
1328 WD_USBD_STATUS_DATA_UNDERRUN = (int)0xC0000009L,
1331 WD_USBD_STATUS_RESERVED1 = (int)0xC000000AL,
1333 WD_USBD_STATUS_RESERVED2 = (int)0xC000000BL,
1335 WD_USBD_STATUS_BUFFER_OVERRUN = (int)0xC000000CL,
1338 WD_USBD_STATUS_BUFFER_UNDERRUN = (int)0xC000000DL,
1341 WD_USBD_STATUS_NOT_ACCESSED = (int)0xC000000FL,
1343 WD_USBD_STATUS_FIFO = (int)0xC0000010L,
1346#if defined(WIN32)
1347 WD_USBD_STATUS_XACT_ERROR = (int)0xC0000011L,
1353 WD_USBD_STATUS_BABBLE_DETECTED = (int)0xC0000012L,
1356 WD_USBD_STATUS_DATA_BUFFER_ERROR = (int)0xC0000013L,
1359#endif
1361 WD_USBD_STATUS_CANCELED = (int)0xC0010000L,
1367 WD_USBD_STATUS_ENDPOINT_HALTED = (int)0xC0000030L,
1368
1369 /* Software status codes
1370 @note The following status codes have only the error bit set: */
1371 WD_USBD_STATUS_NO_MEMORY = (int)0x80000100L,
1374 WD_USBD_STATUS_INVALID_URB_FUNCTION = (int)0x80000200L,
1377 WD_USBD_STATUS_INVALID_PARAMETER = (int)0x80000300L,
1383 WD_USBD_STATUS_ERROR_BUSY = (int)0x80000400L,
1384
1389 WD_USBD_STATUS_REQUEST_FAILED = (int)0x80000500L,
1391 WD_USBD_STATUS_INVALID_PIPE_HANDLE = (int)0x80000600L,
1396
1398 WD_USBD_STATUS_INTERNAL_HC_ERROR = (int)0x80000800L,
1402 WD_USBD_STATUS_ERROR_SHORT_TRANSFER = (int)0x80000900L,
1403
1407 WD_USBD_STATUS_BAD_START_FRAME = (int)0xC0000A00L,
1411 WD_USBD_STATUS_ISOCH_REQUEST_FAILED = (int)0xC0000B00L,
1415 WD_USBD_STATUS_FRAME_CONTROL_OWNED = (int)0xC0000C00L,
1416
1420
1421#if defined(WIN32)
1422 ,
1423 /* Additional USB 2.0 software error codes added for USB 2.0: */
1424 WD_USBD_STATUS_NOT_SUPPORTED = (int)0xC0000E00L,
1437 WD_USBD_STATUS_SET_CONFIG_FAILED = (int)0xC0002000L,
1454 WD_USBD_STATUS_TIMEOUT = (int)0xC0006000L,
1457 WD_USBD_STATUS_DEVICE_GONE = (int)0xC0007000L,
1471 WD_USBD_STATUS_ISO_NOT_ACCESSED_BY_HW = (int)0xC0020000L,
1478 WD_USBD_STATUS_ISO_NA_LATE_USBPORT = (int)0xC0040000L,
1481 WD_USBD_STATUS_ISO_NOT_ACCESSED_LATE = (int)0xC0050000L
1482#endif
1485typedef enum
1487 WD_INSERT = 0x1,
1500 WD_POWER_SYSTEM_SHUTDOWN = 0x2000,
1501 WD_IPC_UNICAST_MSG = 0x4000,
1505#define WD_IPC_ALL_MSG (WD_IPC_UNICAST_MSG | WD_IPC_MULTICAST_MSG)
1507typedef enum
1509 WD_ACKNOWLEDGE = 0x1,
1512
1513#define WDU_USE_SHARED_OBJECT_HANDLE 0x1000000
1514#define WDU_DONT_INSERT_LICENSE 0x2000000
1515
1516#define WD_ACTIONS_POWER (WD_POWER_CHANGED_D0 | WD_POWER_CHANGED_D1 | \
1517 WD_POWER_CHANGED_D2 | WD_POWER_CHANGED_D3 | WD_POWER_SYSTEM_WORKING | \
1518 WD_POWER_SYSTEM_SLEEPING1 | WD_POWER_SYSTEM_SLEEPING3 | \
1519 WD_POWER_SYSTEM_HIBERNATE | WD_POWER_SYSTEM_SHUTDOWN)
1520#define WD_ACTIONS_ALL (WD_ACTIONS_POWER | WD_INSERT | WD_REMOVE)
1522enum
1529typedef DWORD WD_EVENT_TYPE;
1531typedef struct
1532{
1533 DWORD hEvent;
1534 DWORD dwEventType;
1536 DWORD dwAction;
1537 DWORD dwEventId;
1538 DWORD hKernelPlugIn;
1539 DWORD dwOptions;
1540 union u
1542 struct Pci
1545 WD_PCI_SLOT pciSlot;
1547 struct Usb
1549 DWORD dwUniqueID;
1551 struct Ipc
1552 {
1553 DWORD hIpc;
1554 DWORD dwSubGroupID;
1556 DWORD dwGroupID;
1557
1558 DWORD dwSenderUID;
1559 DWORD dwMsgID;
1560 PAD_TO_64(dwMsgID)
1561 UINT64 qwMsgData;
1562 } Ipc;
1563 } u;
1565 DWORD dwNumMatchTables;
1566 WDU_MATCH_TABLE matchTables[1];
1569typedef struct
1570{
1571 DWORD applications_num;
1572 DWORD devices_num;
1573} WD_USAGE;
1575enum
1580
1581#ifndef BZERO
1582 #define BZERO(buf) memset(&(buf), 0, sizeof(buf))
1583#endif
1584
1585#ifndef INVALID_HANDLE_VALUE
1586 #define INVALID_HANDLE_VALUE ((HANDLE)(-1))
1587#endif
1588
1589#ifndef CTL_CODE
1590 #define CTL_CODE(DeviceType, Function, Method, Access) ( \
1591 ((DeviceType)<<16) | ((Access)<<14) | ((Function)<<2) | (Method) \
1594 #define METHOD_BUFFERED 0
1595 #define METHOD_IN_DIRECT 1
1596 #define METHOD_OUT_DIRECT 2
1597 #define METHOD_NEITHER 3
1598 #define FILE_ANY_ACCESS 0
1599 #define FILE_READ_ACCESS 1
1600 #define FILE_WRITE_ACCESS 2
1601#endif
1602
1603#if defined(LINUX) && defined(KERNEL_64BIT)
1604 #define WD_TYPE 0
1605 #define WD_CTL_CODE(wFuncNum) \
1606 _IOC(_IOC_READ|_IOC_WRITE, WD_TYPE, wFuncNum, 0)
1607 #define WD_CTL_DECODE_FUNC(IoControlCode) _IOC_NR(IoControlCode)
1608 #define WD_CTL_DECODE_TYPE(IoControlCode) _IOC_TYPE(IoControlCode)
1609#elif defined(UNIX)
1610 #define WD_TYPE 0
1611 #define WD_CTL_CODE(wFuncNum) (wFuncNum)
1612 #define WD_CTL_DECODE_FUNC(IoControlCode) (IoControlCode)
1613 #define WD_CTL_DECODE_TYPE(IoControlCode) (WD_TYPE)
1614#else
1616 #define WD_TYPE 38200
1617 #if defined(KERNEL_64BIT)
1618 #define FUNC_MASK 0x400
1619 #else
1620 #define FUNC_MASK 0x0
1621 #endif
1622 #define WD_CTL_CODE(wFuncNum) CTL_CODE(WD_TYPE, (wFuncNum | FUNC_MASK), \
1623 METHOD_NEITHER, FILE_ANY_ACCESS)
1624 #define WD_CTL_DECODE_FUNC(IoControlCode) ((IoControlCode >> 2) & 0xfff)
1625 #define WD_CTL_DECODE_TYPE(IoControlCode) \
1626 DEVICE_TYPE_FROM_CTL_CODE(IoControlCode)
1627#endif
1628
1629#if defined(LINUX)
1630 #define WD_CTL_IS_64BIT_AWARE(IoControlCode) \
1631 (_IOC_DIR(IoControlCode) & (_IOC_READ|_IOC_WRITE))
1632#elif defined(UNIX)
1633 #define WD_CTL_IS_64BIT_AWARE(IoControlCode) TRUE
1634#else
1635 #define WD_CTL_IS_64BIT_AWARE(IoControlCode) \
1636 (WD_CTL_DECODE_FUNC(IoControlCode) & FUNC_MASK)
1637#endif
1638
1639/* WinDriver function IOCTL calls. For details on the WinDriver functions, */
1640/* see the WinDriver manual or included help files. */
1642#define IOCTL_WD_KERNEL_BUF_LOCK WD_CTL_CODE(0x901)
1643#define IOCTL_WD_KERNEL_BUF_UNLOCK WD_CTL_CODE(0x902)
1644#define IOCTL_WD_DMA_LOCK WD_CTL_CODE(0x903)
1645#define IOCTL_WD_DMA_UNLOCK WD_CTL_CODE(0x904)
1646#define IOCTL_WD_DMA_SYNC_CPU WD_CTL_CODE(0x905)
1647#define IOCTL_WD_DMA_SYNC_IO WD_CTL_CODE(0x906)
1648#define IOCTL_WD_DMA_TRANSACTION_INIT WD_CTL_CODE(0x907)
1649#define IOCTL_WD_DMA_TRANSACTION_EXECUTE WD_CTL_CODE(0x908)
1650#define IOCTL_WD_DMA_TRANSFER_COMPLETED_AND_CHECK WD_CTL_CODE(0x909)
1651#define IOCTL_WD_DMA_TRANSACTION_RELEASE WD_CTL_CODE(0x90a)
1652#define IOCTL_WD_TRANSFER WD_CTL_CODE(0x90b)
1653#define IOCTL_WD_MULTI_TRANSFER WD_CTL_CODE(0x90c)
1654#define IOCTL_WD_PCI_SCAN_CARDS WD_CTL_CODE(0x90d)
1655#define IOCTL_WD_PCI_GET_CARD_INFO WD_CTL_CODE(0x90e)
1656#define IOCTL_WD_PCI_SCAN_CAPS WD_CTL_CODE(0x90f)
1657#define IOCTL_WD_PCI_CONFIG_DUMP WD_CTL_CODE(0x910)
1658#define IOCTL_WD_VERSION WD_CTL_CODE(0x911)
1659#define IOCTL_WD_KERNEL_PLUGIN_OPEN WD_CTL_CODE(0x912)
1660#define IOCTL_WD_KERNEL_PLUGIN_CLOSE WD_CTL_CODE(0x913)
1661#define IOCTL_WD_KERNEL_PLUGIN_CALL WD_CTL_CODE(0x914)
1662#define IOCTL_WD_INT_ENABLE WD_CTL_CODE(0x915)
1663#define IOCTL_WD_INT_DISABLE WD_CTL_CODE(0x916)
1664#define IOCTL_WD_INT_COUNT WD_CTL_CODE(0x917)
1665#define IOCTL_WD_INT_WAIT WD_CTL_CODE(0x918)
1666#define IOCTL_WD_SLEEP WD_CTL_CODE(0x919)
1667#define IOCTL_WD_DEBUG WD_CTL_CODE(0x91a)
1668#define IOCTL_WD_DEBUG_DUMP WD_CTL_CODE(0x91b)
1669#define IOCTL_WD_DEBUG_ADD WD_CTL_CODE(0x91c)
1670#define IOCTL_WD_CARD_REGISTER WD_CTL_CODE(0x91d)
1671#define IOCTL_WD_CARD_UNREGISTER WD_CTL_CODE(0x91e)
1672#define IOCTL_WD_CARD_CLEANUP_SETUP WD_CTL_CODE(0x91f)
1673#define IOCTL_WD_GET_DEVICE_PROPERTY WD_CTL_CODE(0x920)
1674#define IOCTL_WD_EVENT_REGISTER WD_CTL_CODE(0x921)
1675#define IOCTL_WD_EVENT_UNREGISTER WD_CTL_CODE(0x922)
1676#define IOCTL_WD_EVENT_PULL WD_CTL_CODE(0x923)
1677#define IOCTL_WD_EVENT_SEND WD_CTL_CODE(0x924)
1678#define IOCTL_WDU_GET_DEVICE_DATA WD_CTL_CODE(0x925)
1679#define IOCTL_WDU_WAKEUP WD_CTL_CODE(0x926)
1680#define IOCTL_WDU_SET_INTERFACE WD_CTL_CODE(0x927)
1681#define IOCTL_WDU_RESET_PIPE WD_CTL_CODE(0x928)
1682#define IOCTL_WDU_TRANSFER WD_CTL_CODE(0x929)
1683#define IOCTL_WDU_HALT_TRANSFER WD_CTL_CODE(0x92a)
1684#define IOCTL_WDU_RESET_DEVICE WD_CTL_CODE(0x92b)
1685#define IOCTL_WDU_STREAM_OPEN WD_CTL_CODE(0x92c)
1686#define IOCTL_WDU_STREAM_CLOSE WD_CTL_CODE(0x92d)
1687#define IOCTL_WDU_STREAM_START WD_CTL_CODE(0x92e)
1688#define IOCTL_WDU_STREAM_STOP WD_CTL_CODE(0x92f)
1689#define IOCTL_WDU_STREAM_FLUSH WD_CTL_CODE(0x930)
1690#define IOCTL_WDU_STREAM_GET_STATUS WD_CTL_CODE(0x931)
1691#define IOCTL_WDU_SELECTIVE_SUSPEND WD_CTL_CODE(0x932)
1692#define IOCTL_WD_IPC_REGISTER WD_CTL_CODE(0x933)
1693#define IOCTL_WD_IPC_UNREGISTER WD_CTL_CODE(0x934)
1694#define IOCTL_WD_IPC_SCAN_PROCS WD_CTL_CODE(0x935)
1695#define IOCTL_WD_IPC_SEND WD_CTL_CODE(0x936)
1696#define IOCTL_WD_PCI_SRIOV_ENABLE WD_CTL_CODE(0x937)
1697#define IOCTL_WD_PCI_SRIOV_DISABLE WD_CTL_CODE(0x938)
1698#define IOCTL_WD_PCI_SRIOV_GET_NUMVFS WD_CTL_CODE(0x939)
1699#define IOCTL_WD_IPC_SHARED_INT_ENABLE WD_CTL_CODE(0x93a)
1700#define IOCTL_WD_IPC_SHARED_INT_DISABLE WD_CTL_CODE(0x93b)
1701#define IOCTL_WD_USAGE WD_CTL_CODE(0x93c)
1702#define IOCTL_WD_LICENSE WD_CTL_CODE(0x93d)
1703#define IOCTL_WD_PCI_RESET_CARD WD_CTL_CODE(0x945)
1704
1705#if defined(UNIX)
1706 typedef struct
1707 {
1708 DWORD dwHeader;
1709 DWORD dwSize;
1710 PVOID pData;
1711 PAD_TO_64(pData)
1712 } WD_IOCTL_HEADER;
1713
1714 #define WD_IOCTL_HEADER_CODE 0xa410b413UL
1715#endif
1716
1717#if defined(__KERNEL__)
1718 HANDLE __cdecl WD_Open(void);
1719 void __cdecl WD_Close(HANDLE hWD);
1720 DWORD __cdecl KP_DeviceIoControl(DWORD dwFuncNum, HANDLE h, PVOID pParam,
1721 DWORD dwSize);
1722 #define WD_FUNCTION(wFuncNum, h, pParam, dwSize, fWait) \
1723 KP_DeviceIoControl((DWORD)wFuncNum, h, (PVOID)pParam, (DWORD)dwSize)
1724#else
1725 #define REGKEY_BUFSIZE 256
1726 #define OS_CAN_NOT_DETECT_TEXT "OS CAN NOT DETECT"
1727 #define INSTALLATION_TYPE_NOT_DETECT_TEXT "unknown"
1728 typedef struct
1729 {
1730 CHAR cProdName[REGKEY_BUFSIZE];
1731 CHAR cInstallationType[REGKEY_BUFSIZE];
1732 #ifdef WIN32
1733 CHAR cCurrentVersion[REGKEY_BUFSIZE];
1734 CHAR cBuild[REGKEY_BUFSIZE];
1735 CHAR cCsdVersion[REGKEY_BUFSIZE];
1736 DWORD dwMajorVersion;
1737 DWORD dwMinorVersion;
1738 #else
1739 CHAR cRelease[REGKEY_BUFSIZE];
1740 CHAR cReleaseVersion[REGKEY_BUFSIZE];
1741 #endif
1742 } WD_OS_INFO;
1743
1753
1765 #if defined(APPLE)
1766 DWORD WD_FUNCTION_LOCAL(int wFuncNum, HANDLE h,
1767 PVOID pParam, DWORD dwSize, BOOL fWait);
1768
1769 HANDLE WD_OpenLocal(void);
1770
1771 void WD_CloseLocal(HANDLE h);
1772
1773 #define WD_OpenStreamLocal(read,sync) INVALID_HANDLE_VALUE
1774
1775 #define WD_UStreamRead(hFile, pBuffer, dwNumberOfBytesToRead, \
1776 dwNumberOfBytesRead)\
1777 WD_NOT_IMPLEMENTED
1778
1779 #define WD_UStreamWrite(hFile, pBuffer, dwNumberOfBytesToWrite, \
1780 dwNumberOfBytesWritten)\
1781 WD_NOT_IMPLEMENTED
1782
1783 #if __ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__ >= 120000
1784 #define IO_MASTER_PORT IOMainPort
1785 #else
1786 #define IO_MASTER_PORT IOMasterPort
1787 #endif
1788
1789 #elif defined(UNIX)
1790 static inline ULONG WD_FUNCTION_LOCAL(int wFuncNum, HANDLE h,
1791 PVOID pParam, DWORD dwSize, BOOL fWait)
1792 {
1793 WD_IOCTL_HEADER ioctl_hdr;
1794
1795 BZERO(ioctl_hdr);
1796 ioctl_hdr.dwHeader = WD_IOCTL_HEADER_CODE;
1797 ioctl_hdr.dwSize = dwSize;
1798 ioctl_hdr.pData = pParam;
1799 (void)fWait;
1800 #if defined(LINUX)
1801 return (ULONG)ioctl((int)(long)h, wFuncNum, &ioctl_hdr);
1802 #endif
1803 }
1804
1805 #define WD_OpenLocal()\
1806 ((HANDLE)(long)open(WD_DRIVER_NAME, O_RDWR | O_SYNC))
1807 #define WD_OpenStreamLocal(read,sync) \
1808 ((HANDLE)(long)open(WD_DRIVER_NAME, \
1809 ((read) ? O_RDONLY : O_WRONLY) | \
1810 ((sync) ? O_SYNC : O_NONBLOCK)))
1811
1812 #define WD_CloseLocal(h) close((int)(long)(h))
1813
1814 #define WD_UStreamRead(hFile, pBuffer, dwNumberOfBytesToRead, \
1815 dwNumberOfBytesRead)\
1816 WD_NOT_IMPLEMENTED
1817
1818 #define WD_UStreamWrite(hFile, pBuffer, dwNumberOfBytesToWrite, \
1819 dwNumberOfBytesWritten)\
1820 WD_NOT_IMPLEMENTED
1821
1822 #elif defined(WIN32)
1823 #define WD_CloseLocal(h) CloseHandle(h)
1824
1825 #define WD_UStreamRead(hFile, pBuffer, dwNumberOfBytesToRead, \
1826 dwNumberOfBytesRead)\
1827 ReadFile(hFile, pBuffer, dwNumberOfBytesToRead, \
1828 dwNumberOfBytesRead, NULL) ? WD_STATUS_SUCCESS : \
1829 WD_OPERATION_FAILED
1830
1831 #define WD_UStreamWrite(hFile, pBuffer, dwNumberOfBytesToWrite, \
1832 dwNumberOfBytesWritten)\
1833 WriteFile(hFile, pBuffer, dwNumberOfBytesToWrite, \
1834 dwNumberOfBytesWritten, NULL) ? WD_STATUS_SUCCESS : \
1835 WD_OPERATION_FAILED
1836
1837 #if defined(WIN32)
1838 #define WD_OpenLocal()\
1839 CreateFileA(\
1840 WD_DRIVER_NAME,\
1841 GENERIC_READ,\
1842 FILE_SHARE_READ | FILE_SHARE_WRITE,\
1843 NULL, OPEN_EXISTING, FILE_FLAG_OVERLAPPED, NULL)
1844
1845 #define WD_OpenStreamLocal(read,sync) \
1846 CreateFileA(\
1847 WD_DRIVER_NAME,\
1848 (read) ? GENERIC_READ : GENERIC_WRITE,\
1849 FILE_SHARE_READ | FILE_SHARE_WRITE, NULL, OPEN_EXISTING, \
1850 (sync) ? 0 : FILE_FLAG_OVERLAPPED, NULL)
1851
1852 static DWORD WD_FUNCTION_LOCAL(int wFuncNum, HANDLE h, PVOID pParam,
1853 DWORD dwSize, BOOL fWait)
1854 {
1855 DWORD dwTmp;
1856 HANDLE hWD = fWait ? WD_OpenLocal() : h;
1857 DWORD rc = WD_WINDRIVER_STATUS_ERROR;
1858
1859 if (hWD == INVALID_HANDLE_VALUE)
1860 return (DWORD)WD_STATUS_INVALID_WD_HANDLE;
1861
1862 DeviceIoControl(hWD, (DWORD)wFuncNum, pParam, dwSize, &rc,
1863 sizeof(DWORD), &dwTmp, NULL);
1864
1865 if (fWait)
1866 WD_CloseLocal(hWD);
1867
1868 return rc;
1869 }
1870 #endif
1871 #endif
1873 #define WD_FUNCTION WD_FUNCTION_LOCAL
1874 #define WD_Close WD_CloseLocal
1875 #define WD_Open WD_OpenLocal
1876 #define WD_StreamOpen WD_OpenStreamLocal
1877 #define WD_StreamClose WD_CloseLocal
1878#endif
1879
1880#define SIZE_OF_WD_DMA(pDma) \
1881 ((DWORD)(sizeof(WD_DMA) + ((pDma)->dwPages <= WD_DMA_PAGES ? \
1882 0 : ((pDma)->dwPages - WD_DMA_PAGES) * sizeof(WD_DMA_PAGE))))
1883#define SIZE_OF_WD_EVENT(pEvent) \
1884 ((DWORD)(sizeof(WD_EVENT) + ((pEvent)->dwNumMatchTables > 0 ? \
1885 sizeof(WDU_MATCH_TABLE) * ((pEvent)->dwNumMatchTables - 1) : 0)))
1886
1898#define WD_Debug(h,pDebug)\
1899 WD_FUNCTION(IOCTL_WD_DEBUG, h, pDebug, sizeof(WD_DEBUG), FALSE)
1900
1912#define WD_DebugDump(h,pDebugDump)\
1913 WD_FUNCTION(IOCTL_WD_DEBUG_DUMP, h, pDebugDump, sizeof(WD_DEBUG_DUMP), \
1914 FALSE)
1915
1927#define WD_DebugAdd(h, pDebugAdd)\
1928 WD_FUNCTION(IOCTL_WD_DEBUG_ADD, h, pDebugAdd, sizeof(WD_DEBUG_ADD), FALSE)
1929
1942#define WD_Transfer(h,pTransfer)\
1943 WD_FUNCTION(IOCTL_WD_TRANSFER, h, pTransfer, sizeof(WD_TRANSFER), FALSE)
1944
1961#define WD_MultiTransfer(h, pTransferArray, dwNumTransfers) \
1962 WD_FUNCTION(IOCTL_WD_MULTI_TRANSFER, h, pTransferArray, \
1963 sizeof(WD_TRANSFER) * (dwNumTransfers), FALSE)
1964
1978#define WD_KernelBufLock(h, pKerBuf)\
1979 WD_FUNCTION(IOCTL_WD_KERNEL_BUF_LOCK, h, pKerBuf, \
1980 sizeof(WD_KERNEL_BUFFER), FALSE)
1981
1993#define WD_KernelBufUnlock(h, pKerBuf)\
1994 WD_FUNCTION(IOCTL_WD_KERNEL_BUF_UNLOCK, h, pKerBuf, \
1995 sizeof(WD_KERNEL_BUFFER), FALSE)
1996
2059#define WD_DMALock(h,pDma)\
2060 WD_FUNCTION(IOCTL_WD_DMA_LOCK, h, pDma, SIZE_OF_WD_DMA(pDma), FALSE)
2061
2074#define WD_DMAUnlock(h,pDma)\
2075 WD_FUNCTION(IOCTL_WD_DMA_UNLOCK, h, pDma, SIZE_OF_WD_DMA(pDma), FALSE)
2076
2090#define WD_DMATransactionInit(h,pDma)\
2091 WD_FUNCTION(IOCTL_WD_DMA_TRANSACTION_INIT, h, pDma, SIZE_OF_WD_DMA(pDma), \
2092 FALSE)
2093
2104#define WD_DMATransactionExecute(h,pDma)\
2105 WD_FUNCTION(IOCTL_WD_DMA_TRANSACTION_EXECUTE, h, pDma, \
2106 SIZE_OF_WD_DMA(pDma), FALSE)
2107
2118#define WD_DMATransferCompletedAndCheck(h,pDma)\
2119 WD_FUNCTION(IOCTL_WD_DMA_TRANSFER_COMPLETED_AND_CHECK, h, pDma, \
2120 SIZE_OF_WD_DMA(pDma), FALSE)
2121
2133#define WD_DMATransactionRelease(h,pDma)\
2134 WD_FUNCTION(IOCTL_WD_DMA_TRANSACTION_RELEASE, h, pDma, \
2135 SIZE_OF_WD_DMA(pDma), FALSE)
2136
2148#define WD_DMATransactionUninit(h,pDma)\
2149 WD_FUNCTION(IOCTL_WD_DMA_UNLOCK, h, pDma, SIZE_OF_WD_DMA(pDma), FALSE)
2150
2174#define WD_DMASyncCpu(h,pDma)\
2175 WD_FUNCTION(IOCTL_WD_DMA_SYNC_CPU, h, pDma, SIZE_OF_WD_DMA(pDma), FALSE)
2176
2201#define WD_DMASyncIo(h,pDma)\
2202 WD_FUNCTION(IOCTL_WD_DMA_SYNC_IO, h, pDma, SIZE_OF_WD_DMA(pDma), FALSE)
2203
2255#define WD_CardRegister(h,pCard)\
2256 WD_FUNCTION(IOCTL_WD_CARD_REGISTER, h, pCard, sizeof(WD_CARD_REGISTER),\
2257 FALSE)
2258
2271#define WD_CardUnregister(h,pCard)\
2272 WD_FUNCTION(IOCTL_WD_CARD_UNREGISTER, h, pCard, sizeof(WD_CARD_REGISTER),\
2273 FALSE)
2274
2296#define WD_IpcRegister(h, pIpcRegister) \
2297 WD_FUNCTION(IOCTL_WD_IPC_REGISTER, h, pIpcRegister, \
2298 sizeof(WD_IPC_REGISTER), FALSE)
2299
2312#define WD_IpcUnRegister(h, pProcInfo) \
2313 WD_FUNCTION(IOCTL_WD_IPC_UNREGISTER, h, pProcInfo, sizeof(WD_IPC_PROCESS), \
2314 FALSE)
2315
2329#define WD_IpcScanProcs(h, pIpcScanProcs) \
2330 WD_FUNCTION(IOCTL_WD_IPC_SCAN_PROCS, h, pIpcScanProcs, \
2331 sizeof(WD_IPC_SCAN_PROCS), FALSE)
2332
2346#define WD_IpcSend(h, pIpcSend) \
2347 WD_FUNCTION(IOCTL_WD_IPC_SEND, h, pIpcSend, sizeof(WD_IPC_SEND), FALSE)
2348
2366#define WD_SharedIntEnable(h, pIpcRegister) \
2367 WD_FUNCTION(IOCTL_WD_IPC_SHARED_INT_ENABLE, h, pIpcRegister, \
2368 sizeof(WD_IPC_REGISTER), FALSE)
2369
2381#define WD_SharedIntDisable(h) \
2382 WD_FUNCTION(IOCTL_WD_IPC_SHARED_INT_DISABLE, h, 0, 0, FALSE)
2383
2397#define WD_PciSriovEnable(h,pPciSRIOV) \
2398 WD_FUNCTION(IOCTL_WD_PCI_SRIOV_ENABLE, h, pPciSRIOV, \
2399 sizeof(WD_PCI_SRIOV), FALSE)
2400
2414#define WD_PciSriovDisable(h,pPciSRIOV) \
2415 WD_FUNCTION(IOCTL_WD_PCI_SRIOV_DISABLE, h, pPciSRIOV, \
2416 sizeof(WD_PCI_SRIOV), FALSE)
2417
2433#define WD_PciSriovGetNumVFs(h,pPciSRIOV) \
2434 WD_FUNCTION(IOCTL_WD_PCI_SRIOV_GET_NUMVFS, h, pPciSRIOV, \
2435 sizeof(WD_PCI_SRIOV), FALSE)
2436
2459#define WD_CardCleanupSetup(h,pCardCleanup)\
2460 WD_FUNCTION(IOCTL_WD_CARD_CLEANUP_SETUP, h, pCardCleanup, \
2461 sizeof(WD_CARD_CLEANUP), FALSE)
2462
2477#define WD_PciScanCards(h,pPciScan)\
2478 WD_FUNCTION(IOCTL_WD_PCI_SCAN_CARDS, h, pPciScan,\
2479 sizeof(WD_PCI_SCAN_CARDS), FALSE)
2480
2494#define WD_PciScanCaps(h,pPciScanCaps) \
2495 WD_FUNCTION(IOCTL_WD_PCI_SCAN_CAPS, h, pPciScanCaps, \
2496 sizeof(WD_PCI_SCAN_CAPS), FALSE)
2497
2511#define WD_PciGetCardInfo(h,pPciCard)\
2512 WD_FUNCTION(IOCTL_WD_PCI_GET_CARD_INFO, h, pPciCard, \
2513 sizeof(WD_PCI_CARD_INFO), FALSE)
2514
2529#define WD_PciConfigDump(h,pPciConfigDump)\
2530 WD_FUNCTION(IOCTL_WD_PCI_CONFIG_DUMP, h, pPciConfigDump, \
2531 sizeof(WD_PCI_CONFIG_DUMP), FALSE)
2532
2549#define WD_PciResetCard(h,pPciSlot)\
2550 WD_FUNCTION(IOCTL_WD_PCI_RESET_CARD, h, pPciSlot, sizeof(WD_PCI_SLOT), \
2551 FALSE)
2552
2565#define WD_Version(h,pVerInfo)\
2566 WD_FUNCTION(IOCTL_WD_VERSION, h, pVerInfo, sizeof(WD_VERSION), FALSE)
2567
2591#define WD_License(h,pLicense)\
2592 WD_FUNCTION(IOCTL_WD_LICENSE, h, pLicense, sizeof(WD_LICENSE), FALSE)
2593
2607#define WD_KernelPlugInOpen(h,pKernelPlugIn)\
2608 WD_FUNCTION(IOCTL_WD_KERNEL_PLUGIN_OPEN, h, pKernelPlugIn, \
2609 sizeof(WD_KERNEL_PLUGIN), FALSE)
2610
2623#define WD_KernelPlugInClose(h,pKernelPlugIn)\
2624 WD_FUNCTION(IOCTL_WD_KERNEL_PLUGIN_CLOSE, h, pKernelPlugIn, \
2625 sizeof(WD_KERNEL_PLUGIN), FALSE)
2626
2646#define WD_KernelPlugInCall(h,pKernelPlugInCall)\
2647 WD_FUNCTION(IOCTL_WD_KERNEL_PLUGIN_CALL, h, pKernelPlugInCall, \
2648 sizeof(WD_KERNEL_PLUGIN_CALL), FALSE)
2649
2673#define WD_IntEnable(h,pInterrupt)\
2674 WD_FUNCTION(IOCTL_WD_INT_ENABLE, h, pInterrupt, sizeof(WD_INTERRUPT), FALSE)
2675
2687#define WD_IntDisable(h,pInterrupt)\
2688 WD_FUNCTION(IOCTL_WD_INT_DISABLE, h, pInterrupt, sizeof(WD_INTERRUPT), \
2689 FALSE)
2690
2702#define WD_IntCount(h,pInterrupt)\
2703 WD_FUNCTION(IOCTL_WD_INT_COUNT, h, pInterrupt, sizeof(WD_INTERRUPT), FALSE)
2704
2721#define WD_IntWait(h,pInterrupt)\
2722 WD_FUNCTION(IOCTL_WD_INT_WAIT, h, pInterrupt, sizeof(WD_INTERRUPT), TRUE)
2723
2738#define WD_Sleep(h,pSleep)\
2739 WD_FUNCTION(IOCTL_WD_SLEEP, h, pSleep, sizeof(WD_SLEEP), FALSE)
2740
2741
2742#define WD_EventRegister(h, pEvent) \
2743 WD_FUNCTION(IOCTL_WD_EVENT_REGISTER, h, pEvent, SIZE_OF_WD_EVENT(pEvent), \
2744 FALSE)
2745#define WD_EventUnregister(h, pEvent) \
2746 WD_FUNCTION(IOCTL_WD_EVENT_UNREGISTER, h, pEvent, \
2747 SIZE_OF_WD_EVENT(pEvent), FALSE)
2748#define WD_EventPull(h,pEvent) \
2749 WD_FUNCTION(IOCTL_WD_EVENT_PULL, h, pEvent, SIZE_OF_WD_EVENT(pEvent), FALSE)
2750#define WD_EventSend(h,pEvent) \
2751 WD_FUNCTION(IOCTL_WD_EVENT_SEND, h, pEvent, SIZE_OF_WD_EVENT(pEvent), FALSE)
2752#define WD_Usage(h, pStop) \
2753 WD_FUNCTION(IOCTL_WD_USAGE, h, pStop, sizeof(WD_USAGE), FALSE)
2754
2755#define WD_UGetDeviceData(h, pGetDevData) \
2756 WD_FUNCTION(IOCTL_WDU_GET_DEVICE_DATA, h, pGetDevData, \
2757 sizeof(WDU_GET_DEVICE_DATA), FALSE);
2758#define WD_GetDeviceProperty(h, pGetDevProperty) \
2759 WD_FUNCTION(IOCTL_WD_GET_DEVICE_PROPERTY, h, pGetDevProperty, \
2760 sizeof(WD_GET_DEVICE_PROPERTY), FALSE);
2761#define WD_USetInterface(h, pSetIfc) \
2762 WD_FUNCTION(IOCTL_WDU_SET_INTERFACE, h, pSetIfc, \
2763 sizeof(WDU_SET_INTERFACE), FALSE);
2764#define WD_UResetPipe(h, pResetPipe) \
2765 WD_FUNCTION(IOCTL_WDU_RESET_PIPE, h, pResetPipe, sizeof(WDU_RESET_PIPE), \
2766 FALSE);
2767#define WD_UTransfer(h, pTrans) \
2768 WD_FUNCTION(IOCTL_WDU_TRANSFER, h, pTrans, sizeof(WDU_TRANSFER), TRUE);
2769#define WD_UHaltTransfer(h, pHaltTrans) \
2770 WD_FUNCTION(IOCTL_WDU_HALT_TRANSFER, h, pHaltTrans, \
2771 sizeof(WDU_HALT_TRANSFER), FALSE);
2772#define WD_UWakeup(h, pWakeup) \
2773 WD_FUNCTION(IOCTL_WDU_WAKEUP, h, pWakeup, sizeof(WDU_WAKEUP), FALSE);
2774#define WD_USelectiveSuspend(h, pSelectiveSuspend) \
2775 WD_FUNCTION(IOCTL_WDU_SELECTIVE_SUSPEND, h, pSelectiveSuspend, \
2776 sizeof(WDU_SELECTIVE_SUSPEND), FALSE);
2777#define WD_UResetDevice(h, pResetDevice) \
2778 WD_FUNCTION(IOCTL_WDU_RESET_DEVICE, h, pResetDevice, \
2779 sizeof(WDU_RESET_DEVICE), FALSE);
2780#define WD_UStreamOpen(h, pStream) \
2781 WD_FUNCTION(IOCTL_WDU_STREAM_OPEN, h, pStream, sizeof(WDU_STREAM), FALSE);
2782#define WD_UStreamClose(h, pStream) \
2783 WD_FUNCTION(IOCTL_WDU_STREAM_CLOSE, h, pStream, sizeof(WDU_STREAM), FALSE);
2784#define WD_UStreamStart(h, pStream) \
2785 WD_FUNCTION(IOCTL_WDU_STREAM_START, h, pStream, sizeof(WDU_STREAM), FALSE);
2786#define WD_UStreamStop(h, pStream) \
2787 WD_FUNCTION(IOCTL_WDU_STREAM_STOP, h, pStream, sizeof(WDU_STREAM), FALSE);
2788#define WD_UStreamFlush(h, pStream) \
2789 WD_FUNCTION(IOCTL_WDU_STREAM_FLUSH, h, pStream, sizeof(WDU_STREAM), FALSE);
2790#define WD_UStreamGetStatus(h, pStreamStatus) \
2791 WD_FUNCTION(IOCTL_WDU_STREAM_GET_STATUS, h, pStreamStatus, \
2792 sizeof(WDU_STREAM_STATUS), FALSE);
2793
2794#define __ALIGN_DOWN(val,alignment) ( (val) & ~((alignment) - 1) )
2795#define __ALIGN_UP(val,alignment) \
2796 ( ((val) + (alignment) - 1) & ~((alignment) - 1) )
2797
2798#ifdef WDLOG
2799 #include "wd_log.h"
2800#endif
2801
2802#ifndef MIN
2803 #define MIN(a,b) ((a) > (b) ? (b) : (a))
2804#endif
2805#ifndef MAX
2806 #define MAX(a,b) ((a) > (b) ? (a) : (b))
2807#endif
2808#define SAFE_STRING(s) ((s) ? (s) : "")
2809
2810#define UNUSED_VAR(x) (void)x
2811
2812#ifdef __cplusplus
2813}
2814#endif
2815
2816#endif /* _WINDRVR_H_ */
2817
#define NULL
Definition: kpstdlib.h:269
ITEM_IO.
Definition: windrvr.h:766
ITEM_INTERRUPT.
Definition: windrvr.h:774
ITEM_MEMORY.
Definition: windrvr.h:746
unsigned int u32
Definition: wd_types.h:10
unsigned short u16
Definition: wd_types.h:9
unsigned char u8
Definition: wd_types.h:8
struct WD_BUS WD_BUS_V30
ITEM_TYPE
Definition: windrvr.h:719
@ ITEM_INTERRUPT
Interrupt.
Definition: windrvr.h:721
@ ITEM_BUS
Bus.
Definition: windrvr.h:724
@ ITEM_NONE
Definition: windrvr.h:720
@ ITEM_IO
I/O.
Definition: windrvr.h:723
@ ITEM_MEMORY
Memory.
Definition: windrvr.h:722
@ WD_FORCE_CLEANUP
Definition: windrvr.h:867
@ WD_USB_HARD_RESET
Definition: windrvr.h:1574
@ WD_USB_CYCLE_PORT
Definition: windrvr.h:1575
struct WD_KERNEL_PLUGIN_CALL WD_KERNEL_PLUGIN_CALL_V40
@ WD_DMA_PAGES
Definition: windrvr.h:435
struct WD_PCI_CARD_INFO WD_PCI_CARD_INFO_V118
PCI_ACCESS_RESULT
Definition: windrvr.h:953
@ PCI_ACCESS_OK
Definition: windrvr.h:954
@ PCI_ACCESS_ERROR
Definition: windrvr.h:955
@ PCI_BAD_SLOT
Definition: windrvr.h:957
@ PCI_BAD_BUS
Definition: windrvr.h:956
WD_ITEM_MEM_OPTIONS
Definition: windrvr.h:728
@ WD_ITEM_MEM_DO_NOT_MAP_KERNEL
Skip the mapping of physical memory to the kernel address space.
Definition: windrvr.h:729
@ WD_ITEM_MEM_ALLOW_CACHE
Map physical memory as cached; applicable only to host RAM, not to local memory on the card.
Definition: windrvr.h:731
@ WD_ITEM_MEM_USER_MAP
Map physical memory from user mode, Linux only.
Definition: windrvr.h:734
WD_GET_DEVICE_PROPERTY_OPTION
IOCTL Structures.
Definition: windrvr.h:1067
@ WD_DEVICE_USB
Definition: windrvr.h:1069
@ WD_DEVICE_PCI
Definition: windrvr.h:1068
struct WD_ITEMS WD_ITEMS_V118
struct WD_DEBUG_ADD WD_DEBUG_ADD_V503
size_t UPTR
Definition: windrvr.h:382
#define WD_VERSION_STR_LENGTH
Definition: windrvr.h:61
struct WD_IPC_SCAN_PROCS WD_IPC_SCAN_PROCS_V121
DEBUG_LEVEL
Definition: windrvr.h:982
@ D_ERROR
Definition: windrvr.h:984
@ D_TRACE
Definition: windrvr.h:987
@ D_WARN
Definition: windrvr.h:985
@ D_INFO
Definition: windrvr.h:986
@ D_OFF
Definition: windrvr.h:983
struct WD_TRANSFER WD_TRANSFER_V61
unsigned short int WORD
Definition: windrvr.h:337
struct WD_KERNEL_BUFFER WD_KERNEL_BUFFER_V121
WD_KER_BUF_OPTION
Definition: windrvr.h:574
@ KER_BUF_ALLOC_NON_CONTIG
Definition: windrvr.h:580
@ KER_BUF_GET_EXISTING_BUF
Definition: windrvr.h:583
@ KER_BUF_ALLOC_CONTIG
Definition: windrvr.h:581
@ KER_BUF_ALLOC_CACHED
Definition: windrvr.h:582
@ WD_PCI_CAP_ID_ALL
Definition: windrvr.h:911
#define WD_OpenLocal()
Definition: windrvr.h:1835
DEBUG_COMMAND
Definition: windrvr.h:1011
@ DEBUG_DUMP_SEC_ON
Definition: windrvr.h:1016
@ KERNEL_DEBUGGER_OFF
Definition: windrvr.h:1019
@ DEBUG_CLEAR_BUFFER
Definition: windrvr.h:1015
@ DEBUG_DUMP_CLOCK_OFF
Definition: windrvr.h:1021
@ DEBUG_DUMP_CLOCK_ON
Definition: windrvr.h:1020
@ KERNEL_DEBUGGER_ON
Definition: windrvr.h:1018
@ DEBUG_SET_FILTER
Definition: windrvr.h:1013
@ DEBUG_SET_BUFFER
Definition: windrvr.h:1014
@ DEBUG_CLOCK_RESET
Definition: windrvr.h:1022
@ DEBUG_STATUS
Definition: windrvr.h:1012
@ DEBUG_DUMP_SEC_OFF
Definition: windrvr.h:1017
struct WD_SLEEP WD_SLEEP_V40
#define WD_LICENSE_LENGTH
Definition: windrvr.h:694
unsigned char BYTE
Definition: windrvr.h:336
WD_ERROR_CODES
Definition: windrvr.h:1088
@ WD_INVALID_32BIT_APP
[0x20000021] Invalid 32 Bit User Application.
Definition: windrvr.h:1253
@ WD_TRY_AGAIN
[0x2000001d] Try Again.
Definition: windrvr.h:1239
@ WD_USBD_STATUS_DATA_TOGGLE_MISMATCH
[0xC0000003] HC status: Data toggle mismatch
Definition: windrvr.h:1307
@ WD_RESOURCE_OVERLAP
[0x2000000e] Resource Overlap.
Definition: windrvr.h:1157
@ WD_FAILED_KERNEL_MAPPING
[0x20000018] Failed to map memory to Kernel Space.
Definition: windrvr.h:1205
@ WD_WINDRIVER_STATUS_ERROR
[0x20000000]
Definition: windrvr.h:1092
@ WD_USBD_STATUS_UNEXPECTED_PID
[0xC0000007] HC status: Unexpected PID
Definition: windrvr.h:1319
@ WD_USBD_STATUS_REQUEST_FAILED
[0x80000500] Returned by USBD if it cannot complete a URB request.
Definition: windrvr.h:1386
@ WD_USBD_STATUS_INTERFACE_NOT_FOUND
[0xC0004000] USBD: Interface not found
Definition: windrvr.h:1443
@ WD_USBD_STATUS_INAVLID_CONFIGURATION_DESCRIPTOR
[0xC0000F00] USBD: Invalid configuration descriptor
Definition: windrvr.h:1424
@ WD_TOO_MANY_HANDLES
[0x20000022] Too Many Handles.
Definition: windrvr.h:1259
@ WD_USBD_STATUS_ISO_NOT_ACCESSED_LATE
[0xC0050000] The packet was not sent because the client submitted it too late to transmit:
Definition: windrvr.h:1478
@ WD_USBD_STATUS_INVALID_URB_FUNCTION
[0x80000200] USBD: Invalid URB function
Definition: windrvr.h:1371
@ WD_USBD_STATUS_NOT_ACCESSED
[0xC000000F] HC status: Not accessed
Definition: windrvr.h:1338
@ WD_INTERRUPT_NOT_ENABLED
[0x2000000d] Interrupt not enabled.
Definition: windrvr.h:1150
@ WD_USBD_STATUS_ERROR_BUSY
[0x80000400] Returned if client driver attempts to close an endpoint/interface or configuration with ...
Definition: windrvr.h:1380
@ WD_USBD_STATUS_XACT_ERROR
[0xC0000011] HC status: The host controller has set the Transaction Error (XactErr) bit in the transf...
Definition: windrvr.h:1344
@ WD_MORE_PROCESSING_REQUIRED
[0xC0000016] More Processing Required.
Definition: windrvr.h:1278
@ WD_UNKNOWN_PIPE_TYPE
[0x20000006] Obsolete.
Definition: windrvr.h:1117
@ WD_INVALID_HANDLE
[0x20000001] Invalid WinDriver handle.
Definition: windrvr.h:1094
@ WD_USBD_STATUS_DATA_UNDERRUN
[0xC0000009] HC status: Data underrrun
Definition: windrvr.h:1325
@ WD_OPERATION_FAILED
[0x20000020] Operation Failed.
Definition: windrvr.h:1249
@ WD_USB_DESCRIPTOR_ERROR
[0x20000012] USB Descriptor Error.
Definition: windrvr.h:1175
@ WD_USBD_STATUS_RESERVED1
[0xC000000A] HC status: Reserved1
Definition: windrvr.h:1328
@ WD_USBD_STATUS_RESERVED2
[0xC000000B] HC status: Reserved1
Definition: windrvr.h:1330
@ WD_USBD_STATUS_NOT_SUPPORTED
[0xC0000E00] Returned for APIS not supported/implemented
Definition: windrvr.h:1421
@ WD_USBD_STATUS_DEVICE_GONE
[0xC0007000] USBD: Device Gone
Definition: windrvr.h:1454
@ WD_USBD_STATUS_ISO_NOT_ACCESSED_BY_HW
Extended isochronous error codes returned by USBD.
Definition: windrvr.h:1468
@ WD_USBD_STATUS_DATA_BUFFER_ERROR
[0xC0000013] HC status: Data buffer error
Definition: windrvr.h:1353
@ WD_USBD_STATUS_ISO_TD_ERROR
[0xC0030000] Controller reported an error in the TD.
Definition: windrvr.h:1472
@ WD_USBD_STATUS_DEV_NOT_RESPONDING
[0xC0000005] HC status: Device not responding
Definition: windrvr.h:1313
@ WD_USBD_STATUS_FIFO
[0xC0000010] HC status: FIFO
Definition: windrvr.h:1340
@ WD_NO_LICENSE
0x[20000009] No License.
Definition: windrvr.h:1124
@ WD_INVALID_PARAMETER
[0x2000001b] Invalid Parameter.
Definition: windrvr.h:1229
@ WD_WRONG_UNIQUE_ID
[0x20000010] Wrong unique ID (USB).
Definition: windrvr.h:1166
@ WD_USBD_STATUS_INVALID_PARAMETER
[0x80000300] USBD: Invalid parameter
Definition: windrvr.h:1374
@ WD_USBD_STATUS_BAD_START_FRAME
[0x80000A00] Returned if the requested start frame is not within
Definition: windrvr.h:1404
@ WD_USBD_STATUS_SUCCESS
[0x00000000] Success
Definition: windrvr.h:1288
@ WD_USBD_STATUS_ERROR
[0x80000000] Error
Definition: windrvr.h:1291
@ WD_DATA_MISMATCH
[0x20000008] Data Mismatch.
Definition: windrvr.h:1120
@ WD_NO_RESOURCES_ON_DEVICE
[0x20000019] No Resources On Device.
Definition: windrvr.h:1215
@ WD_NO_EVENTS
[0x2000001a] No Events.
Definition: windrvr.h:1225
@ WD_USBD_STATUS_NO_BANDWIDTH
[0x80000700] Returned when there is not enough bandwidth available
Definition: windrvr.h:1392
@ WD_USBD_STATUS_BUFFER_UNDERRUN
[0xC000000D] HC status: Buffer underrun
Definition: windrvr.h:1335
@ WD_NOT_IMPLEMENTED
[0x2000000a] Function not implemented.
Definition: windrvr.h:1130
@ WD_READ_WRITE_CONFLICT
[0x20000003] Request to read from an OUT (write) pipe or request to write to an IN (read) pipe
Definition: windrvr.h:1107
@ WD_USBD_STATUS_FRAME_CONTROL_NOT_OWNED
[0xC0000D00] Returned by USBD if the caller does not own frame length control and attempts to release...
Definition: windrvr.h:1416
@ WD_DEVICE_NOT_FOUND
[0x2000000f] Device not found.
Definition: windrvr.h:1163
@ WD_NO_DEVICE_OBJECT
[0x20000023] No Device Object.
Definition: windrvr.h:1265
@ WD_USBD_STATUS_CANCELED
[0xC0010000] USBD: Transfer canceled
Definition: windrvr.h:1358
@ WD_INCORRECT_VERSION
[0x2000001c] Incorrect version.
Definition: windrvr.h:1233
@ WD_USBD_STATUS_PENDING
[0x40000000] Operation pending
Definition: windrvr.h:1289
@ WD_USBD_STATUS_TIMEOUT
[0xC0006000] USBD: Timeout
Definition: windrvr.h:1451
@ WD_USBD_STATUS_ISOCH_REQUEST_FAILED
[0xC0000B00] Returned by HCD (Host Controller Driver) if all packets in an isochronous transfer compl...
Definition: windrvr.h:1408
@ WD_FAILED_ENABLING_INTERRUPT
[0x2000000c] Failed Enabling Interrupts.
Definition: windrvr.h:1139
@ WD_KERPLUG_FAILURE
[0x2000000b] Kernel PlugIn failure.
Definition: windrvr.h:1135
@ WD_WINDRIVER_NOT_FOUND
[0x2000001e] Obsolete
Definition: windrvr.h:1243
@ WD_SET_CONFIGURATION_FAILED
[0x20000013] Set Configuration Failed (USB).
Definition: windrvr.h:1183
@ WD_USBD_STATUS_CRC
[0xC0000001] HC status: CRC
Definition: windrvr.h:1303
@ WD_USBD_STATUS_ENDPOINT_HALTED
Returned by HCD (Host Controller Driver) if a transfer is submitted to an endpoint that is stalled:
Definition: windrvr.h:1364
@ WD_USBD_STATUS_INTERNAL_HC_ERROR
[0x80000800] Generic HC (Host Controller) error:
Definition: windrvr.h:1395
@ WD_FAILED_USER_MAPPING
[0x20000017] Failed to map memory to User Space.
Definition: windrvr.h:1196
@ WD_USBD_STATUS_INVALID_PIPE_HANDLE
[80000600] USBD: Invalid pipe handle
Definition: windrvr.h:1388
@ WD_STATUS_SUCCESS
[0] Operation completed successfully
Definition: windrvr.h:1089
@ WD_USBD_STATUS_INAVLID_PIPE_FLAGS
[0xC0005000] USBD: Invalid pipe flags
Definition: windrvr.h:1447
@ WD_INVALID_IOCTL
[0x2000001f] Invalid IOCTL.
Definition: windrvr.h:1244
@ WD_TIME_OUT_EXPIRED
[0x20000015] Time Out Expired.
Definition: windrvr.h:1189
@ WD_SYSTEM_INTERNAL_ERROR
[0x20000007] Internal System Error
Definition: windrvr.h:1118
@ WD_USBD_STATUS_BUFFER_TOO_SMALL
[0xC0003000] USBD: Buffer too small
Definition: windrvr.h:1439
@ WD_USBD_STATUS_INSUFFICIENT_RESOURCES
[0xC0001000] USBD: Insufficient resources
Definition: windrvr.h:1430
@ WD_USBD_STATUS_DATA_OVERRUN
[0xC0000008] HC status: Data overrun
Definition: windrvr.h:1322
@ WD_ZERO_PACKET_SIZE
[0x20000004] Maximum packet size is zero
Definition: windrvr.h:1110
@ WD_USBD_STATUS_ERROR_SHORT_TRANSFER
[0x80000900] Returned when a short packet terminates the transfer
Definition: windrvr.h:1399
@ WD_USBD_STATUS_STALL_PID
[0xC0000004] HC status: PID stall
Definition: windrvr.h:1311
@ WD_USBD_STATUS_PID_CHECK_FAILURE
[0xC0000006] HC status: PID check failed
Definition: windrvr.h:1316
@ WD_USBD_STATUS_ISO_NA_LATE_USBPORT
[0xC0040000] The packet was submitted in time by the client but
Definition: windrvr.h:1475
@ WD_CANT_OBTAIN_PDO
[0x20000014] Obsolete
Definition: windrvr.h:1188
@ WD_USBD_STATUS_BABBLE_DETECTED
[0xC0000012] HC status: Babble detected
Definition: windrvr.h:1350
@ WD_USBD_STATUS_HALTED
[0xC0000000] Halted
Definition: windrvr.h:1292
@ WD_INSUFFICIENT_RESOURCES
[0x20000005] Insufficient resources.
Definition: windrvr.h:1112
@ WD_USBD_STATUS_FRAME_CONTROL_OWNED
[0xC0000C00] Returned by USBD if the frame length control for a given
Definition: windrvr.h:1412
@ WD_USBD_STATUS_BTSTUFF
[0xC0000002] HC status: Bit stuffing
Definition: windrvr.h:1305
@ WD_USBD_STATUS_BUFFER_OVERRUN
[0xC000000C] HC status: Buffer overrun
Definition: windrvr.h:1332
@ WD_USBD_STATUS_SET_CONFIG_FAILED
[0xC0002000] USBD: Set configuration failed
Definition: windrvr.h:1434
@ WD_IRP_CANCELED
[0x20000016] IRP Cancelled.
Definition: windrvr.h:1193
@ WD_INVALID_PIPE_NUMBER
[0x20000002] USB: Invalid Pipe Number.
Definition: windrvr.h:1103
@ WD_OPERATION_ALREADY_DONE
[0x20000011] Operation Already Done.
Definition: windrvr.h:1169
@ WD_USBD_STATUS_STATUS_NOT_MAPPED
[0xC0008000] USBD: Status not mapped
Definition: windrvr.h:1457
@ WD_STATUS_INVALID_WD_HANDLE
[0xffffffff]
Definition: windrvr.h:1090
@ WD_USBD_STATUS_NO_MEMORY
[0x80000100] USBD: Out of memory
Definition: windrvr.h:1368
DEBUG_SECTION
Definition: windrvr.h:991
@ S_MISC
Definition: windrvr.h:998
@ S_IO
Definition: windrvr.h:993
@ S_DMA
Definition: windrvr.h:997
@ S_LICENSE
Definition: windrvr.h:999
@ S_EVENT
Definition: windrvr.h:1005
@ S_INT
Definition: windrvr.h:995
@ S_USB
Definition: windrvr.h:1003
@ S_ALL
Definition: windrvr.h:992
@ S_KER_PLUG
Definition: windrvr.h:1004
@ S_MEM
Definition: windrvr.h:994
@ S_KER_BUF
Definition: windrvr.h:1007
@ S_KER_DRV
Definition: windrvr.h:1002
@ S_PCI
Definition: windrvr.h:996
@ S_PNP
Definition: windrvr.h:1000
@ S_IPC
Definition: windrvr.h:1006
@ S_CARD_REG
Definition: windrvr.h:1001
struct WD_VERSION WD_VERSION_V30
struct WD_LICENSE WD_LICENSE_V122
WD_PCI_SCAN_OPTIONS
Definition: windrvr.h:902
@ WD_PCI_SCAN_BY_TOPOLOGY
Definition: windrvr.h:904
@ WD_PCI_SCAN_DEFAULT
Definition: windrvr.h:903
@ WD_PCI_SCAN_INCLUDE_DOMAINS
Definition: windrvr.h:906
@ WD_PCI_SCAN_REGISTERED
Definition: windrvr.h:905
WD_TRANSFER_CMD
IN WD_TRANSFER_CMD and WD_Transfer() DWORD stands for 32 bits and QWORD is 64 bit.
Definition: windrvr.h:393
@ WM_SWORD
Write memory string word.
Definition: windrvr.h:429
@ WM_SBYTE
Write memory string byte.
Definition: windrvr.h:428
@ RP_SDWORD
Read port string dword.
Definition: windrvr.h:409
@ WM_BYTE
Write memory byte.
Definition: windrvr.h:419
@ WM_SQWORD
Write memory string quad word.
Definition: windrvr.h:432
@ RM_DWORD
Read memory dword.
Definition: windrvr.h:418
@ WP_DWORD
Write port dword.
Definition: windrvr.h:403
@ RP_BYTE
Read port byte.
Definition: windrvr.h:398
@ WM_SDWORD
Write memory string dword.
Definition: windrvr.h:430
@ RM_WORD
Read memory word.
Definition: windrvr.h:417
@ RM_SBYTE
Read memory string byte.
Definition: windrvr.h:425
@ WP_SQWORD
Write port string qword.
Definition: windrvr.h:414
@ RM_BYTE
Read memory byte.
Definition: windrvr.h:416
@ WP_SBYTE
Write port string byte.
Definition: windrvr.h:410
@ WP_SWORD
Write port string word.
Definition: windrvr.h:411
@ RM_SWORD
Read memory string word.
Definition: windrvr.h:426
@ CMD_MASK
Interrupt Mask.
Definition: windrvr.h:396
@ WM_DWORD
Write memory dword.
Definition: windrvr.h:421
@ CMD_NONE
No command.
Definition: windrvr.h:394
@ RP_DWORD
Read port dword.
Definition: windrvr.h:400
@ CMD_END
End command.
Definition: windrvr.h:395
@ WP_BYTE
Write port byte.
Definition: windrvr.h:401
@ RP_QWORD
Read port qword.
Definition: windrvr.h:404
@ WM_QWORD
Write memory qword.
Definition: windrvr.h:423
@ RM_SDWORD
Read memory string dword.
Definition: windrvr.h:427
@ RM_QWORD
Read memory qword.
Definition: windrvr.h:422
@ WP_WORD
Write port word.
Definition: windrvr.h:402
@ WP_SDWORD
Write port string dword.
Definition: windrvr.h:412
@ RM_SQWORD
Read memory string quad word.
Definition: windrvr.h:431
@ RP_SWORD
Read port string word.
Definition: windrvr.h:408
@ WM_WORD
Write memory word.
Definition: windrvr.h:420
@ RP_SBYTE
Read port string byte.
Definition: windrvr.h:407
@ WP_QWORD
Write port qword.
Definition: windrvr.h:405
@ RP_WORD
Read port word.
Definition: windrvr.h:399
@ RP_SQWORD
Read port string qword.
Definition: windrvr.h:413
#define INVALID_HANDLE_VALUE
Definition: windrvr.h:1583
@ WD_IPC_MAX_PROCS
Definition: windrvr.h:828
#define WD_MAX_KP_NAME_LENGTH
Definition: windrvr.h:60
#define WIN32
Definition: windrvr.h:187
#define WD_Close
Definition: windrvr.h:1871
#define WD_CloseLocal(h)
Definition: windrvr.h:1820
@ WD_IPC_UID_UNICAST
Definition: windrvr.h:841
@ WD_IPC_SUBGROUP_MULTICAST
Definition: windrvr.h:842
@ WD_IPC_MULTICAST
Definition: windrvr.h:843
WD_EVENT_OPTION
Definition: windrvr.h:1505
@ WD_ACCEPT_CONTROL
used in WD_EVENT_SEND (acknowledge)
Definition: windrvr.h:1507
@ WD_ACKNOWLEDGE
Definition: windrvr.h:1506
#define BZERO(buf)
Definition: windrvr.h:1579
WD_PCI_SCAN_CAPS_OPTIONS
Definition: windrvr.h:919
@ WD_PCI_SCAN_CAPS_BASIC
Scan basic PCI capabilities.
Definition: windrvr.h:920
@ WD_PCI_SCAN_CAPS_EXTENDED
Scan extended (PCIe) PCI capabilities.
Definition: windrvr.h:921
struct WD_DEBUG WD_DEBUG_V40
DWORD WD_BUS_TYPE
Definition: windrvr.h:708
UINT64 PHYS_ADDR
Definition: windrvr.h:386
struct WD_DEBUG_DUMP WD_DEBUG_DUMP_V40
@ INTERRUPT_MESSAGE
Message-Signaled Interrupts (MSI).
Definition: windrvr.h:628
@ INTERRUPT_CMD_RETURN_VALUE
Obsolete.
Definition: windrvr.h:627
@ INTERRUPT_LATCHED
Legacy Latched Interrupts .
Definition: windrvr.h:618
@ INTERRUPT_MESSAGE_X
Extended Message-Signaled Interrupts (MSI-X).
Definition: windrvr.h:629
@ INTERRUPT_CMD_COPY
Copy any data read in the kernel as a result of a read transfer command, and return it to the user wi...
Definition: windrvr.h:621
@ INTERRUPT_LEVEL_SENSITIVE
Legacy Level Sensitive Interrupts.
Definition: windrvr.h:619
@ INTERRUPT_CE_INT_ID
Obsolete.
Definition: windrvr.h:626
@ INTERRUPT_DONT_GET_MSI_MESSAGE
Linux Only.
Definition: windrvr.h:631
struct WD_PCI_SCAN_CAPS WD_PCI_SCAN_CAPS_V118
struct WD_DMA_PAGE WD_DMA_PAGE_V80
struct WD_EVENT WD_EVENT_V121
struct WD_IPC_REGISTER WD_IPC_REGISTER_V121
struct WD_KERNEL_PLUGIN WD_KERNEL_PLUGIN_V40
DWORD DLLCALLCONV check_secureBoot_enabled(void)
Checks whether the Secure Boot feature is enabled on the system.
void(DLLCALLCONV * DMA_TRANSACTION_CALLBACK)(PVOID pData)
Definition: windrvr.h:539
struct WD_PCI_SRIOV WD_PCI_SRIOV_V122
const char *DLLCALLCONV WD_DriverName(const char *sName)
Sets the name of the WinDriver kernel module, which will be used by the calling application.
unsigned __int64 UINT64
Definition: windrvr.h:318
#define REGKEY_BUFSIZE
Definition: windrvr.h:1722
struct WD_IPC_SEND WD_IPC_SEND_V121
@ WD_PCI_MAX_CAPS
Definition: windrvr.h:909
#define WD_PROCESS_NAME_LENGTH
Definition: windrvr.h:810
@ SLEEP_BUSY
Definition: windrvr.h:973
@ SLEEP_NON_BUSY
Definition: windrvr.h:973
@ WD_BUS_EISA
EISA, including ISA PnP.
Definition: windrvr.h:705
@ WD_BUS_ISA
ISA.
Definition: windrvr.h:704
@ WD_BUS_UNKNOWN
Unknown bus type.
Definition: windrvr.h:703
@ WD_BUS_PCI
PCI.
Definition: windrvr.h:706
@ WD_BUS_USB
USB.
Definition: windrvr.h:702
#define DLLCALLCONV
Definition: windrvr.h:32
WD_EVENT_ACTION
Definition: windrvr.h:1483
@ WD_POWER_SYSTEM_WORKING
Definition: windrvr.h:1492
@ WD_POWER_SYSTEM_SLEEPING3
Definition: windrvr.h:1495
@ WD_POWER_SYSTEM_HIBERNATE
Definition: windrvr.h:1496
@ WD_POWER_CHANGED_D0
Power states for the power management.
Definition: windrvr.h:1487
@ WD_OBSOLETE
Obsolete.
Definition: windrvr.h:1486
@ WD_POWER_SYSTEM_SLEEPING2
Definition: windrvr.h:1494
@ WD_POWER_CHANGED_D3
Definition: windrvr.h:1491
@ WD_POWER_SYSTEM_SHUTDOWN
Definition: windrvr.h:1497
@ WD_POWER_CHANGED_D2
Definition: windrvr.h:1490
@ WD_INSERT
Definition: windrvr.h:1484
@ WD_POWER_CHANGED_D1
Definition: windrvr.h:1489
@ WD_POWER_SYSTEM_SLEEPING1
Definition: windrvr.h:1493
@ WD_REMOVE
Definition: windrvr.h:1485
@ WD_IPC_UNICAST_MSG
Definition: windrvr.h:1498
@ WD_IPC_MULTICAST_MSG
Definition: windrvr.h:1499
@ WD_PCI_CARDS
Definition: windrvr.h:869
@ WD_EVENT_TYPE_IPC
Definition: windrvr.h:1524
@ WD_EVENT_TYPE_UNKNOWN
Definition: windrvr.h:1521
@ WD_EVENT_TYPE_USB
Definition: windrvr.h:1523
@ WD_EVENT_TYPE_PCI
Definition: windrvr.h:1522
UINT64 DMA_ADDR
Definition: windrvr.h:385
DWORD WD_EVENT_TYPE
Definition: windrvr.h:1526
struct WD_PCI_SCAN_CARDS WD_PCI_SCAN_CARDS_V124
WD_DMA_OPTIONS
Definition: windrvr.h:441
@ DMA_KERNEL_BUFFER_ALLOC
The system allocates a contiguous buffer.
Definition: windrvr.h:442
@ DMA_DISABLE_MERGE_ADJACENT_PAGES
Disable merge adjacent pages.
Definition: windrvr.h:491
@ DMA_TRANSACTION
Use this flag to use the DMA transaction mechanism.
Definition: windrvr.h:486
@ DMA_TO_DEVICE
memory pages are locked to be read by device
Definition: windrvr.h:462
@ DMA_KBUF_BELOW_16M
If DMA_KERNEL_BUFFER_ALLOC is used, this will make sure it is under 16M.
Definition: windrvr.h:445
@ DMA_ALLOW_NO_HCARD
Allow memory lock without hCard.
Definition: windrvr.h:470
@ DMA_FROM_DEVICE
memory pages are locked to be written by device
Definition: windrvr.h:459
@ DMA_GET_PREALLOCATED_BUFFERS_ONLY
Windows: Try to allocate buffers from preallocated buffers pool ONLY (if none of them are available,...
Definition: windrvr.h:482
@ DMA_GET_EXISTING_BUF
Get existing buffer by hDma handle.
Definition: windrvr.h:472
@ DMA_ALLOW_64BIT_ADDRESS
Use this value for devices that support 64-bit DMA addressing.
Definition: windrvr.h:467
@ DMA_OVERRIDE_CMA_VALIDATION
Linux: Override CMA validation checks for contiguous buffer locking.
Definition: windrvr.h:495
@ DMA_TO_FROM_DEVICE
memory pages are locked for both read and write
Definition: windrvr.h:464
@ DMA_LARGE_BUFFER
If DMA_LARGE_BUFFER is used, the maximum number of pages are dwPages, and not WD_DMA_PAGES.
Definition: windrvr.h:448
@ DMA_GPUDIRECT
Linux only.
Definition: windrvr.h:489
@ DMA_ALLOW_CACHE
Allow caching of contiguous memory.
Definition: windrvr.h:454
@ DMA_KERNEL_ONLY_MAP
Only map to kernel, dont map to user-mode.
Definition: windrvr.h:456
@ DMA_KBUF_ALLOC_SPECIFY_ADDRESS_WIDTH
When using this flag, the width of the address must be entered in the fourth byte of dwOptions and th...
Definition: windrvr.h:476
@ DMA_RESERVED_MEM
Definition: windrvr.h:474
@ WD_CARD_ITEMS
Definition: windrvr.h:790
@ WD_MATCH_EXCLUDE
Exclude if there is a match.
Definition: windrvr.h:520
unsigned int UINT32
Definition: windrvr.h:341
#define DEBUG_USER_BUF_LEN
Definition: windrvr.h:1039
struct WD_CARD_REGISTER WD_CARD_REGISTER_V118
WD_INTERRUPT_WAIT_RESULT
Definition: windrvr.h:645
@ INTERRUPT_INTERRUPTED
Wait was interrupted before an actual hardware interrupt was received.
Definition: windrvr.h:648
@ INTERRUPT_RECEIVED
Interrupt was received.
Definition: windrvr.h:646
@ INTERRUPT_STOPPED
Interrupt was disabled during wait.
Definition: windrvr.h:647
UINT32 KPTR
Definition: windrvr.h:376
#define WD_Open
Definition: windrvr.h:1872
struct WD_IPC_PROCESS WD_IPC_PROCESS_V121
WD_OS_INFO DLLCALLCONV get_os_type(void)
Retrieves the type of the operating system in section.
#define PAD_TO_64(pName)
Definition: windrvr_usb.h:15