Rtnl2SetLogicalRxQueueMode

Rtnl2SetLogicalRxQueueMode enables or disables an interface mode setting.

Syntax

Copy 
BOOL Rtnl2SetLogicalRxQueueMode(
  [in]    RTNL2_HLOGICAL_RX_QUEUE LogicalRxQueue,
  [in]    RTNL2_RX_MODE_SETTING Setting, 
  [in]    BOOL Enable
);

Parameters

[in] LogicalRxQueue

A handle to the Logical Receive Queue.

[in] Setting

The identifier of the setting to enable or disable. See RTNL2_RX_MODE_SETTING for mode setting.

[in] Enable

TRUE to enable the setting, FALSE to disable the setting.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. Call GetLastError to obtain an error code.

Possible error codes:

Error code Meaning

ERROR_NOT_READY

The calling process has not called Rtnl2Init.

ERROR_INVALID_PARAMETER

One of the following conditions occurred:

  • The supplied Logical Receive Queue handle is invalid.
  • Parameter Setting doesn’t correspond to any setting known by this NL2 version.

ERROR_DEVICE_FEATURE_NOT_SUPPORTED

A request was made to enable a setting (Enable!=0) that is not supported by the hardware.

Note: If the function does NOT report an error in this scenario, it succeeds but does nothing.

RTNL2_ERROR_SERIALIZED_COMMAND_TIMEOUT

The NL2 process didn’t reply within an acceptable delay.

RTNL2_ERROR_NO_MORE_COMMUNICATION

Unable to communicate with the NL2 process. This might be because the NL2 process is not running anymore, or because an application process thread was terminated during a previous call to an NL2 API function.

Remarks

The NL2 maintains a per-queue copy of each interface mode setting. When an application calls Rtnl2SetLogicalRxQueueMode, the NL2 does not directly update the mode setting of the hardware. It first updates the setting in its per-queue copy for the specified queue. Then, it performs a logical OR operation on the mode settings of all Physical and Logical Receive Queues associated with the interface. Finally, the NL2 updates the hardware if the result differs from the previous setting.

Characteristics

Real-time

Deterministic

No
Local memory usage

Process

External MSpace usage

Internal MSpace usage

System

No

No

NL2 process

No

No

Calling process

No

No
Contiguous memory usage

Usage

No

Requirements

Minimum supported version Header Library

eRTOS 1.0 SDK

Rtnl2Api.h

Rtnl2Api.lib

See Also: