esp_hid_gap.c 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855
  1. /*
  2. * SPDX-FileCopyrightText: 2021-2023 Espressif Systems (Shanghai) CO LTD
  3. *
  4. * SPDX-License-Identifier: Unlicense OR CC0-1.0
  5. */
  6. #include <string.h>
  7. #include <stdbool.h>
  8. #include <inttypes.h>
  9. #include "freertos/FreeRTOS.h"
  10. #include "freertos/task.h"
  11. #include "freertos/semphr.h"
  12. #include "esp_hid_gap.h"
  13. static const char *TAG = "ESP_HID_GAP";
  14. // uncomment to print all devices that were seen during a scan
  15. #define GAP_DBG_PRINTF(...) printf(__VA_ARGS__)
  16. #if CONFIG_BT_HID_HOST_ENABLED
  17. static const char * gap_bt_prop_type_names[5] = {"","BDNAME","COD","RSSI","EIR"};
  18. #endif
  19. static esp_hid_scan_result_t *bt_scan_results = NULL;
  20. static size_t num_bt_scan_results = 0;
  21. static esp_hid_scan_result_t *ble_scan_results = NULL;
  22. static size_t num_ble_scan_results = 0;
  23. static SemaphoreHandle_t bt_hidh_cb_semaphore = NULL;
  24. #define WAIT_BT_CB() xSemaphoreTake(bt_hidh_cb_semaphore, portMAX_DELAY)
  25. #define SEND_BT_CB() xSemaphoreGive(bt_hidh_cb_semaphore)
  26. static SemaphoreHandle_t ble_hidh_cb_semaphore = NULL;
  27. #define WAIT_BLE_CB() xSemaphoreTake(ble_hidh_cb_semaphore, portMAX_DELAY)
  28. #define SEND_BLE_CB() xSemaphoreGive(ble_hidh_cb_semaphore)
  29. #define SIZEOF_ARRAY(a) (sizeof(a)/sizeof(*a))
  30. static const char *ble_gap_evt_names[] = { "ADV_DATA_SET_COMPLETE", "SCAN_RSP_DATA_SET_COMPLETE", "SCAN_PARAM_SET_COMPLETE", "SCAN_RESULT", "ADV_DATA_RAW_SET_COMPLETE", "SCAN_RSP_DATA_RAW_SET_COMPLETE", "ADV_START_COMPLETE", "SCAN_START_COMPLETE", "AUTH_CMPL", "KEY", "SEC_REQ", "PASSKEY_NOTIF", "PASSKEY_REQ", "OOB_REQ", "LOCAL_IR", "LOCAL_ER", "NC_REQ", "ADV_STOP_COMPLETE", "SCAN_STOP_COMPLETE", "SET_STATIC_RAND_ADDR", "UPDATE_CONN_PARAMS", "SET_PKT_LENGTH_COMPLETE", "SET_LOCAL_PRIVACY_COMPLETE", "REMOVE_BOND_DEV_COMPLETE", "CLEAR_BOND_DEV_COMPLETE", "GET_BOND_DEV_COMPLETE", "READ_RSSI_COMPLETE", "UPDATE_WHITELIST_COMPLETE"};
  31. static const char *bt_gap_evt_names[] = { "DISC_RES", "DISC_STATE_CHANGED", "RMT_SRVCS", "RMT_SRVC_REC", "AUTH_CMPL", "PIN_REQ", "CFM_REQ", "KEY_NOTIF", "KEY_REQ", "READ_RSSI_DELTA"};
  32. static const char *ble_addr_type_names[] = {"PUBLIC", "RANDOM", "RPA_PUBLIC", "RPA_RANDOM"};
  33. const char *ble_addr_type_str(esp_ble_addr_type_t ble_addr_type)
  34. {
  35. if (ble_addr_type > BLE_ADDR_TYPE_RPA_RANDOM) {
  36. return "UNKNOWN";
  37. }
  38. return ble_addr_type_names[ble_addr_type];
  39. }
  40. const char *ble_gap_evt_str(uint8_t event)
  41. {
  42. if (event >= SIZEOF_ARRAY(ble_gap_evt_names)) {
  43. return "UNKNOWN";
  44. }
  45. return ble_gap_evt_names[event];
  46. }
  47. const char *bt_gap_evt_str(uint8_t event)
  48. {
  49. if (event >= SIZEOF_ARRAY(bt_gap_evt_names)) {
  50. return "UNKNOWN";
  51. }
  52. return bt_gap_evt_names[event];
  53. }
  54. #if CONFIG_BT_BLE_ENABLED
  55. const char *esp_ble_key_type_str(esp_ble_key_type_t key_type)
  56. {
  57. const char *key_str = NULL;
  58. switch (key_type) {
  59. case ESP_LE_KEY_NONE:
  60. key_str = "ESP_LE_KEY_NONE";
  61. break;
  62. case ESP_LE_KEY_PENC:
  63. key_str = "ESP_LE_KEY_PENC";
  64. break;
  65. case ESP_LE_KEY_PID:
  66. key_str = "ESP_LE_KEY_PID";
  67. break;
  68. case ESP_LE_KEY_PCSRK:
  69. key_str = "ESP_LE_KEY_PCSRK";
  70. break;
  71. case ESP_LE_KEY_PLK:
  72. key_str = "ESP_LE_KEY_PLK";
  73. break;
  74. case ESP_LE_KEY_LLK:
  75. key_str = "ESP_LE_KEY_LLK";
  76. break;
  77. case ESP_LE_KEY_LENC:
  78. key_str = "ESP_LE_KEY_LENC";
  79. break;
  80. case ESP_LE_KEY_LID:
  81. key_str = "ESP_LE_KEY_LID";
  82. break;
  83. case ESP_LE_KEY_LCSRK:
  84. key_str = "ESP_LE_KEY_LCSRK";
  85. break;
  86. default:
  87. key_str = "INVALID BLE KEY TYPE";
  88. break;
  89. }
  90. return key_str;
  91. }
  92. #endif /* CONFIG_BT_BLE_ENABLED */
  93. void esp_hid_scan_results_free(esp_hid_scan_result_t *results)
  94. {
  95. esp_hid_scan_result_t *r = NULL;
  96. while (results) {
  97. r = results;
  98. results = results->next;
  99. if (r->name != NULL) {
  100. free((char *)r->name);
  101. }
  102. free(r);
  103. }
  104. }
  105. #if (CONFIG_BT_HID_HOST_ENABLED || CONFIG_BT_BLE_ENABLED)
  106. static esp_hid_scan_result_t *find_scan_result(esp_bd_addr_t bda, esp_hid_scan_result_t *results)
  107. {
  108. esp_hid_scan_result_t *r = results;
  109. while (r) {
  110. if (memcmp(bda, r->bda, sizeof(esp_bd_addr_t)) == 0) {
  111. return r;
  112. }
  113. r = r->next;
  114. }
  115. return NULL;
  116. }
  117. #endif /* (CONFIG_BT_HID_HOST_ENABLED || CONFIG_BT_BLE_ENABLED) */
  118. #if CONFIG_BT_HID_HOST_ENABLED
  119. static void add_bt_scan_result(esp_bd_addr_t bda, esp_bt_cod_t *cod, esp_bt_uuid_t *uuid, uint8_t *name, uint8_t name_len, int rssi)
  120. {
  121. esp_hid_scan_result_t *r = find_scan_result(bda, bt_scan_results);
  122. if (r) {
  123. //Some info may come later
  124. if (r->name == NULL && name && name_len) {
  125. char *name_s = (char *)malloc(name_len + 1);
  126. if (name_s == NULL) {
  127. ESP_LOGE(TAG, "Malloc result name failed!");
  128. return;
  129. }
  130. memcpy(name_s, name, name_len);
  131. name_s[name_len] = 0;
  132. r->name = (const char *)name_s;
  133. }
  134. if (r->bt.uuid.len == 0 && uuid->len) {
  135. memcpy(&r->bt.uuid, uuid, sizeof(esp_bt_uuid_t));
  136. }
  137. if (rssi != 0) {
  138. r->rssi = rssi;
  139. }
  140. return;
  141. }
  142. r = (esp_hid_scan_result_t *)malloc(sizeof(esp_hid_scan_result_t));
  143. if (r == NULL) {
  144. ESP_LOGE(TAG, "Malloc bt_hidh_scan_result_t failed!");
  145. return;
  146. }
  147. r->transport = ESP_HID_TRANSPORT_BT;
  148. memcpy(r->bda, bda, sizeof(esp_bd_addr_t));
  149. memcpy(&r->bt.cod, cod, sizeof(esp_bt_cod_t));
  150. memcpy(&r->bt.uuid, uuid, sizeof(esp_bt_uuid_t));
  151. r->usage = esp_hid_usage_from_cod((uint32_t)cod);
  152. r->rssi = rssi;
  153. r->name = NULL;
  154. if (name_len && name) {
  155. char *name_s = (char *)malloc(name_len + 1);
  156. if (name_s == NULL) {
  157. free(r);
  158. ESP_LOGE(TAG, "Malloc result name failed!");
  159. return;
  160. }
  161. memcpy(name_s, name, name_len);
  162. name_s[name_len] = 0;
  163. r->name = (const char *)name_s;
  164. }
  165. r->next = bt_scan_results;
  166. bt_scan_results = r;
  167. num_bt_scan_results++;
  168. }
  169. #endif
  170. #if CONFIG_BT_BLE_ENABLED
  171. static void add_ble_scan_result(esp_bd_addr_t bda, esp_ble_addr_type_t addr_type, uint16_t appearance, uint8_t *name, uint8_t name_len, int rssi)
  172. {
  173. if (find_scan_result(bda, ble_scan_results)) {
  174. ESP_LOGW(TAG, "Result already exists!");
  175. return;
  176. }
  177. esp_hid_scan_result_t *r = (esp_hid_scan_result_t *)malloc(sizeof(esp_hid_scan_result_t));
  178. if (r == NULL) {
  179. ESP_LOGE(TAG, "Malloc ble_hidh_scan_result_t failed!");
  180. return;
  181. }
  182. r->transport = ESP_HID_TRANSPORT_BLE;
  183. memcpy(r->bda, bda, sizeof(esp_bd_addr_t));
  184. r->ble.appearance = appearance;
  185. r->ble.addr_type = addr_type;
  186. r->usage = esp_hid_usage_from_appearance(appearance);
  187. r->rssi = rssi;
  188. r->name = NULL;
  189. if (name_len && name) {
  190. char *name_s = (char *)malloc(name_len + 1);
  191. if (name_s == NULL) {
  192. free(r);
  193. ESP_LOGE(TAG, "Malloc result name failed!");
  194. return;
  195. }
  196. memcpy(name_s, name, name_len);
  197. name_s[name_len] = 0;
  198. r->name = (const char *)name_s;
  199. }
  200. r->next = ble_scan_results;
  201. ble_scan_results = r;
  202. num_ble_scan_results++;
  203. }
  204. #endif /* CONFIG_BT_BLE_ENABLED */
  205. void print_uuid(esp_bt_uuid_t *uuid)
  206. {
  207. if (uuid->len == ESP_UUID_LEN_16) {
  208. GAP_DBG_PRINTF("UUID16: 0x%04x", uuid->uuid.uuid16);
  209. } else if (uuid->len == ESP_UUID_LEN_32) {
  210. GAP_DBG_PRINTF("UUID32: 0x%08"PRIx32, uuid->uuid.uuid32);
  211. } else if (uuid->len == ESP_UUID_LEN_128) {
  212. GAP_DBG_PRINTF("UUID128: %02x,%02x,%02x,%02x,%02x,%02x,%02x,%02x,%02x,%02x,%02x,%02x,%02x,%02x,%02x,%02x", uuid->uuid.uuid128[0],
  213. uuid->uuid.uuid128[1], uuid->uuid.uuid128[2], uuid->uuid.uuid128[3],
  214. uuid->uuid.uuid128[4], uuid->uuid.uuid128[5], uuid->uuid.uuid128[6],
  215. uuid->uuid.uuid128[7], uuid->uuid.uuid128[8], uuid->uuid.uuid128[9],
  216. uuid->uuid.uuid128[10], uuid->uuid.uuid128[11], uuid->uuid.uuid128[12],
  217. uuid->uuid.uuid128[13], uuid->uuid.uuid128[14], uuid->uuid.uuid128[15]);
  218. }
  219. }
  220. #if CONFIG_BT_HID_HOST_ENABLED
  221. static void handle_bt_device_result(struct disc_res_param *disc_res)
  222. {
  223. GAP_DBG_PRINTF("BT : " ESP_BD_ADDR_STR, ESP_BD_ADDR_HEX(disc_res->bda));
  224. uint32_t codv = 0;
  225. esp_bt_cod_t *cod = (esp_bt_cod_t *)&codv;
  226. int8_t rssi = 0;
  227. uint8_t *name = NULL;
  228. uint8_t name_len = 0;
  229. esp_bt_uuid_t uuid;
  230. uuid.len = ESP_UUID_LEN_16;
  231. uuid.uuid.uuid16 = 0;
  232. for (int i = 0; i < disc_res->num_prop; i++) {
  233. esp_bt_gap_dev_prop_t *prop = &disc_res->prop[i];
  234. if (prop->type != ESP_BT_GAP_DEV_PROP_EIR) {
  235. GAP_DBG_PRINTF(", %s: ", gap_bt_prop_type_names[prop->type]);
  236. }
  237. if (prop->type == ESP_BT_GAP_DEV_PROP_BDNAME) {
  238. name = (uint8_t *)prop->val;
  239. name_len = strlen((const char *)name);
  240. GAP_DBG_PRINTF("%s", (const char *)name);
  241. } else if (prop->type == ESP_BT_GAP_DEV_PROP_RSSI) {
  242. rssi = *((int8_t *)prop->val);
  243. GAP_DBG_PRINTF("%d", rssi);
  244. } else if (prop->type == ESP_BT_GAP_DEV_PROP_COD) {
  245. memcpy(&codv, prop->val, sizeof(uint32_t));
  246. GAP_DBG_PRINTF("major: %s, minor: %d, service: 0x%03x", esp_hid_cod_major_str(cod->major), cod->minor, cod->service);
  247. } else if (prop->type == ESP_BT_GAP_DEV_PROP_EIR) {
  248. uint8_t len = 0;
  249. uint8_t *data = 0;
  250. data = esp_bt_gap_resolve_eir_data((uint8_t *)prop->val, ESP_BT_EIR_TYPE_CMPL_16BITS_UUID, &len);
  251. if (data == NULL) {
  252. data = esp_bt_gap_resolve_eir_data((uint8_t *)prop->val, ESP_BT_EIR_TYPE_INCMPL_16BITS_UUID, &len);
  253. }
  254. if (data && len == ESP_UUID_LEN_16) {
  255. uuid.len = ESP_UUID_LEN_16;
  256. uuid.uuid.uuid16 = data[0] + (data[1] << 8);
  257. GAP_DBG_PRINTF(", "); print_uuid(&uuid);
  258. continue;
  259. }
  260. data = esp_bt_gap_resolve_eir_data((uint8_t *)prop->val, ESP_BT_EIR_TYPE_CMPL_32BITS_UUID, &len);
  261. if (data == NULL) {
  262. data = esp_bt_gap_resolve_eir_data((uint8_t *)prop->val, ESP_BT_EIR_TYPE_INCMPL_32BITS_UUID, &len);
  263. }
  264. if (data && len == ESP_UUID_LEN_32) {
  265. uuid.len = len;
  266. memcpy(&uuid.uuid.uuid32, data, sizeof(uint32_t));
  267. GAP_DBG_PRINTF(", "); print_uuid(&uuid);
  268. continue;
  269. }
  270. data = esp_bt_gap_resolve_eir_data((uint8_t *)prop->val, ESP_BT_EIR_TYPE_CMPL_128BITS_UUID, &len);
  271. if (data == NULL) {
  272. data = esp_bt_gap_resolve_eir_data((uint8_t *)prop->val, ESP_BT_EIR_TYPE_INCMPL_128BITS_UUID, &len);
  273. }
  274. if (data && len == ESP_UUID_LEN_128) {
  275. uuid.len = len;
  276. memcpy(uuid.uuid.uuid128, (uint8_t *)data, len);
  277. GAP_DBG_PRINTF(", "); print_uuid(&uuid);
  278. continue;
  279. }
  280. //try to find a name
  281. if (name == NULL) {
  282. data = esp_bt_gap_resolve_eir_data((uint8_t *)prop->val, ESP_BT_EIR_TYPE_CMPL_LOCAL_NAME, &len);
  283. if (data == NULL) {
  284. data = esp_bt_gap_resolve_eir_data((uint8_t *)prop->val, ESP_BT_EIR_TYPE_SHORT_LOCAL_NAME, &len);
  285. }
  286. if (data && len) {
  287. name = data;
  288. name_len = len;
  289. GAP_DBG_PRINTF(", NAME: ");
  290. for (int x = 0; x < len; x++) {
  291. GAP_DBG_PRINTF("%c", (char)data[x]);
  292. }
  293. }
  294. }
  295. }
  296. }
  297. GAP_DBG_PRINTF("\n");
  298. if (cod->major == ESP_BT_COD_MAJOR_DEV_PERIPHERAL || (find_scan_result(disc_res->bda, bt_scan_results) != NULL)) {
  299. add_bt_scan_result(disc_res->bda, cod, &uuid, name, name_len, rssi);
  300. }
  301. }
  302. #endif
  303. #if CONFIG_BT_BLE_ENABLED
  304. static void handle_ble_device_result(struct ble_scan_result_evt_param *scan_rst)
  305. {
  306. uint16_t uuid = 0;
  307. uint16_t appearance = 0;
  308. char name[64] = {0};
  309. uint8_t uuid_len = 0;
  310. uint8_t *uuid_d = esp_ble_resolve_adv_data(scan_rst->ble_adv, ESP_BLE_AD_TYPE_16SRV_CMPL, &uuid_len);
  311. if (uuid_d != NULL && uuid_len) {
  312. uuid = uuid_d[0] + (uuid_d[1] << 8);
  313. }
  314. uint8_t appearance_len = 0;
  315. uint8_t *appearance_d = esp_ble_resolve_adv_data(scan_rst->ble_adv, ESP_BLE_AD_TYPE_APPEARANCE, &appearance_len);
  316. if (appearance_d != NULL && appearance_len) {
  317. appearance = appearance_d[0] + (appearance_d[1] << 8);
  318. }
  319. uint8_t adv_name_len = 0;
  320. uint8_t *adv_name = esp_ble_resolve_adv_data(scan_rst->ble_adv, ESP_BLE_AD_TYPE_NAME_CMPL, &adv_name_len);
  321. if (adv_name == NULL) {
  322. adv_name = esp_ble_resolve_adv_data(scan_rst->ble_adv, ESP_BLE_AD_TYPE_NAME_SHORT, &adv_name_len);
  323. }
  324. if (adv_name != NULL && adv_name_len) {
  325. memcpy(name, adv_name, adv_name_len);
  326. name[adv_name_len] = 0;
  327. }
  328. GAP_DBG_PRINTF("BLE: " ESP_BD_ADDR_STR ", ", ESP_BD_ADDR_HEX(scan_rst->bda));
  329. GAP_DBG_PRINTF("RSSI: %d, ", scan_rst->rssi);
  330. GAP_DBG_PRINTF("UUID: 0x%04x, ", uuid);
  331. GAP_DBG_PRINTF("APPEARANCE: 0x%04x, ", appearance);
  332. GAP_DBG_PRINTF("ADDR_TYPE: '%s'", ble_addr_type_str(scan_rst->ble_addr_type));
  333. if (adv_name_len) {
  334. GAP_DBG_PRINTF(", NAME: '%s'", name);
  335. }
  336. GAP_DBG_PRINTF("\n");
  337. if (uuid == ESP_GATT_UUID_HID_SVC) {
  338. add_ble_scan_result(scan_rst->bda, scan_rst->ble_addr_type, appearance, adv_name, adv_name_len, scan_rst->rssi);
  339. }
  340. }
  341. #endif /* CONFIG_BT_BLE_ENABLED */
  342. #if CONFIG_BT_HID_HOST_ENABLED
  343. /*
  344. * BT GAP
  345. * */
  346. static void bt_gap_event_handler(esp_bt_gap_cb_event_t event, esp_bt_gap_cb_param_t *param)
  347. {
  348. switch (event) {
  349. case ESP_BT_GAP_DISC_STATE_CHANGED_EVT: {
  350. ESP_LOGV(TAG, "BT GAP DISC_STATE %s", (param->disc_st_chg.state == ESP_BT_GAP_DISCOVERY_STARTED) ? "START" : "STOP");
  351. if (param->disc_st_chg.state == ESP_BT_GAP_DISCOVERY_STOPPED) {
  352. SEND_BT_CB();
  353. }
  354. break;
  355. }
  356. case ESP_BT_GAP_DISC_RES_EVT: {
  357. handle_bt_device_result(&param->disc_res);
  358. break;
  359. }
  360. #if (CONFIG_EXAMPLE_SSP_ENABLED)
  361. case ESP_BT_GAP_KEY_NOTIF_EVT:
  362. ESP_LOGI(TAG, "BT GAP KEY_NOTIF passkey:%"PRIu32, param->key_notif.passkey);
  363. break;
  364. case ESP_BT_GAP_CFM_REQ_EVT: {
  365. ESP_LOGI(TAG, "BT GAP CFM_REQ_EVT Please compare the numeric value: %"PRIu32, param->cfm_req.num_val);
  366. esp_bt_gap_ssp_confirm_reply(param->cfm_req.bda, true);
  367. break;
  368. }
  369. case ESP_BT_GAP_KEY_REQ_EVT:
  370. ESP_LOGI(TAG, "BT GAP KEY_REQ_EVT Please enter passkey!");
  371. break;
  372. #endif
  373. case ESP_BT_GAP_MODE_CHG_EVT:
  374. ESP_LOGI(TAG, "BT GAP MODE_CHG_EVT mode:%d", param->mode_chg.mode);
  375. break;
  376. case ESP_BT_GAP_PIN_REQ_EVT: {
  377. ESP_LOGI(TAG, "BT GAP PIN_REQ_EVT min_16_digit:%d", param->pin_req.min_16_digit);
  378. if (param->pin_req.min_16_digit) {
  379. ESP_LOGI(TAG, "Input pin code: 0000 0000 0000 0000");
  380. esp_bt_pin_code_t pin_code = {0};
  381. esp_bt_gap_pin_reply(param->pin_req.bda, true, 16, pin_code);
  382. } else {
  383. ESP_LOGI(TAG, "Input pin code: 1234");
  384. esp_bt_pin_code_t pin_code;
  385. pin_code[0] = '1';
  386. pin_code[1] = '2';
  387. pin_code[2] = '3';
  388. pin_code[3] = '4';
  389. esp_bt_gap_pin_reply(param->pin_req.bda, true, 4, pin_code);
  390. }
  391. break;
  392. }
  393. default:
  394. ESP_LOGW(TAG, "BT GAP EVENT %s", bt_gap_evt_str(event));
  395. break;
  396. }
  397. }
  398. static esp_err_t init_bt_gap(void)
  399. {
  400. esp_err_t ret;
  401. #if (CONFIG_EXAMPLE_SSP_ENABLED)
  402. /* Set default parameters for Secure Simple Pairing */
  403. esp_bt_sp_param_t param_type = ESP_BT_SP_IOCAP_MODE;
  404. esp_bt_io_cap_t iocap = ESP_BT_IO_CAP_IO;
  405. esp_bt_gap_set_security_param(param_type, &iocap, sizeof(uint8_t));
  406. #endif
  407. /*
  408. * Set default parameters for Legacy Pairing
  409. * Use variable pin, input pin code when pairing
  410. */
  411. esp_bt_pin_type_t pin_type = ESP_BT_PIN_TYPE_VARIABLE;
  412. esp_bt_pin_code_t pin_code;
  413. esp_bt_gap_set_pin(pin_type, 0, pin_code);
  414. if ((ret = esp_bt_gap_register_callback(bt_gap_event_handler)) != ESP_OK) {
  415. ESP_LOGE(TAG, "esp_bt_gap_register_callback failed: %d", ret);
  416. return ret;
  417. }
  418. // Allow BT devices to connect back to us
  419. if ((ret = esp_bt_gap_set_scan_mode(ESP_BT_CONNECTABLE, ESP_BT_NON_DISCOVERABLE)) != ESP_OK) {
  420. ESP_LOGE(TAG, "esp_bt_gap_set_scan_mode failed: %d", ret);
  421. return ret;
  422. }
  423. return ret;
  424. }
  425. static esp_err_t start_bt_scan(uint32_t seconds)
  426. {
  427. esp_err_t ret = ESP_OK;
  428. if ((ret = esp_bt_gap_start_discovery(ESP_BT_INQ_MODE_GENERAL_INQUIRY, (int)(seconds / 1.28), 0)) != ESP_OK) {
  429. ESP_LOGE(TAG, "esp_bt_gap_start_discovery failed: %d", ret);
  430. return ret;
  431. }
  432. return ret;
  433. }
  434. #endif
  435. #if CONFIG_BT_BLE_ENABLED
  436. /*
  437. * BLE GAP
  438. * */
  439. static void ble_gap_event_handler(esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param)
  440. {
  441. switch (event) {
  442. /*
  443. * SCAN
  444. * */
  445. case ESP_GAP_BLE_SCAN_PARAM_SET_COMPLETE_EVT: {
  446. ESP_LOGV(TAG, "BLE GAP EVENT SCAN_PARAM_SET_COMPLETE");
  447. SEND_BLE_CB();
  448. break;
  449. }
  450. case ESP_GAP_BLE_SCAN_RESULT_EVT: {
  451. esp_ble_gap_cb_param_t *scan_result = (esp_ble_gap_cb_param_t *)param;
  452. switch (scan_result->scan_rst.search_evt) {
  453. case ESP_GAP_SEARCH_INQ_RES_EVT: {
  454. handle_ble_device_result(&scan_result->scan_rst);
  455. break;
  456. }
  457. case ESP_GAP_SEARCH_INQ_CMPL_EVT:
  458. ESP_LOGV(TAG, "BLE GAP EVENT SCAN DONE: %d", scan_result->scan_rst.num_resps);
  459. SEND_BLE_CB();
  460. break;
  461. default:
  462. break;
  463. }
  464. break;
  465. }
  466. case ESP_GAP_BLE_SCAN_STOP_COMPLETE_EVT: {
  467. ESP_LOGV(TAG, "BLE GAP EVENT SCAN CANCELED");
  468. break;
  469. }
  470. /*
  471. * ADVERTISEMENT
  472. * */
  473. case ESP_GAP_BLE_ADV_DATA_SET_COMPLETE_EVT:
  474. ESP_LOGV(TAG, "BLE GAP ADV_DATA_SET_COMPLETE");
  475. break;
  476. case ESP_GAP_BLE_ADV_START_COMPLETE_EVT:
  477. ESP_LOGV(TAG, "BLE GAP ADV_START_COMPLETE");
  478. break;
  479. /*
  480. * AUTHENTICATION
  481. * */
  482. case ESP_GAP_BLE_AUTH_CMPL_EVT:
  483. if (!param->ble_security.auth_cmpl.success) {
  484. ESP_LOGE(TAG, "BLE GAP AUTH ERROR: 0x%x", param->ble_security.auth_cmpl.fail_reason);
  485. } else {
  486. ESP_LOGI(TAG, "BLE GAP AUTH SUCCESS");
  487. }
  488. break;
  489. case ESP_GAP_BLE_KEY_EVT: //shows the ble key info share with peer device to the user.
  490. ESP_LOGI(TAG, "BLE GAP KEY type = %s", esp_ble_key_type_str(param->ble_security.ble_key.key_type));
  491. break;
  492. case ESP_GAP_BLE_PASSKEY_NOTIF_EVT: // ESP_IO_CAP_OUT
  493. // The app will receive this evt when the IO has Output capability and the peer device IO has Input capability.
  494. // Show the passkey number to the user to input it in the peer device.
  495. ESP_LOGI(TAG, "BLE GAP PASSKEY_NOTIF passkey:%"PRIu32, param->ble_security.key_notif.passkey);
  496. break;
  497. case ESP_GAP_BLE_NC_REQ_EVT: // ESP_IO_CAP_IO
  498. // The app will receive this event when the IO has DisplayYesNO capability and the peer device IO also has DisplayYesNo capability.
  499. // show the passkey number to the user to confirm it with the number displayed by peer device.
  500. ESP_LOGI(TAG, "BLE GAP NC_REQ passkey:%"PRIu32, param->ble_security.key_notif.passkey);
  501. esp_ble_confirm_reply(param->ble_security.key_notif.bd_addr, true);
  502. break;
  503. case ESP_GAP_BLE_PASSKEY_REQ_EVT: // ESP_IO_CAP_IN
  504. // The app will receive this evt when the IO has Input capability and the peer device IO has Output capability.
  505. // See the passkey number on the peer device and send it back.
  506. ESP_LOGI(TAG, "BLE GAP PASSKEY_REQ");
  507. //esp_ble_passkey_reply(param->ble_security.ble_req.bd_addr, true, 1234);
  508. break;
  509. case ESP_GAP_BLE_SEC_REQ_EVT:
  510. ESP_LOGI(TAG, "BLE GAP SEC_REQ");
  511. // Send the positive(true) security response to the peer device to accept the security request.
  512. // If not accept the security request, should send the security response with negative(false) accept value.
  513. esp_ble_gap_security_rsp(param->ble_security.ble_req.bd_addr, true);
  514. break;
  515. default:
  516. ESP_LOGV(TAG, "BLE GAP EVENT %s", ble_gap_evt_str(event));
  517. break;
  518. }
  519. }
  520. static esp_err_t init_ble_gap(void)
  521. {
  522. esp_err_t ret;
  523. if ((ret = esp_ble_gap_register_callback(ble_gap_event_handler)) != ESP_OK) {
  524. ESP_LOGE(TAG, "esp_ble_gap_register_callback failed: %d", ret);
  525. return ret;
  526. }
  527. return ret;
  528. }
  529. static esp_ble_scan_params_t hid_scan_params = {
  530. .scan_type = BLE_SCAN_TYPE_ACTIVE,
  531. .own_addr_type = BLE_ADDR_TYPE_PUBLIC,
  532. .scan_filter_policy = BLE_SCAN_FILTER_ALLOW_ALL,
  533. .scan_interval = 0x50,
  534. .scan_window = 0x30,
  535. .scan_duplicate = BLE_SCAN_DUPLICATE_ENABLE,
  536. };
  537. static esp_err_t start_ble_scan(uint32_t seconds)
  538. {
  539. esp_err_t ret = ESP_OK;
  540. if ((ret = esp_ble_gap_set_scan_params(&hid_scan_params)) != ESP_OK) {
  541. ESP_LOGE(TAG, "esp_ble_gap_set_scan_params failed: %d", ret);
  542. return ret;
  543. }
  544. WAIT_BLE_CB();
  545. if ((ret = esp_ble_gap_start_scanning(seconds)) != ESP_OK) {
  546. ESP_LOGE(TAG, "esp_ble_gap_start_scanning failed: %d", ret);
  547. return ret;
  548. }
  549. return ret;
  550. }
  551. esp_err_t esp_hid_ble_gap_adv_init(uint16_t appearance, const char *device_name)
  552. {
  553. esp_err_t ret;
  554. const uint8_t hidd_service_uuid128[] = {
  555. 0xfb, 0x34, 0x9b, 0x5f, 0x80, 0x00, 0x00, 0x80, 0x00, 0x10, 0x00, 0x00, 0x12, 0x18, 0x00, 0x00,
  556. };
  557. esp_ble_adv_data_t ble_adv_data = {
  558. .set_scan_rsp = false,
  559. .include_name = true,
  560. .include_txpower = true,
  561. .min_interval = 0x0006, //slave connection min interval, Time = min_interval * 1.25 msec
  562. .max_interval = 0x0010, //slave connection max interval, Time = max_interval * 1.25 msec
  563. .appearance = appearance,
  564. .manufacturer_len = 0,
  565. .p_manufacturer_data = NULL,
  566. .service_data_len = 0,
  567. .p_service_data = NULL,
  568. .service_uuid_len = sizeof(hidd_service_uuid128),
  569. .p_service_uuid = (uint8_t *)hidd_service_uuid128,
  570. .flag = 0x6,
  571. };
  572. esp_ble_auth_req_t auth_req = ESP_LE_AUTH_REQ_SC_MITM_BOND;
  573. //esp_ble_io_cap_t iocap = ESP_IO_CAP_OUT;//you have to enter the key on the host
  574. //esp_ble_io_cap_t iocap = ESP_IO_CAP_IN;//you have to enter the key on the device
  575. esp_ble_io_cap_t iocap = ESP_IO_CAP_IO;//you have to agree that key matches on both
  576. //esp_ble_io_cap_t iocap = ESP_IO_CAP_NONE;//device is not capable of input or output, unsecure
  577. uint8_t init_key = ESP_BLE_ENC_KEY_MASK | ESP_BLE_ID_KEY_MASK;
  578. uint8_t rsp_key = ESP_BLE_ENC_KEY_MASK | ESP_BLE_ID_KEY_MASK;
  579. uint8_t key_size = 16; //the key size should be 7~16 bytes
  580. uint32_t passkey = 1234;//ESP_IO_CAP_OUT
  581. if ((ret = esp_ble_gap_set_security_param(ESP_BLE_SM_AUTHEN_REQ_MODE, &auth_req, 1)) != ESP_OK) {
  582. ESP_LOGE(TAG, "GAP set_security_param AUTHEN_REQ_MODE failed: %d", ret);
  583. return ret;
  584. }
  585. if ((ret = esp_ble_gap_set_security_param(ESP_BLE_SM_IOCAP_MODE, &iocap, 1)) != ESP_OK) {
  586. ESP_LOGE(TAG, "GAP set_security_param IOCAP_MODE failed: %d", ret);
  587. return ret;
  588. }
  589. if ((ret = esp_ble_gap_set_security_param(ESP_BLE_SM_SET_INIT_KEY, &init_key, 1)) != ESP_OK) {
  590. ESP_LOGE(TAG, "GAP set_security_param SET_INIT_KEY failed: %d", ret);
  591. return ret;
  592. }
  593. if ((ret = esp_ble_gap_set_security_param(ESP_BLE_SM_SET_RSP_KEY, &rsp_key, 1)) != ESP_OK) {
  594. ESP_LOGE(TAG, "GAP set_security_param SET_RSP_KEY failed: %d", ret);
  595. return ret;
  596. }
  597. if ((ret = esp_ble_gap_set_security_param(ESP_BLE_SM_MAX_KEY_SIZE, &key_size, 1)) != ESP_OK) {
  598. ESP_LOGE(TAG, "GAP set_security_param MAX_KEY_SIZE failed: %d", ret);
  599. return ret;
  600. }
  601. if ((ret = esp_ble_gap_set_security_param(ESP_BLE_SM_SET_STATIC_PASSKEY, &passkey, sizeof(uint32_t))) != ESP_OK) {
  602. ESP_LOGE(TAG, "GAP set_security_param SET_STATIC_PASSKEY failed: %d", ret);
  603. return ret;
  604. }
  605. if ((ret = esp_ble_gap_set_device_name(device_name)) != ESP_OK) {
  606. ESP_LOGE(TAG, "GAP set_device_name failed: %d", ret);
  607. return ret;
  608. }
  609. if ((ret = esp_ble_gap_config_adv_data(&ble_adv_data)) != ESP_OK) {
  610. ESP_LOGE(TAG, "GAP config_adv_data failed: %d", ret);
  611. return ret;
  612. }
  613. return ret;
  614. }
  615. esp_err_t esp_hid_ble_gap_adv_start(void)
  616. {
  617. static esp_ble_adv_params_t hidd_adv_params = {
  618. .adv_int_min = 0x20,
  619. .adv_int_max = 0x30,
  620. .adv_type = ADV_TYPE_IND,
  621. .own_addr_type = BLE_ADDR_TYPE_PUBLIC,
  622. .channel_map = ADV_CHNL_ALL,
  623. .adv_filter_policy = ADV_FILTER_ALLOW_SCAN_ANY_CON_ANY,
  624. };
  625. return esp_ble_gap_start_advertising(&hidd_adv_params);
  626. }
  627. #endif /* CONFIG_BT_BLE_ENABLED */
  628. /*
  629. * CONTROLLER INIT
  630. * */
  631. static esp_err_t init_low_level(uint8_t mode)
  632. {
  633. esp_err_t ret;
  634. esp_bt_controller_config_t bt_cfg = BT_CONTROLLER_INIT_CONFIG_DEFAULT();
  635. #if CONFIG_IDF_TARGET_ESP32
  636. bt_cfg.mode = mode;
  637. #endif
  638. #if CONFIG_BT_HID_HOST_ENABLED
  639. if (mode & ESP_BT_MODE_CLASSIC_BT) {
  640. bt_cfg.bt_max_acl_conn = 3;
  641. bt_cfg.bt_max_sync_conn = 3;
  642. } else
  643. #endif
  644. {
  645. ret = esp_bt_controller_mem_release(ESP_BT_MODE_CLASSIC_BT);
  646. if (ret) {
  647. ESP_LOGE(TAG, "esp_bt_controller_mem_release failed: %d", ret);
  648. return ret;
  649. }
  650. }
  651. ret = esp_bt_controller_init(&bt_cfg);
  652. if (ret) {
  653. ESP_LOGE(TAG, "esp_bt_controller_init failed: %d", ret);
  654. return ret;
  655. }
  656. ret = esp_bt_controller_enable(mode);
  657. if (ret) {
  658. ESP_LOGE(TAG, "esp_bt_controller_enable failed: %d", ret);
  659. return ret;
  660. }
  661. esp_bluedroid_config_t bluedroid_cfg = BT_BLUEDROID_INIT_CONFIG_DEFAULT();
  662. #if (CONFIG_EXAMPLE_SSP_ENABLED == false)
  663. bluedroid_cfg.ssp_en = false;
  664. #endif
  665. ret = esp_bluedroid_init_with_cfg(&bluedroid_cfg);
  666. if (ret) {
  667. ESP_LOGE(TAG, "esp_bluedroid_init failed: %d", ret);
  668. return ret;
  669. }
  670. ret = esp_bluedroid_enable();
  671. if (ret) {
  672. ESP_LOGE(TAG, "esp_bluedroid_enable failed: %d", ret);
  673. return ret;
  674. }
  675. #if CONFIG_BT_HID_HOST_ENABLED
  676. if (mode & ESP_BT_MODE_CLASSIC_BT) {
  677. ret = init_bt_gap();
  678. if (ret) {
  679. return ret;
  680. }
  681. }
  682. #endif
  683. #if CONFIG_BT_BLE_ENABLED
  684. if (mode & ESP_BT_MODE_BLE) {
  685. ret = init_ble_gap();
  686. if (ret) {
  687. return ret;
  688. }
  689. }
  690. #endif /* CONFIG_BT_BLE_ENABLED */
  691. return ret;
  692. }
  693. esp_err_t esp_hid_gap_init(uint8_t mode)
  694. {
  695. esp_err_t ret;
  696. if (!mode || mode > ESP_BT_MODE_BTDM) {
  697. ESP_LOGE(TAG, "Invalid mode given!");
  698. return ESP_FAIL;
  699. }
  700. if (bt_hidh_cb_semaphore != NULL) {
  701. ESP_LOGE(TAG, "Already initialised");
  702. return ESP_FAIL;
  703. }
  704. bt_hidh_cb_semaphore = xSemaphoreCreateBinary();
  705. if (bt_hidh_cb_semaphore == NULL) {
  706. ESP_LOGE(TAG, "xSemaphoreCreateMutex failed!");
  707. return ESP_FAIL;
  708. }
  709. ble_hidh_cb_semaphore = xSemaphoreCreateBinary();
  710. if (ble_hidh_cb_semaphore == NULL) {
  711. ESP_LOGE(TAG, "xSemaphoreCreateMutex failed!");
  712. vSemaphoreDelete(bt_hidh_cb_semaphore);
  713. bt_hidh_cb_semaphore = NULL;
  714. return ESP_FAIL;
  715. }
  716. ret = init_low_level(mode);
  717. if (ret != ESP_OK) {
  718. vSemaphoreDelete(bt_hidh_cb_semaphore);
  719. bt_hidh_cb_semaphore = NULL;
  720. vSemaphoreDelete(ble_hidh_cb_semaphore);
  721. ble_hidh_cb_semaphore = NULL;
  722. return ret;
  723. }
  724. return ESP_OK;
  725. }
  726. esp_err_t esp_hid_scan(uint32_t seconds, size_t *num_results, esp_hid_scan_result_t **results)
  727. {
  728. if (num_bt_scan_results || bt_scan_results || num_ble_scan_results || ble_scan_results) {
  729. ESP_LOGE(TAG, "There are old scan results. Free them first!");
  730. return ESP_FAIL;
  731. }
  732. #if CONFIG_BT_BLE_ENABLED
  733. if (start_ble_scan(seconds) == ESP_OK) {
  734. WAIT_BLE_CB();
  735. } else {
  736. return ESP_FAIL;
  737. }
  738. #endif /* CONFIG_BT_BLE_ENABLED */
  739. #if CONFIG_BT_HID_HOST_ENABLED
  740. if (start_bt_scan(seconds) == ESP_OK) {
  741. WAIT_BT_CB();
  742. } else {
  743. return ESP_FAIL;
  744. }
  745. #endif
  746. *num_results = num_bt_scan_results + num_ble_scan_results;
  747. *results = bt_scan_results;
  748. if (num_bt_scan_results) {
  749. while (bt_scan_results->next != NULL) {
  750. bt_scan_results = bt_scan_results->next;
  751. }
  752. bt_scan_results->next = ble_scan_results;
  753. } else {
  754. *results = ble_scan_results;
  755. }
  756. num_bt_scan_results = 0;
  757. bt_scan_results = NULL;
  758. num_ble_scan_results = 0;
  759. ble_scan_results = NULL;
  760. return ESP_OK;
  761. }