N957 types

Data Structures
struct	_N957_ConfigROM
	N957 board ROM configuration. More...
Defines
#define	N957_INVALID_HANDLE_VALUE   (-1)
	Value for not valid handles.
#define	N957_TRUE   (-1)
	boolean TRUE
#define	N957_FALSE   (0)
	boolean FALSE
#define	N957_FLASH_PAGE_SIZE   264
	Flash page byte size.
Typedefs
typedef unsigned char	N957_BYTE
	8 bits unsigned int type
typedef unsigned short	N957_UINT16
	16 bits unsigned int type
typedef uint32_t	N957_UINT32
	32 bits unsigned int type
typedef short	N957_INT16
	16 bits signed int type
typedef int32_t	N957_INT32
	32 bits signed int type
typedef int	N957_BOOL
	boolean type
typedef enum _N957ErrorCodes	N957ErrorCodes
typedef enum _N957Registers	N957Registers
typedef enum _N957StatusRegMsks	N957StatusRegMsks
typedef enum _N957ControlRegMsks	N957ControlRegMsks
typedef enum _N957ControlADCRates	N957ControlADCRates
typedef enum _N957ControlADCRatesMsks	N957ControlADCRatesMsks
typedef enum _N957ControlModes	N957ControlModes
typedef enum _N957ControlModesMsks	N957ControlModesMsk
typedef enum _N957ControlOUTPModeMsks	N957ControlOUTPModeMsks
typedef enum _N957FlashEnaRegMsks	N957FlashEnaRegMsks
typedef enum _N957FlashPageTypes	N957FlashPageTypes
typedef struct _N957_ConfigROM	N957_ConfigROM
Enumerations
enum	_N957ErrorCodes { N957Success = 0, N957CommError = -1, N957GenericError = -2, N957InvalidParam = -3 }
	Error codes. More...
enum	_N957Registers {   N957StatusReg = 0x0000, N957ControlReg = 0x0001, N957FwRelReg = 0x0002, N957FwDwnldReg = 0x0003,   N957FlashEnaReg = 0x0004, N957PulserReg = 0x0005, N957DACReg = 0x0006, N957BlDimReg = 0x0007,   N957PotCtrlReg = 0x0008, N957CalSetReg = 0x0009, N957CalClearReg = 0x000a, N957ScratchReg = 0x000b,   N957BuffOccReg = 0x000c, N957ScalerLSWReg = 0x000d, N957ScalerMSWReg = 0x000e, N957TimerLSWReg = 0x000f,   N957TimerMSWReg = 0x0010, N957LiveTimeLSWReg = 0x0011, N957LiveTimeMSWReg = 0x0012, N957SwClearReg = 0x0013,   N957SwResetReg = 0x0014 }
	Accessible registers. More...
enum	_N957StatusRegMsks { N957StatusRegUSBHiSpeedMsk = 0x0001, N957StatusRegMemEmptyMsk = 0x0002, N957StatusRegMemFullMsk = 0x0004, N957StatusRegFlashBusyMsk = 0x0008 }
	Status register bit masks. More...
enum	_N957ControlRegMsks {   N957ControlRegAcqModeMsk = 0x0001, N957ControlRegADCRateMsk = 0x000e, N957ControlRegSLSOnMsk = 0x0010, N957ControlRegConvEnMsk = 0x0040,   N957ControlRegSwConvMsk = 0x0080, N957ControlRegPUREnMsk = 0x0100, N957ControlRegModeMsk = 0x0600, N957ControlRegDACTestEnMsk = 0x0800,   N957ControlRegSLSTypeMsk = 0x1000, N957ControlRegOUTPModeMsk = 0x6000, N957ControlRegOUTPLevelMsk = 0x8000 }
	Control register bit masks. More...
enum	_N957ControlADCRates {   N957ControlADCRate600SPS = 0, N957ControlADCRate70KSPS, N957ControlADCRate140KSPS, N957ControlADCRate250KSPS,   N957ControlADCRate420KSPS, N957ControlADCRate635KSPS, N957ControlADCRate850KSPS, N957ControlADCRate1MSPS }
	Control register ADC rates. More...
enum	_N957ControlADCRatesMsks {   N957ControlADCRate600SPSMsk = 0x0000, N957ControlADCRate70KSPSMsk = 0x0002, N957ControlADCRate140KSPSMsk = 0x0004, N957ControlADCRate250KSPSMsk = 0x0006,   N957ControlADCRate420KSPSMsk = 0x0008, N957ControlADCRate635KSPSMsk = 0x000a, N957ControlADCRate850KSPSMsk = 0x000c, N957ControlADCRate1MSPSMsk = 0x000e }
	Control register ADC rates masks. More...
