WDC_PciDeviceOpen()

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, and returns a handle to the device.

---

Open/Close device

• Verifies that none of the registered device resources (set in pDeviceInfo->Card.Item) are already locked for exclusive use.
• Maps the physical memory ranges found on the device both to kernel-mode and user-mode address space, and stores the mapped addresses in the allocated device structure for future use.
• Saves device resources information required for supporting the communication with the device. For example, the function saves the interrupt request (IRQ) number and the interrupt type, as well as retrieves and saves an interrupt handle, and this information is later used when the user calls functions to handle the device's interrupts
• If the caller selects to use a Kernel PlugIn driver to communicate with the device, the function opens a handle to this driver and stores it for future use.

Parameters

[out]	phDev	Pointer to a handle to the WDC device allocated by the function
[in]	pDeviceInfo	Pointer to a card information structure, which contains information regarding the device to open
[in]	pDevCtx	Pointer to device context information, which will be stored in the device structure

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