Commit 8f2c53db authored by schneider's avatar schneider
Browse files

move some bootloader info to gettingstarted

parent 6be72fea
Pipeline #4820 passed with stage
in 6 seconds
......@@ -4,21 +4,6 @@ title: Bootloader
# `card10` Bootloader
The bootloader allows you to:
- Change the software that the `card10` is executing
- Rescue a `card10` that does not have working software anymore
The bootloader can be activated by pressing the lower right button while turning on the `card10`:
<insert picture here>
Afterwards your operating system will show a new device attached via USB. You can now write and modify files which are on your `card10`. Simply copy all files from a firmware release to the file system and your `card10` is good to go. Simply turn off the `card10` using the button on the top left and turn it back on.
IMPORTANT: Make sure to use your operating "Eject Drive" feature before unplugging or turning off your `card10` (no, `umount` and `sync` are not enough!). This is a know limitation at the moment.
## Inner Workings
The bootloader tries to mount the external flash chip (8 MB) as a FAT file system and then read the `card10.bin` file from it. If the file can be read and is not corrupted, the bootloader checks if the internal flash already contains this file and writes it to the internal flash if needed. Afterwards the bootloader tries to execute the file inside the internal flash.
......@@ -27,13 +12,6 @@ The bootloader tries to mount the external flash chip (8 MB) as a FAT file syste
- If the bootloader fails to read a `card10.bin` file from the external flash, it will try to boot the file inside the internal flash.
## Trouble Shooting
If operating does not show a file system after activating the bootloader and attaching it via USB, a few things might be at fault:
- The file system might be corrupted. Please try to create a new FAT file system and copy over the data from a working firmware release.
- The USB cable might be broken. Check if your computer recognized a new device
## Inner Inner Workings
The bootloader sits at the beginning of the internal flash. It starts at address `0x1000 0000`. After the ROM code is done initializing the chip, it transfers execution to the code which address `0x1000 0004` points to. The bootloader can have a maximum size of 64 kB (as defined in `max32665_boot.ld`). At address `0x1001 0000` the code for core 0 starts (as defined in `max32665_core0.ld`. This is the address where the bootloader starts to write the contents of `card10.bin`. It then jumps to the address which `0x1001 0004` points to. It takes care to initialize the stack pointer and `SCB->VTOR` before doing so.
......
......@@ -35,7 +35,7 @@ state LED will remain blinking and glowing as you set it in the app.
### USB storage
Your card10 can function similar to a USB stick in its _USB storage mode_. You can use this mode to upload _configuration files_ , firmware updates and _MicropPython scripts_.
Your card10 can function similar to a USB stick in its _USB storage mode_. You can use this mode to upload configuration files , firmware updates and MicropPython scripts.
To enter _USB storage mode_, use POWER button to enter the menu. Now use the RIGHT button to select _USB Storage_ and press SELECT. If your card10 is connected to another computer via USB, it will show up as a storage device. Press any button to exit _USB storage mode_ again.
......@@ -43,6 +43,13 @@ To enter _USB storage mode_, use POWER button to enter the menu. Now use the RIG
If you don't have a _USB Storage_ menu entry or your card10 reboots while using it, you can also use the bootloader to access your card10: First switch off your card10 with a long press of the POWER button. Next, hold down the RIGHT button and the POWER button, until your display shows the text "USB activated. Ready.". Use your operating systems "Eject Safely" functiion or press the POWER button again to exit the bootloader after you are done.
#### Trouble shooting
If operating does not show a file system after activating _USB storage mode_ and attaching it via USB, a few things might be at fault:
- The file system might be corrupted. Please try to create a new FAT file system and copy over the data from a working firmware release.
- The USB cable might be broken. Check if your computer recognized a new device.
### Setting your nickname
To set your nickname, create a file called `nickname.txt` on your laptop.
Start your card10 in USB storage mode, then copy `nickname.txt` onto the card10. Eject the USB device.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment