Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_ReadReg16 (int32_t cardIndex, int32_t module, uint32_t offset, uint16_t *data)
	Reads a value from a 16-bit register.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_WriteReg16 (int32_t cardIndex, int32_t module, uint32_t offset, uint16_t data)
	Writes a value to a 16-bit register.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_WriteRegMask16 (int32_t cardIndex, int32_t module, uint32_t offset, uint16_t mask, uint16_t value)
	Writes a value to a 16-bit register, 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.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_MaskReg16 (int32_t cardIndex, int32_t module, uint32_t offset, uint16_t mask, nai_maskreg_op_t maskop)
	Writes a value to a 16-bit register, either clearing, setting or toggling only the bit positions that are set in mask. The mask and value may be truncated or padded with zeros depending on the register width.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_Read16 (int32_t cardIndex, int32_t module, uint32_t offset, uint32_t stride, uint32_t count, uint32_t dataWidth, void *data)
	Reads from 16-bit registers. The data will be truncated if the register is wider than width, or padded with zeros if the register is narrower than width.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_Write16 (int32_t cardIndex, int32_t module, uint32_t offset, uint32_t stride, uint32_t count, uint32_t dataWidth, const void *data)
	Writes to 16-bit register. The data will be truncated if the register is narrower than width, or padded with zeros if the register is wider than width.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_WriteZeros16 (int32_t cardIndex, int32_t module, uint32_t offset, uint32_t count)
	Writes zeros to a given number of contiguous 16-bit registers.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_ReadReg32 (int32_t cardIndex, int32_t module, uint32_t offset, uint32_t *data)
	Reads a value from a 32-bit register.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_WriteReg32 (int32_t cardIndex, int32_t module, uint32_t offset, uint32_t data)
	Writes a value to a 32-bit register.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_WriteRegMask32 (int32_t cardIndex, int32_t module, uint32_t offset, uint32_t mask, uint32_t value)
	Writes a value to a 32-bit register, 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.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_MaskReg32 (int32_t cardIndex, int32_t module, uint32_t offset, uint32_t mask, nai_maskreg_op_t maskop)
	Writes a value to a 32-bit register, either clearing, setting or toggling only the bit positions that are set in mask. The mask and value may be truncated or padded with zeros depending on the register width.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_Read32 (int32_t cardIndex, int32_t module, uint32_t offset, uint32_t stride, uint32_t count, uint32_t dataWidth, void *data)
	Reads from 32-bit registers. The data will be truncated if the register is wider than width, or padded with zeros if the register is narrower than width.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_Write32 (int32_t cardIndex, int32_t module, uint32_t offset, uint32_t stride, uint32_t count, uint32_t dataWidth, const void *data)
	Writes to 32-bit registers. The data will be truncated if the register is narrower than width, or padded with zeros if the register is wider than width.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_1553BM_SendAndReceive (int32_t cardIndex, int32_t module, uint32_t txoffset, uint32_t rxoffset, uint32_t rxcountoffset, const uint32_t txbuffer, uint32_t txcount, uint32_t rxbuffer, uint32_t rxcount)
	This function is used for the host application to communicate with the 1553 module bare metal via two FIFOs, the In FIFO and the Out FIFO. Commands to the bare metal are sent via the In FIFO and responses from the bare metal are received in the Out FIFO.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_WriteZeros32 (int32_t cardIndex, int32_t module, uint32_t offset, uint32_t count)
	Writes zeros to a given number of contiguous 32-bit registers.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_ReadFifo32 (int32_t cardIndex, int32_t module, uint32_t dataoffset, uint32_t countoffset, uint32_t count, uint32_t countremaining, uint32_t timeout, uint32_t width, void data, uint32_t *outread)
	Attempts to read a fifo. If 'timeout' is set to NAIBRD_FIFO_TIMEOUT_NONE, 'count' will specify the maximum number of elements to read. The operation will not block and read up to 'count' words from the fifo. Otherwise, 'count' will specify an absolute number of elements to read and the operation waits up to 'timeout' milliseconds for the FIFO's count to be equal to or exceed 'count' before performing the read. If it times out, no data is read.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_WriteFifo32 (int32_t cardIndex, int32_t module, uint32_t dataoffset, uint32_t countoffset, uint32_t count, uint32_t fifosize, uint32_t timeout, uint32_t datawidth, const void data, uint32_t outwritten)
	Attempts to write to a fifo. If timeout is set to NAIBRD_FIFO_TIMEOUT_NONE, the operation does not block and up to count words are written from the fifo. Otherwise, the operation waits up to timeout milliseconds for the FIFO's count to drop to (fifosize-count) before performing the write. If it times out, no data is written.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_BlockOp (int32_t masterCardIndex, int32_t slaveCardIndex, uint16_t blockid, uint32_t regwidth, uint32_t count, naibrd_blockAccessOp_t blockOp, uint32_t address[], uint32_t data[])
	This function writes data array to corresponding register address array. The benefit of using this function is that during Ethernet communication multiple data can be packed in one Ethernet message and hence increases through put.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_ZBlockOp (int32_t masterCardIndex, uint16_t zblockid, uint32_t regwidth, uint32_t count, naibrd_blockAccessOp_t blockOp, uint16_t addrflags[], uint32_t address[], uint32_t data[])
	This function writes data array to corresponding register address array. The difference between this function and naibrd_BlockOp is that this function takes advantage of the Ethernet Z-Block Command which provides the capability to access on-board and off-board registers within the same Ethernet command. The benefit of using this function is that during Ethernet communication multiple data (inboard and off-board) can be packed in one Ethernet message and hence increases through put.

