Author: Riku Isokoski <riksu9000@gmail.com>
files-needed-by-factory: Move to separate document These are instructions for maintainers, and should be in a separate document.
README.md | 1 doc/buildAndProgram.md | 38 ------------------------------------ doc/files-needed-by-factory.md | 37 +++++++++++++++++++++++++++++++++++
diff --git a/README.md b/README.md index 7b8ddde15dc377ff28da5788a9d1b0c25bee8dfc..b4a9cb65a8603bde51a61089aa68c9f40bfd59be 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,7 @@ - [Maintainer's guide](doc/maintainer-guide.md) - [Versioning](doc/versioning.md) - [Project branches](doc/branches.md) - [Files included in the release notes](doc/filesInReleaseNotes.md) +- [Files needed by the factory](doc/files-needed-by-factory.md) ## Licenses diff --git a/doc/buildAndProgram.md b/doc/buildAndProgram.md index 78bea1b458b5dbfc658486bbae51d0db88839694..260ae8c52c90846a0d0f3f1fce9798f4f7a7d7f3 100644 --- a/doc/buildAndProgram.md +++ b/doc/buildAndProgram.md @@ -89,41 +89,3 @@ - **pinetime-mcuboot-app-image** : MCUBoot image of the firmware - **pinetime-mcuboot-ap-dfu** : DFU file of the firmware The same files are generated for **pinetime-recovery** and **pinetime-recoveryloader** - -### How to generate files needed by the factory - -These files are needed by the Pine64 factory to flash InfiniTime as the default firmware on the PineTimes. - -Two files are needed: an **HEX (.hex)** file that contains the content of the internal flash memory (bootloader + InfiniTime) and a **binary (.bin)** file that contains the content of the external flash memory (recovery firmware). - -#### merged-internal.hex - -First, convert the bootloader to hex: - -``` -<ARM TOOLCHAIN>/bin/arm-none-eabi-objcopy -I binary -O ihex ./bootloader.bin ./bootloader.hex -``` - -where `bootloader.bin` is the [last stable version](https://github.com/JF002/pinetime-mcuboot-bootloader/releases) of the [bootloader](https://github.com/JF002/pinetime-mcuboot-bootloader). - -Then, convert the MCUBoot image of InfiniTime: - -``` -<ARM TOOLCHAIN>/bin/arm-none-eabi-objcopy -I binary -O ihex --change-addresses 0x8000 ./pinetime-mcuboot-app-image-1.6.0.bin ./pinetime-mcuboot-app-image-1.6.0.hex -``` - -where `pinetime-mcuboot-app-image-1.6.0.bin` is [the bin of the last MCUBoot image](https://github.com/InfiniTimeOrg/InfiniTime/releases) of [InfiniTime](https://github.com/InfiniTimeOrg/InfiniTime). - -Pay attention to the parameter `--change-addresses 0x8000`. It's needed to ensure the image will be flashed at the offset expected by the bootloader (0x8000). - -Finally, merge them together with **mergehex**: - -``` -/opt/mergehex/mergehex -m ./bootloader.hex ./pinetime-mcuboot-app-image-1.6.0.hex -o merged-internal.hex -``` - -This file must be flashed at offset **0x00** of the internal memory of the NRF52832. - -#### spinor.bin - -This file is the MCUBoot image of the last stable version of the recovery firmware. It must be flashed at offset **0x00** of the external SPINOR flash memory. diff --git a/doc/files-needed-by-factory.md b/doc/files-needed-by-factory.md new file mode 100644 index 0000000000000000000000000000000000000000..f99a29b66cea7aeb4845c58e5c9c9f6934996f9d --- /dev/null +++ b/doc/files-needed-by-factory.md @@ -0,0 +1,37 @@ +# How to generate files needed by the factory + +These files are needed by the Pine64 factory to flash InfiniTime as the default firmware on the PineTimes. + +Two files are needed: an **HEX (.hex)** file that contains the content of the internal flash memory (bootloader + InfiniTime) and a **binary (.bin)** file that contains the content of the external flash memory (recovery firmware). + +#### merged-internal.hex + +First, convert the bootloader to hex: + +``` +<ARM TOOLCHAIN>/bin/arm-none-eabi-objcopy -I binary -O ihex ./bootloader.bin ./bootloader.hex +``` + +where `bootloader.bin` is the [last stable version](https://github.com/JF002/pinetime-mcuboot-bootloader/releases) of the [bootloader](https://github.com/JF002/pinetime-mcuboot-bootloader). + +Then, convert the MCUBoot image of InfiniTime: + +``` +<ARM TOOLCHAIN>/bin/arm-none-eabi-objcopy -I binary -O ihex --change-addresses 0x8000 ./pinetime-mcuboot-app-image-1.6.0.bin ./pinetime-mcuboot-app-image-1.6.0.hex +``` + +where `pinetime-mcuboot-app-image-1.6.0.bin` is [the bin of the last MCUBoot image](https://github.com/InfiniTimeOrg/InfiniTime/releases) of [InfiniTime](https://github.com/InfiniTimeOrg/InfiniTime). + +Pay attention to the parameter `--change-addresses 0x8000`. It's needed to ensure the image will be flashed at the offset expected by the bootloader (0x8000). + +Finally, merge them together with **mergehex**: + +``` +/opt/mergehex/mergehex -m ./bootloader.hex ./pinetime-mcuboot-app-image-1.6.0.hex -o merged-internal.hex +``` + +This file must be flashed at offset **0x00** of the internal memory of the NRF52832. + +#### spinor.bin + +This file is the MCUBoot image of the last stable version of the recovery firmware. It must be flashed at offset **0x00** of the external SPINOR flash memory.