Move STM32 bootloader address config to separate .h file.

diff --git a/keyboard/chibi_onekey/Makefile b/keyboard/chibi_onekey/Makefile
index 2d5ff8cdceb38892e9f215dbbc3f549fcbabb395..2c5af44bf1de39ad37f34787fbccb7e582aff172 100644 (file)
--- a/keyboard/chibi_onekey/Makefile
+++ b/keyboard/chibi_onekey/Makefile
@@ -37,12 +37,16 @@ MCU_STARTUP = stm32f0xx
 BOARD = ST_STM32F072B_DISCOVERY
 # ARM version, CORTEX-M0/M1 are 6, CORTEX-M3/M4/M7 are 7
 ARMV = 6
 BOARD = ST_STM32F072B_DISCOVERY
 # ARM version, CORTEX-M0/M1 are 6, CORTEX-M3/M4/M7 are 7
 ARMV = 6

-# If you want to be able to jump to bootloader from firmware (on STM32 MCUs),
-# set the correct BOOTLOADER_ADDRESS here. Otherwise leave commented out.
+# If you want to be able to jump to bootloader from firmware on STM32 MCUs,
+# set the correct BOOTLOADER_ADDRESS. Either set it here, or define it in
+# ./bootloader_defs.h or in ./boards/<FOO>/bootloader_defs.h (if you have
+# a custom board definition that you plan to reuse).
+# If you're not setting it here, leave it commented out.

 # It is chip dependent, the correct number can be looked up here (page 175):
 # http://www.st.com/web/en/resource/technical/document/application_note/CD00167594.pdf
 # It is chip dependent, the correct number can be looked up here (page 175):
 # http://www.st.com/web/en/resource/technical/document/application_note/CD00167594.pdf

-# This also requires a patch to chibios: <tmk_dir>/tmk_core/
-BOOTLOADER_ADDRESS = 0x1FFFC800
+# This also requires a patch to chibios:
+#   <tmk_dir>/tmk_core/tool/chibios/ch-bootloader-jump.patch
+#STM32_BOOTLOADER_ADDRESS = 0x1FFFC800

 
 # Build Options
 #   comment out to disable the options.
 
 # Build Options
 #   comment out to disable the options.

diff --git a/keyboard/chibi_onekey/bootloader_defs.h b/keyboard/chibi_onekey/bootloader_defs.h
new file mode 100644 (file)
index 0000000..02c48c4
--- /dev/null
+++ b/keyboard/chibi_onekey/bootloader_defs.h
@@ -0,0 +1,7 @@
+/* Address for jumping to bootloader on STM32 chips. */
+/* It is chip dependent, the correct number can be looked up here (page 175):
+ * http://www.st.com/web/en/resource/technical/document/application_note/CD00167594.pdf
+ * This also requires a patch to chibios:
+ *  <tmk_dir>/tmk_core/tool/chibios/ch-bootloader-jump.patch
+ */
+#define STM32_BOOTLOADER_ADDRESS 0x1FFFC800

diff --git a/tmk_core/common/chibios/bootloader.c b/tmk_core/common/chibios/bootloader.c
index 93f2e3785a5b003a6ea70550e5299612491352be..f36eced432ff1b50766e3b6ffc6a3ec366b05d4b 100644 (file)
--- a/tmk_core/common/chibios/bootloader.c
+++ b/tmk_core/common/chibios/bootloader.c
@@ -2,7 +2,7 @@
 
 #include "ch.h"
 
 
 #include "ch.h"
 

-#ifdef BOOTLOADER_ADDRESS
+#ifdef STM32_BOOTLOADER_ADDRESS

 #define SYMVAL(sym) (uint32_t)(((uint8_t *)&(sym)) - ((uint8_t *)0))
 extern uint32_t __ram0_end__;
 
 #define SYMVAL(sym) (uint32_t)(((uint8_t *)&(sym)) - ((uint8_t *)0))
 extern uint32_t __ram0_end__;
 


@@ -10,7 +10,7 @@ void bootloader_jump(void) {
   *((unsigned long *)(SYMVAL(__ram0_end__) - 4)) = 0xDEADBEEF; // set magic flag => reset handler will jump into boot loader
    NVIC_SystemReset();
 }
   *((unsigned long *)(SYMVAL(__ram0_end__) - 4)) = 0xDEADBEEF; // set magic flag => reset handler will jump into boot loader
    NVIC_SystemReset();
 }

-#else /* BOOTLOADER_ADDRESS */
+#else /* STM32_BOOTLOADER_ADDRESS */

 void bootloader_jump(void) {}
 void bootloader_jump(void) {}

