djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
main
circuitpython/ports/atmel-samd/reset.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

45 lines
1.8 KiB
C
Raw Permalink Normal View History

atmel-samd: Reboot to bootloader when a 1200 baud serial connection is closed. This is how Arduino triggers the bootloader.
2017-07-06 16:41:13 -04:00
/*
Modernize module and class static dicts; update freetouch
2017-08-27 15:02:50 -04:00
* This file is part of the MicroPython project, http://micropython.org/
atmel-samd: Reboot to bootloader when a 1200 baud serial connection is closed. This is how Arduino triggers the bootloader.
2017-07-06 16:41:13 -04:00
*
* The MIT License (MIT)
*
* Copyright (c) 2017 Scott Shawcroft for Adafruit Industries
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
Initial merge of micropython v1.9.2 into circuitpython 2.0.0 (in development) master. cpx build compiles and loads and works in repl; test suite not run yet esp8266 not tested yet
2017-08-25 22:17:07 -04:00
#ifndef MICROPY_INCLUDED_ATMEL_SAMD_RESET_H
#define MICROPY_INCLUDED_ATMEL_SAMD_RESET_H
atmel-samd: Reboot to bootloader when a 1200 baud serial connection is closed. This is how Arduino triggers the bootloader.
2017-07-06 16:41:13 -04:00
merge from 2.2.0 + fix up board defs
2018-01-02 21:25:41 -05:00
#include <stdbool.h>
#include <stdint.h>
Add some NORETURN attributes I have a function where it should be impossible to reach the end, so I put in a safe-mode reset at the bottom: ``` int find_unused_slot(void) { // precondition: you already verified that a slot was available for (int i=0; i<NUM_SLOTS; i++) { if( slot_free(i)) { return i; } } safe_mode_reset(MICROPY_FATAL_ERROR); } ``` However, the compiler still gave a diagnostic, because safe_mode_reset was not declared NORETURN. So I started by teaching the compiler that reset_into_safe_mode never returned. This leads at least one level deeper due to reset_cpu needing to be a NORETURN function. Each port is a little different in this area. I also marked reset_to_bootloader as NORETURN. Additional notes: * stm32's reset_to_bootloader was not implemented, but now does a bare reset. Most stm32s are not fitted with uf2 bootloaders anyway. * ditto cxd56 * esp32s2 did not implement reset_cpu at all. I used esp_restart(). (not tested) * litex did not implement reset_cpu at all. I used reboot_ctrl_write. But notably this is what reset_to_bootloader already did, so one or the other must be incorrect (not tested). reboot_ctrl_write cannot be declared NORETURN, as it returns unless the special value 0xac is written), so a new unreachable forever-loop is added. * cxd56's reset is via a boardctl() call which can't generically be declared NORETURN, so a new unreacahble "for(;;)" forever-loop is added. * In several places, NVIC_SystemReset is redeclared with NORETURN applied. This is accepted just fine by gcc. I chose this as preferable to editing the multiple copies of CMSIS headers where it is normally declared. * the stub safe_mode reset simply aborts. This is used in mpy-cross.
2020-09-24 12:20:32 -04:00
#include "py/mpconfig.h"
merge from 2.2.0 + fix up board defs
2018-01-02 21:25:41 -05:00
// Copied from inc/uf2.h in https://github.com/Microsoft/uf2-samd21
#define DBL_TAP_MAGIC 0xf01669ef // Randomly selected, adjusted to have first and last bit set
atmel-samd: reset: reset() was always entering bootloader mode .. set the dbl_tap word to a different special value unless RUNMODE_BOOTLOADER was selected
2018-04-04 20:21:54 -04:00
#define DBL_TAP_MAGIC_QUICK_BOOT 0xf02669ef
merge from 2.2.0 + fix up board defs
2018-01-02 21:25:41 -05:00
extern uint32_t _bootloader_dbl_tap;
Add some NORETURN attributes I have a function where it should be impossible to reach the end, so I put in a safe-mode reset at the bottom: ``` int find_unused_slot(void) { // precondition: you already verified that a slot was available for (int i=0; i<NUM_SLOTS; i++) { if( slot_free(i)) { return i; } } safe_mode_reset(MICROPY_FATAL_ERROR); } ``` However, the compiler still gave a diagnostic, because safe_mode_reset was not declared NORETURN. So I started by teaching the compiler that reset_into_safe_mode never returned. This leads at least one level deeper due to reset_cpu needing to be a NORETURN function. Each port is a little different in this area. I also marked reset_to_bootloader as NORETURN. Additional notes: * stm32's reset_to_bootloader was not implemented, but now does a bare reset. Most stm32s are not fitted with uf2 bootloaders anyway. * ditto cxd56 * esp32s2 did not implement reset_cpu at all. I used esp_restart(). (not tested) * litex did not implement reset_cpu at all. I used reboot_ctrl_write. But notably this is what reset_to_bootloader already did, so one or the other must be incorrect (not tested). reboot_ctrl_write cannot be declared NORETURN, as it returns unless the special value 0xac is written), so a new unreachable forever-loop is added. * cxd56's reset is via a boardctl() call which can't generically be declared NORETURN, so a new unreacahble "for(;;)" forever-loop is added. * In several places, NVIC_SystemReset is redeclared with NORETURN applied. This is accepted just fine by gcc. I chose this as preferable to editing the multiple copies of CMSIS headers where it is normally declared. * the stub safe_mode reset simply aborts. This is used in mpy-cross.
2020-09-24 12:20:32 -04:00
void reset_to_bootloader(void) NORETURN;
void reset(void) NORETURN;
merge from 2.2.0 + fix up board defs
2018-01-02 21:25:41 -05:00
bool bootloader_available(void);
atmel-samd: Reboot to bootloader when a 1200 baud serial connection is closed. This is how Arduino triggers the bootloader.
2017-07-06 16:41:13 -04:00
Initial merge of micropython v1.9.2 into circuitpython 2.0.0 (in development) master. cpx build compiles and loads and works in repl; test suite not run yet esp8266 not tested yet
2017-08-25 22:17:07 -04:00
#endif // MICROPY_INCLUDED_ATMEL_SAMD_RESET_H
Reference in New Issue Copy Permalink