Merge branch 'feature/hogp_example_support_v5.1' into 'release/v5.1'

feat(nimble): Added HID over Gatt Profile Support (v5.1)

See merge request espressif/esp-idf!28025

components/bt/CMakeLists.txt

@@ -537,6 +537,8 @@ if(CONFIG_BT_ENABLED)
                     host/nimble/nimble/nimble/host/services/prox/include
                     host/nimble/nimble/nimble/host/services/cts/include
                     host/nimble/nimble/nimble/host/services/tps/include
+                    host/nimble/nimble/nimble/host/services/hid/include
+                    host/nimble/nimble/nimble/host/services/sps/include
                     host/nimble/nimble/nimble/host/util/include
                     host/nimble/nimble/nimble/host/store/ram/include
                     host/nimble/nimble/nimble/host/store/config/include
@@ -557,6 +559,8 @@ if(CONFIG_BT_ENABLED)
                     "host/nimble/nimble/nimble/host/services/lls/src/ble_svc_lls.c"
                     "host/nimble/nimble/nimble/host/services/prox/src/ble_svc_prox.c"
                     "host/nimble/nimble/nimble/host/services/cts/src/ble_svc_cts.c"
+                    "host/nimble/nimble/nimble/host/services/hid/src/ble_svc_hid.c"
+                    "host/nimble/nimble/nimble/host/services/sps/src/ble_svc_sps.c"
                     "host/nimble/nimble/nimble/host/src/ble_hs_conn.c"
                     "host/nimble/nimble/nimble/host/src/ble_store_util.c"
                     "host/nimble/nimble/nimble/host/src/ble_sm.c"

components/bt/host/nimble/Kconfig.in

@@ -659,6 +659,29 @@ config BT_NIMBLE_BLE_GATT_BLOB_TRANSFER
         This option is used when data to be sent is more than 512 bytes. For peripheral role,
         BT_NIMBLE_MSYS_1_BLOCK_COUNT needs to be increased according to the need.
 
+menu "BLE Services"
+    menuconfig BT_NIMBLE_HID_SERVICE
+        bool "HID service"
+        depends on BT_NIMBLE_ENABLED
+        default n
+        help
+            Enable HID service support
+
+    config BT_NIMBLE_SVC_HID_MAX_INSTANCES
+        depends on BT_NIMBLE_HID_SERVICE
+        int "Maximum HID service instances"
+        default 2
+        help
+            Defines maximum number of HID service instances
+
+    config BT_NIMBLE_SVC_HID_MAX_RPTS
+        depends on BT_NIMBLE_HID_SERVICE
+        int "Maximum HID Report characteristics per service instance"
+        default 3
+        help
+            Defines maximum number of report characteristics per service instance
+endmenu
+
 config BT_NIMBLE_VS_SUPPORT
     bool "Enable support for VSC and VSE"
     help

components/bt/host/nimble/port/include/esp_nimble_cfg.h

@@ -908,6 +908,20 @@
 #ifndef MYNEWT_VAL_BLE_SVC_BAS_BATTERY_LEVEL_READ_PERM
 #define MYNEWT_VAL_BLE_SVC_BAS_BATTERY_LEVEL_READ_PERM (0)
 #endif
+
+/*** nimble/host/services/hid */
+#ifndef MYNEWT_VAL_BLE_SVC_HID_SERVICE
+#define MYNEWT_VAL_BLE_SVC_HID_SERVICE CONFIG_BT_NIMBLE_HID_SERVICE
+#endif
+
+#ifndef MYNEWT_VAL_BLE_SVC_HID_MAX_RPTS
+#define MYNEWT_VAL_BLE_SVC_HID_MAX_RPTS CONFIG_BT_NIMBLE_SVC_HID_MAX_RPTS
+#endif
+
+#ifndef MYNEWT_VAL_BLE_SVC_HID_MAX_SVC_INSTANCES
+#define MYNEWT_VAL_BLE_SVC_HID_MAX_SVC_INSTANCES CONFIG_BT_NIMBLE_SVC_HID_MAX_INSTANCES
+#endif
+
 #ifndef MYNEWT_VAL_BLE_MESH_ADV_TASK_PRIO
 #define MYNEWT_VAL_BLE_MESH_ADV_TASK_PRIO (9)
 #endif
@@ -1570,6 +1584,15 @@
 #define MYNEWT_VAL_BLE_SVC_DIS_SYSTEM_ID_READ_PERM (-1)
 #endif
 