-#endif /* BOOTLOADER_ADDRESS */
+#endif /* STM32_BOOTLOADER_ADDRESS */

 
 

diff --git a/tmk_core/protocol/chibios/README.md b/tmk_core/protocol/chibios/README.md
index 06569c51cb9303c1595f883bdb76e799c0027df5..676a5f4ff3f12c8c352d03d1a96a9e3564075c1f 100644 (file)
--- a/tmk_core/protocol/chibios/README.md
+++ b/tmk_core/protocol/chibios/README.md
@@ -2,13 +2,13 @@
 
 ### Notes
 
 
 ### Notes
 

-- To use, unpack or symlink [ChibiOS] {currently 3.0.1} to `tmk_core/tool/chibios/chibios`.
+- To use, unpack or symlink [ChibiOS] {currently 3.0.2} to `tmk_core/tool/chibios/chibios`.

 - For gcc options, inspect `tmk_core/tool/chibios/chibios.mk`. For instance, I enabled `-Wno-missing-field-initializers`, because TMK common bits generated a lot of warnings on that.
 Also pay attention to `-O0` (enabled for debugging); for deployment use `-O2`.
 - USB string descriptors are messy. I did not find a way to cleanly generate the right structures from actual strings, so the definitions in individual keyboards' `config.h` are ugly as heck.
 - There are some random constants left so far, e.g. 5ms sleep between calling `keyboard_task`, or 1.5sec wait for USB init, in `main.c`. There should be no such in `usb_main.c` (the main USB stack). Everything is based on timers/interrupts/kernel scheduling (well except `keyboard_task`), so no periodically called things (again, except `keyboard_task`, which is just how TMK is designed).
 - It is easy to add some code for testing (e.g. blink LED, do stuff on button press, etc...) - just create another thread in `main.c`, it will run independently of the keyboard business.
 - For gcc options, inspect `tmk_core/tool/chibios/chibios.mk`. For instance, I enabled `-Wno-missing-field-initializers`, because TMK common bits generated a lot of warnings on that.
 Also pay attention to `-O0` (enabled for debugging); for deployment use `-O2`.
 - USB string descriptors are messy. I did not find a way to cleanly generate the right structures from actual strings, so the definitions in individual keyboards' `config.h` are ugly as heck.
 - There are some random constants left so far, e.g. 5ms sleep between calling `keyboard_task`, or 1.5sec wait for USB init, in `main.c`. There should be no such in `usb_main.c` (the main USB stack). Everything is based on timers/interrupts/kernel scheduling (well except `keyboard_task`), so no periodically called things (again, except `keyboard_task`, which is just how TMK is designed).
 - It is easy to add some code for testing (e.g. blink LED, do stuff on button press, etc...) - just create another thread in `main.c`, it will run independently of the keyboard business.

-- Jumping to bootloader works, but it is not entirely pleasant, since it is very much MCU dependent. The code is now geared towards STM32 chips and their built-in bootloaders. So, one needs to dig out the right address to jump to, and pass it to the compiler in the `Makefile`. Also, a patch to upstream ChibiOS is needed (supplied), because it `ResetHandler` needs adjusting.
+- Jumping to bootloader works, but it is not entirely pleasant, since it is very much MCU dependent. The code is now geared towards STM32 chips and their built-in bootloaders. So, one needs to dig out the right address to jump to, and either pass it to the compiler in the `Makefile`, or better, define it in `<your_kb>/bootloader_defs.h`. Also, a patch to upstream ChibiOS is needed (supplied), because it `ResetHandler` needs adjusting.

 - Sleep LED works, but at the moment only on/off, i.e. no breathing.
 - The USB stack works pretty completely; however there are bits of other TMK stuff that are not done yet:
 
 - Sleep LED works, but at the moment only on/off, i.e. no breathing.
 - The USB stack works pretty completely; however there are bits of other TMK stuff that are not done yet:
 


@@ -28,7 +28,7 @@ Also pay attention to `-O0` (enabled for debugging); for deployment use `-O2`.
 
 ### Tried with
 
 
 ### Tried with
 

-- ChibiOS 3.0.1 and ST F072RB DISCOVERY board.
+- ChibiOS 3.0.1, 3.0.2 and ST F072RB DISCOVERY board.

 - Need to test on other STM32 chips (F3, F4) to make it as much chip-independent as possible.
 
 ## STM32-based keyboard design considerations
 - Need to test on other STM32 chips (F3, F4) to make it as much chip-independent as possible.
 
 ## STM32-based keyboard design considerations


