Merge branch 'feature/wifi_bt_new_coex' into 'master'

Feature/wifi bt new coex

See merge request idf/esp-idf!2087

Author: jack0c

.gitlab-ci.yml

@@ -98,8 +98,8 @@ build_template_app:
     - make all V=1
     # Check if there are any stray printf/ets_printf references in WiFi libs
     - cd ../components/esp32/lib
-    - test $(xtensa-esp32-elf-nm *.a | grep -w printf | wc -l) -eq 0
-    - test $(xtensa-esp32-elf-nm *.a | grep -w ets_printf | wc -l) -eq 0
+    - test $(ls *.a|awk '{if ($1 != "libcoexist.a") print $1}' | xargs xtensa-esp32-elf-nm | grep -w printf | wc -l) -eq 0
+    - test $(ls *.a|awk '{if ($1 != "libcoexist.a") print $1}' | xargs xtensa-esp32-elf-nm | grep -w ets_printf | wc -l) -eq 0
 
 
 .build_template: &build_template

components/bt/bt.c

@@ -540,7 +540,13 @@ esp_err_t esp_bt_controller_enable(esp_bt_mode_t mode)
     esp_pm_lock_acquire(s_pm_lock);
 #endif
 
-    esp_phy_load_cal_and_init();
+    esp_phy_load_cal_and_init(PHY_BT_MODULE);
+    esp_modem_sleep_register(MODEM_BLE_MODULE);
+
+    /* TODO: Classic BT should be registered once it supports 
+     * modem sleep */
+
+    esp_modem_sleep_exit(MODEM_BLE_MODULE);
 
     if (btdm_bb_init_flag == false) {
         btdm_bb_init_flag = true;
@@ -549,6 +555,8 @@ esp_err_t esp_bt_controller_enable(esp_bt_mode_t mode)
 
     ret = btdm_controller_enable(mode);
     if (ret) {
+        esp_modem_sleep_deregister(MODEM_BLE_MODULE);
+        esp_phy_rf_deinit(PHY_BT_MODULE);
         return ESP_ERR_INVALID_STATE;
     }
 
@@ -571,7 +579,10 @@ esp_err_t esp_bt_controller_disable(void)
     }
 
     if (ret == ESP_BT_MODE_IDLE) {
-        esp_phy_rf_deinit();
+        /* TODO: Need to de-register classic BT once it supports
+         * modem sleep */
+        esp_modem_sleep_deregister(MODEM_BLE_MODULE);
+        esp_phy_rf_deinit(PHY_BT_MODULE);
         btdm_controller_status = ESP_BT_CONTROLLER_STATUS_INITED;
     }
 

components/bt/lib

@@ -822,12 +822,40 @@ menu Wi-Fi
 config SW_COEXIST_ENABLE
     bool "Software controls WiFi/Bluetooth coexistence"
     depends on BT_ENABLED
-    default n
+    default y
     help
         If enabled, WiFi & Bluetooth coexistence is controlled by software rather than hardware.
         Recommended for heavy traffic scenarios. Both coexistence configuration options are
         automatically managed, no user intervention is required.
 
+choice SW_COEXIST_PREFERENCE
+    prompt "WiFi/Bluetooth coexistence performance preference"
+    depends on SW_COEXIST_ENABLE
+    default SW_COEXIST_PREFERENCE_BALANCE
+    help
+        Choose Bluetooth/WiFi/Balance for different preference.
+        If choose WiFi, it will make WiFi performance better. Such, keep WiFi Audio more smooth.
+        If choose Bluetooth, it will make Bluetooth performance better. Such, keep Bluetooth(A2DP) Audio more smooth.
+        If choose Balance, the performance of WiFi and bluetooth will be balance. It's default.
+        Except config preference in menuconfig, you can also call esp_coex_preference_set() dynamically.
+
+config SW_COEXIST_PREFERENCE_WIFI
+    bool "WiFi"
+
+config SW_COEXIST_PREFERENCE_BT
+    bool "Bluetooth(include BR/EDR and BLE)"
+
+config SW_COEXIST_PREFERENCE_BALANCE
+    bool "Balance"
+
+endchoice
+
+config SW_COEXIST_PREFERENCE_VALUE
+    int
+    depends on SW_COEXIST_ENABLE
+    default 0 if SW_COEXIST_PREFERENCE_WIFI
+    default 1 if SW_COEXIST_PREFERENCE_BT
+    default 2 if SW_COEXIST_PREFERENCE_BALANCE
 
 config ESP32_WIFI_STATIC_RX_BUFFER_NUM
     int "Max number of WiFi static RX buffers"
@@ -919,27 +947,33 @@ config ESP32_WIFI_DYNAMIC_TX_BUFFER_NUM
 
 config ESP32_WIFI_AMPDU_TX_ENABLED
     bool "WiFi AMPDU TX"
