WDC_SetDebugOptions()

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 the possible debug options to set.

---

Debugging and error handling

This function is typically called at the beginning of the application, after the call to WDC_DriverOpen(), and can be re-called at any time while the WDC library is in use (i.e, WDC_DriverClose() has not been called) in order to change the debug settings.

Until the function is called, the WDC library uses the default debug options

• see WDC_DBG_DEFAULT.

When the function is recalled, it performs any required cleanup for the previous debug settings and sets the default debug options before attempting to set the new options specified by the caller.

Parameters

[in]	dbgOptions	A bit mask of flags indicating the desired debug settings - see WDC_DBG_OPTIONS. If this parameter is set to zero, the default debug options will be used see WDC_DBG_DEFAULT
[in]	pcDbgFile	WDC debug output file. This parameter is relevant only if the WDC_DBG_OUT_FILE flag is set in the debug options (dbgOptions) (either directly or via one of the convenience debug options combinations see WDC_DBG_OPTIONS). If the WDC_DBG_OUT_FILE debug flag is set and sDbgFile is NULL, WDC debug messages will be logged to the default debug file stderr.

Returns

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

 
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();
}