RTX64 Real-Time NAL API Data Types

This section summarizes the structures, enumerations, and other data types used by the Real Time NAL API (RtNal) function set supported by the RTX64 Network Abstraction Layer (NAL).

Structures

Name Description
RTNAL_ETHERTYPE_FILTER A parameter to RtndIoctl to set, get, or remove an Ethernet type filter with ioctls RTNAL_IOCTL_SET_RX_ETHERTYPE_FILTER, RTNAL_IOCTL_GET_RX_ETHERTYPE_FILTER, and RTNAL_IOCTL_CLEAR_RX_ETHERTYPE_FILTER.
RTNAL_FRAME Specifies data to the function RtNalTransmitEx and receive and transmit callbacks of RTN_FN_PKT_CALLBACK types.
RTNAL_HW_TIME Used for hardware timestamps.
RTNAL_INFO Specifies information to RtNalGetInfo about the current Network Abstraction Layer (NAL) settings.
RTNAL_INTERFACE Specifies interface configuration data for the driver function RtndInitializeInterface. Retrieves interface configuration data by RtNalEnumInterfaceInfo.
RTNAL_PCI_LOCATION A parameter to RtndIoctl call to get the PCI Bus location of the interface.
RTNAL_QUEUE

Used by RtNalAcquireQueue, RtNalGetQueueByHandle, and RtNalGetQueueByIndex to return network queue information.
RTNAL_DEVICE_INFO

Part of RTNAL_QUEUE. Data specific to the network device.
RTNAL_PTP_SET_TIMESTAMP_TYPE_ARGUMENTS A parameter for RtndIoctl to set the PTP Receive packet type to be timestamped. It is used with ioctls RTNAL_IOCTL_SET_RX_MESSAGE_TYPE_TO_TIMESTAMP and RTNAL_IOCTL_SET_TX_MESSAGE_TYPE_TO_TIMESTAMP.
RTNAL_QUEUE_INFO

Part of RTNAL_QUEUE. Data specific to the network device queue.
RTNAL_QUEUE_CAPABILITIES

Used by RtNalConfigureQueue to pass pointers to callback functions provided by the application process to the NAL.
RTNAL_QUEUE_CRITERIA

Specifies data to the function RtNalAcquireQueue.
RTNAL_QUEUE_EVENTS

Used by RtNalAcquireQueue to return queue notification event handles to the application.

Enumerations

Name Description
RTNAL_PTP_MESSAGE_TYPE The message type supported for PTP time stamping.
RTNAL_PTP_VERSION The PTP version.
RTNAL_QUE_SEARCH

Used by RtNalAcquireQueue to describe the method to locate the desired network queue in the system.
RTNAL_QUEUE_TYPE Receive or transmit queue type.

Other Data Types

Name Description
RTNAL_QUEUE_HANDLE

A data type that represents the network queue to the application.
RTNAL_PHYSICAL_ADDRESS Represents the physical address in NAL and NIC drivers.