mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
88 lines
2.7 KiB
C
88 lines
2.7 KiB
C
/*
|
|
* Copyright (C) 2020 Christian Amsüss <chrysn@fsfe.org>
|
|
*
|
|
* This file is subject to the terms and conditions of the GNU Lesser
|
|
* General Public License v2.1. See the file LICENSE in the top level
|
|
* directory for more details.
|
|
*/
|
|
/** @ingroup bootloaders
|
|
*
|
|
* @{
|
|
*
|
|
* @file
|
|
* @brief Configuration for the riotboot_dfu bootloader
|
|
*
|
|
* @author Christian Amsüss <chrysn@fsfe.org>
|
|
*/
|
|
|
|
/* Include guards and cplusplus are more of a formality; this header is local
|
|
* to the riotboot_dfu application that isn't written in C++ and not included
|
|
* from anywhere else either, but still here for consistency (and because
|
|
* otherwise the checks complain) */
|
|
#ifndef RIOTBOOT_BOOTLOADER_SELECTION_H
|
|
#define RIOTBOOT_BOOTLOADER_SELECTION_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Not including GPIO headers: we're not actually *doing* anything on GPIO, and
|
|
* if no BTN0_PIN is defined we don't define anything either */
|
|
#include <board.h>
|
|
|
|
/** @brief 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`.
|
|
*
|
|
* */
|
|
#if (!defined(BTN_BOOTLOADER_PIN) && defined(BTN0_PIN) && !defined(BTN_BOOTLOADER_NONE)) || DOXYGEN
|
|
#define BTN_BOOTLOADER_PIN BTN0_PIN
|
|
#endif
|
|
|
|
/** @brief Pin mode for @ref BTN_BOOTLOADER_PIN
|
|
*
|
|
* Mode into which the riotboot_dfu bootloader will configure @ref
|
|
* BTN_BOOTLOADER_PIN before reading it.
|
|
*
|
|
* */
|
|
#ifndef BTN_BOOTLOADER_MODE
|
|
#define BTN_BOOTLOADER_MODE BTN0_MODE
|
|
#endif
|
|
|
|
/** @brief Interpretation of @ref 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
|
|
*/
|
|
#ifndef BTN_BOOTLOADER_EXT_PULLUP
|
|
#define BTN_BOOTLOADER_EXT_PULLUP false
|
|
#endif
|
|
|
|
/** @brief 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.
|
|
*/
|
|
#if !defined(LED_BOOTLOADER_PIN) && defined(LED0_PIN) && !defined(LED_BOOTLOADER_NONE) || DOXYGEN
|
|
#define LED_BOOTLOADER_PIN LED0_PIN
|
|
#define LED_BOOTLOADER_ON LED0_ON /**< Turn the bootloader LED on */
|
|
#define LED_BOOTLOADER_OFF LED0_OFF /**< Turn the bootloader LED off */
|
|
#define LED_BOOTLOADER_TOGGLE LED0_TOGGLE /**< Toggle the bootloader LED */
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* RIOTBOOT_BOOTLOADER_SELECTION_H */
|
|
|
|
/** @} */
|