Skip to content

Commit a3c489d

Browse files
committed
Update bootloader README.md formatting.
1 parent 41e9022 commit a3c489d

File tree

1 file changed

+22
-54
lines changed

1 file changed

+22
-54
lines changed

bootloaders/zero/README.md

Lines changed: 22 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ is running, the LED, if configured, will PWM fade quickly (~4Hz).
5555
file on the SD card with the already installed firmware. If they already match, then
5656
the bootloader will jump to the firmware, unless SDCARD_AUTORUN_DISABLED is defined,
5757
in which case the LED will blink with status code LED_STATUS_FILE_ALREADY_MATCHES.
58-
If the update file differs from the installed firmware, it continues to step 5.
58+
If the update file differs from the installed firmware, continue to step 5.
5959
5. The application section of the FLASH is erased. The selected update file is written
6060
to the FLASH. If the file exceeds the size of the FLASH, the LED will blink with
6161
status code LED_STATUS_FILE_TOO_LARGE.
@@ -391,14 +391,14 @@ BOOT_LOAD_PIN | 84
391391
SDCARD_USE_PIN1 & SDCARD_USE_PIN2 | 92
392392
SDCARD_USE_PIN1 | 60
393393
ARDUINO_EXTENDED_CAPABILITIES (X/Y/Z) | 904*
394-
*X (Chip Erase) & Y (Write FLASH)* | 120*
395-
*Z (CRC Verification)* | 248*
396-
*crc16Table* | 512*
394+
*X (Chip Erase) & Y (Write FLASH)* | 120*
395+
*Z (CRC Verification)* | 248*
396+
*crc16Table* | 512*
397397

398-
*SAM_BA_CDC and SAM_BA_UART automatically pull in SAM-BA Monitor*
399-
*ARDUINO_EXTENDED_CAPABILITIES and SDCARD_ENABLED include X and Y functions*
400-
*ARDUINO_EXTENDED_CAPABILITIES and SAM_BA_UART include crc16Table*
401-
*ARDUINO_EXTENDED_CAPABILITIES includes Z function*
398+
* SAM_BA_CDC and SAM_BA_UART automatically pull in SAM-BA Monitor
399+
* ARDUINO_EXTENDED_CAPABILITIES and SDCARD_ENABLED include X and Y functions
400+
* ARDUINO_EXTENDED_CAPABILITIES and SAM_BA_UART include crc16Table
401+
* ARDUINO_EXTENDED_CAPABILITIES includes Z function
402402

403403
#### Example Compiled Binary Size
404404

@@ -427,12 +427,8 @@ See "SD Card Bootloader" section. This define can also be set from the
427427
makefile (so it can be used with the build_all_bootloaders.sh script).
428428
Size: ~2788B. Disabled by default. Available with 4KB bootloader.
429429

430-
#### SDCARD_SPI_SERCOM_INSTANCE
431-
#### SDCARD_SPI_PAD_SETTINGS
432-
#### SDCARD_SPI_PAD0
433-
#### SDCARD_SPI_PAD1
434-
#### SDCARD_SPI_PAD2
435-
#### SDCARD_SPI_PAD3
430+
### SDCARD_SPI_SERCOM_INSTANCE
431+
#### SDCARD_SPI_PAD_SETTINGS, SDCARD_SPI_PAD0, SDCARD_SPI_PAD1, SDCARD_SPI_PAD2, SDCARD_SPI_PAD3
436432

437433
If SDCARD_ENABLED is defined, then all SDCARD_SPI_* defines must also be set.
438434
When setting SDCARD_SPI_PADx defines, consult the appropriate header file
@@ -442,23 +438,16 @@ Atmel/1.0.0-mattairtech-1/CMSIS/Device/ATMEL/sam<d21|c21|l21|d11>/include/
442438
When using SDCARD_USE_PIN1 or SDCARD_USE_PIN2, the SPI peripheral and
443439
associated pins are only initialized if either pin is active.
444440

445-
### SDCARD_SPI_CS_PORT
446-
### SDCARD_SPI_CS_PIN
441+
### SDCARD_SPI_CS_PORT, SDCARD_SPI_CS_PIN
447442

448443
If SDCARD_ENABLED is defined, then SDCARD_SPI_CS_PORT and SDCARD_SPI_CS_PIN
449444
must also be defined. PORT can be 0 (Port A) or 1 (Port B).
450445

451446
### SDCARD_USE_PIN1
452-
#### SDCARD_PIN1_POLARITY
453-
#### SDCARD_PIN1_PORT
454-
#### SDCARD_PIN1_PIN
455-
#### SDCARD_PIN1_CONFIG
447+
#### SDCARD_PIN1_POLARITY, SDCARD_PIN1_PORT, SDCARD_PIN1_PIN, SDCARD_PIN1_CONFIG
456448

457449
### SDCARD_USE_PIN2
458-
#### SDCARD_PIN2_POLARITY
459-
#### SDCARD_PIN2_PORT
460-
#### SDCARD_PIN2_PIN
461-
#### SDCARD_PIN2_CONFIG
450+
#### SDCARD_PIN2_POLARITY, SDCARD_PIN2_PORT, SDCARD_PIN2_PIN, SDCARD_PIN2_CONFIG
462451