Detailed Description

Function Documentation

◆ naibrd_1553BM_SendAndReceive()

NAIBRDFUNC nai_status_t NAIAPI naibrd_1553BM_SendAndReceive	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	txoffset,
		uint32_t	rxoffset,
		uint32_t	rxcountoffset,
		const uint32_t *	txbuffer,
		uint32_t	txcount,
		uint32_t *	rxbuffer,
		uint32_t	rxcount )

This function is used for the host application to communicate with the 1553 module bare metal via two FIFOs, the In FIFO and the Out FIFO. Commands to the bare metal are sent via the In FIFO and responses from the bare metal are received in the Out FIFO.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number to write to, or NAIBRD_MOTHERBOARD.
txoffset	: (Input) The address of the In FIFO's data register.
rxoffset	: (Input) The address of the Out FIFO's data register.
rxcountoffset	: (Input) The address of the Out FIFO count register.
txbuffer	: (Input) Buffer containing data to place in In FIFO.
txcount	: (Input) Number of words to place in In FIFO.
rxbuffer	: (Output) Pointer to array to store rx data from Out FIFO.
rxcount	: (Input) The number of elements received from the Out FIFO.

Returns

NAI_SUCCESS when the board is ready.
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when the module number is invalid.
An error returned by naibrd_BusWrite or the writeFnc specified by naibrd_SetIOFnc.

◆ naibrd_BlockOp()

NAIBRDFUNC nai_status_t NAIAPI naibrd_BlockOp	(	int32_t	masterCardIndex,
		int32_t	slaveCardIndex,
		uint16_t	blockid,
		uint32_t	regwidth,
		uint32_t	count,
		naibrd_blockAccessOp_t	blockOp,
		uint32_t	address[],
		uint32_t	data[] )

This function writes data array to corresponding register address array. The benefit of using this function is that during Ethernet communication multiple data can be packed in one Ethernet message and hence increases through put.

Parameters

masterCardIndex	: (Input) Master Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
slaveCardIndex	: (Input) Slave Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
blockid	: (Input) The block ID is used access the internal blockAccess data structure or used in naibrd_Ether_SetBlock(...) and naibrd_Ether_WriteBlock(...) for Ethernet operation (1 - NAI_MAX_BLOCK_ACCESS).
regwidth	: (Input) Specify the 16/32 bit register width for Gen2-3(16Bits) or Gen5(32Bits) boards (0 - NAI_MAX_CARDS-1).
count	: (Input) The total number of registers define in the block (1 - MAX_ETHER_BLOCK_REG_CNT).
blockOp	: (Input) Block access operation. Refer to naibrd_blockAccessOp_t for definition.
address	: (Input) List of Register Addresses.
data	: (Input) List of data to be written to the address in the address array.

