sbigudrv.h

/*

	SBIGUDRV.H

	Contains the function prototypes and enumerated constants
	for the Universal Parallel/USB/Ethernet driver.

	This supports the following devices:

		ST-7E/8E/9E/10E
		ST-5C/237/237A (PixCel255/237)
		ST-1K, ST-2K, ST-4K
		STL Large Format Cameras
		ST-402 Family of Cameras
		AO-7, AOL, AO-8
		CFW-8, CFW-9, CFW-10, CFW-L
		ST Focuser
		STX Cameras
		ST-8300 Cameras
		STF-8300 Cameras
		ST-i Cameras
		STT Cameras (Preliminary)
		Differential Guider Accessory (Preliminary)
		FW5-8300, FW8-8300
 
	Version 4.75 - March 27, 2012
	(c)1995-2012 - Santa Barbara Instrument Group

*/
#ifndef _PARDRV_
#define _PARDRV_

/*

	SBIG Specific Code

*/
#ifndef TARGET
 #define ENV_WIN		  1				/* Target for Windows environment */
 #define ENV_WINVXD		2				/* SBIG Use Only, Win 9X VXD */
 #define ENV_WINSYS		3				/* SBIG Use Only, Win NT SYS */
 #define ENV_ESRVJK		4				/* SBIG Use Only, Ethernet Remote */
 #define ENV_ESRVWIN	5				/* SBIG Use Only, Ethernet Remote */
 #define ENV_MACOSX   6				/* SBIG Use Only, Mac OSX */
 #define ENV_LINUX		7				/* SBIG Use Only, Linux */
 #define ENV_NIOS	    8				/* SBIG Use Only, Embedded NIOS */
 #define TARGET			ENV_WIN   /* Set for your target */
#endif


/*

	Enumerated Constants

	Note that the various constants are declared here as enums
	for ease of declaration but in the structures that use the
	enums unsigned shorts are used to force the various
	16 and 32 bit compilers to use 16 bits.

*/

/*

	Supported Camera Commands

	These are the commands supported by the driver.
	They are prefixed by CC_ to designate them as
	camera commands and avoid conflicts with other
	enums.

	Some of the commands are marked as SBIG use only
	and have been included to enhance testability
	of the driver for SBIG.

*/
typedef enum 
{
	/*

		General Use Commands

	*/
	CC_NULL,

	/* 1 - 10 */
	CC_START_EXPOSURE = 1, 
	CC_END_EXPOSURE, 
	CC_READOUT_LINE,
	CC_DUMP_LINES, 
	CC_SET_TEMPERATURE_REGULATION,
	CC_QUERY_TEMPERATURE_STATUS, 
	CC_ACTIVATE_RELAY, 
	CC_PULSE_OUT,
	CC_ESTABLISH_LINK, 
	CC_GET_DRIVER_INFO,

	/* 11 - 20 */
	CC_GET_CCD_INFO, 
	CC_QUERY_COMMAND_STATUS, 
	CC_MISCELLANEOUS_CONTROL,
	CC_READ_SUBTRACT_LINE, 
	CC_UPDATE_CLOCK, 
	CC_READ_OFFSET,
	CC_OPEN_DRIVER, 
	CC_CLOSE_DRIVER,
	CC_TX_SERIAL_BYTES, 
	CC_GET_SERIAL_STATUS,

	/* 21 - 30 */
	CC_AO_TIP_TILT, 
	CC_AO_SET_FOCUS, 
	CC_AO_DELAY,
  CC_GET_TURBO_STATUS, 
	CC_END_READOUT, 
	CC_GET_US_TIMER,
	CC_OPEN_DEVICE, 
	CC_CLOSE_DEVICE, 
	CC_SET_IRQL, 
	CC_GET_IRQL,

	/* 31 - 40 */
	CC_GET_LINE, 
	CC_GET_LINK_STATUS, 
	CC_GET_DRIVER_HANDLE,
	CC_SET_DRIVER_HANDLE, 
	CC_START_READOUT, 
	CC_GET_ERROR_STRING,
	CC_SET_DRIVER_CONTROL, 
	CC_GET_DRIVER_CONTROL,
	CC_USB_AD_CONTROL, 
	CC_QUERY_USB,

	/* 41 - 50 */
	CC_GET_PENTIUM_CYCLE_COUNT, 
	CC_RW_USB_I2C, 
	CC_CFW, 
	CC_BIT_IO,
	CC_USER_EEPROM, 
	CC_AO_CENTER, 
	CC_BTDI_SETUP, 
	CC_MOTOR_FOCUS,
	CC_QUERY_ETHERNET, 
	CC_START_EXPOSURE2,

	/* 51 - 60 */
	CC_SET_TEMPERATURE_REGULATION2, 
	CC_READ_OFFSET2, 
	CC_DIFF_GUIDER,
	CC_COLUMN_EEPROM, 
	CC_CUSTOMER_OPTIONS,
	CC_DEBUG_LOG,
	CC_QUERY_USB2,
	CC_QUERY_ETHERNET2, 

	/*
		SBIG Use Only Commands
	*/
	CC_SEND_BLOCK = 90, 
	CC_SEND_BYTE, 
	CC_GET_BYTE, 
	CC_SEND_AD,
	CC_GET_AD, 
	CC_CLOCK_AD, 
	CC_SYSTEM_TEST,
	CC_GET_DRIVER_OPTIONS, 
	CC_SET_DRIVER_OPTIONS,
	CC_FIRMWARE, 
	CC_BULK_IO, 
	CC_RIPPLE_CORRECTION,
	CC_EZUSB_RESET,
	CC_LAST_COMMAND
} 
PAR_COMMAND;

/*

	Return Error Codes

	These are the error codes returned by the driver
	function.  They are prefixed with CE_ to designate
	them as camera errors.

*/
#ifndef CE_ERROR_BASE
 #define CE_ERROR_BASE 1
