Level 1 APIs


Functions

N957_DLL_API N957_API N957_GetStatus (int32_t handle, N957_UINT16 *data)
 Gets Status register.
N957_DLL_API N957_API N957_GetControl (int32_t handle, N957_UINT16 *data)
 Gets Control register.
N957_DLL_API N957_API N957_SetControl (int32_t handle, N957_UINT16 data)
 Sets Control register.
N957_DLL_API N957_API N957_GetFWRelease (int32_t handle, char *FwRel, int buff_size)
 Gets firmare release string.
N957_DLL_API N957_API N957_GetDAC (int32_t handle, N957_UINT16 *data)
 Gets DAC register.
N957_DLL_API N957_API N957_SetDAC (int32_t handle, N957_UINT16 data)
 Sets DAC register.
N957_DLL_API N957_API N957_GetBlDim (int32_t handle, N957_UINT16 *data)
 Gets Block Dimension register.
N957_DLL_API N957_API N957_GetPulser (int32_t handle, N957_UINT16 *data)
 Gets Pulser register.
N957_DLL_API N957_API N957_SetPulser (int32_t handle, N957_UINT16 data)
 Sets Pulser register.
N957_DLL_API N957_API N957_GetFwDwnld (int32_t handle, N957_UINT16 *data)
 Gets Firmware Download register.
N957_DLL_API N957_API N957_SetFwDwnld (int32_t handle, N957_UINT16 data)
 Sets Firmware Download register.
N957_DLL_API N957_API N957_GetFlashEna (int32_t handle, N957_UINT16 *data)
 Gets Flash Enable register.
N957_DLL_API N957_API N957_SetFlashEna (int32_t handle, N957_UINT16 data)
 Sets Flash Enable register.
N957_DLL_API N957_API N957_GetUsbFlag (int32_t handle, N957_BOOL *usb_high_speed)
 Gets USB flag status.
N957_DLL_API N957_API N957_GetMemEmptyFlag (int32_t handle, N957_BOOL *data)
 Gets memory empty flag status.
N957_DLL_API N957_API N957_GetMemFullFlag (int32_t handle, N957_BOOL *data)
 Gets memory full status flag.
N957_DLL_API N957_API N957_GetFlashBusyFlag (int32_t handle, N957_BOOL *data)
 Gets Flash busy status flag.
N957_DLL_API N957_API N957_GetAcqModeFlag (int32_t handle, N957_BOOL *data)
 Gets Acquisition mode control flag.
N957_DLL_API N957_API N957_SetAcqModeFlag (int32_t handle, N957_BOOL data)
 Sets Acquisition mode control flag.
N957_DLL_API N957_API N957_GetADCRate (int32_t handle, N957ControlADCRates *rate)
 Gets ADC rate.
N957_DLL_API N957_API N957_SetADCRate (int32_t handle, N957ControlADCRates rate)
 Sets ADC rate.
N957_DLL_API N957_API N957_GetSlsFlag (int32_t handle, N957_BOOL *data)
 Gets Sliding scale control flag.
N957_DLL_API N957_API N957_SetSlsFlag (int32_t handle, N957_BOOL data)
 Sets Sliding scale control flag.
N957_DLL_API N957_API N957_SwReset (int32_t handle)
 Performs a software reset.
N957_DLL_API N957_API N957_SwClear (int32_t handle)
 Performs a software clear.
N957_DLL_API N957_API N957_GetConvEnFlag (int32_t handle, N957_BOOL *data)
 Gets Convertion enable control flag.
N957_DLL_API N957_API N957_SetConvEnFlag (int32_t handle, N957_BOOL data)
 Sets Convertion enable control flag.
N957_DLL_API N957_API N957_GetSwConvFlag (int32_t handle, N957_BOOL *data)
 Gets Software convertion control flag.
N957_DLL_API N957_API N957_SetSwConvFlag (int32_t handle, N957_BOOL data)
 Sets Software convertion control flag.
N957_DLL_API N957_API N957_GetPurEnFlag (int32_t handle, N957_BOOL *data)
 Gets Pile UP rejection control flag.
N957_DLL_API N957_API N957_SetPurEnFlag (int32_t handle, N957_BOOL data)
 Sets Pile UP rejection control flag.
N957_DLL_API N957_API N957_GetAcquisitionMode (int32_t handle, N957ControlModes *mode)
 Gets acquisition mode.
N957_DLL_API N957_API N957_SetAcquisitionMode (int32_t handle, N957ControlModes mode)
 Sets acquisition mode.
N957_DLL_API N957_API N957_GetBufferOccupancy (int32_t handle, N957_UINT16 *buffer_size)
 Gets the data buffer occupancy.
N957_DLL_API N957_API N957_GetRawData (int32_t handle, N957_UINT16 *data_buff, N957_UINT16 *read_data)
 Gets raw data from board FIFO.
