MX Foundation 4
|
The following attributes are available for all devices supporting a HFCE interface
The KMXF_HFCE_SPEED
attribute holds the speed for each RX and TX channels, in Bps.
The supported range is:
Module | Range (bps) | Default (bps) | Note |
---|---|---|---|
MXF_MODULE_HFCE | 100000 - 1000000 | 400000 | Frequency = 16000000 / n with 15 ≤ n ≤ 159 |
The KMXF_HFCE_TX_INTERFRAME_TIME_FILL
attribute holds the inter-frame time fill option.
The supported values are:
Constant | Value |
---|---|
VMXF_HFCE_TX_INTERFRAME_TIME_FILL_NONE | No idle pattern will be sent between transmission (idle time). Allows other stations on the bus to transmit. (default) |
VMXF_HFCE_TX_INTERFRAME_TIME_FILL_IDLE_PATTERN | Idle pattern will be sent between transmission. No other stations on the bus are allowed to transmit. |
The KMXF_HFCE_TX_RX_TEST_LB
attribute holds the TX-to-RX loopback state for the receiver channel. When the loopback mode is enabled, the received data comes from the corresponding internal transmitter instead of the default configuration where the received data come from the RX line circuit. This feature is intended for a demo application or for testing purposes. When enabled, the module's first RX channel receives data transmitted on the first TX channel; the second RX channel receives data from the second TX channel, and so on.
The supported values are:
Constant | Value |
---|---|
VMXF_ENABLE | Enable loopback |
VMXF_DISABLE | Disable loopback (default) |
The KMXF_HFCE_RX_FIFO_AGING
attribute defines the FIFO aging timeout value for a receiver channel. It defines the longest delay that a received word can wait in the hardware FIFO before a receive interrupt is generated. The attribute value resolution is based on the timebase resolution. A RX FIFO Aging Timeout value of 0 disables the aging timeout.
The supported range is:
Module | Range (microsecond) | Default (microsecond) | Note |
---|---|---|---|
MXF_MODULE_HFCE | 0 - 16320 | 8192 | Value is rounded down to step of 64 microseconds |
The KMXF_HFCE_RX_FIFO_AF
attribute holds the almost full threshold for a receiver channel. This attribute value determines the number of received words that must be accumulated in the receive hardware FIFO before an interrupt is generated.
The supported range is:
Module | Range (16-bit word) | Default (16-bit word) |
---|---|---|
MXF_MODULE_HFCE | 1 - 127 | 16 |
The KMXF_HFCE_TX_FIFO_AF
attribute holds the almost full threshold for a transmitter channel. The attribute value determines the maximum number of transmit words that are queued in the transmit hardware FIFO. The transmit interrupt will be cleared automatically once this threshold is reached.
The supported range is:
Module | Range (16-bit word) | Default (16-bit word) |
---|---|---|
MXF_MODULE_HFCE | 2 - 255 | 48 |
The KMXF_HFCE_TX_FIFO_AE
attribute holds the almost empty threshold for a transmitter channel. The attribute value determines when the transmit interrupt will be generated. The transmit interrupt will be generated whenever the number of word remaining in the transmit hardware FIFO is less than or equal to the value specified through this attribute. The software embedded process, will then be able to react and fill in the transmit FIFO.
The supported range is:
Module | Range (16-bit word) | Default (16-bit word) |
---|---|---|
MXF_MODULE_HFCE | 1 - 254 | 32 |
The KMXF_HFCE_MODULE_RX_TIMETAG_ENABLE
attribute defines the RX time tag enable state. When the time tag reception is disabled, the timeTag field of MXF_HFCE_DATAREC will always be 0. Disabling the time tag can result in a small gain in performance, because less data are transferred between the module and the reception buffer.
The supported values are:
Constant | Value |
---|---|
VMXF_ENABLE | Enable time tag reception (default) |
VMXF_DISABLE | Disable time tag reception |