2.2 WD_PciScanCards()

PURPOSE

$\bullet$Detects PCI devices installed on the PCI bus, which conform to the input criteria (vendor ID and/or card ID), and returns the number and location (bus, slot and function) of the detected devices.

PROTOTYPE

DWORD WD_PciScanCards(
    HANDLE hWD,
    WD_PCI_SCAN_CARDS *pPciScan);

PARAMETERS

Name	Type	Input/Output
$\bullet$hWD	HANDLE	Input
$\bullet$pPciScan	WD_PCI_SCAN_CARDS*
$\gg$searchId	WD_PCI_ID
$\diamond$dwVendorId	DWORD	Input
$\diamond$dwDeviceId	DWORD	Input
$\gg$dwCards	DWORD	Output
$\gg$cardId	WD_PCI_ID[WD_PCI_CARDS]
$\diamond$dwVendorId	DWORD	Output
$\diamond$dwDeviceId	DWORD	Output
$\gg$cardSlot	WD_PCI_SLOT[WD_PCI_CARDS]
$\diamond$dwBus	DWORD	Output
$\diamond$dwSlot	DWORD	Output
$\diamond$dwFunction	DWORD	Output
$\gg$dwOptions	DWORD	Input

DESCRIPTION

Name	Description
hWD	Handle to WinDriver's kernel-mode driver as received from WD_Open() [5.2]
pPciScan	Pointer to a PCI bus scan information structure:
$\bullet$ searchId	PCI card ID information structure:
$\gg$ dwVendorId	The vendor ID of the PCI cards to detect. If 0, the function will search for all PCI card vendor IDs.
$\gg$ dwDeviceId	The card ID of the PCI cards to detect. If 0, the function will search for all PCI card IDs. If both dwVendorId and dwDeviceId are set to 0 the function will return information regarding all connected PCI cards.
$\bullet$ dwCards	Number of cards detected for the specified search criteria set in the searchId field
$\bullet$ cardId	Array of PCI card ID information structures for the detected PCI cards that match the search criteria set in the searchId field:
$\gg$ dId.dwVendorId	Vendor ID
$\gg$ dId.dwDeviceId	Card ID
$\bullet$ cardSlot	Array of PCI slot information structures for the detected PCI cards that match the search criteria set in the searchId field:
$\gg$ dwBus	Bus number (0 based)
$\gg$ dwSlot	Slot number (0 based)
$\gg$ dwFunction	Function number (0 based)
$\bullet$ dwOptions	PCI bus scan options. Can be either of the following: $\bullet$WD_PCI_SCAN_DEFAULT: Scan all PCI buses and slots. This is the default scan option. $\bullet$WD_PCI_SCAN_BY_TOPOLOGY: Scan the PCI bus by topology.

RETURN VALUE

Returns WD_STATUS_SUCCESS (0) on success, or an appropriate error code otherwise [A].

EXAMPLE

WD_PCI_SCAN_CARDS pciScan;
DWORD cards_found;
WD_PCI_SLOT pciSlot;

BZERO(pciScan);
pciScan.searchId.dwVendorId = 0x12bc;
pciScan.searchId.dwDeviceId = 0x1;
WD_PciScanCards(hWD, &pciScan);
if (pciScan.dwCards>0) /* Found at least one device */
    pciSlot = pciScan.cardSlot[0]; /* Use the first card found */
else
    printf("No matching PCI devices found\n");