;;****************************************************************************
;;
;; (include pfbDpSlave.cfg)
;; Defines relating to the DP Slave functionality
;;
;; Assumes the pfbDefines.cfg file has already been included.
;;
;;****************************************************************************

; Defines relating to the DP Slave control register
(type DpSlaveControlRead cardGet %1 home slvCntCfg)
(typeDesc DpSlaveControlRead "(DpSlaveControlRead cardId)")

(type DpSlaveControlSet pfbBitSet %1 home slvCntCfg %2)
(typeDesc DpSlaveControlSet "(DpSlaveControlSet cardId events)")

(type DpSlaveControlClear pfbBitClear %1 home slvCntCfg %2)
(typeDesc DpSlaveControlClear "(DpSlaveControlClear cardId events)")

;
; Enable DP Slave functionality
; NOTE: pfbOnline command will automatically set this if DpSlave specified.
(type DpSlaveEnable pfbBitSet %1 home slvCntCfg SLV_CTL_ENABLE)
(typeDesc DpSlaveEnable "(DpSlaveEnable cardId)")

; Set Slave Ident Number (default is 0x6715)
;   Must be setup before going Online (if not configured with pfbLoadCfg cmd)
(type DpSlaveID cardSet %1 home slvID %2)
(typeDesc DpSlaveID "(DpSlaveID cardId IdentNumber)")

; Set Receive Data Length (default is 0)
;   Must be setup before going Online (if not configured with pfbLoadCfg cmd)
(type DpSlaveRxLen cardSet %1 home slvRxDataLen %2)
(typeDesc DpSlaveRxLen "(DpSlaveRxLen cardId nBytes)")

; Set Transmit Data Length (default is 0)
;   Must be setup before going Online (if not configured with pfbLoadCfg cmd)
(type DpSlaveTxLen cardSet %1 home slvTxDataLen %2)
(typeDesc DpSlaveTxLen "(DpSlaveTxLen cardId nBytes)")

; Set swap mode
;	SLV_CTL_RX_BYTE_SWAP
(type DpSlaveSlvSwapSet pfbBitSet %1 slvCntCfg SLV_CTL_RX_BYTE_SWAP)
(typeDesc DpSlaveSlvSwapSet "(DpSlaveSlvByteSwap cardId)")
(type DpSlaveSlvSwapClear pfbBitClear %1 slvCntCfg SLV_CTL_RX_BYTE_SWAP)
(typeDesc DpSlaveSlvSwapClear "(DpSlaveSlvSwapClear cardId)")


;;***************************************************************************
;; Summary of DP Slave registers and constants
;    slvCntCfg			Control/config
;	SLV_CTL_DIAG_UPD	request diagnostic read from master
;	SLV_CTL_EVT_RX_CHG	generate event (intr) when rx data to slave changes
;	SLV_CTL_FORCE_READY_TIME force resp time (pfbReadyTime), and ignore what the master sends
;	SLV_CTL_IGN_SYNC_FRZ_ERR don't generate error if master request sync and/or freeze
;	SLV_CTL_RX_BYTE_SWAP	swap upper and lower bytes of rx data
;	SLV_CTL_EVT_UPDTE	generate event when slave is updated
;	SLV_CTL_EVT_MODE_CHANGE generate event when slave mode changes
;	SLV_CTL_IGNORE_STS	ignore status of slave (no event
;	SLV_CTL_DIS_LED		disable status led for dp slave function
;	SLV_CTL_ENABLE		enable PFB to act as dp slave
;    slvStatus			Status (Host Read Only
;	SLV_STS_RUN_MODE	we're being scanned in run mode
;	SLV_STS_OK		current slave status is OK
;    slvError			Error indication
;	SLV_ERR_ID_MISM	ID from master does not match configured ID
;	SLV_ERR_READY_TIME_MISM pfbReadyTime does not match what master sent
;	SLV_ERR_UNSUP_REQ	pfb is requesting unsupported Freeze or Sync
;	SLV_ERR_RX_LEN_MISM	length of data from master to us incorrect
;	SLV_ERR_TX_LEN_MISM	length of data from us to master incorrect
;	SLV_ERR_WD_FACT_INV	slvWdFact1 or slvWdFact2 from master was 0
;	SLV_ERR_TIME_OUT	slave watchdog time out (check response timeout
;	SLV_ERR_WARN_WD_DIS	slave timeout watch dog disabled from master
;    slvEvent			Event Flags
;	SLV_EVT_UPD		master has updated us
;	SLV_EVT_RX_DATA_CHG	rx data from master has changed
;    slvDiagEvent		Diagnostic Event Flags
;	SLV_DEVT_DIAG_UPD	master has read diagnostic info
;    slvRxDataLen		(received from master
;    slvReqRxDataLen		(requested by master
;    slvTxDataLen		(transmitted to master
;    slvReqTxDataLen		(requested by master
;    slvChkLen			len configuration check data
;    slvParmLen			len of parameters from master
;    slvGlbCntrl		global controls from master
;    slvSts1			tatus byte 1 to master
;    slvSts2			tatus byte 2 to master
;    slvSts3			tatus byte 3 to master
;    slvMasStn			Station that configured Slave
;    slvID_hi			master hi byte id  (def 0x67
;    slvID_lo			master lo byte id  (def 0x15
;    slvDiagLen			Len of diags to master
;    slvDiag			Diags to master
;    slvMasSts			status byte
;    slvWdFact1			Watchdog factor 1
;    slvWdFact2			Watchdog factor 2
;    slvReadyTime		Response delay time (tbit
;    slvMasID_hi		ID value (hi byte
;    slvMasID_lo		ID value (lo byte
;    slvGrpId			Group ID value
;    slvParm			slave parameters
;    slvChk			Config. Check values
;    slvRxData			Slave Rx data
;    slvTxData			Slave data to be sent
;