Rtnl2EnablePhysicalRxQueueTimestamping enables the Ingress Timestamp reporting for the frames received through a given Physical Receive Queue.
Syntax
BOOL Rtnl2EnablePhysicalRxQueueTimestamping(
[in] RTNL2_HPHYSICAL_RX_QUEUE PhysicalRxQueue
);Parameters
[in] PhysicalRxQueue
A handle to the Physical Receive Queue.
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 |
The supplied Physical Receive Queue handle is invalid. |
|
ERROR_DEVICE_FEATURE_NOT_SUPPORTED |
Hardware timestamping is not supported by the hardware. |
|
RTNL2_ERROR_PHYSICAL_RX_QUEUE_IS_RELEASING |
Another thread of the calling process is executing Rtnl2ReleasePhysicalRxQueue at the same time. |
|
RTNL2_ERROR_TIMESTAMPING_NOT_CONFIGURED |
Timestamping has not been enabled globally for the NIC nor specifically for this Physical Receive Queue. |
|
RTNL2_ERROR_SERIALIZED_COMMAND_TIMEOUT |
The NL2 process didn't reply within an acceptable amount of time. |
|
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 Rtnl2EnablePhysicalRxQueueTimestamping function does not dynamically enable hardware timestamping; instead, it allows the NL2 to report hardware timestamps in the IngressTimestamp field of the RTNL2_BUFFER_HEADER structure.
The Rtnl2EnablePhysicalRxQueueTimestamping function can be used by the application to verify whether hardware timestamping is supported.
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:
