Level 2 APIs

Functions
N957_DLL_API N957_API	N957_StartAcquire (int32_t handle, N957ControlModes mode)
	Starts an acquisition.
N957_DLL_API N957_API	N957_PauseAcquire (int32_t handle)
	Pauses acquisition: internal buffer will NOT be resetted and scaler and timers will not be stopped.
N957_API	N957_ResumeAcquire (int32_t handle)
	Resumes acquisition from pause.
N957_DLL_API N957_API	N957_StopAcquire (int32_t handle)
	Stops acquisition: scaler and timers will be stopped (internal buffer still keep data: use N957_SwClear to clear data/scaler/timers).
N957_DLL_API N957_API	N957_ReadData (int32_t handle, N957_UINT16 *data_buff, N957_UINT16 *read_data)
	Reads a block of data.
N957_DLL_API N957_API	N957_GetConfigROM (int32_t handle, N957_ConfigROM *config_rom)
	Gets the configuration ROM stored into board flash.
N957_DLL_API N957_API	N957_FwUpgrade (int32_t handle, const N957_BYTE *data_buff, N957_UINT32 data_size, N957FlashPageTypes page_type)
	Updates board firmware.

---

Function Documentation

N957_API N957_FwUpgrade	(	int32_t	handle,
		const N957_BYTE *	data_buff,
		N957_UINT32	data_size,
		N957FlashPageTypes	page_type
	)

Updates board firmware.

Parameters:

	handle	board's handle
	data_buff,:	firmware data buffer
	data_size	buffer size (BYTEs)
	page_type	the type of page to download (Boot or Backup)

Returns:

N957Success: procedure executed correctly : error code otherwise

See also:

N957ErrorCodes

N957FlashPageTypes

Note:

handle must be a valid one (as returned from N957_Init)

N957_API N957_GetConfigROM	(	int32_t	handle,
		N957_ConfigROM *	config_rom
	)

Gets the configuration ROM stored into board flash.

Parameters:

	handle	board's handle
	config_rom	The configuration ROM buffer (caller allocated)

Returns:

N957Success: procedure executed correctly : error code otherwise

See also:

N957ErrorCodes

N957_ConfigROM

Note:

handle must be a valid one (as returned from N957_Init)

N957_API N957_PauseAcquire

(

int32_t

handle

)

Pauses acquisition: internal buffer will NOT be resetted and scaler and timers will not be stopped.

Parameters:

handle

board's handle

Returns:

N957Success: procedure executed correctly : error code otherwise

See also:

N957ErrorCodes

Note:

handle must be a valid one (as returned from N957_Init)

N957_API N957_ReadData	(	int32_t	handle,
		N957_UINT16 *	data_buff,
		N957_UINT16 *	read_data
	)

Reads a block of data.

Parameters:

	handle	board's handle
	data_buff	data buffer (caller allocated)
	read_data	The buffer size on input (WORDs) and the number of WORDs read on output

Returns:

N957Success: procedure executed correctly : error code otherwise

See also:

N957ErrorCodes

Note:

handle must be a valid one (as returned from N957_Init) and acquisition must be started

N957_API N957_ResumeAcquire

(

int32_t

handle

)

Resumes acquisition from pause.

Parameters:

handle

board's handle

Returns:

N957Success: procedure executed correctly : error code otherwise

See also:

N957ErrorCodes

Note:

handle must be a valid one (as returned from N957_Init)

N957_API N957_StartAcquire	(	int32_t	handle,
		N957ControlModes	mode
	)

Starts an acquisition.

Parameters:

	handle	board's handle
	mode	acquisition mode

Returns:

N957Success: procedure executed correctly : error code otherwise

See also:

N957ErrorCodes

N957ControlModes

Note:

handle must be a valid one (as returned from N957_Init)

N957_API N957_StopAcquire

(

int32_t

handle

)

Stops acquisition: scaler and timers will be stopped (internal buffer still keep data: use N957_SwClear to clear data/scaler/timers).

Parameters:

handle

board's handle

Returns:

N957Success: procedure executed correctly : error code otherwise

See also:

N957ErrorCodes

Note:

handle must be a valid one (as returned from N957_Init)