MX Foundation 4
|
The KMXF_A629_MODULE_TI
attribute holds the transmit interval of the module. The attribute value is expressed according to the current timebase (microseconds or nanoseconds) and by steps of 500 microseconds. See Transmit Interval.
Range | Value (μs) |
---|---|
Minimum | 500 |
Maximum | 64000 |
Default value: 25 ms
The KMXF_A629_MODULE_SG
attribute holds the synchronization gap of the module. The SG should be chosen to be longer than the maximum length Terminal Gap. See Synchronization Gap.
Constant | Value |
---|---|
VMXF_A629_MODULE_SG_16 | SG of 16 (17.7 μs) |
VMXF_A629_MODULE_SG_32 | SG of 32 (33.7 μs) |
VMXF_A629_MODULE_SG_64 | SG of 64 (65.7 μs) |
VMXF_A629_MODULE_SG_127 | SG of 127 (127.7 μs) (default) |
The KMXF_A629_MODULE_INTERFACE
attribute holds the module interface, either SIM (Serial Interface Module) or TTL.
Constant | Value |
---|---|
VMXF_A629_MODULE_INTERFACE_SIM | SIM interface (default) |
VMXF_A629_MODULE_INTERFACE_TTL | Pseudo-bus interface |
The KMXF_A629_MODULE_RX_ONLY
attribute holds the module RX only enable state. When enabled, this will prevent any transmission to occur.
In MXF 4.1.0 and later, this attribute returns the state of the software RX only attribute ORed with the A629 Tx Inhibit Key state at the back of the FM629 device. The A629 Tx Inhibit Key acts like a sticky bit register, meaning that if the key has been turned to inhibit transmission (RX only enable), the transmission will be disabled until this attribute is set to Disable RX only, even if the key has been turned back to allow transmission.
If a frame is started when in RX only mode, error MAXT_ERROR_BAD_TERM_MODE will be returned by mxfTxPeriodicMajorFrameStart(). If the A629 Tx Inhibit key is turned to disable transmission while a frame is running, the frame will be halted, the status bit MXF_TXPERIODIC_MJRFRAME_STATUS_HALTED will be set and the txHalted statistic incremented.
Constant | Value |
---|---|
VMXF_DISABLE | Disable RX only (default) |
VMXF_ENABLE | Enable RX only |
The KMXF_A629_MODULE_XPP_CID_ENABLE
attribute holds the module XPP CID enable state. This attribute allows using the CID of each label configured in each XPP cell. The default CID is ignored for transmission. This feature allows doing an error injection. However, the default CID is used for the CRC calculation. The supported values are:
Constant | Value |
---|---|
VMXF_DISABLE | Disable XPP CID (default) |
VMXF_ENABLE | Enable XPP CID |
The KMXF_A629_MODULE_XPP_DUAL_ENABLE
attribute holds the module XPP Dual enable state. When this attribute is disabled, the module has 120 RTs (or XPPs). However, once the “DUAL XPP” mode is enabled, the available simultaneous RT is down to 60. The RT number from 60 to 119 are the second XPP for RT 0 to 59. So each DUAL XPP (ex. RT 0 and 60) can have a different configuration (TG, CID, etc). Then, when a “RT XPP switch” is called, the module processing would point to the other XPP configuration without affecting the on going scheduling. The supported values are:
Constant | Value |
---|---|
VMXF_DISABLE | Disable XPP Dual (default) |
VMXF_ENABLE | Enable XPP Dual |
The KMXF_A629_MODULE_XPP_FIFO_AGING
attribute holds aging timeout for the module XPP FIFO. The aging timeout is used to prevent the stagnation of received events when the almost full threshold is not reached. Programming a value of “0” disables the maximum aging surveillance process. The attribute value is expressed according to the current timebase (microseconds or nanoseconds) and by steps of 64 microseconds. The supported range is:
Range | Value (μs) |
---|---|
Minimum | 0 |
Maximum | 16320 |
Default value: 1024 μs
The KMXF_A629_MODULE_XPP_FIFO_AF
attribute holds the number of 16-bit words of the almost full (AF) XPP FIFO. The supported range is:
Range | Value |
---|---|
Minimum | 1 (default) |
Maximum | 63 |
The KMXF_A629_MODULE_BM_FIFO_AGING
attribute holds aging timeout for BM FIFO. The aging timeout is used to prevent the stagnation of received events when the almost full threshold is not reached. Programming a value of “0” disables the maximum aging surveillance process. The attribute value is expressed according to the current timebase (microseconds or nanoseconds) and by steps of 64 microseconds. The supported range is:
Range | Value (μs) |
---|---|
Minimum | 0 |
Maximum | 16320 |
Default value: 1024 μs
The KMXF_A629_MODULE_BM_FIFO_AF
attribute holds the number of 16-bit words of the almost full (AF) BM FIFO. The supported range is:
Range | Value |
---|---|
Minimum | 1 |
Maximum | 2047 |
Default value: 32
The KMXF_A629_MODULE_APERIODIC_MODE
attribute holds the module Tx Aperiodic Mode enable state. When enabled, the transmission is not based on the A629 timers (TI, SG and TG) but controlled by the application. There are limitations to keep in mind when using this mode. See Aperiodic Mode section for more details.
This mode should be used only for special test cases.
Constant | Value |
---|---|
VMXF_DISABLE | Disable Tx Aperiodic Mode (default) |
VMXF_ENABLE | Enable Tx Aperiodic Mode |
The KMXF_A629_MODULE_SPEED
attribute holds the module Speed.
Constant | Value |
---|---|
VMXF_A629_MODULE_SPEED_2MBPS | 2 Mbps (default) |
VMXF_A629_MODULE_SPEED_8MBPS | 8 Mbps |