########################################################################
### FILE:	llacinit.mod
### PURPOSE:	Low Level Auxillary Control setup
### AUTHOR:	Tor Slettnes <tor@slett.net>
### 
### Copyrights (C) 2006 Applied Biosystems.  All rights reserved.
########################################################################

### Asynchronous Event Handler
    LLAC:EVENt+ Events -control=0x00 -controlMask=0x40 <multiline>
        SET Message "-subsystem=$device$ -node=$source$" \
                    "-control=$control$ -severity=$severity$" \
                    "-id=$id$ -data=$0h$,$1h$,$2h$,$3h$ -text=\"$text$\"" 

        PUBLish Event ${Message}
    </multiline>

    LLAC:EVENT+ Warnings -control=0x10 -controlMask=0x70 <quote>
        PUBLish Warning "$device$ Warning $id$: $text$ (data=$0123h$)"
    </quote>

    LLAC:EVENT+ Errors -control=0x20 -controlmask=0x70 <quote>
        PUBLish Warning "$device$ Error $id$: $text$ (data=$0123h$)"
    </quote>
        
    LLAC:EVENT+ Fatals -control=0x30 -controlmask=0x70 <quote>
        PUBLish Error "$device$ Fatal Event $id$: $text$ (data=$0123h$)"
        IF $(STATE:EXISTS? $device$) <quote.state>
            SET id $device$.$[ "$id$"[2:] ]
            STATe:ERRor= $device$ ${id} "$text$ (data=$0123h$)"
        </quote.state>
    </quote>


### Synchronization event handler
    LLAC:EVENt+ LLACSync -id=0x0000 -idMask=0x8000 -control=0x00 -controlMask=0x40 <multiline>
        PUBLish SyncEvent '-target=$target$ -id=$id$ -source=$source$ -control=$control$ -data=$0h$,$1h$,$2h$,$3h$'
    </multiline>
    

### Registration event handler
    STATe:NEW LLAC:Registration

    LLAC:DEFINT DEVice+ $AppType$ $Node$ <quote.reg>
        SET StateName LLAC:Registration:$AppType$
	VAR $AppType$-Retries 0

	UNLess $(:STATe:EXISTS? ${StateName}) <quote.reg>
            :STATe:NEW ${StateName} 
            :STATe:DEPendency+ LLAC:Registration -requires=${StateName}
       
            :STATe:TRIGGer+ -states=${StateName} -edge=Set LLACRegister <quote.trigger>
                INFO "Registering $AppType$ at node address $Node$"
                $AppType$+ $Node$
            </quote.trigger>

            :STATe:TRIGGer+ -states=${StateName} -edge=Clear LLACUnregister <quote.trigger>
                INFO "Deregistering $AppType$ at node address $Node$"
                TRY '$AppType$- $Node$' \
                    'WARNing "Unable to unregister $AppType$: [${error}] ${message}"'
            </quote.trigger>
        </quote.reg>

	NEXT

        :STATe:SETTing ${StateName} True
    </quote.reg>


    DEFINT BOOT+ $SourceNode$ <quote.boot>
        INFO "Bootload handler for device $SourceNode$ -- not implemented yet"
    </quote.boot>


    LLAC:EVENt+ LLACRegEvent -control=0x40 -controlMask=0x40 <quote.regevent>
        SET LLACVersion $01h$
        SET TABLEOffset $23h$

        SET DeviceType  $(:LLAC:DEVice? -ignoreMissing $source$)

        UNLess ${#DeviceType} <quote.query>
            SET AppType  $(:LLAC:TEXT? -nonprint="" $source 0x0008)
            IF $(:STATe:EXISTS? ${AppType:-.}) <quote.app>
                SET DeviceType $(:STATe:NAME? ${AppType})
                :LLAC:DEVice= $source$ ${DeviceType}
            </quote.app>
        </quote.query>

        IF ${#DeviceType} <quote.add>
            :LLAC:DEVICE+ ${DeviceType} $source$
        </quote.add>
    </quote.regevent>


### Send Registration Requests at regular intervals
    LLAC:SCHedule+ CheckRegistrations 2.0 <quote.checkregistrations>
        ITERate -key=state $(:STATe:DEPendency* LLAC:Registration) <quote>
            SET Device $[ "${state}".split(":")[-1] ]
            SET RetryCounter ${Device}-Retries
            SET Retries ${${RetryCounter}:-0}
            IF ${Retries} <quote.notresponding>
                SET LogMessage "RegistrationCheck: No response from ${Device} after ${Retries} requests"
                IF $[ ${Retries} < 3 ] <if>
                    WARNing "${LogMessage}; retrying..."
                </if>
                ELIF $(:STATe:SETTing? -errorState=False ${state}) <else>
                    WARNing "${LogMessage}; deregistering!"
                    :STATe:SETTing ${state} False
                </else>
            </quote.notresponding>
            ADDValue ${RetryCounter} 1
        </quote>
        RegistrationRequest 0x81   ### TBC does not support broadcast address
        RegistrationRequest
    </quote.checkregistrations>