#endif

typedef enum
{
	/* 0 - 10 */
	CE_NO_ERROR,
	CE_CAMERA_NOT_FOUND = CE_ERROR_BASE,
	CE_EXPOSURE_IN_PROGRESS,
	CE_NO_EXPOSURE_IN_PROGRESS,
	CE_UNKNOWN_COMMAND,
	CE_BAD_CAMERA_COMMAND,
	CE_BAD_PARAMETER,
	CE_TX_TIMEOUT,
	CE_RX_TIMEOUT,
	CE_NAK_RECEIVED,
	CE_CAN_RECEIVED,

	/* 11 - 20 */
	CE_UNKNOWN_RESPONSE,
	CE_BAD_LENGTH,
	CE_AD_TIMEOUT,
	CE_KBD_ESC,
	CE_CHECKSUM_ERROR,
	CE_EEPROM_ERROR,
	CE_SHUTTER_ERROR,
	CE_UNKNOWN_CAMERA,
	CE_DRIVER_NOT_FOUND,
	CE_DRIVER_NOT_OPEN,

	/* 21 - 30 */
	CE_DRIVER_NOT_CLOSED,
	CE_SHARE_ERROR,
	CE_TCE_NOT_FOUND,
	CE_AO_ERROR,
	CE_ECP_ERROR,
	CE_MEMORY_ERROR,
	CE_DEVICE_NOT_FOUND,
	CE_DEVICE_NOT_OPEN,
	CE_DEVICE_NOT_CLOSED,
	CE_DEVICE_NOT_IMPLEMENTED,
	
	/* 31 - 40 */
	CE_DEVICE_DISABLED,
	CE_OS_ERROR,
	CE_SOCK_ERROR,
	CE_SERVER_NOT_FOUND,
	CE_CFW_ERROR,
	CE_MF_ERROR,
	CE_FIRMWARE_ERROR,
	CE_DIFF_GUIDER_ERROR,
	CE_RIPPLE_CORRECTION_ERROR,
	CE_EZUSB_RESET,
	CE_NEXT_ERROR

} PAR_ERROR;

/*

	Camera Command State Codes

	These are the return status codes for the Query
	Command Status command.  They are prefixed with
	CS_ to designate them as camera status.

*/
typedef enum
{
	CS_IDLE,
	CS_IN_PROGRESS,
	CS_INTEGRATING,
	CS_INTEGRATION_COMPLETE
}
PAR_COMMAND_STATUS;

#define CS_PULSE_IN_ACTIVE			0x8000
#define CS_WAITING_FOR_TRIGGER	0x8000

/*
	Misc. Enumerated Constants
  QUERY_TEMP_STATUS_REQUEST - Used with the Query Temperature Status command.
	ABG_STATE7 - Passed to Start Exposure Command
	MY_LOGICAL - General purpose type
	DRIVER_REQUEST - Used with Get Driver Info command
	CCD_REQUEST - Used with Imaging commands to specify CCD
	CCD_INFO_REQUEST - Used with Get CCD Info Command
	PORT - Used with Establish Link Command
	CAMERA_TYPE - Returned by Establish Link and Get CCD Info commands
	SHUTTER_COMMAND, SHUTTER_STATE7 - Used with Start Exposure and Miscellaneous Control Commands
	TEMPERATURE_REGULATION - Used with Enable Temperature Regulation
	LED_STATE - Used with the Miscellaneous Control Command
	FILTER_COMMAND, FILTER_STATE - Used with the Miscellaneous Control Command
	AD_SIZE, FILTER_TYPE - Used with the GetCCDInfo3 Command
	AO_FOCUS_COMMAND - Used with the AO Set Focus Command
	SBIG_DEVICE_TYPE - Used with Open Device Command
	DRIVER_CONTROL_PARAM - Used with Get/SetDriverControl Command
	USB_AD_CONTROL_COMMAND - Used with UsbADControl Command
	CFW_MODEL_SELECT, CFW_STATUS, CFW_ERROR - Used with CFW command
	CFW_POSITION, CFW_GET_INFO_SELECT - Used with CFW Command
	BIT_IO_OPERATION, BIT_IO_NMAE - Used with BitIO command
	MF_MODEL_SELECT, MF_STATUS, MF_ERROR, MF_GET_INFO_SELECT - Used with Motor Focus Command
	DIFF_GUIDER_COMMAND, DIFF_GUIDER_STATE, DIFF_GUIDER_ERROR -	Used with the Diff Guider Command
*/

typedef enum
{
	TEMP_STATUS_STANDARD,
	TEMP_STATUS_ADVANCED,
	TEMP_STATUS_ADVANCED2
}
QUERY_TEMP_STATUS_REQUEST;

typedef enum
{
	ABG_LOW7,
	ABG_CLK_LOW7,
	ABG_CLK_MED7,
	ABG_CLK_HI7
}
ABG_STATE7;

typedef unsigned short MY_LOGICAL;

#define FALSE 0
#define TRUE 	1

typedef enum 
{ 
	DRIVER_STD,
	DRIVER_EXTENDED,
	DRIVER_USB_LOADER
} 
DRIVER_REQUEST;

typedef enum 
{ 
	CCD_IMAGING,
	CCD_TRACKING,
	CCD_EXT_TRACKING
} 
CCD_REQUEST;

typedef enum 
{ 
	RM_1X1,
	RM_2X2,
	RM_3X3,
	RM_NX1,
	RM_NX2,
	RM_NX3,
	RM_1X1_VOFFCHIP,
	RM_2X2_VOFFCHIP,
	RM_3X3_VOFFCHIP,
	RM_9X9, RM_NXN
} 
READOUT_BINNING_MODE;  