enum	_N957ControlModes { N957ControlModeExtGate = 0, N957ControlModeAuto }
	Control register Modes. More...
enum	_N957ControlModesMsks { N957ControlModeExtGateMsk = 0x0000, N957ControlModeAutoMsk = 0x0200 }
	Control register Modes masks. More...
enum	_N957ControlOUTPModeMsks { N957OUTPModeMemFullMsk = 0x00, N957OUTPModePeakMsk = 0x01, N957OUTPModeLevelMsk = 0x10, N957OUTPModePulseMsk = 0x11 }
	Control register OUTP Modes masks. More...
enum	_N957FlashEnaRegMsks { N957FlashEnaRegFCSMsk = 0x0001 }
	Flash enable bit masks. More...
enum	_N957FlashPageTypes { N957FlashPageStandard, N957FlashPageBackup }
	Flash page types. More...

---

Define Documentation

#define N957_FALSE   (0)

boolean FALSE

Definition at line 54 of file N957types.h.

#define N957_FLASH_PAGE_SIZE   264

Flash page byte size.

Definition at line 266 of file N957types.h.

#define N957_INVALID_HANDLE_VALUE   (-1)

Value for not valid handles.

Definition at line 36 of file N957types.h.

#define N957_TRUE   (-1)

boolean TRUE

Definition at line 53 of file N957types.h.

---

Typedef Documentation

typedef int N957_BOOL

boolean type

Definition at line 52 of file N957types.h.

typedef unsigned char N957_BYTE

8 bits unsigned int type

Definition at line 47 of file N957types.h.

typedef struct _N957_ConfigROM N957_ConfigROM

typedef short N957_INT16

16 bits signed int type

Definition at line 50 of file N957types.h.

typedef int32_t N957_INT32

32 bits signed int type

Definition at line 51 of file N957types.h.

typedef unsigned short N957_UINT16

16 bits unsigned int type

Definition at line 48 of file N957types.h.

typedef uint32_t N957_UINT32

32 bits unsigned int type

Definition at line 49 of file N957types.h.

typedef enum _N957ControlADCRates N957ControlADCRates

typedef enum _N957ControlADCRatesMsks N957ControlADCRatesMsks

typedef enum _N957ControlModes N957ControlModes

typedef enum _N957ControlModesMsks N957ControlModesMsk

typedef enum _N957ControlOUTPModeMsks N957ControlOUTPModeMsks

typedef enum _N957ControlRegMsks N957ControlRegMsks

typedef enum _N957ErrorCodes N957ErrorCodes

typedef enum _N957FlashEnaRegMsks N957FlashEnaRegMsks

typedef enum _N957FlashPageTypes N957FlashPageTypes

typedef enum _N957Registers N957Registers

typedef enum _N957StatusRegMsks N957StatusRegMsks

---

Enumeration Type Documentation

enum _N957ControlADCRates

Control register ADC rates.

The control register's ADC rates enumeration.

Enumerator:

N957ControlADCRate600SPS	600 SPS
N957ControlADCRate70KSPS	70 KSPS
N957ControlADCRate140KSPS	140 KSPS
N957ControlADCRate250KSPS	250 KSPS
N957ControlADCRate420KSPS	420 KSPS
N957ControlADCRate635KSPS	635 KSPS
N957ControlADCRate850KSPS	850 KSPS
N957ControlADCRate1MSPS	1 MSPS

Definition at line 178 of file N957types.h.

enum _N957ControlADCRatesMsks

Control register ADC rates masks.

The control register's ADC rates masks.

Enumerator:

N957ControlADCRate600SPSMsk	600 SPS
N957ControlADCRate70KSPSMsk	70 KSPS
N957ControlADCRate140KSPSMsk	140 KSPS
N957ControlADCRate250KSPSMsk	250 KSPS
N957ControlADCRate420KSPSMsk	420 KSPS
N957ControlADCRate635KSPSMsk	635 KSPS
N957ControlADCRate850KSPSMsk	850 KSPS
N957ControlADCRate1MSPSMsk	1 MSPS

Definition at line 197 of file N957types.h.

enum _N957ControlModes

Control register Modes.

The control register's modes enumeration.

Enumerator:

N957ControlModeExtGate	Ext Gate: track on external trigger rising edge hold on external trigger falling edge.
N957ControlModeAuto	Auto : track on signal level hold on signal peak detect.

Definition at line 216 of file N957types.h.