+    default y if SW_COEXIST_ENABLE
     default y
     help
         Select this option to enable AMPDU TX feature
+        Suggest enable it when SW_COEXIST_ENABLE is defined.
 
 
 config ESP32_WIFI_TX_BA_WIN
     int "WiFi AMPDU TX BA window size"
     depends on ESP32_WIFI_AMPDU_TX_ENABLED
     range 2 32
+    default 2 if SW_COEXIST_ENABLE
     default 6
     help
         Set the size of WiFi Block Ack TX window. Generally a bigger value means higher throughput but
         more memory. Most of time we should NOT change the default value unless special reason, e.g. 
         test the maximum UDP TX throughput with iperf etc. For iperf test in shieldbox, the recommended
-        value is 9~12.
+        value is 9~12. If SW_COEXIST_ENABLE is defined, suggest value is 2.
 
 config ESP32_WIFI_AMPDU_RX_ENABLED
     bool "WiFi AMPDU RX"
+    depends on !SW_COEXIST_ENABLE
+    default y
     default y
     help
         Select this option to enable AMPDU RX feature
+        Suggest disable this option when SW_COEXIST_ENABLE is enabled. It can improve WiFi RX performance normally.
 
 config ESP32_WIFI_RX_BA_WIN
     int "WiFi AMPDU RX BA window size"

components/esp32/Kconfig

@@ -18,33 +18,79 @@
 extern "C" {
 #endif
 
+typedef enum {
+    COEX_PREFER_WIFI = 0,
+    COEX_PREFER_BT,
+    COEX_PREFER_BALANCE,
+    COEX_PREFER_NUM,
+} coex_prefer_t;
+
 /**
  * @brief Init software coexist
+ *        extern function for internal use.
  *
  * @return Init ok or failed.
  */
 esp_err_t coex_init(void);
 
 /**
  * @brief De-init software coexist
+ *        extern function for internal use.
  */
 void coex_deinit(void);
 
 /**
- * @brief Get software coexist enable or not
+ * @brief Pause software coexist
+ *        extern function for internal use.
+ */
+void coex_pause(void);
+
+/**
+ * @brief Resume software coexist
+ *        extern function for internal use.
+ */
+void coex_resume(void);
+
+/**
+ * @brief Get software coexist version string
+ *        extern function for internal use.
+ * @return : version string
+ */
+const char *coex_version_get(void);
+
+/**
+ * @brief Coexist performance preference set from libbt.a
+ *        extern function for internal use.
  *
- * @return software coexist enable status.
+ *  @param prefer : the prefer enumeration value
+ *  @return : ESP_OK - success, other - failed
  */
-bool coexist_get_enable(void);
+esp_err_t coex_preference_set(coex_prefer_t prefer);
 
 /**
- * @brief Set software coexist enable or not
+ * @brief Get software coexist version string
  *
- * @param enable software coexist or disable it
+ * @return : version string
+ */
+static inline const char *esp_coex_version_get(void)
+{
+    return coex_version_get();
+}
+
+/**
+ * @brief Set coexist preference of performance
+ *  For example, if prefer to bluetooth, then it will make A2DP(play audio via classic bt)
+ *  more smooth while wifi is runnning something.
+ *  If prefer to wifi, it will do similar things as prefer to bluetooth.
+ *  Default, it prefer to balance.
  *
- * @return Void.
+ *  @param prefer : the prefer enumeration value
+ *  @return : ESP_OK - success, other - failed
  */
-void coexist_set_enable(bool enable);
+static inline esp_err_t esp_coex_preference_set(coex_prefer_t prefer)
+{
+    return coex_preference_set(prefer);
+}
 
 #ifdef __cplusplus
 }

components/esp32/include/esp_coexist.h

@@ -46,6 +46,43 @@ typedef enum {
     PHY_RF_CAL_FULL    = 0x00000002         /*!< Do full RF calibration. Produces best results, but also consumes a lot of time and current. Suggested to be used once. */
 } esp_phy_calibration_mode_t;
 