463452
If SDCARD_ENABLED is defined, then SDCARD_USE_PIN1 and SDCARD_USE_PIN2 can
464453
optionally be defined. When SDCARD_USE_PIN2 is defined, SDCARD_USE_PIN1 must
@@ -492,10 +481,7 @@ lacks USB, so set to SAM_BA_UART_ONLY in this case. By default,
492481
SAM_BA_USBCDC_ONLY is set (SAM_BA_UART_ONLY with the C21).
493482

494483
### SAM_BA_INTERFACE_USE_PIN
495-
#### SAM_BA_INTERFACE_PIN_POLARITY
496-
#### SAM_BA_INTERFACE_PIN_PORT
497-
#### SAM_BA_INTERFACE_PIN_PIN
498-
#### SAM_BA_INTERFACE_PIN_CONFIG
484+
#### SAM_BA_INTERFACE_PIN_POLARITY, SAM_BA_INTERFACE_PIN_PORT, SAM_BA_INTERFACE_PIN_PIN, SAM_BA_INTERFACE_PIN_CONFIG
499485

500486
If SAM_BA_INTERFACE_USE_PIN is defined, then the associated pin controls which
501487
SAM-BA interface is used (if SAM_BA_BOTH_INTERFACES is defined). If only one
@@ -568,26 +554,19 @@ The fine calibration value for DFLL open-loop mode is defined here.
568554
The coarse calibration value is loaded from NVM OTP (factory calibration values).
569555

570556
### USB_VENDOR_STRINGS_ENABLED
571-
#### STRING_MANUFACTURER
572-
#### STRING_PRODUCT
557+
#### STRING_MANUFACTURER, STRING_PRODUCT
573558

574559
If USB_VENDOR_STRINGS_ENABLED is defined, then STRING_MANUFACTURER and
575560
STRING_PRODUCT will be sent to the host.
576561
Size: ~228B. By default, USB_VENDOR_STRINGS_ENABLED is defined (including 4KB).
577562

578-
#### USB_VID_HIGH
579-
#### USB_VID_LOW
580-
#### USB_PID_HIGH
581-
#### USB_PID_LOW
563+
### USB_VID_HIGH
564+
#### USB_VID_LOW, USB_PID_HIGH, USB_PID_LOW
582565

583566
If USB CDC is used, then the USB vendor ID (VID) and product ID (PID) must be set.
584567

585568
### BOOT_USART_SERCOM_INSTANCE
586-
#### BOOT_USART_PAD_SETTINGS
587-
#### BOOT_USART_PAD3
588-
#### BOOT_USART_PAD2
589-
#### BOOT_USART_PAD1
590-
#### BOOT_USART_PAD0
569+
#### BOOT_USART_PAD_SETTINGS, BOOT_USART_PAD3, BOOT_USART_PAD2, BOOT_USART_PAD1, BOOT_USART_PAD0
591570

592571
BOOT_USART_SERCOM_INSTANCE must be a single digit representing the SERCOM number.
593572
See board_driver_serial.h for BOOT_USART_PAD_SETTINGS values. When setting
@@ -603,10 +582,7 @@ tapping two times on the reset button (within 1/2 second).
603582
Size: ~96B. Enabled by default.
604583

605584
### BOOT_LOAD_PIN_ENABLED
606-
#### BOOT_LOAD_PIN
607-
#### BOOT_LOAD_PIN_PORT
608-
#### BOOT_LOAD_PIN_POLARITY
609-
#### BOOT_LOAD_PIN_CONFIG
585+
#### BOOT_LOAD_PIN, BOOT_LOAD_PIN_PORT, BOOT_LOAD_PIN_POLARITY, BOOT_LOAD_PIN_CONFIG
610586

611587
If BOOT_LOAD_PIN_ENABLED is defined, the bootloader is started if the selected
612588
pin is active after reset. There is a 10ms delay before testing the pin to
@@ -622,17 +598,9 @@ If BOARD_LED_FADE_ENABLED is defined, then the main LED produces a PWM fade in a
622598
is running, the fading will be twice as fast as the SAM-BA interface (USB CDC or UART).
623599
Size: ~160B. Enabled by default.
624600

625-
### BOARD_LED_PORT
626-
#### BOARD_LED_PIN
627-
#### BOARD_LED_POLARITY
628-
629-
### BOARD_LEDRX_PORT
630-
#### BOARD_LEDRX_PIN
631-
#### BOARD_LEDRX_POLARITY
632-
633-
### BOARD_LEDTX_PORT
634-
#### BOARD_LEDTX_PIN
635-
#### BOARD_LEDTX_POLARITY
601+
### BOARD_LED_PORT, BOARD_LED_PIN, BOARD_LED_POLARITY
602+
#### BOARD_LEDRX_PORT, BOARD_LEDRX_PIN, BOARD_LEDRX_POLARITY
603+
#### BOARD_LEDTX_PORT, BOARD_LEDTX_PIN, BOARD_LEDTX_POLARITY
636604

637605
If the LED PORT is defined, then the LED on the associated pin is enabled.
638606
Polarity can be either LED_POLARITY_HIGH_ON or LED_POLARITY_LOW_ON.

0 commit comments

Comments
 (0)