Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
1760 Device Functions
NAI Board Library - Module Functions » M1760 Module Functions

Functions

NAIBRDFUNC naibrd_1760_t NAIAPI naibrd_1760_MasterReset (int16_t swDevice)
 Performs Master Reset on the Channel.
 
NAIBRDFUNC naibrd_1760_t NAIAPI naibrd_1760_GetDeviceReady (int16_t swDevice, bool_t *ready)
 Reads the ready status from bit 15 of the Master Status and Reset Register (0x1).
 
NAIBRDFUNC naibrd_1760_t NAIAPI naibrd_1760_SetChannelConfig (int16_t swDevice, uint32_t value)
 Set the channel configuration register.
 
NAIBRDFUNC naibrd_1760_t NAIAPI naibrd_1760_GetChannelConfig (int16_t swDevice, uint32_t *outvalue)
 Read the channel configuration register.
 
NAIBRDFUNC naibrd_1760_t NAIAPI naibrd_1760_SetChannelControl (int16_t swDevice, uint32_t value)
 Set the channel control register.
 
NAIBRDFUNC naibrd_1760_t NAIAPI naibrd_1760_GetChannelControl (int16_t swDevice, uint32_t *outvalue)
 Get the channel control register.
 
NAIBRDFUNC naibrd_1760_t NAIAPI naibrd_1760_CoreWriteEnable (int16_t swDevice, bool_t enable)
 Enable or disable writes to 1760 core registers.
 

Detailed Description

Function Documentation

◆ naibrd_1760_CoreWriteEnable()

NAIBRDFUNC naibrd_1760_t NAIAPI naibrd_1760_CoreWriteEnable ( int16_t swDevice,
bool_t enable )

Enable or disable writes to 1760 core registers.

Parameters
swDevice: (Input) Logical Device Number (0-31).
enable: (Input) Enable (NAI_TRUE) or disable (NAI_FALSE).
Returns
  • NAI_SUCCESS when function is completed successfully
  • NAI_ERROR_INVALID_VALUE when invalid swDevice is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_1760_GetChannelConfig()

NAIBRDFUNC naibrd_1760_t NAIAPI naibrd_1760_GetChannelConfig ( int16_t swDevice,
uint32_t * outvalue )

Read the channel configuration register. 

Bit 31-2    Don't Care
Bit 1       BCENA - Bus Controller Enable Input, Active High
Bit 0       EECOPY - EEPROM Copy, Active High. Asserting this input initiates RAM and register copy into serial
            EEPROM used for auto-initialization
Parameters
swDevice: (Input) Logical Device Number (0-31).
outvalue: (Output) 32-bit value read from the register.
Returns
  • NAI_SUCCESS when function is completed successfully
  • NAI_ERROR_INVALID_VALUE when invalid swDevice is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_1760_GetChannelControl()

NAIBRDFUNC naibrd_1760_t NAIAPI naibrd_1760_GetChannelControl ( int16_t swDevice,
uint32_t * outvalue )

Get the channel control register. 

Bit 31-6    Don't Care
Bit 5       TEST - Test Enable Input. The host asserts this pin to perform RAM self-test and loop-back tests.
Bit 4       RT1SSF - RT Subsystem Fail Input, Active High. When this input is high, the selected RT1 sets the
            Subsystem Fail flag in its transmit status word. This input is logically-ORed with the SSYSF bit in
            the terminal's RT1 1760 Status Word Bits register.
Bit 3       MTRUN - Monitor Run/Stop Input, Active High. This input starts/stops MT data recording. Upon going
            low, the MT stops when the current message is completed.
Bit 2       BCTRIG - BC Trigger Input, Active High. Used in conjunction with certain BC instructions.
Bit 1       TXINHB - Transmit inhibit input for Bus B, Active High. This input is logically OR'ed with the pair
            of corresponding bits in the Master Configuration Register to enable or inhibit transmit on Bus B,
            affecting behavior for all enabled 1760 devices.