@@ -36,13 +36,13 @@ Also pay attention to `-O0` (enabled for debugging); for deployment use `-O2`.
 - STM32F0x2 chips can do crystal-less USB, but they still need a 3.3V voltage regulator.
 - The BOOT0 pin should be tied to GND.
 - For a hardware way of accessing the in-built DFU bootloader, in addition to the reset button, put another button between the BOOT0 pin and 3V3.
 - STM32F0x2 chips can do crystal-less USB, but they still need a 3.3V voltage regulator.
 - The BOOT0 pin should be tied to GND.
 - For a hardware way of accessing the in-built DFU bootloader, in addition to the reset button, put another button between the BOOT0 pin and 3V3.

-- For breathing the caps lock LED during the suspended state ("sleep LED"), it is desirable to have that LED on a hardware PWM pin (there's usually plenty of those, look for TIMERs in the datasheet).
+- For breathing the caps lock LED during the suspended state ("sleep LED"), it is desirable to have that LED on a hardware PWM pin (there's usually plenty of those, look for TIMERs in the datasheet). However this is not strictly necessary, because instead of direct output of a timer to a pin (better of course), it is easy to define timer callbacks in ChibiOS that turn on/off an arbitrary pin.

 
 

-## ChibiOS-supported MCUs (as of 3.0.1)
+## ChibiOS-supported MCUs (as of 3.0.2)

 
 - Pretty much all STM32 chips.
 - There is also support for AVR8, but the USB stack is not implemented for them yet, and also the kernel itself takes about 1k of RAM. I think people managed to get ChibiOS running on atmega32[8p/u4] though.
 
 - Pretty much all STM32 chips.
 - There is also support for AVR8, but the USB stack is not implemented for them yet, and also the kernel itself takes about 1k of RAM. I think people managed to get ChibiOS running on atmega32[8p/u4] though.

-- There is some support for K20 and KL25 Freescale chips (i.e. Teensy 3.0, mchck, FRDM-KL25Z, FRDM-K20D50M), but again, no USB stack yet.
+- There is some support for K20x and KL2x Freescale chips (i.e. Teensy 3.0, mchck, FRDM-KL25Z, FRDM-K20D50M), but again, no official USB stack yet. This is being worked on, see the `kinetis` branch of [my ChibiOS fork](https://github.com/flabbergast/ChibiOS). It supports also Teensy LC, 3.1 and FRDM-KL26Z.

 - I've seen community support for Nordic NRF51822 (the chip in Adafruit's Bluefruit bluetooth-low-energy boards), but not sure about the extent.
 
 
 - I've seen community support for Nordic NRF51822 (the chip in Adafruit's Bluefruit bluetooth-low-energy boards), but not sure about the extent.
 
 

diff --git a/tmk_core/tool/chibios/ch-bootloader-jump.patch b/tmk_core/tool/chibios/ch-bootloader-jump.patch
index 7f33e8ac3fd82b283680392858d83700a99ee3f2..d8865762143d2e8a1f369e6ed0e367025e946667 100644 (file)
--- a/tmk_core/tool/chibios/ch-bootloader-jump.patch
+++ b/tmk_core/tool/chibios/ch-bootloader-jump.patch
@@ -1,8 +1,8 @@
 diff --git a/os/common/ports/ARMCMx/compilers/GCC/crt0_v6m.s b/os/common/ports/ARMCMx/compilers/GCC/crt0_v6m.s
 diff --git a/os/common/ports/ARMCMx/compilers/GCC/crt0_v6m.s b/os/common/ports/ARMCMx/compilers/GCC/crt0_v6m.s

-index 38b4513..12a3f39 100644
+index 51a79bb..42d07bd 100644

 --- a/os/common/ports/ARMCMx/compilers/GCC/crt0_v6m.s
 +++ b/os/common/ports/ARMCMx/compilers/GCC/crt0_v6m.s
 --- a/os/common/ports/ARMCMx/compilers/GCC/crt0_v6m.s
 +++ b/os/common/ports/ARMCMx/compilers/GCC/crt0_v6m.s

-@@ -98,6 +98,13 @@
+@@ -105,6 +105,13 @@

  #define CRT0_CALL_DESTRUCTORS               TRUE\r
  #endif\r
  \r
  #define CRT0_CALL_DESTRUCTORS               TRUE\r
  #endif\r
  \r


@@ -16,12 +16,12 @@ index 38b4513..12a3f39 100644
  /*===========================================================================*/\r
  /* Code section.                                                             */\r
  /*===========================================================================*/\r
  /*===========================================================================*/\r
  /* Code section.                                                             */\r
  /*===========================================================================*/\r

-@@ -117,6 +124,17 @@
+@@ -124,6 +131,17 @@

                  .thumb_func\r
                  .global Reset_Handler\r
  Reset_Handler:\r
 +\r
                  .thumb_func\r
                  .global Reset_Handler\r
  Reset_Handler:\r
 +\r

-+#ifdef BOOTLOADER_ADDRESS\r
++#ifdef STM32_BOOTLOADER_ADDRESS\r

 +                /* jump to bootloader code */\r
 +                ldr        r0, =__ram0_end__-4\r
 +                ldr        r1, =MAGIC_BOOTLOADER_NUMBER\r
 +                /* jump to bootloader code */\r
 +                ldr        r0, =__ram0_end__-4\r
 +                ldr        r1, =MAGIC_BOOTLOADER_NUMBER\r


@@ -29,16 +29,16 @@ index 38b4513..12a3f39 100644
 +                str        r0, [r0, #0] /* erase stored magic */\r
 +                cmp        r2, r1\r
 +                beq        Bootloader_Jump\r
 +                str        r0, [r0, #0] /* erase stored magic */\r
 +                cmp        r2, r1\r
 +                beq        Bootloader_Jump\r

-+#endif /* BOOTLOADER_ADDRESS */\r
++#endif /* STM32_BOOTLOADER_ADDRESS */\r

 +\r
                  /* Interrupts are globally masked initially.*/\r
                  cpsid   i\r
  \r
 +\r
                  /* Interrupts are globally masked initially.*/\r
                  cpsid   i\r
  \r

-@@ -230,6 +248,21 @@ endfiniloop:
+@@ -242,6 +260,21 @@ endfiniloop:

                  ldr     r1, =__default_exit\r
                  bx      r1\r
  \r
                  ldr     r1, =__default_exit\r
                  bx      r1\r
  \r

-+#ifdef BOOTLOADER_ADDRESS\r
++#ifdef STM32_BOOTLOADER_ADDRESS\r

 +/*\r
 + * Jump-to-bootloader function.\r
 + */\r
 +/*\r
 + * Jump-to-bootloader function.\r
 + */\r


@@ -46,21 +46,21 @@ index 38b4513..12a3f39 100644
 +                .align  2\r
 +                .thumb_func\r
 +Bootloader_Jump:\r
 +                .align  2\r
 +                .thumb_func\r
 +Bootloader_Jump:\r

-+                ldr     r0, =BOOTLOADER_ADDRESS\r
++                ldr     r0, =STM32_BOOTLOADER_ADDRESS\r

 +                ldr     r1, [r0, #0]\r
 +                mov     sp, r1\r
 +                ldr     r0, [r0, #4]\r
 +                bx      r0\r
 +                ldr     r1, [r0, #0]\r
 +                mov     sp, r1\r
 +                ldr     r0, [r0, #4]\r
 +                bx      r0\r

-+#endif /* BOOTLOADER_ADDRESS */\r
++#endif /* STM32_BOOTLOADER_ADDRESS */\r

 +\r
  #endif\r
  \r
  /** @} */\r
 diff --git a/os/common/ports/ARMCMx/compilers/GCC/crt0_v7m.s b/os/common/ports/ARMCMx/compilers/GCC/crt0_v7m.s
 +\r
  #endif\r
  \r
  /** @} */\r
 diff --git a/os/common/ports/ARMCMx/compilers/GCC/crt0_v7m.s b/os/common/ports/ARMCMx/compilers/GCC/crt0_v7m.s

-index fcfa4de..2d560da 100644
+index 4812a29..dca9f88 100644

 --- a/os/common/ports/ARMCMx/compilers/GCC/crt0_v7m.s
 +++ b/os/common/ports/ARMCMx/compilers/GCC/crt0_v7m.s
 --- a/os/common/ports/ARMCMx/compilers/GCC/crt0_v7m.s
 +++ b/os/common/ports/ARMCMx/compilers/GCC/crt0_v7m.s

-@@ -133,6 +133,13 @@
+@@ -140,6 +140,13 @@

  #define CRT0_CPACR_INIT                     0x00F00000\r
  #endif\r
  \r
  #define CRT0_CPACR_INIT                     0x00F00000\r
  #endif\r
  \r


@@ -74,11 +74,12 @@ index fcfa4de..2d560da 100644
  /*===========================================================================*/\r
  /* Code section.                                                             */\r
  /*===========================================================================*/\r
  /*===========================================================================*/\r
  /* Code section.                                                             */\r
  /*===========================================================================*/\r

-@@ -157,6 +164,16 @@
+@@ -164,6 +171,17 @@

                  .thumb_func\r
                  .global Reset_Handler\r
  Reset_Handler:\r
                  .thumb_func\r
                  .global Reset_Handler\r
  Reset_Handler:\r

-+#ifdef BOOTLOADER_ADDRESS\r
++\r
++#ifdef STM32_BOOTLOADER_ADDRESS\r

 +                /* jump to bootloader code */\r
 +                ldr        r0, =__ram0_end__-4\r
 +                ldr        r1, =MAGIC_BOOTLOADER_NUMBER\r
 +                /* jump to bootloader code */\r
 +                ldr        r0, =__ram0_end__-4\r
 +                ldr        r1, =MAGIC_BOOTLOADER_NUMBER\r


@@ -86,16 +87,16 @@ index fcfa4de..2d560da 100644
 +                str        r0, [r0, #0] /* erase stored magic */\r
 +                cmp        r2, r1\r
 +                beq        Bootloader_Jump\r
 +                str        r0, [r0, #0] /* erase stored magic */\r
 +                cmp        r2, r1\r
 +                beq        Bootloader_Jump\r

-+#endif /* BOOTLOADER_ADDRESS */\r
++#endif /* STM32_BOOTLOADER_ADDRESS */\r

 +\r
                  /* Interrupts are globally masked initially.*/\r
                  cpsid   i\r
  \r
 +\r
                  /* Interrupts are globally masked initially.*/\r
                  cpsid   i\r
  \r

-@@ -289,6 +306,21 @@ endfiniloop:
+@@ -305,6 +323,21 @@ endfiniloop:

                  /* Branching to the defined exit handler.*/\r
                  b       __default_exit\r
  \r
                  /* Branching to the defined exit handler.*/\r
                  b       __default_exit\r
  \r

-+#ifdef BOOTLOADER_ADDRESS\r
++#ifdef STM32_BOOTLOADER_ADDRESS\r

 +/*\r
 + * Jump-to-bootloader function.\r
 + */\r
 +/*\r
 + * Jump-to-bootloader function.\r
 + */\r


@@ -103,12 +104,12 @@ index fcfa4de..2d560da 100644
 +                .align  2\r
 +                .thumb_func\r
 +Bootloader_Jump:\r
 +                .align  2\r
 +                .thumb_func\r
 +Bootloader_Jump:\r

-+                ldr     r0, =BOOTLOADER_ADDRESS\r
++                ldr     r0, =STM32_BOOTLOADER_ADDRESS\r

 +                ldr     r1, [r0, #0]\r
 +                mov     sp, r1\r
 +                ldr     r0, [r0, #4]\r
 +                bx      r0\r
 +                ldr     r1, [r0, #0]\r
 +                mov     sp, r1\r
 +                ldr     r0, [r0, #4]\r
 +                bx      r0\r

-+#endif /* BOOTLOADER_ADDRESS */\r
++#endif /* STM32_BOOTLOADER_ADDRESS */\r

 +\r
  #endif /* !defined(__DOXYGEN__) */\r
  \r
 +\r
  #endif /* !defined(__DOXYGEN__) */\r
  \r

diff --git a/tmk_core/tool/chibios/chibios.mk b/tmk_core/tool/chibios/chibios.mk
index 6ba783e34c89959444675b6cf473113b5f5b63a3..bc8c61b31c0687db605ca5ed9ad24c02dc9eabe6 100644 (file)
--- a/tmk_core/tool/chibios/chibios.mk
+++ b/tmk_core/tool/chibios/chibios.mk
@@ -207,6 +207,14 @@ UDEFS = $(OPT_DEFS)
 
 # Define ASM defines here
 UADEFS = $(OPT_DEFS)
 
 # Define ASM defines here
 UADEFS = $(OPT_DEFS)

+# bootloader definitions may be used in the startup .s file
+ifneq ("$(wildcard $(TARGET_DIR)/bootloader_defs.h)","")
+    UADEFS += -include $(TARGET_DIR)/bootloader_defs.h
+    UDEFS += -include $(TARGET_DIR)/bootloader_defs.h
+else ifneq ("$(wildcard $(TARGET_DIR)/boards/$(BOARD)/bootloader_defs.h)","")
+    UADEFS += -include $(TARGET_DIR)/boards/$(BOARD)/bootloader_defs.h
+    UDEFS += -include $(TARGET_DIR)/boards/$(BOARD)/bootloader_defs.h
+endif

 
 # List all user directories here
 UINCDIR =
 
 # List all user directories here
 UINCDIR =