N957Lib.h File Reference

N957 board library public methods definitions. More...

#include "N957oslib.h"
#include "N957types.h"

Go to the source code of this file.

Functions

N957_DLL_API N957_API N957_Init (short BdNum, int32_t *handle)
 Initialize a new board.
N957_DLL_API N957_API N957_End (int32_t handle)
 Releases the resources allocated for the board.
N957_DLL_API const char * N957_DecodeError (N957ErrorCodes code)
 Decodes a N957 error code into string.
N957_DLL_API N957_API N957_SWRelease (char *SwRel, int buff_size)
 Gets the library release string.
N957_DLL_API N957_API N957_WriteReg (int32_t handle, N957_UINT16 reg_addr, N957_UINT16 data)
 Writes data to board's register.
N957_DLL_API N957_API N957_ReadReg (int32_t handle, N957_UINT16 reg_addr, N957_UINT16 *data)
 Reads data from board's register.
N957_DLL_API N957_API N957_SetRegBitMsk (int32_t handle, N957_UINT16 reg_addr, N957_UINT16 bitmsk)
 Sets a mask of bits into board's register.
N957_DLL_API N957_API N957_ClearRegBitMsk (int32_t handle, N957_UINT16 reg_addr, N957_UINT16 bitmsk)
 Clears a mask of bits into board's register.
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.
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.


Detailed Description

N957 board library public methods definitions.

Author:
CAEN S.p.A. ( http://www.caen.it )
Version:
1.2
Date:
05/2006

Definition in file N957Lib.h.


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