Compare commits
18 Commits
v2
...
7d103ca957
| Author | SHA1 | Date | |
|---|---|---|---|
| 7d103ca957 | |||
| eca7a41051 | |||
| 7314f7ab3b | |||
| 5b361904ab | |||
| 833e134e01 | |||
| da730b7bb5 | |||
| c351bee257 | |||
| 34e7f1be34 | |||
| 445e187722 | |||
| 250aba5cfb | |||
| 5c900720e3 | |||
| 7d6ef959b2 | |||
| 11ffbce2e2 | |||
| f32a27ff15 | |||
| 57d94cf631 | |||
| 8203a24f33 | |||
| 2906da3272 | |||
| 64c1e484b5 |
3
.gitmodules
vendored
3
.gitmodules
vendored
@@ -1,3 +0,0 @@
|
|||||||
[submodule "libavr"]
|
|
||||||
path = libavr
|
|
||||||
url = ../libavr.git
|
|
||||||
234
CMakeLists.txt
234
CMakeLists.txt
@@ -8,9 +8,6 @@ include(FetchContent)
|
|||||||
if(NOT LIBAVR_ROOT AND DEFINED ENV{LIBAVR_ROOT})
|
if(NOT LIBAVR_ROOT AND DEFINED ENV{LIBAVR_ROOT})
|
||||||
set(LIBAVR_ROOT $ENV{LIBAVR_ROOT})
|
set(LIBAVR_ROOT $ENV{LIBAVR_ROOT})
|
||||||
endif()
|
endif()
|
||||||
if(NOT LIBAVR_ROOT)
|
|
||||||
set(LIBAVR_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/libavr)
|
|
||||||
endif()
|
|
||||||
if(LIBAVR_ROOT)
|
if(LIBAVR_ROOT)
|
||||||
FetchContent_Declare(libavr SOURCE_DIR ${LIBAVR_ROOT})
|
FetchContent_Declare(libavr SOURCE_DIR ${LIBAVR_ROOT})
|
||||||
else()
|
else()
|
||||||
@@ -54,20 +51,6 @@ if(PROJECT_IS_TOP_LEVEL)
|
|||||||
endif()
|
endif()
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
# The ELF is only a container (symbols, section headers) and is never flashed —
|
|
||||||
# and the host tool's load_image() dispatches on extension, so handing it one
|
|
||||||
# would silently program the header bytes. Every loader image therefore gets
|
|
||||||
# both flashable forms beside it at link time: .hex for avrdude, and .bin for
|
|
||||||
# the host tool's raw path (which is what the reloc and update tests convert to
|
|
||||||
# on the fly). .eeprom is dropped — EEPROM content is its own update.
|
|
||||||
function(add_image_outputs name)
|
|
||||||
add_custom_command(TARGET ${name} POST_BUILD
|
|
||||||
COMMAND ${CMAKE_OBJCOPY} -O ihex -R .eeprom
|
|
||||||
$<TARGET_FILE:${name}> $<TARGET_FILE:${name}>.hex
|
|
||||||
COMMAND ${CMAKE_OBJCOPY} -O binary -R .eeprom
|
|
||||||
$<TARGET_FILE:${name}> $<TARGET_FILE:${name}>.bin)
|
|
||||||
endfunction()
|
|
||||||
|
|
||||||
# The TinySafeBoot protocol reimplemented on libavr in three variants that trade
|
# The TinySafeBoot protocol reimplemented on libavr in three variants that trade
|
||||||
# clarity for size. Each links into the ATmega328P boot section (BOOTSZ selects
|
# clarity for size. Each links into the ATmega328P boot section (BOOTSZ selects
|
||||||
# its size; BOOTRST vectors a reset to its base) with -nostartfiles — a polled
|
# its size; BOOTRST vectors a reset to its base) with -nostartfiles — a polled
|
||||||
@@ -107,7 +90,6 @@ function(add_tsb_variant name bytes)
|
|||||||
target_link_options(${name} PRIVATE -nostartfiles -Wl,--section-start=.text=${base_hex}
|
target_link_options(${name} PRIVATE -nostartfiles -Wl,--section-start=.text=${base_hex}
|
||||||
-Wl,--defsym=tsb_app=0 -Wl,--pmem-wrap-around=32k)
|
-Wl,--defsym=tsb_app=0 -Wl,--pmem-wrap-around=32k)
|
||||||
add_custom_command(TARGET ${name} POST_BUILD COMMAND ${CMAKE_SIZE} $<TARGET_FILE:${name}>)
|
add_custom_command(TARGET ${name} POST_BUILD COMMAND ${CMAKE_SIZE} $<TARGET_FILE:${name}>)
|
||||||
add_image_outputs(${name})
|
|
||||||
if(PROJECT_IS_TOP_LEVEL)
|
if(PROJECT_IS_TOP_LEVEL)
|
||||||
add_test(NAME ${name}.size
|
add_test(NAME ${name}.size
|
||||||
COMMAND ${CMAKE_COMMAND} -DSIZE_TOOL=${CMAKE_SIZE} -DELF=$<TARGET_FILE:${name}>
|
COMMAND ${CMAKE_COMMAND} -DSIZE_TOOL=${CMAKE_SIZE} -DELF=$<TARGET_FILE:${name}>
|
||||||
@@ -129,35 +111,52 @@ if(LIBAVR_MCU STREQUAL "atmega328p")
|
|||||||
endif()
|
endif()
|
||||||
|
|
||||||
# pureboot — the pure-constraint port (see pureboot/README.md): one source,
|
# pureboot — the pure-constraint port (see pureboot/README.md): one source,
|
||||||
# no inline assembly, no global register variables, every libavr chip,
|
# no inline assembly, no global register variables, every libavr chip, 512
|
||||||
# fitting each chip's smallest boot sector. The geometry and the
|
# bytes each. The loader owns the top 512 bytes of flash on every chip; the
|
||||||
# pureboot_add_loader() deployment function live in pureboot/CMakeLists.txt —
|
# application entry symbol is address 0 on the mega (reset re-vectors to the
|
||||||
# the unit a downstream project consumes; everything below is this port's
|
# loader through BOOTRST, so word 0 stays the application's own vector) and
|
||||||
# own build: the stock loaders, their tests, and the size matrix. The
|
# the trampoline word just below the loader on the tinies (host-side vector
|
||||||
# distinct binary dir keeps the `pureboot` target's output name free.
|
# surgery points it at the application). --pmem-wrap-around models AVR's
|
||||||
add_subdirectory(pureboot pureboot-cmake)
|
# modulo-flash PC where the flash is big enough to need it.
|
||||||
|
if(LIBAVR_MCU STREQUAL "attiny13a")
|
||||||
|
set(_pb_flash 1024)
|
||||||
|
set(_pb_wrap "")
|
||||||
|
set(_pb_page 32)
|
||||||
|
set(_pb_hz 9600000)
|
||||||
|
set(_pb_baud 57600)
|
||||||
|
set(_pb_eeprom 64)
|
||||||
|
elseif(LIBAVR_MCU STREQUAL "attiny85")
|
||||||
|
set(_pb_flash 8192)
|
||||||
|
set(_pb_wrap -Wl,--pmem-wrap-around=8k)
|
||||||
|
set(_pb_page 64)
|
||||||
|
set(_pb_hz 8000000)
|
||||||
|
set(_pb_baud 57600)
|
||||||
|
set(_pb_eeprom 512)
|
||||||
|
else()
|
||||||
|
set(_pb_flash 32768)
|
||||||
|
set(_pb_wrap -Wl,--pmem-wrap-around=32k)
|
||||||
|
set(_pb_page 128)
|
||||||
|
set(_pb_hz 16000000)
|
||||||
|
set(_pb_baud 115200)
|
||||||
|
set(_pb_eeprom 1024)
|
||||||
|
endif()
|
||||||
|
math(EXPR _pb_base "${_pb_flash} - 512")
|
||||||
|
math(EXPR _pb_base_hex "${_pb_base}" OUTPUT_FORMAT HEXADECIMAL)
|
||||||
|
if(LIBAVR_MCU STREQUAL "atmega328p")
|
||||||
|
set(_pb_app 0)
|
||||||
|
else()
|
||||||
|
math(EXPR _pb_app "${_pb_base} - 2")
|
||||||
|
endif()
|
||||||
|
|
||||||
# The stock loader: the family-default deployment (crystal/RC clock, the
|
add_executable(pureboot pureboot/pureboot.cpp)
|
||||||
# chip's natural link, default pins). The activation window stays a cache
|
target_link_libraries(pureboot PRIVATE libavr)
|
||||||
# variable — re-timing a deployed loader is a self-update with a re-timed
|
target_link_options(pureboot PRIVATE -nostartfiles -Wl,--section-start=.text=${_pb_base_hex}
|
||||||
# build. pureboot9 is that re-timed build, and what the update test installs.
|
-Wl,--defsym=pureboot_app=${_pb_app} ${_pb_wrap})
|
||||||
set(PUREBOOT_TIMEOUT 8 CACHE STRING "pureboot activation window, seconds")
|
add_custom_command(TARGET pureboot POST_BUILD COMMAND ${CMAKE_SIZE} $<TARGET_FILE:pureboot>)
|
||||||
pureboot_add_loader(pureboot TIMEOUT ${PUREBOOT_TIMEOUT})
|
|
||||||
if(PROJECT_IS_TOP_LEVEL)
|
if(PROJECT_IS_TOP_LEVEL)
|
||||||
get_target_property(_pb_stock_hz pureboot PUREBOOT_HZ)
|
|
||||||
get_target_property(_pb_stock_baud pureboot PUREBOOT_BAUD)
|
|
||||||
|
|
||||||
add_test(NAME pureboot.size
|
add_test(NAME pureboot.size
|
||||||
COMMAND ${CMAKE_COMMAND} -DSIZE_TOOL=${CMAKE_SIZE} -DELF=$<TARGET_FILE:pureboot>
|
COMMAND ${CMAKE_COMMAND} -DSIZE_TOOL=${CMAKE_SIZE} -DELF=$<TARGET_FILE:pureboot>
|
||||||
-DLIMIT=${PUREBOOT_LIMIT} -P ${CMAKE_CURRENT_SOURCE_DIR}/test/check_size.cmake)
|
-DLIMIT=512 -P ${CMAKE_CURRENT_SOURCE_DIR}/test/check_size.cmake)
|
||||||
if(Python3_FOUND)
|
|
||||||
add_test(NAME pureboot.pi
|
|
||||||
COMMAND ${Python3_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/test/check_pi.py
|
|
||||||
${CMAKE_OBJDUMP} ${CMAKE_NM} $<TARGET_FILE:pureboot> ${PUREBOOT_BASE_HEX})
|
|
||||||
add_test(NAME pureboot.planner
|
|
||||||
COMMAND ${Python3_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/test/test_planner.py
|
|
||||||
${CMAKE_CURRENT_SOURCE_DIR}/pureboot/pureboot.py)
|
|
||||||
endif()
|
|
||||||
|
|
||||||
# The protocol test flashes this fixture through the loader with the real
|
# The protocol test flashes this fixture through the loader with the real
|
||||||
# host tool and expects its banner after the hand-over; a normally linked
|
# host tool and expects its banner after the hand-over; a normally linked
|
||||||
@@ -169,153 +168,10 @@ if(PROJECT_IS_TOP_LEVEL)
|
|||||||
COMMAND ${CMAKE_OBJCOPY} -O binary $<TARGET_FILE:pbapp> $<TARGET_FILE:pbapp>.bin)
|
COMMAND ${CMAKE_OBJCOPY} -O binary $<TARGET_FILE:pbapp> $<TARGET_FILE:pbapp>.bin)
|
||||||
add_test(NAME pureboot.protocol
|
add_test(NAME pureboot.protocol
|
||||||
COMMAND ${Python3_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/test/pbtest.py
|
COMMAND ${Python3_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/test/pbtest.py
|
||||||
${PB_DEVICE} $<TARGET_FILE:pureboot> ${PUREBOOT_SIM_MCU} ${_pb_stock_hz}
|
${PB_DEVICE} $<TARGET_FILE:pureboot> ${LIBAVR_MCU} ${_pb_hz} ${_pb_base_hex}
|
||||||
${PUREBOOT_BASE_HEX} ${PUREBOOT_PAGE} ${_pb_stock_baud} ${PUREBOOT_EEPROM}
|
${_pb_page} ${_pb_baud} ${_pb_eeprom} $<TARGET_FILE:pbapp>.bin
|
||||||
$<TARGET_FILE:pbapp>.bin ${CMAKE_CURRENT_SOURCE_DIR}/pureboot/pureboot.py
|
${CMAKE_CURRENT_SOURCE_DIR}/pureboot/pureboot.py
|
||||||
${CMAKE_BINARY_DIR}/pbtest-work)
|
${CMAKE_BINARY_DIR}/pbtest-work)
|
||||||
set_tests_properties(pureboot.protocol PROPERTIES TIMEOUT 180)
|
set_tests_properties(pureboot.protocol PROPERTIES TIMEOUT 180)
|
||||||
|
|
||||||
# The position-independence acceptance test: the identical image,
|
|
||||||
# installed one slot lower, must serve the full command set.
|
|
||||||
add_test(NAME pureboot.reloc
|
|
||||||
COMMAND ${Python3_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/test/pbreloc.py
|
|
||||||
${PB_DEVICE} $<TARGET_FILE:pureboot> ${PUREBOOT_SIM_MCU} ${_pb_stock_hz}
|
|
||||||
${PUREBOOT_BASE_HEX} ${PUREBOOT_PAGE} ${_pb_stock_baud}
|
|
||||||
${CMAKE_CURRENT_SOURCE_DIR}/pureboot/pureboot.py
|
|
||||||
${CMAKE_BINARY_DIR}/pbreloc-work)
|
|
||||||
set_tests_properties(pureboot.reloc PROPERTIES TIMEOUT 180
|
|
||||||
ENVIRONMENT "PB_OBJCOPY=${CMAKE_OBJCOPY}")
|
|
||||||
|
|
||||||
# Entering the loader from a running application with no reset
|
|
||||||
# between, over a page buffer the application dirtied — the case the
|
|
||||||
# loader declines to guard and the host repairs. Hardware forbids the
|
|
||||||
# state here (SPM runs only from the boot section); simavr does not,
|
|
||||||
# which is what makes it constructible.
|
|
||||||
if(LIBAVR_MCU STREQUAL "atmega328p")
|
|
||||||
add_test(NAME pureboot.dirty
|
|
||||||
COMMAND ${Python3_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/test/pbdirty.py
|
|
||||||
${PB_DEVICE} $<TARGET_FILE:pureboot> ${PUREBOOT_SIM_MCU} ${_pb_stock_hz}
|
|
||||||
${PUREBOOT_BASE_HEX} ${PUREBOOT_PAGE} ${_pb_stock_baud}
|
|
||||||
$<TARGET_FILE:pbapp>.bin
|
|
||||||
${CMAKE_CURRENT_SOURCE_DIR}/pureboot/pureboot.py
|
|
||||||
${CMAKE_BINARY_DIR}/pbdirty-work)
|
|
||||||
set_tests_properties(pureboot.dirty PROPERTIES TIMEOUT 180)
|
|
||||||
endif()
|
|
||||||
|
|
||||||
# Re-homing: a loader mistakenly programmed at address 0 (a raw .bin
|
|
||||||
# handed to a programmer) or sitting in the staging slot must heal
|
|
||||||
# into the canonical slot through the ordinary --update-loader flow.
|
|
||||||
# Patched-vector behavior, so one representative chip carries it.
|
|
||||||
if(LIBAVR_MCU STREQUAL "attiny85")
|
|
||||||
add_test(NAME pureboot.rehome
|
|
||||||
COMMAND ${Python3_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/test/pbrehome.py
|
|
||||||
${PB_DEVICE} $<TARGET_FILE:pureboot> $<TARGET_FILE:pureboot9>.bin
|
|
||||||
${PUREBOOT_SIM_MCU} ${_pb_stock_hz} ${PUREBOOT_BASE_HEX} ${PUREBOOT_PAGE}
|
|
||||||
${_pb_stock_baud} $<TARGET_FILE:pbapp>.bin
|
|
||||||
${CMAKE_CURRENT_SOURCE_DIR}/pureboot/pureboot.py
|
|
||||||
${CMAKE_BINARY_DIR}/pbrehome-work)
|
|
||||||
set_tests_properties(pureboot.rehome PROPERTIES TIMEOUT 180)
|
|
||||||
endif()
|
|
||||||
|
|
||||||
# The self-update end-to-end: the re-timed build (same source, only
|
|
||||||
# the timeout differs — a byte-different image) replaces the resident
|
|
||||||
# through --update-loader, with every power-fail phase rehearsed from
|
|
||||||
# the runner's flash dumps.
|
|
||||||
pureboot_add_loader(pureboot9 TIMEOUT 9)
|
|
||||||
add_test(NAME pureboot.update
|
|
||||||
COMMAND ${Python3_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/test/pbupdate.py
|
|
||||||
${PB_DEVICE} $<TARGET_FILE:pureboot> $<TARGET_FILE:pureboot9>
|
|
||||||
${PUREBOOT_SIM_MCU} ${_pb_stock_hz} ${PUREBOOT_BASE_HEX} ${PUREBOOT_PAGE}
|
|
||||||
${_pb_stock_baud} $<TARGET_FILE:pbapp>.bin
|
|
||||||
${CMAKE_CURRENT_SOURCE_DIR}/pureboot/pureboot.py
|
|
||||||
${CMAKE_BINARY_DIR}/pbupdate-work)
|
|
||||||
set_tests_properties(pureboot.update PROPERTIES TIMEOUT 600
|
|
||||||
ENVIRONMENT "PB_OBJCOPY=${CMAKE_OBJCOPY}")
|
|
||||||
endif()
|
|
||||||
|
|
||||||
# The size matrix: every configuration axis that could move the image
|
|
||||||
# size — the serial backend (different code), the clock and its ladder
|
|
||||||
# baud (different constants and divisor shapes), the USART instance
|
|
||||||
# (different register class) — each combination must still fit the
|
|
||||||
# chip's slot budget. Pins are size-neutral (port and bit are immediate
|
|
||||||
# operands) and the timeout is a constant, so neither adds an axis. The
|
|
||||||
# stock build is one point of this matrix and already has its test.
|
|
||||||
function(pureboot_size_variant name)
|
|
||||||
pureboot_add_loader(${name} ${ARGN})
|
|
||||||
add_test(NAME ${name}.size
|
|
||||||
COMMAND ${CMAKE_COMMAND} -DSIZE_TOOL=${CMAKE_SIZE} -DELF=$<TARGET_FILE:${name}>
|
|
||||||
-DLIMIT=${PUREBOOT_LIMIT} -P ${CMAKE_CURRENT_SOURCE_DIR}/test/check_size.cmake)
|
|
||||||
endfunction()
|
|
||||||
|
|
||||||
# Clock points: the shipped-fuse floor (CKDIV8), the calibrated RC, and
|
|
||||||
# the crystal the stock build assumes (the tiny13's ladder is its own RC
|
|
||||||
# menu — it has no crystal option).
|
|
||||||
if(LIBAVR_MCU MATCHES "^attiny13")
|
|
||||||
set(_matrix_clocks 1200000 4800000 9600000)
|
|
||||||
else()
|
|
||||||
set(_matrix_clocks 1000000 8000000 16000000)
|
|
||||||
endif()
|
|
||||||
foreach(_matrix_hz IN LISTS _matrix_clocks)
|
|
||||||
math(EXPR _matrix_khz "${_matrix_hz} / 1000")
|
|
||||||
if(PUREBOOT_HAS_USART OR NOT _matrix_hz EQUAL _pb_stock_hz)
|
|
||||||
pureboot_size_variant(pureboot_sw_${_matrix_khz}k CLOCK ${_matrix_hz} SERIAL software)
|
|
||||||
endif()
|
|
||||||
if(PUREBOOT_HAS_USART AND NOT _matrix_hz EQUAL _pb_stock_hz)
|
|
||||||
pureboot_size_variant(pureboot_hw_${_matrix_khz}k CLOCK ${_matrix_hz} SERIAL hardware)
|
|
||||||
endif()
|
|
||||||
endforeach()
|
|
||||||
if(PUREBOOT_HAS_USART1)
|
|
||||||
pureboot_size_variant(pureboot_usart1 USART 1)
|
|
||||||
endif()
|
|
||||||
|
|
||||||
# One configured deployment end to end — a real board's shape rather
|
|
||||||
# than the stock assumption: the ATmega328P on its shipped 1 MHz fuses,
|
|
||||||
# the software UART on hand-picked pins (TX = PB1, RX = PB5), the ladder
|
|
||||||
# baud (9600). The full protocol suite runs against it, fixture
|
|
||||||
# application included, over the runner's GPIO bridge — proving the
|
|
||||||
# configuration plumbing produces a working loader, not just one that
|
|
||||||
# fits.
|
|
||||||
if(LIBAVR_MCU STREQUAL "atmega328p" AND DEFINED PB_DEVICE)
|
|
||||||
pureboot_size_variant(pureboot_custom CLOCK 1000000 SERIAL software RX pb5 TX pb1)
|
|
||||||
get_target_property(_custom_hz pureboot_custom PUREBOOT_HZ)
|
|
||||||
get_target_property(_custom_baud pureboot_custom PUREBOOT_BAUD)
|
|
||||||
get_target_property(_custom_link pureboot_custom PUREBOOT_LINK)
|
|
||||||
add_executable(pbapp_custom test/pbapp.cpp)
|
|
||||||
target_link_libraries(pbapp_custom PRIVATE libavr)
|
|
||||||
target_compile_definitions(pbapp_custom PRIVATE PUREBOOT_CLOCK_HZ=${_custom_hz}
|
|
||||||
PUREBOOT_BAUD=${_custom_baud} PUREBOOT_SOFT_SERIAL PUREBOOT_TX=pb1)
|
|
||||||
add_custom_command(TARGET pbapp_custom POST_BUILD
|
|
||||||
COMMAND ${CMAKE_OBJCOPY} -O binary
|
|
||||||
$<TARGET_FILE:pbapp_custom> $<TARGET_FILE:pbapp_custom>.bin)
|
|
||||||
add_test(NAME pureboot.custom
|
|
||||||
COMMAND ${Python3_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/test/pbtest.py
|
|
||||||
${PB_DEVICE} $<TARGET_FILE:pureboot_custom> ${PUREBOOT_SIM_MCU} ${_custom_hz}
|
|
||||||
${PUREBOOT_BASE_HEX} ${PUREBOOT_PAGE} ${_custom_baud} ${PUREBOOT_EEPROM}
|
|
||||||
$<TARGET_FILE:pbapp_custom>.bin ${CMAKE_CURRENT_SOURCE_DIR}/pureboot/pureboot.py
|
|
||||||
${CMAKE_BINARY_DIR}/pbcustom-work ${_custom_link})
|
|
||||||
set_tests_properties(pureboot.custom PROPERTIES TIMEOUT 180)
|
|
||||||
endif()
|
|
||||||
|
|
||||||
# The second USART, driven for real on one chip: instance selection is
|
|
||||||
# compile-checked everywhere, but only a live session proves the loader
|
|
||||||
# initialized and polls the USART it claims to. The fixture application
|
|
||||||
# banners on the same instance.
|
|
||||||
if(LIBAVR_MCU STREQUAL "atmega644a" AND DEFINED PB_DEVICE)
|
|
||||||
get_target_property(_usart1_hz pureboot_usart1 PUREBOOT_HZ)
|
|
||||||
get_target_property(_usart1_baud pureboot_usart1 PUREBOOT_BAUD)
|
|
||||||
add_executable(pbapp_usart1 test/pbapp.cpp)
|
|
||||||
target_link_libraries(pbapp_usart1 PRIVATE libavr)
|
|
||||||
target_compile_definitions(pbapp_usart1 PRIVATE PUREBOOT_CLOCK_HZ=${_usart1_hz}
|
|
||||||
PUREBOOT_BAUD=${_usart1_baud} PUREBOOT_USART=1)
|
|
||||||
add_custom_command(TARGET pbapp_usart1 POST_BUILD
|
|
||||||
COMMAND ${CMAKE_OBJCOPY} -O binary
|
|
||||||
$<TARGET_FILE:pbapp_usart1> $<TARGET_FILE:pbapp_usart1>.bin)
|
|
||||||
add_test(NAME pureboot.usart1
|
|
||||||
COMMAND ${Python3_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/test/pbtest.py
|
|
||||||
${PB_DEVICE} $<TARGET_FILE:pureboot_usart1> ${PUREBOOT_SIM_MCU} ${_usart1_hz}
|
|
||||||
${PUREBOOT_BASE_HEX} ${PUREBOOT_PAGE} ${_usart1_baud} ${PUREBOOT_EEPROM}
|
|
||||||
$<TARGET_FILE:pbapp_usart1>.bin ${CMAKE_CURRENT_SOURCE_DIR}/pureboot/pureboot.py
|
|
||||||
${CMAKE_BINARY_DIR}/pbusart1-work usart1)
|
|
||||||
set_tests_properties(pureboot.usart1 PROPERTIES TIMEOUT 180)
|
|
||||||
endif()
|
endif()
|
||||||
endif()
|
endif()
|
||||||
|
|||||||
1641
CMakePresets.json
1641
CMakePresets.json
File diff suppressed because it is too large
Load Diff
1
libavr
1
libavr
Submodule libavr deleted from e81dad0131
@@ -1,319 +0,0 @@
|
|||||||
# pureboot as a consumable CMake unit: the per-chip geometry, the default
|
|
||||||
# baud ladder, and pureboot_add_loader() — the one way a loader target is
|
|
||||||
# created, both by this port's own build and by a downstream project. A
|
|
||||||
# downstream project brings its usual libavr setup (the `libavr` target and
|
|
||||||
# the LIBAVR_MCU toolchain preset), adds this directory, and states its
|
|
||||||
# deployment:
|
|
||||||
#
|
|
||||||
# add_subdirectory(bootloader/pureboot)
|
|
||||||
# pureboot_add_loader(myboot CLOCK 1000000 SERIAL software TX pb1 RX pb5)
|
|
||||||
#
|
|
||||||
# Every argument is optional — CLOCK defaults to the family assumption
|
|
||||||
# below, BAUD to the fastest standard rate the clock reaches within 2.5 %
|
|
||||||
# (the ladder), SERIAL to the chip's hardware USART where it has one
|
|
||||||
# (`hardware`/`software` force a backend, USART 1 picks the second
|
|
||||||
# instance), RX/TX to pb0/pb1 for the software UART, TIMEOUT to 8 s.
|
|
||||||
# Infeasible picks fail the build by name: libavr's baud-error and
|
|
||||||
# software-UART cycle-floor static asserts re-check whatever is passed.
|
|
||||||
|
|
||||||
# Per-family geometry: flash/page/EEPROM sizes and the linker wrap the PC
|
|
||||||
# modulo needs, the loader slot (each chip's smallest boot sector — 1 KiB on
|
|
||||||
# the word-addressed 1284s), and the deployment defaults (crystal assumption
|
|
||||||
# on the megas, calibrated RC on the tinies). The USART flags mirror the
|
|
||||||
# hardware inventory the loader's own static asserts check (the plain 644 is
|
|
||||||
# the x4 family's one single-USART die, Atmel-2593).
|
|
||||||
set(_pb_has_usart 1)
|
|
||||||
set(_pb_has_usart1 0)
|
|
||||||
if(LIBAVR_MCU MATCHES "^attiny13a?$")
|
|
||||||
set(_pb_flash 1024)
|
|
||||||
set(_pb_wrap "")
|
|
||||||
set(_pb_page 32)
|
|
||||||
set(_pb_hz 9600000)
|
|
||||||
set(_pb_eeprom 64)
|
|
||||||
set(_pb_has_usart 0)
|
|
||||||
elseif(LIBAVR_MCU STREQUAL "attiny25")
|
|
||||||
set(_pb_flash 2048)
|
|
||||||
set(_pb_wrap "")
|
|
||||||
set(_pb_page 32)
|
|
||||||
set(_pb_hz 8000000)
|
|
||||||
set(_pb_eeprom 128)
|
|
||||||
set(_pb_has_usart 0)
|
|
||||||
elseif(LIBAVR_MCU STREQUAL "attiny45")
|
|
||||||
set(_pb_flash 4096)
|
|
||||||
set(_pb_wrap "")
|
|
||||||
set(_pb_page 64)
|
|
||||||
set(_pb_hz 8000000)
|
|
||||||
set(_pb_eeprom 256)
|
|
||||||
set(_pb_has_usart 0)
|
|
||||||
elseif(LIBAVR_MCU STREQUAL "attiny85")
|
|
||||||
set(_pb_flash 8192)
|
|
||||||
set(_pb_wrap -Wl,--pmem-wrap-around=8k)
|
|
||||||
set(_pb_page 64)
|
|
||||||
set(_pb_hz 8000000)
|
|
||||||
set(_pb_eeprom 512)
|
|
||||||
set(_pb_has_usart 0)
|
|
||||||
elseif(LIBAVR_MCU MATCHES "^atmega48(a|p|pa)?$")
|
|
||||||
set(_pb_flash 4096)
|
|
||||||
set(_pb_wrap "")
|
|
||||||
set(_pb_page 64)
|
|
||||||
set(_pb_hz 16000000)
|
|
||||||
set(_pb_eeprom 256)
|
|
||||||
elseif(LIBAVR_MCU MATCHES "^atmega8a?$" OR LIBAVR_MCU MATCHES "^atmega88(a|p|pa)?$")
|
|
||||||
set(_pb_flash 8192)
|
|
||||||
set(_pb_wrap -Wl,--pmem-wrap-around=8k)
|
|
||||||
set(_pb_page 64)
|
|
||||||
set(_pb_hz 16000000)
|
|
||||||
set(_pb_eeprom 512)
|
|
||||||
elseif(LIBAVR_MCU MATCHES "^atmega16a?$" OR LIBAVR_MCU MATCHES "^atmega168(a|p|pa)?$")
|
|
||||||
set(_pb_flash 16384)
|
|
||||||
set(_pb_wrap -Wl,--pmem-wrap-around=16k)
|
|
||||||
set(_pb_page 128)
|
|
||||||
set(_pb_hz 16000000)
|
|
||||||
set(_pb_eeprom 512)
|
|
||||||
elseif(LIBAVR_MCU MATCHES "^atmega164(a|p|pa)$")
|
|
||||||
set(_pb_flash 16384)
|
|
||||||
set(_pb_wrap -Wl,--pmem-wrap-around=16k)
|
|
||||||
set(_pb_page 128)
|
|
||||||
set(_pb_hz 16000000)
|
|
||||||
set(_pb_eeprom 512)
|
|
||||||
set(_pb_has_usart1 1)
|
|
||||||
elseif(LIBAVR_MCU MATCHES "^atmega32a?$" OR LIBAVR_MCU MATCHES "^atmega328p?$")
|
|
||||||
set(_pb_flash 32768)
|
|
||||||
set(_pb_wrap -Wl,--pmem-wrap-around=32k)
|
|
||||||
set(_pb_page 128)
|
|
||||||
set(_pb_hz 16000000)
|
|
||||||
set(_pb_eeprom 1024)
|
|
||||||
elseif(LIBAVR_MCU MATCHES "^atmega324(a|p|pa)$")
|
|
||||||
set(_pb_flash 32768)
|
|
||||||
set(_pb_wrap -Wl,--pmem-wrap-around=32k)
|
|
||||||
set(_pb_page 128)
|
|
||||||
set(_pb_hz 16000000)
|
|
||||||
set(_pb_eeprom 1024)
|
|
||||||
set(_pb_has_usart1 1)
|
|
||||||
elseif(LIBAVR_MCU MATCHES "^atmega644(a|p|pa)?$")
|
|
||||||
# 64 KiB is exactly the 16-bit byte space: plain LPM reaches everything,
|
|
||||||
# and the smallest boot section (1 KiB) holds the loader and its staging
|
|
||||||
# slot together (see README.md). The plain 644 is the family's one
|
|
||||||
# single-USART die.
|
|
||||||
set(_pb_flash 65536)
|
|
||||||
set(_pb_wrap -Wl,--pmem-wrap-around=64k)
|
|
||||||
set(_pb_page 256)
|
|
||||||
set(_pb_hz 16000000)
|
|
||||||
set(_pb_eeprom 2048)
|
|
||||||
if(NOT LIBAVR_MCU STREQUAL "atmega644")
|
|
||||||
set(_pb_has_usart1 1)
|
|
||||||
endif()
|
|
||||||
elseif(LIBAVR_MCU MATCHES "^atmega1284p?$")
|
|
||||||
# 128 KiB: wire flash addresses are word addresses, reads go through
|
|
||||||
# ELPM, and the PC's modulo wrap exceeds what --pmem-wrap-around models.
|
|
||||||
# The slot is 1 KiB — this chip's own smallest boot sector; the far
|
|
||||||
# machinery cannot fit 512 B (see README.md).
|
|
||||||
set(_pb_flash 131072)
|
|
||||||
set(_pb_wrap "")
|
|
||||||
set(_pb_page 256)
|
|
||||||
set(_pb_hz 16000000)
|
|
||||||
set(_pb_eeprom 4096)
|
|
||||||
set(_pb_slot 1024)
|
|
||||||
set(_pb_limit 1024)
|
|
||||||
set(_pb_has_usart1 1)
|
|
||||||
else()
|
|
||||||
message(FATAL_ERROR "pureboot: no geometry for ${LIBAVR_MCU}")
|
|
||||||
endif()
|
|
||||||
if(NOT DEFINED _pb_slot)
|
|
||||||
set(_pb_slot 512)
|
|
||||||
endif()
|
|
||||||
math(EXPR _pb_base "${_pb_flash} - ${_pb_slot}")
|
|
||||||
math(EXPR _pb_base_hex "${_pb_base}" OUTPUT_FORMAT HEXADECIMAL)
|
|
||||||
# Patched-vector chips hand over through the trampoline word below the slot,
|
|
||||||
# which is also the slot's own last word — their budget is slot − 2.
|
|
||||||
if(LIBAVR_MCU MATCHES "^atmega" AND NOT LIBAVR_MCU MATCHES "^atmega48")
|
|
||||||
set(_pb_app 0)
|
|
||||||
if(NOT DEFINED _pb_limit)
|
|
||||||
set(_pb_limit ${_pb_slot})
|
|
||||||
endif()
|
|
||||||
else()
|
|
||||||
math(EXPR _pb_app "${_pb_base} - 2")
|
|
||||||
math(EXPR _pb_limit "${_pb_slot} - 2")
|
|
||||||
endif()
|
|
||||||
|
|
||||||
# simavr names its cores after the base dies; the A revisions run on them
|
|
||||||
# (the 644PA on the 644P core).
|
|
||||||
set(_pb_sim_mcu ${LIBAVR_MCU})
|
|
||||||
if(LIBAVR_MCU MATCHES "^atmega(8|16|32|48|88|164|168|644)a$")
|
|
||||||
string(REGEX REPLACE "a$" "" _pb_sim_mcu ${LIBAVR_MCU})
|
|
||||||
elseif(LIBAVR_MCU STREQUAL "atmega644pa")
|
|
||||||
set(_pb_sim_mcu atmega644p)
|
|
||||||
endif()
|
|
||||||
|
|
||||||
# The function runs in its caller's scope, so everything it needs crosses
|
|
||||||
# scopes as global properties.
|
|
||||||
set_property(GLOBAL PROPERTY PUREBOOT_BASE_HEX ${_pb_base_hex})
|
|
||||||
set_property(GLOBAL PROPERTY PUREBOOT_APP ${_pb_app})
|
|
||||||
set_property(GLOBAL PROPERTY PUREBOOT_WRAP "${_pb_wrap}")
|
|
||||||
set_property(GLOBAL PROPERTY PUREBOOT_DEFAULT_HZ ${_pb_hz})
|
|
||||||
set_property(GLOBAL PROPERTY PUREBOOT_HAS_USART ${_pb_has_usart})
|
|
||||||
set_property(GLOBAL PROPERTY PUREBOOT_HAS_USART1 ${_pb_has_usart1})
|
|
||||||
|
|
||||||
# The port's own build (tests, the size matrix) reads the geometry from the
|
|
||||||
# parent scope; a downstream consumer gets the same variables for free.
|
|
||||||
set(PUREBOOT_BASE_HEX ${_pb_base_hex} PARENT_SCOPE)
|
|
||||||
set(PUREBOOT_PAGE ${_pb_page} PARENT_SCOPE)
|
|
||||||
set(PUREBOOT_SLOT ${_pb_slot} PARENT_SCOPE)
|
|
||||||
set(PUREBOOT_LIMIT ${_pb_limit} PARENT_SCOPE)
|
|
||||||
set(PUREBOOT_EEPROM ${_pb_eeprom} PARENT_SCOPE)
|
|
||||||
set(PUREBOOT_DEFAULT_HZ ${_pb_hz} PARENT_SCOPE)
|
|
||||||
set(PUREBOOT_HAS_USART ${_pb_has_usart} PARENT_SCOPE)
|
|
||||||
set(PUREBOOT_HAS_USART1 ${_pb_has_usart1} PARENT_SCOPE)
|
|
||||||
set(PUREBOOT_SIM_MCU ${_pb_sim_mcu} PARENT_SCOPE)
|
|
||||||
|
|
||||||
# The fastest standard rate the clock reaches within 2.5 % — the same
|
|
||||||
# best-of-U2X-and-plain divisor search libavr's solve_baud runs, so a
|
|
||||||
# default never trips the compile-time error it is checked against. A
|
|
||||||
# software build additionally requires the polled receiver's 100-cycles-a-bit
|
|
||||||
# floor (its own static assert): at low clocks the U2X divisor still reaches
|
|
||||||
# rates the bit-banged sampler cannot, so the backend gates the ladder.
|
|
||||||
function(pureboot_default_baud clock software outvar)
|
|
||||||
foreach(baud 115200 57600 38400 19200 9600)
|
|
||||||
math(EXPR _cycles "${clock} / ${baud}")
|
|
||||||
if(software AND _cycles LESS 100)
|
|
||||||
continue()
|
|
||||||
endif()
|
|
||||||
foreach(divisor 8 16)
|
|
||||||
math(EXPR _step "${divisor} * ${baud}")
|
|
||||||
math(EXPR _n "(${clock} + ${_step} / 2) / ${_step}")
|
|
||||||
if(_n LESS 1 OR _n GREATER 4096)
|
|
||||||
continue()
|
|
||||||
endif()
|
|
||||||
math(EXPR _actual "${clock} / (${divisor} * ${_n})")
|
|
||||||
math(EXPR _delta "${_actual} - ${baud}")
|
|
||||||
if(_delta LESS 0)
|
|
||||||
math(EXPR _delta "-(${_delta})")
|
|
||||||
endif()
|
|
||||||
math(EXPR _error_bp "${_delta} * 10000 / ${baud}")
|
|
||||||
if(_error_bp LESS_EQUAL 250)
|
|
||||||
set(${outvar} ${baud} PARENT_SCOPE)
|
|
||||||
return()
|
|
||||||
endif()
|
|
||||||
endforeach()
|
|
||||||
endforeach()
|
|
||||||
message(FATAL_ERROR "pureboot: no standard baud rate fits a ${clock} Hz clock within 2.5 %")
|
|
||||||
endfunction()
|
|
||||||
|
|
||||||
# pureboot_add_loader(<name> [CLOCK <hz>] [BAUD <bd>]
|
|
||||||
# [SERIAL auto|hardware|software] [USART <n>]
|
|
||||||
# [RX <pin>] [TX <pin>] [TIMEOUT <s>])
|
|
||||||
#
|
|
||||||
# Creates the loader target plus its flashable images (<name>.hex for a
|
|
||||||
# programmer, <name>.bin for --update-loader) and stamps the resolved
|
|
||||||
# deployment on the target: the PUREBOOT_HZ, PUREBOOT_BAUD and PUREBOOT_LINK
|
|
||||||
# properties (the link as usart0/usart1/sw:<RX>,<TX> — what a test harness
|
|
||||||
# needs to speak to the build).
|
|
||||||
function(pureboot_add_loader name)
|
|
||||||
cmake_parse_arguments(PB "" "CLOCK;BAUD;SERIAL;USART;RX;TX;TIMEOUT" "" ${ARGN})
|
|
||||||
if(PB_UNPARSED_ARGUMENTS)
|
|
||||||
message(FATAL_ERROR "pureboot_add_loader(${name}): unknown arguments ${PB_UNPARSED_ARGUMENTS}")
|
|
||||||
endif()
|
|
||||||
get_property(_hz GLOBAL PROPERTY PUREBOOT_DEFAULT_HZ)
|
|
||||||
get_property(_base_hex GLOBAL PROPERTY PUREBOOT_BASE_HEX)
|
|
||||||
get_property(_app GLOBAL PROPERTY PUREBOOT_APP)
|
|
||||||
get_property(_wrap GLOBAL PROPERTY PUREBOOT_WRAP)
|
|
||||||
get_property(_usart GLOBAL PROPERTY PUREBOOT_HAS_USART)
|
|
||||||
get_property(_usart1 GLOBAL PROPERTY PUREBOOT_HAS_USART1)
|
|
||||||
|
|
||||||
if(NOT PB_CLOCK)
|
|
||||||
set(PB_CLOCK ${_hz})
|
|
||||||
endif()
|
|
||||||
if(NOT PB_TIMEOUT)
|
|
||||||
set(PB_TIMEOUT 8)
|
|
||||||
endif()
|
|
||||||
if(NOT PB_SERIAL)
|
|
||||||
set(PB_SERIAL auto)
|
|
||||||
endif()
|
|
||||||
if(DEFINED PB_USART AND PB_SERIAL STREQUAL "software")
|
|
||||||
message(FATAL_ERROR "pureboot_add_loader(${name}): USART ${PB_USART} contradicts SERIAL software")
|
|
||||||
endif()
|
|
||||||
if(DEFINED PB_USART)
|
|
||||||
set(PB_SERIAL hardware)
|
|
||||||
elseif(PB_SERIAL STREQUAL "hardware")
|
|
||||||
set(PB_USART 0)
|
|
||||||
endif()
|
|
||||||
|
|
||||||
set(_serial_defines "")
|
|
||||||
if(PB_SERIAL STREQUAL "hardware")
|
|
||||||
if(PB_USART EQUAL 1 AND NOT _usart1)
|
|
||||||
message(FATAL_ERROR "pureboot_add_loader(${name}): ${LIBAVR_MCU} has no USART1")
|
|
||||||
elseif(NOT _usart)
|
|
||||||
message(FATAL_ERROR "pureboot_add_loader(${name}): ${LIBAVR_MCU} has no hardware USART")
|
|
||||||
endif()
|
|
||||||
set(_serial_defines PUREBOOT_USART=${PB_USART})
|
|
||||||
set(_link usart${PB_USART})
|
|
||||||
else()
|
|
||||||
if(PB_SERIAL STREQUAL "auto")
|
|
||||||
if(_usart AND (PB_RX OR PB_TX))
|
|
||||||
message(WARNING "pureboot_add_loader(${name}): RX/TX apply to the software UART, "
|
|
||||||
"which auto does not pick on ${LIBAVR_MCU} — SERIAL software to force it")
|
|
||||||
endif()
|
|
||||||
if(_usart)
|
|
||||||
set(_link usart0)
|
|
||||||
else()
|
|
||||||
set(PB_SERIAL software)
|
|
||||||
endif()
|
|
||||||
endif()
|
|
||||||
if(PB_SERIAL STREQUAL "software")
|
|
||||||
if(NOT PB_RX)
|
|
||||||
set(PB_RX pb0)
|
|
||||||
endif()
|
|
||||||
if(NOT PB_TX)
|
|
||||||
set(PB_TX pb1)
|
|
||||||
endif()
|
|
||||||
foreach(_pin ${PB_RX} ${PB_TX})
|
|
||||||
if(NOT _pin MATCHES "^p[a-h][0-7]$")
|
|
||||||
message(FATAL_ERROR "pureboot_add_loader(${name}): pin '${_pin}' is not of the form pb1")
|
|
||||||
endif()
|
|
||||||
endforeach()
|
|
||||||
set(_serial_defines PUREBOOT_SOFT_SERIAL PUREBOOT_RX=${PB_RX} PUREBOOT_TX=${PB_TX})
|
|
||||||
# The link spec a test harness drives a GPIO bridge with: sw:<RX>,<TX>
|
|
||||||
# as the port letter and bit, the loader's own pin naming upcased.
|
|
||||||
string(SUBSTRING ${PB_RX} 1 2 _rx_pin)
|
|
||||||
string(SUBSTRING ${PB_TX} 1 2 _tx_pin)
|
|
||||||
string(TOUPPER "sw:${_rx_pin},${_tx_pin}" _link)
|
|
||||||
string(REPLACE "SW" "sw" _link ${_link})
|
|
||||||
endif()
|
|
||||||
endif()
|
|
||||||
if(NOT PB_BAUD)
|
|
||||||
if(PB_SERIAL STREQUAL "software")
|
|
||||||
pureboot_default_baud(${PB_CLOCK} 1 PB_BAUD)
|
|
||||||
else()
|
|
||||||
pureboot_default_baud(${PB_CLOCK} 0 PB_BAUD)
|
|
||||||
endif()
|
|
||||||
endif()
|
|
||||||
|
|
||||||
set(_defines PUREBOOT_CLOCK_HZ=${PB_CLOCK} PUREBOOT_BAUD=${PB_BAUD} PUREBOOT_TIMEOUT=${PB_TIMEOUT}
|
|
||||||
${_serial_defines})
|
|
||||||
|
|
||||||
add_executable(${name} ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/pureboot.cpp)
|
|
||||||
target_link_libraries(${name} PRIVATE libavr)
|
|
||||||
target_compile_definitions(${name} PRIVATE ${_defines})
|
|
||||||
# Codegen shaping for the loader TU only, worth ~40 B on every chip and
|
|
||||||
# what carries the far-flash 1284 build under 512. At -Os GCC otherwise
|
|
||||||
# rewrites the byte-stream loops' counters into end-pointer forms that
|
|
||||||
# cost registers (-fno-ivopts, -fno-split-wide-types), leaves register
|
|
||||||
# pressure on the table with the default allocator
|
|
||||||
# (-fira-algorithm=priority), and spends bytes on rewrites a
|
|
||||||
# straight-line loader gains nothing from.
|
|
||||||
target_compile_options(${name} PRIVATE
|
|
||||||
-fno-ivopts -fira-algorithm=priority -fno-expensive-optimizations -fno-split-wide-types)
|
|
||||||
target_link_options(${name} PRIVATE -nostartfiles -Wl,--section-start=.text=${_base_hex}
|
|
||||||
-Wl,--defsym=pureboot_app=${_app} ${_wrap})
|
|
||||||
add_custom_command(TARGET ${name} POST_BUILD COMMAND ${CMAKE_SIZE} $<TARGET_FILE:${name}>)
|
|
||||||
# The ELF is a container (symbols, section headers), never flashed; the
|
|
||||||
# flashable forms sit beside it: .hex for a programmer, .bin (the slot's
|
|
||||||
# bare bytes) for the host tool's raw path and --update-loader.
|
|
||||||
add_custom_command(TARGET ${name} POST_BUILD
|
|
||||||
COMMAND ${CMAKE_OBJCOPY} -O ihex -R .eeprom
|
|
||||||
$<TARGET_FILE:${name}> $<TARGET_FILE:${name}>.hex
|
|
||||||
COMMAND ${CMAKE_OBJCOPY} -O binary -R .eeprom
|
|
||||||
$<TARGET_FILE:${name}> $<TARGET_FILE:${name}>.bin)
|
|
||||||
set_target_properties(${name} PROPERTIES PUREBOOT_HZ ${PB_CLOCK} PUREBOOT_BAUD ${PB_BAUD}
|
|
||||||
PUREBOOT_LINK ${_link})
|
|
||||||
endfunction()
|
|
||||||
@@ -2,129 +2,47 @@
|
|||||||
|
|
||||||
A serial bootloader on [libavr](https://git.blackmark.me/avr/libavr), pure by
|
A serial bootloader on [libavr](https://git.blackmark.me/avr/libavr), pure by
|
||||||
constraint: one C++ source, no inline assembly, no global register variables
|
constraint: one C++ source, no inline assembly, no global register variables
|
||||||
(attributes and compiler flags allowed), built for **every chip libavr
|
(attributes allowed), built for every chip libavr targets, **512 bytes on
|
||||||
targets — all 37 — in 512 bytes each**: 434 B on the tiny13s, 438–442 B on
|
each** — 490 B on the ATtiny13A, 510 B on the ATtiny85, 484 B on the
|
||||||
the tiny25/45/85, 412–452 B across the megas, and 506 B on the
|
ATmega328P. The device speaks primitives; every composite — verify, erase,
|
||||||
ATmega1284/1284P, whose far-flash machinery (ELPM reads, RAMPZ page commands,
|
reset-vector surgery, timeout configuration — lives in the host tool
|
||||||
word-addressed wire) is the heaviest. Those are the stock deployments;
|
(`pureboot.py`).
|
||||||
choosing the software UART where the chip has a USART costs 8–46 B more (a
|
|
||||||
bit-bang against a peripheral), which every chip still absorbs inside its
|
|
||||||
slot — on the 1284s that means their 1 KiB boot sector, where the
|
|
||||||
software-serial image lands at 546 B. Bringing the 1284's default build
|
|
||||||
under 512 at all is what the loop-placement attributes on the byte streamers
|
|
||||||
(`pureboot.cpp`) and the codegen flags on the loader TU (`CMakeLists.txt`)
|
|
||||||
are for; measured against each chip's own budget the tightest is the
|
|
||||||
ATmega328P, 50 B spare. Clock, baud, serial backend and
|
|
||||||
pins are per-build configuration (below); the size matrix in the test suite
|
|
||||||
holds every combination inside its slot. The device speaks primitives; every
|
|
||||||
composite — verify, erase, reset-vector surgery, updating the loader itself —
|
|
||||||
lives in the host tool (`pureboot.py`).
|
|
||||||
|
|
||||||
The 1284s still *deploy* in a 1 KiB slot, their smallest boot sector being
|
|
||||||
512 words; at 506 B the image would also fit the 644's
|
|
||||||
two-512-byte-slots-per-boot-sector geometry.
|
|
||||||
|
|
||||||
The image is **position-independent**: control flow is PC-relative, the
|
|
||||||
read/write paths take wire addresses, the write guard protects the slot the
|
|
||||||
code is *running* in (from the runtime return address), the info block is
|
|
||||||
addressed from that same anchor, and the application jump is an indirect
|
|
||||||
call to an absolute entry. The identical binary therefore runs from any
|
|
||||||
slot with every command intact — which makes pureboot **its own staging
|
|
||||||
loader**: the host installs the same binary one slot below the resident,
|
|
||||||
jumps into it, and lets it rewrite the resident. The slot is 512 bytes
|
|
||||||
(1 KiB on the word-addressed large chips, matching their boot-sector
|
|
||||||
minimum); on the tinies the budget is 510, not 512: a slot's last word
|
|
||||||
belongs to the host-managed trampoline (below).
|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
Every deployment axis is a build parameter, resolved by the CMake function
|
|
||||||
`pureboot_add_loader()` (in `pureboot/CMakeLists.txt`) — the one way a
|
|
||||||
loader target is created, by this repo's own build and by a downstream
|
|
||||||
project alike:
|
|
||||||
|
|
||||||
| Argument | Meaning | Default |
|
|
||||||
|---|---|---|
|
|
||||||
| `CLOCK <hz>` | the clock the board runs | 16 MHz megas, 8 MHz t25/45/85, 9.6 MHz t13s |
|
|
||||||
| `BAUD <bd>` | the wire rate | the ladder below |
|
|
||||||
| `SERIAL auto\|hardware\|software` | the link backend | `auto`: the hardware USART where the chip has one |
|
|
||||||
| `USART <n>` | the USART instance (x4 megas carry two) | 0 |
|
|
||||||
| `RX <pin>`, `TX <pin>` | software-UART pins | `pb0`, `pb1` |
|
|
||||||
| `TIMEOUT <s>` | the activation window | 8 |
|
|
||||||
|
|
||||||
The default baud is the fastest of 115200/57600/38400/19200/9600 the clock
|
|
||||||
reaches within 2.5 % — the same U2X-included divisor search libavr's baud
|
|
||||||
solver runs — and on a software build additionally within the polled
|
|
||||||
receiver's 100-cycles-a-bit floor. 16 MHz lands 115200, 8 MHz 57600,
|
|
||||||
1 MHz 9600. Whatever is picked or overridden is re-checked in the compile:
|
|
||||||
an infeasible clock/baud/backend combination, or a USART the chip does not
|
|
||||||
have, fails with a named static assert.
|
|
||||||
|
|
||||||
A downstream project brings its usual libavr setup (the `libavr` target,
|
|
||||||
the chip via the `LIBAVR_MCU` toolchain preset), consumes this directory,
|
|
||||||
and states its deployment — for example an ATmega328P on its shipped
|
|
||||||
1 MHz fuses with the software UART on hand-picked pins:
|
|
||||||
|
|
||||||
```cmake
|
|
||||||
FetchContent_Declare(bootloader GIT_REPOSITORY git@git.blackmark.me:avr/bootloader.git GIT_TAG main)
|
|
||||||
FetchContent_MakeAvailable(bootloader)
|
|
||||||
add_subdirectory(${bootloader_SOURCE_DIR}/pureboot pureboot)
|
|
||||||
|
|
||||||
pureboot_add_loader(myboot CLOCK 1000000 SERIAL software TX pb1 RX pb5)
|
|
||||||
```
|
|
||||||
|
|
||||||
The function emits the ELF plus `myboot.hex` (the programmer artifact) and
|
|
||||||
`myboot.bin` (the self-update image), prints the size, and stamps the
|
|
||||||
resolved deployment on the target as the `PUREBOOT_HZ`, `PUREBOOT_BAUD`
|
|
||||||
and `PUREBOOT_LINK` properties — what a flashing script or test harness
|
|
||||||
needs to speak to the build. This exact example deployment runs the full
|
|
||||||
protocol suite in CI (`pureboot.custom`).
|
|
||||||
|
|
||||||
## Link
|
## Link
|
||||||
|
|
||||||
The stock builds assume the family's natural deployment; any axis moves
|
|
||||||
per build (above).
|
|
||||||
|
|
||||||
| Chip | Serial | Baud | Clock assumed |
|
| Chip | Serial | Baud | Clock assumed |
|
||||||
|---|---|---|---|
|
|---|---|---|---|
|
||||||
| every ATmega | the hardware USART (USART0), RXD/TXD per pinout | 115200 8N1 | 16 MHz crystal |
|
| ATmega328P | USART0, RXD/TXD = PD0/PD1 | 115200 8N1 | 16 MHz crystal |
|
||||||
| ATtiny25/45/85 | software UART, RX = PB0, TX = PB1 | 57600 8N1 | 8 MHz internal RC |
|
| ATtiny85 | software UART, RX = PB0, TX = PB1 | 57600 8N1 | 8 MHz internal RC |
|
||||||
| ATtiny13/13A | software UART, RX = PB0, TX = PB1 | 57600 8N1 | 9.6 MHz internal RC |
|
| ATtiny13A | software UART, RX = PB0, TX = PB1 | 57600 8N1 | 9.6 MHz internal RC |
|
||||||
|
|
||||||
The software-UART RX pin has its pull-up enabled; TX idles high. All
|
The tiny RX pin has its pull-up enabled; TX idles high. All multi-byte
|
||||||
multi-byte quantities on the wire are little-endian.
|
quantities on the wire are little-endian.
|
||||||
|
|
||||||
## Activation
|
## Activation
|
||||||
|
|
||||||
Reset enters the loader (BOOTRST on the boot-sectioned megas; the patched
|
Reset enters the loader (BOOTRST on the mega, the patched reset vector on the
|
||||||
reset vector on the tinies and the boot-section-less m48s) — except a
|
tinies) — except a watchdog reset, which hands straight to the application
|
||||||
watchdog reset, which hands straight to the application (the application
|
(the application owns its watchdog; it must clear WDRF itself, which also
|
||||||
owns its watchdog; it must clear WDRF itself, which also releases the
|
releases the WDRF-forced WDE).
|
||||||
WDRF-forced WDE).
|
|
||||||
|
|
||||||
The host then has one activation window per awaited byte to knock: `p` then
|
The host then has one activation window per awaited byte to knock: `p` then
|
||||||
`b`. Each awaited byte gets a fresh window; any other byte is discarded and
|
`b`. Each awaited byte gets a fresh window; any other byte is discarded and
|
||||||
awaited again (line noise cannot lock the loader, only delay it). A window
|
awaited again (line noise cannot lock the loader, only delay it). A window
|
||||||
expiring with an idle line boots the application.
|
expiring with an idle line boots the application.
|
||||||
|
|
||||||
The window length is a compile-time constant — 8 s by default, another
|
The window length in seconds is the **last EEPROM cell** (address
|
||||||
value via `pureboot_add_loader(... TIMEOUT <s>)` (the stock target keeps
|
`eeprom_size - 1`); `0x00` and the erased `0xff` both mean the 4 s default,
|
||||||
the `PUREBOOT_TIMEOUT` cache variable) — so the whole EEPROM belongs to
|
so a full EEPROM erase resets the timeout rather than maxing it. The host
|
||||||
the application; pureboot never uses it for its own state. Re-timing a
|
changes it with the ordinary EEPROM-write command.
|
||||||
deployed loader is a self-update with a re-timed build (below).
|
|
||||||
|
|
||||||
## Session
|
## Session
|
||||||
|
|
||||||
After the knock the loader stays in its command loop until `J` jumps away or
|
After the knock the loader stays in its command loop until `G` or a reset.
|
||||||
the chip resets. Before reading each command it waits for any pending EEPROM
|
Before reading each command it waits for any pending EEPROM write to finish
|
||||||
write to finish and sends the prompt `+` (0x2b) — the prompt is therefore
|
and sends the prompt `+` (0x2b) — the prompt is therefore also the completion
|
||||||
also the completion ack of the previous command. A session is: await `+`,
|
ack of the previous command. A session is: await `+`, send a command, read
|
||||||
send a command, read its reply, repeat.
|
its reply, repeat.
|
||||||
|
|
||||||
On chips whose flash exceeds 64 KiB (the 1284s — info-block flag bit 1) the
|
|
||||||
`R`/`W` flash addresses are **word** addresses; everywhere else they are byte
|
|
||||||
addresses (the 644s' 64 KiB is exactly the 16-bit byte space and stays
|
|
||||||
byte-addressed). EEPROM addresses are always bytes, counts always bytes.
|
|
||||||
|
|
||||||
| Cmd | Arguments | Reply |
|
| Cmd | Arguments | Reply |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
@@ -134,262 +52,72 @@ byte-addressed). EEPROM addresses are always bytes, counts always bytes.
|
|||||||
| `r` | addr16, n8 | n EEPROM bytes (n = 0 means 256) |
|
| `r` | addr16, n8 | n EEPROM bytes (n = 0 means 256) |
|
||||||
| `w` | addr16, n8, then n data bytes | `+` per byte, sent once its write has begun |
|
| `w` | addr16, n8, then n data bytes | `+` per byte, sent once its write has begun |
|
||||||
| `F` | — | 4 bytes: low fuse, lock, extended fuse, high fuse |
|
| `F` | — | 4 bytes: low fuse, lock, extended fuse, high fuse |
|
||||||
| `J` | word address (16-bit) | `+`, then execution continues there |
|
| `G` | — | `+`, then the application runs |
|
||||||
| other | — | ignored; the loop re-prompts (send a junk byte, await `+`, to resync) |
|
| other | — | ignored; the loop re-prompts (send a junk byte, await `+`, to resync) |
|
||||||
|
|
||||||
`W` streams exactly one SPM page (size from the info block) into the buffer,
|
`W` streams exactly one SPM page (size from the info block) into the buffer,
|
||||||
then erases and programs; the address must be page-aligned. Pages inside the
|
then erases and programs; the address must be page-aligned. Pages inside the
|
||||||
512-byte slot the loader is *running* in are drained but never programmed — a
|
loader's own 512 bytes are drained but never programmed — a broken host
|
||||||
broken host cannot brick the running copy, and a staged copy may rewrite the
|
cannot brick the chip. `w` is host-paced: send the next byte only after the
|
||||||
resident slot.
|
previous byte's `+`. `F` returns the bytes in the hardware's Z order; on a chip without an
|
||||||
|
extended fuse byte (the ATtiny13A) that slot carries no meaning. Fuse *writing* does not
|
||||||
The loader never clears the SPM buffer before a fill, so **one `W` may
|
exist: SPM reaches flash (and, on the mega, lock bits) only — fuse bytes are
|
||||||
program the wrong bytes, and the host is what fixes it**. The buffer is
|
external-programming territory by hardware.
|
||||||
write-once per word until cleared, and two things leave words in it: a
|
|
||||||
refused page (drained, never programmed) and — where SPM runs from anywhere,
|
|
||||||
the tinies and the m48s — an application that self-programmed before
|
|
||||||
entering. The next `W` takes those stale words, and clears them: a page write
|
|
||||||
auto-erases the buffer (§26.2.1; §19.2 on the tinies), so repeating it
|
|
||||||
programs correctly. The host therefore verifies every page it writes and
|
|
||||||
rewrites what comes back wrong (three retries, then it stops); a host that
|
|
||||||
programs without reading back cannot trust the first `W` after either event.
|
|
||||||
|
|
||||||
`w` is host-paced: send the next byte only after the previous
|
|
||||||
byte's `+`. `F` returns the bytes in the hardware's Z order; on a chip
|
|
||||||
without an extended fuse byte (the ATtiny13A) that slot carries no meaning.
|
|
||||||
Fuse *writing* does not exist: SPM reaches flash (and, on the mega, lock
|
|
||||||
bits) only — fuse bytes are external-programming territory by hardware.
|
|
||||||
|
|
||||||
`J` is the one control-transfer primitive: the host uses it to run the
|
|
||||||
application (word 0 on the mega, the trampoline word on the tinies — both
|
|
||||||
known from the info block) and to move between loader copies during a
|
|
||||||
self-update. A jump to a loader slot's base re-enters that copy's own
|
|
||||||
startup; it must then be knocked afresh.
|
|
||||||
|
|
||||||
The info block (`b`):
|
The info block (`b`):
|
||||||
|
|
||||||
| Offset | Content |
|
| Offset | Content |
|
||||||
|---|---|
|
|---|---|
|
||||||
| 0–2 | `'P'`, `'B'`, pureboot version (2) |
|
| 0–2 | `'P'`, `'B'`, protocol version (1) |
|
||||||
| 3–5 | device signature |
|
| 3–5 | device signature |
|
||||||
| 6 | SPM page size in bytes (0 means 256) |
|
| 6 | SPM page size in bytes |
|
||||||
| 7–8 | loader base — application flash ends here (a word address when bit 1 is set) |
|
| 7–8 | loader base — application flash ends here |
|
||||||
| 9–10 | EEPROM size |
|
| 9–10 | EEPROM size |
|
||||||
| 11 | bit 0: host must patch the reset vector (no hardware boot section); bit 1: flash wire addresses are word addresses |
|
| 11 | bit 0 set: host must patch the reset vector (no hardware boot section) |
|
||||||
|
|
||||||
Composites are the host's job: verify = read back and compare, erase =
|
Composites are the host's job: verify = read back and compare, erase =
|
||||||
write `0xff` (per page for flash, per byte for EEPROM).
|
write `0xff` (per page for flash, per byte for EEPROM), timeout = EEPROM
|
||||||
|
write to the last cell.
|
||||||
## Version
|
|
||||||
|
|
||||||
The third byte of the info block is the **pureboot version** — the loader's
|
|
||||||
one identity number, and the only way to tell what a deployed loader is.
|
|
||||||
Nothing else is numbered: the wire protocol has no version of its own, a
|
|
||||||
pureboot version implies its protocol, and the host tool is what holds that
|
|
||||||
map. It states the window of loader versions it speaks
|
|
||||||
(`OLDEST_LOADER`/`NEWEST_LOADER` in `pureboot.py`); a version that changes
|
|
||||||
the protocol becomes the new floor there. So far none has: pureboot 1 and 2
|
|
||||||
speak the identical session, and a loader newer than the tool is refused by
|
|
||||||
name rather than decoded on the assumption that nothing moved.
|
|
||||||
|
|
||||||
The tool carries its own version, free to drift from the loader's:
|
|
||||||
`--version` prints both it and the window.
|
|
||||||
|
|
||||||
## Deployment
|
## Deployment
|
||||||
|
|
||||||
The build leaves three artifacts per chip. The ELF is a container for the
|
**ATmega328P**: program the loader at 0x7e00 with an external programmer;
|
||||||
tests and objcopy — never flashed. The **.hex is the programmer artifact**:
|
fuses BOOTSZ = 11 (256 words) and BOOTRST programmed. Applications are
|
||||||
it carries its own addresses and lands the loader in its top slot,
|
flashed unmodified — reset re-vectors to the loader in hardware, word 0
|
||||||
touching nothing else. The **.bin is the self-update image** — the slot's
|
stays the application's own reset vector, and `G` jumps to 0.
|
||||||
bare bytes with no addressing, which a programmer would put at address 0.
|
|
||||||
On a boot-sectioned mega a copy at 0 is dead weight (SPM only executes
|
|
||||||
from the boot section, so it cannot even heal itself — reflash the .hex);
|
|
||||||
on the patched-vector chips it *runs* (the image is position-independent
|
|
||||||
and reset enters word 0), reports its canonical geometry, and the ordinary
|
|
||||||
`--update-loader` flow re-homes a build into the top slot from any
|
|
||||||
position — the staging install and the word-0 redirect execute from
|
|
||||||
copies outside page 0's slot, and a copy sitting in the staging slot
|
|
||||||
itself is recognized as the installed staging copy and left in place (it
|
|
||||||
streams the new resident like any staged copy, so an older build installs
|
|
||||||
a newer one). `pureboot.rehome` is the acceptance test for both
|
|
||||||
positions. Flashing the application afterwards overwrites the stale copy,
|
|
||||||
vector surgery included.
|
|
||||||
|
|
||||||
**Boot-sectioned megas**: program the loader at `flash − slot` with an
|
**Tinies** (no boot section): program the loader at `flash - 512`; erased
|
||||||
external programmer. Every such mega has a BOOTSZ step whose boot section
|
flash below it walks up into the loader, so a virgin chip activates. When
|
||||||
is exactly the loader slot — 512 B, the second-smallest step on the 8 KiB
|
flashing an application the host performs reset-vector surgery: the
|
||||||
and 16 KiB chips (m8, m88, m16, m168, m164), the smallest on the 32 KiB
|
application's own `rjmp` target is re-encoded as a trampoline `rjmp` in the
|
||||||
ones (m32, m328, m324); on the 1284s that step is the smallest, 512 words,
|
word just below the loader (`base - 2`, where `G` jumps), and word 0 is
|
||||||
which is why their slot is 1 KiB — so the ATmega328P profiles below apply
|
rewritten to `rjmp` to the loader base. Every other vector stays the
|
||||||
to every one of them with its own addresses and slot size; the per-chip
|
application's. Page 0 is written last, so an interrupted flash leaves word 0
|
||||||
BOOTSZ ladders live in the host tool (`BOOT_FUSE`). The 1284s' numbers:
|
erased and the chip still falls through to the loader on the next reset.
|
||||||
standalone = BOOTSZ 512 words (reset at the loader base 0x1fc00);
|
|
||||||
self-update = 1024 words, covering both 1 KiB slots, the loader-first
|
|
||||||
reset landing at 0x1f800 — the staging slot, walked across when erased.
|
|
||||||
|
|
||||||
The **644s** are the geometry's sweet spot: their smallest boot section
|
|
||||||
(512 words = 1 KiB) is exactly *two* 512-byte slots, so the resident and
|
|
||||||
its staging slot both live inside the minimum section — self-update needs
|
|
||||||
no fuse step up, and the standalone profile does not exist (reset lands at
|
|
||||||
0xfc00, one erased slot below the loader: the loader-first walk built in).
|
|
||||||
|
|
||||||
ATmega328P profiles (addresses for its 32 KiB):
|
|
||||||
|
|
||||||
| BOOTSZ | BOOTRST | Behavior |
|
|
||||||
|---|---|---|
|
|
||||||
| 256 words (512 B) | programmed | *Standalone*: reset always enters the loader; **self-update impossible** (the staging slot lies outside the boot section, where SPM is disabled). |
|
|
||||||
| 512 words (1 KB) | unprogrammed | *Self-update, app-first*: reset always boots the application, which owns all 31.5 KB and must offer its own jump to 0x7e00 to reach the loader (a virgin chip reaches it by reset across erased flash). Updates are power-fail-safe except mid-rewrite of the resident slot itself (no reset path leads to the staging copy then). |
|
|
||||||
| 512 words (1 KB) | programmed | *Self-update, loader-first*: reset lands at 0x7c00 — the staging slot, normally erased, so execution walks up into the loader; during an update it is the staging copy itself, so a mid-rewrite power loss recovers by reset. The loss windows move to the staging install/retire page writes instead (page-write scale). The host keeps `[0x7c00, 0x7e00)` clear of application data (`--force` overrides). |
|
|
||||||
|
|
||||||
Applications are flashed unmodified — word 0 stays the application's own
|
|
||||||
reset vector, and the hand-over jumps to 0.
|
|
||||||
|
|
||||||
**Patched-vector chips — the tinies and the m48s** (no boot section; the
|
|
||||||
m48s' SPM runs from the entire flash, Atmel-8271 §26): program the loader
|
|
||||||
at `flash − 512`; erased flash below it walks up into the loader, so a
|
|
||||||
virgin chip activates. When flashing an application the host performs
|
|
||||||
reset-vector surgery: word 0 is rewritten to `rjmp` to the loader base, and
|
|
||||||
the application's own entry is re-encoded as a trampoline `rjmp` in the
|
|
||||||
word just below the loader (`base − 2`, where the hand-over jumps). Every
|
|
||||||
other vector stays the application's. The patched page 0 and the trampoline
|
|
||||||
page are written *first*, so from the first write on an interrupted flash
|
|
||||||
still resets into the loader; an erase runs top-down for the same reason.
|
|
||||||
The m48s speak this profile over their hardware USART — no fuse preflight,
|
|
||||||
BOOTRST does not exist there.
|
|
||||||
|
|
||||||
## Updating the loader
|
|
||||||
|
|
||||||
`pureboot.py --update-loader new_pureboot.bin` replaces the resident loader
|
|
||||||
with any pureboot build — a re-timed window, a newer version — using the
|
|
||||||
loader itself as its own staging loader. The image is the loader's own 512
|
|
||||||
bytes as a raw binary, or the Intel HEX the build emits beside it, which
|
|
||||||
links the loader at its base inside an otherwise blank flash image:
|
|
||||||
|
|
||||||
The preflight refuses an image built for another chip: the info block
|
|
||||||
embedded in every pureboot binary (signature, page size, loader base,
|
|
||||||
EEPROM size, flags) must match the device's own, and the error names both.
|
|
||||||
Die revisions share their base signature and geometry, so their images are
|
|
||||||
interchangeable — as the silicon is. `loader_image()` also accepts a
|
|
||||||
padded image (a raw .bin padded from 0, or a whole-flash read-back with
|
|
||||||
the loader resident) and peels it to the slot content by the embedded base.
|
|
||||||
|
|
||||||
1. The staging slot `[base−slot, base)` is saved to a host-side state file
|
|
||||||
(on the 1 KB tiny13s that is the whole application, vectors included).
|
|
||||||
2. The resident installs the identical update image there. On the
|
|
||||||
patched-vector chips the host composes the slot's last word — the same
|
|
||||||
address as the resident's trampoline — as a jump to the resident base,
|
|
||||||
so even an abandoned staging copy times out into a loader, never into
|
|
||||||
garbage. A loader already sitting whole in the staging slot (its info
|
|
||||||
block in place, the slot unchanged since the update began) is left as
|
|
||||||
the staging copy instead — rewriting it would only meet its own
|
|
||||||
running-slot guard.
|
|
||||||
3. `J` enters the staging copy, which rewrites the resident slot. On the
|
|
||||||
patched-vector chips whose staging slot sits away from page 0 the host
|
|
||||||
first re-aims word 0 at the staging copy, so a power loss mid-rewrite
|
|
||||||
still resets into a loader; on the tiny13s the staging slot carries the
|
|
||||||
reset vector itself.
|
|
||||||
4. `J` enters the new resident, which restores the staging slot's saved
|
|
||||||
content (word 0 and the trampoline with it) and the state file is
|
|
||||||
discarded.
|
|
||||||
|
|
||||||
Every phase is idempotent and keyed off the actual flash state: re-running
|
|
||||||
the same command after any interruption resumes and completes. The state
|
|
||||||
file carries the only bytes not recoverable from the device; if it is lost
|
|
||||||
mid-update the update still completes, and the staging region is restored by
|
|
||||||
reflashing the application. A boot-sectioned mega needs its fuses for the
|
|
||||||
preflight (BOOTSZ gate, profile notes) — read from the device, or supplied
|
|
||||||
with `--assume-fuses` where reading is impossible (simulators); the
|
|
||||||
patched-vector chips need none.
|
|
||||||
|
|
||||||
## Host tool
|
## Host tool
|
||||||
|
|
||||||
`pureboot.py` — Python 3, standard library only. The port layer is the one
|
`pureboot.py` — Python 3, standard library only (termios drives any tty,
|
||||||
platform-specific part: termios drives any tty on POSIX (a USB adapter as
|
a USB adapter as well as a simavr pty):
|
||||||
well as a simavr pty), the Win32 serial API through `ctypes` drives a COM
|
|
||||||
port on Windows (`--port COM6`; the `\\.\` form for two-digit ports is
|
|
||||||
supplied by the tool). Opening the port asserts DTR and RTS on both, so a
|
|
||||||
board that wires DTR to reset gets its reset pulse and opens the activation
|
|
||||||
window by itself.
|
|
||||||
|
|
||||||
pureboot.py --port /dev/ttyUSB0 --baud 57600 \
|
pureboot.py --port /dev/ttyUSB0 --baud 57600 \
|
||||||
--info --fuses --flash app.hex
|
--info --fuses --flash app.hex --timeout 10
|
||||||
|
|
||||||
Operations run in a fixed order within one session: info, fuses, loader
|
Operations run in a fixed order within one session: info, fuses, flash
|
||||||
update, flash (erase / program / read / verify), EEPROM (erase / program /
|
(erase / program / read / verify), EEPROM (erase / program / read / verify),
|
||||||
read / verify) — then the loader hands over to the application; `--stay`
|
timeout — then the loader hands over to the application; `--stay` keeps the
|
||||||
keeps the session alive instead, and a later invocation reconnects into it
|
session alive instead, and a later invocation reconnects into it (the knock
|
||||||
(the knock converges there too). `--flash` and `--eeprom` verify by
|
converges there too). `--flash` and `--eeprom` verify by read-back unless
|
||||||
read-back unless `--no-verify`, and a flash page that reads back wrong is
|
`--no-verify`; images are raw binary, or Intel HEX by extension.
|
||||||
rewritten up to three times before the run stops — the loader leaves one
|
|
||||||
recoverable way for a page to land wrong (see `W` above), and rewriting is
|
|
||||||
what clears it. `--verify-flash` only reports. Images are raw binary, or
|
|
||||||
Intel HEX by extension. `--force` overrides the refusable safety checks (today: flashing
|
|
||||||
application data into a mega's reset walk region).
|
|
||||||
|
|
||||||
Readouts come one fact per line: `--info` prints the decoded info block
|
|
||||||
field by field, the loader's version first; `--fuses` each fuse byte on its
|
|
||||||
own line — plus, on a boot-sectioned mega, the decoded meaning (where the
|
|
||||||
BOOTSZ section starts, what BOOTRST does to reset). Transfers that take
|
|
||||||
wire time — programming, reading, erasing, verifying, the update phases —
|
|
||||||
draw a transient progress bar on stderr when it is a tty; logs and pipes
|
|
||||||
see only the summary lines.
|
|
||||||
`-v`/`--verbose` adds the decisions as they happen: knock counts, the
|
|
||||||
programming plan (vector-surgery targets, skipped blank pages), update
|
|
||||||
state handling and per-phase page counts.
|
|
||||||
|
|
||||||
## Tests
|
## Tests
|
||||||
|
|
||||||
`tools/check.sh` runs every chip's workflow (`tools/check.sh --full` adds
|
Per chip preset, `ctest` runs the 512-byte size gate and the end-to-end
|
||||||
the reflect-mode builds of libavr's spot set; `tools/make_presets.py`
|
protocol test: a simavr device (`test/pureboot_device.c` — the mega's USART
|
||||||
regenerates the presets). Per chip preset, `ctest` runs:
|
as a pty; on the tinies a cycle-timed GPIO⇄pty bridge for the software UART,
|
||||||
|
plus the SPM/NVM module simavr's tiny cores lack) driven by the real host
|
||||||
- `pureboot.size` — the 510-byte (tinies) / 512-byte (mega) budget;
|
tool through knock-from-reset, program + verify of both memories, timeout
|
||||||
- `pureboot_*.size` — the size matrix: the serial backends × the clock
|
configuration, session reconnect, an external reset through the patched
|
||||||
ladder (1/8/16 MHz; the t13s' own RC menu), plus the USART1 build on the
|
vector, and the hand-over to a fixture application whose banner proves the
|
||||||
x4 chips — every configuration axis that could move the image, each
|
launch — cross-checked against the simulator's ground-truth memory dumps and
|
||||||
variant against the same slot budget (pins are immediate operands and the
|
an independent decode of the surgery's rjmp words.
|
||||||
timeout is a constant: size-neutral);
|
|
||||||
- `pureboot.custom` (328P) — the configured-deployment acceptance test: the
|
|
||||||
1 MHz software-serial TX=PB1/RX=PB5 build from the configuration example
|
|
||||||
drives the full protocol suite through the runner's GPIO bridge, fixture
|
|
||||||
application included;
|
|
||||||
- `pureboot.usart1` (644A) — the same protocol suite over the second
|
|
||||||
hardware USART: instance selection is compile-checked everywhere, but
|
|
||||||
only a live session proves the loader polls the USART it claims;
|
|
||||||
- `pureboot.pi` — the position-independence lint: no absolute `jmp`/`call`
|
|
||||||
in the image, the info block within its first 256 bytes;
|
|
||||||
- `pureboot.planner` — the host tool's pure logic: programming orders and
|
|
||||||
their recovery properties, the surgery, the staging composition, the
|
|
||||||
boot-fuse decode, the update preflight's error/warning matrix over
|
|
||||||
synthetic fuse bytes, and the repairing verify against a fake device — one
|
|
||||||
bad write repaired in a single rewrite, a page that never comes good
|
|
||||||
stopping after exactly three;
|
|
||||||
- `pureboot.protocol` — end to end against a simavr device
|
|
||||||
(`test/pureboot_device.c` — a hardware USART as a pty, or a cycle-timed
|
|
||||||
GPIO⇄pty bridge for a software-UART build, selected with `-l` to match
|
|
||||||
the loader's link; plus the SPM/NVM module simavr's tiny cores lack)
|
|
||||||
driven by the real host tool through
|
|
||||||
knock-from-reset, program + verify of both memories, session reconnect, an
|
|
||||||
external reset through the patched vector, and the hand-over to a fixture
|
|
||||||
application whose banner proves the launch — cross-checked against the
|
|
||||||
simulator's ground-truth memory dumps and an independent decode of the
|
|
||||||
surgery's rjmp words;
|
|
||||||
- `pureboot.reloc` — the identical image installed one slot below the
|
|
||||||
resident serves the complete command set from there (the
|
|
||||||
position-independence acceptance test);
|
|
||||||
- `pureboot.dirty` (328P) — entering the loader from a running application
|
|
||||||
with no reset between, over an SPM page buffer the fixture deliberately
|
|
||||||
dirtied: the case the loader declines to guard against. A bare verify must
|
|
||||||
see the corruption, the repairing verify must fix it in one rewrite, and a
|
|
||||||
plain verify afterwards must pass. On the boot-sectioned megas hardware
|
|
||||||
forbids the state outright (SPM runs only from the boot section, and reset
|
|
||||||
erases the buffer), but simavr dispatches SPM from anywhere — which is what
|
|
||||||
makes the path constructible at all;
|
|
||||||
- `pureboot.update` — the full `--update-loader` flow to a re-timed build,
|
|
||||||
then every power-fail phase: the device is killed mid-write, restarted
|
|
||||||
from its flash dump, and a re-run must complete the update with the
|
|
||||||
application intact throughout.
|
|
||||||
|
|
||||||
`size`, `pi`, and `planner` are host logic and run anywhere; the
|
|
||||||
simulator-driven targets need simavr and a pty, so they are POSIX-only —
|
|
||||||
on Windows the tool is exercised against real hardware.
|
|
||||||
|
|||||||
@@ -1,28 +1,17 @@
|
|||||||
// pureboot — a serial bootloader on libavr, pure by constraint: one C++
|
// pureboot — a serial bootloader on libavr, pure by constraint: one C++
|
||||||
// source with no inline assembly and no global register variables, built for
|
// source with no inline assembly and no global register variables, built for
|
||||||
// every chip libavr targets, 512 bytes on each. The device speaks primitives
|
// every chip libavr targets, 512 bytes on each. The device speaks primitives
|
||||||
// — read/program flash, read/write EEPROM, fuse bytes, an info block, a jump
|
// — read/program flash, read/write EEPROM, fuse bytes, an info block, run —
|
||||||
// — and everything composite (verify, erase, reset-vector surgery, updating
|
// and everything composite (verify, erase, reset-vector surgery on the
|
||||||
// the loader itself) lives in the host tool. Protocol reference: README.md
|
// tinies, timeout configuration) lives in the host tool. Protocol reference:
|
||||||
// next to this file.
|
// README.md next to this file.
|
||||||
//
|
//
|
||||||
// The image is position-independent: control flow is PC-relative, the write
|
// Entry: reset lands in avr::startup::entry below (BOOTRST on the mega; the
|
||||||
// and read paths take wire addresses, the write guard refuses the 512-byte
|
// patched reset vector — or erased flash walking up into the loader — on the
|
||||||
// slot the code is *running* in (taken from the runtime return address), the
|
// tinies). A watchdog reset hands straight to the application. Otherwise the
|
||||||
// info block is read relative to that same anchor, and the application jump
|
// host has one activation window — EEPROM's last cell, in seconds — to knock
|
||||||
// is an indirect call to an absolute entry. The identical binary therefore
|
// ("pb"); an idle line boots the application. A session then stays in the
|
||||||
// runs from any 512-byte slot with every command intact: flashed one slot
|
// command loop until 'G' hands over or the chip resets.
|
||||||
// below the resident loader it becomes the staging loader that rewrites the
|
|
||||||
// resident — how pureboot updates itself, host-driven, with no other
|
|
||||||
// firmware involved.
|
|
||||||
//
|
|
||||||
// Entry: reset lands in avr::startup::entry below (BOOTRST on the
|
|
||||||
// boot-sectioned megas; the patched reset vector — or erased flash walking
|
|
||||||
// up into the loader — on the tinies and the boot-section-less m48s). A
|
|
||||||
// watchdog reset hands straight to the application. Otherwise the
|
|
||||||
// host has one activation window per awaited knock byte ("pb"); an idle line
|
|
||||||
// boots the application. A session then stays in the command loop until 'J'
|
|
||||||
// jumps away or the chip resets.
|
|
||||||
|
|
||||||
#include <libavr/libavr.hpp>
|
#include <libavr/libavr.hpp>
|
||||||
|
|
||||||
@@ -38,119 +27,79 @@ constexpr auto off = avr::irq::guard_policy::unused;
|
|||||||
|
|
||||||
constexpr std::uint8_t ack = '+';
|
constexpr std::uint8_t ack = '+';
|
||||||
|
|
||||||
// Per-deployment personality, passed in by the build — pureboot_add_loader()
|
// Per-chip personality, from the chip database: the clocks the dogfood
|
||||||
// (the CMake function next to this file) resolves the defaults: the clock the
|
// boards run (16 MHz crystal on the mega, calibrated RC on the tinies) and
|
||||||
// board actually runs, the wire baud, the serial backend and its pins. The
|
// the device signature (compile-time data — the tiny13A cannot even read its
|
||||||
// device signature needs no configuring — it comes from the chip database
|
// signature row from code).
|
||||||
// (avr::hw::db.signature), the only universal source, since the tiny13A
|
consteval avr::hertz_t clock()
|
||||||
// cannot even read its signature row from code.
|
|
||||||
#if !defined(PUREBOOT_CLOCK_HZ) || !defined(PUREBOOT_BAUD)
|
|
||||||
#error \
|
|
||||||
"PUREBOOT_CLOCK_HZ and PUREBOOT_BAUD select this build's clock and baud — create loader targets with pureboot_add_loader() (README.md)"
|
|
||||||
#endif
|
|
||||||
|
|
||||||
using dev = avr::device<{.clock = avr::hertz_t{PUREBOOT_CLOCK_HZ}}>;
|
|
||||||
constexpr avr::baud_t wire_baud{PUREBOOT_BAUD};
|
|
||||||
|
|
||||||
// The watchdog reset flag's home: MCUSR, or the classic megas' MCUCSR.
|
|
||||||
consteval std::int16_t wdrf_field()
|
|
||||||
{
|
{
|
||||||
auto reg = std::string_view{avr::hw::db.regs[static_cast<std::size_t>(avr::power::detail::reset_reg())].name};
|
if (avr::hw::db.name == "ATtiny13A")
|
||||||
return avr::hw::db.field_index(reg, "WDRF");
|
return 9.6_MHz;
|
||||||
|
if (avr::hw::db.name == "ATtiny85")
|
||||||
|
return 8_MHz;
|
||||||
|
return 16_MHz;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Geometry: the resident loader owns the top slot of flash — 512 bytes,
|
consteval std::array<std::uint8_t, 3> signature()
|
||||||
// except on the >64 KiB chips whose own smallest boot sector is 1 KiB (the
|
{
|
||||||
// 1284s): there the slot is 1 KiB, matching the hardware boundary the
|
if (avr::hw::db.name == "ATtiny13A")
|
||||||
// 512-byte figure comes from everywhere else. The word below the slot is
|
return {0x1e, 0x90, 0x07};
|
||||||
// the trampoline (the application's relocated reset vector) on chips
|
if (avr::hw::db.name == "ATtiny85")
|
||||||
// without a hardware boot section — the tinies and the m48s, whose SPM
|
return {0x1e, 0x93, 0x0b};
|
||||||
// runs from anywhere (Atmel-8271 §26). A boot section also means the CPU
|
return {0x1e, 0x95, 0x0f};
|
||||||
// runs on while the RWW section programs; everywhere else it halts through
|
}
|
||||||
// the operation.
|
|
||||||
constexpr std::uint16_t slot_bytes = spm::flash_bytes > 65536 ? 1024 : 512;
|
using dev = avr::device<{.clock = clock()}>;
|
||||||
constexpr std::uint32_t base = spm::flash_bytes - slot_bytes;
|
|
||||||
|
// Geometry: the loader owns the top 512 bytes of flash; the byte below it is
|
||||||
|
// the trampoline word (the application's relocated reset vector) on chips
|
||||||
|
// without a hardware boot section. The RWWSRE bit marks a separate boot
|
||||||
|
// section — on classic AVR the two capabilities coincide.
|
||||||
|
constexpr std::uint16_t boot_bytes = 512;
|
||||||
|
constexpr std::uint16_t base = static_cast<std::uint16_t>(spm::flash_bytes - boot_bytes);
|
||||||
constexpr std::uint16_t page = spm::page_bytes;
|
constexpr std::uint16_t page = spm::page_bytes;
|
||||||
constexpr bool boot_section = avr::hw::curated::has_boot_section();
|
constexpr bool boot_section = avr::hw::db.field_index("SPMCSR", "RWWSRE") >= 0;
|
||||||
|
|
||||||
// Past 64 KiB a byte address no longer fits the wire's 16 bits, so on the
|
// The activation timeout lives in EEPROM's last cell, in seconds; the host
|
||||||
// large chips every flash address on the wire — and all slot arithmetic —
|
// rewrites it with the ordinary EEPROM-write command. An unprogrammed cell —
|
||||||
// is a word address instead ('J' always was one). A slot spans the same
|
// 0x00 or the erased 0xff — means the 4 s default: a stray value can never
|
||||||
// wire-high-byte pair in either unit (512 B = 2 x 256 bytes, 1 KiB =
|
// floor the window to nothing and lock the loader out, and erasing the whole
|
||||||
// 2 x 256 words), so the slot index is the high byte with its low bit
|
// EEPROM resets the timeout instead of maxing it to 255 s.
|
||||||
// dropped everywhere.
|
constexpr std::uint16_t timeout_cell = avr::hw::db.mem.eeprom_size - 1;
|
||||||
constexpr bool word_flash = spm::flash_bytes > 65536;
|
constexpr std::uint8_t default_seconds = 4;
|
||||||
constexpr std::uint16_t wire_base =
|
|
||||||
word_flash ? static_cast<std::uint16_t>(base / 2) : static_cast<std::uint16_t>(base);
|
|
||||||
constexpr std::uint16_t wire_page_mask = word_flash ? (page / 2 - 1) : (page - 1);
|
|
||||||
|
|
||||||
// The activation window, in seconds, is a compile-time constant (the build
|
// The 12-byte info block the host reads with the 'b' command; flash-resident
|
||||||
// may override it): the whole EEPROM belongs to the application, and
|
// (there is no crt to copy a .data image).
|
||||||
// re-timing the loader is a bootloader self-update with a re-timed binary.
|
inline constexpr std::array<std::uint8_t, 12> info_data = {
|
||||||
#if !defined(PUREBOOT_TIMEOUT)
|
|
||||||
#define PUREBOOT_TIMEOUT 8
|
|
||||||
#endif
|
|
||||||
constexpr std::uint8_t timeout_seconds = PUREBOOT_TIMEOUT;
|
|
||||||
|
|
||||||
// The pureboot version: the loader's one identity number, carried in the info
|
|
||||||
// block so a host can tell a deployed loader apart from another. The wire
|
|
||||||
// protocol has no number of its own — a version implies its protocol, and the
|
|
||||||
// host tool is what holds that map (README.md).
|
|
||||||
constexpr std::uint8_t version = 2;
|
|
||||||
|
|
||||||
// The 12-byte info block the host reads with the 'b' command, flash-resident
|
|
||||||
// through flash_table (there is no crt to copy a .data image, and its storage
|
|
||||||
// carries the word alignment 'b' needs to halve the address on the large
|
|
||||||
// chips). The page byte is the wire count convention: 0 means 256.
|
|
||||||
inline constexpr avr::flash_table<std::array<std::uint8_t, 12>{
|
|
||||||
'P',
|
'P',
|
||||||
'B',
|
'B',
|
||||||
version, // magic, then the loader's version
|
1, // magic, protocol version
|
||||||
avr::hw::db.signature[0],
|
signature()[0],
|
||||||
avr::hw::db.signature[1],
|
signature()[1],
|
||||||
avr::hw::db.signature[2],
|
signature()[2],
|
||||||
static_cast<std::uint8_t>(page),
|
static_cast<std::uint8_t>(page),
|
||||||
wire_base & 0xff,
|
base & 0xff,
|
||||||
wire_base >> 8, // app flash ends here; resident loader base (a word address on large chips)
|
base >> 8, // app flash ends here; loader base
|
||||||
avr::hw::db.mem.eeprom_size & 0xff,
|
avr::hw::db.mem.eeprom_size & 0xff,
|
||||||
avr::hw::db.mem.eeprom_size >> 8,
|
avr::hw::db.mem.eeprom_size >> 8,
|
||||||
// bit 0: host must patch the reset vector (no hardware boot section);
|
boot_section ? 0 : 1, // bit 0: host must patch the reset vector (no hardware boot section)
|
||||||
// bit 1: flash wire addresses are word addresses
|
};
|
||||||
static_cast<std::uint8_t>((boot_section ? 0 : 1) | (word_flash ? 2 : 0)),
|
using info = avr::flash_table<info_data>;
|
||||||
}>
|
|
||||||
info_data;
|
|
||||||
|
|
||||||
// The serial link. PUREBOOT_USART forces a hardware USART instance,
|
// The serial link: the hardware USART where the chip has one, the polled
|
||||||
// PUREBOOT_SOFT_SERIAL the polled software UART (no vector — the table
|
// software UART (no vector — the table belongs to the application) on PB0/PB1
|
||||||
// belongs to the application) on PUREBOOT_RX/PUREBOOT_TX; with neither, the
|
// elsewhere. Both are class templates on the clock so only the selected
|
||||||
// chip's first USART where it has one and the software UART elsewhere. Both
|
// backend is ever instantiated. pending() is the cheap line test the
|
||||||
// are class templates on the clock so only the selected backend is ever
|
// activation window polls; rx() then picks the byte up.
|
||||||
// instantiated. pending() is the cheap line test the activation window
|
template <avr::hertz_t C>
|
||||||
// polls; rx() then picks the byte up; drain() holds until the last
|
consteval std::int16_t rxc_field()
|
||||||
// transmitted frame is fully on the wire (the jump hand-over must not let
|
{
|
||||||
// the target's re-init clip the ack).
|
return avr::hw::db.field_index("UCSR0A", "RXC0");
|
||||||
#if defined(PUREBOOT_SOFT_SERIAL) && defined(PUREBOOT_USART)
|
}
|
||||||
#error "PUREBOOT_SOFT_SERIAL and PUREBOOT_USART select opposing serial backends"
|
|
||||||
#endif
|
|
||||||
#if !defined(PUREBOOT_RX)
|
|
||||||
#define PUREBOOT_RX pb0
|
|
||||||
#endif
|
|
||||||
#if !defined(PUREBOOT_TX)
|
|
||||||
#define PUREBOOT_TX pb1
|
|
||||||
#endif
|
|
||||||
#if defined(PUREBOOT_USART)
|
|
||||||
constexpr char usart_digit = '0' + PUREBOOT_USART;
|
|
||||||
#else
|
|
||||||
constexpr char usart_digit = '0';
|
|
||||||
#endif
|
|
||||||
|
|
||||||
template <avr::hertz_t C>
|
template <avr::hertz_t C>
|
||||||
struct hardware_link {
|
struct hardware_link {
|
||||||
using uart = avr::uart::usart<usart_digit, C, {.baud = wire_baud, .max_baud_error = 2.5_pct}>;
|
using uart = avr::uart::usart0<C, {.baud = 115200_Bd, .max_baud_error = 2.5_pct}>;
|
||||||
|
|
||||||
// The compiled idle poll: lds UCSR0A (2), sbrc skipping the exit (2),
|
|
||||||
// sbiw + sbci + sbci + brne (6).
|
|
||||||
static constexpr std::uint8_t poll_cycles = 10;
|
|
||||||
|
|
||||||
static void init()
|
static void init()
|
||||||
{
|
{
|
||||||
@@ -159,7 +108,7 @@ struct hardware_link {
|
|||||||
|
|
||||||
static bool pending()
|
static bool pending()
|
||||||
{
|
{
|
||||||
return uart::rx_ready();
|
return avr::hw::field_impl<rxc_field<C>()>::test();
|
||||||
}
|
}
|
||||||
|
|
||||||
static std::uint8_t rx()
|
static std::uint8_t rx()
|
||||||
@@ -171,21 +120,12 @@ struct hardware_link {
|
|||||||
{
|
{
|
||||||
uart::write(byte);
|
uart::write(byte);
|
||||||
}
|
}
|
||||||
|
|
||||||
static void drain()
|
|
||||||
{
|
|
||||||
uart::drain();
|
|
||||||
}
|
|
||||||
};
|
};
|
||||||
|
|
||||||
template <avr::hertz_t C>
|
template <avr::hertz_t C>
|
||||||
struct software_link {
|
struct software_link {
|
||||||
using rx_t = avr::uart::software_rx_polled<C, avr::PUREBOOT_RX, wire_baud>;
|
using rx_t = avr::uart::software_rx_polled<C, avr::pb0, 57600_Bd>;
|
||||||
using tx_t = avr::uart::software_tx<C, avr::PUREBOOT_TX, wire_baud>;
|
using tx_t = avr::uart::software_tx<C, avr::pb1, 57600_Bd>;
|
||||||
|
|
||||||
// The compiled idle poll: sbis skipping the exit (2), sbiw + sbci +
|
|
||||||
// sbci + brne (6).
|
|
||||||
static constexpr std::uint8_t poll_cycles = 8;
|
|
||||||
|
|
||||||
static void init()
|
static void init()
|
||||||
{
|
{
|
||||||
@@ -194,7 +134,7 @@ struct software_link {
|
|||||||
|
|
||||||
static bool pending()
|
static bool pending()
|
||||||
{
|
{
|
||||||
return rx_t::start_pending();
|
return !avr::io::input<avr::pb0>::read(); // a start bit has begun
|
||||||
}
|
}
|
||||||
|
|
||||||
static std::uint8_t rx()
|
static std::uint8_t rx()
|
||||||
@@ -206,117 +146,74 @@ struct software_link {
|
|||||||
{
|
{
|
||||||
tx_t::template write<off>(byte);
|
tx_t::template write<off>(byte);
|
||||||
}
|
}
|
||||||
|
|
||||||
static void drain()
|
|
||||||
{
|
|
||||||
// The software transmitter returns only after the stop bit.
|
|
||||||
}
|
|
||||||
};
|
};
|
||||||
|
|
||||||
#if defined(PUREBOOT_USART)
|
using link = std::conditional_t<avr::hw::db.has_reg("UDR0"), hardware_link<dev::clock>, software_link<dev::clock>>;
|
||||||
static_assert(avr::uart::has_usart<usart_digit>(), "PUREBOOT_USART selects a hardware USART this chip does not have");
|
|
||||||
using link = hardware_link<dev::clock>;
|
|
||||||
#elif defined(PUREBOOT_SOFT_SERIAL)
|
|
||||||
using link = software_link<dev::clock>;
|
|
||||||
#else
|
|
||||||
using link =
|
|
||||||
std::conditional_t<avr::uart::has_usart<usart_digit>(), hardware_link<dev::clock>, software_link<dev::clock>>;
|
|
||||||
#endif
|
|
||||||
|
|
||||||
// The application's entry, an absolute address the linker pins (--defsym in
|
// The application's entry: the linker pins pureboot_app to 0x0000 on the
|
||||||
// CMakeLists.txt): 0x0000 on the mega (word 0 stays the application's own
|
// mega (reset re-vectors here through BOOTRST, so address 0 stays the
|
||||||
// vector — BOOTRST re-vectors a reset into the loader in hardware) and the
|
// application's own vector) and to the trampoline word at base - 2 on the
|
||||||
// trampoline word at base - 2 on the tinies. Reaching it must not depend on
|
// tinies (--defsym in CMakeLists.txt).
|
||||||
// where this copy runs, so the jump goes through a pointer: [[gnu::noipa]]
|
|
||||||
// keeps the constant from folding back into a PC-relative call.
|
|
||||||
extern "C" [[noreturn]] void pureboot_app();
|
extern "C" [[noreturn]] void pureboot_app();
|
||||||
|
|
||||||
[[gnu::noipa, noreturn]] void jump(void (*target)())
|
[[noreturn]] void run_app()
|
||||||
{
|
{
|
||||||
target();
|
pureboot_app();
|
||||||
__builtin_unreachable();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
[[gnu::noinline, noreturn]] void run_app()
|
// One activation tick is 65536 pending() polls — a pin (or flag) test plus a
|
||||||
|
// 16-bit countdown, about 8 cycles. Whole-second precision is all the
|
||||||
|
// timeout cell promises; the seconds count stays a loop bound (a runtime
|
||||||
|
// multiply would drag libgcc's __mulhi3 into the MUL-less tinies).
|
||||||
|
consteval std::uint16_t ticks_per_second()
|
||||||
{
|
{
|
||||||
jump(pureboot_app);
|
return static_cast<std::uint16_t>(dev::clock.hz / (65536ull * 8u));
|
||||||
}
|
}
|
||||||
|
static_assert(ticks_per_second() >= 1);
|
||||||
|
|
||||||
// One activation window is a single 32-bit poll countdown. The divisor is
|
bool pending_before(std::uint8_t seconds)
|
||||||
// the backend's counted poll-loop cycles (its own comment reads them off the
|
|
||||||
// compiled loop); whole-second precision is all the window promises, so the
|
|
||||||
// nearest cycle count is plenty.
|
|
||||||
consteval std::uint32_t window_polls()
|
|
||||||
{
|
{
|
||||||
return timeout_seconds * static_cast<std::uint32_t>(dev::clock.hz / link::poll_cycles);
|
do {
|
||||||
}
|
std::uint16_t ticks = ticks_per_second();
|
||||||
|
do {
|
||||||
bool pending_before_deadline()
|
std::uint16_t spins = 0; // wraps first, so 65536 polls per tick
|
||||||
{
|
|
||||||
std::uint32_t polls = window_polls();
|
|
||||||
do {
|
do {
|
||||||
if (link::pending())
|
if (link::pending())
|
||||||
return true;
|
return true;
|
||||||
} while (--polls);
|
} while (--spins);
|
||||||
|
} while (--ticks);
|
||||||
|
} while (--seconds);
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
// A knock byte under the activation deadline: an idle line means no host is
|
// A knock byte under the activation deadline: an idle line means no host is
|
||||||
// there, and the application runs.
|
// there, and the application runs.
|
||||||
std::uint8_t rx_deadline()
|
std::uint8_t rx_deadline(std::uint8_t seconds)
|
||||||
{
|
{
|
||||||
if (!pending_before_deadline())
|
if (!pending_before(seconds))
|
||||||
run_app();
|
run_app();
|
||||||
return link::rx();
|
return link::rx();
|
||||||
}
|
}
|
||||||
|
|
||||||
// Inlined into its call sites: reading two bytes across a call otherwise
|
std::uint16_t rx16()
|
||||||
// strands the first in a call-saved register the caller must push/pop; folded
|
|
||||||
// into the (noreturn) command loop that cost disappears.
|
|
||||||
[[gnu::always_inline]] inline std::uint16_t rx16()
|
|
||||||
{
|
{
|
||||||
std::uint16_t low = link::rx();
|
std::uint8_t low = link::rx();
|
||||||
return static_cast<std::uint16_t>(low | (link::rx() << 8));
|
return static_cast<std::uint16_t>(low | (link::rx() << 8));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const std::uint8_t *flash_ptr(std::uint16_t address)
|
||||||
|
{
|
||||||
|
return reinterpret_cast<const std::uint8_t *>(address);
|
||||||
|
}
|
||||||
|
|
||||||
// The streamers take the count in the wire's 8-bit form: 0 means 256.
|
// The streamers take the count in the wire's 8-bit form: 0 means 256.
|
||||||
//
|
void send_flash(std::uint16_t address, std::uint8_t count)
|
||||||
// Two functions, because they want opposite placement and placement is an
|
|
||||||
// attribute: the byte-addressed loop is small enough to inline into both
|
|
||||||
// callers, the word-addressed one stays out of line but flattened — a call to
|
|
||||||
// the transmit inside it would strand the 24-bit cursor in callee-saved
|
|
||||||
// registers. `word_flash` picks at the call site.
|
|
||||||
[[maybe_unused, gnu::always_inline]] inline void send_flash_near(std::uint16_t address, std::uint8_t count)
|
|
||||||
{
|
{
|
||||||
do
|
do
|
||||||
link::tx(avr::flash_load(reinterpret_cast<const std::uint8_t *>(address++)));
|
link::tx(avr::flash_load(flash_ptr(address++)));
|
||||||
while (--count);
|
while (--count);
|
||||||
}
|
}
|
||||||
|
|
||||||
// The 24-bit cursor as the machine holds it: the RAMPZ byte and a 16-bit Z,
|
|
||||||
// carried explicitly (the reassembled 32-bit address folds away inside the
|
|
||||||
// inlined far load).
|
|
||||||
[[maybe_unused, gnu::flatten, gnu::noinline]] void send_flash_far(std::uint16_t address, std::uint8_t count)
|
|
||||||
{
|
|
||||||
std::uint8_t rampz = static_cast<std::uint8_t>(address >> 15);
|
|
||||||
std::uint16_t z = static_cast<std::uint16_t>(address << 1);
|
|
||||||
do {
|
|
||||||
link::tx(avr::flash_load_far<std::uint8_t>((static_cast<std::uint32_t>(rampz) << 16) | z));
|
|
||||||
// The protocol never reads across 64 KiB, but carrying the wrap is
|
|
||||||
// smaller than the flat 32-bit cursor GCC builds without it.
|
|
||||||
if (++z == 0)
|
|
||||||
++rampz;
|
|
||||||
} while (--count);
|
|
||||||
}
|
|
||||||
|
|
||||||
[[gnu::always_inline]] inline void send_flash(std::uint16_t address, std::uint8_t count)
|
|
||||||
{
|
|
||||||
if constexpr (word_flash)
|
|
||||||
send_flash_far(address, count);
|
|
||||||
else
|
|
||||||
send_flash_near(address, count);
|
|
||||||
}
|
|
||||||
|
|
||||||
void send_eeprom(std::uint16_t address, std::uint8_t count)
|
void send_eeprom(std::uint16_t address, std::uint8_t count)
|
||||||
{
|
{
|
||||||
do
|
do
|
||||||
@@ -337,111 +234,51 @@ void store_eeprom(std::uint16_t address, std::uint8_t count)
|
|||||||
}
|
}
|
||||||
|
|
||||||
// One flash page: stream the bytes into the SPM buffer as little-endian
|
// One flash page: stream the bytes into the SPM buffer as little-endian
|
||||||
// words, then erase and program — except the 512-byte slot this code runs
|
// words, then erase and program. Addresses in the loader's own 512 bytes
|
||||||
// in, which is drained but never programmed, so a copy can never erase
|
// are drained but never programmed — a broken host cannot brick the chip.
|
||||||
// itself. `slot_high` is the high byte of that running slot's base (run()
|
// On the mega the RWW section is re-enabled so reads work immediately.
|
||||||
// derives it); a broken host thus cannot brick the running loader, and a
|
void program_flash(std::uint16_t address)
|
||||||
// copy flashed one slot lower may rewrite the slot above it — how pureboot
|
|
||||||
// updates itself.
|
|
||||||
void program_flash(std::uint16_t wire_address, std::uint8_t slot_high)
|
|
||||||
{
|
{
|
||||||
// No discard before the fill: the buffer is write-once per word
|
for (std::uint16_t i = 0; i < page; i += 2) {
|
||||||
// (§26.2.1), so filling over one a refused page or an application left
|
|
||||||
// dirty programs stale words — but a page write auto-erases the buffer
|
|
||||||
// (§26.2.1; §19.2 on the tinies), so that write clears the condition and
|
|
||||||
// the host's read-back rewrites the page.
|
|
||||||
|
|
||||||
// One induction either way. On the byte-addressed chips the wire address
|
|
||||||
// itself walks the page (aligned, so the offset bits wrap to zero); on
|
|
||||||
// the word-addressed large chips the wire word address becomes a 32-bit
|
|
||||||
// byte cursor once, and their 256-byte page makes its low byte the whole
|
|
||||||
// in-page offset. The slot index is one high byte of the wire address —
|
|
||||||
// two values on byte-addressed chips (the & ~1), bits 16:9 re-packed on
|
|
||||||
// the large ones.
|
|
||||||
spm::flash_address_t address;
|
|
||||||
std::uint8_t page_high;
|
|
||||||
if constexpr (word_flash) {
|
|
||||||
// Pages are aligned, so one page never crosses a 64 KiB boundary:
|
|
||||||
// RAMPZ is a per-page constant and the fill cursor is a 16-bit Z
|
|
||||||
// whose low byte is the whole in-page offset (256-byte pages). The
|
|
||||||
// slot index is simply the wire word address's high byte.
|
|
||||||
const std::uint8_t rampz = static_cast<std::uint8_t>(wire_address >> 15);
|
|
||||||
const std::uint16_t z0 = static_cast<std::uint16_t>(wire_address << 1);
|
|
||||||
std::uint16_t z = z0;
|
|
||||||
do {
|
|
||||||
std::uint8_t low = link::rx();
|
std::uint8_t low = link::rx();
|
||||||
std::uint8_t high = link::rx();
|
std::uint8_t high = link::rx();
|
||||||
spm::fill<off>((static_cast<spm::flash_address_t>(rampz) << 16) | z,
|
spm::fill<off>(address + i, static_cast<std::uint16_t>(low | (high << 8)));
|
||||||
static_cast<std::uint16_t>(low | (high << 8)));
|
|
||||||
z += 2;
|
|
||||||
} while (static_cast<std::uint8_t>(z));
|
|
||||||
address = (static_cast<spm::flash_address_t>(rampz) << 16) | z0;
|
|
||||||
page_high = static_cast<std::uint8_t>(wire_address >> 8) & 0xfe;
|
|
||||||
} else {
|
|
||||||
address = static_cast<spm::flash_address_t>(wire_address);
|
|
||||||
do {
|
|
||||||
std::uint8_t low = link::rx();
|
|
||||||
std::uint8_t high = link::rx();
|
|
||||||
spm::fill<off>(address, static_cast<std::uint16_t>(low | (high << 8)));
|
|
||||||
address += 2;
|
|
||||||
} while (static_cast<std::uint8_t>(address) & (page - 1));
|
|
||||||
address -= 2; // back inside the page — erase and write ignore the word bits
|
|
||||||
page_high = static_cast<std::uint8_t>(address >> 8) & 0xfe;
|
|
||||||
}
|
}
|
||||||
if (page_high != slot_high) {
|
if (address < base) {
|
||||||
// The tinies and the m48s halt the CPU through the erase and the
|
|
||||||
// write, so only the boot-sectioned megas — running on while their
|
|
||||||
// RWW section programs — wait.
|
|
||||||
spm::erase_page<off>(address);
|
spm::erase_page<off>(address);
|
||||||
if constexpr (boot_section)
|
|
||||||
spm::wait();
|
spm::wait();
|
||||||
spm::write_page<off>(address);
|
spm::write_page<off>(address);
|
||||||
if constexpr (boot_section)
|
|
||||||
spm::wait();
|
spm::wait();
|
||||||
}
|
|
||||||
// The megas program with their RWW section disabled; reads need it back
|
|
||||||
// on. The same store discards the buffer (§26.2.2), so they never meet
|
|
||||||
// the stale-word case above. boot_section implies an RWW section.
|
|
||||||
if constexpr (boot_section)
|
if constexpr (boot_section)
|
||||||
spm::rww_enable<off>();
|
spm::rww_enable<off>();
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// The four fuse/lock bytes in the hardware's own Z order: low, lock,
|
// The four fuse/lock bytes in the hardware's own Z order: low, lock,
|
||||||
// extended, high. Writing fuses is not a thing self-programming can do on
|
// extended, high. Writing fuses is not a thing self-programming can do on
|
||||||
// AVR — SPM reaches flash (and boot lock bits) only.
|
// AVR — SPM reaches flash (and boot lock bits) only.
|
||||||
void send_fuses()
|
void send_fuses()
|
||||||
{
|
{
|
||||||
std::uint8_t which = 0;
|
for (std::uint8_t which = 0; which < 4; ++which)
|
||||||
do
|
|
||||||
link::tx(spm::read_fuse<off>(static_cast<spm::fuse>(which)));
|
link::tx(spm::read_fuse<off>(static_cast<spm::fuse>(which)));
|
||||||
while (++which & 3);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
[[noreturn]] void run()
|
[[noreturn]] void run()
|
||||||
{
|
{
|
||||||
// A watchdog reset belongs to the application (whose watchdog stays
|
// A watchdog reset belongs to the application (whose watchdog stays
|
||||||
// forced on until it clears WDRF) — no activation window in its way.
|
// forced on until it clears WDRF) — no activation window in its way.
|
||||||
// The flag register is MCUSR, or the classic megas' MCUCSR.
|
if (avr::hw::mcusr::wdrf.test())
|
||||||
if (avr::hw::field_impl<wdrf_field()>::test())
|
|
||||||
run_app();
|
run_app();
|
||||||
|
|
||||||
link::init();
|
link::init();
|
||||||
|
|
||||||
// The high byte of the 512-byte-aligned base this copy runs at: the
|
std::uint8_t seconds = ee::read(timeout_cell);
|
||||||
// return address is a word address, whose high byte is the 256-word slot
|
if (seconds == 0 || seconds == 0xff)
|
||||||
// index — on byte-addressed chips doubled back into byte terms.
|
seconds = default_seconds;
|
||||||
// program_flash refuses this one slot and the info block is addressed
|
|
||||||
// from it, so both follow wherever the code was flashed. The high byte is
|
|
||||||
// spelled as byteswap's low byte: the builtin's value is itself built by
|
|
||||||
// swapping the two stacked bytes, and the double swap folds to the single
|
|
||||||
// byte pick a hand assembler writes — `>> 8` leaves the swap materialized.
|
|
||||||
const std::uint16_t ra_words = reinterpret_cast<std::uint16_t>(__builtin_return_address(0));
|
|
||||||
const std::uint8_t ra_high = static_cast<std::uint8_t>(std::byteswap(ra_words));
|
|
||||||
const std::uint8_t slot_high = word_flash ? ra_high & 0xfe : static_cast<std::uint8_t>(ra_high << 1);
|
|
||||||
|
|
||||||
// The knock: 'p' then 'b', each under a fresh window; any other byte is
|
// The knock: 'p' then 'b', each under a fresh window; any other byte is
|
||||||
// line noise and waits again. Falling out of a window runs the app.
|
// line noise and waits again. Falling out of a window runs the app.
|
||||||
while (rx_deadline() != 'p' || rx_deadline() != 'b') {
|
while (rx_deadline(seconds) != 'p' || rx_deadline(seconds) != 'b') {
|
||||||
}
|
}
|
||||||
|
|
||||||
for (;;) {
|
for (;;) {
|
||||||
@@ -449,47 +286,34 @@ void send_fuses()
|
|||||||
// and fuse reads (§26.2.1), and the ack tells the host all is done.
|
// and fuse reads (§26.2.1), and the ack tells the host all is done.
|
||||||
ee::wait();
|
ee::wait();
|
||||||
link::tx(ack);
|
link::tx(ack);
|
||||||
const std::uint8_t command = link::rx();
|
switch (link::rx()) {
|
||||||
switch (command) {
|
case 'b': // info block
|
||||||
case 'b': { // info block, read relative to the running slot
|
send_flash(reinterpret_cast<std::uint16_t>(info::storage.data()), info::size());
|
||||||
// The block sits in the image's first 256 bytes (the build lint
|
|
||||||
// asserts it), and slots are 512-aligned — so the low byte of its
|
|
||||||
// link address (in wire units: bytes, or words on the large
|
|
||||||
// chips) is its offset in any slot, and the high byte of its
|
|
||||||
// runtime address is the running slot's. Composed from the two
|
|
||||||
// bytes — the high half is runtime data, so no absolute address
|
|
||||||
// is ever materialized.
|
|
||||||
const auto link_low = reinterpret_cast<std::uint16_t>(info_data.storage.data());
|
|
||||||
const std::uint8_t low =
|
|
||||||
word_flash ? static_cast<std::uint8_t>(link_low >> 1) : static_cast<std::uint8_t>(link_low);
|
|
||||||
send_flash(static_cast<std::uint16_t>(low | (slot_high << 8)), static_cast<std::uint8_t>(info_data.size()));
|
|
||||||
break;
|
break;
|
||||||
}
|
case 'R': { // read flash: addr16, n8 (0 = 256)
|
||||||
case 'J': { // jump to a wire word address: hand-over and staging transfer
|
|
||||||
auto target = reinterpret_cast<void (*)()>(rx16());
|
|
||||||
link::tx(ack);
|
|
||||||
link::drain();
|
|
||||||
jump(target);
|
|
||||||
}
|
|
||||||
case 'R': // read flash: addr16, n8 (0 = 256)
|
|
||||||
case 'r': // read EEPROM: addr16, n8
|
|
||||||
case 'w': { // write EEPROM: addr16, n8, then n bytes each acked
|
|
||||||
std::uint16_t address = rx16();
|
std::uint16_t address = rx16();
|
||||||
std::uint8_t count = link::rx();
|
send_flash(address, link::rx());
|
||||||
if (command == 'R')
|
|
||||||
send_flash(address, count);
|
|
||||||
else if (command == 'r')
|
|
||||||
send_eeprom(address, count);
|
|
||||||
else
|
|
||||||
store_eeprom(address, count);
|
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
case 'W': // program one flash page: addr16, page bytes
|
case 'W': // program one flash page: addr16, page bytes
|
||||||
program_flash(rx16(), slot_high);
|
program_flash(rx16());
|
||||||
break;
|
break;
|
||||||
|
case 'r': { // read EEPROM: addr16, n8
|
||||||
|
std::uint16_t address = rx16();
|
||||||
|
send_eeprom(address, link::rx());
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
case 'w': { // write EEPROM: addr16, n8, then n bytes each acked
|
||||||
|
std::uint16_t address = rx16();
|
||||||
|
store_eeprom(address, link::rx());
|
||||||
|
break;
|
||||||
|
}
|
||||||
case 'F': // fuse and lock bytes
|
case 'F': // fuse and lock bytes
|
||||||
send_fuses();
|
send_fuses();
|
||||||
break;
|
break;
|
||||||
|
case 'G': // hand over to the application
|
||||||
|
link::tx(ack);
|
||||||
|
run_app();
|
||||||
default: // unknown bytes are ignored; the loop re-acks
|
default: // unknown bytes are ignored; the loop re-acks
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -1,54 +0,0 @@
|
|||||||
#!/usr/bin/env python3
|
|
||||||
"""Position-independence lint for the pureboot image.
|
|
||||||
|
|
||||||
The self-staging design lets the identical binary run from any 512-byte
|
|
||||||
slot, which holds only if nothing in the image addresses itself absolutely.
|
|
||||||
Two link-time facts guarantee it, both asserted here from the built ELF:
|
|
||||||
|
|
||||||
1. No absolute jmp/call opcodes — all control flow is PC-relative
|
|
||||||
(rjmp/rcall/ijmp/icall). -mrelax normally guarantees this; a code
|
|
||||||
change that grows a branch out of relaxation range would break it
|
|
||||||
silently.
|
|
||||||
2. The info block sits within the image's first 256 bytes: the 'b'
|
|
||||||
command rebuilds its address as (running slot high byte : low byte of
|
|
||||||
the link address), which needs the offset to fit that low byte.
|
|
||||||
|
|
||||||
Usage: check_pi.py <objdump> <nm> <elf> <text_start_hex>
|
|
||||||
"""
|
|
||||||
|
|
||||||
import re
|
|
||||||
import subprocess
|
|
||||||
import sys
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
objdump, nm, elf, text_start = sys.argv[1:]
|
|
||||||
text_start = int(text_start, 0)
|
|
||||||
|
|
||||||
listing = subprocess.run([objdump, "-d", elf], capture_output=True, text=True, check=True).stdout
|
|
||||||
absolute = [
|
|
||||||
line
|
|
||||||
for line in listing.splitlines()
|
|
||||||
if re.search(r"\t(jmp|call)\t", line)
|
|
||||||
]
|
|
||||||
if absolute:
|
|
||||||
print("FAIL: absolute control flow in the image:")
|
|
||||||
print("\n".join(absolute))
|
|
||||||
sys.exit(1)
|
|
||||||
|
|
||||||
symbols = subprocess.run([nm, "-C", elf], capture_output=True, text=True, check=True).stdout
|
|
||||||
info = [line for line in symbols.splitlines() if "flash_table" in line and "::storage" in line]
|
|
||||||
if len(info) != 1:
|
|
||||||
print(f"FAIL: expected one info-block storage symbol, found {len(info)}")
|
|
||||||
sys.exit(1)
|
|
||||||
address = int(info[0].split()[0], 16)
|
|
||||||
offset = address - text_start
|
|
||||||
if not 0 <= offset < 256:
|
|
||||||
print(f"FAIL: info block at image offset {offset:#x}, must sit in the first 256 bytes")
|
|
||||||
sys.exit(1)
|
|
||||||
|
|
||||||
print(f"PI lint: control flow PC-relative, info block at offset {offset:#x}")
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
@@ -1,19 +1,8 @@
|
|||||||
// Test-fixture application for the pureboot protocol tests: prints "APP" on
|
// Test-fixture application for the pureboot protocol test: prints "APP" on
|
||||||
// the chip's serial link (the same link the loader uses) — the proof that
|
// the chip's serial link (the same link the loader uses) and idles — the
|
||||||
// the loader's hand-over, and on the tinies the host's reset-vector
|
// proof that the loader's hand-over, and on the tinies the host's
|
||||||
// surgery, actually launched it. Linked normally (crt, vectors at 0); on
|
// reset-vector surgery, actually launched it. Linked normally (crt, vectors
|
||||||
// the tinies its reset vector is the rjmp the host re-homes.
|
// at 0); on the tinies its reset vector is the rjmp the host re-homes.
|
||||||
//
|
|
||||||
// On the hardware-USART link it then listens, and an 'L' makes it jump into
|
|
||||||
// the resident loader — the application-owned loader entry a
|
|
||||||
// BOOTRST-unprogrammed mega relies on (reset always boots the application
|
|
||||||
// there), exercised by the self-update tests. The software link idles:
|
|
||||||
// reset reaches those loaders through the patched vector (or the runner
|
|
||||||
// models BOOTRST), so the application owes them nothing.
|
|
||||||
//
|
|
||||||
// The fixture speaks the deployment its loader was built for: the same
|
|
||||||
// PUREBOOT_* defines configure it, and without them it assumes the stock
|
|
||||||
// deployment (the crystal/RC clock table below, the chip's natural link).
|
|
||||||
#include <libavr/libavr.hpp>
|
#include <libavr/libavr.hpp>
|
||||||
|
|
||||||
using namespace avr::literals;
|
using namespace avr::literals;
|
||||||
@@ -22,85 +11,31 @@ namespace {
|
|||||||
|
|
||||||
consteval avr::hertz_t clock()
|
consteval avr::hertz_t clock()
|
||||||
{
|
{
|
||||||
#if defined(PUREBOOT_CLOCK_HZ)
|
if (avr::hw::db.name == "ATtiny13A")
|
||||||
return avr::hertz_t{PUREBOOT_CLOCK_HZ};
|
|
||||||
#else
|
|
||||||
auto name = std::string_view{avr::hw::db.name};
|
|
||||||
if (name.starts_with("ATtiny13"))
|
|
||||||
return 9.6_MHz;
|
return 9.6_MHz;
|
||||||
if (name.starts_with("ATtiny"))
|
if (avr::hw::db.name == "ATtiny85")
|
||||||
return 8_MHz;
|
return 8_MHz;
|
||||||
return 16_MHz;
|
return 16_MHz;
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
#if !defined(PUREBOOT_TX)
|
|
||||||
#define PUREBOOT_TX pb1
|
|
||||||
#endif
|
|
||||||
#if !defined(PUREBOOT_USART)
|
|
||||||
#define PUREBOOT_USART 0
|
|
||||||
#endif
|
|
||||||
|
|
||||||
consteval bool use_hardware()
|
|
||||||
{
|
|
||||||
#if defined(PUREBOOT_SOFT_SERIAL)
|
|
||||||
return false;
|
|
||||||
#else
|
|
||||||
return avr::hw::db.has_instance("USART0") || avr::hw::db.has_instance("USART");
|
|
||||||
#endif
|
|
||||||
}
|
}
|
||||||
|
|
||||||
using dev = avr::device<{.clock = clock()}>;
|
using dev = avr::device<{.clock = clock()}>;
|
||||||
|
|
||||||
template <avr::hertz_t C, bool Hardware = use_hardware()>
|
template <avr::hertz_t C, bool Hardware = avr::hw::db.has_reg("UDR0")>
|
||||||
struct link {
|
struct link {
|
||||||
#if defined(PUREBOOT_BAUD)
|
using tx_t = avr::uart::usart0<C, {.baud = 115200_Bd, .max_baud_error = 2.5_pct}>;
|
||||||
static constexpr avr::baud_t baud{PUREBOOT_BAUD};
|
|
||||||
#else
|
|
||||||
static constexpr avr::baud_t baud{115200};
|
|
||||||
#endif
|
|
||||||
using tx_t = avr::uart::usart<'0' + PUREBOOT_USART, C, {.baud = baud, .max_baud_error = 2.5_pct}>;
|
|
||||||
static void tx(char c)
|
static void tx(char c)
|
||||||
{
|
{
|
||||||
tx_t::write(static_cast<std::uint8_t>(c));
|
tx_t::write(static_cast<std::uint8_t>(c));
|
||||||
}
|
}
|
||||||
[[noreturn]] static void idle()
|
|
||||||
{
|
|
||||||
// 'L' hands back to the loader at the top slot — 512 bytes, or the
|
|
||||||
// 1 KiB the >64 KiB chips use.
|
|
||||||
constexpr std::uint32_t slot = avr::hw::db.mem.flash_size > 65536 ? 1024 : 512;
|
|
||||||
for (;;) {
|
|
||||||
auto command = tx_t::read_blocking();
|
|
||||||
if (command == 'L')
|
|
||||||
reinterpret_cast<void (*)()>(static_cast<std::uint16_t>((avr::hw::db.mem.flash_size - slot) / 2))();
|
|
||||||
// 'D' leaves every word of the SPM page buffer dirty, so that a
|
|
||||||
// following 'L' enters the loader with the buffer it never clears.
|
|
||||||
if (command == 'D') {
|
|
||||||
for (std::uint16_t at = 0; at < avr::spm::page_bytes; at += 2)
|
|
||||||
avr::spm::fill(at, 0xdead);
|
|
||||||
tx('D');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
};
|
};
|
||||||
|
|
||||||
template <avr::hertz_t C>
|
template <avr::hertz_t C>
|
||||||
struct link<C, false> {
|
struct link<C, false> {
|
||||||
#if defined(PUREBOOT_BAUD)
|
using tx_t = avr::uart::software_tx<C, avr::pb1, 57600_Bd>;
|
||||||
static constexpr avr::baud_t baud{PUREBOOT_BAUD};
|
|
||||||
#else
|
|
||||||
static constexpr avr::baud_t baud{57600};
|
|
||||||
#endif
|
|
||||||
using tx_t = avr::uart::software_tx<C, avr::PUREBOOT_TX, baud>;
|
|
||||||
static void tx(char c)
|
static void tx(char c)
|
||||||
{
|
{
|
||||||
tx_t::write(static_cast<std::uint8_t>(c));
|
tx_t::write(static_cast<std::uint8_t>(c));
|
||||||
}
|
}
|
||||||
[[noreturn]] static void idle()
|
|
||||||
{
|
|
||||||
while (true) {
|
|
||||||
}
|
|
||||||
}
|
|
||||||
};
|
};
|
||||||
|
|
||||||
} // namespace
|
} // namespace
|
||||||
@@ -111,5 +46,6 @@ int main()
|
|||||||
link<dev::clock>::tx('A');
|
link<dev::clock>::tx('A');
|
||||||
link<dev::clock>::tx('P');
|
link<dev::clock>::tx('P');
|
||||||
link<dev::clock>::tx('P');
|
link<dev::clock>::tx('P');
|
||||||
link<dev::clock>::idle();
|
while (true) {
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,90 +0,0 @@
|
|||||||
#!/usr/bin/env python3
|
|
||||||
"""Dirty-page-buffer acceptance test: the loader carries no buffer discard,
|
|
||||||
so a page filled over words an earlier writer left behind programs those
|
|
||||||
instead. This asserts the whole contract — the corruption is real and a bare
|
|
||||||
verify sees it, the repairing verify fixes it in one rewrite (the write that
|
|
||||||
took the stale words auto-erased the buffer), and it stays fixed.
|
|
||||||
|
|
||||||
The state is reached the way the loader cannot prevent: an application
|
|
||||||
dirties the buffer and jumps in with no reset between. Real boot-sectioned
|
|
||||||
megas forbid that outright — SPM executes only from the boot section
|
|
||||||
(Atmel-8271 §26.2) — but simavr dispatches SPM from anywhere, which is what
|
|
||||||
makes the path constructible at all.
|
|
||||||
|
|
||||||
Usage: pbdirty.py <device_bin> <pureboot_elf> <mcu> <hz> <base_hex> <page>
|
|
||||||
<baud> <app_bin> <tool_py> <workdir>
|
|
||||||
"""
|
|
||||||
|
|
||||||
import os
|
|
||||||
import sys
|
|
||||||
|
|
||||||
|
|
||||||
def fail(message):
|
|
||||||
print(f"FAIL: {message}")
|
|
||||||
sys.exit(1)
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
device_bin, elf, mcu, hz, base_hex, page, baud, app_bin, tool, workdir = sys.argv[1:]
|
|
||||||
page, baud = int(page), int(baud)
|
|
||||||
sys.path.insert(0, os.path.dirname(os.path.abspath(tool)))
|
|
||||||
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
|
|
||||||
import pbsim
|
|
||||||
import pureboot as pb
|
|
||||||
|
|
||||||
os.makedirs(workdir, exist_ok=True)
|
|
||||||
dump = os.path.join(workdir, "dump.bin")
|
|
||||||
|
|
||||||
# Reset boots the application on a BOOTRST-unprogrammed mega; its 'L' is
|
|
||||||
# the loader entry this test needs, reached without a reset.
|
|
||||||
device = pbsim.Device(device_bin, elf, mcu, hz, base_hex, page, baud, dump, reset_hex="0")
|
|
||||||
try:
|
|
||||||
port = pb.Port(device.pty, baud)
|
|
||||||
loader = pb.Loader(port)
|
|
||||||
loader.connect(25)
|
|
||||||
|
|
||||||
# Install the application and hand over to it.
|
|
||||||
pb.op_flash(loader, app_bin, erase=False, verify=True)
|
|
||||||
loader.run_application()
|
|
||||||
if port.read_exact(3, 5.0) != b"APP":
|
|
||||||
fail("the application did not start")
|
|
||||||
|
|
||||||
port.write(b"D")
|
|
||||||
if port.read_exact(1, 5.0) != b"D":
|
|
||||||
fail("the application did not acknowledge dirtying the page buffer")
|
|
||||||
port.write(b"L")
|
|
||||||
loader = pb.Loader(port)
|
|
||||||
loader.connect(25)
|
|
||||||
|
|
||||||
# Program by hand, so the corruption is observable before anything
|
|
||||||
# repairs it.
|
|
||||||
pages = pb.plan_flash(open(app_bin, "rb").read(), loader.info)
|
|
||||||
for address in sorted(pages):
|
|
||||||
loader.write_page(address, pages[address])
|
|
||||||
try:
|
|
||||||
pb.verify_pages(loader, pages)
|
|
||||||
except pb.Error as error:
|
|
||||||
if "verify failed" not in str(error):
|
|
||||||
fail(f"the read-back failed, but not at verify: {error}")
|
|
||||||
else:
|
|
||||||
# Either the fixture no longer dirties the buffer, or the loader
|
|
||||||
# clears it again — in which case this test's premise is gone.
|
|
||||||
fail("programming over a dirty page buffer came back clean")
|
|
||||||
|
|
||||||
# What the programming path uses: one rewrite settles it, and it stays
|
|
||||||
# settled.
|
|
||||||
pb.verify_pages(loader, pages, repair=True)
|
|
||||||
pb.verify_pages(loader, pages)
|
|
||||||
|
|
||||||
# Ground truth beyond the loader's own read-back.
|
|
||||||
loader.run_application()
|
|
||||||
if port.read_exact(3, 5.0) != b"APP":
|
|
||||||
fail("the application did not start after the recovered write")
|
|
||||||
port.close()
|
|
||||||
finally:
|
|
||||||
device.stop()
|
|
||||||
print("pbdirty: a dirty page buffer is caught by verify and cleared by the retry")
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
102
test/pbrehome.py
102
test/pbrehome.py
@@ -1,102 +0,0 @@
|
|||||||
#!/usr/bin/env python3
|
|
||||||
"""Re-homing acceptance test: a pureboot image programmed somewhere other
|
|
||||||
than its canonical top slot must still be a working loader —
|
|
||||||
position-independent, guarding its accidental slot — and the ordinary
|
|
||||||
--update-loader flow must put a build into the top slot from there.
|
|
||||||
|
|
||||||
Two positions are exercised. Address 0 (a raw .bin handed to a programmer,
|
|
||||||
which defaults to offset 0): the staging install and the word-0 redirect
|
|
||||||
both run from copies whose slots are not page 0's, so the running-slot
|
|
||||||
guard never blocks the flow. The staging slot itself: a loader already
|
|
||||||
sitting there IS the installed staging copy — the tool recognizes it by
|
|
||||||
its embedded info block and leaves it in place instead of tripping the
|
|
||||||
copy's own guard on the composed through-word — and that (older) copy
|
|
||||||
streams the new resident like any staged copy. In both cases flashing an
|
|
||||||
application through the healed resident overwrites the stale copy, vector
|
|
||||||
surgery included, and the banner proves the launch.
|
|
||||||
|
|
||||||
Usage: pbrehome.py <device_bin> <pureboot_elf> <update_bin> <mcu> <hz>
|
|
||||||
<base_hex> <page> <baud> <app_bin> <tool_py> <workdir>
|
|
||||||
"""
|
|
||||||
|
|
||||||
import os
|
|
||||||
import sys
|
|
||||||
|
|
||||||
|
|
||||||
def fail(message):
|
|
||||||
print(f"FAIL: {message}")
|
|
||||||
sys.exit(1)
|
|
||||||
|
|
||||||
|
|
||||||
def rehome_from(pbsim, pb, device_bin, elf, place_hex, guard_probe, update_bin, base, page, baud, app_bin, workdir,
|
|
||||||
mcu, hz):
|
|
||||||
"""Place the loader at `place_hex`, heal through --update-loader, flash
|
|
||||||
the application, expect the banner."""
|
|
||||||
dump = os.path.join(workdir, f"dump-{place_hex}.bin")
|
|
||||||
state = os.path.join(workdir, f"rehome-{place_hex}.pbstate")
|
|
||||||
if os.path.exists(state):
|
|
||||||
os.unlink(state)
|
|
||||||
device = pbsim.Device(device_bin, elf, mcu, hz, place_hex, page, baud, dump, reset_hex="0")
|
|
||||||
try:
|
|
||||||
port = pb.Port(device.pty, baud)
|
|
||||||
loader = pb.Loader(port)
|
|
||||||
info = loader.connect(25)
|
|
||||||
if info.base != base:
|
|
||||||
fail(f"the misplaced copy reports base {info.base:#06x} — the info block must stay canonical")
|
|
||||||
|
|
||||||
# The accidental slot still guards itself; re-homing rides on the
|
|
||||||
# canonical slots being writable from it.
|
|
||||||
probe = int(guard_probe, 0)
|
|
||||||
before = loader.read_flash(probe, info.page)
|
|
||||||
loader.write_page(probe, bytes(info.page))
|
|
||||||
if loader.read_flash(probe, info.page) != before:
|
|
||||||
fail("the misplaced copy's guard let its own slot change")
|
|
||||||
|
|
||||||
# The ordinary update flow puts the build into the top slot.
|
|
||||||
pb.op_update_loader(loader, 25, update_bin, state, None)
|
|
||||||
update = open(update_bin, "rb").read()
|
|
||||||
if loader.read_flash(base, len(update)) != update:
|
|
||||||
fail("the canonical slot does not hold the update image")
|
|
||||||
|
|
||||||
# An application flashed through the healed resident overwrites the
|
|
||||||
# stale copy (surgery included) and launches.
|
|
||||||
pages = pb.plan_flash(open(app_bin, "rb").read(), loader.info)
|
|
||||||
for address in pb.covered(pages, loader.info, skip_blank=False):
|
|
||||||
loader.write_page(address, pages[address])
|
|
||||||
pb.verify_pages(loader, pages)
|
|
||||||
loader.run_application()
|
|
||||||
if port.read_exact(3, 5.0) != b"APP":
|
|
||||||
fail(f"application does not banner after the re-home from {place_hex}")
|
|
||||||
port.close()
|
|
||||||
finally:
|
|
||||||
device.stop()
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
(device_bin, elf, update_bin, mcu, hz, base_hex, page, baud, app_bin, tool, workdir) = sys.argv[1:]
|
|
||||||
base, page, baud = int(base_hex, 0), int(page), int(baud)
|
|
||||||
sys.path.insert(0, os.path.dirname(os.path.abspath(tool)))
|
|
||||||
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
|
|
||||||
import pbsim
|
|
||||||
import pureboot as pb
|
|
||||||
|
|
||||||
os.makedirs(workdir, exist_ok=True)
|
|
||||||
|
|
||||||
# Address 0: the raw-.bin-to-a-programmer accident. The guard probe is
|
|
||||||
# the copy's own page 0.
|
|
||||||
rehome_from(pbsim, pb, device_bin, elf, "0x0", "0x0", update_bin, base, page, baud, app_bin, workdir, mcu, hz)
|
|
||||||
print("re-home from address 0: converged")
|
|
||||||
|
|
||||||
# The staging slot: erased flash with the loader sitting exactly where
|
|
||||||
# a staging copy would — the tool must leave it in place and let it
|
|
||||||
# stream the (different) update build into the resident slot.
|
|
||||||
stage = base - 512
|
|
||||||
rehome_from(pbsim, pb, device_bin, elf, hex(stage), hex(stage), update_bin, base, page, baud, app_bin, workdir,
|
|
||||||
mcu, hz)
|
|
||||||
print("re-home from the staging slot: converged")
|
|
||||||
|
|
||||||
print("pbrehome: a misplaced loader re-homes through the ordinary update flow")
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
@@ -1,98 +0,0 @@
|
|||||||
#!/usr/bin/env python3
|
|
||||||
"""Position-independence acceptance test: the identical pureboot binary,
|
|
||||||
flashed one slot below the resident loader, must serve the complete command
|
|
||||||
set from there. The resident installs it (through-word composed by the host
|
|
||||||
layer), 'J' transfers control, and every command is exercised against the
|
|
||||||
staged copy — the info block must come back byte-identical, the write guard
|
|
||||||
must protect the staged copy's own slot and permit the resident's, and the
|
|
||||||
staged copy must be able to rewrite the resident slot verbatim.
|
|
||||||
|
|
||||||
Usage: pbreloc.py <device_bin> <pureboot_elf> <mcu> <hz> <base_hex> <page>
|
|
||||||
<baud> <tool_py> <workdir>
|
|
||||||
"""
|
|
||||||
|
|
||||||
import os
|
|
||||||
import subprocess
|
|
||||||
import sys
|
|
||||||
|
|
||||||
|
|
||||||
def fail(message):
|
|
||||||
print(f"FAIL: {message}")
|
|
||||||
sys.exit(1)
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
device_bin, elf, mcu, hz, base_hex, page, baud, tool, workdir = sys.argv[1:]
|
|
||||||
base, page, baud = int(base_hex, 0), int(page), int(baud)
|
|
||||||
stage = None # derived from the device's own info (slot-sized) below
|
|
||||||
sys.path.insert(0, os.path.dirname(os.path.abspath(tool)))
|
|
||||||
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
|
|
||||||
import pbsim
|
|
||||||
import pureboot as pb
|
|
||||||
|
|
||||||
os.makedirs(workdir, exist_ok=True)
|
|
||||||
objcopy = os.environ.get("PB_OBJCOPY", "avr-objcopy")
|
|
||||||
image_path = os.path.join(workdir, "pureboot.bin")
|
|
||||||
subprocess.run([objcopy, "-O", "binary", elf, image_path], check=True)
|
|
||||||
image = open(image_path, "rb").read()
|
|
||||||
|
|
||||||
device = pbsim.Device(device_bin, elf, mcu, hz, base_hex, page, baud, os.path.join(workdir, "dump.bin"))
|
|
||||||
try:
|
|
||||||
port = pb.Port(device.pty, baud)
|
|
||||||
loader = pb.Loader(port)
|
|
||||||
info = loader.connect(25)
|
|
||||||
if info.base != base:
|
|
||||||
fail(f"info reports base {info.base:#06x}")
|
|
||||||
resident_info = info.raw
|
|
||||||
|
|
||||||
# Install the staging copy exactly as the update flow would.
|
|
||||||
stage = info.stage
|
|
||||||
staged = pb.staging_content(image, info)
|
|
||||||
pb.write_differing(loader, stage, staged)
|
|
||||||
|
|
||||||
# Enter it; from here on, every command runs in the relocated copy.
|
|
||||||
staged_info = loader.enter_copy(stage, 25)
|
|
||||||
if staged_info.raw != resident_info:
|
|
||||||
fail(f"staged info {staged_info.raw.hex()} != resident info {resident_info.hex()}")
|
|
||||||
|
|
||||||
# 'R' from the staged copy already proved itself in the install
|
|
||||||
# verify; 'F' must answer 4 bytes (values are unmodeled in simavr).
|
|
||||||
if len(loader.read_fuses()) != 4:
|
|
||||||
fail("fuse read from the staged copy")
|
|
||||||
|
|
||||||
# EEPROM round-trip through the staged copy.
|
|
||||||
pattern = bytes(range(0x50, 0x60))
|
|
||||||
loader.write_eeprom(0, pattern)
|
|
||||||
if loader.read_eeprom(0, len(pattern)) != pattern:
|
|
||||||
fail("EEPROM round-trip through the staged copy")
|
|
||||||
|
|
||||||
# The guard, both ways: its own slot refused (drained, unchanged), the
|
|
||||||
# resident slot writable. The refusal leaves its drained words in the
|
|
||||||
# SPM buffer, so the write that follows may take them — and clears
|
|
||||||
# them by writing, so the retry must not.
|
|
||||||
before = loader.read_flash(stage, page)
|
|
||||||
loader.write_page(stage, bytes(page))
|
|
||||||
if loader.read_flash(stage, page) != before:
|
|
||||||
fail("the staged copy's guard let its own slot change")
|
|
||||||
marker = bytes((i * 3) & 0xFF for i in range(page))
|
|
||||||
loader.write_page(base, marker)
|
|
||||||
if loader.read_flash(base, page) != marker:
|
|
||||||
loader.write_page(base, marker)
|
|
||||||
if loader.read_flash(base, page) != marker:
|
|
||||||
fail("the staged copy could not write the resident slot, even on retry")
|
|
||||||
|
|
||||||
# Restore the resident image through the staged copy, then 'J' back
|
|
||||||
# into it and prove it lives.
|
|
||||||
resident = image + b"\xff" * (info.slot - len(image))
|
|
||||||
pb.write_differing(loader, base, resident)
|
|
||||||
back_info = loader.enter_copy(base, 25)
|
|
||||||
if back_info.raw != resident_info:
|
|
||||||
fail("the restored resident does not serve its info block")
|
|
||||||
port.close()
|
|
||||||
finally:
|
|
||||||
device.stop()
|
|
||||||
print("pbreloc: the relocated copy serves the full command set")
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
@@ -1,68 +0,0 @@
|
|||||||
"""Shared simavr harness for the pureboot tests: spawn the device runner,
|
|
||||||
hand out its pty, restart it from a flash dump (the power-fail path), and
|
|
||||||
keep its chatter out of undrained pipes."""
|
|
||||||
|
|
||||||
import os
|
|
||||||
import signal
|
|
||||||
import subprocess
|
|
||||||
|
|
||||||
|
|
||||||
class Device:
|
|
||||||
def __init__(self, binary, elf, mcu, hz, base_hex, page, baud, dump, reset_hex=None, resume=None, link=None):
|
|
||||||
cmd = [binary]
|
|
||||||
if link:
|
|
||||||
cmd += ["-l", link]
|
|
||||||
cmd += [elf, mcu, hz, base_hex, str(page), str(baud), dump]
|
|
||||||
if reset_hex is not None or resume is not None:
|
|
||||||
# Chips without a hardware boot section — the tinies and the
|
|
||||||
# m48s — reset to address 0 like silicon; the boot-sectioned
|
|
||||||
# megas re-vector to the loader base (BOOTRST).
|
|
||||||
patch = not mcu.startswith("atmega") or mcu.startswith("atmega48")
|
|
||||||
cmd.append(reset_hex if reset_hex is not None else ("0" if patch else base_hex))
|
|
||||||
if resume is not None:
|
|
||||||
cmd.append(resume)
|
|
||||||
self.log = open(dump + ".log", "a")
|
|
||||||
self.proc = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=self.log, text=True)
|
|
||||||
self.dump = dump
|
|
||||||
self.pty = None
|
|
||||||
for _ in range(50):
|
|
||||||
line = self.proc.stdout.readline()
|
|
||||||
if not line:
|
|
||||||
break
|
|
||||||
if line.startswith("PB_PTY"):
|
|
||||||
self.pty = line.split()[1]
|
|
||||||
break
|
|
||||||
if not self.pty:
|
|
||||||
self.stop()
|
|
||||||
raise RuntimeError("device did not report a pty")
|
|
||||||
|
|
||||||
def reset(self):
|
|
||||||
"""The external reset line: SIGUSR1 re-enters at the reset vector."""
|
|
||||||
self.proc.send_signal(signal.SIGUSR1)
|
|
||||||
|
|
||||||
def power_fail(self):
|
|
||||||
"""SIGTERM: the runner dumps its flash and exits — the image a
|
|
||||||
restart resumes from."""
|
|
||||||
self.stop()
|
|
||||||
return self.dump
|
|
||||||
|
|
||||||
def stop(self):
|
|
||||||
self.proc.terminate()
|
|
||||||
try:
|
|
||||||
self.proc.wait(timeout=5)
|
|
||||||
except subprocess.TimeoutExpired:
|
|
||||||
self.proc.kill()
|
|
||||||
self.log.close()
|
|
||||||
|
|
||||||
|
|
||||||
def run_tool(tool, pty, baud, *args, timeout=180):
|
|
||||||
result = subprocess.run(
|
|
||||||
[os.environ.get("PYTHON", "python3"), tool, "--port", pty, "--baud", str(baud), "--wait", "25", *args],
|
|
||||||
capture_output=True,
|
|
||||||
text=True,
|
|
||||||
timeout=timeout,
|
|
||||||
)
|
|
||||||
print(result.stdout, end="")
|
|
||||||
if result.returncode != 0:
|
|
||||||
raise RuntimeError(f"tool exited {result.returncode}: {result.stderr.strip()}")
|
|
||||||
return result.stdout
|
|
||||||
111
test/pbtest.py
111
test/pbtest.py
@@ -1,19 +1,19 @@
|
|||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
"""End-to-end pureboot protocol test: spawn the simavr device, then drive it
|
"""End-to-end pureboot protocol test: spawn the simavr device, then drive it
|
||||||
with the real host tool (pureboot.py, as a subprocess over the device's pty)
|
with the real host tool (pureboot.py, as a subprocess over the device's pty)
|
||||||
through flash + EEPROM + fuse + hand-over scenarios, and cross-check
|
through flash + EEPROM + timeout + fuse + hand-over scenarios, and cross-check
|
||||||
the tool's view against the simulator's ground-truth memory dumps.
|
the tool's view against the simulator's ground-truth memory dumps.
|
||||||
|
|
||||||
Usage: pbtest.py <device_bin> <pureboot_elf> <mcu> <hz> <base_hex> <page>
|
Usage: pbtest.py <device_bin> <pureboot_elf> <mcu> <hz> <base_hex> <page>
|
||||||
<baud> <eeprom_size> <app_bin> <tool_py> <workdir> [link]
|
<baud> <eeprom_size> <app_bin> <tool_py> <workdir>
|
||||||
|
|
||||||
The optional link is the runner's -l spec (usart1, sw:B5,B1, ...) for a
|
|
||||||
loader built off the chip's natural serial default.
|
|
||||||
Exits 0 if every scenario passes.
|
Exits 0 if every scenario passes.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
import signal
|
||||||
|
import subprocess
|
||||||
import sys
|
import sys
|
||||||
|
import time
|
||||||
|
|
||||||
|
|
||||||
def fail(message):
|
def fail(message):
|
||||||
@@ -33,14 +33,53 @@ def rjmp_decode(word, at, flash_words):
|
|||||||
return (at + 1 + offset) % flash_words
|
return (at + 1 + offset) % flash_words
|
||||||
|
|
||||||
|
|
||||||
|
class Device:
|
||||||
|
def __init__(self, binary, elf, mcu, hz, base, page, baud, dump):
|
||||||
|
self.proc = subprocess.Popen(
|
||||||
|
[binary, elf, mcu, hz, base, str(page), str(baud), dump],
|
||||||
|
stdout=subprocess.PIPE,
|
||||||
|
stderr=subprocess.STDOUT,
|
||||||
|
text=True,
|
||||||
|
)
|
||||||
|
self.dump = dump
|
||||||
|
self.pty = None
|
||||||
|
deadline = time.time() + 5
|
||||||
|
while time.time() < deadline:
|
||||||
|
line = self.proc.stdout.readline()
|
||||||
|
if not line:
|
||||||
|
break
|
||||||
|
if line.startswith("PB_PTY"):
|
||||||
|
self.pty = line.split()[1]
|
||||||
|
break
|
||||||
|
if not self.pty:
|
||||||
|
self.stop()
|
||||||
|
raise RuntimeError("device did not report a pty")
|
||||||
|
|
||||||
|
def stop(self):
|
||||||
|
self.proc.terminate()
|
||||||
|
try:
|
||||||
|
self.proc.wait(timeout=3)
|
||||||
|
except subprocess.TimeoutExpired:
|
||||||
|
self.proc.kill()
|
||||||
|
|
||||||
|
|
||||||
|
def run_tool(tool, pty, baud, *args):
|
||||||
|
result = subprocess.run(
|
||||||
|
[sys.executable, tool, "--port", pty, "--baud", str(baud), "--wait", "20", *args],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
timeout=120,
|
||||||
|
)
|
||||||
|
print(result.stdout, end="")
|
||||||
|
if result.returncode != 0:
|
||||||
|
fail(f"tool exited {result.returncode}: {result.stderr.strip()}")
|
||||||
|
return result.stdout
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
args = sys.argv[1:]
|
(device_bin, elf, mcu, hz, base_hex, page, baud, eeprom_size, app_bin, tool, workdir) = sys.argv[1:]
|
||||||
link = args.pop() if len(args) == 12 else None
|
|
||||||
(device_bin, elf, mcu, hz, base_hex, page, baud, eeprom_size, app_bin, tool, workdir) = args
|
|
||||||
base, page, baud, eeprom_size = int(base_hex, 0), int(page), int(baud), int(eeprom_size)
|
base, page, baud, eeprom_size = int(base_hex, 0), int(page), int(baud), int(eeprom_size)
|
||||||
sys.path.insert(0, os.path.dirname(os.path.abspath(tool)))
|
sys.path.insert(0, os.path.dirname(os.path.abspath(tool)))
|
||||||
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
|
|
||||||
import pbsim
|
|
||||||
import pureboot as pb
|
import pureboot as pb
|
||||||
|
|
||||||
os.makedirs(workdir, exist_ok=True)
|
os.makedirs(workdir, exist_ok=True)
|
||||||
@@ -51,33 +90,25 @@ def main():
|
|||||||
read_flash = os.path.join(workdir, "readback_flash.bin")
|
read_flash = os.path.join(workdir, "readback_flash.bin")
|
||||||
read_eeprom = os.path.join(workdir, "readback_eeprom.bin")
|
read_eeprom = os.path.join(workdir, "readback_eeprom.bin")
|
||||||
|
|
||||||
# The geometry the host will discover, for computing the expected image:
|
# The geometry the host will discover, for computing the expected image.
|
||||||
# the boot-sectioned megas need no vector surgery (the tinies and the
|
|
||||||
# boot-section-less m48s do), the large chips speak word addresses, and
|
|
||||||
# the page byte is the wire's 0-means-256.
|
|
||||||
mega = mcu.startswith("atmega")
|
|
||||||
patch = not mega or mcu.startswith("atmega48")
|
|
||||||
word_flash = base + 512 > 0x10000
|
|
||||||
wire_base = base // 2 if word_flash else base
|
|
||||||
flags = (1 if patch else 0) | (2 if word_flash else 0)
|
|
||||||
info = pb.Info(
|
info = pb.Info(
|
||||||
bytes([ord("P"), ord("B"), pb.NEWEST_LOADER, 0, 0, 0, page & 0xFF])
|
bytes([ord("P"), ord("B"), 1, 0, 0, 0, page])
|
||||||
+ bytes([wire_base & 0xFF, wire_base >> 8, eeprom_size & 0xFF, eeprom_size >> 8])
|
+ bytes([base & 0xFF, base >> 8, eeprom_size & 0xFF, eeprom_size >> 8])
|
||||||
+ bytes([flags])
|
+ bytes([0 if mcu == "atmega328p" else 1])
|
||||||
)
|
)
|
||||||
|
|
||||||
device = pbsim.Device(device_bin, elf, mcu, hz, base_hex, page, baud, dump, link=link)
|
device = Device(device_bin, elf, mcu, hz, base_hex, page, baud, dump)
|
||||||
try:
|
try:
|
||||||
# Session 1: knock from reset, identify, program everything, stay.
|
# Session 1: knock from reset, identify, program everything, stay.
|
||||||
out = pbsim.run_tool(tool, device.pty, baud, "--info", "--fuses", "--flash", app_bin,
|
out = run_tool(tool, device.pty, baud, "--info", "--fuses", "--flash", app_bin,
|
||||||
"--eeprom", ee_path, "--stay")
|
"--eeprom", ee_path, "--timeout", "8", "--stay")
|
||||||
for needed in ("version", "signature", "fuses", "verify:", "stays"):
|
for needed in ("device: signature", "fuses:", "verify:", "activation timeout: 8 s", "stays"):
|
||||||
if needed not in out:
|
if needed not in out:
|
||||||
fail(f"session 1 output lacks {needed!r}")
|
fail(f"session 1 output lacks {needed!r}")
|
||||||
|
|
||||||
# Session 2: reconnect into the live session, verify, dump, hand over
|
# Session 2: reconnect into the live session, verify, dump, hand over
|
||||||
# is deferred — the pty must be reopened for the APP banner first.
|
# is deferred — the pty must be reopened for the APP banner first.
|
||||||
out = pbsim.run_tool(tool, device.pty, baud, "--verify-flash", app_bin, "--verify-eeprom", ee_path,
|
out = run_tool(tool, device.pty, baud, "--verify-flash", app_bin, "--verify-eeprom", ee_path,
|
||||||
"--read-flash", read_flash, "--read-eeprom", read_eeprom, "--stay")
|
"--read-flash", read_flash, "--read-eeprom", read_eeprom, "--stay")
|
||||||
if out.count("verify:") != 2:
|
if out.count("verify:") != 2:
|
||||||
fail("session 2 did not verify both memories")
|
fail("session 2 did not verify both memories")
|
||||||
@@ -85,6 +116,8 @@ def main():
|
|||||||
eeprom_back = open(read_eeprom, "rb").read()
|
eeprom_back = open(read_eeprom, "rb").read()
|
||||||
if eeprom_back[: len(ee_image)] != ee_image:
|
if eeprom_back[: len(ee_image)] != ee_image:
|
||||||
fail("EEPROM read-back mismatch")
|
fail("EEPROM read-back mismatch")
|
||||||
|
if eeprom_back[-1] != 8:
|
||||||
|
fail(f"timeout cell reads {eeprom_back[-1]}, expected 8")
|
||||||
|
|
||||||
# The expected post-surgery flash, straight from the tool's planner.
|
# The expected post-surgery flash, straight from the tool's planner.
|
||||||
pages = pb.plan_flash(open(app_bin, "rb").read(), info)
|
pages = pb.plan_flash(open(app_bin, "rb").read(), info)
|
||||||
@@ -95,19 +128,16 @@ def main():
|
|||||||
|
|
||||||
# An external reset re-enters through the patched word 0 (tinies; the
|
# An external reset re-enters through the patched word 0 (tinies; the
|
||||||
# runner resets them to address 0 like silicon) or BOOTRST (mega).
|
# runner resets them to address 0 like silicon) or BOOTRST (mega).
|
||||||
# The loader must answer a fresh knock, and the 'J' hand-over must
|
# The loader must answer a fresh knock, and 'G' must land in the
|
||||||
# land in the application, which banners on the same link.
|
# application, which banners on the same link.
|
||||||
device.reset()
|
device.proc.send_signal(signal.SIGUSR1)
|
||||||
port = pb.Port(device.pty, baud)
|
port = pb.Port(device.pty, baud)
|
||||||
try:
|
try:
|
||||||
loader = pb.Loader(port)
|
loader = pb.Loader(port)
|
||||||
live = loader.connect(15)
|
loader.connect(15)
|
||||||
# The loader built from this tree and the tool beside it must
|
port.write(b"G")
|
||||||
# agree on where the version numbering stands: a bump the tool
|
if port.read_exact(1, 5.0) != pb.PROMPT:
|
||||||
# was never told about is a loader it would refuse to speak to.
|
fail("no ack for G")
|
||||||
if live.version != pb.NEWEST_LOADER:
|
|
||||||
fail(f"loader reports pureboot {live.version}, the tool's newest is {pb.NEWEST_LOADER}")
|
|
||||||
loader.run_application()
|
|
||||||
banner = port.read_exact(3, 5.0)
|
banner = port.read_exact(3, 5.0)
|
||||||
if banner != b"APP":
|
if banner != b"APP":
|
||||||
fail(f"application banner was {banner!r}")
|
fail(f"application banner was {banner!r}")
|
||||||
@@ -124,9 +154,8 @@ def main():
|
|||||||
fail("loader region looks erased in the ground-truth dump")
|
fail("loader region looks erased in the ground-truth dump")
|
||||||
|
|
||||||
# The surgery, decoded independently: the patched vector must land on the
|
# The surgery, decoded independently: the patched vector must land on the
|
||||||
# loader, the trampoline on the application's own entry (patched-vector
|
# loader, the trampoline on the application's own entry.
|
||||||
# chips only — a boot-sectioned mega's word 0 stays the application's).
|
if mcu != "atmega328p":
|
||||||
if patch:
|
|
||||||
flash_words = (base + 512) // 2
|
flash_words = (base + 512) // 2
|
||||||
app = open(app_bin, "rb").read()
|
app = open(app_bin, "rb").read()
|
||||||
word0 = flash_true[0] | (flash_true[1] << 8)
|
word0 = flash_true[0] | (flash_true[1] << 8)
|
||||||
@@ -139,7 +168,7 @@ def main():
|
|||||||
ee_true_path = dump + ".eeprom"
|
ee_true_path = dump + ".eeprom"
|
||||||
if os.path.exists(ee_true_path):
|
if os.path.exists(ee_true_path):
|
||||||
ee_true = open(ee_true_path, "rb").read()
|
ee_true = open(ee_true_path, "rb").read()
|
||||||
if ee_true[: len(ee_image)] != ee_image:
|
if ee_true[: len(ee_image)] != ee_image or ee_true[-1] != 8:
|
||||||
fail("ground-truth EEPROM does not match what was programmed")
|
fail("ground-truth EEPROM does not match what was programmed")
|
||||||
|
|
||||||
print("pbtest: all scenarios pass")
|
print("pbtest: all scenarios pass")
|
||||||
|
|||||||
230
test/pbupdate.py
230
test/pbupdate.py
@@ -1,230 +0,0 @@
|
|||||||
#!/usr/bin/env python3
|
|
||||||
"""Self-update end-to-end: an application is flashed, then the loader
|
|
||||||
replaces itself with a re-timed build through the host tool's
|
|
||||||
--update-loader — and the power-fail phases of that update are rehearsed by
|
|
||||||
killing the simulated device mid-write, restarting it from its flash dump,
|
|
||||||
and letting a re-run complete the update.
|
|
||||||
|
|
||||||
The boot-sectioned megas run the BOOTRST-unprogrammed profile (reset boots
|
|
||||||
the application; the fixture application's 'L' jump is the application-owned
|
|
||||||
loader entry), with --assume-fuses standing in for the fuse read simavr
|
|
||||||
cannot model. The patched-vector chips — the tinies and the m48s — reset
|
|
||||||
into a loader at every phase by construction: the t13a because its staging
|
|
||||||
slot carries the reset vector itself, the others through the word-0 redirect
|
|
||||||
the tool plants around the resident rewrite.
|
|
||||||
|
|
||||||
Usage: pbupdate.py <device_bin> <pureboot_elf> <update_elf> <mcu> <hz>
|
|
||||||
<base_hex> <page> <baud> <app_bin> <tool_py> <workdir>
|
|
||||||
"""
|
|
||||||
|
|
||||||
import os
|
|
||||||
import subprocess
|
|
||||||
import sys
|
|
||||||
|
|
||||||
|
|
||||||
def fail(message):
|
|
||||||
print(f"FAIL: {message}")
|
|
||||||
sys.exit(1)
|
|
||||||
|
|
||||||
|
|
||||||
def rjmp_decode(word, at, flash_words):
|
|
||||||
"""Written against the instruction-set definition, not with the tool's
|
|
||||||
encoder, so an encoding bug cannot verify itself."""
|
|
||||||
if word & 0xF000 != 0xC000:
|
|
||||||
fail(f"word at {at * 2:#06x} is {word:#06x}, not an rjmp")
|
|
||||||
offset = word & 0x0FFF
|
|
||||||
if offset >= 0x800:
|
|
||||||
offset -= 0x1000
|
|
||||||
return (at + 1 + offset) % flash_words
|
|
||||||
|
|
||||||
|
|
||||||
class PowerFail(Exception):
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
def assumed_fuses(pb, image):
|
|
||||||
"""Synthetic 'F' bytes for --assume-fuses: the smallest boot section
|
|
||||||
covering both the resident and the staging slot (two slots — what a
|
|
||||||
self-update needs), BOOTRST unprogrammed — the per-chip BOOTSZ ladder
|
|
||||||
and fuse byte come from the tool's own table, keyed by the update
|
|
||||||
image's embedded signature."""
|
|
||||||
info = pb.image_info(image)
|
|
||||||
which, ladder = pb.BOOT_FUSE[bytes(info.signature[1:3])]
|
|
||||||
bits = min((b for b in ladder if ladder[b] * 2 >= 2 * info.slot), key=lambda b: ladder[b])
|
|
||||||
fuses = bytearray((0xFF, 0xFF, 0xFF, 0xFF))
|
|
||||||
fuses[which] = 0xF8 | (bits << 1) | 1
|
|
||||||
return bytes(fuses)
|
|
||||||
|
|
||||||
|
|
||||||
def make_fault_loader(pb, base, slot, kill_region, kill_hits, device):
|
|
||||||
"""A Loader whose write_page kills the device (or, with device=None,
|
|
||||||
just the host) at the Nth write into a region; the sequence
|
|
||||||
stage->resident->stage distinguishes the install from the restore."""
|
|
||||||
|
|
||||||
class FaultLoader(pb.Loader):
|
|
||||||
def __init__(self, port):
|
|
||||||
super().__init__(port)
|
|
||||||
self.seen_resident = False
|
|
||||||
self.hits = 0
|
|
||||||
|
|
||||||
def write_page(self, address, data):
|
|
||||||
if address >= base:
|
|
||||||
phase = "resident"
|
|
||||||
self.seen_resident = True
|
|
||||||
elif address >= base - slot:
|
|
||||||
phase = "stage_restore" if self.seen_resident else "stage"
|
|
||||||
else:
|
|
||||||
phase = "app"
|
|
||||||
if phase == kill_region:
|
|
||||||
self.hits += 1
|
|
||||||
if self.hits == kill_hits:
|
|
||||||
if device is not None:
|
|
||||||
device.power_fail()
|
|
||||||
raise PowerFail(f"{kill_region} write {kill_hits}")
|
|
||||||
super().write_page(address, data)
|
|
||||||
|
|
||||||
return FaultLoader
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
(device_bin, elf, update_elf, mcu, hz, base_hex, page, baud, app_bin, tool, workdir) = sys.argv[1:]
|
|
||||||
base, page, baud = int(base_hex, 0), int(page), int(baud)
|
|
||||||
mega = mcu.startswith("atmega")
|
|
||||||
# The m48s are megas without a boot section: patched vector, no fuse
|
|
||||||
# preflight, and the same reset-to-0 the tinies get.
|
|
||||||
patch = not mega or mcu.startswith("atmega48")
|
|
||||||
# Word-addressed (>64 KiB) chips use the 1 KiB slot; their loader base
|
|
||||||
# itself sits beyond the 16-bit byte space — the 644's base + slot only
|
|
||||||
# touches the 64 KiB boundary and stays byte-addressed.
|
|
||||||
slot = 1024 if base >= 0x10000 and mega else 512
|
|
||||||
reset_hex = "0" if mega else None # the boot-sectioned mega runs BOOTRST-unprogrammed here
|
|
||||||
sys.path.insert(0, os.path.dirname(os.path.abspath(tool)))
|
|
||||||
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
|
|
||||||
import pbsim
|
|
||||||
import pureboot as pb
|
|
||||||
|
|
||||||
os.makedirs(workdir, exist_ok=True)
|
|
||||||
objcopy = os.environ.get("PB_OBJCOPY", "avr-objcopy")
|
|
||||||
images = {}
|
|
||||||
for name, source in (("v0", elf), ("v9", update_elf)):
|
|
||||||
path = os.path.join(workdir, name + ".bin")
|
|
||||||
subprocess.run([objcopy, "-O", "binary", source, path], check=True)
|
|
||||||
images[name] = open(path, "rb").read()
|
|
||||||
if images["v0"] == images["v9"]:
|
|
||||||
fail("the update image is byte-identical to the resident build")
|
|
||||||
dump = os.path.join(workdir, "dump.bin")
|
|
||||||
state = os.path.join(workdir, "update.pbstate")
|
|
||||||
fuses = assumed_fuses(pb, images["v0"]) if mega and not patch else None
|
|
||||||
|
|
||||||
def connect(device):
|
|
||||||
port = pb.Port(device.pty, baud)
|
|
||||||
if mega:
|
|
||||||
# Reset boots the application here; its 'L' is the loader entry.
|
|
||||||
# To a live loader the same byte is an ignored command.
|
|
||||||
port.read_available(0.5)
|
|
||||||
port.write(b"L")
|
|
||||||
loader = pb.Loader(port)
|
|
||||||
loader.connect(25)
|
|
||||||
return port, loader
|
|
||||||
|
|
||||||
def padded(image):
|
|
||||||
return image + b"\xff" * (slot - len(image))
|
|
||||||
|
|
||||||
def resident_bytes(loader):
|
|
||||||
return loader.read_flash(base, slot)
|
|
||||||
|
|
||||||
def assert_state(loader, image, app_pages):
|
|
||||||
if resident_bytes(loader) != padded(image):
|
|
||||||
fail("resident loader does not match the update image")
|
|
||||||
stage = base - slot
|
|
||||||
got = loader.read_flash(stage, slot)
|
|
||||||
for address, data in app_pages.items():
|
|
||||||
if stage <= address < base:
|
|
||||||
if got[address - stage : address - stage + page] != data:
|
|
||||||
fail(f"staging region page {address:#06x} not restored")
|
|
||||||
|
|
||||||
device = pbsim.Device(device_bin, elf, mcu, hz, base_hex, page, baud, dump, reset_hex=reset_hex)
|
|
||||||
final = "v0"
|
|
||||||
try:
|
|
||||||
# The application first — its planner output is the restore truth.
|
|
||||||
pbsim.run_tool(tool, device.pty, baud, "--flash", app_bin, "--stay")
|
|
||||||
port, loader = connect(device)
|
|
||||||
app_pages = pb.plan_flash(open(app_bin, "rb").read(), loader.info)
|
|
||||||
port.close()
|
|
||||||
|
|
||||||
# A clean CLI update, resident -> v9.
|
|
||||||
args = ["--update-loader", os.path.join(workdir, "v9.bin"), "--state", state, "--stay"]
|
|
||||||
if fuses:
|
|
||||||
args += ["--assume-fuses", fuses.hex()]
|
|
||||||
out = pbsim.run_tool(tool, device.pty, baud, *args)
|
|
||||||
if "loader updated" not in out:
|
|
||||||
fail("update did not report success")
|
|
||||||
if os.path.exists(state):
|
|
||||||
fail("state file survived a completed update")
|
|
||||||
port, loader = connect(device)
|
|
||||||
assert_state(loader, images["v9"], app_pages)
|
|
||||||
loader.run_application()
|
|
||||||
if port.read_exact(3, 5.0) != b"APP":
|
|
||||||
fail("application does not banner after the update")
|
|
||||||
port.close()
|
|
||||||
final = "v9"
|
|
||||||
print("clean update: resident replaced, staging restored, application intact")
|
|
||||||
|
|
||||||
# Power-fail rehearsal: kill mid-phase, restart from the dump,
|
|
||||||
# re-run, and the update must still complete. Each round flips the
|
|
||||||
# direction so the flash is never already at its target. The mega's
|
|
||||||
# mid-resident-rewrite loss is exercised as a host crash instead:
|
|
||||||
# with BOOTRST unprogrammed and the resident mid-erase, a power loss
|
|
||||||
# there has no reset path into the staging copy — the documented
|
|
||||||
# cost of that profile (README).
|
|
||||||
for kill_region, kill_hits, kill_device in (
|
|
||||||
("stage", 2, True),
|
|
||||||
("resident", 1, patch),
|
|
||||||
("stage_restore", 2, True),
|
|
||||||
):
|
|
||||||
device.reset() # the previous round left the application running
|
|
||||||
port, loader = connect(device)
|
|
||||||
target = "v9" if resident_bytes(loader) == padded(images["v0"]) else "v0"
|
|
||||||
image_path = os.path.join(workdir, target + ".bin")
|
|
||||||
injected = make_fault_loader(pb, base, slot, kill_region, kill_hits, device if kill_device else None)(port)
|
|
||||||
injected.info = loader.info
|
|
||||||
try:
|
|
||||||
pb.op_update_loader(injected, 25, image_path, state, fuses)
|
|
||||||
fail(f"{kill_region}: fault never triggered")
|
|
||||||
except PowerFail as event:
|
|
||||||
print(f"power fail injected: {event}")
|
|
||||||
port.close()
|
|
||||||
if kill_device:
|
|
||||||
device = pbsim.Device(device_bin, elf, mcu, hz, base_hex, page, baud, dump,
|
|
||||||
reset_hex=reset_hex, resume=dump)
|
|
||||||
port, loader = connect(device)
|
|
||||||
pb.op_update_loader(loader, 25, image_path, state, fuses)
|
|
||||||
assert_state(loader, images[target], app_pages)
|
|
||||||
loader.run_application()
|
|
||||||
if port.read_exact(3, 5.0) != b"APP":
|
|
||||||
fail(f"{kill_region}: application lost after the resumed update")
|
|
||||||
port.close()
|
|
||||||
final = target
|
|
||||||
print(f"resumed after {kill_region} loss: update completed, application intact")
|
|
||||||
finally:
|
|
||||||
device.stop()
|
|
||||||
|
|
||||||
# Ground truth: the simulator's own flash against the final state, and
|
|
||||||
# on the patched-vector chips an independent decode of the reset routing.
|
|
||||||
flash = open(dump, "rb").read()
|
|
||||||
if flash[base : base + slot] != padded(images[final]):
|
|
||||||
fail("ground-truth resident region does not match the final image")
|
|
||||||
if patch:
|
|
||||||
flash_words = (base + slot) // 2
|
|
||||||
word0 = flash[0] | (flash[1] << 8)
|
|
||||||
if rjmp_decode(word0, 0, flash_words) != base // 2:
|
|
||||||
fail("ground-truth reset vector does not land on the loader")
|
|
||||||
app = open(app_bin, "rb").read()
|
|
||||||
trampoline = flash[base - 2] | (flash[base - 1] << 8)
|
|
||||||
if rjmp_decode(trampoline, (base - 2) // 2, flash_words) != rjmp_decode(app[0] | (app[1] << 8), 0, flash_words):
|
|
||||||
fail("ground-truth trampoline does not land on the application entry")
|
|
||||||
print("pbupdate: clean update + all power-fail phases recovered")
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
@@ -1,16 +1,12 @@
|
|||||||
// simavr "device" for the pureboot protocol tests, every chip. Loads the
|
// simavr "device" for the pureboot protocol tests, all three chips. Loads
|
||||||
// boot-linked ELF at the loader base, starts execution there (BOOTRST / the
|
// the boot-linked ELF at the loader base, starts execution there (BOOTRST /
|
||||||
// patched vector are not what is under test), and exposes the loader's
|
// the patched vector are not what is under test), and exposes the loader's
|
||||||
// serial link as a pty for the real host tool:
|
// serial link as a pty for the real host tool:
|
||||||
//
|
//
|
||||||
// - Hardware USART builds: simavr's uart_pty on the selected instance.
|
// - ATmega328P: the hardware USART0 through simavr's uart_pty.
|
||||||
// - Software UART builds: an 8N1 bridge between a pty and the GPIO pins,
|
// - Tinies: an 8N1 bridge between a pty and the GPIO software UART
|
||||||
// timed against the simulated cycle counter (drives the loader's RX,
|
// (drives PB0, the loader's RX; decodes PB1, its TX), timed against the
|
||||||
// decodes its TX).
|
// simulated cycle counter.
|
||||||
//
|
|
||||||
// The link follows the chip's natural default (USART0 on the megas, the
|
|
||||||
// software UART on PB0/PB1 elsewhere) unless -l overrides it: `-l usart1`
|
|
||||||
// for the second instance, `-l sw:B5,B1` for a software build's RX,TX pins.
|
|
||||||
//
|
//
|
||||||
// simavr's tiny cores decode the SPM opcode but attach no NVM module — SPM
|
// simavr's tiny cores decode the SPM opcode but attach no NVM module — SPM
|
||||||
// is a silent no-op (the mega's boot section has one, avr_flash). The
|
// is a silent no-op (the mega's boot section has one, avr_flash). The
|
||||||
@@ -42,84 +38,11 @@
|
|||||||
|
|
||||||
static avr_t *avr;
|
static avr_t *avr;
|
||||||
static uart_pty_t uart_pty;
|
static uart_pty_t uart_pty;
|
||||||
static int link_software;
|
static int use_uart_pty;
|
||||||
static char uart_digit = '0';
|
|
||||||
static char sw_rx_port = 'B', sw_tx_port = 'B';
|
|
||||||
static int sw_rx_bit = 0, sw_tx_bit = 1;
|
|
||||||
static const char *dump_path;
|
static const char *dump_path;
|
||||||
static uint32_t reset_pc;
|
static uint32_t reset_pc;
|
||||||
static volatile sig_atomic_t reset_requested;
|
static volatile sig_atomic_t reset_requested;
|
||||||
|
|
||||||
static int parse_link(const char *spec)
|
|
||||||
{
|
|
||||||
if (strcmp(spec, "usart0") == 0 || strcmp(spec, "usart1") == 0) {
|
|
||||||
link_software = 0;
|
|
||||||
uart_digit = spec[5];
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
if (strncmp(spec, "sw", 2) == 0) {
|
|
||||||
link_software = 1;
|
|
||||||
if (spec[2] == '\0')
|
|
||||||
return 0;
|
|
||||||
if (sscanf(spec + 2, ":%c%d,%c%d", &sw_rx_port, &sw_rx_bit, &sw_tx_port, &sw_tx_bit) == 4)
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
return -1;
|
|
||||||
}
|
|
||||||
|
|
||||||
// simavr 1.6's avr_flash PGERS handler erases spm_pagesize bytes starting at
|
|
||||||
// Z & ~1 instead of the page containing Z (its PGWRT path masks correctly) —
|
|
||||||
// hardware ignores the in-page bits (§26.8.1), so an erase issued with Z
|
|
||||||
// anywhere inside the page wipes half the neighbouring page in simulation
|
|
||||||
// only. Wrap the mega's registered flash ioctl and re-dispatch page erases
|
|
||||||
// with Z forced to the page boundary; everything else passes through.
|
|
||||||
//
|
|
||||||
// A second gap on the boot-section-less m48s: their RWWSRE bit is the
|
|
||||||
// temporary-buffer discard (Atmel-8271 §26.2/§26.3.1), but the stock model
|
|
||||||
// gates its RWWSRE branch on AVR_SELFPROG_HAVE_RWW — absent on the m48
|
|
||||||
// core — so the discard store falls through into the buffer-fill branch and
|
|
||||||
// plants whatever Z/R1:R0 happen to hold. Perform the silicon's discard
|
|
||||||
// here instead.
|
|
||||||
static avr_flash_t *mega_flash;
|
|
||||||
static int (*mega_flash_ioctl)(avr_io_t *io, uint32_t ctl, void *param);
|
|
||||||
|
|
||||||
static int fixed_flash_ioctl(avr_io_t *io, uint32_t ctl, void *param)
|
|
||||||
{
|
|
||||||
if (ctl == AVR_IOCTL_FLASH_SPM && avr_regbit_get(io->avr, mega_flash->pgers)) {
|
|
||||||
uint16_t z = (uint16_t)(io->avr->data[30] | (io->avr->data[31] << 8));
|
|
||||||
uint16_t masked = (uint16_t)(z & ~(mega_flash->spm_pagesize - 1));
|
|
||||||
io->avr->data[30] = (uint8_t)masked;
|
|
||||||
io->avr->data[31] = (uint8_t)(masked >> 8);
|
|
||||||
int result = mega_flash_ioctl(io, ctl, param);
|
|
||||||
io->avr->data[30] = (uint8_t)z;
|
|
||||||
io->avr->data[31] = (uint8_t)(z >> 8);
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
if (ctl == AVR_IOCTL_FLASH_SPM && !(mega_flash->flags & AVR_SELFPROG_HAVE_RWW) &&
|
|
||||||
(io->avr->data[mega_flash->r_spm] & 0x11) == 0x11) { // RWWSRE|SELFPRGEN: the m48 buffer discard
|
|
||||||
for (int i = 0; i < mega_flash->spm_pagesize / 2; i++) {
|
|
||||||
mega_flash->tmppage[i] = 0xffff;
|
|
||||||
mega_flash->tmppage_used[i] = 0;
|
|
||||||
}
|
|
||||||
avr_regbit_clear(io->avr, mega_flash->selfprgen);
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
return mega_flash_ioctl(io, ctl, param);
|
|
||||||
}
|
|
||||||
|
|
||||||
static void fix_mega_flash_erase(void)
|
|
||||||
{
|
|
||||||
for (avr_io_t *io = avr->io_port; io; io = io->next) {
|
|
||||||
if (io->kind && strcmp(io->kind, "flash") == 0) {
|
|
||||||
mega_flash = (avr_flash_t *)io;
|
|
||||||
mega_flash_ioctl = io->ioctl;
|
|
||||||
io->ioctl = fixed_flash_ioctl;
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
fprintf(stderr, "device: no flash module to fix — SPM page erases may misalign\n");
|
|
||||||
}
|
|
||||||
|
|
||||||
static void request_reset(int sig)
|
static void request_reset(int sig)
|
||||||
{
|
{
|
||||||
(void)sig;
|
(void)sig;
|
||||||
@@ -131,7 +54,6 @@ static void request_reset(int sig)
|
|||||||
typedef struct {
|
typedef struct {
|
||||||
avr_io_t io;
|
avr_io_t io;
|
||||||
uint8_t buffer[128];
|
uint8_t buffer[128];
|
||||||
uint8_t used[128]; // a buffer word loads once until erased — like silicon
|
|
||||||
unsigned page;
|
unsigned page;
|
||||||
} tiny_nvm_t;
|
} tiny_nvm_t;
|
||||||
|
|
||||||
@@ -149,21 +71,16 @@ static int nvm_ioctl(avr_io_t *io, uint32_t ctl, void *param)
|
|||||||
uint32_t page_base = (uint32_t)(z & ~(n->page - 1)) % (mcu->flashend + 1);
|
uint32_t page_base = (uint32_t)(z & ~(n->page - 1)) % (mcu->flashend + 1);
|
||||||
if (command == 0x01) { // SPMEN alone: buffer fill from r1:r0
|
if (command == 0x01) { // SPMEN alone: buffer fill from r1:r0
|
||||||
unsigned offset = z & (n->page - 1) & ~1u;
|
unsigned offset = z & (n->page - 1) & ~1u;
|
||||||
if (!n->used[offset]) { // first write wins until the buffer clears
|
|
||||||
n->buffer[offset] = mcu->data[0];
|
n->buffer[offset] = mcu->data[0];
|
||||||
n->buffer[offset + 1] = mcu->data[1];
|
n->buffer[offset + 1] = mcu->data[1];
|
||||||
n->used[offset] = 1;
|
|
||||||
}
|
|
||||||
} else if (command == 0x03) { // PGERS
|
} else if (command == 0x03) { // PGERS
|
||||||
memset(mcu->flash + page_base, 0xff, n->page);
|
memset(mcu->flash + page_base, 0xff, n->page);
|
||||||
} else if (command == 0x05) { // PGWRT: programming only clears bits
|
} else if (command == 0x05) { // PGWRT: programming only clears bits
|
||||||
for (unsigned i = 0; i < n->page; i++)
|
for (unsigned i = 0; i < n->page; i++)
|
||||||
mcu->flash[page_base + i] &= n->buffer[i];
|
mcu->flash[page_base + i] &= n->buffer[i];
|
||||||
memset(n->buffer, 0xff, n->page);
|
memset(n->buffer, 0xff, n->page);
|
||||||
memset(n->used, 0, n->page);
|
|
||||||
} else if (command == 0x11) { // CTPB
|
} else if (command == 0x11) { // CTPB
|
||||||
memset(n->buffer, 0xff, n->page);
|
memset(n->buffer, 0xff, n->page);
|
||||||
memset(n->used, 0, n->page);
|
|
||||||
}
|
}
|
||||||
mcu->data[0x57] &= (uint8_t)~0x1f; // the operation completes instantly
|
mcu->data[0x57] &= (uint8_t)~0x1f; // the operation completes instantly
|
||||||
return 0;
|
return 0;
|
||||||
@@ -245,14 +162,8 @@ static void rx_start_next(void)
|
|||||||
// A reset abandons whatever the bridge was mid-transfer: bytes still queued
|
// A reset abandons whatever the bridge was mid-transfer: bytes still queued
|
||||||
// for a chip that no longer has the context to receive them meaningfully,
|
// for a chip that no longer has the context to receive them meaningfully,
|
||||||
// and a decode in progress on a TX line the reset may have already changed.
|
// and a decode in progress on a TX line the reset may have already changed.
|
||||||
// The pending cycle timers must go with the state: avr_reset drops the TX
|
|
||||||
// output latch, whose falling edge starts a spurious decode before this
|
|
||||||
// runs, and a stale tx_sample would then interleave with the loader's first
|
|
||||||
// real answer through the shared shift state, corrupting it.
|
|
||||||
static void bridge_reset(void)
|
static void bridge_reset(void)
|
||||||
{
|
{
|
||||||
avr_cycle_timer_cancel(avr, tx_sample, NULL);
|
|
||||||
avr_cycle_timer_cancel(avr, rx_step, NULL);
|
|
||||||
rx_head = rx_tail = 0;
|
rx_head = rx_tail = 0;
|
||||||
rx_active = 0;
|
rx_active = 0;
|
||||||
tx_active = 0;
|
tx_active = 0;
|
||||||
@@ -297,42 +208,23 @@ static void finish(int sig)
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if (!link_software)
|
if (use_uart_pty)
|
||||||
uart_pty_stop(&uart_pty);
|
uart_pty_stop(&uart_pty);
|
||||||
_exit(0);
|
_exit(0);
|
||||||
}
|
}
|
||||||
|
|
||||||
int main(int argc, char *argv[])
|
int main(int argc, char *argv[])
|
||||||
{
|
{
|
||||||
int link_given = 0;
|
if (argc != 8) {
|
||||||
for (int opt; (opt = getopt(argc, argv, "l:")) != -1;) {
|
fprintf(stderr, "usage: %s <pureboot.elf> <mcu> <hz> <base_hex> <page> <baud> <flash_dump>\n", argv[0]);
|
||||||
if (opt != 'l' || parse_link(optarg) != 0) {
|
|
||||||
fprintf(stderr, "device: bad link spec (usart0, usart1, sw, or sw:B0,B1 as RX,TX)\n");
|
|
||||||
return 2;
|
return 2;
|
||||||
}
|
}
|
||||||
link_given = 1;
|
|
||||||
}
|
|
||||||
int args = argc - optind;
|
|
||||||
if (args < 7 || args > 9) {
|
|
||||||
fprintf(stderr,
|
|
||||||
"usage: %s [-l link] <pureboot.elf> <mcu> <hz> <base_hex> <page> <baud> <flash_dump>"
|
|
||||||
" [reset_hex] [resume_flash]\n"
|
|
||||||
" -l link: usart0 | usart1 | sw[:B0,B1] (RX,TX); default: the chip's own\n"
|
|
||||||
" reset_hex: reset vector (default: base with a boot section, else 0)\n"
|
|
||||||
" resume_flash: raw full-flash image loaded instead of the ELF — a prior\n"
|
|
||||||
" run's dump, for power-fail resume tests\n",
|
|
||||||
argv[0]);
|
|
||||||
return 2;
|
|
||||||
}
|
|
||||||
argv += optind - 1; // argv[1] is the ELF again, whatever was parsed
|
|
||||||
const char *mcu_name = argv[2];
|
const char *mcu_name = argv[2];
|
||||||
uint32_t base = (uint32_t)strtoul(argv[4], NULL, 0);
|
uint32_t base = (uint32_t)strtoul(argv[4], NULL, 0);
|
||||||
unsigned page = (unsigned)atoi(argv[5]);
|
unsigned page = (unsigned)atoi(argv[5]);
|
||||||
unsigned baud = (unsigned)atoi(argv[6]);
|
unsigned baud = (unsigned)atoi(argv[6]);
|
||||||
dump_path = argv[7];
|
dump_path = argv[7];
|
||||||
int is_mega = strncmp(mcu_name, "atmega", 6) == 0;
|
use_uart_pty = strcmp(mcu_name, "atmega328p") == 0;
|
||||||
if (!link_given)
|
|
||||||
link_software = !is_mega; // the chips' natural links: USART0, or PB0/PB1
|
|
||||||
|
|
||||||
avr = avr_make_mcu_by_name(mcu_name);
|
avr = avr_make_mcu_by_name(mcu_name);
|
||||||
if (!avr) {
|
if (!avr) {
|
||||||
@@ -343,29 +235,16 @@ int main(int argc, char *argv[])
|
|||||||
avr->frequency = (uint32_t)strtoul(argv[3], NULL, 0);
|
avr->frequency = (uint32_t)strtoul(argv[3], NULL, 0);
|
||||||
memset(avr->flash, 0xff, avr->flashend + 1); // real flash powers up erased
|
memset(avr->flash, 0xff, avr->flashend + 1); // real flash powers up erased
|
||||||
|
|
||||||
if (args > 8) {
|
|
||||||
// Resume: the full flash image of an interrupted prior run.
|
|
||||||
FILE *f = fopen(argv[9], "rb");
|
|
||||||
if (!f || fread(avr->flash, 1, avr->flashend + 1, f) == 0) {
|
|
||||||
fprintf(stderr, "device: cannot read %s\n", argv[9]);
|
|
||||||
return 1;
|
|
||||||
}
|
|
||||||
fclose(f);
|
|
||||||
} else {
|
|
||||||
elf_firmware_t fw = {0};
|
elf_firmware_t fw = {0};
|
||||||
if (elf_read_firmware(argv[1], &fw) != 0) {
|
if (elf_read_firmware(argv[1], &fw) != 0) {
|
||||||
fprintf(stderr, "device: cannot read %s\n", argv[1]);
|
fprintf(stderr, "device: cannot read %s\n", argv[1]);
|
||||||
return 1;
|
return 1;
|
||||||
}
|
}
|
||||||
memcpy(avr->flash + base, fw.flash, fw.flashsize);
|
memcpy(avr->flash + base, fw.flash, fw.flashsize);
|
||||||
}
|
// The mega enters the loader in hardware (BOOTRST, not modeled); the
|
||||||
// The boot-sectioned megas enter the loader in hardware (BOOTRST, not
|
// tinies reset to word 0 like silicon — erased flash walks up into the
|
||||||
// modeled — the argument picks the modeled fuse's target); the tinies
|
// loader, and after the host's surgery the patched vector routes there.
|
||||||
// and the boot-section-less m48s reset to word 0 like silicon — erased
|
reset_pc = use_uart_pty ? base : 0;
|
||||||
// flash walks up into the loader, and after the host's surgery the
|
|
||||||
// patched vector routes there.
|
|
||||||
int boot_section = is_mega && strncmp(mcu_name, "atmega48", 8) != 0;
|
|
||||||
reset_pc = args > 7 ? (uint32_t)strtoul(argv[8], NULL, 0) : (boot_section ? base : 0);
|
|
||||||
avr->pc = reset_pc;
|
avr->pc = reset_pc;
|
||||||
avr->codeend = avr->flashend;
|
avr->codeend = avr->flashend;
|
||||||
|
|
||||||
@@ -378,34 +257,26 @@ int main(int argc, char *argv[])
|
|||||||
avr_ioctl(avr, AVR_IOCTL_EEPROM_SET, &seed);
|
avr_ioctl(avr, AVR_IOCTL_EEPROM_SET, &seed);
|
||||||
}
|
}
|
||||||
|
|
||||||
// The megas carry simavr's avr_flash module (and its two gaps the wrap
|
if (use_uart_pty) {
|
||||||
// above fixes); the tinies get the NVM module simavr lacks. Which serial
|
// POLL_SLEEP paces an idle-polling loader in host real time (a
|
||||||
// bridge runs is the link's business, not the chip class's.
|
// no-hardware CPU-saving hack); clear it so cycles run free.
|
||||||
if (is_mega) {
|
uint32_t flags = 0;
|
||||||
fix_mega_flash_erase();
|
avr_ioctl(avr, AVR_IOCTL_UART_GET_FLAGS('0'), &flags);
|
||||||
|
flags &= ~AVR_UART_FLAG_POLL_SLEEP;
|
||||||
|
avr_ioctl(avr, AVR_IOCTL_UART_SET_FLAGS('0'), &flags);
|
||||||
|
uart_pty_init(avr, &uart_pty);
|
||||||
|
uart_pty_connect(&uart_pty, '0');
|
||||||
|
printf("PB_PTY %s\n", uart_pty.pty.slavename);
|
||||||
} else {
|
} else {
|
||||||
nvm.page = page;
|
nvm.page = page;
|
||||||
memset(nvm.buffer, 0xff, sizeof(nvm.buffer));
|
memset(nvm.buffer, 0xff, sizeof(nvm.buffer));
|
||||||
nvm.io.kind = "tiny_nvm";
|
nvm.io.kind = "tiny_nvm";
|
||||||
nvm.io.ioctl = nvm_ioctl;
|
nvm.io.ioctl = nvm_ioctl;
|
||||||
avr_register_io(avr, &nvm.io);
|
avr_register_io(avr, &nvm.io);
|
||||||
}
|
|
||||||
|
|
||||||
if (!link_software) {
|
|
||||||
// POLL_SLEEP paces an idle-polling loader in host real time (a
|
|
||||||
// no-hardware CPU-saving hack); clear it so cycles run free.
|
|
||||||
uint32_t flags = 0;
|
|
||||||
avr_ioctl(avr, AVR_IOCTL_UART_GET_FLAGS(uart_digit), &flags);
|
|
||||||
flags &= ~AVR_UART_FLAG_POLL_SLEEP;
|
|
||||||
avr_ioctl(avr, AVR_IOCTL_UART_SET_FLAGS(uart_digit), &flags);
|
|
||||||
uart_pty_init(avr, &uart_pty);
|
|
||||||
uart_pty_connect(&uart_pty, uart_digit);
|
|
||||||
printf("PB_PTY %s\n", uart_pty.pty.slavename);
|
|
||||||
} else {
|
|
||||||
bit_cycles = (avr->frequency + baud / 2) / baud; // matches uart.hpp's own rounding exactly
|
bit_cycles = (avr->frequency + baud / 2) / baud; // matches uart.hpp's own rounding exactly
|
||||||
rx_pin = avr_io_getirq(avr, AVR_IOCTL_IOPORT_GETIRQ(sw_rx_port), (unsigned)sw_rx_bit);
|
rx_pin = avr_io_getirq(avr, AVR_IOCTL_IOPORT_GETIRQ('B'), 0);
|
||||||
avr_irq_register_notify(avr_io_getirq(avr, AVR_IOCTL_IOPORT_GETIRQ(sw_tx_port), (unsigned)sw_tx_bit), tx_hook,
|
avr_irq_register_notify(avr_io_getirq(avr, AVR_IOCTL_IOPORT_GETIRQ('B'), 1), tx_hook, NULL);
|
||||||
NULL);
|
|
||||||
avr_raise_irq(rx_pin, 1); // idle line
|
avr_raise_irq(rx_pin, 1); // idle line
|
||||||
|
|
||||||
int slave;
|
int slave;
|
||||||
@@ -433,27 +304,18 @@ int main(int argc, char *argv[])
|
|||||||
reset_requested = 0;
|
reset_requested = 0;
|
||||||
avr_reset(avr);
|
avr_reset(avr);
|
||||||
avr->pc = reset_pc;
|
avr->pc = reset_pc;
|
||||||
if (!link_software) { // reset restores the pacing hack; re-clear it
|
if (use_uart_pty) { // reset restores the pacing hack; re-clear it
|
||||||
uint32_t flags = 0;
|
uint32_t flags = 0;
|
||||||
avr_ioctl(avr, AVR_IOCTL_UART_GET_FLAGS(uart_digit), &flags);
|
avr_ioctl(avr, AVR_IOCTL_UART_GET_FLAGS('0'), &flags);
|
||||||
flags &= ~AVR_UART_FLAG_POLL_SLEEP;
|
flags &= ~AVR_UART_FLAG_POLL_SLEEP;
|
||||||
avr_ioctl(avr, AVR_IOCTL_UART_SET_FLAGS(uart_digit), &flags);
|
avr_ioctl(avr, AVR_IOCTL_UART_SET_FLAGS('0'), &flags);
|
||||||
} else {
|
} else {
|
||||||
bridge_reset();
|
bridge_reset();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if (link_software && ++since_poll >= 2000) {
|
if (!use_uart_pty && ++since_poll >= 2000) {
|
||||||
since_poll = 0;
|
since_poll = 0;
|
||||||
poll_pty();
|
poll_pty();
|
||||||
// An unthrottled idle simulation runs the activation window out
|
|
||||||
// from under the host's real-time knock cadence: a 1 MHz build's
|
|
||||||
// 8 s window is 8 M cycles — tens of wall milliseconds — so a
|
|
||||||
// first knock lost to an in-flight reset misses the window
|
|
||||||
// entirely. Pace the simulation only while the bridge is fully
|
|
||||||
// quiet (nothing decoding, nothing queued); transfers keep full
|
|
||||||
// speed, and a quiet window stretches toward real time.
|
|
||||||
if (!rx_active && !tx_active && rx_head == rx_tail)
|
|
||||||
usleep(200);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
finish(0);
|
finish(0);
|
||||||
|
|||||||
@@ -1,278 +0,0 @@
|
|||||||
#!/usr/bin/env python3
|
|
||||||
"""Host-tool unit tests — the pure planning and policy logic, no simulator:
|
|
||||||
the flash-programming orders and their recovery properties, the reset-vector
|
|
||||||
surgery, the staging-slot composition, the mega boot-fuse decode, and the
|
|
||||||
update preflight's error/warning matrix (fuse combinations simavr cannot
|
|
||||||
model reach it here as synthetic bytes).
|
|
||||||
|
|
||||||
Usage: test_planner.py <tool_py>
|
|
||||||
"""
|
|
||||||
|
|
||||||
import sys
|
|
||||||
|
|
||||||
|
|
||||||
def fail(message):
|
|
||||||
print(f"FAIL: {message}")
|
|
||||||
sys.exit(1)
|
|
||||||
|
|
||||||
|
|
||||||
def expect_error(what, fn, *needles):
|
|
||||||
try:
|
|
||||||
fn()
|
|
||||||
except Exception as error:
|
|
||||||
for needle in needles:
|
|
||||||
if needle not in str(error):
|
|
||||||
fail(f"{what}: error lacks {needle!r}: {error}")
|
|
||||||
return
|
|
||||||
fail(f"{what}: no error raised")
|
|
||||||
|
|
||||||
|
|
||||||
def info_of(pb, base, page, patch, flash, signature=(0x1E, 0x93, 0x0B), word_flash=False, version=None):
|
|
||||||
scale = 2 if word_flash else 1
|
|
||||||
wire_base = base // scale
|
|
||||||
flags = (1 if patch else 0) | (2 if word_flash else 0)
|
|
||||||
raw = bytes((0x50, 0x42, pb.NEWEST_LOADER if version is None else version,
|
|
||||||
*signature, page & 0xFF, wire_base & 0xFF, wire_base >> 8, 0, 2, flags))
|
|
||||||
info = pb.Info(raw)
|
|
||||||
assert info.flash_size == flash
|
|
||||||
return info
|
|
||||||
|
|
||||||
|
|
||||||
def rjmp_decode(word, at, flash_words):
|
|
||||||
if word & 0xF000 != 0xC000:
|
|
||||||
fail(f"not an rjmp: {word:#06x}")
|
|
||||||
offset = word & 0x0FFF
|
|
||||||
if offset >= 0x800:
|
|
||||||
offset -= 0x1000
|
|
||||||
return (at + 1 + offset) % flash_words
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
import os
|
|
||||||
sys.path.insert(0, os.path.dirname(os.path.abspath(sys.argv[1])))
|
|
||||||
import pureboot as pb
|
|
||||||
|
|
||||||
tiny = info_of(pb, 0x1E00, 64, True, 0x2000)
|
|
||||||
mega = info_of(pb, 0x7E00, 128, False, 0x8000, signature=(0x1E, 0x95, 0x0F))
|
|
||||||
|
|
||||||
# Versioning: the block's third byte is the loader's version, and the tool
|
|
||||||
# speaks a window of them. Every version in the window decodes, so an older
|
|
||||||
# deployed loader stays usable; one above the window is refused by name,
|
|
||||||
# since which version changed the protocol is knowledge only the tool
|
|
||||||
# holds, and it holds none about a version it has never heard of.
|
|
||||||
for version in range(pb.OLDEST_LOADER, pb.NEWEST_LOADER + 1):
|
|
||||||
if info_of(pb, 0x1E00, 64, True, 0x2000, version=version).version != version:
|
|
||||||
fail(f"pureboot {version} does not decode")
|
|
||||||
expect_error(
|
|
||||||
"unknown loader version",
|
|
||||||
lambda: info_of(pb, 0x1E00, 64, True, 0x2000, version=pb.NEWEST_LOADER + 1),
|
|
||||||
f"pureboot {pb.NEWEST_LOADER + 1}",
|
|
||||||
"newer tool",
|
|
||||||
)
|
|
||||||
|
|
||||||
# mega_boot: BOOTSZ words and the BOOTRST sense per chip — the fuse byte
|
|
||||||
# index (EXTENDED on the x8 line except the m328s' HIGH, HIGH elsewhere)
|
|
||||||
# and the per-family ladders (Atmel-2486/2466/2503/2545/8271/DS40002065/
|
|
||||||
# 8272/8011/2593/42719). Synthetic 'F' replies: only the boot byte
|
|
||||||
# carries meaning.
|
|
||||||
cases = (
|
|
||||||
((0x1E, 0x93, 0x07), 0x2000, 3, {0b11: 0x1F00, 0b10: 0x1E00, 0b01: 0x1C00, 0b00: 0x1800}), # m8
|
|
||||||
((0x1E, 0x94, 0x03), 0x4000, 3, {0b11: 0x3F00, 0b10: 0x3E00, 0b01: 0x3C00, 0b00: 0x3800}), # m16
|
|
||||||
((0x1E, 0x95, 0x02), 0x8000, 3, {0b11: 0x7E00, 0b10: 0x7C00, 0b01: 0x7800, 0b00: 0x7000}), # m32
|
|
||||||
((0x1E, 0x93, 0x0A), 0x2000, 2, {0b11: 0x1F00, 0b10: 0x1E00, 0b01: 0x1C00, 0b00: 0x1800}), # m88
|
|
||||||
((0x1E, 0x93, 0x0F), 0x2000, 2, {0b11: 0x1F00, 0b10: 0x1E00, 0b01: 0x1C00, 0b00: 0x1800}), # m88P
|
|
||||||
((0x1E, 0x94, 0x06), 0x4000, 2, {0b11: 0x3F00, 0b10: 0x3E00, 0b01: 0x3C00, 0b00: 0x3800}), # m168/168A
|
|
||||||
((0x1E, 0x94, 0x0B), 0x4000, 2, {0b11: 0x3F00, 0b10: 0x3E00, 0b01: 0x3C00, 0b00: 0x3800}), # m168P
|
|
||||||
((0x1E, 0x95, 0x14), 0x8000, 3, {0b11: 0x7E00, 0b10: 0x7C00, 0b01: 0x7800, 0b00: 0x7000}), # m328
|
|
||||||
((0x1E, 0x95, 0x0F), 0x8000, 3, {0b11: 0x7E00, 0b10: 0x7C00, 0b01: 0x7800, 0b00: 0x7000}), # m328P
|
|
||||||
((0x1E, 0x94, 0x0F), 0x4000, 3, {0b11: 0x3F00, 0b10: 0x3E00, 0b01: 0x3C00, 0b00: 0x3800}), # m164A
|
|
||||||
((0x1E, 0x94, 0x0A), 0x4000, 3, {0b11: 0x3F00, 0b10: 0x3E00, 0b01: 0x3C00, 0b00: 0x3800}), # m164P
|
|
||||||
((0x1E, 0x95, 0x15), 0x8000, 3, {0b11: 0x7E00, 0b10: 0x7C00, 0b01: 0x7800, 0b00: 0x7000}), # m324A
|
|
||||||
((0x1E, 0x96, 0x09), 0x10000, 3, {0b11: 0xFC00, 0b10: 0xF800, 0b01: 0xF000, 0b00: 0xE000}), # m644
|
|
||||||
((0x1E, 0x96, 0x0A), 0x10000, 3, {0b11: 0xFC00, 0b10: 0xF800, 0b01: 0xF000, 0b00: 0xE000}), # m644P
|
|
||||||
((0x1E, 0x97, 0x06), 0x20000, 3, {0b11: 0x1FC00, 0b10: 0x1F800, 0b01: 0x1F000, 0b00: 0x1E000}), # 1284
|
|
||||||
((0x1E, 0x97, 0x05), 0x20000, 3, {0b11: 0x1FC00, 0b10: 0x1F800, 0b01: 0x1F000, 0b00: 0x1E000}), # 1284P
|
|
||||||
)
|
|
||||||
for signature, flash, which, ladder in cases:
|
|
||||||
# Word-addressed chips carry the 1 KiB slot (their smallest boot sector).
|
|
||||||
slot = 1024 if flash > 0x10000 else 512
|
|
||||||
chip = info_of(pb, flash - slot, 128 if flash < 0x20000 else 0, False, flash,
|
|
||||||
signature=signature, word_flash=flash > 0x10000)
|
|
||||||
for bits, start in ladder.items():
|
|
||||||
fuses = bytearray((0xFF, 0xFF, 0xFF, 0xFF))
|
|
||||||
fuses[which] = (0xF8 | (bits << 1)) & ~1
|
|
||||||
prog, at = pb.mega_boot(chip, bytes(fuses))
|
|
||||||
if not prog or at != start:
|
|
||||||
fail(f"mega_boot {signature[1]:02x}{signature[2]:02x} BOOTSZ={bits:02b} programmed: {prog} {at:#07x}")
|
|
||||||
fuses[which] |= 1
|
|
||||||
prog, at = pb.mega_boot(chip, bytes(fuses))
|
|
||||||
if prog or at != start:
|
|
||||||
fail(f"mega_boot {signature[1]:02x}{signature[2]:02b} unprogrammed: {prog} {at:#07x}")
|
|
||||||
|
|
||||||
# Word-addressed info decode: the 1284P's base/page ride the wire scaled,
|
|
||||||
# and its slot is 1 KiB.
|
|
||||||
big = info_of(pb, 0x1FC00, 0, False, 0x20000, signature=(0x1E, 0x97, 0x05), word_flash=True)
|
|
||||||
if big.page != 256 or big.base != 0x1FC00 or big.stage != 0x1F800 or big.slot != 1024:
|
|
||||||
fail(f"word-addressed info decode: page {big.page}, base {big.base:#x}, stage {big.stage:#x}")
|
|
||||||
|
|
||||||
# Surgery: word 0 lands on the loader, the trampoline on the original
|
|
||||||
# entry — checked with an independent decoder.
|
|
||||||
app = bytes((0xC0 | 0x00, 0xC0)) + bytes((0x12,)) * 300 # rjmp .+0x00C0... entry word 0xC0C0
|
|
||||||
entry = rjmp_decode(app[0] | (app[1] << 8), 0, tiny.flash_size // 2)
|
|
||||||
pages = pb.plan_flash(app, tiny)
|
|
||||||
word0 = pages[0][0] | (pages[0][1] << 8)
|
|
||||||
if rjmp_decode(word0, 0, tiny.flash_size // 2) != tiny.base // 2:
|
|
||||||
fail("surgery: patched word 0 misses the loader")
|
|
||||||
tp = pages[tiny.base - 64]
|
|
||||||
tramp = tp[62] | (tp[63] << 8)
|
|
||||||
if rjmp_decode(tramp, (tiny.base - 2) // 2, tiny.flash_size // 2) != entry:
|
|
||||||
fail("surgery: trampoline misses the original entry")
|
|
||||||
expect_error("non-rjmp vector", lambda: pb.plan_flash(bytes((0x0C, 0x94)) + app[2:], tiny), "not an rjmp")
|
|
||||||
looped = bytearray(app)
|
|
||||||
word = pb.rjmp_to(0, tiny.base // 2, tiny.flash_size // 2)
|
|
||||||
looped[0], looped[1] = word & 0xFF, word >> 8
|
|
||||||
expect_error("read-back image", lambda: pb.plan_flash(bytes(looped), tiny), "read-back")
|
|
||||||
expect_error("oversize image", lambda: pb.plan_flash(bytes(0x1DFF), tiny), "application flash ends")
|
|
||||||
|
|
||||||
# Ordering: patched vector puts page 0 first and the trampoline second;
|
|
||||||
# a boot section puts page 0 last. Blank pages drop only when erased.
|
|
||||||
order = pb.covered(pages, tiny, skip_blank=False)
|
|
||||||
if order[0] != 0 or order[1] != tiny.base - 64:
|
|
||||||
fail(f"tiny order starts {order[:2]}, want page 0 then trampoline page")
|
|
||||||
if sorted(order[2:]) != order[2:]:
|
|
||||||
fail("tiny order tail not ascending")
|
|
||||||
mega_pages = pb.plan_flash(bytes((0xFF,)) * 600, mega)
|
|
||||||
morder = pb.covered(mega_pages, mega, skip_blank=False)
|
|
||||||
if morder[-1] != 0 or sorted(morder[:-1]) != morder[:-1]:
|
|
||||||
fail(f"mega order {morder}, want ascending with page 0 last")
|
|
||||||
blanky = {0: pages[0], 64: bytes((0xFF,)) * 64, 128: pages[128], tiny.base - 64: tp}
|
|
||||||
slim = pb.covered(blanky, tiny, skip_blank=True)
|
|
||||||
if 64 in slim or 0 not in slim or tiny.base - 64 not in slim:
|
|
||||||
fail(f"skip_blank order wrong: {slim}")
|
|
||||||
|
|
||||||
# Staging content: the identical image plus the through-word on a
|
|
||||||
# patched-vector chip; hard size clamps either way.
|
|
||||||
image = bytes(range(256)) * 2 # 512 B — too big for a tiny slot
|
|
||||||
expect_error("tiny staging size", lambda: pb.staging_content(image, tiny), "510")
|
|
||||||
staged = pb.staging_content(image[:508], tiny)
|
|
||||||
through = staged[510] | (staged[511] << 8)
|
|
||||||
if rjmp_decode(through, (tiny.base - 2) // 2, tiny.flash_size // 2) != tiny.base // 2:
|
|
||||||
fail("through-word misses the resident base")
|
|
||||||
if pb.staging_content(image, mega) != image:
|
|
||||||
fail("mega staging content should be the bare image")
|
|
||||||
expect_error("mega staging size", lambda: pb.staging_content(image + b"!", mega), "512")
|
|
||||||
|
|
||||||
# The embedded info block: found in a synthetic binary, absent in noise.
|
|
||||||
binary = bytes((0xAA,)) * 10 + tiny.raw + bytes((0xBB,)) * 10
|
|
||||||
found = pb.image_info(binary)
|
|
||||||
if found is None or found.raw != tiny.raw:
|
|
||||||
fail("image_info misses the embedded block")
|
|
||||||
if pb.image_info(bytes((0xAA,)) * 40) is not None:
|
|
||||||
fail("image_info invents a block")
|
|
||||||
# An older loader's image stays readable, so a deployed build can be
|
|
||||||
# identified and installed like any other.
|
|
||||||
old = info_of(pb, 0x1E00, 64, True, 0x2000, version=pb.OLDEST_LOADER)
|
|
||||||
found_old = pb.image_info(bytes((0xAA,)) * 10 + old.raw)
|
|
||||||
if found_old is None or found_old.version != pb.OLDEST_LOADER:
|
|
||||||
fail("image_info misses an older loader's block")
|
|
||||||
|
|
||||||
# loader_image must peel a padded image down to the slot content: a raw
|
|
||||||
# .bin padded from address 0 (or a whole-flash read-back with the loader
|
|
||||||
# resident at base) yields the same bytes as the bare slot image.
|
|
||||||
import tempfile
|
|
||||||
slot_image = bytes((0xAA,)) * 10 + tiny.raw + bytes((0xCC,)) * 40
|
|
||||||
padded = bytes((0xFF,)) * tiny.base + slot_image
|
|
||||||
with tempfile.NamedTemporaryFile(suffix=".bin", delete=False) as f:
|
|
||||||
f.write(padded)
|
|
||||||
padded_path = f.name
|
|
||||||
try:
|
|
||||||
if pb.loader_image(padded_path) != slot_image:
|
|
||||||
fail("loader_image does not peel a padded image to the slot content")
|
|
||||||
finally:
|
|
||||||
os.unlink(padded_path)
|
|
||||||
|
|
||||||
# Update preflight: the full fuse matrix, plus target mismatch.
|
|
||||||
other = info_of(pb, 0x1E00, 32, True, 0x2000)
|
|
||||||
expect_error("wrong-target image", lambda: pb.update_preflight(binary, other, None), "another target")
|
|
||||||
expect_error("mega needs fuses", lambda: pb.update_preflight(bytes((0xAA,)) * 8 + mega.raw, mega, None),
|
|
||||||
"--assume-fuses")
|
|
||||||
mega_image = bytes((0xAA,)) * 8 + mega.raw
|
|
||||||
|
|
||||||
def fuses(high):
|
|
||||||
return bytes((0xFF, 0xFF, 0xFF, high))
|
|
||||||
|
|
||||||
expect_error("BOOTSZ 512 B", lambda: pb.update_preflight(mega_image, mega, fuses(0xFE)),
|
|
||||||
"cannot self-update", "BOOTSZ")
|
|
||||||
notes = pb.update_preflight(mega_image, mega, fuses(0xFD)) # 1 KB, BOOTRST unprogrammed
|
|
||||||
if not any("BOOTRST unprogrammed" in n for n in notes):
|
|
||||||
fail(f"1K/unprogrammed notes: {notes}")
|
|
||||||
notes = pb.update_preflight(mega_image, mega, fuses(0xFC)) # 1 KB, BOOTRST programmed
|
|
||||||
if not any("staging slot" in n for n in notes):
|
|
||||||
fail(f"1K/programmed notes: {notes}")
|
|
||||||
notes = pb.update_preflight(mega_image, mega, fuses(0xFA)) # 2 KB, BOOTRST programmed
|
|
||||||
if not any("application flash" in n for n in notes):
|
|
||||||
fail(f"2K/programmed notes: {notes}")
|
|
||||||
if pb.update_preflight(bytes((0xAA,)) * 8 + tiny.raw, tiny, None) != []:
|
|
||||||
fail("tiny preflight should pass without fuses")
|
|
||||||
|
|
||||||
# The walk-region refusal: BOOTRST aimed below the loader plus app data
|
|
||||||
# in the walk span errors without --force; erased spans and unprogrammed
|
|
||||||
# BOOTRST pass.
|
|
||||||
deep = {0x7800: bytes((1,)) * 128}
|
|
||||||
expect_error("walk region", lambda: pb.check_walk_region(deep, mega, fuses(0xFA), False), "--force")
|
|
||||||
pb.check_walk_region(deep, mega, fuses(0xFA), True)
|
|
||||||
pb.check_walk_region(deep, mega, fuses(0xFB), False) # BOOTRST unprogrammed
|
|
||||||
pb.check_walk_region({0x7800: bytes((0xFF,)) * 128}, mega, fuses(0xFA), False)
|
|
||||||
pb.check_walk_region(deep, mega, None, False) # fuses unknown: no check
|
|
||||||
|
|
||||||
# The repairing verify: a mismatched page is rewritten rather than raised,
|
|
||||||
# bounded so a fault that is not self-clearing cannot spin.
|
|
||||||
class FakeLoader:
|
|
||||||
"""A device whose first `bad` writes of any page land wrong."""
|
|
||||||
|
|
||||||
def __init__(self, info, bad):
|
|
||||||
self.info = info
|
|
||||||
self.bad = bad
|
|
||||||
self.flash = {}
|
|
||||||
self.writes = 0
|
|
||||||
|
|
||||||
def write_page(self, address, data):
|
|
||||||
self.writes += 1
|
|
||||||
self.flash[address] = bytes(len(data)) if self.bad > 0 else bytes(data)
|
|
||||||
self.bad -= 1
|
|
||||||
|
|
||||||
def read_flash(self, address, count):
|
|
||||||
return self.flash.get(address, bytes(count))
|
|
||||||
|
|
||||||
want = {0: bytes((i * 5) & 0xFF for i in range(128))}
|
|
||||||
|
|
||||||
# One bad write, then good: repaired in place, and the caller never sees
|
|
||||||
# an error. The rewrite is counted, so a silent no-op cannot pass.
|
|
||||||
device = FakeLoader(info_of(pb, 0x7E00, 128, False, 0x8000), bad=1)
|
|
||||||
device.write_page(0, want[0])
|
|
||||||
pb.verify_pages(device, want, repair=True)
|
|
||||||
if device.writes != 2:
|
|
||||||
fail(f"repairing verify made {device.writes} writes, expected 2")
|
|
||||||
|
|
||||||
# Without repair the same state raises, so the repair is what fixed it.
|
|
||||||
device = FakeLoader(info_of(pb, 0x7E00, 128, False, 0x8000), bad=1)
|
|
||||||
device.write_page(0, want[0])
|
|
||||||
expect_error("verify without repair", lambda: pb.verify_pages(device, want), "verify failed")
|
|
||||||
|
|
||||||
# A page that never comes good stops after RETRIES rewrites, and says so.
|
|
||||||
device = FakeLoader(info_of(pb, 0x7E00, 128, False, 0x8000), bad=99)
|
|
||||||
device.write_page(0, want[0])
|
|
||||||
expect_error(
|
|
||||||
"unrepairable page",
|
|
||||||
lambda: pb.verify_pages(device, want, repair=True),
|
|
||||||
"verify failed",
|
|
||||||
f"after {pb.RETRIES} retries",
|
|
||||||
)
|
|
||||||
if device.writes != pb.RETRIES + 1:
|
|
||||||
fail(f"unrepairable page took {device.writes} writes, expected {pb.RETRIES + 1}")
|
|
||||||
|
|
||||||
print("test_planner: all planner and policy checks pass")
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
# The port's gate: every chip's generated workflow — build, size matrix, and
|
|
||||||
# the simulator-driven protocol suites. --full adds the reflect-spot builds
|
|
||||||
# (libavr's rule: reflect compiles are bounded to its spot set, never the
|
|
||||||
# full matrix). LIBAVR_ROOT must point at the libavr checkout.
|
|
||||||
set -e
|
|
||||||
cd "$(dirname "$0")/.."
|
|
||||||
|
|
||||||
full=0
|
|
||||||
[[ "$1" == "--full" ]] && { full=1; shift; }
|
|
||||||
|
|
||||||
CHIPS=(attiny13 attiny13a attiny25 attiny45 attiny85
|
|
||||||
atmega8 atmega8a atmega16 atmega16a atmega32 atmega32a
|
|
||||||
atmega48 atmega48a atmega48p atmega48pa
|
|
||||||
atmega88 atmega88a atmega88p atmega88pa
|
|
||||||
atmega168 atmega168a atmega168p atmega168pa
|
|
||||||
atmega328 atmega328p
|
|
||||||
atmega164a atmega164p atmega164pa
|
|
||||||
atmega324a atmega324p atmega324pa
|
|
||||||
atmega644 atmega644a atmega644p atmega644pa
|
|
||||||
atmega1284 atmega1284p)
|
|
||||||
REFLECT_SPOT=(attiny13a attiny85 atmega8 atmega16a atmega32a atmega48pa
|
|
||||||
atmega88 atmega168pa atmega328p atmega164a atmega644p atmega1284)
|
|
||||||
|
|
||||||
for chip in "${CHIPS[@]}"; do
|
|
||||||
echo "==== $chip ===="
|
|
||||||
cmake --workflow --preset "$chip-generated" "$@"
|
|
||||||
done
|
|
||||||
|
|
||||||
if ((full)); then
|
|
||||||
for chip in "${REFLECT_SPOT[@]}"; do
|
|
||||||
echo "==== $chip reflect ===="
|
|
||||||
cmake --workflow --preset "$chip-reflect" "$@"
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "check: every chip green"
|
|
||||||
@@ -1,90 +0,0 @@
|
|||||||
#!/usr/bin/env python3
|
|
||||||
"""Regenerate CMakePresets.json — one uniform pipeline per chip.
|
|
||||||
|
|
||||||
Every chip gets generated-mode configure/build/test presets and a workflow
|
|
||||||
running all three. Reflect-mode presets (configure + build, no tests — the
|
|
||||||
port's TUs compile identically; the sims prove nothing new there) exist for
|
|
||||||
libavr's reflect spot set only, mirroring its rule: the full reflect matrix
|
|
||||||
is never built, one chip per hardware class and pack vintage is.
|
|
||||||
|
|
||||||
Run from the repo root: tools/make_presets.py
|
|
||||||
"""
|
|
||||||
|
|
||||||
import json
|
|
||||||
import os
|
|
||||||
|
|
||||||
CHIPS = [
|
|
||||||
"attiny13", "attiny13a", "attiny25", "attiny45", "attiny85",
|
|
||||||
"atmega8", "atmega8a", "atmega16", "atmega16a", "atmega32", "atmega32a",
|
|
||||||
"atmega48", "atmega48a", "atmega48p", "atmega48pa",
|
|
||||||
"atmega88", "atmega88a", "atmega88p", "atmega88pa",
|
|
||||||
"atmega168", "atmega168a", "atmega168p", "atmega168pa",
|
|
||||||
"atmega328", "atmega328p",
|
|
||||||
"atmega164a", "atmega164p", "atmega164pa",
|
|
||||||
"atmega324a", "atmega324p", "atmega324pa",
|
|
||||||
"atmega644", "atmega644a", "atmega644p", "atmega644pa",
|
|
||||||
"atmega1284", "atmega1284p",
|
|
||||||
]
|
|
||||||
|
|
||||||
# libavr's REFLECT_SPOT (tools/check.sh): one chip per hardware class and
|
|
||||||
# pack vintage.
|
|
||||||
REFLECT_SPOT = [
|
|
||||||
"attiny13a", "attiny85", "atmega8", "atmega16a", "atmega32a",
|
|
||||||
"atmega48pa", "atmega88", "atmega168pa", "atmega328p", "atmega164a",
|
|
||||||
"atmega644p", "atmega1284",
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
configure = [{
|
|
||||||
"name": "base",
|
|
||||||
"hidden": True,
|
|
||||||
"generator": "Ninja",
|
|
||||||
"binaryDir": "${sourceDir}/build/${presetName}",
|
|
||||||
"toolchainFile": "$env{LIBAVR_ROOT}/cmake/avr-toolchain.cmake",
|
|
||||||
"cacheVariables": {
|
|
||||||
"CMAKE_BUILD_TYPE": "Release",
|
|
||||||
"CMAKE_EXPORT_COMPILE_COMMANDS": "ON",
|
|
||||||
"CMAKE_COLOR_DIAGNOSTICS": "ON",
|
|
||||||
},
|
|
||||||
}]
|
|
||||||
build, test, workflows = [], [], []
|
|
||||||
|
|
||||||
def add(chip, mode):
|
|
||||||
name = f"{chip}-{mode}"
|
|
||||||
configure.append({
|
|
||||||
"name": name,
|
|
||||||
"inherits": "base",
|
|
||||||
"cacheVariables": {
|
|
||||||
"LIBAVR_MCU": chip,
|
|
||||||
"LIBAVR_REFLECT": "ON" if mode == "reflect" else "OFF",
|
|
||||||
},
|
|
||||||
})
|
|
||||||
build.append({"name": name, "configurePreset": name})
|
|
||||||
steps = [{"type": "configure", "name": name}, {"type": "build", "name": name}]
|
|
||||||
if mode == "generated":
|
|
||||||
test.append({"name": name, "configurePreset": name, "output": {"outputOnFailure": True}})
|
|
||||||
steps.append({"type": "test", "name": name})
|
|
||||||
workflows.append({"name": name, "steps": steps})
|
|
||||||
|
|
||||||
for chip in CHIPS:
|
|
||||||
add(chip, "generated")
|
|
||||||
for chip in REFLECT_SPOT:
|
|
||||||
add(chip, "reflect")
|
|
||||||
|
|
||||||
presets = {
|
|
||||||
"version": 8,
|
|
||||||
"configurePresets": configure,
|
|
||||||
"buildPresets": build,
|
|
||||||
"testPresets": test,
|
|
||||||
"workflowPresets": workflows,
|
|
||||||
}
|
|
||||||
path = os.path.join(os.path.dirname(os.path.abspath(__file__)), "..", "CMakePresets.json")
|
|
||||||
with open(path, "w") as f:
|
|
||||||
json.dump(presets, f, indent=1)
|
|
||||||
f.write("\n")
|
|
||||||
print(f"{len(CHIPS)} chips, {len(REFLECT_SPOT)} reflect: {os.path.normpath(path)}")
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
Reference in New Issue
Block a user