Returns

NAI_SUCCESS when the board is ready.
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_VALUE when the count is out of range.
An error returned by naibrd_BusWriteFifo or the writefifoFnc specified by naibrd_SetFifoIOFnc.

◆ naibrd_MaskReg16()

NAIBRDFUNC nai_status_t NAIAPI naibrd_MaskReg16	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	offset,
		uint16_t	mask,
		nai_maskreg_op_t	maskop )

Writes a value to a 16-bit register, either clearing, setting or toggling only the bit positions that are set in mask. The mask and value may be truncated or padded with zeros depending on the register width.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number to write to, or NAIBRD_MOTHERBOARD.
offset	: (Input) The offset from the module or board start address to start writing.
mask	: (Input) The bits to change in the register.
maskop	: (Input) The operation to perform on the data at the address specified.

Returns

NAI_SUCCESS when the board is ready.
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when the module number is invalid.
An error returned by naibrd_BusMaskReg or the MaskRegFnc specified by naibrd_SetIOFnc.

◆ naibrd_MaskReg32()

NAIBRDFUNC nai_status_t NAIAPI naibrd_MaskReg32	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	offset,
		uint32_t	mask,
		nai_maskreg_op_t	maskop )

Writes a value to a 32-bit register, either clearing, setting or toggling only the bit positions that are set in mask. The mask and value may be truncated or padded with zeros depending on the register width.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number to write to, or NAIBRD_MOTHERBOARD.
offset	: (Input) The offset from the module or board start address to start writing.
mask	: (Input) The bits to change in the register.
maskop	: (Input) The operation to perform on the data at the address specified.

Returns

NAI_SUCCESS when the board is ready.
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when the module number is invalid.
An error returned by naibrd_BusMaskReg or the MaskRegFnc specified by naibrd_SetIOFnc.

◆ naibrd_Read16()

NAIBRDFUNC nai_status_t NAIAPI naibrd_Read16	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	offset,
		uint32_t	stride,
		uint32_t	count,
		uint32_t	dataWidth,
		void *	data )

Reads from 16-bit registers. The data will be truncated if the register is wider than width, or padded with zeros if the register is narrower than width.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number to read from, or NAIBRD_MOTHERBOARD.
offset	: (Input) The offset from the module or board start address to start reading.
stride	: (Input) The amount to increment the address after each individual read.
count	: (Input) The total number of elements to read.
dataWidth	: (Input) The width of the elements in data, in bytes.
data	: (Output) The array to receive the values of the registers.

Returns

NAI_SUCCESS when the board is ready.
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when the module number is invalid.
An error returned by naibrd_BusRead or the readFnc specified by naibrd_SetIOFnc.

◆ naibrd_Read32()

NAIBRDFUNC nai_status_t NAIAPI naibrd_Read32	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	offset,
		uint32_t	stride,
		uint32_t	count,
		uint32_t	dataWidth,
		void *	data )

Reads from 32-bit registers. The data will be truncated if the register is wider than width, or padded with zeros if the register is narrower than width.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number to read from, or NAIBRD_MOTHERBOARD.
offset	: (Input) The offset from the module or board start address to start reading.
stride	: (Input) The amount to increment the address after each individual read.
count	: (Input) The total number of elements to read.
dataWidth	: (Input) The width of the elements in data, in bytes.
data	: (Output) The array to receive the values of the registers.

Returns

NAI_SUCCESS when the board is ready.
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when the module number is invalid.
An error returned by naibrd_BusRead or the readFnc specified by naibrd_SetIOFnc.

◆ naibrd_ReadFifo32()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ReadFifo32	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	dataoffset,
		uint32_t	countoffset,
		uint32_t	count,
		uint32_t *	countremaining,
		uint32_t	timeout,
		uint32_t	width,
		void *	data,
		uint32_t *	outread )

