3.3 WD_IntWait

3.3 WD_IntWait
	Chapter 3 LoweLevel WD_xxx Interrupt Functions

PURPOSE

• Waits for an interrupt.

PROTOTYPE

DWORD WD_IntWait(
    HANDLE hWD,
    WD_INTERRUPT *pInterrupt);

PARAMETERS

DESCRIPTION

Name	Description
hWD	Handle to WinDriver's kernel-mode driver as received from `WD_Open` [5.2]
pInterrupt	Pointer to an interrupt information structure:
• hInterrupt	Interrupt handle. The handle is returned by `WD_CardRegister` [2.8] in `pCardReg->Card.Item[i].I.Int.hInterrupt`.
• dwCounter	Number of interrupts received
• dwLost	Number of interrupts that were acknowledge in kernel mode but not yet handled in user mode
• fStopped	Set by the function to any of the following values: • 0 – an interrupt occurred. • `INTERRUPT_STOPPED` – an interrupt was disabled while waiting for interrupts. • `INTERRUPT_INTERRUPTED` – while waiting for an interrupt, `WD_IntWait` [3.3] was interrupted without an actual hardware interrupt (see also remark below).
• dwLastMessage	Relevant only for MSI/MSI-X interrupts on Windows Vista and higher (see information in the WinDriver PCI Manual): When an interrupt occurs, WinDriver's kernel-mode interrupt handler sets this field to the interrupt's message data.

RETURN VALUE

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

REMARKS

The INTERRUPT_INTERRUPTED status (set in pInterrupt->fStopped) can occur on Linux if the application that waits on the interrupt is stopped (e.g., by pressing CTRL+Z).

EXAMPLE

for (;;)
{
    WD_IntWait(hWD, &Intrp);
    if (Intrp.fStopped)
        break;

    ProcessInterrupt(Intrp.dwCounter);
}


3.2 WD_IntEnable		3.4 WD_IntCount