RtndEnableTxInterrupt

RtndEnableTxInterrupt enables or disables the transmit interrupt for a specific Transmit Queue.

Syntax

Copy
BOOL RtndEnableTxInterrupt(
  [in]    ULONG_PTR RtndInterfaceId,
  [in]    ULONG TxQueueIndex,
  [in]    BOOL Enable
);

Parameters

[in] RtndInterfaceId

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

[in] TxQueueIndex

The index of the Transmit Queue.

[in] Enable

TRUE to enable the transmit 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 transmit interrupt, the driver must enable the global transmit interrupt only when at least one of the Transmit Queues has been requested to enable its transmit interrupt.

Characteristics

Real-time requirements

Deterministic behavior

Recommended

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: