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 10 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 // for each REPORT_MAP characteristic, read HID Descriptor (Report Map Characteristic Value) 71 HIDS_CLIENT_STATE_W2_READ_REPORT_MAP_CHARACTERISTIC_VALUE, 72 HIDS_CLIENT_STATE_W4_REPORT_MAP_CHARACTERISTIC_VALUE_RESULT, 73 74 // for REPORT_MAP characteristic, read External Report Reference Characteristic Descriptor 75 HIDS_CLIENT_STATE_W2_REPORT_MAP_READ_CHARACTERISTIC_DESCRIPTOR_VALUE, 76 HIDS_CLIENT_STATE_W4_REPORT_MAP_CHARACTERISTIC_DESCRIPTOR_VALUE_RESULT, 77 78 // for every external report reference uuid, discover external Report characteristic 79 HIDS_CLIENT_STATE_W2_REPORT_MAP_QUERY_EXTERNAL_REPORT_CHARACTERISTIC, 80 HIDS_CLIENT_STATE_W4_REPORT_MAP_EXTERNAL_REPORT_CHARACTERISTIC_RESULT, 81 82 // for each Report characteristics, discover characteristic descriptor 83 HIDS_CLIENT_STATE_W2_REPORT_QUERY_CHARACTERISTIC_DESCRIPTORS, 84 HIDS_CLIENT_STATE_W4_REPORT_CHARACTERISTIC_DESCRIPTORS_RESULT, 85 // then read value of characteristic descriptor to get report ID and type 86 HIDS_CLIENT_STATE_W2_REPORT_READ_CHARACTERISTIC_DESCRIPTOR_VALUE, 87 HIDS_CLIENT_STATE_W4_REPORT_CHARACTERISTIC_DESCRIPTOR_VALUE_RESULT, 88 89 // Boot Mode 90 HIDS_CLIENT_STATE_W2_ENABLE_KEYBOARD, 91 HIDS_CLIENT_STATE_W4_KEYBOARD_ENABLED, 92 HIDS_CLIENT_STATE_W2_ENABLE_MOUSE, 93 HIDS_CLIENT_STATE_W4_MOUSE_ENABLED, 94 95 96 HIDS_CLIENT_STATE_W2_SET_PROTOCOL_MODE, 97 HIDS_CLIENT_STATE_W4_SET_PROTOCOL_MODE, 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 uint16_t value_handle; 107 uint16_t end_handle; 108 uint16_t properties; 109 uint16_t external_report_reference_uuid; 110 111 // service mapping 112 uint8_t service_index; 113 uint8_t report_id; 114 hid_report_type_t report_type; 115 gatt_client_notification_t notifications; 116 } hids_client_report_t; 117 118 typedef struct { 119 uint16_t start_handle; 120 uint16_t end_handle; 121 } hid_service_t; 122 123 typedef struct { 124 btstack_linked_item_t item; 125 126 hci_con_handle_t con_handle; 127 uint16_t cid; 128 hid_protocol_mode_t protocol_mode; 129 hid_service_client_state_t state; 130 btstack_packet_handler_t client_handler; 131 132 uint8_t num_instances; 133 hid_service_t services[MAX_NUM_HID_SERVICES]; 134 135 // used for discovering characteristics 136 uint8_t service_index; 137 hid_protocol_mode_t required_protocol_mode; 138 139 uint16_t protocol_mode_value_handle; 140 141 // send report 142 hids_client_report_t reports[HIDS_CLIENT_NUM_REPORTS]; 143 uint8_t num_reports; 144 145 uint8_t active_report_index; 146 uint16_t descriptor_handle; 147 uint16_t report_len; 148 const uint8_t * report; 149 } hids_client_t; 150 151 /* API_START */ 152 153 /** 154 * @brief Initialize Battery Service. 155 */ 156 void hids_client_init(void); 157 158 /* @brief Connect to HID Services of remote device. 159 * 160 * @param con_handle 161 * @param packet_handler 162 * @param protocol_mode see hid_protocol_mode_t in hid.h 163 * @param hids_cid 164 * @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 165 */ 166 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); 167 168 /** 169 * @brief Send HID output report. 170 * @param hids_cid 171 * @param report_id 172 * @param report 173 * @param report_len 174 * @result status ERROR_CODE_SUCCESS on success, otherwise ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER, ERROR_CODE_COMMAND_DISALLOWED 175 */ 176 uint8_t hids_client_send_report(uint16_t hids_cid, uint8_t report_id, const uint8_t * report, uint8_t report_len); 177 178 /** 179 * @brief Disconnect from Battery Service. 180 * @param hids_cid 181 * @return status 182 */ 183 uint8_t hids_client_disconnect(uint16_t hids_cid); 184 185 /** 186 * @brief De-initialize Battery Service. 187 */ 188 void hids_client_deinit(void); 189 190 /* API_END */ 191 192 #if defined __cplusplus 193 } 194 #endif 195 196 #endif 197