Jungo WinDriver  
Official Documentation
wdc_lib.h
Go to the documentation of this file.
1 /* @JUNGO_COPYRIGHT@ */
2 
3 #ifndef _WDC_LIB_H_
4 #define _WDC_LIB_H_
5 
6 /*********************************************************************
7 * File: wdc_lib.h - Shared WD card (WDC) library header. *
8 * This file defines the WDC library's high-level *
9 * interface *
10 **********************************************************************/
11 
12 #if defined(__KERNEL__)
13  #include "kpstdlib.h"
14 #endif
15 #include "windrvr.h"
16 #include "windrvr_int_thread.h"
17 #include "windrvr_events.h"
18 #include "bits.h"
19 #include "pci_regs.h"
20 
21 #ifdef __cplusplus
22  extern "C" {
23 #endif
24 /**************************************************************
25  General definitions
26  **************************************************************/
27 
28 #define MAX_NAME 128
29 #define MAX_DESC 128
30 #define MAX_NAME_DISPLAY 22
31 
33 typedef void *WDC_DEVICE_HANDLE;
34 
35 #ifndef __KERNEL__
37 typedef struct {
38  DWORD dwNumDevices;
39  WD_PCI_ID deviceId[WD_PCI_CARDS];
40  WD_PCI_SLOT deviceSlot[WD_PCI_CARDS];
43 #endif
44 
46 typedef struct {
47  DWORD dwNumCaps;
51 
52 /* Driver open options */
53 /* Basic driver open flags */
54 #define WDC_DRV_OPEN_CHECK_VER 0x1
57 #define WDC_DRV_OPEN_REG_LIC 0x2
58 /* Convenient driver open options */
59 #define WDC_DRV_OPEN_BASIC 0x0
63 #define WDC_DRV_OPEN_KP WDC_DRV_OPEN_BASIC
65 #define WDC_DRV_OPEN_ALL (WDC_DRV_OPEN_CHECK_VER | WDC_DRV_OPEN_REG_LIC)
66 #if defined(__KERNEL__)
67  #define WDC_DRV_OPEN_DEFAULT WDC_DRV_OPEN_KP
68 #else
69  #define WDC_DRV_OPEN_DEFAULT WDC_DRV_OPEN_ALL
70 #endif
71 typedef DWORD WDC_DRV_OPEN_OPTIONS;
72 
73 /* Debug information display options */
74 #define WDC_DBG_OUT_DBM 0x1
76 #define WDC_DBG_OUT_FILE 0x2
79 #define WDC_DBG_LEVEL_ERR 0x10
80 #define WDC_DBG_LEVEL_TRACE 0x20
83 #define WDC_DBG_NONE 0x100
86 #define WDC_DBG_DEFAULT (WDC_DBG_OUT_DBM | WDC_DBG_LEVEL_TRACE)
87 
88 #define WDC_DBG_DBM_ERR (WDC_DBG_OUT_DBM | WDC_DBG_LEVEL_ERR)
89 #define WDC_DBG_DBM_TRACE (WDC_DBG_OUT_DBM | WDC_DBG_LEVEL_TRACE)
90 
91 #if !defined(__KERNEL__)
92  #define WDC_DBG_FILE_ERR (WDC_DBG_OUT_FILE | WDC_DBG_LEVEL_ERR)
93  #define WDC_DBG_FILE_TRACE (WDC_DBG_OUT_FILE | WDC_DBG_LEVEL_TRACE)
94 
95  #define WDC_DBG_DBM_FILE_ERR \
96  (WDC_DBG_OUT_DBM | WDC_DBG_OUT_FILE | WDC_DBG_LEVEL_ERR)
97  #define WDC_DBG_DBM_FILE_TRACE \
98  (WDC_DBG_OUT_DBM | WDC_DBG_OUT_FILE | WDC_DBG_LEVEL_TRACE)
99 
100  #define WDC_DBG_FULL \
101  (WDC_DBG_OUT_DBM | WDC_DBG_OUT_FILE | WDC_DBG_LEVEL_TRACE)
102 #else
103  #define WDC_DBG_FULL (WDC_DBG_OUT_DBM | WDC_DBG_LEVEL_TRACE)
104 #endif
105 
106 typedef DWORD WDC_DBG_OPTIONS;
107 
109 #define WDC_SLEEP_BUSY 0
110 #define WDC_SLEEP_NON_BUSY SLEEP_NON_BUSY
111 typedef DWORD WDC_SLEEP_OPTIONS;
112 
113 /* -----------------------------------------------
114  Memory / I/O / Registers
115  ----------------------------------------------- */
116 typedef enum {
121 
123 typedef enum {
124  WDC_ADDR_RW_DEFAULT = 0x0,
129 
130 /* Memory/I/O address size and access mode definitions (size - in bytes) */
131 #define WDC_SIZE_8 ((DWORD)sizeof(BYTE))
132 #define WDC_SIZE_16 ((DWORD)sizeof(WORD))
133 #define WDC_SIZE_32 ((DWORD)sizeof(UINT32))
134 #define WDC_SIZE_64 ((DWORD)sizeof(UINT64))
135 typedef DWORD WDC_ADDR_SIZE;
136 
137 typedef enum {
143 
144 #define WDC_ADDR_MODE_TO_SIZE(mode) (DWORD)mode
145 #define WDC_ADDR_SIZE_TO_MODE(size) (((size) > WDC_SIZE_32) ? WDC_MODE_64 : \
146  ((size) > WDC_SIZE_16) ? WDC_MODE_32 : \
147  ((size) > WDC_SIZE_8) ? WDC_MODE_16 : WDC_MODE_8)
148 
150 #define WDC_AD_CFG_SPACE 0xFF
151 
152 /**************************************************************
153  Function Prototypes
154  **************************************************************/
155 /* -----------------------------------------------
156  General
157  ----------------------------------------------- */
170 
179 
187 
197 DWORD DLLCALLCONV WDC_Sleep(_In_ DWORD dwMicroSecs,
198  _In_ WDC_SLEEP_OPTIONS options);
199 
219 DWORD DLLCALLCONV WDC_Version(_Outptr_ CHAR *pcVersion, _In_ DWORD dwLen,
220  _Outptr_ DWORD *pdwVersion);
221 
251  _In_ const CHAR *pcLicense);
252 
266 
270 #ifndef __KERNEL__
295 DWORD DLLCALLCONV WDC_PciScanDevices(_In_ DWORD dwVendorId,
296  _In_ DWORD dwDeviceId, _Outptr_ WDC_PCI_SCAN_RESULT *pPciScanResult);
297 
323  _In_ DWORD dwDeviceId, _Outptr_ WDC_PCI_SCAN_RESULT *pPciScanResult);
324 
350  _In_ DWORD dwDeviceId, _Outptr_ WDC_PCI_SCAN_RESULT *pPciScanResult);
351 #endif
352 
371  _Outptr_ DWORD *pdwOffset);
388  _Outptr_ WDC_PCI_HEADER_TYPE *pHeaderType);
389 
406  _In_ DWORD dwCapId, _Outptr_ WDC_PCI_SCAN_CAPS_RESULT *pScanCapsResult);
407 
425  _In_ DWORD dwCapId, _Outptr_ WDC_PCI_SCAN_CAPS_RESULT *pScanCapsResult);
426 
445  _In_ DWORD dwCapId, _Outptr_ WDC_PCI_SCAN_CAPS_RESULT *pScanCapsResult);
446 
457 
468 
472 #ifndef __KERNEL__
487 #endif
488 
512  _In_ DWORD dwNumVFs);
513 
526 
541  _Outptr_ DWORD *pdwNumVFs);
542 
546 #if !defined(__KERNEL__)
577  _In_ const WD_PCI_CARD_INFO *pDeviceInfo, _In_ const PVOID pDevCtx);
578 
608  _In_ const WD_CARD *pDeviceInfo, _In_ const PVOID pDevCtx);
609 
623 
635 #endif
636 
671  _In_ WD_TRANSFER *pTransCmds, _In_ DWORD dwCmds, _In_ BOOL fForceCleanup);
672 
691  _In_ const CHAR *pcKPDriverName, _In_ PVOID pKPOpenData);
692 
718  _In_ DWORD dwMsg, _Inout_ PVOID pData, _Outptr_ PDWORD pdwResult);
719 
728 #define WDC_ReadMem8(addr, off) *(volatile BYTE *)((UPTR)(addr) + (UPTR)(off))
729 
733 #define WDC_ReadMem16(addr, off) \
734  *(volatile WORD *)((UPTR)(addr) + (UPTR)(off))
735 
739 #define WDC_ReadMem32(addr, off) \
740  *(volatile UINT32 *)((UPTR)(addr) + (UPTR)(off))
741 
745 #define WDC_ReadMem64(addr, off) \
746  *(volatile UINT64 *)((UPTR)(addr) + (UPTR)(off))
747 
748 
752 #define WDC_WriteMem8(addr, off, val) \
753  *(volatile BYTE * )(((UPTR)(addr) + (UPTR)(off))) = (val)
754 
758 #define WDC_WriteMem16(addr, off, val) \
759  *(volatile WORD * )(((UPTR)(addr) + (UPTR)(off))) = (val)
760 
764 #define WDC_WriteMem32(addr, off, val) \
765  *(volatile UINT32 *)(((UPTR)(addr) + (UPTR)(off))) = (val)
766 
770 #define WDC_WriteMem64(addr, off, val) \
771  *(volatile UINT64 *)(((UPTR)(addr) + (UPTR)(off))) = (val)
772 
773 
791  _In_ DWORD dwAddrSpace, _In_ KPTR dwOffset, _Outptr_ BYTE *pbVal);
792 
808  _In_ DWORD dwAddrSpace, _In_ KPTR dwOffset, _Outptr_ WORD *pwVal);
809 
825  _In_ DWORD dwAddrSpace, _In_ KPTR dwOffset, _Outptr_ UINT32 *pdwVal);
826 
842  _In_ DWORD dwAddrSpace, _In_ KPTR dwOffset, _Outptr_ UINT64 *pqwVal);
843 
858  _In_ DWORD dwAddrSpace, _In_ KPTR dwOffset, _In_ BYTE bVal);
859 
874  _In_ DWORD dwAddrSpace, _In_ KPTR dwOffset, _In_ WORD wVal);
875 
890  _In_ DWORD dwAddrSpace, _In_ KPTR dwOffset, _In_ UINT32 dwVal);
891 
906  _In_ DWORD dwAddrSpace, _In_ KPTR dwOffset, _In_ UINT64 qwVal);
907 
929  _In_ DWORD dwAddrSpace,_In_ KPTR dwOffset, _In_ DWORD dwBytes,
930  _Outptr_ PVOID pData, _In_ WDC_ADDR_MODE mode,
931  _In_ WDC_ADDR_RW_OPTIONS options);
932 
953  _In_ DWORD dwAddrSpace, _In_ KPTR dwOffset, _In_ DWORD dwBytes,
954  _In_ PVOID pData, _In_ WDC_ADDR_MODE mode,
955  _In_ WDC_ADDR_RW_OPTIONS options);
956 
958 /* @snippet highlevel_examples.c WDC_ReadAddrBlock8 */
959 #define WDC_ReadAddrBlock8(hDev,dwAddrSpace,dwOffset,dwBytes,pData,options) \
960  WDC_ReadAddrBlock(hDev, dwAddrSpace, dwOffset, dwBytes, pData, \
961  WDC_MODE_8, options)
962 
964 /* @snippet highlevel_examples.c WDC_ReadAddrBlock16 */
965 #define WDC_ReadAddrBlock16(hDev,dwAddrSpace,dwOffset,dwBytes,pData,options) \
966  WDC_ReadAddrBlock(hDev, dwAddrSpace, dwOffset, dwBytes, pData, \
967  WDC_MODE_16, options)
968 
970 /* @snippet highlevel_examples.c WDC_ReadAddrBlock32 */
971 #define WDC_ReadAddrBlock32(hDev,dwAddrSpace,dwOffset,dwBytes,pData,options) \
972  WDC_ReadAddrBlock(hDev, dwAddrSpace, dwOffset, dwBytes, pData, \
973  WDC_MODE_32, options)
974 
976 /* @snippet highlevel_examples.c WDC_ReadAddrBlock64 */
977 #define WDC_ReadAddrBlock64(hDev,dwAddrSpace,dwOffset,dwBytes,pData,options) \
978  WDC_ReadAddrBlock(hDev, dwAddrSpace, dwOffset, dwBytes, pData, \
979  WDC_MODE_64, options)
980 
982 /* @snippet highlevel_examples.c WDC_WriteAddrBlock8 */
983 #define WDC_WriteAddrBlock8(hDev,dwAddrSpace,dwOffset,dwBytes,pData,options) \
984  WDC_WriteAddrBlock(hDev, dwAddrSpace, dwOffset, dwBytes, pData, \
985  WDC_MODE_8, options)
986 
988 /* @snippet highlevel_examples.c WDC_WriteAddrBlock16 */
989 #define WDC_WriteAddrBlock16(hDev,dwAddrSpace,dwOffset,dwBytes,pData,options) \
990  WDC_WriteAddrBlock(hDev, dwAddrSpace, dwOffset, dwBytes, pData, \
991  WDC_MODE_16, options)
992 
994 /* @snippet highlevel_examples.c WDC_WriteAddrBlock32 */
995 #define WDC_WriteAddrBlock32(hDev,dwAddrSpace,dwOffset,dwBytes,pData,options) \
996  WDC_WriteAddrBlock(hDev, dwAddrSpace, dwOffset, dwBytes, pData, \
997  WDC_MODE_32, options)
998 
1000 /* @snippet highlevel_examples.c WDC_WriteAddrBlock64 */
1001 #define WDC_WriteAddrBlock64(hDev,dwAddrSpace,dwOffset,dwBytes,pData,options) \
1002  WDC_WriteAddrBlock(hDev, dwAddrSpace, dwOffset, dwBytes, pData, \
1003  WDC_MODE_64, options)
1004 
1016  _In_ DWORD dwNumTrans);
1017 
1030  _In_ DWORD dwAddrSpace);
1031 
1056  _In_ DWORD dwOffset, _Outptr_ PVOID pData, _In_ DWORD dwBytes);
1057 
1075  _In_ DWORD dwOffset, _In_ PVOID pData, _In_ DWORD dwBytes);
1076 
1077 
1096  _In_ DWORD dwOffset, _Outptr_ PVOID pData, _In_ DWORD dwBytes);
1097 
1113  _In_ DWORD dwOffset, _In_ PVOID pData, _In_ DWORD dwBytes);
1114 
1135  _In_ DWORD dwOffset, _Outptr_ BYTE *pbVal);
1136 
1154  _In_ DWORD dwOffset, _Outptr_ WORD *pwVal);
1155 
1173  _In_ DWORD dwOffset, _Outptr_ UINT32 *pdwVal);
1174 
1192  _In_ DWORD dwOffset, _Outptr_ UINT64 *pqwVal);
1193 
1210  _In_ DWORD dwOffset, _In_ BYTE bVal);
1211 
1228  _In_ DWORD dwOffset, _In_ WORD wVal);
1229 
1247  _In_ DWORD dwOffset, _In_ UINT32 dwVal);
1248 
1265  _In_ DWORD dwOffset, _In_ UINT64 qwVal);
1266 
1285  _In_ DWORD dwOffset, _Outptr_ BYTE *pbVal);
1286 
1302  _In_ DWORD dwOffset, _Outptr_ WORD *pwVal);
1303 
1319  _In_ DWORD dwOffset, _Outptr_ UINT32 *pdwVal);
1320 
1336  _In_ DWORD dwOffset, _Outptr_ UINT64 *pqwVal);
1337 
1352  _In_ DWORD dwOffset, _In_ BYTE bVal);
1353 
1368  _In_ DWORD dwOffset, _In_ WORD wVal);
1369 
1384  _In_ DWORD dwOffset, _In_ UINT32 dwVal);
1385 
1400  _In_ DWORD dwOffset, _In_ UINT64 qwVal);
1401 
1405 #if !defined(__KERNEL__)
1454  _Outptr_ PVOID *ppBuf, _In_ DWORD dwOptions, _In_ DWORD dwDMABufSize,
1455  _Outptr_ WD_DMA **ppDma);
1456 
1493  _In_ PVOID pBuf, _In_ DWORD dwOptions, _In_ DWORD dwDMABufSize,
1494  _Outptr_ WD_DMA **ppDma);
1495 
1496 
1497 typedef struct {
1499  DWORD dwNumCmds;
1500  DWORD dwOptions;
1502  PVOID pData;
1503  BOOL fUseKP;
1505 
1551  _Outptr_ PVOID *ppBuf, _In_ DWORD dwOptions, _In_ DWORD dwDMABufSize,
1552  _Outptr_ WD_DMA **ppDma, _In_ WDC_INTERRUPT_PARAMS *pInterruptParams,
1553  _In_ DWORD dwAlignment);
1554 
1597  _In_ PVOID pBuf, _In_ DWORD dwOptions, _In_ DWORD dwDMABufSize,
1598  _Outptr_ WD_DMA **ppDma, _In_ WDC_INTERRUPT_PARAMS *pInterruptParams,
1599  _In_ DWORD dwMaxTransferSize, _In_ DWORD dwTransferElementSize);
1600 
1629  _In_ DMA_TRANSACTION_CALLBACK funcDMATransactionCallback,
1630  _In_ PVOID DMATransactionCallbackCtx);
1631 
1658  _In_ BOOL fRunCallback);
1659 
1679 
1700 
1738  _In_ PHYS_ADDR qwAddr, _Outptr_ PVOID *ppBuf, _In_ DWORD dwOptions,
1739  _In_ DWORD dwDMABufSize, _Outptr_ WD_DMA **ppDma);
1740 
1741 
1762 
1765 #define WDC_DMAGetGlobalHandle(pDma) ((pDma)->hDma)
1766 
1782 DWORD DLLCALLCONV WDC_DMABufGet(_In_ DWORD hDma, _Outptr_ WD_DMA **ppDma);
1783 
1803 
1823 #endif
1824 /* -----------------------------------------------
1825  Interrupts
1826  ----------------------------------------------- */
1827 #if !defined(__KERNEL__)
1965  _In_ WD_TRANSFER *pTransCmds, _In_ DWORD dwNumCmds, _In_ DWORD dwOptions,
1966  _In_ INT_HANDLER funcIntHandler, _In_ PVOID pData, _In_ BOOL fUseKP);
1967 
1984 
1985 #endif
1986 
2002 
2017 const CHAR * DLLCALLCONV WDC_IntType2Str(_In_ DWORD dwIntType);
2018 
2023 #if !defined(__KERNEL__)
2080  _In_ DWORD dwActions, _In_ EVENT_HANDLER funcEventHandler,
2081  _In_ PVOID pData, _In_ BOOL fUseKP);
2082 
2097 
2098 #endif
2099 
2114 
2156  _In_ const CHAR *pcDbgFile);
2157 
2169 void DLLCALLCONV WDC_Err(const CHAR *format, ...);
2170 
2181 void DLLCALLCONV WDC_Trace(const CHAR *format, ...);
2182 
2183 #ifdef __cplusplus
2184 }
2185 #endif
2186 
2187 #endif /* _WDC_LIB_H_ */
2188 
WDC_PCI_HEADER_TYPE
Definition: pci_regs.h:15
INT_HANDLER funcIntHandler
Definition: wdc_lib.h:1501
WD_TRANSFER * pTransCmds
Definition: wdc_lib.h:1498
DWORD dwNumCaps
Number of matching PCI capabilities.
Definition: wdc_lib.h:47
PCI capabilities scan results.
Definition: wdc_lib.h:46
DWORD dwNumDevices
Number of matching devices.
Definition: wdc_lib.h:38
PCI scan results.
Definition: wdc_lib.h:37
DWORD DLLCALLCONV WDC_DMAReservedBufLock(_In_ WDC_DEVICE_HANDLE hDev, _In_ PHYS_ADDR qwAddr, _Outptr_ PVOID *ppBuf, _In_ DWORD dwOptions, _In_ DWORD dwDMABufSize, _Outptr_ WD_DMA **ppDma)
Locks a physical reserved memory buffer for DMA and returns the corresponding user mode address of lo...
DWORD WDC_SLEEP_OPTIONS
Definition: wdc_lib.h:111
#define WDC_SIZE_64
Definition: wdc_lib.h:134
DWORD DLLCALLCONV WDC_DMASGBufLock(_In_ WDC_DEVICE_HANDLE hDev, _In_ PVOID pBuf, _In_ DWORD dwOptions, _In_ DWORD dwDMABufSize, _Outptr_ WD_DMA **ppDma)
Locks a pre-allocated user-mode memory buffer for DMA and returns the corresponding physical mappings...
DWORD DLLCALLCONV WDC_IsaDeviceOpen(_Outptr_ WDC_DEVICE_HANDLE *phDev, _In_ const WD_CARD *pDeviceInfo, _In_ const PVOID pDevCtx)
Allocates and initializes a WDC ISA device structure, registers the device with WinDriver,...
DWORD DLLCALLCONV WDC_PciWriteCfg8(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwOffset, _In_ BYTE bVal)
Writes 1 byte (8 bits) to a specified offset in a PCI device's configuration space or a PCI Express d...
DWORD DLLCALLCONV WDC_Sleep(_In_ DWORD dwMicroSecs, _In_ WDC_SLEEP_OPTIONS options)
Delays execution for the specified duration of time (in microseconds).
DWORD DLLCALLCONV WDC_IntEnable(_In_ WDC_DEVICE_HANDLE hDev, _In_ WD_TRANSFER *pTransCmds, _In_ DWORD dwNumCmds, _In_ DWORD dwOptions, _In_ INT_HANDLER funcIntHandler, _In_ PVOID pData, _In_ BOOL fUseKP)
Enables interrupt handling for the device.
DWORD DLLCALLCONV WDC_DMATransactionUninit(_In_ WD_DMA *pDma)
Unlocks and frees the memory allocated for a DMA buffer transaction by a previous call to WDC_DMATran...
DWORD DLLCALLCONV WDC_PciReadCfgBySlot64(_In_ WD_PCI_SLOT *pPciSlot, _In_ DWORD dwOffset, _Outptr_ UINT64 *pqwVal)
Reads 8 bytes (64 bits) from a specified offset in a PCI device's configuration space or a PCI Expres...
DWORD DLLCALLCONV WDC_PciScanDevices(_In_ DWORD dwVendorId, _In_ DWORD dwDeviceId, _Outptr_ WDC_PCI_SCAN_RESULT *pPciScanResult)
Scans the PCI bus for all devices with the specified vendor and device ID combination and returns inf...
DWORD DLLCALLCONV WDC_DMASyncIo(_In_ WD_DMA *pDma)
Synchronizes the I/O caches with the DMA buffer, by flushing the data from the I/O caches and updatin...
DWORD WDC_DRV_OPEN_OPTIONS
Definition: wdc_lib.h:71
DWORD WDC_CardCleanupSetup(_In_ WDC_DEVICE_HANDLE hDev, _In_ WD_TRANSFER *pTransCmds, _In_ DWORD dwCmds, _In_ BOOL fForceCleanup)
Sets a list of transfer cleanup commands to be performed for the specified card on any of the followi...
DWORD DLLCALLCONV WDC_PciReadCfgBySlot16(_In_ WD_PCI_SLOT *pPciSlot, _In_ DWORD dwOffset, _Outptr_ WORD *pwVal)
Reads 2 bytes (16 bits) from a specified offset in a PCI device's configuration space or a PCI Expres...
void DLLCALLCONV WDC_Trace(const CHAR *format,...)
Displays debug trace messages according to the WDC debug options.
DWORD DLLCALLCONV WDC_MultiTransfer(_In_ WD_TRANSFER *pTransCmds, _In_ DWORD dwNumTrans)
Performs a group of memory and/or I/O read/write transfers.
DWORD DLLCALLCONV WDC_PciSriovDisable(_In_ WDC_DEVICE_HANDLE hDev)
Disables SR-IOV for a supported device and removes all the assigned VFs.
void DLLCALLCONV WDC_Err(const CHAR *format,...)
Displays debug error messages according to the WDC debug options.
const CHAR *DLLCALLCONV WDC_IntType2Str(_In_ DWORD dwIntType)
Converts interrupt type to string.
DWORD DLLCALLCONV WDC_WriteAddr16(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwAddrSpace, _In_ KPTR dwOffset, _In_ WORD wVal)
writes 2 byte (16 bits) to a specified memory or I/O address.
DWORD DLLCALLCONV WDC_PciGetHeaderType(_In_ WDC_DEVICE_HANDLE hDev, _Outptr_ WDC_PCI_HEADER_TYPE *pHeaderType)
Retrieves the PCI device's configuration space header type.
DWORD DLLCALLCONV WDC_DMATransactionSGInit(_In_ WDC_DEVICE_HANDLE hDev, _In_ PVOID pBuf, _In_ DWORD dwOptions, _In_ DWORD dwDMABufSize, _Outptr_ WD_DMA **ppDma, _In_ WDC_INTERRUPT_PARAMS *pInterruptParams, _In_ DWORD dwMaxTransferSize, _In_ DWORD dwTransferElementSize)
Initializes the transaction and locks a pre-allocated user-mode memory buffer for DMA.
DWORD DLLCALLCONV WDC_IsaDeviceClose(_In_ WDC_DEVICE_HANDLE hDev)
Uninitializes a WDC ISA device structure and frees the memory allocated for it.
DWORD DLLCALLCONV WDC_SetDebugOptions(_In_ WDC_DBG_OPTIONS dbgOptions, _In_ const CHAR *pcDbgFile)
Sets debug options for the WDC library - see the description of WDC_DBG_OPTIONS for details regarding...
WDC_ADDR_MODE
Definition: wdc_lib.h:137
@ WDC_MODE_64
Definition: wdc_lib.h:141
@ WDC_MODE_32
Definition: wdc_lib.h:140
@ WDC_MODE_8
Definition: wdc_lib.h:138
@ WDC_MODE_16
Definition: wdc_lib.h:139
DWORD DLLCALLCONV WDC_PciGetExpressOffset(_In_ WDC_DEVICE_HANDLE hDev, _Outptr_ DWORD *pdwOffset)
Retrieves the PCI Express configuration registers' offset in the device's configuration space.
DWORD DLLCALLCONV WDC_DMATransactionRelease(_In_ WD_DMA *pDma)
Terminates a specified DMA transaction without deleting the associated WD_DMA transaction structure.
WDC_DIRECTION
Definition: wdc_lib.h:116
@ WDC_READ_WRITE
Definition: wdc_lib.h:119
@ WDC_READ
Definition: wdc_lib.h:118
@ WDC_WRITE
Definition: wdc_lib.h:117
DWORD DLLCALLCONV WDC_DMATransactionExecute(_Inout_ WD_DMA *pDma, _In_ DMA_TRANSACTION_CALLBACK funcDMATransactionCallback, _In_ PVOID DMATransactionCallbackCtx)
Begins the execution of a specified DMA transaction.
DWORD DLLCALLCONV WDC_PciDeviceOpen(_Outptr_ WDC_DEVICE_HANDLE *phDev, _In_ const WD_PCI_CARD_INFO *pDeviceInfo, _In_ const PVOID pDevCtx)
Allocates and initializes a WDC PCI device structure, registers the device with WinDriver,...
DWORD DLLCALLCONV WDC_DMASyncCpu(_In_ WD_DMA *pDma)
Synchronizes the cache of all CPUs with the DMA buffer, by flushing the data from the CPU caches.
DWORD DLLCALLCONV WDC_PciWriteCfg64(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwOffset, _In_ UINT64 qwVal)
Writes 8 bytes (64 bits) to a specified offset in a PCI device's configuration space or a PCI Express...
DWORD DLLCALLCONV WDC_PciWriteCfgBySlot64(_In_ WD_PCI_SLOT *pPciSlot, _In_ DWORD dwOffset, _In_ UINT64 qwVal)
writes 8 bytes (64 bits) to a specified offset in a PCI device's configuration space or a PCI Express...
PVOID DLLCALLCONV WDC_GetDevContext(_In_ WDC_DEVICE_HANDLE hDev)
Returns the device's user context information.
DWORD DLLCALLCONV WDC_ReadAddr8(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwAddrSpace, _In_ KPTR dwOffset, _Outptr_ BYTE *pbVal)
Read/write a device's address space (8/16/32/64 bits)
DWORD DLLCALLCONV WDC_ReadAddrBlock(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwAddrSpace, _In_ KPTR dwOffset, _In_ DWORD dwBytes, _Outptr_ PVOID pData, _In_ WDC_ADDR_MODE mode, _In_ WDC_ADDR_RW_OPTIONS options)
Reads a block of data from the device.
DWORD DLLCALLCONV WDC_CallKerPlug(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwMsg, _Inout_ PVOID pData, _Outptr_ PDWORD pdwResult)
Sends a message from a user-mode application to a Kernel PlugIn driver.
DWORD DLLCALLCONV WDC_WriteAddrBlock(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwAddrSpace, _In_ KPTR dwOffset, _In_ DWORD dwBytes, _In_ PVOID pData, _In_ WDC_ADDR_MODE mode, _In_ WDC_ADDR_RW_OPTIONS options)
Writes a block of data to the device.
DWORD DLLCALLCONV WDC_PciSriovGetNumVFs(_In_ WDC_DEVICE_HANDLE hDev, _Outptr_ DWORD *pdwNumVFs)
Gets the number of virtual functions assigned to a supported device.
DWORD DLLCALLCONV WDC_DriverClose(void)
Closes the WDC WinDriver handle (acquired and stored by a previous call to WDC_DriverOpen()) and unin...
DWORD DLLCALLCONV WDC_PciReadCfg(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwOffset, _Outptr_ PVOID pData, _In_ DWORD dwBytes)
Identify device by handle.
DWORD DLLCALLCONV WDC_DMATransactionContigInit(_In_ WDC_DEVICE_HANDLE hDev, _Outptr_ PVOID *ppBuf, _In_ DWORD dwOptions, _In_ DWORD dwDMABufSize, _Outptr_ WD_DMA **ppDma, _In_ WDC_INTERRUPT_PARAMS *pInterruptParams, _In_ DWORD dwAlignment)
Initializes the transaction, allocates a contiguous DMA buffer, locks it in physical memory,...
DWORD DLLCALLCONV WDC_DMABufUnlock(_In_ WD_DMA *pDma)
Unlocks and frees the memory allocated for a DMA buffer by a previous call to WDC_DMAContigBufLock(),...
DWORD DLLCALLCONV WDC_PciWriteCfgBySlot(_In_ WD_PCI_SLOT *pPciSlot, _In_ DWORD dwOffset, _In_ PVOID pData, _In_ DWORD dwBytes)
Write data to a specified offset in a PCI device's configuration space or a PCI Express device's exte...
#define WDC_SIZE_16
Definition: wdc_lib.h:132
BOOL DLLCALLCONV WDC_IntIsEnabled(_In_ WDC_DEVICE_HANDLE hDev)
Checks if a device's interrupts are currently enabled.
DWORD DLLCALLCONV WDC_PciGetExpressGen(_In_ WDC_DEVICE_HANDLE hDev)
Retrieves the PCI Express generation of a device.
DWORD DLLCALLCONV WDC_PciDeviceClose(_In_ WDC_DEVICE_HANDLE hDev)
Uninitializes a WDC PCI device structure and frees the memory allocated for it.
DWORD DLLCALLCONV WDC_WriteAddr32(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwAddrSpace, _In_ KPTR dwOffset, _In_ UINT32 dwVal)
writes 4 byte (32 bits) to a specified memory or I/O address.
DWORD DLLCALLCONV WDC_EventRegister(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwActions, _In_ EVENT_HANDLER funcEventHandler, _In_ PVOID pData, _In_ BOOL fUseKP)
Registers the application to receive Plug-and-Play and power management events notifications for the ...
HANDLE DLLCALLCONV WDC_GetWDHandle(void)
Get a handle to WinDriver.
DWORD WDC_ADDR_SIZE
Definition: wdc_lib.h:135
DWORD DLLCALLCONV WDC_DMABufGet(_In_ DWORD hDma, _Outptr_ WD_DMA **ppDma)
Retrieves a contiguous DMA buffer which was allocated by another process.
DWORD DLLCALLCONV WDC_IntDisable(_In_ WDC_DEVICE_HANDLE hDev)
Disables interrupt interrupt handling for the device, pursuant to a previous call to WDC_IntEnable()
DWORD DLLCALLCONV WDC_PciScanCaps(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwCapId, _Outptr_ WDC_PCI_SCAN_CAPS_RESULT *pScanCapsResult)
Scans the basic PCI capabilities of the given device for the specified capability (or for all capabil...
DWORD DLLCALLCONV WDC_PciReadCfg16(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwOffset, _Outptr_ WORD *pwVal)
Reads 2 bytes (16 bits) from a specified offset in a PCI device's configuration space or a PCI Expres...
BOOL DLLCALLCONV WDC_AddrSpaceIsActive(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwAddrSpace)
Checks if the specified memory or I/O address space is active ,i.e., if its size is not zero.
DWORD DLLCALLCONV WDC_PciWriteCfgBySlot16(_In_ WD_PCI_SLOT *pPciSlot, _In_ DWORD dwOffset, _In_ WORD wVal)
writes 2 bytes (16 bits) to a specified offset in a PCI device's configuration space or a PCI Express...
DWORD DLLCALLCONV WDC_KernelPlugInOpen(_In_ WDC_DEVICE_HANDLE hDev, _In_ const CHAR *pcKPDriverName, _In_ PVOID pKPOpenData)
Opens a handle to a Kernel PlugIn driver.
DWORD DLLCALLCONV WDC_PciGetDeviceInfo(_Inout_ WD_PCI_CARD_INFO *pDeviceInfo)
Retrieves a PCI device's resources information (memory and I/O ranges and interrupt information).
#define WDC_SIZE_8
Definition: wdc_lib.h:131
DWORD DLLCALLCONV WDC_DMAContigBufLock(_In_ WDC_DEVICE_HANDLE hDev, _Outptr_ PVOID *ppBuf, _In_ DWORD dwOptions, _In_ DWORD dwDMABufSize, _Outptr_ WD_DMA **ppDma)
Allocates a contiguous DMA buffer, locks it in physical memory, and returns mappings of the allocated...
DWORD DLLCALLCONV WDC_PciReadCfg8(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwOffset, _Outptr_ BYTE *pbVal)
Read/write 8/16/32/64 bits from the PCI configuration space.
DWORD DLLCALLCONV WDC_PciReadCfg64(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwOffset, _Outptr_ UINT64 *pqwVal)
Reads 8 bytes (64 bits) from a specified offset in a PCI device's configuration space or a PCI Expres...
DWORD DLLCALLCONV WDC_ReadAddr16(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwAddrSpace, _In_ KPTR dwOffset, _Outptr_ WORD *pwVal)
reads 2 byte (16 bits) from a specified memory or I/O address.
DWORD DLLCALLCONV WDC_DMATransferCompletedAndCheck(_Inout_ WD_DMA *pDma, _In_ BOOL fRunCallback)
Notifies WinDriver that a device's DMA transfer operation is completed.
DWORD DLLCALLCONV WDC_PciScanRegisteredDevices(_In_ DWORD dwVendorId, _In_ DWORD dwDeviceId, _Outptr_ WDC_PCI_SCAN_RESULT *pPciScanResult)
Scans the PCI bus for all devices with the specified vendor and device ID combination that have been ...
DWORD DLLCALLCONV WDC_PciGetExpressGenBySlot(_In_ WD_PCI_SLOT *pPciSlot)
Retrieves the PCI Express generation of a device.
DWORD DLLCALLCONV WDC_PciReadCfg32(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwOffset, _Outptr_ UINT32 *pdwVal)
Reads 4 bytes (32 bits) from a specified offset in a PCI device's configuration space or a PCI Expres...
DWORD DLLCALLCONV WDC_Version(_Outptr_ CHAR *pcVersion, _In_ DWORD dwLen, _Outptr_ DWORD *pdwVersion)
Returns the version number of the WinDriver kernel module used by the WDC library.
DWORD DLLCALLCONV WDC_PciWriteCfgBySlot8(_In_ WD_PCI_SLOT *pPciSlot, _In_ DWORD dwOffset, _In_ BYTE bVal)
writes 1 byte (8 bits) to a specified offset in a PCI device's configuration space or a PCI Express d...
WDC_ADDR_RW_OPTIONS
Read/write address options.
Definition: wdc_lib.h:123
@ WDC_ADDR_RW_DEFAULT
Default: memory resource - direct access; autoincrement on block transfers.
Definition: wdc_lib.h:124
@ WDC_ADDR_RW_NO_AUTOINC
Hold device address constant while reading/writing a block.
Definition: wdc_lib.h:126
DWORD DLLCALLCONV WDC_PciReadCfgBySlot32(_In_ WD_PCI_SLOT *pPciSlot, _In_ DWORD dwOffset, _Outptr_ UINT32 *pdwVal)
Reads 4 bytes (32 bits) from a specified offset in a PCI device's configuration space or a PCI Expres...
#define WDC_SIZE_32
Definition: wdc_lib.h:133
WD_BUS_TYPE DLLCALLCONV WDC_GetBusType(_In_ WDC_DEVICE_HANDLE hDev)
Returns the device's bus type: WD_BUS_PCI, WD_BUS_ISA or WD_BUS_UNKNOWN.
DWORD DLLCALLCONV WDC_WriteAddr8(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwAddrSpace, _In_ KPTR dwOffset, _In_ BYTE bVal)
writes 1 byte (8 bits) to a specified memory or I/O address.
DWORD DLLCALLCONV WDC_ReadAddr32(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwAddrSpace, _In_ KPTR dwOffset, _Outptr_ UINT32 *pdwVal)
reads 4 byte (32 bits) from a specified memory or I/O address.
DWORD DLLCALLCONV WDC_PciReadCfgBySlot8(_In_ WD_PCI_SLOT *pPciSlot, _In_ DWORD dwOffset, _Outptr_ BYTE *pbVal)
Read/write 8/16/32/64 bits from the PCI configuration space.
DWORD DLLCALLCONV WDC_PciSriovEnable(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwNumVFs)
SR-IOV API functions are not part of the standard WinDriver API, and not included in the standard ver...
DWORD DLLCALLCONV WDC_PciScanDevicesByTopology(_In_ DWORD dwVendorId, _In_ DWORD dwDeviceId, _Outptr_ WDC_PCI_SCAN_RESULT *pPciScanResult)
Scans the PCI bus for all devices with the specified vendor and device ID combination and returns inf...
DWORD WDC_DBG_OPTIONS
Definition: wdc_lib.h:106
DWORD DLLCALLCONV WDC_WriteAddr64(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwAddrSpace, _In_ KPTR dwOffset, _In_ UINT64 qwVal)
writes 8 byte (64 bits) to a specified memory or I/O address.
DWORD DLLCALLCONV WDC_PciWriteCfg(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwOffset, _In_ PVOID pData, _In_ DWORD dwBytes)
Writes data to a specified offset in a PCI device's configuration space or a PCI Express device's ext...
DWORD DLLCALLCONV WDC_PciWriteCfgBySlot32(_In_ WD_PCI_SLOT *pPciSlot, _In_ DWORD dwOffset, _In_ UINT32 dwVal)
writes 4 bytes (32 bits) to a specified offset in a PCI device's configuration space or a PCI Express...
DWORD DLLCALLCONV WDC_PciWriteCfg32(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwOffset, _In_ UINT32 dwVal)
Writes 4 bytes (32 bits) to a specified offset in a PCI device's configuration space or a PCI Express...
DWORD DLLCALLCONV WDC_ReadAddr64(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwAddrSpace, _In_ KPTR dwOffset, _Outptr_ UINT64 *pqwVal)
reads 8 byte (64 bits) from a specified memory or I/O address.
BOOL DLLCALLCONV WDC_EventIsRegistered(_In_ WDC_DEVICE_HANDLE hDev)
Checks if the application is currently registered to receive Plug-and-Play and power management notif...
DWORD DLLCALLCONV WDC_PciReadCfgBySlot(_In_ WD_PCI_SLOT *pPciSlot, _In_ DWORD dwOffset, _Outptr_ PVOID pData, _In_ DWORD dwBytes)
Read/write a block of any length from the PCI configuration space.
DWORD DLLCALLCONV WDC_EventUnregister(_In_ WDC_DEVICE_HANDLE hDev)
Unregisters an application from a receiving Plug-and-Play and power management notifications for a de...
DWORD DLLCALLCONV WDC_PciScanCapsBySlot(_In_ WD_PCI_SLOT *pPciSlot, _In_ DWORD dwCapId, _Outptr_ WDC_PCI_SCAN_CAPS_RESULT *pScanCapsResult)
Scans the basic PCI capabilities of the given device for the specified capability (or for all capabil...
DWORD DLLCALLCONV WDC_PciWriteCfg16(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwOffset, _In_ WORD wVal)
Writes 2 bytes (16 bits) to a specified offset in a PCI device's configuration space or a PCI Express...
DWORD DLLCALLCONV WDC_PciScanExtCaps(_In_ WDC_DEVICE_HANDLE hDev, _In_ DWORD dwCapId, _Outptr_ WDC_PCI_SCAN_CAPS_RESULT *pScanCapsResult)
Scans the extended (PCI Express) PCI capabilities of the given device for the specified capability (o...
DWORD DLLCALLCONV WDC_DriverOpen(_In_ WDC_DRV_OPEN_OPTIONS openOptions, _In_ const CHAR *pcLicense)
Opens and stores a handle to WinDriver's kernel module and initializes the WDC library according to t...
void * WDC_DEVICE_HANDLE
Handle to device information struct.
Definition: wdc_lib.h:33
#define _Inout_
Definition: windrvr.h:38
unsigned short int WORD
Definition: windrvr.h:333
unsigned char BYTE
Definition: windrvr.h:332
#define _Outptr_
Definition: windrvr.h:40
DWORD WD_BUS_TYPE
Definition: windrvr.h:681
UINT64 PHYS_ADDR
Definition: windrvr.h:378
void(DLLCALLCONV * DMA_TRANSACTION_CALLBACK)(PVOID pData)
Definition: windrvr.h:526
#define _In_
Definition: windrvr.h:37
unsigned __int64 UINT64
Definition: windrvr.h:314
@ WD_PCI_MAX_CAPS
Definition: windrvr.h:882
#define DLLCALLCONV
Definition: windrvr.h:32
@ WD_PCI_CARDS
Definition: windrvr.h:842
unsigned int UINT32
Definition: windrvr.h:337
UINT32 KPTR
Definition: windrvr.h:368
void(* EVENT_HANDLER)(WD_EVENT *pEvent, void *pData)
void(DLLCALLCONV * INT_HANDLER)(PVOID pData)