]> 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:29:47 +0000 (19:29 +0800)
committerwangmengyang <wangmengyang@espressif.com>
Fri, 21 Dec 2018 11:29:47 +0000 (19:29 +0800)
Add remark that "EVED" mode for bluetooth modem sleep is only used for internal test

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

index c583f4f7e54b048dc4b4fedf9885f833dc7bd4a4..f018d6d0360c594cf14ea8048dd60ad904fe717e 100644 (file)
@@ -145,11 +145,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
@@ -163,6 +165,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 8e37f39268bd7694ee9190642dd3970cac36a06f..56629e01df2007b51079de74eba6ab6fd61a6399 100644 (file)
@@ -65,7 +65,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)