Attempts to read a fifo. If 'timeout' is set to NAIBRD_FIFO_TIMEOUT_NONE, 'count' will specify the maximum number of elements to read. The operation will not block and read up to 'count' words from the fifo. Otherwise, 'count' will specify an absolute number of elements to read and the operation waits up to 'timeout' milliseconds for the FIFO's count to be equal to or exceed 'count' before performing the read. If it times out, no data is read.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number to read from, or NAIBRD_MOTHERBOARD.
dataoffset	: (Input) The offset from the module or board start address to the FIFO's data register.
countoffset	: (Input) The offset from the module or board start address to the FIFO's count register.
count	: (Input) The number of elements to read from the FIFO. This value can be a 'maximum' or an 'absolute' value depending on the 'timeout' parameter (See 'timeout').
countremaining	: (Output) The number of elements remaining in the FIFO.
timeout	: (Input) If the 'count' parameter specifies an absolute number of elements to read from the FIFO, then 'timeout' is the amount of time, in milliseconds, to wait for the number of elements in the FIFO to reach 'count' before timing out. If the 'count' parameter specifies the maximum number of elements that can be from the FIFO, then use NAIBRD_FIFO_TIMEOUT_NONE for the timeout parameter. This will cause the FIFO to be read (up to but not exceeding 'count') and immediately return to the caller.
width	: (Input) The width of the elements in data, in bytes.
data	: (Output) An array to store the values read.
outread	: (Output) The number of elements read.

Returns

NAI_SUCCESS when the board is ready.
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when the module number is invalid.
NAI_ERROR_TIMEOUT when the number of elements in the FIFO does not equal 'count' in the time specified by 'timeout'. This only applies when timeout is a time (in mS) and not NAIBRD_FIFO_TIMEOUT_NONE
An error returned by naibrd_BusReadFifo or the readfifoFnc specified by naibrd_SetFifoIOFnc.

◆ naibrd_ReadReg16()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ReadReg16	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	offset,
		uint16_t *	data )

Reads a value from a 16-bit register.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number to read from, or NAIBRD_MOTHERBOARD.
offset	: (Input) The offset from the module or board start address to start writing.
data	: (Output) The value read.

Returns

NAI_SUCCESS when the board is ready.
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when the module number is invalid.
An error returned by naibrd_Read32.

◆ naibrd_ReadReg32()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ReadReg32	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	offset,
		uint32_t *	data )

Reads a value from a 32-bit register.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number to read from, or NAIBRD_MOTHERBOARD.
offset	: (Input) The offset from the module or board start address to start writing.
data	: (Output) The value read.

Returns

NAI_SUCCESS when the board is ready.
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when the module number is invalid.
An error returned by naibrd_Read32.

◆ naibrd_Write16()

NAIBRDFUNC nai_status_t NAIAPI naibrd_Write16	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	offset,
		uint32_t	stride,
		uint32_t	count,
		uint32_t	dataWidth,
		const void *	data )

Writes to 16-bit register. The data will be truncated if the register is narrower than width, or padded with zeros if the register is wider than width.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number to write to, or NAIBRD_MOTHERBOARD.
offset	: (Input) The offset from the module or board start address to start writing.
stride	: (Input) The amount to increment the address after each individual write.
count	: (Input) The total number of elements to write.
dataWidth	: (Input) The width of the elements in data, in bytes.
data	: (Input) The array that contains the values to write to the registers.

Returns

NAI_SUCCESS when the board is ready.
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when the module number is invalid.
An error returned by naibrd_BusWrite or the writeFnc specified by naibrd_SetIOFnc.

◆ naibrd_Write32()

NAIBRDFUNC nai_status_t NAIAPI naibrd_Write32	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	offset,
		uint32_t	stride,
		uint32_t	count,
		uint32_t	dataWidth,
		const void *	data )