+#ifndef MYNEWT_VAL_BLE_SVC_DIS_PNP_ID_DEFAULT
+#define MYNEWT_VAL_BLE_SVC_DIS_PNP_ID_DEFAULT (NULL)
+#endif
+
+/* Value copied from BLE_SVC_DIS_DEFAULT_READ_PERM */
+#ifndef MYNEWT_VAL_BLE_SVC_DIS_PNP_ID_READ_PERM
+#define MYNEWT_VAL_BLE_SVC_DIS_PNP_ID_READ_PERM (-1)
+#endif
+
 /*** @apache-mynewt-nimble/nimble/host/services/gap */
 #ifndef MYNEWT_VAL_BLE_SVC_GAP_APPEARANCE
 #define MYNEWT_VAL_BLE_SVC_GAP_APPEARANCE CONFIG_BT_NIMBLE_SVC_GAP_APPEARANCE

components/esp_hid/CMakeLists.txt

@@ -13,6 +13,11 @@ if(CONFIG_BT_ENABLED)
              "src/bt_hidh.c"
              "src/bt_hidd.c")
     endif()
+    if(CONFIG_BT_NIMBLE_ENABLED)
+        list(APPEND srcs
+                "src/nimble_hidd.c"
+                "src/nimble_hidh.c")
+    endif()
 endif()
 
 idf_component_register(SRCS "${srcs}"

components/esp_hid/include/esp_hidh_nimble.h

@@ -0,0 +1,28 @@
+/*
+ * SPDX-FileCopyrightText: 2017-2023 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#pragma once
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+#include "sdkconfig.h"
+
+#if CONFIG_BT_NIMBLE_ENABLED
+/**
+ * @brief Open BlueTooth HID Device using BlueDroid
+ * @param bda               : BT Device Address
+ * @param transport         : BT Device Protocol (Classic/HID)
+ * @param remote_addr_type  : BLE Remote address type
+ *
+ * @return: ESP_OK on success
+ */
+esp_hidh_dev_t *esp_hidh_dev_open(uint8_t *bda, esp_hid_transport_t transport, uint8_t remote_addr_type);
+#endif /* CONFIG_BT_NIMBLE_ENABLED */
+
+#ifdef __cplusplus
+}
+#endif

components/esp_hid/include/esp_hidh_transport.h

@@ -1,16 +1,8 @@
-// Copyright 2017-2019 Espressif Systems (Shanghai) PTE LTD
-//
-// 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.
+/*
+ * SPDX-FileCopyrightText: 2017-2023 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
 
 #pragma once
 
@@ -28,6 +20,10 @@ extern "C" {
 #include "esp_hidh_bluedroid.h"
 #endif
 
+#if CONFIG_BT_NIMBLE_ENABLED
+#include "esp_hidh_nimble.h"
+#endif
+
 #ifdef __cplusplus
 }
 #endif

components/esp_hid/private/ble_hidd.h

@@ -1,16 +1,8 @@
-// Copyright 2017-2019 Espressif Systems (Shanghai) PTE LTD
-//
-// 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.
+/*
+ * SPDX-FileCopyrightText: 2017-2023 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
 
 #pragma once
 
@@ -22,7 +14,7 @@
 extern "C" {
 #endif
 
-#if CONFIG_GATTS_ENABLE
+#if CONFIG_GATTS_ENABLE || CONFIG_BT_NIMBLE_ENABLED
 
 esp_err_t esp_ble_hidd_dev_init(esp_hidd_dev_t *dev, const esp_hid_device_config_t *config, esp_event_handler_t callback);
 

components/esp_hid/private/ble_hidh.h

@@ -1,16 +1,8 @@
-// Copyright 2017-2019 Espressif Systems (Shanghai) PTE LTD
-//
-// 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.
+/*
+ * SPDX-FileCopyrightText: 2017-2023 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
 
 #pragma once
 
@@ -20,12 +12,16 @@
 extern "C" {
 #endif
 
-#if CONFIG_GATTC_ENABLE
+#if CONFIG_GATTC_ENABLE || CONFIG_BT_NIMBLE_ENABLED
 
 esp_err_t esp_ble_hidh_init(const esp_hidh_config_t *config);
 esp_err_t esp_ble_hidh_deinit(void);
 
+#if CONFIG_BT_NIMBLE_ENABLED
+esp_hidh_dev_t *esp_ble_hidh_dev_open(uint8_t *bda, uint8_t address_type);
+#else
 esp_hidh_dev_t *esp_ble_hidh_dev_open(esp_bd_addr_t bda, esp_ble_addr_type_t address_type);
+#endif
 
 #endif /* CONFIG_GATTC_ENABLE */
 

