avr: moved COM and COMPROTO defs and routines into dedicated files.

This commit is contained in:
Martin Preuss
2023-04-16 23:23:06 +02:00
parent d53b061aed
commit 5f4260d605
15 changed files with 1332 additions and 1001 deletions

View File

@@ -9,21 +9,24 @@
.equ FLASH_ERROR_NONE = 0
.equ FLASH_ERROR_BAD_MSGNUM = 1
.equ FLASH_ERROR_BAD_ADDR = 2
.equ FLASH_CMD_FLASH_RSP = 74
.equ FLASH_MSG_OFFS_DESTADDR = 0
.equ FLASH_MSG_OFFS_MSGLEN = 1
.equ FLASH_MSG_OFFS_MSGDATA = 2
.equ FLASH_MSG_OFFS_CMD = 2 ; first at COM2_MSG_OFFS_MSGDATA
.equ FLASH_MSG_OFFS_SRCADDR = 3
.equ FLASH_MSG_OFFS_PAYLOAD = 4 ; payload for the cmd follows here
.equ CPRO_PACKET_FLASH_START_OFFS_MSGNUM = COM_MSG_OFFS_PAYLOAD+0 ; 2 bytes
.equ CPRO_PACKET_FLASH_START_OFFS_ADDR = COM_MSG_OFFS_PAYLOAD+2 ; 2 bytes
.equ CPRO_PACKET_FLASH_ADDR_OFFS_MSGNUM = COM_MSG_OFFS_PAYLOAD+0 ; 2 bytes
.equ CPRO_PACKET_FLASH_ADDR_OFFS_ADDR = COM_MSG_OFFS_PAYLOAD+2 ; 2 bytes
.equ FLASH_PACKET_DATA_OFFS_ADDR = FLASH_MSG_OFFS_PAYLOAD+0 ; 2 bytes
.equ FLASH_PACKET_DATA_OFFS_DATA = FLASH_MSG_OFFS_PAYLOAD+2 ; n bytes
.equ CPRO_PACKET_FLASH_DATA_OFFS_MSGNUM = COM_MSG_OFFS_PAYLOAD+0 ; 2 bytes
.equ CPRO_PACKET_FLASH_DATA_OFFS_DATA = COM_MSG_OFFS_PAYLOAD+2 ; 2 bytes
.equ CPRO_FLASH_ERROR_NONE = 0
.equ CPRO_FLASH_ERROR_BAD_MSGNUM = 1
.equ CPRO_FLASH_ERROR_BAD_ADDR = 2
@@ -34,8 +37,9 @@
.dseg
flashDataBegin:
flashCurrentAddress: .byte 2
flashLastReceivedMsg: .byte 2
flashUid: .byte 4
flashSendBuffer: .byte 64
flashRecvBuffer: .byte 64
flashDataEnd:
@@ -49,104 +53,371 @@ flashDataEnd:
FLASH_PROTO_BEGIN:
bootLoader:
cli ; disable interrupts throughout the whole process
; setup stack
.ifdef SPH ; if SPH is defined
ldi r16, High(RAMEND)
out SPH, r16 ; init MSB stack pointer
.endif
ldi r16, Low(RAMEND)
out SPL, r16 ; init LSB stack pointer
sbi DDRA, PORTA3 ; out
; sbi PINA, PORTA3 ; toggle
cbi PORTA, PORTA3 ; on
; sbi PORTA, PORTA3 ; off
rcall flashReadUid
sts flashUid, r18
sts flashUid+1, r19
sts flashUid+2, r20
sts flashUid+3, r21
; send flash ready message
ldi xl, LOW(flashSendBuffer)
ldi xh, HIGH(flashSendBuffer)
rcall flashWriteFlashReady
rcall flashSendPacketUntilSuccess
; wait up to 10s for incoming FLASH_START message
ldi r16, CPRO_CMD_FLASH_START
ldi r17, 100 ; 100*100ms=10s
rcall flashWaitForSpecificMessageWithLed
brcc bootLoader_startFirmware
; either FLASH_START or FLASH_END received
cpi r16, CPRO_CMD_FLASH_START ; not FLASH_START, no flashing requested
brne bootLoader_startFirmware
; receive and flash new firmware
; try to start firmware
bootLoader_startFirmware:
lds r20, firmwareStart
lds r21, firmwareStart+1
mov r16, r20
or r16, r21
breq bootLoader ; restart boot loader
; jmp via stack
push r20
push r21
ret
; ---------------------------------------------------------------------------
; Enqueue a FLASHDATA_ACK packet.
; wait for a specific message to arrive within given time, flashing LED
;
; IN:
; - R16: destination address
; - R17: response code (0 if ok, error code otherwise)
; - R19:R18: msg num
; - R16: message type to receive
; - R17: wait time in 100ms (1=100ms, 2=200ms etc.)
; OUT:
; - CFLAG: set if okay, clear otherwise
; MODIFIED REGS: R6, R7, R8, R9, R10, R11, R12, R16, R17, X, Y (R3, R4, R15, R16, R17, R18, R19, R20, R21)
; - CFLAG: set if msg received (either expected msg or FLASH_END), cleared otherwise
; - R16: message type received (if CFLAG set)
; REGS: R2, R16, R17 (R1, R24, R25, X)
CPRO_EnqueueFlashRsp:
mov r6, r16
mov r7, r17
mov r8, r18
mov r9, r19
flashWaitForSpecificMessageWithLed:
mov r2, r16
sbi PORTA, PORTA3 ; LED off
rcall COM_AllocBufferAndGetXY ; (r16, r17, r21)
brcc CPRO_EnqueueFlashRsp_error
push xh
push xl
mov r16, r6
ldi r17, CPRO_PAYLOAD_FLAGS_SECONDS | (3<<CPRO_PAYLOAD_FLAGS_SHIFT_NUM)
ldi r18, CPRO_CMD_FLASH_RSP
rcall cproBeginMsgWithVariablePayload ; (R3, R4, R16, R17, R18, R19, R20, R21, X)
st X+, r8 ; 4: msg num (low)
st X+, r9 ; 5: msg num (high)
st X+, r7 ; 6: ACK or NAK
pop xl
pop xh
rcall comCalcAndAddChecksumByte
; mark buffer as enqueued with PRIO "important" (higher number of retries)
ldi r20, COM_BUFFER_PRIO_IMPORTANT
rcall COM_EnqueuePacket ; (R15, R16)
brcc CPRO_EnqueueFlashRsp_error
flashWaitForSpecificMessageWithLed_loop:
sbi PINA, PORTA3 ; toggle LED
mov r16, r2
push r17
ldi r17, 100 ; wait up to 100ms
rcall flashWaitForSpecificMessage ; (R1, R16, R17, R24, R25, X)
pop r17
brcs flashWaitForSpecificMessageWithLed_received
dec r17
brne flashWaitForSpecificMessageWithLed_loop
sbi PORTA, PORTA3 ; off
clc
ret
flashWaitForSpecificMessageWithLed_received:
sbi PORTA, PORTA3 ; off
sec
ret
CPRO_EnqueueFlashRsp_error:
; ---------------------------------------------------------------------------
; wait for a specific message to arrive within given time.
;
; IN:
; - R16: msg command to wait for
; - R17: time to wait for packet (in milliseconds) (low)
; OUT:
; - CFLAG: set if msg received, cleared on timeout
; - R16 : message type received
; REGS: R1, R16, R17, X (R24, R25)
flashWaitForSpecificMessage:
mov r1, r16 ; expected message type
; wait for ATTN to go low
flashWaitForSpecificMessage_loop1:
ldi r16, 0 ; wait for low
rcall flashWaitForAttnState1ms ; (R24, R25)
brcs flashWaitForSpecificMessage_isLow
dec r17
brne flashWaitForSpecificMessage_loop1
rjmp flashWaitForSpecificMessage_timeout
; receive message
flashWaitForSpecificMessage_isLow: ; is low, receive message, check for msg type
push r17
ldi r16, COM2_MAINTENANCE_ADDR
ldi xl, LOW(flashRecvBuffer)
ldi xh, HIGH(flashRecvBuffer)
rcall com2ReceivePacketRaw
pop r17
brcc flashWaitForSpecificMessage_waitAttnHigh
ldi xl, LOW(flashRecvBuffer)
ldi xh, HIGH(flashRecvBuffer)
adiw xh:xl, COM2_MSG_OFFS_CMD
ld r16, X
sbiw xh:xl, COM2_MSG_OFFS_CMD
cp r16, r1
breq flashWaitForSpecificMessage_received
cpi r16, CPRO_CMD_FLASH_END
breq flashWaitForSpecificMessage_received
flashWaitForSpecificMessage_waitAttnHigh:
dec r17
breq flashWaitForSpecificMessage_timeout
; wait for ATTN to go high
flashWaitForSpecificMessage_loop2:
ldi r16, 0xff ; wait for high
rcall flashWaitForAttnState1ms ; (R24, R25)
brcs flashWaitForSpecificMessage_isHigh
dec r17
brne flashWaitForSpecificMessage_loop2
rjmp flashWaitForSpecificMessage_timeout
flashWaitForSpecificMessage_isHigh:
rjmp flashWaitForSpecificMessage_loop1
flashWaitForSpecificMessage_received: ; R16 contains message type
sec
ret
flashWaitForSpecificMessage_timeout:
clc
ret
; ---------------------------------------------------------------------------
; Handle "FLASH_START" packet.
; Wait for up to 1ms for ATTN line to reach the given state
;
; IN:
; - Y : pointer to received buffer
; - R16: expected state (0xff for high, 0 for low)
; OUT:
; - CFLAG: set if handled, cleared otherwise
; - CFLAG: set if state reached, cleared otherwise
; REGS: R24, R25
flashWaitForAttnState1ms:
ldi r24, LOW(1000)
ldi r25, HIGH(1000)
flashWaitForAttnState1ms_loop:
in r17, COM_PIN_ATTN
eor r17, r16
andi r17, (1<<COM_PINNUM_ATTN)
breq flashWaitForAttnState1ms_stateReached
sbiw r25:r24, 1
brne flashWaitForAttnState1ms_loop
clc
ret
flashWaitForAttnState1ms_stateReached:
sec
ret
; ---------------------------------------------------------------------------
; wait indefinately until ATTN line is high, send packet over wire, retry until successfull
;
; IN:
; - x : ptr to buffer to send
; OUT:
; - nothing
; REGS: R15, R16, R22 (R17, R21, X)
CPRO_HandleFlashStart:
ldd r21, y+(COM_BUFFER_OFFS_DATA+COM_MSG_OFFS_SRCADDR) ; source address for later
; check message number
ldi r20, CPRO_FLASH_ERROR_BAD_MSGNUM ; preset error code
ldd r16, y+(COM_BUFFER_OFFS_DATA+CPRO_PACKET_FLASH_START_OFFS_MSGNUM)
ldd r17, y+(COM_BUFFER_OFFS_DATA+CPRO_PACKET_FLASH_START_OFFS_MSGNUM)+1
tst r17
brne CPRO_HandleFlashStart_respond ; high byte of first message number should be 0
cpi r16, 1
brne CPRO_HandleFlashStart_respond ; low byte of first message number should be 1
lds r16, flashLastReceivedMsg
lds r17, flashLastReceivedMsg+1
or r16, r17
brne CPRO_HandleFlashStart_respond ; should be 0, otherwise operation already in progress
sts flashLastReceivedMsg+1, r16 ; high byte: 0
ldi r16, 1
sts flashLastReceivedMsg, r16 ; low byte: 1
flashSendPacketUntilSuccess:
push xl
push xh
rcall COM2_SendPacketWithAttn
pop xh
pop xl
brcc flashSendPacket_error
cbi PORTA, PORTA3 ; on
ret
flashSendPacket_error:
rcall flashWaitForAttnHigh
rjmp flashSendPacketUntilSuccess
; check address
ldi r20, CPRO_FLASH_ERROR_BAD_ADDR ; preset error code
ldd r16, y+(COM_BUFFER_OFFS_DATA+CPRO_PACKET_FLASH_START_OFFS_ADDR)
ldd r17, y+(COM_BUFFER_OFFS_DATA+CPRO_PACKET_FLASH_START_OFFS_ADDR)+1
mov r18, r16
mov r19, r17
subi r18, LOW(AQHOME_FW_START_ADDRESS_MAIN) ; below start of main firmware?
sbci r19, HIGH(AQHOME_FW_START_ADDRESS_MAIN)
brcs CPRO_HandleFlashStart_respond
; store address
sts flashCurrentAddress, r16
sts flashCurrentAddress+1, r17
clr r20 ; set response code to 0
; fall through
CPRO_HandleFlashStart_respond:
mov r16, r21 ; dest addr
mov r17, r20 ; response
lds r18, flashLastReceivedMsg
lds r19, flashLastReceivedMsg+1
rcall CPRO_EnqueueFlashRsp
sec ; message handled
; ---------------------------------------------------------------------------
; wait indefinately for free ATTN line
;
; IN:
; - nothing
; OUT:
; - nothing
; REGS: R15, R16, R22 (R17, R21, X)
flashWaitForAttnHigh:
rcall com2WaitForAttnHigh ; waits for up to 100us
brcc flashWaitForAttnHigh_stillLow
ret
flashWaitForAttnHigh_stillLow:
rcall flashWaitDependingOnUid ; (R16, R18, R22, R24, R25)
rjmp flashWaitForAttnHigh
; ---------------------------------------------------------------------------
; wait depending on lowest byte of uid.
;
; Wait interval is between 100ms and 25s (i.e. 255*100ms). This is used to avoid
; all nodes on the network trying to send messages at the exact same time (e.g. after
; power outage which would affect all nodes at the same time).
;
; IN:
; - nothing
; OUT:
; - nothing
; REGS: R16 (R18, R22, R24, R25)
flashWaitDependingOnUid:
lds r16, flashUid
tst r16
brne flashWaitForAttnHigh_waitLoop
ldi r16, 17
flashWaitForAttnHigh_waitLoop: ; wait for up to 25s before trying again
rcall flashWaitFor100ms ; (R18, R22, R24, R25)
sbi PINA, PORTA3 ; toggle LED
dec r16
brne flashWaitForAttnHigh_waitLoop
ret
; ---------------------------------------------------------------------------
; wait for 100 milliseconds.
;
; IN:
; - nothing
; OUT:
; - nothing
; REGS: R18 (R22, R24, R25)
flashWaitFor100ms:
ldi r18, 100
flashWaitFor100ms_loop:
rcall flashWaitFor1ms ; (R22, R24, R25)
dec r18
brne flashWaitFor100ms_loop
ret
; ---------------------------------------------------------------------------
; wait for 1 millisecond.
;
; IN:
; - nothing
; OUT:
; - nothing
; REGS: R24, R25 (R22)
flashWaitFor1ms:
ldi r24, LOW(1000)
ldi r25, HIGH(1000)
flashWaitFor1ms_loop:
rcall com2WaitFor1000ns
sbiw r25:r24, 1
brne flashWaitFor1ms_loop
ret
; ---------------------------------------------------------------------------
; Write a FLASH_RESPONSE packet.
;
; IN:
; - R16: response code (0 if ok, error code otherwise)
; - X : buffer to write to
; OUT:
; - nothing
; MODIFIED REGS: R16, R17 (R18, R19, R20)
flashWriteFlashRsp:
clr r18
st X+, r18 ; dest address (unused)
ldi r18, 3 ; msg code+src address+one payload byte
st X+, r18 ; msg len
ldi r17, CPRO_CMD_FLASH_RSP
st X+, r17 ; msg code
clr r17
st X+, r17 ; src address (not used)
st X, r16 ; payload byte
sbiw xh:xl, 4
rcall com2CalcAndAddChecksumByte ; (R16, R17, R18, R19, R20, X)
sbiw xh:xl, 5
ret
; ---------------------------------------------------------------------------
; Write a FLASH_READY packet.
;
; IN:
; - X : buffer to write to
; OUT:
; - nothing
; MODIFIED REGS: R16 (R17, R18, R19, R20)
flashWriteFlashReady:
clr r16
st X+, r16 ; dest address (unused)
ldi r16, 12 ; msg code+src address+ten payload bytes
st X+, r16 ; msg len
ldi r16, CPRO_CMD_FLASH_READY
st X+, r16 ; msg code
clr r16
st X+, r16 ; src address (not used)
; payload
lds r16, flashUid
st X+, r16
lds r16, flashUid+1
st X+, r16
lds r16, flashUid+2
st X+, r16
lds r16, flashUid+3
st X+, r16
ldi r16, LOW(firmwareType)
st X+, r16
ldi r16, HIGH(firmwareType)
st X+, r16
ldi r16, LOW(firmwareVersion)
st X+, r16
ldi r16, HIGH(firmwareVersion)
st X+, r16
ldi r16, LOW(PAGESIZE*2)
st X+, r16
ldi r16, HIGH(PAGESIZE*2)
st X, r16
sbiw xh:xl, 13
rcall com2CalcAndAddChecksumByte ; (R16, R17, R18, R19, R20, X)
sbiw xh:xl, 14
ret
@@ -154,3 +425,13 @@ CPRO_HandleFlashStart_respond:
FLASH_PROTO_END:
.equ MODULE_SIZE_FLASH_PROTO = FLASH_PROTO_END-FLASH_PROTO_BEGIN