Bit 0       TXINHA - Transmit inhibit input for Bus A, Active High. This input is logically OR'ed with the pair
            of corresponding bits in the Master Configuration Register to enable or inhibit transmit on Bus A,
            affecting behavior for all enabled 1760 devices.
Parameters
swDevice: (Input) Logical Device Number (0-31).
outvalue: (Output) 32-bit value to set in the register.
Returns
  • NAI_SUCCESS when function is completed successfully
  • NAI_ERROR_INVALID_VALUE when invalid swDevice is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_1760_GetDeviceReady()

NAIBRDFUNC naibrd_1760_t NAIAPI naibrd_1760_GetDeviceReady ( int16_t swDevice,
bool_t * ready )

Reads the ready status from bit 15 of the Master Status and Reset Register (0x1).

Parameters
swDevice: (Input) Logical Device Number (0-31).
ready: (Output) NAI_TRUE if ready is high, NAI_FALSE if ready is low.
Returns
  • NAI_SUCCESS when function is completed successfully
  • NAI_ERROR_INVALID_VALUE when invalid swDevice is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_1760_MasterReset()

NAIBRDFUNC naibrd_1760_t NAIAPI naibrd_1760_MasterReset ( int16_t swDevice)

Performs Master Reset on the Channel.

Parameters
swDevice: (Input) Logical Device Number (0-31).
Returns
  • NAI_SUCCESS when function is completed successfully
  • NAI_ERROR_INVALID_VALUE when invalid swDevice is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_1760_SetChannelConfig()

NAIBRDFUNC naibrd_1760_t NAIAPI naibrd_1760_SetChannelConfig ( int16_t swDevice,
uint32_t value )

Set the channel configuration register. 

Bit 31-2    Don't Care
Bit 1       BCENA - Bus Controller Enable Input, Active High
Bit 0       EECOPY - EEPROM Copy, Active High. Asserting this input initiates RAM and register copy into serial
            EEPROM used for auto-initialization
Parameters
swDevice: (Input) Logical Device Number (0-31).
value: (Input) 32-bit value to set in the register.
Returns
  • NAI_SUCCESS when function is completed successfully
  • NAI_ERROR_INVALID_VALUE when invalid swDevice is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_1760_SetChannelControl()

NAIBRDFUNC naibrd_1760_t NAIAPI naibrd_1760_SetChannelControl ( int16_t swDevice,
uint32_t value )

Set the channel control register. 

Bit 31-6    Don't Care
Bit 5       TEST - Test Enable Input. The host asserts this pin to perform RAM self-test and loop-back tests.
Bit 4       RT1SSF - RT Subsystem Fail Input, Active High. When this input is high, the selected RT1 sets the
            Subsystem Fail flag in its transmit status word. This input is logically-ORed with the SSYSF bit in
            the terminal's RT1 1760 Status Word Bits register.
Bit 3       MTRUN - Monitor Run/Stop Input, Active High. This input starts/stops MT data recording. Upon going
            low, the MT stops when the current message is completed.
Bit 2       BCTRIG - BC Trigger Input, Active High. Used in conjunction with certain BC instructions.
Bit 1       TXINHB - Transmit inhibit input for Bus B, Active High. This input is logically OR'ed with the pair
            of corresponding bits in the Master Configuration Register to enable or inhibit transmit on Bus B,
            affecting behavior for all enabled 1760 devices.
Bit 0       TXINHA - Transmit inhibit input for Bus A, Active High. This input is logically OR'ed with the pair
            of corresponding bits in the Master Configuration Register to enable or inhibit transmit on Bus A,
            affecting behavior for all enabled 1760 devices.
Parameters
swDevice: (Input) Logical Device Number (0-31).
value: (Input) 32-bit value to set in the register.
Returns
  • NAI_SUCCESS when function is completed successfully
  • NAI_ERROR_INVALID_VALUE when invalid swDevice is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.