Merge pull request #14670 from jeromecoutant/PR_README_SLEEP

STM32: add information in README for SLEEP feature

targets/TARGET_STM/README.md

@@ -1,5 +1,37 @@
 # README for Mbed OS STM32 targets
 
+Table of Contents
+=================
+
+* [README for Mbed OS STM32 targets](#readme-for-mbed-os-stm32-targets)
+   * [ST TOOLS](#st-tools)
+      * [USB drivers](#usb-drivers)
+      * [ST-Link FW](#st-link-fw)
+      * [STM32 Cube](#stm32-cube)
+      * [STM32CubeMX](#stm32cubemx)
+      * [STM32CubeProgrammer](#stm32cubeprogrammer)
+   * [STM32 families](#stm32-families)
+      * [STM32WB](#stm32wb)
+      * [STM32WL](#stm32wl)
+      * [STM32H7](#stm32h7)
+   * [Custom boards](#custom-boards)
+      * [STM32 organisation](#stm32-organisation)
+      * [Add a custom board](#add-a-custom-board)
+      * [Board specific files (pinmap)](#board-specific-files-pinmap)
+      * [Use of custom_targets.json](#use-of-custom_targetsjson)
+   * [ST specific implementation](#st-specific-implementation)
+      * [Pin configuration](#pin-configuration)
+         * [Alternate feature](#alternate-feature)
+         * [Conflict pins](#conflict-pins)
+      * [Clock selection](#clock-selection)
+         * [System clock](#system-clock)
+         * [Low power clock](#low-power-clock)
+      * [Sleep feature](#sleep-feature)
+      * [WiFi configuration](#wifi-configuration)
+      * [Ethernet configuration](#ethernet-configuration)
+   * [Mbed OS Wiki pages](#mbed-os-wiki-pages)
+
+
 ## ST TOOLS
 
 ### USB drivers
@@ -377,6 +409,27 @@ You can change this in you local mbed_app.json:
 ```
 
 
+### Sleep feature
+
+ST MCUs feature several low-power modes, please check Reference Manual of each one for more details.
+
+- MBED sleep mode is usually mapped to ST SLEEP mode:
+  - CPU clock is off
+  - all peripherals can run and wake up the CPU when an interrupt or an event
+occurs
+
+- MBED deepsleep mode is mapped to ST STOP2 mode:
+  - all clocks in the VCORE domain are stopped
+  - the PLL, the MSI, the HSI and the HSE are disabled
+  - the LSI and the LSE can be kept running
+  - RTC can remain active
+
+Detailed sleep Mbed OS description : https://os.mbed.com/docs/mbed-os/latest/apis/power-management-sleep.html
+- debug profile is disabling deepsleep
+- deepsleep can also be disabled by application or drivers using sleep_manager_lock_deep_sleep()
+- deep-sleep-latency value is configured to 4 by default for STM32
+
+
 ### WiFi configuration
 
 https://github.com/ARMmbed/wifi-ism43362