components/esp_hid/private/esp_hidh_private.h

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2017-2022 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2017-2023 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -17,6 +17,9 @@
 #include "esp_event.h"
 #include "sys/queue.h"
 #include "esp_timer.h"
+#if CONFIG_BT_NIMBLE_ENABLED
+#include "nimble/ble.h"
+#endif
 
 #ifdef __cplusplus
 extern "C" {
@@ -52,7 +55,11 @@ struct esp_hidh_dev_s {
     esp_timer_handle_t      trans_timer;    //transactiion timer
     uint8_t                 report_type;    //Get_Report tansaction report_type
     uint8_t                 report_id;      //Get_Report tansaction report_id
+#if CONFIG_BT_NIMBLE_ENABLED
+    uint8_t                 *protocol_mode;  // protocol mode is unique for each hid service instance
+#else
     uint8_t                 protocol_mode;  //device protocol mode
+#endif
     bool                    connected;      //we have all required data to communicate
     bool                    opened;         //we opened the device manually, else the device connected to us
     bool                    added;          //If lower layer has added the device
@@ -82,6 +89,9 @@ struct esp_hidh_dev_s {
 #if CONFIG_BLUEDROID_ENABLED
     esp_bd_addr_t bda;
 #endif /* CONFIG_BLUEDROID_ENABLED */
+#if CONFIG_BT_NIMBLE_ENABLED
+    uint8_t bda[6];
+#endif
 
     union {
 #if CONFIG_BT_HID_HOST_ENABLED
@@ -102,6 +112,15 @@ struct esp_hidh_dev_s {
             uint16_t battery_ccc_handle;
         } ble;
 #endif /* CONFIG_GATTC_ENABLE */
+#if CONFIG_BT_NIMBLE_ENABLED
+        struct {
+            uint8_t address_type;
+            int conn_id;
+            uint16_t appearance;
+            uint16_t battery_handle;
+            uint16_t battery_ccc_handle;
+        } ble;
+#endif
     };
     TAILQ_ENTRY(esp_hidh_dev_s) devices;
 };
@@ -115,6 +134,10 @@ esp_hidh_dev_t *esp_hidh_dev_get_by_bda(esp_bd_addr_t bda); //BT/BLE
 esp_hidh_dev_t *esp_hidh_dev_get_by_handle(uint8_t handle); //Classic Bluetooth Only
 esp_hidh_dev_t *esp_hidh_dev_get_by_conn_id(uint16_t conn_id); //BLE Only
 #endif /* CONFIG_BLUEDROID_ENABLED */
+#if CONFIG_BT_NIMBLE_ENABLED
+esp_hidh_dev_t *esp_hidh_dev_get_by_bda(uint8_t* bda); // BLE Only
+esp_hidh_dev_t *esp_hidh_dev_get_by_conn_id(uint16_t conn_id); //BLE Only
+#endif
 
 esp_hidh_dev_report_t *esp_hidh_dev_get_report_by_id_type_proto(esp_hidh_dev_t *dev, size_t map_index, size_t report_id, int report_type, uint8_t protocol_mode);
 esp_hidh_dev_report_t *esp_hidh_dev_get_report_by_id_and_type(esp_hidh_dev_t *dev, size_t map_index, size_t report_id, int report_type);

components/esp_hid/src/esp_hid_common.c

@@ -1,16 +1,8 @@
-// Copyright 2017-2019 Espressif Systems (Shanghai) PTE LTD
-//
-// 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.
+/*
+ * SPDX-FileCopyrightText: 2017-2023 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
 
 #include <string.h>
 #include "esp_log.h"

components/esp_hid/src/esp_hidd.c

@@ -8,7 +8,7 @@
 #include "esp_hidd_private.h"
 #include "esp_event_base.h"
 
-#if CONFIG_GATTS_ENABLE
+#if CONFIG_GATTS_ENABLE || CONFIG_BT_NIMBLE_ENABLED
 #include "ble_hidd.h"
 #endif /* CONFIG_GATTS_ENABLE */
 
@@ -27,7 +27,7 @@ esp_err_t esp_hidd_dev_init(const esp_hid_device_config_t *config, esp_hid_trans
     }
 
     switch (transport) {
-#if CONFIG_GATTS_ENABLE
+#if CONFIG_GATTS_ENABLE || CONFIG_BT_NIMBLE_ENABLED
     case ESP_HID_TRANSPORT_BLE:
         ret = esp_ble_hidd_dev_init(dev, config, callback);
         break;