typedef enum 
{ 
	CCD_INFO_IMAGING, 
	CCD_INFO_TRACKING,
	CCD_INFO_EXTENDED, 
	CCD_INFO_EXTENDED_5C, 
	CCD_INFO_EXTENDED2_IMAGING,
	CCD_INFO_EXTENDED2_TRACKING,
	CCD_INFO_EXTENDED3
} 
CCD_INFO_REQUEST;

typedef enum
{
	ABG_NOT_PRESENT,
	ABG_PRESENT
}
IMAGING_ABG;

typedef enum
{
	BR_AUTO,
	BR_9600,
	BR_19K,
	BR_38K,
	BR_57K,
	BR_115K
}
PORT_RATE;

typedef enum 
{ 
	ST7_CAMERA = 4,
	ST8_CAMERA,
	ST5C_CAMERA,
	TCE_CONTROLLER,
	ST237_CAMERA,
	STK_CAMERA,
	ST9_CAMERA,
	STV_CAMERA,
	ST10_CAMERA,
	ST1K_CAMERA,
	ST2K_CAMERA,
	STL_CAMERA,
	ST402_CAMERA,
	STX_CAMERA,
	ST4K_CAMERA,
	STT_CAMERA,
	STI_CAMERA,
	STF_CAMERA,
	NEXT_CAMERA,
	NO_CAMERA=0xFFFF
} 
CAMERA_TYPE;

typedef enum
{
	SC_LEAVE_SHUTTER,
	SC_OPEN_SHUTTER,
	SC_CLOSE_SHUTTER,
	SC_INITIALIZE_SHUTTER,
	SC_OPEN_EXT_SHUTTER,
	SC_CLOSE_EXT_SHUTTER
}
SHUTTER_COMMAND;

typedef enum
{
	SS_OPEN,
	SS_CLOSED,
	SS_OPENING,
	SS_CLOSING
}
SHUTTER_STATE7;

typedef enum
{
	REGULATION_OFF,
	REGULATION_ON,
	REGULATION_OVERRIDE,
	REGULATION_FREEZE,
	REGULATION_UNFREEZE,
	REGULATION_ENABLE_AUTOFREEZE,
	REGULATION_DISABLE_AUTOFREEZE
}
TEMPERATURE_REGULATION;

#define REGULATION_FROZEN_MASK 0x8000

typedef enum
{
	LED_OFF,
	LED_ON,
	LED_BLINK_LOW,
	LED_BLINK_HIGH
}
LED_STATE;

typedef enum
{
	FILTER_LEAVE,
	FILTER_SET_1,
	FILTER_SET_2,
	FILTER_SET_3,
	FILTER_SET_4,
	FILTER_SET_5,
	FILTER_STOP,
	FILTER_INIT
}
FILTER_COMMAND;

typedef enum
{
	FS_MOVING,
	FS_AT_1,
	FS_AT_2,
	FS_AT_3,
	FS_AT_4,
	FS_AT_5,
	FS_UNKNOWN
}
FILTER_STATE;

typedef enum
{
	AD_UNKNOWN,
	AD_12_BITS,
	AD_16_BITS
}
AD_SIZE;

typedef enum
{
	FW_UNKNOWN,
	FW_EXTERNAL,
	FW_VANE,
	FW_FILTER_WHEEL
}
FILTER_TYPE;

typedef enum
{
	AOF_HARD_CENTER,
	AOF_SOFT_CENTER,
	AOF_STEP_IN,
  AOF_STEP_OUT
}
AO_FOCUS_COMMAND;

// Ethernet stuff
#define SRV_SERVICE_PORT	5000
#define BROADCAST_PORT		5001

typedef enum
{
	DEV_NONE,
	DEV_LPT1,
	DEV_LPT2,
	DEV_LPT3,
  DEV_USB = 0x7F00,
  DEV_ETH,
  DEV_USB1,
  DEV_USB2,
  DEV_USB3,
  DEV_USB4,
  DEV_USB5,
  DEV_USB6,
  DEV_USB7,
  DEV_USB8
}
SBIG_DEVICE_TYPE;

typedef enum 
{ 
	DCP_USB_FIFO_ENABLE, 
	DCP_CALL_JOURNAL_ENABLE,
	DCP_IVTOH_RATIO, 
	DCP_USB_FIFO_SIZE, 
	DCP_USB_DRIVER, 
	DCP_KAI_RELGAIN,
	DCP_USB_PIXEL_DL_ENABLE, 
	DCP_HIGH_THROUGHPUT, 
	DCP_VDD_OPTIMIZED,
	DCP_AUTO_AD_GAIN, 
	DCP_NO_HCLKS_FOR_INTEGRATION, 
	DCP_TDI_MODE_ENABLE, 
	DCP_VERT_FLUSH_CONTROL_ENABLE, 
	DCP_ETHERNET_PIPELINE_ENABLE, 
	DCP_FAST_LINK, 
	DCP_OVERSCAN_ROWSCOLS, 
	DCP_PIXEL_PIPELINE_ENABLE, 
	DCP_COLUMN_REPAIR_ENABLE,
	DCP_WARM_PIXEL_REPAIR_ENABLE, 
	DCP_WARM_PIXEL_REPAIR_COUNT, 
	DCP_LAST 
} 
DRIVER_CONTROL_PARAM;

typedef enum
{
	USB_AD_IMAGING_GAIN,
	USB_AD_IMAGING_OFFSET,

	USB_AD_TRACKING_GAIN,
	USB_AD_TRACKING_OFFSET,
	
	USB_AD_EXTTRACKING_GAIN,
	USB_AD_EXTTRACKING_OFFSET,
	
	USB_AD_IMAGING2_GAIN,
	USB_AD_IMAGING2_OFFSET,

	USB_AD_IMAGING_GAIN_RIGHT,
	USB_AD_IMAGING_OFFSET_RIGHT,
}
USB_AD_CONTROL_COMMAND;

typedef enum
{
	USBD_SBIGE,
	USBD_SBIGI,
	USBD_SBIGM,
	USBD_NEXT
}
ENUM_USB_DRIVER;

