########################################################################
### FILE:	system.mod
### PUROPSE:	Generic system functions
###
### Copyrights (C) 2006 Applied Biosystems.  All rights reserved.
########################################################################


########################################################################
### MACRO:      UPGRADE
### PURPOSE:    Invoke the Upgrade Package SCPI Macro.
###

DEFine -asynchronous UPGRade <multiline>
        PUBLish Upgrade Starting Instrument Upgrade.
        PUBLish Upgrade Validating Instrument Upgrade Package.
        VAR  result $(SYST:EXEC '/sbin/gpgVerify.sh')
        IF $[ ${result:-0} > 0 ] <if>
                FILe:REMove -recursive UPGRADE:*
                PUBLish Upgrade upgrade aborted GPG Validation Failure!
                ERRor -id=InvalidSignature 'Failed to verify upgrade package signature!'
        </if>
        ELSe <cont>
                PUBLish Upgrade Performing Instrument Upgrade.
                MODule  upgrade.mod
        </cont>
</multiline>


########################################################################
### MACRO:	    ClientCONFig, ClientCONFig?
### PURPOSE:	Set and get key/value pairs for Client configurations
###

DEFine ClientCONFig $section$=default $key$ $value$ <ml>
    TRY <try>
        CONF+ client $section$
        CONF= -createMissing client $section$ $key$ "$value$"
    </try> <catch>
        CONF= -createMissing client $section$ $key$ "$value$"
    </catch>
    PUBLish Configuration cconf/$section$/$key$ = $value$
</ml>


DEFine ClientCONFig? $section$=default $key$ <ml>
    RETurn $(CONF? client $section$ $key$)
</ml>


DEFine ClientCONFig- $section$=default $key$ <ml>
    CONF- client $section$ $key$
    PUBLish Configuration cconf/$section$/$key$ removed
</ml>

########################################################################
### MACRO:	    UserCONFig, UserCONFig?
### PURPOSE:	Set and get key/value pairs for users configurations
###

DEFine UserCONFig $user$=default $key$ $value$ <ml>
    TRY <try>
        CONF+ user $user$
        CONF= -createMissing user $user$ $key$ "$value$"
    </try> <catch>
        CONF= -createMissing user $user$ $key$ "$value$"
    </catch>
    PUBLish Configuration uconf/$user$/$key$ = $value$
</ml>


DEFine UserCONFig? $user$=default $key$ <ml>
    RETurn $(CONF? user $user$ $key$)
</ml>


DEFine UserCONFig- $user$=default $key$ <ml>
    CONF- user $user$ $key$
    PUBLish Configuration uconf/$user$/$key$ removed
</ml>

########################################################################
### MACRO:	TIMe, TIMe?, TimeSync
### PURPOSE:	Set/read system time, synchronize time w/subsystems
###


DEFine TIMe $seconds$ <multiline>
    IF ${#RunTitle:-} <quote.notnow>
        ERRor -id=TimeChangeDuringRun "Cannot change system time while a run is in progress"
    </quote.notnow>

    SYSTem:TIMe $seconds$
    TimeSync $seconds$
</multiline>

ALIas TIMe? SYSTem:TIMe?


VARiable TimeSync ""
DEFINT TimeSync $Time$='' <multiline>
    VAR time $[ int(float("$Time$" or time.time())) ]
    RUN ${TimeSync}
</multiline>


DEFine ModeSwitchWait $applicationTypeRegister$=8 $node$ $mode$ $delay$ <ml.ModeSwitchWait>
    IF $[ "$mode$" not in "$(LLAC:TEXT? -size=4 $node$ $applicationTypeRegister$)" ] <ml.ifMode>
        WAIT $delay$
        IF $[ "$mode$" not in "$(LLAC:TEXT? -size=4 $node$ $applicationTypeRegister$)" ] <ml.if>
           ERRor "Unable to switch to $mode$ mode"
        </ml.if>
    </ml.ifMode>
</ml.ModeSwitchWait>


DEFine FirmWareUPgrade $appSwitchDelay$=2 $applicationTableRegister$=7 $applicationTypeRegister$=8 $firmwareResetControlRegister$=10 $bootDeviceBlockOffset$=1 $firmwareResetCommand$=1 $node$ $applicationType$ $file$ <ml.FirmWareUPgrade>
    IF $[ "BOOT" not in "$(LLAC:TEXT? -size=4 $node$ $applicationTypeRegister$)" ] <ml.reset>
        LLAC:INT -size=2 $node$ $firmwareResetControlRegister$ $firmwareResetCommand$
        ModeSwitchWait -applicationTypeRegister=$applicationTypeRegister$ $node$ BOOT $appSwitchDelay$
    </ml.reset>

    LVAR AppTableAddr $(LLAC:HEX? -size=2 $node$ $applicationTableRegister$)
    LVAR BootTableAddr $(LLAC:HEX? -size=2 $node$ ${AppTableAddr})
    LVAR BootDeviceBlock $(LLAC:HEX? -size=2 $node$ $[ ${BootTableAddr} + $bootDeviceBlockOffset$ ])

    LLAC:FIRMWAREDOWNLOAD $node$ ${BootDeviceBlock} $file$

    ModeSwitchWait -applicationTypeRegister=$applicationTypeRegister$ $node$ $applicationType$ $appSwitchDelay$
</ml.FirmWareUPgrade>



########################################################################
### MACROS:	NICK=, NICK?
### PURPOSE:	Set/get instrument nick name

SYStem:SETTing:ALIas NICK= :CONF= -createMissing server.ini server nickname
SYSTem:SETTing:ALIas NICK? :CONF? -default="-" server.ini server nickname