N957_DLL_API N957_API N957_GetScaler (int32_t handle, N957_UINT32 *scaler)
 Gets the scaler counter.
N957_DLL_API N957_API N957_GetTimer (int32_t handle, N957_UINT32 *timer)
 Gets the timer value.
N957_DLL_API N957_API N957_GetLiveTime (int32_t handle, N957_UINT32 *live_time)
 Gets the live time timer value.
N957_DLL_API N957_API N957_SetLLD (int32_t handle, N957_BYTE lld)
 Sets the low level detect treshold.
N957_DLL_API N957_API N957_ReadFlashPage (int32_t handle, N957_BYTE data_buff[N957_FLASH_PAGE_SIZE], N957_UINT16 page_number)
 Reads a page from flash.
N957_DLL_API N957_API N957_WriteFlashPage (int32_t handle, N957_BYTE data_buff[N957_FLASH_PAGE_SIZE], N957_UINT16 page_number)
 Reads a page from flash.
N957_DLL_API N957_API N957_EraseFlashPage (int32_t handle, N957_UINT16 page_number)
 Reads a page from flash.

Function Documentation

N957_API N957_EraseFlashPage ( int32_t  handle,
N957_UINT16  page_number 
)

Reads a page from flash.

Parameters:
handle board's handle
page_number number of the page to erase
Returns:
N957Success: procedure ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_GetAcqModeFlag ( int32_t  handle,
N957_BOOL *  data 
)

Gets Acquisition mode control flag.

Parameters:
handle board's handle
data data read
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_GetAcquisitionMode ( int32_t  handle,
N957ControlModes *  mode 
)

Gets acquisition mode.

Parameters:
handle board's handle
mode acquisition mode
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes

N957ControlModes

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

N957_API N957_GetADCRate ( int32_t  handle,
N957ControlADCRates *  rate 
)

Gets ADC rate.

Parameters:
handle board's handle
rate data read
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes

N957ControlADCRates

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

N957_API N957_GetBlDim ( int32_t  handle,
N957_UINT16 *  data 
)

Gets Block Dimension register.

Parameters:
handle board's handle
data data read
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_GetBufferOccupancy ( int32_t  handle,
N957_UINT16 *  buffer_size 
)

Gets the data buffer occupancy.

Parameters:
handle board's handle
buffer_size The buffer occupancy (WORDs)
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_GetControl ( int32_t  handle,
N957_UINT16 *  data 
)

Gets Control register.

Parameters:
handle board's handle
data data read
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_GetConvEnFlag ( int32_t  handle,
N957_BOOL *  data 
)

Gets Convertion enable control flag.

Parameters:
handle board's handle
data data read
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_GetDAC ( int32_t  handle,
N957_UINT16 *  data 
)

Gets DAC register.

Parameters:
handle board's handle
data data read
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_GetFlashBusyFlag ( int32_t  handle,
N957_BOOL *  data 
)

Gets Flash busy status flag.

Parameters:
handle board's handle
data data read
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_GetFlashEna ( int32_t  handle,
N957_UINT16 *  data 
)

Gets Flash Enable register.

Parameters:
handle board's handle
data data read
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_GetFwDwnld ( int32_t  handle,
N957_UINT16 *  data 
)

Gets Firmware Download register.

Parameters:
handle board's handle
data data read
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_GetFWRelease ( int32_t  handle,
char *  FwRel,
int  buff_size 
)

Gets firmare release string.

The firmware release string format is : ##.## ( major_version.minor_version )

Parameters:
handle board's handle
FwRel Firmware release buffer (caller allocated) to be filled with firmware release string
buff_size Allocated buffer size (BYTEs)
Returns:
N957Success: procedure execution ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_GetLiveTime ( int32_t  handle,
N957_UINT32 *  live_time 
)

Gets the live time timer value.

Parameters:
handle board's handle
live_time The live time timer value (1 msec resolution)
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_GetMemEmptyFlag ( int32_t  handle,
N957_BOOL *  data 
)

Gets memory empty flag status.

Parameters:
handle board's handle
data data read
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_GetMemFullFlag ( int32_t  handle,
N957_BOOL *  data 
)

Gets memory full status flag.

Parameters:
handle board's handle
data data read
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_GetPulser ( int32_t  handle,
N957_UINT16 *  data 
)

Gets Pulser register.

Parameters:
handle board's handle
data data read
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_GetPurEnFlag ( int32_t  handle,
N957_BOOL *  data 
)

Gets Pile UP rejection control flag.

Parameters:
handle board's handle
data data read
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

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

Gets raw data from board FIFO.

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: read ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_GetScaler ( int32_t  handle,
N957_UINT32 *  scaler 
)

Gets the scaler counter.

This is the number of convertions occurred