Writes to 32-bit registers. The data will be truncated if the register is narrower than width, or padded with zeros if the register is wider than width.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number to write to, or NAIBRD_MOTHERBOARD.
offset	: (Input) The offset from the module or board start address to start writing.
stride	: (Input) The amount to increment the address after each individual write.
count	: (Input) The total number of elements to write.
dataWidth	: (Input) The width of the elements in data, in bytes.
data	: (Input) The array that contains the values to write to the registers.

Returns

NAI_SUCCESS when the board is ready.
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when the module number is invalid.
An error returned by naibrd_BusWrite or the writeFnc specified by naibrd_SetIOFnc.

◆ naibrd_WriteFifo32()

NAIBRDFUNC nai_status_t NAIAPI naibrd_WriteFifo32	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	dataoffset,
		uint32_t	countoffset,
		uint32_t	count,
		uint32_t	fifosize,
		uint32_t	timeout,
		uint32_t	datawidth,
		const void *	data,
		uint32_t *	outwritten )

Attempts to write to a fifo. If timeout is set to NAIBRD_FIFO_TIMEOUT_NONE, the operation does not block and up to count words are written from the fifo. Otherwise, the operation waits up to timeout milliseconds for the FIFO's count to drop to (fifosize-count) before performing the write. If it times out, no data is written.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number to read from, or NAIBRD_MOTHERBOARD.
dataoffset	: (Input) The offset from the module or board start address to the FIFO's data register.
countoffset	: (Input) The offset from the module or board start address to the FIFO's count register.
count	: (Input) The number of elements to write to the FIFO.
fifosize	: (Input) The maximum number of elements the FIFO can hold.
timeout	: (Input) The amount of time, in milliseconds, to wait for the FIFO's count to drop to (fifosize-count) before timing out.
datawidth	: (Input) The width of the elements in data, in bytes.
data	: (Output) An array containing the values to write.
outwritten	: (Output) The number of elements written.

Returns

NAI_SUCCESS when the board is ready.
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when the module number is invalid.
An error returned by naibrd_BusWriteFifo or the writefifoFnc specified by naibrd_SetFifoIOFnc.

◆ naibrd_WriteReg16()

NAIBRDFUNC nai_status_t NAIAPI naibrd_WriteReg16	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	offset,
		uint16_t	data )

Writes a value to a 16-bit register.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number to write to, or NAIBRD_MOTHERBOARD.
offset	: (Input) The offset from the module or board start address to start writing.
data	: (Input) The value to write.

Returns

NAI_SUCCESS when the board is ready.
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when the module number is invalid.
An error returned by naibrd_Write32.

◆ naibrd_WriteReg32()

NAIBRDFUNC nai_status_t NAIAPI naibrd_WriteReg32	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	offset,
		uint32_t	data )

Writes a value to a 32-bit register.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number to write to, or NAIBRD_MOTHERBOARD.
offset	: (Input) The offset from the module or board start address to start writing.
data	: (Input) The value to write.

Returns

NAI_SUCCESS when the board is ready.
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when the module number is invalid.
An error returned by naibrd_Write32.

◆ naibrd_WriteRegMask16()

NAIBRDFUNC nai_status_t NAIAPI naibrd_WriteRegMask16	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	offset,
		uint16_t	mask,
		uint16_t	value )

Writes a value to a 16-bit register, 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.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number to write to, or NAIBRD_MOTHERBOARD.
offset	: (Input) The offset from the module or board start address to start writing.
mask	: (Input) The bits to change in the register.
value	: (Input) The value to write. Not that only the bit positions set in mask will be used.

Returns

NAI_SUCCESS when the board is ready.
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when the module number is invalid.
An error returned by naibrd_BusWriteRegMask or the writeMaskFnc specified by naibrd_SetIOFnc.

◆ naibrd_WriteRegMask32()

NAIBRDFUNC nai_status_t NAIAPI naibrd_WriteRegMask32	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	offset,
		uint32_t	mask,
		uint32_t	value )

Writes a value to a 32-bit register, 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.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number to write to, or NAIBRD_MOTHERBOARD.
offset	: (Input) The offset from the module or board start address to start writing.
mask	: (Input) The bits to change in the register.
value	: (Input) The value to write. Note that only the bit positions set in mask will be used.

