ar_get_device_config

short ar_get_device_config (short board, short channel, short item, short * value);

Purpose

This function returns the state of board-level and ARINC 429 channel-level configuration register bit fields for the specified attribute.

Parameters

Input

Name

Type

Description

board

short

(input) Device Number of the board to reference, (valid range is 0-15).

channel

short

(input) The ARINC 429 or Discrete “channel” index, when applicable (valid range is 0 to one less than the total number of channels installed for the channel type referenced via the item parameter).

item

short

(input) The channel configuration attribute to read.  Valid "item" parameters options are:
ARU_RX_BITRATE                         (1)   Receiver bus speed
ARU_TX_BITRATE                         (2)   Transmitter bus speed
ARU_RX_PARITY                           (3)   Receiver parity detection
ARU_TX_PARITY                           (4)   Transmitter parity selection
ARU_RECV_MODE                         (5)   Receiver internal wrap
ARU_TX_BIT_ERROR                     (6)   Transmitter bit count error
ARU_TX_GAP_ERROR                    (8)   Transmit inter-msg gap error
ARU_RX_FIFO_ENABLE                 (16)  Receiver FIFO operation
ARU_TX_DISABLE                        (10)  External Transmit selection
ARU_TX_FIFO_ENABLE                  (17)  Transmitter FIFO operation
ARU_DISCRETE_OUT                    (12)  Discrete output state
ARU_DISCRETE_IN                       (14)  Discrete input state
ARU_DISCRETE_VALUES              (175) Bit-wise Discrete input state

ARU_RX_MERGED_MODE               (18)  Receiver FIFO selection
ARU_TX_FIFO_COUNT                   (19)  Current transmit buffer message count

ARU_FW_VERSION                        (20)  Hardware Version Reg. value
ARU_CONFIGURATION                   (21)  Device H/W configuration
ARU_DIFFERENTIAL_IN                  (22)  Differential input state
ARU_DIFFERENTIAL_OUT               (23)  Differential output state

ARU_IRIG_OUTPUT_ENABLE           (26)  R830-RX IRIG generator enable

ARU_IRIG_INPUT_TIME                  (27)  IRIG encoded sample time

ARU_RX_FIFO_COUNT                    (28)  Current receive buffer message count

ARU_HW_INTERRUPT_ENABLE         (29)  PCI Interrupt enable state
ARU_HW_ENHANCE_CHECK            (30)  Enhanced f/w compatibility check

ARU_RX_MSG_COUNT                    (35)  Receive channel cumulative message count

ARU_TX_MSG_COUNT                    (36)  Transmit channel cumulative message count

ARU_ACCESS_SNAPSHOT_BUFFER  (38)  Snapshot buffer storage select
ARU_DEVICE_DISABLE                  (39)  CEI-430 device disabled state
ARU_BYPASS_INIT_WRAP_TEST    (320) Bypass the init wrap test
ARU_MULTITHREAD_PROTECT       (321) Enable func thread protection
ARU_FAST_SLEW_RATE                (323) Transmitter slew rate
ARU_RX_TIMETAG_MODE             (440) Receive message time-tag reporting mode
ARU_IRIG_WRAP_ENABLE             (441) IRIG receiver internal wrap
ARU_IRIG_AVAILABLE                  (445) IRIG receiver installed state
ARU_IRIG_CALIBRATED               (447) IRIG signal availability
ARU_CHAN_COUNT_429               (448) ARINC 429 Tx channel count
ARU_CHAN_COUNT_573               (449) ARINC 573/717 channel count
ARU_CHAN_COUNT_DISC             (450) Discrete I/O channel count
ARU_CHAN_COUNT_DIFF              (451) Differential I/O channel count

Output

 

 

Name

Type

Description

value

short (passed by reference)

(output) The current channel configuration attribute state.
for this item                           valid return values for value are:                 
ARU_RX_BITRATE  &               ARU_SPEED_LOW   (1) 12.5 Kbps
ARU_TX_BITRATE                   ARU_SPEED_HIGH  (0) 100 Kbps
                                             Custom Bus Speed = 16,000,000 / value+2

ARU_RX_PARITY                     AR_ON  (7) Parity detect enabled
                                             AR_OFF (8) Parity detect disabled

ARU_TX_PARITY                     ARU_PARITY_ODD  (0) ODD parity active
                                             ARU_PARITY_EVEN (1) EVEN parity active
                                             ARU_PARITY_NONE (2) NO parity selected, bit 31 transmitted as supplied

ARU_RECV_MODE                   AR_WRAP_OFF (1) Internal wrap disabled
                                             AR_WRAP_ON  (0) Internal wrap enabled

ARU_RX_FIFO_ENABLE            AR_ON   (7) Rx FIFO operation enabled
                                             AR_OFF  (8) Rx FIFO operation disabled

ARU_RX_MERGED_MODE         AR_ON   (7) Rx directed to Merged FIFO
                                             AR_OFF  (8) Rx directed to Channel FIFO

ARU_TX_DISABLE                   AR_ON  (7) External Transmit disabled
                                             AR_OFF (8) External Transmit enabled

ARU_TX_FIFO_ENABLE             AR_ON  (7) Tx FIFO operation enabled
                                             AR_OFF (8) Tx FIFO operation disabled

