Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Bus Monitor Specific Functions
N7/N8 (Summit) 1553 Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SUM1553_BM_SetMonitorFilter (int32_t cardIndex, int32_t module, int32_t channel, bool_t monitorAll, uint32_t monitorFilter)
 Sets up the Bus Monitor filter registers. If all RTs are to be monitored, the Bus Monitor Control (BMC) bit (Core Register 0 bit 5) will be set to 0, otherwise this bit is set to 1 and the core will only monitor the RTs specified in the Monitor Filter registers (Core Register 14 and 15).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SUM1553_BM_GetMonitorFilter (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outmonitorAll, uint32_t *outmonitorFilter)
 Retrieves the Bus Monitor filter registers. If all RTs are to be monitored, the Bus Monitor Control (BMC) bit (Core Register 0 bit 5) will be set to 0, otherwise this bit is set to 1 and the core will only monitor the RTs specified in the Monitor Filter registers (Core Register 14 and 15).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SUM1553_BM_SetMonitorBlockCount (int32_t cardIndex, int32_t module, int32_t channel, uint16_t blockcnt)
 Sets the Monitor Block Count (MBC) register (Core Register 13). The Monitor Block Count register is used to set the number of monitor blocks to be logged. Once execution begins, the value contained in the register will be decremented. Upon reaching 0, an MBC interrupt is generated (Core Register 4 bit 0). The core will restart at the initial address specified in the Monitor Command Pointer register (Core Register 11) and Monitor Data Pointer register (Core Register 12). Note: The Monitor Block Count initial value allows that number of blocks + 1; it is really used as an index. So if the initial count is set to 1023, 1024 blocks will be monitored.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SUM1553_BM_GetMonitorBlockCount (int32_t cardIndex, int32_t module, int32_t channel, uint16_t *outblockcnt)
 Retrieves the Monitor Block Count (MBC) register (Core Register 13). The Monitor Block Count register is used to set the number of monitor blocks to be logged. Once execution begins, the value contained in the register will be decremented. Upon reaching 0, an MBC interrupt is generated (Core Register 4 bit 0). The core will restart at the initial address specified in the Monitor Command Pointer register (Core Register 11) and Monitor Data Pointer register (Core Register 12). Note: The Monitor Block Count initial value allows that number of blocks + 1; it is really used as an index. So if the initial count is set to 1023, 1024 blocks will be monitored.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SUM1553_BM_ReadDataBlock (int32_t cardIndex, int32_t module, int32_t channel, uint16_t datablock, uint16_t *outinfo, uint16_t *outcmd1, uint16_t *outcmd2, uint16_t *outstatus1, uint16_t *outstatus2, uint16_t *outtimetag, uint16_t outdatablock[32])
 Retrieves the message and associated control words read by the Bus Monitor for the Data Block value read from the Monitor Block Counter register (Core Register 13).
 

Detailed Description


Function Documentation

◆ naibrd_SUM1553_BM_GetMonitorBlockCount()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SUM1553_BM_GetMonitorBlockCount ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint16_t * outblockcnt )

Retrieves the Monitor Block Count (MBC) register (Core Register 13). The Monitor Block Count register is used to set the number of monitor blocks to be logged. Once execution begins, the value contained in the register will be decremented. Upon reaching 0, an MBC interrupt is generated (Core Register 4 bit 0). The core will restart at the initial address specified in the Monitor Command Pointer register (Core Register 11) and Monitor Data Pointer register (Core Register 12). Note: The Monitor Block Count initial value allows that number of blocks + 1; it is really used as an index. So if the initial count is set to 1023, 1024 blocks will be monitored.

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]).
outblockcnt: (Output) Number of monitor blocks to be logged.
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_BM_GetMonitorFilter()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SUM1553_BM_GetMonitorFilter ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * outmonitorAll,
uint32_t * outmonitorFilter )

Retrieves the Bus Monitor filter registers. If all RTs are to be monitored, the Bus Monitor Control (BMC) bit (Core Register 0 bit 5) will be set to 0, otherwise this bit is set to 1 and the core will only monitor the RTs specified in the Monitor Filter registers (Core Register 14 and 15).

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]).
outmonitorAll: (Output) (1) monitor all RTs (0) monitor RTs specified by the monitorFilter.
outmonitorFilter: (Output) Each bit represents the RT address to monitor with the MSB representing RT Address 31 and LSB representing RT Address 0. A bit value of 1 indicates to monitor the RT address, otherwise the RT address will not be monitored.
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_BM_ReadDataBlock()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SUM1553_BM_ReadDataBlock ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint16_t datablock,
uint16_t * outinfo,
uint16_t * outcmd1,
uint16_t * outcmd2,
uint16_t * outstatus1,
uint16_t * outstatus2,
uint16_t * outtimetag,
uint16_t outdatablock[32] )

Retrieves the message and associated control words read by the Bus Monitor for the Data Block value read from the Monitor Block Counter register (Core Register 13).

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]).
datablock: (Input) Data block read from Monitor Block Counter to retrieve data (0 - NAI_SUM1553_BM_CMDBLK_CNT).
outinfo: (Output) BM message info.
outcmd1: (Output) BM message command word 1.
outcmd2: (Output) BM message command word 2.
outstatus1: (Output) BM status 1.
outstatus2: (Output) BM status 2.
outtimetag: (Output) BM time tag.
outdatablock: (Output) BM message data.
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 datablock is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SUM1553_BM_SetMonitorBlockCount()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SUM1553_BM_SetMonitorBlockCount ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint16_t blockcnt )

Sets the Monitor Block Count (MBC) register (Core Register 13). The Monitor Block Count register is used to set the number of monitor blocks to be logged. Once execution begins, the value contained in the register will be decremented. Upon reaching 0, an MBC interrupt is generated (Core Register 4 bit 0). The core will restart at the initial address specified in the Monitor Command Pointer register (Core Register 11) and Monitor Data Pointer register (Core Register 12). Note: The Monitor Block Count initial value allows that number of blocks + 1; it is really used as an index. So if the initial count is set to 1023, 1024 blocks will be monitored.

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]).
blockcnt: (Input) Number of monitor blocks to be logged.
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_BM_SetMonitorFilter()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SUM1553_BM_SetMonitorFilter ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t monitorAll,
uint32_t monitorFilter )

Sets up the Bus Monitor filter registers. If all RTs are to be monitored, the Bus Monitor Control (BMC) bit (Core Register 0 bit 5) will be set to 0, otherwise this bit is set to 1 and the core will only monitor the RTs specified in the Monitor Filter registers (Core Register 14 and 15).

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]).
monitorAll: (Input) (1) monitor all RTs (0) monitor RTs specified by the monitorFilter.
monitorFilter: (Input) Each bit represents the RT address to monitor with the MSB representing RT Address 31 and LSB representing RT Address 0. A bit value of 1 indicates to monitor the RT address, otherwise the RT address will not be monitored.
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.