WDC_DriverOpen()

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 the open options passed to it.

This function should be called once before calling any other WDC API.

Parameters

[in]	openOptions	A mask of any of the supported open flags, which determines the initialization actions that will be performed by the function.
[in]	pcLicense	WinDriver license registration string. This argument is ignored if the WDC_DRV_OPEN_REG_LIC flag is not set in the openOptions argument. If this parameter is a NULL pointer or an empty string, the function will attempt to register the demo WinDriver evaluation license. Therefore, when evaluating WinDriver pass NULL as this parameter. After registering your WinDriver toolkit, modify the code to pass your WinDriver license registration string.

Returns

Returns WD_STATUS_SUCCESS (0) on success, or an appropriate error code otherwise

Remarks

This function is currently only supported from the user mode. This function is supported only for Windows and Linux.

 
int main(void)
{
    DWORD dwStatus;
 
    WDC_DEVICE_HANDLE hDev;
    WD_PCI_SLOT slot = {0, 0, 0, 0}; /* Replace domain/bus/slot/function with your own */
    WD_PCI_CARD_INFO deviceInfo;
 
    BYTE bData = 0x1;
    WORD wData = 0x2;
    UINT32 u32Data = 0x3;
    UINT64 u64Data = 0x4;
 
    /* Make sure to fully initialize WinDriver! */
    if (!WD_DriverName(DEFAULT_DRIVER_NAME))
    {
        printf("Failed to set the driver name for WDC library.\n");
        return WD_INTERNAL_ERROR;
    }
 
    dwStatus = WDC_SetDebugOptions(WDC_DBG_DEFAULT, NULL);
    if (WD_STATUS_SUCCESS != dwStatus)
    {
        printf("Failed to initialize debug options for WDC library.\n"
            "Error 0x%lx - %s\n", dwStatus, Stat2Str(dwStatus));
        return dwStatus;
    }
 
    /* Open a handle to the driver and initialize the WDC library */
    dwStatus = WDC_DriverOpen(WDC_DRV_OPEN_DEFAULT, DEFAULT_LICENSE_STRING);
    if (WD_STATUS_SUCCESS != dwStatus)
    {
        printf("Failed to initialize the WDC library. Error 0x%lx - %s\n",
            dwStatus, Stat2Str(dwStatus));
        return dwStatus;
    }
 
    BZERO(deviceInfo);
    deviceInfo.pciSlot = slot;
    dwStatus = WDC_PciGetDeviceInfo(&deviceInfo);
    if (WD_STATUS_SUCCESS != dwStatus)
    {
        printf("Failed retrieving the device's resources "
            "information. Error [0x%lx - %s]\n", dwStatus, Stat2Str(dwStatus));
        goto Exit;
    }
 
    /* Open a device handle */
    dwStatus = WDC_PciDeviceOpen(&hDev, &deviceInfo, NULL);
    if (WD_STATUS_SUCCESS != dwStatus)
    {
        printf("Failed opening a WDC device handle. Error 0x%lx - %s\n",
            dwStatus, Stat2Str(dwStatus));
        goto Exit;
    }
 
    /* Read/Write memory examples: */
 
    /* Check BYTE */
    dwResult = WDC_WriteAddrBlock8(hDev, MEM_SPACE, REG, 1,
        &bData, WDC_ADDR_RW_DEFAULT);
    if (dwResult)
        goto Exit;
 
    dwResult = WDC_ReadAddrBlock8(hDev, MEM_SPACE, REG, 1,
        &bData, WDC_ADDR_RW_DEFAULT);
    if (dwResult)
        goto Exit;
 
    /* Check WORD */
    dwResult = WDC_WriteAddrBlock16(hDev, MEM_SPACE, REG, 2,
        &wData, WDC_ADDR_RW_DEFAULT);
    if (dwResult)
        goto Exit;
 
    dwResult = WDC_ReadAddrBlock16(hDev, MEM_SPACE, REG, 2,
        &wData, WDC_ADDR_RW_DEFAULT);
    if (dwResult)
        goto Exit;
 
    /* Check UINT32 */
    dwResult = WDC_WriteAddrBlock32(hDev, MEM_SPACE, REG, 4,
        &u32Data, WDC_ADDR_RW_DEFAULT);
    if (dwResult)
        goto Exit;
 
    dwResult = WDC_ReadAddrBlock32(hDev, MEM_SPACE, REG, 4,
        &u32Data, WDC_ADDR_RW_DEFAULT);
    if (dwResult)
        goto Exit;
 
    /* Check UINT64 */
    dwResult = WDC_WriteAddrBlock64(hDev, MEM_SPACE, REG, 8,
        &u64Data, WDC_ADDR_RW_DEFAULT);
    if (dwResult)
        goto Exit;
 
    dwResult = WDC_ReadAddrBlock64(hDev, MEM_SPACE, REG, 8,
        &u64Data, WDC_ADDR_RW_DEFAULT);
    if (dwResult)
        goto Exit;
 
Exit:
    if (hDev)
    {
        dwStatus = WDC_PciDeviceClose(hDev);
        if (WD_STATUS_SUCCESS != dwStatus)
        {
            printf("Failed closing a WDC device handle (0x%p). Error 0x%lx "
                "- %s\n", hDev, dwStatus, Stat2Str(dwStatus));
        }
    }
    WDC_DriverClose();
}