Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Core Memory Access Functions
N7/N8 (Summit) 1553 Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SUM1553_ReadCoreReg (int32_t cardIndex, int32_t module, int32_t channel, uint32_t corereg, uint16_t *outdata)
 Retrieves the value in the Core Register specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SUM1553_WriteCoreReg (int32_t cardIndex, int32_t module, int32_t channel, uint32_t corereg, uint16_t data)
 Sets the value in the Core Register specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SUM1553_Read (int32_t cardIndex, int32_t module, int32_t channel, uint32_t address, uint32_t count, uint16_t outdata[])
 Retrieves the values in the address(es) specified. The page register associated with the address(es) specified is set to window the memory into the module memory space. Note addressing is word-based to match the core's addressing scheme.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SUM1553_Write (int32_t cardIndex, int32_t module, int32_t channel, uint32_t address, uint32_t count, const uint16_t data[])
 Sets the values in the address(es) specified. The page register associated with the address(es) specified is set to window the memory into the module memory space. Note addressing is word-based to match the core's addressing scheme.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SUM1553_WriteMask (int32_t cardIndex, int32_t module, int32_t channel, uint32_t address, uint16_t mask, uint16_t data)
 Writes a value to the address specified, updating only the bit positions that are set in mask. The resulting value in the register will be (oldData & ~mask) | (data & mask). The mask and value may be truncated or padded with zeros depending on the register width. The page register associated with the address(es) specified is set to window the memory into the module memory space. Note addressing is word-based to match the core's addressing scheme.
 

Detailed Description


Function Documentation

◆ naibrd_SUM1553_Read()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SUM1553_Read ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t address,
uint32_t count,
uint16_t outdata[] )

Retrieves the values in the address(es) specified. The page register associated with the address(es) specified is set to window the memory into the module memory space. Note addressing is word-based to match the core's addressing scheme.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
address: (Input) Core Address.
count: (Input) Number of words to read.
outdata: (Output) Data retrieved from memory.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SUM1553_ReadCoreReg()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SUM1553_ReadCoreReg ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t corereg,
uint16_t * outdata )

Retrieves the value in the Core Register specified.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
corereg: (Input) Core Register (0 - 32).
outdata: (Output) Data retrieved from core register.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_RANGE when invalid core register is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SUM1553_Write()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SUM1553_Write ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t address,
uint32_t count,
const uint16_t data[] )

Sets the values in the address(es) specified. The page register associated with the address(es) specified is set to window the memory into the module memory space. Note addressing is word-based to match the core's addressing scheme.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
address: (Input) Core Address.
count: (Input) Number of words to read.
data: (Input) Data to write to memory.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SUM1553_WriteCoreReg()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SUM1553_WriteCoreReg ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t corereg,
uint16_t data )

Sets the value in the Core Register specified.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
corereg: (Input) Core Register (0 - 32).
data: (Output) Data to set in core register.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_RANGE when invalid core register is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SUM1553_WriteMask()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SUM1553_WriteMask ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t address,
uint16_t mask,
uint16_t data )

Writes a value to the address specified, updating only the bit positions that are set in mask. The resulting value in the register will be (oldData & ~mask) | (data & mask). The mask and value may be truncated or padded with zeros depending on the register width. The page register associated with the address(es) specified is set to window the memory into the module memory space. Note addressing is word-based to match the core's addressing scheme.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
address: (Input) Core Address.
mask: (Input) The bits to change.
data: (Input) The value to write. Note that only the bit positions set in mask will be used.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.