typedef enum 
{ 
	CFWSEL_UNKNOWN, 
	CFWSEL_CFW2, 
	CFWSEL_CFW5, 
	CFWSEL_CFW8, 
	CFWSEL_CFWL,
	CFWSEL_CFW402, 
	CFWSEL_AUTO, 
	CFWSEL_CFW6A, 
	CFWSEL_CFW10,
	CFWSEL_CFW10_SERIAL, 
	CFWSEL_CFW9, 
	CFWSEL_CFWL8, 
	CFWSEL_CFWL8G,
	CFWSEL_CFW1603, 
	CFWSEL_FW5_STX, 
	CFWSEL_FW5_8300,
	CFWSEL_FW8_8300, 
	CFWSEL_FW7_STX, 
	CFWSEL_FW8_STT
} 
CFW_MODEL_SELECT;

typedef enum 
{ 
	CFWC_QUERY, 
	CFWC_GOTO, 
	CFWC_INIT, 
	CFWC_GET_INFO,
	CFWC_OPEN_DEVICE, 
	CFWC_CLOSE_DEVICE 
} 
CFW_COMMAND;

typedef enum 
{ 
	CFWS_UNKNOWN, 
	CFWS_IDLE, 
	CFWS_BUSY 
} 
CFW_STATUS;

typedef enum 
{ 
	CFWE_NONE, 
	CFWE_BUSY, 
	CFWE_BAD_COMMAND, 
	CFWE_CAL_ERROR, 
	CFWE_MOTOR_TIMEOUT,
	CFWE_BAD_MODEL, 
	CFWE_DEVICE_NOT_CLOSED, 
	CFWE_DEVICE_NOT_OPEN,
	CFWE_I2C_ERROR 
} 
CFW_ERROR;

typedef enum 
{ 
	CFWP_UNKNOWN, 
	CFWP_1, 
	CFWP_2, 
	CFWP_3, 
	CFWP_4, 
	CFWP_5, 
	CFWP_6,
	CFWP_7, 
	CFWP_8, 
	CFWP_9, 
	CFWP_10
} 
CFW_POSITION;

typedef enum 
{ 
	CFWPORT_COM1=1, 
	CFWPORT_COM2, 
	CFWPORT_COM3, 
	CFWPORT_COM4 
} 
CFW_COM_PORT;

typedef enum 
{ 
	CFWG_FIRMWARE_VERSION, 
	CFWG_CAL_DATA, 
	CFWG_DATA_REGISTERS 
} 
CFW_GETINFO_SELECT;


typedef enum
{
	BITIO_WRITE,
	BITIO_READ
}
BITIO_OPERATION;

typedef enum
{
	BITI_PS_LOW,
	BITO_IO1,
	BITO_IO2,
	BITI_IO3,
	BITO_FPGA_WE
}
BITIO_NAME;

typedef enum
{
	BTDI_SCHEDULE_ERROR = 1,
	BTDI_OVERRUN_ERROR  = 2
}
BTDI_ERROR;

typedef enum
{
	MFSEL_UNKNOWN,
	MFSEL_AUTO,
	MFSEL_STF
}
MF_MODEL_SELECT;

typedef enum
{
	MFC_QUERY,
	MFC_GOTO,
	MFC_INIT,
	MFC_GET_INFO,
	MFC_ABORT
}
MF_COMMAND;

typedef enum
{
	MFS_UNKNOWN,
	MFS_IDLE,
	MFS_BUSY
}
MF_STATUS;

typedef enum
{
	MFE_NONE,
	MFE_BUSY,
	MFE_BAD_COMMAND,
	MFE_CAL_ERROR,
	MFE_MOTOR_TIMEOUT,
	MFE_BAD_MODEL,
	MFE_I2C_ERROR,
	MFE_NOT_FOUND
}
MF_ERROR;

typedef enum
{
	MFG_FIRMWARE_VERSION,
	MFG_DATA_REGISTERS
}
MF_GETINFO_SELECT;

typedef enum
{
	DGC_DETECT,
	DGC_GET_BRIGHTNESS,
	DGC_SET_BRIGHTNESS
}
DIFF_GUIDER_COMMAND;

typedef enum
{
	DGE_NO_ERROR,
	DGE_NOT_FOUND,
	DGE_BAD_COMMAND,
	DGE_BAD_PARAMETER
}
DIFF_GUIDER_ERROR;

typedef enum
{
	DGS_UNKNOWN,
	DGS_IDLE,
	DGS_BUSY
}
DIFF_GUIDER_STATUS;

typedef enum
{
	FS_OFF,
	FS_ON,
	FS_AUTOCONTROL
}
FAN_STATE;

typedef enum
{
	BIO_READ,
	BIO_WRITE,
	BIO_FLUSH
}
BULK_IO_COMMAND;

typedef enum
{
	PIXEL_CHANNEL_MODE_A,
	PIXEL_CHANNEL_MODE_B,
	PIXEL_CHANNEL_MODE_AB
}
PIXEL_CHANNEL_MODE;

typedef enum
{
	PIXEL_CHANNEL_A,
	PIXEL_CHANNEL_B
}
ACTIVE_PIXEL_CHANNEL;

/*
	General Purpose Flags
*/
#define END_SKIP_DELAY	0x8000
												/*
												 	 set in ccd parameter of EndExposure
											   	 command to skip synchronization
											   	 delay - Use this to increase the
											   	 rep rate when taking darks to later
											   	 be subtracted from SC_LEAVE_SHUTTER
											   	 exposures such as when tracking and
											   	 imaging
												*/

#define START_SKIP_VDD	0x8000
												/*
												 	 set in ccd parameter of StartExposure
											   	 command to skip lowering Imaging CCD
											   	 Vdd during integration. - Use this to
											   	 increase the rep rate when you don't
											   	 care about glow in the upper-left
											   	 corner of the imaging CCD
											  */