Returns

NAI_SUCCESS when the board is ready.
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when the module number is invalid.
An error returned by naibrd_BusWriteRegMask or the writeMaskFnc specified by naibrd_SetIOFnc.

◆ naibrd_WriteZeros16()

NAIBRDFUNC nai_status_t NAIAPI naibrd_WriteZeros16	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	offset,
		uint32_t	count )

Writes zeros to a given number of contiguous 16-bit registers.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number to write to, or NAIBRD_MOTHERBOARD.
offset	: (Input) The offset from the module or board start address to start writing.
count	: (Input) The total number of elements to write.

Returns

NAI_SUCCESS when the board is ready.
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when the module number is invalid.
An error returned by naibrd_BusWrite or the writeFnc specified by naibrd_SetIOFnc.

◆ naibrd_WriteZeros32()

NAIBRDFUNC nai_status_t NAIAPI naibrd_WriteZeros32	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	offset,
		uint32_t	count )

Writes zeros to a given number of contiguous 32-bit registers.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number to write to, or NAIBRD_MOTHERBOARD.
offset	: (Input) The offset from the module or board start address to start writing.
count	: (Input) The total number of elements to write.

Returns

NAI_SUCCESS when the board is ready.
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when the module number is invalid.
An error returned by naibrd_BusWrite or the writeFnc specified by naibrd_SetIOFnc.

◆ naibrd_ZBlockOp()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ZBlockOp	(	int32_t	masterCardIndex,
		uint16_t	zblockid,
		uint32_t	regwidth,
		uint32_t	count,
		naibrd_blockAccessOp_t	blockOp,
		uint16_t	addrflags[],
		uint32_t	address[],
		uint32_t	data[] )

This function writes data array to corresponding register address array. The difference between this function and naibrd_BlockOp is that this function takes advantage of the Ethernet Z-Block Command which provides the capability to access on-board and off-board registers within the same Ethernet command. The benefit of using this function is that during Ethernet communication multiple data (inboard and off-board) can be packed in one Ethernet message and hence increases through put.

Parameters

masterCardIndex	: (Input) Master Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
zblockid	: (Input) The block ID is used access the internal blockAccess data structure or used in naibrd_Ether_SetZBlock(...) and naibrd_Ether_WriteZBlock(...) for Ethernet operation (1 - NAI_MAX_BLOCK_ACCESS).
regwidth	: (Input) Specify the 16/32 bit register width for Gen2-3(16Bits) or Gen5(32Bits) boards (0 - NAI_MAX_CARDS-1).
count	: (Input) The total number of registers define in the block (1 - MAX_ETHER_BLOCK_REG_CNT).
blockOp	: (Input) Block access operation. Refer to naibrd_blockAccessOp_t for definition.
addrflags	: (Input) List of Address Flags (on-board or off-board) associated with list of register addresses.
address	: (Input) List of Register Addresses.
data	: (Input) List of data to be written to the address in the address array.

Returns

NAI_SUCCESS when the board is ready.
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_VALUE when the count is out of range.
An error returned by naibrd_BusWriteFifo or the writefifoFnc specified by naibrd_SetFifoIOFnc.

Functions

Detailed Description

Function Documentation

◆ naibrd_1553BM_SendAndReceive()

◆ naibrd_BlockOp()

◆ naibrd_MaskReg16()

◆ naibrd_MaskReg32()

◆ naibrd_Read16()

◆ naibrd_Read32()

◆ naibrd_ReadFifo32()

◆ naibrd_ReadReg16()

◆ naibrd_ReadReg32()

◆ naibrd_Write16()

◆ naibrd_Write32()

◆ naibrd_WriteFifo32()

◆ naibrd_WriteReg16()

◆ naibrd_WriteReg32()

◆ naibrd_WriteRegMask16()

◆ naibrd_WriteRegMask32()

◆ naibrd_WriteZeros16()

◆ naibrd_WriteZeros32()

◆ naibrd_ZBlockOp()