+
+/**
+ * @brief Modules for modem sleep 
+ */
+typedef enum{
+    MODEM_BLE_MODULE,              //!< BLE controller used
+    MODEM_CLASSIC_BT_MODULE,       //!< Classic BT controller used
+    MODEM_WIFI_STATION_MODULE,     //!< Wi-Fi Station used
+    MODEM_WIFI_SOFTAP_MODULE,      //!< Wi-Fi SoftAP used
+    MODEM_WIFI_SNIFFER_MODULE,     //!< Wi-Fi Sniffer used
+    MODEM_USER_MODULE,             //!< User used
+    MODEM_MODULE_COUNT             //!< Number of items
+}modem_sleep_module_t;
+
+/**
+ * @brief Module WIFI mask for medem sleep
+ */
+#define MODEM_BT_MASK   ((1<<MODEM_BLE_MODULE)          |   \
+                         (1<<MODEM_CLASSIC_BT_MODULE))
+
+/**
+ * @brief Module WIFI mask for medem sleep
+ */
+#define MODEM_WIFI_MASK ((1<<MODEM_WIFI_STATION_MODULE) |   \
+                         (1<<MODEM_WIFI_SOFTAP_MODULE)  |   \
+                         (1<<MODEM_WIFI_SNIFFER_MODULE))
+
+/**
+ * @brief Modules needing to call phy_rf_init
+ */
+typedef enum{
+    PHY_BT_MODULE,          //!< Bluetooth used
+    PHY_WIFI_MODULE,        //!< Wi-Fi used
+    PHY_MODEM_MODULE,       //!< Modem sleep used
+    PHY_MODULE_COUNT        //!< Number of items
+}phy_rf_module_t;
+
 /**
  * @brief Get PHY init data
  *
@@ -130,8 +167,8 @@ esp_err_t esp_phy_store_cal_data_to_nvs(const esp_phy_calibration_data_t* cal_da
  * @return ESP_OK on success.
  * @return ESP_FAIL on fail.
  */
-esp_err_t esp_phy_rf_init(const esp_phy_init_data_t* init_data,
-        esp_phy_calibration_mode_t mode, esp_phy_calibration_data_t* calibration_data);
+esp_err_t esp_phy_rf_init(const esp_phy_init_data_t* init_data,esp_phy_calibration_mode_t mode, 
+        esp_phy_calibration_data_t* calibration_data, phy_rf_module_t module);
 
 /**
  * @brief De-initialize PHY and RF module
@@ -142,12 +179,32 @@ esp_err_t esp_phy_rf_init(const esp_phy_init_data_t* init_data,
  *
  * @return ESP_OK on success.
  */
-esp_err_t esp_phy_rf_deinit(void);
+esp_err_t esp_phy_rf_deinit(phy_rf_module_t module);
 
 /**
  * @brief Load calibration data from NVS and initialize PHY and RF module
  */
-void esp_phy_load_cal_and_init(void);
+void esp_phy_load_cal_and_init(phy_rf_module_t module);
+
+/**
+ * @brief Module requires to enter modem sleep
+ */
+esp_err_t esp_modem_sleep_enter(modem_sleep_module_t module);
+
+/**
+ * @brief Module requires to exit modem sleep
+ */
+esp_err_t esp_modem_sleep_exit(modem_sleep_module_t module);
+
+/**
+ * @brief Register module to make it be able to require to enter/exit modem sleep
+ */
+esp_err_t esp_modem_sleep_register(modem_sleep_module_t module);
+
+/**
+ * @brief De-register module from modem sleep list 
+ */
+esp_err_t esp_modem_sleep_deregister(modem_sleep_module_t module);
 
 #ifdef __cplusplus
 }

components/esp32/include/esp_phy_init.h

@@ -174,8 +174,9 @@ typedef struct {
 }wifi_fast_scan_threshold_t;
 
 typedef enum {
-    WIFI_PS_NONE,    /**< No power save */
-    WIFI_PS_MODEM,   /**< Modem power save */
+    WIFI_PS_NONE,        /**< No power save */
+    WIFI_PS_MIN_MODEM,   /**< Minimum modem power save. In this mode, station wakes up to receive beacon every DTIM period */
+    WIFI_PS_MAX_MODEM,   /**< Maximum modem power save. In this mode, station wakes up to receive beacon every listen interval */
 } wifi_ps_type_t;
 
 #define WIFI_PROTOCOL_11B         1
@@ -208,6 +209,7 @@ typedef struct {
     bool bssid_set;        /**< whether set MAC address of target AP or not. Generally, station_config.bssid_set needs to be 0; and it needs to be 1 only when users need to check the MAC address of the AP.*/
     uint8_t bssid[6];     /**< MAC address of target AP*/
     uint8_t channel;       /**< channel of target AP. Set to 1~13 to scan starting from the specified channel before connecting to AP. If the channel of AP is unknown, set it to 0.*/
+    uint16_t listen_interval;   /**< Listen interval for ESP32 station to receive beacon in maximum power save mode, units: beacon interval */
     wifi_sort_method_t sort_method;    /**< sort the connect AP in the list by rssi or security mode */
     wifi_fast_scan_threshold_t  threshold;     /**< When scan_method is set to WIFI_FAST_SCAN, only APs which have an auth mode that is more secure than the selected auth mode and a signal stronger than the minimum RSSI will be used. */
 } wifi_sta_config_t;