WD_DriverName()

const char* DLLCALLCONV WD_DriverName

(

const char *

sName

)

Sets the name of the WinDriver kernel module, which will be used by the calling application.

The default driver name, which is used if the function is not called, is windrvr1620.

This function must be called once, and only once, from the beginning of your application, before calling any other WinDriver function (including WD_Open() / WDC_DriverOpen() / WDC_PciDeviceOpen() / WDC_IsaDeviceOpen()), as demonstrated in the sample and generated DriverWizard WinDriver applications, which include a call to this function with the default driver name - windrvr1620

On Windows and Linux, if you select to modify the name of the WinDriver kernel module (windrvr1620.sys/.dll/.o/.ko), as explained in 17.2. Renaming the WinDriver Kernel Driver, you must ensure that your application calls WD_DriverName() with your new driver name.

In order to use the WD_DriverName() function, your user-mode driver project must be built with WD_DRIVER_NAME_CHANGE preprocessor flag (e.g.: -DWD_DRIVER_NAME_CHANGE — for MS Visual Studio, Windows GCC, and GCC). The sample and generated DriverWizard Windows and Linux WinDriver projects/makefiles already set this preprocessor flag.

Parameters

[in]

sName

The name of the WinDriver kernel module to be used by the application. NOTE: The driver name should be indicated without the driver file's extension. For example, use windrvr1620, not windrvr1620.sys or windrvr1620.o.

Returns

Returns the selected driver name on success; returns NULL on failure (e.g., if the function is called twice from the same application).

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