#define START_MOTOR_ALWAYS_ON	0x4000
												/*
												 	 set in ccd parameter of StartExposure
											   	 and EndExposure commands to force shutter
											   	 motor to stay on all the time which reduces
											   	 delays in Start and End Exposure timing and
											   	 yields higher image throughput.  Don't
											   	 do this too often or camera head will
											   	 heat up
											   */

#define ABORT_DONT_END	0x2000
												/*
												 	 set in ccd parameter of EndExposure
											   	 command to abort the exposure completely
											   	 instead of just ending the integration phase
											   	 for cameras with internal frame buffers
											   	 like the STX
											  */

#define EXP_WAIT_FOR_TRIGGER_IN 0x80000000  // set in exposureTime to wait for trigger in pulse
#define EXP_SEND_TRIGGER_OUT    0x40000000  // set in exposureTime to send trigger out Y-
#define EXP_LIGHT_CLEAR					0x20000000	// set to do light clear of the CCD
#define EXP_MS_EXPOSURE					0x10000000	// set to interpret exposure time as milliseconds
#define EXP_FAST_READOUT				0x08000000	// activate the fast readout mode of the STF-8300, etc.
#define EXP_DUAL_CHANNEL_MODE   0x04000000  // activate the dual channel CCD readout mode of the STF-8050
#define EXP_TIME_MASK           0x00FFFFFF  // mask with exposure time to remove flags

/*

  Capabilities Bits - Bit Field Definitions for the 
	capabilitiesBits in the GetCCDInfoResults4 struct.

*/
#define CB_CCD_TYPE_MASK						0x0001			/* mask for CCD type */
#define CB_CCD_TYPE_FULL_FRAME			0x0000			/* b0=0 is full frame CCD */
#define CB_CCD_TYPE_FRAME_TRANSFER	0x0001			/* b0=1 is frame transfer CCD */
#define CB_CCD_ESHUTTER_MASK				0x0002			/* mask for electronic shutter type */
#define CB_CCD_ESHUTTER_NO					0x0000			/* b1=0 indicates no electronic shutter */
#define CB_CCD_ESHUTTER_YES					0x0002			/* b1=1 indicates electronic shutter */
#define CB_CCD_EXT_TRACKER_MASK			0x0004			/* mask for external tracker support */
#define CB_CCD_EXT_TRACKER_NO				0x0000			/* b2=0 indicates no external tracker support */
#define CB_CCD_EXT_TRACKER_YES			0x0004			/* b2=1 indicates external tracker support */
#define CB_CCD_BTDI_MASK						0x0008			/* mask for BTDI support */
#define CB_CCD_BTDI_NO							0x0000			/* b3=0 indicates no BTDI support */
#define CB_CCD_BTDI_YES							0x0008			/* b3=1 indicates BTDI support */
#define CB_AO8_MASK									0x0010			/* mask for AO-8 detected */
#define CB_AO8_NO										0x0000			/* b4=0 indicates no AO-8 detected */
#define CB_AO8_YES									0x0010			/* b4=1 indicates AO-8 detected */
#define CB_FRAME_BUFFER_MASK				0x0020			/* mask for camera with frame buffer */
#define CB_FRAME_BUFFER_NO					0x0000			/* b5=0 indicates camera without Frame Buffer */
#define CB_FRAME_BUFFER_YES					0x0020			/* b5=1 indicates camera with Frame Buffer */
#define CB_REQUIRES_STARTEXP2_MASK	0x0040			/* mask for camera that requires StartExposure2 */
#define CB_REQUIRES_STARTEXP2_NO		0x0000			/* b6=0 indicates camera works with StartExposure */
#define CB_REQUIRES_STARTEXP2_YES		0x0040			/* b6=1 indicates camera Requires StartExposure2 */

/*

	Defines

*/
#define MIN_ST7_EXPOSURE			12  /* Minimum exposure in 1/100ths second */
#define MIN_ST402_EXPOSURE		 4	/* Minimum exposure in 1/100ths second */
#define MIN_ST3200_EXPOSURE		 9	/* Minimum exposure in 1/100ths second */

#define MIN_STF8300_EXPOSURE	 9	/* Minimum exposure in 1/100ths second */
#define MIN_STF8050_EXPOSURE	 1	/* Minimum exposure in 1/1000ths second since has E Shutter */
#define MIN_STF4070_EXPOSURE	 1	/* Minimum exposure in 1/1000ths second since has E Shutter */

#define MIN_STX_EXPOSURE			18	/* Minimum exposure in 1/100ths second */
#define MIN_STT_EXPOSURE			12	/* Minimum exposure in 1/100ths second */
#define MIN_STU_EXPOSURE		 	 1	/* Minimum exposure in 1/1000ths second since ST-i has E Shutter */

/*

	Command Parameter and Results Structs

	Make sure you set your compiler for byte structure alignment
	as that is how the driver was built.

*/
/* Force 8 Byte Struct Align */
#if TARGET == ENV_MACOSX || TARGET == ENV_LINUX
 #pragma pack(push,8)
#else
 #pragma pack(push)
 #pragma pack(8)
#endif

typedef struct 
{
	unsigned short	ccd;					/* CCD_REQUEST */
	unsigned long		exposureTime;
	unsigned short  abgState;			/* ABG_STATE7 */
	unsigned short  openShutter;  /* SHUTTER_COMMAND */ 
} 
StartExposureParams;

typedef struct 
{
	unsigned short	ccd;					/* CCD_REQUEST */
	unsigned long		exposureTime;
	unsigned short	abgState;			/* ABG_STATE7 */
	unsigned short  openShutter;  /* SHUTTER_COMMAND */ 
	unsigned short	readoutMode;
	unsigned short	top;
	unsigned short	left;
	unsigned short	height;
	unsigned short	width;
} 
StartExposureParams2;

