; $Revision: 1 $
; $Date: 8/22/05 4:17p $
;
;	This files gives a minor amount of documentation on the commands
;	supported in the HPDI32 app3 configuration file.
;

; Lines that are empty are ignored.
; White space is generally ignored.
; A semicolon begins a comment. The semicolon and all that follow are ignored.
; Upper and lower case letters can be used interchangably. Case is insignificant.
; Commands can appear in any order and any number of times.
; Processing is from beginning of the file to the end.



; Verbose: This controls how much is to be reported while working.
; Verbose			= Very, Yes, No
Verbose				= Very	; Report a lot of additional information.
Verbose				= Yes	; Report some additional information.
Verbose				= No	; Report no additional information.

; List: Requests a listing of the commands and current settings.
; List				= Yes, No
List				= No	; Do not list the commands.
List				= Yes	; List the commands to the console.



; AlmostEmpty: Set the Tx and Rx Almost Empty value.
; AlmostEmpty		= hex or decimal
AlmostEmpty			= 16

; AlmostFull: Set the Tx and Rx Almost Full value.
; AlmostFull		= hex or decimal
AlmostFull			= 16

; BlockCount: Specify the number of I/O data blocks to transfer.
; BlockCount		=  hex or decimal
BlockCount			= 256
BlockCount			= 1024
BlockCount			= 4096
BlockCount			= 1067	; ~20 minutes at 4096Hz

; BlockSamples: Specify the number of samples in each I/O data block.
; BlockSamples		=  hex or decimal
BlockSamples		= 256
BlockSamples		= 1024
BlockSamples		= 4096

; DataSize: Specify the cable data size.
; DataSize			= 8, 16, 32
DataSize			= 8		; Use the lowest 8-bits of cable data only.
DataSize			= 16	; Use the lowest 16-bits of cable data only.
DataSize			= 32	; Use all 32-bits of cable data.

; FrameValid: Configure the Frame Valid cable signal as Flow Control or GPIO.
; FrameValid		= Low, High, In, FlowControl
FrameValid			= Low			; GPIO: output low
FrameValid			= High			; GPIO: output high
FrameValid			= In			; GPIO: input
FrameValid			= FlowControl	; The signal's default functionality.

; IOClock: This is used to calculate the cable transfer data rate.
; IOClock			= hex or decimal
IOClock				= 8192
IOClock				= 20000000	; May vary greatly.

; LineValid: Configure the Line Valid cable signal as Flow Control or GPIO.
; LineValid			= Low, High, In, FlowControl
LineValid			= Low			; GPIO: output low
LineValid			= High			; GPIO: output high
LineValid			= In			; GPIO: input
LineValid			= FlowControl	; The signal's default functionality.

; LineValidOffCount: Specifies the Line Valid Off period in clock cycles.
; LineValidOffCount	= hex or decimal
LineValidOffCount	= 1024
LineValidOffCount	= 0x0

; LineValidOnCount: Specifies the Line Valid On period in clock cycles.
; LineValidOnCount	= hex or decimal
LineValidOnCount	= 1024
LineValidOnCount	= 0x0

; Mode: This specifies the desired I/O mode.
; Mode				= PIO, DMA (Auto), DMDMA
Mode				= PIO	; Programmed I/O
Mode				= DMA	; Direct Memory Access (the Automatic option is used)
Mode				= DMDMA	; Demand Mode DMA

; RxEnabled: Configure the Rx Enabled cable signal as Flow Control or GPIO.
; RxEnabled			= Low, High, In, FlowControl
RxEnabled			= Low			; GPIO: output low
RxEnabled			= High			; GPIO: output high
RxEnabled			= In			; GPIO: input
RxEnabled			= FlowControl	; The signal's default functionality.

; RxReady: Configure the Rx Ready cable signal as Flow Control or GPIO.
; RxReady			= Low, High, In, FlowControl
RxReady				= Low			; GPIO: output low
RxReady				= High			; GPIO: output high
RxReady				= In			; GPIO: input
RxReady				= FlowControl	; The signal's default functionality.

; StatusValid: Configure the Status Valid cable signal as Flow Control or GPIO.
; StatusValid		= Low, High, In, FlowControl
StatusValid			= Low			; GPIO: output low
StatusValid			= High			; GPIO: output high
StatusValid			= In			; GPIO: input
StatusValid			= FlowControl	; The signal's default functionality.

; StatusValidCount: Specifies the Status Valid high period in clock cycles.
; StatusValidCount	= hex or decimal
StatusValidCount	= 1024
StatusValidCount	= 0x0

; StatusValidMirror: Is the Line Valid signal to be high during the Status Valid period?
; StatusValidMirror	= No, Yes
StatusValidMirror	= No	; Line Valid stays low.
StatusValidMirror	= Yes	; Line Valid goes high.

; Timeout: This specifies the I/O timeout period.
; Timeout			=  hex or decimal
Timeout				= 0
Timeout				= 10
Timeout				= 1

; TxClockDivider: This configures the Tx Clock Divider.
; TxClockDivider	= hex or decimal
TxClockDivider		= 10
TxClockDivider		= 0x0

; TxEnabled: Configure the Tx Enabled cable signal as Flow Control or GPIO.
; TxEnabled			= Low, High, In, FlowControl
TxEnabled			= Low			; GPIO: output low
TxEnabled			= High			; GPIO: output high
TxEnabled			= In			; GPIO: input
TxEnabled			= FlowControl	; The signal's default functionality.

; TxReady: Configure the Tx Ready cable signal as Flow Control or GPIO.
; TxReady			= Low, High, In, FlowControl
TxReady				= Low			; GPIO: output low
TxReady				= High			; GPIO: output high
TxReady				= In			; GPIO: input
TxReady				= FlowControl	; The signal's default functionality.

