mhpeSetTransmitAttributes

Sets the type of a given transmit endpoint.

HPESTATUS mhpeSetTransmitAttributes(
    MPEHANDLE   ephandle,
    uint32_t    tx_attribs
);

Parameters

ephandle

A Tx endpoint handle.

tx_attribs

The transmit attributes. The valid attributes are:

HPE_TX_TIMESTAMP_1STEP: Place a 1588 timestamp within the packet.
HPE_TX_TIMESTAMP_2STEP: Make a timestamp available post transmission.
HPE_TX_STREAM: Launch packets at specific time offsets.
HPE_TX_STICKY: The queue has persistent buffers.
HPE_TX_NONOTIFY: Do not signal when a TX interrupt occurs. Use this option when polling mode is desired but interrupts must be enabled for hpeSetTargetTimer.
hpeGetTransmitQueueState must be used to detect transmit completion (as would be done when NO_INTERRUPTS is specified).

Remarks

HPE_TX_TIMESTAMP_1STEP and HPE_TX_TIMESTAMP_2STEP are mutually exclusive. Enabling 2STEP time stamping on more than one queue may yield erroneous results.
HPE_TX_STICKY queue may be used only in conjunction with HPE_TX_STREAM queues. Once attached, the buffers are not detached. Launch time may be adjusted by setting the launch_time field in the HPETXSTREAMBUFFERSET structure (possibly to 0) and calling hpeSetTransmitOffset.

Return Values

A HPESTATUS value indicating the success or failure of the operation.

Status

E_OK: The operation completed successfully.
E_EXIST: The handle given is not a handle for an open HPE interface.
E_PARAM: The rx_queue_type parameter is invalid.
E_LIMIT: The queue_index parameter is out of range for the current hardware interface.
E_SUPPORT: The device does not support multi-queue or filter operations.

Requirements

Versions	Defined in	Include	Link to
INtime 7.1	intime/rt/include/mhpeif.h	mhpeif.h	mhpeif.lib