ARU_TX_BIT_ERROR               AR_HI   (1) Tx long (33-bit) msg error
                                             AR_LO   (0) Tx short (31-bit) msg error
                                             AR_OFF  (8) Tx message length error disabled

ARU_TX_GAP_ERROR              AR_ON  (7) Tx inter-message gap error enabled
                                             AR_OFF (8) Tx inter-message gap error disabled

ARU_FAST_SLEW_RATE           AR_ON  (7) transmission using a 1.5 microsecond rise time
                                             AR_OFF (8) transmission using a 10 microsecond rise time

ARU_CONFIGURATION            CEIDEV_CONFIG_CEI830               (7)        CEI-830

                                             CEIDEV_CONFIG_CEI430              (8)        CEI-430

                                             CEIDEV_CONFIG_AMCA30             (9)        AMC-A30

                                             CEIDEV_CONFIG_CEI530              (10)      CEI-530

                                             CEIDEV_CONFIG_R830RX              (11)      R830RX

                                             CEIDEV_CONFIG_RAR_CPCI          (12)      RAR-CPCI

                                             CEIDEV_CONFIG_RAR_EC             (13)      RAR-EC

                                             CEIDEV_CONFIG_RAR_PCIE          (14)      RAR-PCIE


ARU_RX_TIMETAG_MODE        AR_TIMETAG_EXT_IRIG_64BIT     (0) 64-bit IRIG
                                             AR_TIMETAG_INT_USEC_64BIT    (1) 64-bit 1usec
                                             AR_TIMETAG_INT_20USEC_32BIT (3) 32-bit 20usec
                                             AR_TIMETAG_INT_MSEC_32BIT    (4) 32-bit 1msec
                                             AR_TIMER_X20_COMPAT_32BIT    (5) CEI-x20 compatible programmable resolution

ARU_ACCESS_SNAPSHOT_BUFFER   
                                             ARU_LABEL_ONLY        (0)
                                             ARU_LABEL_WITH_SDI (1)

ARU_BYPASS_INIT_WRAP_TEST
                                             AR_ON  (7) bypass wrap test during init
                                             AR_OFF (8) execute wrap test during init

ARU_MULTITHREAD_PROTECT
                                             AR_ON  (7) h/w access protection enabled
                                             AR_OFF (8) h/w access protection disabled

ARU_IRIG_AVAILALBE             FALSE (0) IRIG is installed on the device
                                             TRUE  (1) IRIG is not installed

ARU_IRIG_CALIBRATED          FALSE (0) IRIG signal is valid
                                             TRUE  (1) IRIG signal hasn't been detected

ARU_IRIG_WRAP_ENABLE       AR_ON  (7) internal wrap enabled
                                             AR_OFF (8) internal wrap disabled

ARU_IRIG_OUTPUT_ENABLE    AR_ON  (7) R830RX IRIG Generator enabled
                                             AR_OFF (8) R830RX IRIG Generator disabled

ARU_DISCRETE_IN                 AR_HI  (1) discrete channel shorted to ground
                                             AR_LO  (0) discrete channel floating

ARU_DISCRETE_OUT              AR_HI  (1) the discrete is open
                                             AR_LO (0) the discrete is shorted to ground

ARU_DIFFERENTIAL_IN            AR_HI (1) differential input is "high"
                                             AR_LO (0) differential input is "low"

ARU_DIFFERENTIAL_OUT         AR_ON  (7) differential output is enabled
                                             AR_OFF (8) differential output is disabled
                                             AR_HI  (1) differential output is "high"
                                             AR_LO  (0) differential output is "low"

ARU_DEVICE_DISABLE            FALSE (0) CEI-430 is disabled
                                             TRUE   (1) CEI-430 is enabled

 

ARU_HW_INTERRUPT_ENABLE  AR_ON  (7) PCI Interrupt is enabled
                                             AR_OFF (8) PCI Interrupt is disabled

ARU_HW_ENHANCE_CHECK     not applicable (return status indicates state)

 

ARU_FW_VERSION                  current programmed firmware version value

ARU_TX_FIFO_COUNT             current transmit buffer message count

 

ARU_RX_FIFO_COUNT             current receive buffer message count

 

ARU_RX_MSG_COUNT             receive channel cumulative message count since last device initialization

 

ARU_TX_MSG_COUNT             transmit channel cumulative message count since last device initialization

 

ARU_CHAN_COUNT_429          number of ARINC 429 channels installed

ARU_CHAN_COUNT_573          number of ARINC 573/717 channels installed

ARU_CHAN_COUNT_DISC       number of Discrete channels installed

ARU_CHAN_COUNT_DIFF        number of Differential channels installed

Return Value

Name

Type

Description

status

short

status of the function call, with valid values of:
ARS_NORMAL                  Success or Enhanced Firmware compatible (for ARU_HW_ENHANCE_CHECK).
ARS_INVBOARD              The board parameter value was invalid.
ARS_INVARG                  The item parameter value is not supported by this function or device configuration.
ARS_INVHARVAL             The value parameter is NULL.

ARS_BOARD_MUTEX        Access to the Board Lock timed-out/failed.

ARS_HW_CONSISTENCY  The board is incompatible with the Enhanced Firmware required for the API.

References

Device Configuration Functions
Alphabetical Function Index
Hierarchical Function Index

CEI-x30 API Description