Advanced Log Functions

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_Log_CopyDataToScratchpad (int32_t cardIndex, uint32_t offset, uint32_t reqCount, uint32_t *p_outresponseCode)
	Copies the data from the Logging (FRAM) device that is connected to the platform processor to the Scratchpad Register area so that it can be accessed via the Native Bus (PCI/cPCI/PCIe, VME).
NAIBRDFUNC nai_status_t NAIAPI	naibrd_Log_ClearData (int32_t cardIndex, uint32_t offset, uint32_t reqCount, uint32_t *p_outresponseCode)
	Clears the data in the Log (FRAM) device that is connected to the platform processor.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_Log_ClearAllData (int32_t cardIndex, uint32_t *p_outresponseCode)
	Clears all the data in the Log (FRAM) device that is connected to the platform processor.

Detailed Description

Function Documentation

naibrd_Log_ClearAllData()

NAIBRDFUNC nai_status_t NAIAPI naibrd_Log_ClearAllData	(	int32_t	cardIndex,
		uint32_t *	p_outresponseCode )

Clears all the data in the Log (FRAM) device that is connected to the platform processor.

Important Note - This function works in conjunction with the MBCore application running on Motherboard Processor that the Log (FRAM) device is connected to. This function can be used to retrieve the Log (FRAM) device on a Slave board when access is via the native bus (PCI/PCIe/VME) or when accessing the Log (FRAM) device for the processor (Zynq or Ultrascale) on a board that has a host processor (PPC/Intel - 68PPC2, 67PPC2, etc).

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
p_outresponseCode	: (Output) Response code associated with command requested.

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_VALUE when invalid parameter is specified.

naibrd_Log_ClearData()

NAIBRDFUNC nai_status_t NAIAPI naibrd_Log_ClearData	(	int32_t	cardIndex,
		uint32_t	offset,
		uint32_t	reqCount,
		uint32_t *	p_outresponseCode )

Clears the data in the Log (FRAM) device that is connected to the platform processor.

Important Note - This function works in conjunction with the MBCore application running on Motherboard Processor that the Log (FRAM) device is connected to. This function can be used to retrieve the Log (FRAM) device on a Slave board when access is via the native bus (PCI/PCIe/VME) or when accessing the Log (FRAM) device for the processor (Zynq or Ultrascale) on a board that has a host processor (PPC/Intel - 68PPC2, 67PPC2, etc).

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
offset	: (Input) Offset address on the FRAM to start clearing.
reqCount	: (Input) Number of bytes to clear from Log device from the offset address specified.
p_outresponseCode	: (Output) Response code associated with command requested.

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_VALUE when invalid parameter is specified.

naibrd_Log_CopyDataToScratchpad()

NAIBRDFUNC nai_status_t NAIAPI naibrd_Log_CopyDataToScratchpad	(	int32_t	cardIndex,
		uint32_t	offset,
		uint32_t	reqCount,
		uint32_t *	p_outresponseCode )

Copies the data from the Logging (FRAM) device that is connected to the platform processor to the Scratchpad Register area so that it can be accessed via the Native Bus (PCI/cPCI/PCIe, VME).

Important Note - This function works in conjunction with the MBCore application running on Motherboard Processor that the Log (FRAM) device is connected to. This function can be used to retrieve the Log (FRAM) device on a Slave board when access is via the native bus (PCI/PCIe/VME) or when accessing the Log (FRAM) device for the processor (Zynq or Ultrascale) on a board that has a host processor (PPC/Intel - 68PPC2, 67PPC2, etc).

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
offset	: (Input) Offset address on the FRAM to read.
reqCount	: (Input) Number of bytes to read from Log device from the offset address specified.
p_outresponseCode	: (Output) Response code associated with command requested.

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_VALUE when invalid parameter is specified.