Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
General Register Access Functions
NAI Board Library - Module Functions » M1553 Module Functions

Functions

NAIBRDFUNC naibrd_1553_reg_value_t NAIAPI naibrd_1553_ReadRegister (int16_t device, naibrd_1553_general_registerAddress_t registerAddress)
 Reads a register on the device at the specified memory location.
 
NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_WriteRegister (int16_t device, naibrd_1553_general_registerAddress_t registerAddress, naibrd_1553_reg_value_t registerValue)
 Writes to the specified register location.
 
NAIBRDFUNC naibrd_1553_aux_reg_value_t NAIAPI naibrd_1553_ReadAuxRegister (int16_t device, naibrd_1553_general_auxRegAddress_t auxRegisterAddress)
 Reads an Auxiliary register on the device at the specified memory location.
 
NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_WriteAuxRegister (int16_t device, naibrd_1553_general_auxRegAddress_t auxRegisterAddress, naibrd_1553_aux_reg_value_t auxRegisterValue)
 Writes to the specified auxiliary register location.
 
NAIBRDFUNC uint16_t NAIAPI naibrd_1553_ReadMemory (int16_t device, uint32_t deviceMemoryAddress)
 Reads a memory location.
 
NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_WriteMemory (int16_t device, uint32_t deviceMemoryAddress, uint16_t deviceMemoryValue)
 Writes to the specified memory location.
 
NAIBRDFUNC uint32_t NAIAPI naibrd_1553_ReadIntRegister (int16_t device, naibrd_1553_general_intRegAddress_t intRegisterAddress)
 Reads an Interrupt register on the device at the specified memory location.
 
NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_WriteIntRegister (int16_t device, naibrd_1553_general_intRegAddress_t intRegisterAddress, uint32_t intRegisterValue)
 Writes to the specified interrupt register location.
 

Detailed Description

Function Documentation

◆ naibrd_1553_ReadAuxRegister()

NAIBRDFUNC naibrd_1553_aux_reg_value_t NAIAPI naibrd_1553_ReadAuxRegister ( int16_t device,
naibrd_1553_general_auxRegAddress_t auxRegisterAddress )

Reads an Auxiliary register on the device at the specified memory location.

Parameters
device: (Input) Logical Device Number (0-31).
auxRegisterAddress(Input) Specifies the register address to be read (0-15).
Returns
Contents of the register that was read.

◆ naibrd_1553_ReadIntRegister()

NAIBRDFUNC uint32_t NAIAPI naibrd_1553_ReadIntRegister ( int16_t device,
naibrd_1553_general_intRegAddress_t intRegisterAddress )

Reads an Interrupt register on the device at the specified memory location.

Parameters
device: (Input) Logical Device Number (0-31).
intRegisterAddress(Input) Specifies the register address to be read (0-3).
Returns
Contents of the register that was read.

◆ naibrd_1553_ReadMemory()

NAIBRDFUNC uint16_t NAIAPI naibrd_1553_ReadMemory ( int16_t device,
uint32_t deviceMemoryAddress )

Reads a memory location.

Parameters
device: (Input) Logical Device Number (0-31).
deviceMemoryAddress(Input) Specifies the memory location to read.
Returns
Contents of the memory location that was read.

◆ naibrd_1553_ReadRegister()

NAIBRDFUNC naibrd_1553_reg_value_t NAIAPI naibrd_1553_ReadRegister ( int16_t device,
naibrd_1553_general_registerAddress_t registerAddress )

Reads a register on the device at the specified memory location.

Parameters
device: (Input) Logical Device Number (0-31).
registerAddress(Input) Specifies the register address to be read (0-63).
Returns
Contents of the register that was read.

◆ naibrd_1553_WriteAuxRegister()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_WriteAuxRegister ( int16_t device,
naibrd_1553_general_auxRegAddress_t auxRegisterAddress,
naibrd_1553_aux_reg_value_t auxRegisterValue )

Writes to the specified auxiliary register location.

Parameters
device: (Input) Logical Device Number (0-31).
auxRegisterAddress(Input) Specifies the auxiliary register address to be read (0-15).
auxRegisterValue(Input) Value to be written to the auxiliary register.
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAIBRD_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAIBRD_1553_RC_INVALID_STATE when device is in an invalid state
  • NAIBRD_1553_RC_INVALID_ADDRESS when one or all of the addresses specified in wAuxRegisterAddress is invalid

◆ naibrd_1553_WriteIntRegister()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_WriteIntRegister ( int16_t device,
naibrd_1553_general_intRegAddress_t intRegisterAddress,
uint32_t intRegisterValue )

Writes to the specified interrupt register location.

Parameters
device: (Input) Logical Device Number (0-31).
intRegisterAddress(Input) Specifies the interrupt register address to write (0-3).
intRegisterValue(Input) Value to be written to the interrupt register.
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAIBRD_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAIBRD_1553_RC_INVALID_STATE when device is in an invalid state
  • NAIBRD_1553_RC_INVALID_ADDRESS when one or all of the addresses specified in intRegisterAddress is invalid

◆ naibrd_1553_WriteMemory()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_WriteMemory ( int16_t device,
uint32_t deviceMemoryAddress,
uint16_t deviceMemoryValue )

Writes to the specified memory location.

Parameters
device: (Input) Logical Device Number (0-31).
deviceMemoryAddress(Input) Specifies the memory location to write to.
deviceMemoryValue(Input) Value to be written.
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAIBRD_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAIBRD_1553_RC_INVALID_STATE when device is in an invalid state
  • NAIBRD_1553_RC_INVALID_ADDRESS when one or all of the addresses specified in wDeviceMemoryAddress is invalid

◆ naibrd_1553_WriteRegister()

NAIBRDFUNC naibrd_1553_t NAIAPI naibrd_1553_WriteRegister ( int16_t device,
naibrd_1553_general_registerAddress_t registerAddress,
naibrd_1553_reg_value_t registerValue )

Writes to the specified register location.

Parameters
device: (Input) Logical Device Number (0-31).
registerAddress(Input) Specifies the register address to be read (0-63).
registerValue(Input) Value to be written to the register.
Returns
  • NAI_SUCCESS when the device has been initialized successfully
  • NAIBRD_1553_RC_INVALID_DEVICE_NUMBER when incorrect device number was input
  • NAIBRD_1553_RC_INVALID_STATE when device is in an invalid state
  • NAIBRD_1553_RC_INVALID_ADDRESS when one or all of the addresses specified in wRegisterAddress is invalid