RtndEnableRxInterrupt

RtndEnableRxInterrupt enables or disables the receive interrupt for a specific Receive Queue.

Syntax

Copy
BOOL RtndEnableRxInterrupt(
  [in]    ULONG_PTR RtndInterfaceId,
  [in]    ULONG RxQueueIndex,
  [in]    BOOL Enable
);

Parameters

[in] RtndInterfaceId

The number or pointer used to identify the interface. This value is returned by RtndManageInterface.

[in] RxQueueIndex

The index of the Receive Queue.

[in] Enable

TRUE to enable the receive interrupt, FALSE to disable it.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. To get extended error information, call GetLastError.

Common error codes:

Error code Meaning

ERROR_IO_DEVICE

An unexpected error occurred while trying to access the device.

Note: Custom drivers may return other error codes not listed above.

Remarks

The NL2 always calls this function from the NL2 process but not necessarily from the main thread.

If the NIC doesn’t have a per-queue receive interrupt, the driver must enable the global receive interrupt if, and only if, at least one of the Receive Queues has been requested to enable its receive interrupt.

Characteristics

Real-time requirements

Deterministic behavior

Not required

Local memory allocation/deallocation restrictions

Process

External MSpace

Internal MSpace

System

Not allowed

Not allowed

Process

Not allowed

Not allowed

Contiguous memory allocation/deallocation restrictions

Contiguous memory

Not allowed

Requirements

Minimum supported version Header

eRTOS 1.0 SDK

Rtnd.h

See Also: