bootloader_selection.h File Reference

Configuration for the riotboot_dfu bootloader. More...

Detailed Description

Configuration for the riotboot_dfu bootloader.

Author
Christian Amsüss chrys.nosp@m.n@fs.nosp@m.fe.or.nosp@m.g

Definition in file bootloader_selection.h.

#include <board.h>
+ Include dependency graph for bootloader_selection.h:

Go to the source code of this file.

#define BTN_BOOTLOADER_PIN   BTN0_PIN
 Button pin for bootloader selection. More...
 
#define BTN_BOOTLOADER_MODE   BTN0_MODE
 Pin mode for BTN_BOOTLOADER_PIN. More...
 
#define BTN_BOOTLOADER_EXT_PULLUP   false
 Interpretation of BTN_BOOTLOADER_PIN. More...
 
#define LED_BOOTLOADER_PIN   LED0_PIN
 LED pin for bootloader indication. More...
 
#define LED_BOOTLOADER_ON   LED0_ON
 Turn the bootloader LED on
More...
 
#define LED_BOOTLOADER_OFF   LED0_OFF
 Turn the bootloader LED off. More...
 
#define LED_BOOTLOADER_TOGGLE   LED0_TOGGLE
 Toggle the bootloader LED
More...
 

Macro Definition Documentation

◆ BTN_BOOTLOADER_EXT_PULLUP

#define BTN_BOOTLOADER_EXT_PULLUP   false

Interpretation of BTN_BOOTLOADER_PIN.

This value should be set to true if the button has an external pull-up and thus, works as an active-low button. If the button has an internal pull-up, the default value should remains false

Definition at line 66 of file bootloader_selection.h.

◆ BTN_BOOTLOADER_MODE

#define BTN_BOOTLOADER_MODE   BTN0_MODE

Pin mode for BTN_BOOTLOADER_PIN.

Mode into which the riotboot_dfu bootloader will configure BTN_BOOTLOADER_PIN before reading it.

Definition at line 56 of file bootloader_selection.h.

◆ BTN_BOOTLOADER_PIN

#define BTN_BOOTLOADER_PIN   BTN0_PIN

Button pin for bootloader selection.

This pin (typically connected to a button) is checked by the riotboot_dfu bootloader to decide whether to enter DFU mode even if a valid image is present.

The default value for all boards is BTN0, if one is defined.

Boards that insist on not using any button even though they have some can define BTN_BOOTLOADER_NONE in their board.h.

Definition at line 46 of file bootloader_selection.h.

◆ LED_BOOTLOADER_OFF

#define LED_BOOTLOADER_OFF   LED0_OFF

Turn the bootloader LED off.

Definition at line 77 of file bootloader_selection.h.

◆ LED_BOOTLOADER_ON

#define LED_BOOTLOADER_ON   LED0_ON

Turn the bootloader LED on

Definition at line 76 of file bootloader_selection.h.

◆ LED_BOOTLOADER_PIN

#define LED_BOOTLOADER_PIN   LED0_PIN

LED pin for bootloader indication.

This pin (typically connected to a LED) will be toggled while the bootloader is active. It can be used to communicate the current bootloader state to the user.

Definition at line 75 of file bootloader_selection.h.

◆ LED_BOOTLOADER_TOGGLE

#define LED_BOOTLOADER_TOGGLE   LED0_TOGGLE

Toggle the bootloader LED

Definition at line 78 of file bootloader_selection.h.