typedef struct 
{
	unsigned short  ccd; /* CCD_REQUEST */
} 
EndExposureParams;

typedef struct 
{
	unsigned short ccd; /* CCD_REQUEST */ 
	unsigned short readoutMode;
	unsigned short pixelStart;
	unsigned short pixelLength;
} 
ReadoutLineParams;

typedef struct 
{
	unsigned short ccd; /* CCD_REQUEST */
	unsigned short readoutMode;
	unsigned short lineLength;
} 
DumpLinesParams;

typedef struct 
{
	unsigned short  ccd; /* CCD_REQUEST */
} 
EndReadoutParams;

typedef struct 
{
	unsigned short  ccd; /* CCD_REQUEST */
	unsigned short readoutMode;
	unsigned short top;
	unsigned short left;
	unsigned short height;
	unsigned short width;
} 
StartReadoutParams;

typedef struct 
{
	unsigned short /* TEMPERATURE_REGULATION */ regulation;
	unsigned short ccdSetpoint;
} 
SetTemperatureRegulationParams;

typedef struct 
{
	unsigned short /* TEMPERATURE_REGULATION */ regulation;
	double ccdSetpoint;
} 
SetTemperatureRegulationParams2;

typedef struct 
{
	unsigned short /* TEMP_STATUS_REQUEST */ request;
} 
QueryTemperatureStatusParams;

typedef struct 
{
	MY_LOGICAL			enabled;
	unsigned short	ccdSetpoint;
	unsigned short	power;
	unsigned short	ccdThermistor;
	unsigned short	ambientThermistor;
} 
QueryTemperatureStatusResults;

typedef struct 
{
	MY_LOGICAL coolingEnabled;
	MY_LOGICAL fanEnabled;
	double	   ccdSetpoint;
	double	   imagingCCDTemperature;
	double	   trackingCCDTemperature;
	double	   externalTrackingCCDTemperature;
	double	   ambientTemperature;
	double	   imagingCCDPower;
	double	   trackingCCDPower;
	double	   externalTrackingCCDPower;
	double 	   heatsinkTemperature;
	double     fanPower;
	double	   fanSpeed;
	double	   trackingCCDSetpoint;
} 
QueryTemperatureStatusResults2;

typedef struct 
{
	unsigned short tXPlus;
	unsigned short tXMinus;
	unsigned short tYPlus;
	unsigned short tYMinus;
} 
ActivateRelayParams;

typedef struct 
{
	unsigned short numberPulses;
	unsigned short pulseWidth;
	unsigned short pulsePeriod;
} 
PulseOutParams;

typedef struct 
{
	unsigned short	dataLength;
	unsigned char		data[256];
} 
TXSerialBytesParams;

typedef struct 
{
	unsigned short bytesSent;
} 
TXSerialBytesResults;

typedef struct 
{
	MY_LOGICAL clearToCOM;
} 
GetSerialStatusResults;

typedef struct 
{
	unsigned short sbigUseOnly;
} 
EstablishLinkParams;

typedef struct 
{
	unsigned short /* CAMERA_TYPE */ cameraType;
} 
EstablishLinkResults;

typedef struct 
{
	unsigned short /* DRIVER_REQUEST */ request;
} 
GetDriverInfoParams;

typedef struct 
{
	unsigned short version;
	char name[64];
	unsigned short maxRequest;
} 
GetDriverInfoResults0;

typedef struct 
{
	unsigned short /* CCD_INFO_REQUEST */ request;
} 
GetCCDInfoParams;

typedef struct 
{
	unsigned short mode;
	unsigned short width;
	unsigned short height;
	unsigned short gain;
	unsigned long  pixel_width;
	unsigned long  pixel_height;
} 
READOUT_INFO;

typedef struct 
{
	unsigned short firmwareVersion;
	unsigned short /* CAMERA_TYPE */ cameraType;
	char name[64];
	unsigned short readoutModes;
	struct 
	{
		unsigned short mode;
		unsigned short width;
		unsigned short height;
		unsigned short gain;
		unsigned long pixelWidth;
		unsigned long pixelHeight;
	} 
	readoutInfo[20];
} 
GetCCDInfoResults0;

typedef struct 
{
	unsigned short badColumns;
	unsigned short columns[4];
	unsigned short /* IMAGING_ABG */ imagingABG;
	char serialNumber[10];
} 
GetCCDInfoResults2;

typedef struct 
{
	unsigned short /* AD_SIZE */ adSize;
	unsigned short /* FILTER_TYPE */ filterType;
} 
GetCCDInfoResults3;

typedef struct 
{
	unsigned short capabilitiesBits;
	unsigned short dumpExtra;
} 
GetCCDInfoResults4;

typedef struct 
{
	// cameraBits:
	// b0: 0 = STX camera, 1 = STXL camera 
	// b1: 0 = mechanical shutter, 1 = no mechanical shutter
	unsigned long cameraBits;

	// ccdBits:
	// b0: 0 = Mono CCD, 1 = Color CCD
	// b1: 0 = Bayer color matrix, 1 = Truesense color matrix
	unsigned long ccdBits;

	// reserved for future expansion
	unsigned long extraBits;
} 
GetCCDInfoResults6;

typedef struct 
{
	unsigned short command;
} 
QueryCommandStatusParams;

typedef struct 
{
	unsigned short status;
} 
QueryCommandStatusResults;

typedef struct 
{
	MY_LOGICAL fanEnable;
	unsigned short /* SHUTTER_COMMAND */ shutterCommand;
	unsigned short /* LED_STATE */ ledState;
} 
MiscellaneousControlParams;

typedef struct 
{
	unsigned short /* CCD_REQUEST */ ccd;
} 
ReadOffsetParams;

typedef struct 
{
	unsigned short offset;
} 
ReadOffsetResults;

typedef struct 
{
	unsigned short offset;
	double rms;
} 
ReadOffsetResults2;