Parameters:
handle board's handle
scaler The scaler value (bits)
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_GetSlsFlag ( int32_t  handle,
N957_BOOL *  data 
)

Gets Sliding scale control flag.

Parameters:
handle board's handle
data data read
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_GetStatus ( int32_t  handle,
N957_UINT16 *  data 
)

Gets Status register.

Parameters:
handle board's handle
data data read
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_GetSwConvFlag ( int32_t  handle,
N957_BOOL *  data 
)

Gets Software convertion control flag.

Parameters:
handle board's handle
data data read
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_GetTimer ( int32_t  handle,
N957_UINT32 *  timer 
)

Gets the timer value.

Parameters:
handle board's handle
timer The timer value (1 msec resolution)
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_GetUsbFlag ( int32_t  handle,
N957_BOOL *  usb_high_speed 
)

Gets USB flag status.

Parameters:
handle board's handle
usb_high_speed USB port type: FALSE = full speed (USB 1.1) , TRUE = high speed (USB 2.0)
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_ReadFlashPage ( int32_t  handle,
N957_BYTE  data_buff[N957_FLASH_PAGE_SIZE],
N957_UINT16  page_number 
)

Reads a page from flash.

Parameters:
handle board's handle
data_buff data buffer (caller allocated)
page_number number of the page to read
Returns:
N957Success: procedure ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_SetAcqModeFlag ( int32_t  handle,
N957_BOOL  data 
)

Sets Acquisition mode control flag.

Parameters:
handle board's handle
data data to write
Returns:
N957Success: write ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_SetAcquisitionMode ( int32_t  handle,
N957ControlModes  mode 
)

Sets acquisition mode.

Parameters:
handle board's handle
mode acquisition mode
Returns:
N957Success: write ok : error code otherwise
See also:
N957ErrorCodes

N957ControlModes

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

N957_API N957_SetADCRate ( int32_t  handle,
N957ControlADCRates  rate 
)

Sets ADC rate.

Parameters:
handle board's handle
rate data to write
Returns:
N957Success: write ok : error code otherwise
See also:
N957ErrorCodes

N957ControlADCRates

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

N957_API N957_SetControl ( int32_t  handle,
N957_UINT16  data 
)

Sets Control register.

Parameters:
handle board's handle
data data to write read
Returns:
N957Success: write ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_SetConvEnFlag ( int32_t  handle,
N957_BOOL  data 
)

Sets Convertion enable control flag.

Parameters:
handle board's handle
data data to write
Returns:
N957Success: write ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_SetDAC ( int32_t  handle,
N957_UINT16  data 
)

Sets DAC register.

Parameters:
handle board's handle
data data to write
Returns:
N957Success: write ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_SetFlashEna ( int32_t  handle,
N957_UINT16  data 
)

Sets Flash Enable register.

Parameters:
handle board's handle
data data to write
Returns:
N957Success: write ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_SetFwDwnld ( int32_t  handle,
N957_UINT16  data 
)

Sets Firmware Download register.

Parameters:
handle board's handle
data data to write
Returns:
N957Success: write ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_SetLLD ( int32_t  handle,
N957_BYTE  lld 
)

Sets the low level detect treshold.

Parameters:
handle board's handle
lld The low level detect value in te range [0..99] (0= min value 99= max value)
Returns:
N957Success: read ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_SetPulser ( int32_t  handle,
N957_UINT16  data 
)

Sets Pulser register.

Parameters:
handle board's handle
data data to write
Returns:
N957Success: write ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_SetPurEnFlag ( int32_t  handle,
N957_BOOL  data 
)

Sets Pile UP rejection control flag.

Parameters:
handle board's handle
data data to write
Returns:
N957Success: write ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_SetSlsFlag ( int32_t  handle,
N957_BOOL  data 
)

Sets Sliding scale control flag.

Parameters:
handle board's handle
data data to write
Returns:
N957Success: write ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_SetSwConvFlag ( int32_t  handle,
N957_BOOL  data 
)

Sets Software convertion control flag.

Parameters:
handle board's handle
data data to write
Returns:
N957Success: write ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

N957_API N957_SwClear ( int32_t  handle  ) 

Performs a software clear.

Clears data, Scaler counter, Timer and Live time timer

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_SwReset ( int32_t  handle  ) 

Performs a software reset.

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_WriteFlashPage ( int32_t  handle,
N957_BYTE  data_buff[N957_FLASH_PAGE_SIZE],
N957_UINT16  page_number 
)

Reads a page from flash.

Parameters:
handle board's handle
data_buff data buffer (caller allocated)
page_number number of the page to write
Returns:
N957Success: procedure ok : error code otherwise
See also:
N957ErrorCodes
Note:
handle must be a valid one (as returned from N957_Init)

Generated on Mon Jun 30 09:34:03 2008 for CAEN N957 Lib by  doxygen 1.5.6