]> granicus.if.org Git - esp-idf/commitdiff
component/bt: add more information and description for bluetooth modem sleep
authorwangmengyang <wangmengyang@espressif.com>
Fri, 21 Dec 2018 11:30:20 +0000 (19:30 +0800)
committerwangmengyang <wangmengyang@espressif.com>
Fri, 21 Dec 2018 11:30:20 +0000 (19:30 +0800)
Add remark that "EVED" mode for bluetooth modem sleep is only used for internal test

components/bt/Kconfig
components/bt/bt.c

index ab44cf18de4277c0f2665057957253dd91989e1e..0c9430e9316176ad04362e47d8fe1ba7d89cc08f 100644 (file)
@@ -146,11 +146,13 @@ choice BTDM_MODEM_SLEEP_MODE
 config BTDM_MODEM_SLEEP_MODE_ORIG
     bool "ORIG Mode(sleep with low power clock)"
     help
-        ORIG mode is a deep sleep mode that can be used for dual mode controller. In this mode, bluetooth controller sleeps between BR/EDR frames and BLE events. A low power clock is used to maintain bluetooth reference clock.
+        ORIG mode is a bluetooth sleep mode that can be used for dual mode controller. In this mode, bluetooth controller
+        sleeps between BR/EDR frames and BLE events. A low power clock is used to maintain bluetooth reference clock.
 config BTDM_MODEM_SLEEP_MODE_EVED
-    bool "EVED Mode "
+    bool "EVED Mode(For internal test only)"
     help
-        This mode is for BLE only.
+        EVED mode is for BLE only and is only for internal test. Do not use it for production. this mode is not compatible
+        with DFS nor light sleep
 endchoice
 
 choice BTDM_LOW_POWER_CLOCK
@@ -164,6 +166,7 @@ config BTDM_LPCLK_SEL_MAIN_XTAL
     help
         Main crystal can be used as low power clock for bluetooth modem sleep. If this option is selected, bluetooth
         modem sleep can work under Dynamic Frequency Scaling(DFS) enabled, but cannot work when light sleep is enabled.
+        Main crystal has a relatively better performance than other bluetooth low power clock sources.
 config BTDM_LPCLK_SEL_EXT_32K_XTAL
     bool "External 32kHz crystal"
     depends on ESP32_RTC_CLOCK_SOURCE_EXTERNAL_CRYSTAL
index d6e1d4192dc410da70f6c7c36abecb40c0330c8c..82bf79fde6d50c7f18eb43a7cce142eebdbe834b 100644 (file)
@@ -66,7 +66,7 @@
 /* Sleep mode */
 #define BTDM_MODEM_SLEEP_MODE_NONE          (0)
 #define BTDM_MODEM_SLEEP_MODE_ORIG          (1)
-#define BTDM_MODEM_SLEEP_MODE_EVED          (2)
+#define BTDM_MODEM_SLEEP_MODE_EVED          (2)  // sleep mode for BLE controller, used only for internal test.
 
 /* Low Power Clock Selection */
 #define BTDM_LPCLK_SEL_XTAL      (0)