typedef struct 
{
	unsigned short xDeflection;
	unsigned short yDeflection;
} 
AOTipTiltParams;

typedef struct 
{
	unsigned short /* AO_FOCUS_COMMAND */ focusCommand;
} 
AOSetFocusParams;

typedef struct 
{
	unsigned long delay;
} 
AODelayParams;

typedef struct 
{
	MY_LOGICAL turboDetected;
} 
GetTurboStatusResults;

typedef struct 
{
	unsigned short	deviceType;			/* SBIG_DEVICE_TYPE, specifies LPT, Ethernet, etc */
	unsigned short	lptBaseAddress;	/* DEV_LPTN: Windows 9x Only, Win NT uses deviceSelect */
	unsigned long		ipAddress;			/* DEV_ETH:  Ethernet address */
} 
OpenDeviceParams;

typedef struct 
{
	unsigned short level;
} 
SetIRQLParams;

typedef struct 
{
	unsigned short level;
} 
GetIRQLResults;

typedef struct 
{
	MY_LOGICAL			linkEstablished;
	unsigned short	baseAddress;
	unsigned short	/* CAMERA_TYPE */ cameraType;
  unsigned long		comTotal;
  unsigned long		comFailed;
} 
GetLinkStatusResults;

typedef struct 
{
	unsigned long count;
} 
GetUSTimerResults;

typedef struct 
{
	unsigned short port;
	unsigned short length;
	unsigned char *source;
} 
SendBlockParams;

typedef struct 
{
	unsigned short port;
	unsigned short data;
} 
SendByteParams;

typedef struct 
{
	unsigned short /* CCD_REQUEST */ ccd;
	unsigned short readoutMode;
	unsigned short pixelStart;
	unsigned short pixelLength;
} 
ClockADParams;

typedef struct 
{
	unsigned short testClocks;
	unsigned short testMotor;
  unsigned short test5800;
	unsigned short stlAlign;
	unsigned short motorAlwaysOn;
} 
SystemTestParams;

typedef struct 
{
    unsigned short outLength;
    unsigned char *outPtr;
    unsigned short inLength;
    unsigned char *inPtr;
} 
SendSTVBlockParams;

typedef struct 
{
	unsigned short errorNo;
} 
GetErrorStringParams;

typedef struct 
{
	char errorString[64];
} 
GetErrorStringResults;

typedef struct 
{
	short handle;
} 
SetDriverHandleParams;

typedef struct 
{
	short handle;
} 
GetDriverHandleResults;

typedef struct 
{
	unsigned short /* DRIVER_CONTROL_PARAM */ controlParameter;
	unsigned long controlValue;
} 
SetDriverControlParams; 

typedef struct 
{
	unsigned short /* DRIVER_CONTROL_PARAM */ controlParameter;
} 
GetDriverControlParams; 

typedef struct 
{
	unsigned long controlValue;
} 
GetDriverControlResults;

typedef struct 
{
	unsigned	short /* USB_AD_CONTROL_COMMAND */ command;
	short			data;
} 
USBADControlParams;

typedef struct 
{
	MY_LOGICAL			cameraFound;
	unsigned short	cameraType;
	char						name[64];
	char						serialNumber[10];
} 
QUERY_USB_INFO;

typedef struct 
{
	unsigned short camerasFound;
	QUERY_USB_INFO usbInfo[4];
} 
QueryUSBResults;

typedef struct 
{
	unsigned short camerasFound;
	QUERY_USB_INFO usbInfo[8];
} 
QueryUSBResults2;

typedef struct 
{
	MY_LOGICAL			cameraFound;
	unsigned long		ipAddress;
	unsigned short	cameraType;
	char						name[64];
	char						serialNumber[10];
} 
QUERY_ETHERNET_INFO;

typedef struct 
{
	unsigned short			camerasFound;
	QUERY_ETHERNET_INFO ethernetInfo[4];
} 
QueryEthernetResults;

typedef struct 
{
	unsigned short			camerasFound;
	QUERY_ETHERNET_INFO ethernetInfo[8];
} 
QueryEthernetResults2;

typedef struct 
{
	unsigned short rightShift;
} 
GetPentiumCycleCountParams;

typedef struct 
{
	unsigned long countLow;
	unsigned long countHigh;
} 
GetPentiumCycleCountResults;

typedef struct 
{
	unsigned char	address;
	unsigned char	data;
	MY_LOGICAL		write;
	unsigned char	deviceAddress;
} 
RWUSBI2CParams;

typedef struct 
{
	unsigned char data;
} 
RWUSBI2CResults;

typedef struct 
{
	unsigned short	/* CFW_MODEL_SELECT */ cfwModel;
	unsigned short	/* CFW_COMMAND */			cfwCommand;
	unsigned long		cfwParam1;
	unsigned long		cfwParam2;
  unsigned short	outLength;
  unsigned char		*outPtr;
  unsigned short	inLength;
  unsigned char		*inPtr;
} 
CFWParams;

typedef struct 
{
	unsigned short	/* CFW_MODEL_SELECT */ cfwModel;
	unsigned short	/* CFW_POSITION */ cfwPosition;
	unsigned short	/* CFW_STATUS */ cfwStatus;
	unsigned short	/* CFW_ERROR */ cfwError;
	unsigned long		cfwResult1;
	unsigned long		cfwResult2;
} 
CFWResults;

typedef struct 
{
	unsigned short /* BITIO_OPERATION */ bitOperation;
	unsigned short /* BITIO_NAME */ bitName;
	MY_LOGICAL setBit;
} 
BitIOParams;

typedef struct 
{
	MY_LOGICAL bitIsSet;
} 
BitIOResults;

typedef struct 
{
	MY_LOGICAL		writeData;
	unsigned char data[32];
} 
UserEEPROMParams, UserEEPROMResults;

