Merge pull request #14692 from jeromecoutant/PR_WB_HCI

STM32WB: improve FLASH size

connectivity/drivers/ble/FEATURE_BLE/TARGET_STM32WB/HCIDriver.cpp

@@ -28,6 +28,7 @@
 #include "bstream.h"
 #include "hci_mbed_os_adaptation.h"
 #include "mbed_trace.h"
+#include "platform/mbed_error.h"
 
 /* STM32WB include files */
 #include "stm32wbxx_ll_ipcc.h"
@@ -130,7 +131,8 @@ public:
         HciResetCmd();
     }
 
-    static uint8_t convert_db_to_tx_power_index(int8_t level_db) {
+    static uint8_t convert_db_to_tx_power_index(int8_t level_db)
+    {
         const int8_t conversion[] = {
             -40, -21, -20, -19,
             -18, -16, -15, -14,
@@ -151,7 +153,8 @@ public:
         return index;
     }
 
-    virtual ble_error_t set_tx_power(int8_t level_db) {
+    virtual ble_error_t set_tx_power(int8_t level_db)
+    {
 
 
         uint8_t buf[2];
@@ -480,10 +483,29 @@ public:
             WirelessFwInfo_t wireless_info_instance;
             WirelessFwInfo_t *p_wireless_info = &wireless_info_instance;
             if (SHCI_GetWirelessFwInfo(p_wireless_info) != SHCI_Success) {
-                tr_info("SHCI_GetWirelessFwInfo error");
+                tr_error("SHCI_GetWirelessFwInfo error");
             } else {
+                // https://github.com/STMicroelectronics/STM32CubeWB/tree/master/Projects/STM32WB_Copro_Wireless_Binaries
+                // Be sure that you are using the latest BLE FW version
                 tr_info("WIRELESS COPROCESSOR FW VERSION ID = %d.%d.%d", p_wireless_info->VersionMajor, p_wireless_info->VersionMinor, p_wireless_info->VersionSub);
-                tr_info("WIRELESS COPROCESSOR FW STACK TYPE = %d", p_wireless_info->StackType);
+                tr_info("WIRELESS COPROCESSOR FW STACK TYPE = %d (ROM size 0x%x)", p_wireless_info->StackType, MBED_ROM_SIZE);
+
+#if STM32WB55xx
+                switch (p_wireless_info->StackType) {
+                    case INFO_STACK_TYPE_BLE_FULL:
+                        if (MBED_ROM_SIZE > 0xCA000)  {
+                            error("Wrong MBED_ROM_SIZE with BLE FW\n");
+                        }
+                        break;
+                    case INFO_STACK_TYPE_BLE_HCI:
+                        if (MBED_ROM_SIZE > 0xE0000)  {
+                            error("Wrong MBED_ROM_SIZE with HCI FW\n");
+                        }
+                        break;
+                    default:
+                        tr_error("StackType %u not expected\n", p_wireless_info->StackType);
+                }
+#endif
             }
         }
     }
@@ -532,7 +554,7 @@ private:
         /*  At this stage, we'll need to wait for ready event,
          *  passed thru TL_SYS_EvtReceived */
         if (!sysevt_wait()) {
-            tr_info("ERROR booting WB controler");
+            error("ERROR booting WB controler\n");
             return;
         }
 

targets/TARGET_STM/TARGET_STM32WB/README.md

@@ -1,12 +1,13 @@
 * [STM32WB family](#stm32wb-family)
 * [Supported boards](#supported-boards)
-   * [NUCLEO_WB55RG](#nucleo_wb55rg)
+   * [NUCLEO_WB55RG (NUCLEO-WB55RG)](#nucleo_wb55rg-nucleo-wb55rg)
    * [DISCO_WB5MMG (STM32WB5MM-DK)](#disco_wb5mmg-stm32wb5mm-dk)
 * [BLE](#ble)
    * [MBED-OS support](#mbed-os-support)
-   * [mbed-trace support](#mbed-trace-support)
+   * [BLE FW](#ble-fw)
    * [BLE FW update](#ble-fw-update)
    * [BLE FW flashing procedure](#ble-fw-flashing-procedure)
+   * [mbed-trace support](#mbed-trace-support)
 
 
 # STM32WB family
@@ -30,8 +31,9 @@ This ST MCU family is dual-core : based on an Arm Cortex-M4 core and an Arm Cort
 
 [mbed.com platform page](https://os.mbed.com/platforms/ST-Nucleo-WB55RG/)
 
-- Total FLASH is 1MB, but note that it is shared by M4 and M0 cores.
+- Total FLASH is 1MB
-    - mbed-os application size is then limited to 768 KB
+
+But FLASH is shared by M4 and M0 cores, [see BLE FW](#ble-fw)
 
 - RAM: 256 KB
     - SRAM1: 192 KB
@@ -51,8 +53,9 @@ SRAM2 is dedicated for M0 core and inter CPU communication, and then can not be
 
 [mbed.com platform page](https://os.mbed.com/platforms/DISCO-WB5MMG/)
 
-- Total FLASH is 1MB, but note that it is shared by M4 and M0 cores.
+- Total FLASH is 1MB
-    - mbed-os application size is then limited to 768 KB
+
+But FLASH is shared by M4 and M0 cores, [see BLE FW](#ble-fw)
 
 - RAM: 256 KB
     - SRAM1: 192 KB
@@ -83,11 +86,59 @@ Note that the BLE controller firmware running on the cortex-M0 is the same as in
 Official ST Application Note : 
 [AN5289: Building wireless applications with STM32WB Series microcontrollers](https://www.st.com/resource/en/application_note/dm00598033-building-wireless-applications-with-stm32wb-series-microcontrollers-stmicroelectronics.pdf)
 
+## BLE FW
+
+All available BLE FW for M0 core are provided in ths ST STM32CubeWB repo:
+
+https://github.com/STMicroelectronics/STM32CubeWB/tree/master/Projects/STM32WB_Copro_Wireless_Binaries/STM32WB5x
+
+Default BLE FW in ST boards is **stm32wb5x_BLE_Stack_full_fw.bin**
+- As explained in Release_Notes.html, this FW is flashed at @ 0x080CA000
+- Default "mbed_rom_size" in targets.json is then "0xCA000" (808K)
+
+To optimize FLASH size, **stm32wb5x_BLE_HCILayer_fw.bin** is supported for MBED-OS use case
+- As explained in Release_Notes.html, this FW is flashed at @ 0x080E0000
+- Then "mbed_rom_size" can be updated to "0xE0000" (896K)
+
+Example in your local mbed_app.json:
+```
+    "target_overrides": {
+        "NUCLEO_WB55RG": {
+            "target.mbed_rom_size": "0xE0000"
+        }
+```
+
+
+## BLE FW update
+
+Official ST Application Note : 
+[AN5185: ST firmware upgrade services for STM32WB Series](http://www.st.com/st-web-ui/static/active/en/resource/technical/document/application_note/DM00513965.pdf)
+
+
+## BLE FW flashing procedure
+
+STM32CubeProgrammer needs to be used:
+
+https://www.st.com/en/development-tools/stm32cubeprog.html
+
+Please check the Release Note and complete flashing procedure:
+https://htmlpreview.github.io/?https://github.com/STMicroelectronics/STM32CubeWB/blob/master/Projects/STM32WB_Copro_Wireless_Binaries/STM32WB5x/Release_Notes.html
+
+- connect the board with ST-LINK
+- In the left column, go to "Firmware Upgrade Services"
+- "Start FUS"
+- "Read FUS infos" => version v1.2.0 is expected
+- Firmware Upgrade / "Browse" : select the chosen FW (see above)
+- Firmware Upgrade / Start address : depends on the chosen FW (see above)
+- Firmware Upgrade / "Firmware Upgrade"
+- In the left column, go to "Option bytes"
+- User Configuration => "Read"
+- User Configuration / enable nSWBOOT0 => "Apply"
 
 
 ## mbed-trace support
 
-trace group: BLE_WB
+trace group: BLWB
 
 example:
 ````
@@ -99,104 +150,3 @@ example:
 [DBG ][BLWB]:    Cmd 0xc03
 [DBG ][BLWB]:    Len 0D]
 ````
-
-## BLE FW update
-
-Official ST Application Note : 
-[AN5185: ST firmware upgrade services for STM32WB Series](http://www.st.com/st-web-ui/static/active/en/resource/technical/document/application_note/DM00513965.pdf)
-
-Latest BLE FW :
-https://github.com/STMicroelectronics/STM32CubeWB/blob/master/Projects/STM32WB_Copro_Wireless_Binaries/STM32WB5x/stm32wb5x_BLE_Stack_full_fw.bin
-
-## BLE FW flashing procedure
-
-Release Note and complete flashing procedure:
-https://htmlpreview.github.io/?https://github.com/STMicroelectronics/STM32CubeWB/blob/master/Projects/STM32WB_Copro_Wireless_Binaries/STM32WB5x/Release_Notes.html
-
-
-- STEP 1: Use STM32CubeProgrammer
-
-https://www.st.com/en/development-tools/stm32cubeprog.html
-
-````
-FLASHPATH="C:\Program Files\STMicroelectronics\STM32Cube\STM32CubeProgrammer\bin"
-export PATH=$FLASHPATH:$PATH
-````
-
-- STEP 2: Access to Bootloader USB Interface (system flash)
-
-    * Boot0 pin set to VDD : Jumper between CN7.5(VDD) and CN7.7(Boot0)
-    * Jumper JP1 on USB_MCU
-    * Power ON via USB_USER
-
-![Image description](stm32wb_ble_update.jpg)
-
-- STEP 3 : Delete current wireless stack :
-
-```
-$ STM32_Programmer_CLI.exe -c port=usb1 -fwdelete
-...
-FUS state is FUS_IDLE
-
-FUS status is FUS_NO_ERROR
-Deleting firmware ...
-Firmware delete finished
-fwdelete command execution finished
-```
-
-- STEP 4 : Read FUS Version
-
-```
-$ STM32_Programmer_CLI.exe -c port=usb1 -r32 0x20030030 1
-...
-
-Reading 32-bit memory content
-  Size          : 4 Bytes
-  Address:      : 0x20030030
-
-0x20030030 : 00050300
-```
-
-- STEP 5A if last result is 00050300 : Download new FUS :
-
-```
-$ ./STM32_Programmer_CLI.exe -c port=usb1 -fwupgrade stm32wb5x_FUS_fw_for_fus_0_5_3.bin 0x080EC000 firstinstall=0
-```
-
-- STEP 5B if last result is 01000100 or 01000200 : Download new FUS :
-
-```
-$ STM32_Programmer_CLI.exe -c port=usb1 -fwupgrade stm32wb5x_FUS_fw.bin 0x080EC000 firstinstall=0
-...
-Firmware Upgrade Success
-```
-
-
-- STEP 4 (to check) : Read FUS Version
-
-```
-$ STM32_Programmer_CLI.exe -c port=usb1 -r32 0x20030030 1
-
-Reading 32-bit memory content
-  Size          : 4 Bytes
-  Address:      : 0x20030030
-
-0x20030030 : 01020000
-```
-
-- STEP 6 : Download new wireless stack :
-
-
-```
-$ STM32_Programmer_CLI.exe -c port=usb1 -fwupgrade stm32wb5x_BLE_Stack_full_fw.bin 0x080CA000 firstinstall=1
-
-...
-Download firmware image at address 0x80cb000 ...
-...
-File download complete
-...
-Firmware Upgrade Success
-```
-
-- STEP 7 : Revert STEP 2 procedure to put back device in normal mode.
-

targets/TARGET_STM/TARGET_STM32WB/TARGET_STM32WB55xG/TOOLCHAIN_ARM/stm32wb55xg.sct

@@ -22,8 +22,9 @@
 #endif
 
 #if !defined(MBED_APP_SIZE)
-; 768KB FLASH // BLE firmware is being flashed strating from @ 0x080C0000
+// MBED_APP_SIZE cannot be full ROM size as core M0 FW is using the end of FLASH
-#define MBED_APP_SIZE 0xC0000
+// Size is defined in json with "mbed_rom_size"
+#define MBED_APP_SIZE MBED_ROM_SIZE
 #endif
 
 #if !defined(MBED_CONF_TARGET_BOOT_STACK_SIZE)
@@ -38,7 +39,7 @@
 /* Round up VECTORS_SIZE to 8 bytes */
 #define VECTORS_SIZE  (((NVIC_NUM_VECTORS * 4) + 7) AND ~7)
 
-; RAM_SIZE = 192KB SRAM (0x30000) + Shared mem
+; RAM_SIZE = 192KB SRAM1 (0x30000) + Shared mem (part of SRAM2)
 LR_IROM1  MBED_APP_START  MBED_APP_SIZE  {
 
   ER_IROM1  MBED_APP_START  MBED_APP_SIZE  {

targets/TARGET_STM/TARGET_STM32WB/TARGET_STM32WB55xG/TOOLCHAIN_GCC_ARM/stm32wb55xg.ld

@@ -23,8 +23,9 @@
 #endif
 
 #if !defined(MBED_APP_SIZE)
-/* 768KB FLASH - BLE firmware is being flashed strating from @ 0x080C0000 */
+// MBED_APP_SIZE cannot be full ROM size as core M0 FW is using the end of FLASH
-#define MBED_APP_SIZE 768K
+// Size is defined in json with "mbed_rom_size"
+#define MBED_APP_SIZE MBED_ROM_SIZE
 #endif
 
 #if !defined(MBED_CONF_TARGET_BOOT_STACK_SIZE)
@@ -36,7 +37,7 @@
 /* Round up VECTORS_SIZE to 8 bytes */
 #define VECTORS_SIZE  (((NVIC_NUM_VECTORS * 4) + 7) & 0xFFFFFFF8)
 
-/* RAM_SIZE = 192KB SRAM (0x30000) + Shared mem */
+/* RAM_SIZE = 192KB SRAM1 (0x30000) + Shared mem (part of SRAM2) */
 MEMORY
 { 
   FLASH (rx) : ORIGIN = MBED_APP_START, LENGTH = MBED_APP_SIZE

targets/TARGET_STM/TARGET_STM32WB/TARGET_STM32WB55xG/TOOLCHAIN_IAR/stm32wb55xg.icf

@@ -17,7 +17,7 @@
 /* Device specific values */
 
 if (!isdefinedsymbol(MBED_APP_START)) { define symbol MBED_APP_START = 0x08000000; }
-if (!isdefinedsymbol(MBED_APP_SIZE)) { define symbol MBED_APP_SIZE = 0xC0000; }
+if (!isdefinedsymbol(MBED_APP_SIZE)) { define symbol MBED_APP_SIZE = MBED_ROM_START; }
 
 /* [ROM = 768kb = 0xC0000] */
 define symbol __intvec_start__     = MBED_APP_START;

targets/TARGET_STM/TARGET_STM32WB/TARGET_STM32WB55xG/cmsis_nvic.h

@@ -22,7 +22,9 @@
 #endif
 
 #if !defined(MBED_ROM_SIZE)
-#define MBED_ROM_SIZE  0x100000  // 1.0 MB
+// MBED_ROM_SIZE cannot be full ROM size as core M0 FW is using the end of FLASH
+// Size is defined in json with "mbed_rom_size"
+#error "mbed_rom_size is missing"
 #endif
 
 #if !defined(MBED_RAM_START)

targets/TARGET_STM/TARGET_STM32WB/TARGET_STM32WB5MxG/TOOLCHAIN_ARM/stm32wb5mxg.sct

@@ -22,8 +22,9 @@
 #endif
 
 #if !defined(MBED_APP_SIZE)
-; 768KB FLASH // BLE firmware is being flashed strating from @ 0x080C0000
+// MBED_APP_SIZE cannot be full ROM size as core M0 FW is using the end of FLASH
-#define MBED_APP_SIZE 0xC0000
+// Size is defined in json with "mbed_rom_size"
+#define MBED_APP_SIZE MBED_ROM_SIZE
 #endif
 
 #if !defined(MBED_CONF_TARGET_BOOT_STACK_SIZE)
@@ -38,6 +39,7 @@
 /* Round up VECTORS_SIZE to 8 bytes */
 #define VECTORS_SIZE  (((NVIC_NUM_VECTORS * 4) + 7) AND ~7)
 
+; RAM_SIZE = 192KB SRAM1 (0x30000) + Shared mem (part of SRAM2)
 LR_IROM1  MBED_APP_START  MBED_APP_SIZE  {
 
   ER_IROM1  MBED_APP_START  MBED_APP_SIZE  {

targets/TARGET_STM/TARGET_STM32WB/TARGET_STM32WB5MxG/TOOLCHAIN_GCC_ARM/stm32wb5mxg.ld

@@ -23,8 +23,9 @@
 #endif
 
 #if !defined(MBED_APP_SIZE)
-/* 768KB FLASH - BLE firmware is being flashed strating from @ 0x080C0000 */
+// MBED_APP_SIZE cannot be full ROM size as core M0 FW is using the end of FLASH
-#define MBED_APP_SIZE 768K
+// Size is defined in json with "mbed_rom_size"
+#define MBED_APP_SIZE MBED_ROM_SIZE
 #endif
 
 #if !defined(MBED_CONF_TARGET_BOOT_STACK_SIZE)
@@ -36,7 +37,7 @@
 /* Round up VECTORS_SIZE to 8 bytes */
 #define VECTORS_SIZE  (((NVIC_NUM_VECTORS * 4) + 7) & 0xFFFFFFF8)
 
-/* RAM_SIZE = 192KB SRAM (0x30000) + Shared mem */
+/* RAM_SIZE = 192KB SRAM1 (0x30000) + Shared mem (part of SRAM2) */
 MEMORY
 { 
   FLASH (rx) : ORIGIN = MBED_APP_START, LENGTH = MBED_APP_SIZE

targets/TARGET_STM/TARGET_STM32WB/TARGET_STM32WB5MxG/TOOLCHAIN_IAR/stm32wb5mxg.icf

@@ -17,7 +17,7 @@
 /* Device specific values */
 
 if (!isdefinedsymbol(MBED_APP_START)) { define symbol MBED_APP_START = 0x08000000; }
-if (!isdefinedsymbol(MBED_APP_SIZE)) { define symbol MBED_APP_SIZE = 0xC0000; }
+if (!isdefinedsymbol(MBED_APP_SIZE)) { define symbol MBED_APP_SIZE = MBED_ROM_START; }
 
 /* [ROM = 768kb = 0xC0000] */
 define symbol __intvec_start__     = MBED_APP_START;

targets/TARGET_STM/TARGET_STM32WB/TARGET_STM32WB5MxG/cmsis_nvic.h

@@ -22,7 +22,9 @@
 #endif
 
 #if !defined(MBED_ROM_SIZE)
-#define MBED_ROM_SIZE  0x100000  // 1.0 MB
+// MBED_ROM_SIZE cannot be full ROM size as core M0 FW is using the end of FLASH
+// Size is defined in json with "mbed_rom_size"
+#error "mbed_rom_size is missing"
 #endif
 
 #if !defined(MBED_RAM_START)

targets/TARGET_STM/TARGET_STM32WB/flash_api.c

@@ -19,7 +19,6 @@
 #if DEVICE_FLASH
 
 #include "flash_api.h"
-#include "flash_data.h"
 #include "mbed_critical.h"
 #include "mbed_assert.h"
 #include "cmsis.h"
@@ -80,7 +79,7 @@ int32_t flash_erase_sector(flash_t *obj, uint32_t address)
     uint32_t cpu1_sem_status = 1;
     uint32_t cpu2_sem_status = 1;
 
-    if ((address >= (FLASH_BASE + FLASH_SIZE)) || (address < FLASH_BASE)) {
+    if ((address >= (FLASH_BASE + MBED_ROM_SIZE)) || (address < FLASH_BASE)) {
         return -1;
     }
 
@@ -179,7 +178,7 @@ int32_t flash_program_page(flash_t *obj, uint32_t address, const uint8_t *data,
     uint32_t cpu1_sem_status = 1;
     uint32_t cpu2_sem_status = 1;
 
-    if ((address >= (FLASH_BASE + FLASH_SIZE)) || (address < FLASH_BASE)) {
+    if ((address >= (FLASH_BASE + MBED_ROM_SIZE)) || (address < FLASH_BASE)) {
         return -1;
     }
 
@@ -267,7 +266,7 @@ int32_t flash_program_page(flash_t *obj, uint32_t address, const uint8_t *data,
 uint32_t flash_get_sector_size(const flash_t *obj, uint32_t address)
 {
     /*  considering 1 sector = 1 page */
-    if ((address >= (FLASH_BASE + FLASH_SIZE)) || (address < FLASH_BASE)) {
+    if ((address >= (FLASH_BASE + MBED_ROM_SIZE)) || (address < FLASH_BASE)) {
         return MBED_FLASH_INVALID_SIZE;
     } else {
         return FLASH_PAGE_SIZE;
@@ -301,7 +300,7 @@ uint32_t flash_get_start_address(const flash_t *obj)
  */
 uint32_t flash_get_size(const flash_t *obj)
 {
-    return FLASH_SIZE;
+    return MBED_ROM_SIZE;
 }
 
 uint8_t flash_get_erase_value(const flash_t *obj)

targets/TARGET_STM/TARGET_STM32WB/flash_data.h

@@ -1,31 +0,0 @@
-/* mbed Microcontroller Library
- * Copyright (c) 2019 STMicroelectronics
- * SPDX-License-Identifier: Apache-2.0
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-#ifndef MBED_FLASH_DATA_H
-#define MBED_FLASH_DATA_H
-
-#if DEVICE_FLASH
-
-#ifdef FLASH_SIZE
-#undef FLASH_SIZE
-#endif
-
-// Only the first the application side is accessible.
-#define FLASH_SIZE    ((uint32_t)0xC0000) // 768 Kbytes
-
-#endif
-#endif

targets/targets.json

@@ -4160,6 +4160,7 @@
             "STM32WB",
             "CORDIO"
         ],
+        "mbed_rom_start": "0x08000000",
         "config": {
             "lpticker_lptim": {
                 "help": "This target supports LPTIM. Set value 1 to use LPTIM for LPTICKER, or 0 to use RTC wakeup timer",
@@ -4196,6 +4197,7 @@
         "extra_labels_add": [
             "STM32WB55xG"
         ],
+        "mbed_rom_size": "0xCA000",
         "macros_add": [
             "STM32WB55xx",
             "MBEDTLS_CONFIG_HW_SUPPORT"
@@ -4224,6 +4226,7 @@
         "extra_labels_add": [
             "STM32WB5MxG"
         ],
+        "mbed_rom_size": "0xCA000",
         "macros_add": [
             "STM32WB5Mxx",
             "MBEDTLS_CONFIG_HW_SUPPORT"