1 /* 2 * Copyright (C) 2021 BlueKitchen GmbH 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the copyright holders nor the names of 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 4. Any redistribution, use, or modification is done solely for 17 * personal benefit and not for any commercial purpose or for 18 * monetary gain. 19 * 20 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS 24 * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * Please inquire about commercial licensing options at 34 * [email protected] 35 * 36 */ 37 38 #ifndef HIDS_CLIENT_H 39 #define HIDS_CLIENT_H 40 41 #if defined __cplusplus 42 extern "C" { 43 #endif 44 45 #include <stdint.h> 46 #include "hid.h" 47 #include "btstack_defines.h" 48 #include "bluetooth.h" 49 #include "btstack_linked_list.h" 50 #include "ble/gatt_client.h" 51 52 #ifndef MAX_NUM_HID_SERVICES 53 #define MAX_NUM_HID_SERVICES 3 54 #endif 55 #define HIDS_CLIENT_INVALID_REPORT_INDEX 0xFF 56 57 #define HIDS_CLIENT_NUM_REPORTS 15 58 59 typedef enum { 60 HIDS_CLIENT_STATE_IDLE, 61 62 // get all HID services 63 HIDS_CLIENT_STATE_W2_QUERY_SERVICE, 64 HIDS_CLIENT_STATE_W4_SERVICE_RESULT, 65 66 // for each service, discover all characteristics 67 HIDS_CLIENT_STATE_W2_QUERY_CHARACTERISTIC, 68 HIDS_CLIENT_STATE_W4_CHARACTERISTIC_RESULT, 69 70 HIDS_CLIENT_STATE_W2_SET_BOOT_PROTOCOL_MODE, 71 72 // for each REPORT_MAP characteristic, read HID Descriptor (Report Map Characteristic Value) 73 HIDS_CLIENT_STATE_W2_READ_REPORT_MAP_HID_DESCRIPTOR, 74 HIDS_CLIENT_STATE_W4_REPORT_MAP_HID_DESCRIPTOR, 75 76 // for REPORT_MAP characteristic, discover descriptor 77 HIDS_CLIENT_STATE_W2_REPORT_MAP_DISCOVER_CHARACTERISTIC_DESCRIPTORS, 78 HIDS_CLIENT_STATE_W4_REPORT_MAP_CHARACTERISTIC_DESCRIPTORS_RESULT, 79 80 // for REPORT_MAP characteristic, read External Report Reference Characteristic Descriptor 81 HIDS_CLIENT_STATE_W2_REPORT_MAP_READ_EXTERNAL_REPORT_REFERENCE_UUID, 82 HIDS_CLIENT_STATE_W4_REPORT_MAP_EXTERNAL_REPORT_REFERENCE_UUID, 83 84 // for every external report reference uuid, discover external Report characteristic 85 HIDS_CLIENT_STATE_W2_DISCOVER_EXTERNAL_REPORT_CHARACTERISTIC, 86 HIDS_CLIENT_STATE_W4_EXTERNAL_REPORT_CHARACTERISTIC_RESULT, 87 88 // for each Report characteristics, discover Report characteristic descriptor 89 HIDS_CLIENT_STATE_W2_FIND_REPORT, 90 HIDS_CLIENT_STATE_W4_REPORT_FOUND, 91 92 // then read value of Report characteristic descriptor to get report ID and type 93 HIDS_CLIENT_STATE_W2_READ_REPORT_ID_AND_TYPE, 94 HIDS_CLIENT_STATE_W4_REPORT_ID_AND_TYPE, 95 96 HIDS_CLIENT_STATE_W2_ENABLE_INPUT_REPORTS, 97 HIDS_CLIENT_STATE_W4_INPUT_REPORTS_ENABLED, 98 99 HIDS_CLIENT_STATE_CONNECTED, 100 HIDS_CLIENT_W2_SEND_REPORT 101 } hid_service_client_state_t; 102 103 104 typedef struct { 105 // GATT cache 106 107 //reuse as descriptor_handle 108 uint16_t value_handle; 109 uint16_t end_handle; 110 uint16_t properties; 111 112 // UUID of external Report characteristic, stored in Report Map descriptor EXTERNAL_REPORT_REFERENCE 113 uint16_t external_report_reference_uuid; 114 115 // service mapping 116 uint8_t service_index; 117 uint8_t report_id; 118 hid_report_type_t report_type; 119 uint8_t boot_report; 120 gatt_client_notification_t notification_listener; 121 } hids_client_report_t; 122 123 typedef struct { 124 uint16_t start_handle; 125 uint16_t end_handle; 126 127 uint16_t report_map_value_handle; 128 uint16_t report_map_end_handle; 129 130 // descriptor storage 131 uint16_t hid_descriptor_offset; 132 uint16_t hid_descriptor_len; 133 uint16_t hid_descriptor_max_len; 134 uint8_t hid_descriptor_status; // ERROR_CODE_SUCCESS if descriptor available, 135 // ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE if not, and 136 // ERROR_CODE_MEMORY_CAPACITY_EXCEEDED if descriptor is larger then the available space 137 } hid_service_t; 138 139 typedef struct { 140 btstack_linked_item_t item; 141 142 hci_con_handle_t con_handle; 143 uint16_t cid; 144 hid_protocol_mode_t protocol_mode; 145 hid_service_client_state_t state; 146 btstack_packet_handler_t client_handler; 147 148 uint8_t num_instances; 149 hid_service_t services[MAX_NUM_HID_SERVICES]; 150 151 // used for discovering characteristics 152 uint8_t service_index; 153 hid_protocol_mode_t required_protocol_mode; 154 155 uint16_t protocol_mode_value_handle; 156 157 // send report 158 hids_client_report_t reports[HIDS_CLIENT_NUM_REPORTS]; 159 uint8_t num_reports; 160 161 // index used for report and report map search 162 uint8_t report_index; 163 uint16_t descriptor_handle; 164 uint16_t report_len; 165 const uint8_t * report; 166 167 } hids_client_t; 168 169 /* API_START */ 170 171 /** 172 * @brief Initialize Battery Service. 173 * @param hid_descriptor_storage 174 * @param hid_descriptor_storage_len 175 */ 176 void hids_client_init(uint8_t * hid_descriptor_storage, uint16_t hid_descriptor_storage_len); 177 178 /* @brief Connect to HID Services of remote device. 179 * 180 * @param con_handle 181 * @param packet_handler 182 * @param protocol_mode see hid_protocol_mode_t in hid.h 183 * @param hids_cid 184 * @return status ERROR_CODE_SUCCESS on success, otherwise ERROR_CODE_COMMAND_DISALLOWED if there is already a client associated with con_handle, or BTSTACK_MEMORY_ALLOC_FAILED 185 */ 186 uint8_t hids_client_connect(hci_con_handle_t con_handle, btstack_packet_handler_t packet_handler, hid_protocol_mode_t protocol_mode, uint16_t * hids_cid); 187 188 /** 189 * @brief Send HID output report. 190 * @param hids_cid 191 * @param report_id 192 * @param report 193 * @param report_len 194 * @result status ERROR_CODE_SUCCESS on success, otherwise ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER, ERROR_CODE_COMMAND_DISALLOWED 195 */ 196 uint8_t hids_client_send_report(uint16_t hids_cid, uint8_t report_id, const uint8_t * report, uint8_t report_len); 197 198 /** 199 * @brief Disconnect from Battery Service. 200 * @param hids_cid 201 * @return status 202 */ 203 uint8_t hids_client_disconnect(uint16_t hids_cid); 204 205 /* 206 * @brief Get descriptor data 207 * @param hid_cid 208 * @result data 209 */ 210 const uint8_t * hids_client_descriptor_storage_get_descriptor_data(uint16_t hids_cid, uint8_t service_index); 211 212 /* 213 * @brief Get descriptor length 214 * @param hid_cid 215 * @result length 216 */ 217 uint16_t hids_client_descriptor_storage_get_descriptor_len(uint16_t hids_cid, uint8_t service_index); 218 219 /** 220 * @brief De-initialize Battery Service. 221 */ 222 void hids_client_deinit(void); 223 224 /* API_END */ 225 226 #if defined __cplusplus 227 } 228 #endif 229 230 #endif 231