enum _N957ControlModesMsks

Control register Modes masks.

The control register's modes masks.

Enumerator:

N957ControlModeExtGateMsk	External gate.
N957ControlModeAutoMsk	Auto.

Definition at line 233 of file N957types.h.

enum _N957ControlOUTPModeMsks

Control register OUTP Modes masks.

The control register's OUTP mode masks.

Enumerator:

N957OUTPModeMemFullMsk	OUTP Memory Full Mode.
N957OUTPModePeakMsk	OUTP Peak Mode.
N957OUTPModeLevelMsk	OUTP Level Mode.
N957OUTPModePulseMsk	OUTP Pulser Mode.

Definition at line 246 of file N957types.h.

enum _N957ControlRegMsks

Control register bit masks.

The control register's bits definitions.

Enumerator:

N957ControlRegAcqModeMsk	Enable data acquisition mode.
N957ControlRegADCRateMsk	ADC data rate bits. 000 -> 600 SPS 001 -> 70 KSPS 010 -> 140 KSPS 011 -> 250 KSPS 100 -> 420 KSPS 101 -> 635 KSPS 110 -> 850 KSPS 111 -> 1 MSPS See also: _N957ControlADCRates
N957ControlRegSLSOnMsk	SLS (Sliding scale) activation.
N957ControlRegConvEnMsk	Convertion enable flag.
N957ControlRegSwConvMsk	Software convertion flag.
N957ControlRegPUREnMsk	PUR (Pile Up rejection) flag.
N957ControlRegModeMsk	function mode bits 00 -> Ext Gate: track on external trigger rising edge hold on external trigger falling edge 01 -> Auto : track on signal level hold on signal peak detect See also: _N957ControlModesMsks
N957ControlRegDACTestEnMsk	DAC Test enable flag.
N957ControlRegSLSTypeMsk	Slading scale Type 0= LFSR 1= RAMP.
N957ControlRegOUTPModeMsk	Output Lemo configuration. 00 -> OUTP Memory Full Mode 01 -> OUTP Peak Mode 10 -> OUTP Level Mode 11 -> OUTP Pulser Mode See also: _N957ControlOUTPModeMsks
N957ControlRegOUTPLevelMsk	Output Lemo level.

Definition at line 128 of file N957types.h.

enum _N957ErrorCodes

Error codes.

Error codes returned by the exported functions.

Enumerator:

N957Success	Operation completed successfully.
N957CommError	Communication error.
N957GenericError	Unspecified error.
N957InvalidParam	Invalid parameter.

Definition at line 64 of file N957types.h.

enum _N957FlashEnaRegMsks

Flash enable bit masks.

Enumerator:

N957FlashEnaRegFCSMsk

Flash CS (active low).

Definition at line 260 of file N957types.h.

enum _N957FlashPageTypes

Flash page types.

The flash page types for firmware upgrade

Enumerator:

N957FlashPageStandard	Standard (boot) flash page.
N957FlashPageBackup	Backup flash page.

Definition at line 275 of file N957types.h.

enum _N957Registers

Accessible registers.

The list of user accessible registers.

Enumerator:

N957StatusReg	Status register.
N957ControlReg	Control register.
N957FwRelReg	Firmware Release register.
N957FwDwnldReg	Firmware download register.
N957FlashEnaReg	Flash Enable register.
N957PulserReg	Pulser register.
N957DACReg	DAC register direct access.
N957BlDimReg	Block Dim register number of word to read.
N957PotCtrlReg	Potentiometer control register.
N957CalSetReg	Calibration set register.
N957CalClearReg	Calibration clear register.
N957ScratchReg	Scratch register.
N957BuffOccReg	Buffer occupancy register.
N957ScalerLSWReg	Scaler LSW register.
N957ScalerMSWReg	Scaler MSW register.
N957TimerLSWReg	Timer LSW register.
N957TimerMSWReg	Timer MSW register.
N957LiveTimeLSWReg	Live time timer LSW register.
N957LiveTimeMSWReg	Live time timer MSW register.
N957SwClearReg	Software clear register.
N957SwResetReg	Software reset register.

Definition at line 80 of file N957types.h.

enum _N957StatusRegMsks

Status register bit masks.

The status register's bits definitions.

Enumerator:

N957StatusRegUSBHiSpeedMsk	USB High Speed status flag.
N957StatusRegMemEmptyMsk	Data Memory empty flag.
N957StatusRegMemFullMsk	Data Memory full (overflow) flag.
N957StatusRegFlashBusyMsk	Flash Busy flag.

Definition at line 112 of file N957types.h.