typedef struct 
{
	MY_LOGICAL			writeData;
	unsigned short	columns[7];
	unsigned short	flags;
} 
ColumnEEPROMParams, ColumnEEPROMResults;

typedef struct 
{
	unsigned char rowPeriod;
} 
BTDISetupParams;

typedef struct 
{
	unsigned char btdiErrors;
} 
BTDISetupResults;

typedef struct 
{
	unsigned short	/* MF_MODEL_SELECT */ mfModel;
	unsigned short	/* MF_COMMAND */ mfCommand;
	long						mfParam1;
	long						mfParam2;
  unsigned short	outLength;
  unsigned char		*outPtr;
  unsigned short	inLength;
  unsigned char		*inPtr;
} 
MFParams;

typedef struct 
{
	unsigned short	/* MF_MODEL_SELECT */ mfModel;
	long						mfPosition;
	unsigned short	/* MF_STATUS */ mfStatus;
	unsigned short	/* MF_ERROR  */ mfError;
	long						mfResult1;
	long						mfResult2;
} 
MFResults;

typedef struct 
{
	unsigned short  diffGuiderCommand; /* DIFF_GUIDER_COMMAND */ 
	unsigned short  spareShort;
	unsigned long   diffGuiderParam1;
	unsigned long   diffGuiderParam2;
  unsigned short  outLength;
  unsigned char*  outPtr;
  unsigned short  inLength;
  unsigned char*  inPtr;
} 
DiffGuiderParams;

typedef struct 
{
	unsigned short  diffGuiderError;  /* DIFF_GUIDER_ERROR  */
	unsigned short  diffGuiderStatus; /* DIFF_GUIDER_STATUS */
	unsigned long   diffGuiderResult1;
	unsigned long   diffGuiderResult2;
} 
DiffGuiderResults;

typedef struct
{
	unsigned short bRedEnable;
	unsigned short bIREnable;
	unsigned short nRedBrightness;
	unsigned short nIRBrightness;
}
DGLEDState;

typedef struct
{
	unsigned short	command; 			// BULK_IO_COMMAND
	MY_LOGICAL 			isPixelData;
	unsigned long 	dataLength;
	char*						dataPtr;
}
BulkIOParams;

typedef struct
{
	unsigned long dataLength;
}
BulkIOResults;

typedef struct 
{
	MY_LOGICAL bSetCustomerOptions; // TRUE/FALSE = set/get options 
	MY_LOGICAL bOverscanRegions;
	MY_LOGICAL bWindowHeater;
	MY_LOGICAL bPreflashCcd;
	MY_LOGICAL bVddNormallyOff;
} 
CustomerOptionsParams, CustomerOptionsResults;

typedef enum 
{ 
	DLF_CC_BASE					= 0x0001,
	DLF_CC_READOUT     	= 0x0002,
	DLF_CC_STATUS				= 0x0004,
	DLF_CC_TEMPERATURE	= 0x0008,
	DLF_CC_CFW					= 0x0010,
	DLF_CC_AO						= 0x0020,
	DLF_CC_40			      = 0x0040,
	DLF_CC_80     			= 0x0080
} 
DEBUG_LOG_CC_FLAGS;

typedef enum 
{ 
	DLF_MC_BASE					= 0x0001,
	DLF_MC_READOUT			= 0x0002,
	DLF_MC_STATUS				= 0x0004,
	DLF_MC_TEMPERATURE	= 0x0008,	
	DLF_MC_EEPROM				= 0x0010,
	DLF_MC_20	      		= 0x0020,
	DLF_MC_40				    = 0x0040,
	DLF_MC_80					  = 0x0080
} 
DEBUG_LOG_MC_FLAGS;

typedef enum 
{ 
	DLF_FCE_ETH					= 0x0001,
	DLF_FCE_USB					= 0x0002,
	DLF_FCE_FIFO				= 0x0004,
	DLF_FCE_0008				= 0x0008,
	DLF_FCE_0010				= 0x0010,
	DLF_FCE_0020				= 0x0020,
	DLF_FCE_0040		    = 0x0040,
	DLF_FCE_0080   			= 0x0080
} 
DEBUG_LOG_FCE_FLAGS;

typedef enum 
{ 
	DLF_IO_RD_COM_PIPE		= 0x0001,
	DLF_IO_WR_COM_PIPE		= 0x0002,
	DLF_IO_RD_PIXEL_PIPE	= 0x0004,
	DLF_IO_RD_ALT_PIPE		= 0x0008,
	DLF_IO_WR_ALT_PIPE		= 0x0010,
	DLF_IO_RD							= 0x0020,
	DLF_IO_WR							= 0x0040,
	DLF_IO_0080						= 0x0080
} 
DEBUG_LOG_IO_FLAGS;

typedef struct 
{
	unsigned short ccFlags;
	unsigned short mcFlags;
	unsigned short fceFlags;
	unsigned short ioFlags;
	char					 logFilePathName[1024];
} 
DebugLogParams;

#pragma pack(pop)	/* Restore previous struct align */

/*

	Function Prototypes

	This are the driver interface functions.

  SBIGUnivDrvCommand() - Supports Parallel, USB and Ethernet based cameras.

	Each function takes a command parameter and pointers
	to parameters and results structs.

	The calling program needs to allocate the memory for
	the parameters and results structs and these routines
	read them and fill them in respectively.

*/
#if TARGET == ENV_WIN
  #ifdef __cplusplus
  	extern "C" short __stdcall SBIGUnivDrvCommand(short command, void *Params, void *pResults);
  #else
	extern short __stdcall SBIGUnivDrvCommand(short command, void *Params, void *pResults);
  #endif
#else
  #ifdef __cplusplus
  	extern "C" short SBIGUnivDrvCommand(short command, void *Params, void *pResults);
  #else
    extern short SBIGUnivDrvCommand(short command, void *Params, void *pResults);
  #endif
#endif

#endif /* ifndef _PARDRV_ */