1 /* 2 * Copyright (C) 2014 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 HID_DEVICE_H 39 #define HID_DEVICE_H 40 41 #include <stdint.h> 42 #include "btstack_defines.h" 43 #include "bluetooth.h" 44 #include "btstack_hid_parser.h" 45 46 #if defined __cplusplus 47 extern "C" { 48 #endif 49 50 /* API_START */ 51 52 #define HID_BOOT_MODE_KEYBOARD_ID 1 53 #define HID_BOOT_MODE_MOUSE_ID 2 54 55 typedef enum { 56 HID_MESSAGE_TYPE_HANDSHAKE = 0, 57 HID_MESSAGE_TYPE_HID_CONTROL, 58 HID_MESSAGE_TYPE_RESERVED_2, 59 HID_MESSAGE_TYPE_RESERVED_3, 60 HID_MESSAGE_TYPE_GET_REPORT, 61 HID_MESSAGE_TYPE_SET_REPORT, 62 HID_MESSAGE_TYPE_GET_PROTOCOL, 63 HID_MESSAGE_TYPE_SET_PROTOCOL, 64 HID_MESSAGE_TYPE_GET_IDLE_DEPRECATED, 65 HID_MESSAGE_TYPE_SET_IDLE_DEPRECATED, 66 HID_MESSAGE_TYPE_DATA, 67 HID_MESSAGE_TYPE_DATC_DEPRECATED 68 } hid_message_type_t; 69 70 typedef enum { 71 HID_HANDSHAKE_PARAM_TYPE_SUCCESSFUL = 0x00, // This code is used to acknowledge requests. A device that has correctly received SET_REPORT, SET_IDLE or SET_PROTOCOL payload transmits an acknowledgment to the host. 72 HID_HANDSHAKE_PARAM_TYPE_NOT_READY, // This code indicates that a device is too busy to accept data. The Bluetooth HID Host should retransmit the data the next time it communicates with the device. 73 HID_HANDSHAKE_PARAM_TYPE_ERR_INVALID_REPORT_ID, // Invalid report ID transmitted. 74 HID_HANDSHAKE_PARAM_TYPE_ERR_UNSUPPORTED_REQUEST, // The device does not support the request. This result code shall be used if the HIDP message type is unsupported. 75 HID_HANDSHAKE_PARAM_TYPE_ERR_INVALID_PARAMETER, // A parameter value is out of range or inappropriate for the request. 76 HID_HANDSHAKE_PARAM_TYPE_ERR_UNKNOWN = 0x0E // Device could not identify the error condition. 0xF = ERR_FATAL. Restart is essential to resume functionality. 77 } hid_handshake_param_type_t; 78 79 typedef enum { 80 HID_CONTROL_PARAM_NOP_DEPRECATED = 0, // Deprecated: No Operation. 81 HID_CONTROL_PARAM_HARD_RESET_DEPRECATED, // Deprecated: Device performs Power On System Test (POST) then initializes all internal variables and initiates normal operations. 82 HID_CONTROL_PARAM_SOFT_RESET_DEPRECATED, // Deprecated: Device initializes all internal variables and initiates normal operations. 83 HID_CONTROL_PARAM_SUSPEND = 0x03, // Go to reduced power mode. 84 HID_CONTROL_PARAM_EXIT_SUSPEND, // Exit reduced power mode. 85 HID_CONTROL_PARAM_VIRTUAL_CABLE_UNPLUG 86 } hid_control_param_t; 87 88 typedef enum { 89 HID_PROTOCOL_MODE_BOOT = 0, 90 HID_PROTOCOL_MODE_REPORT 91 } hid_protocol_mode_t; 92 93 /** 94 * @brief Create HID Device SDP service record. 95 * @param service Empty buffer in which a new service record will be stored. 96 * @param have_remote_audio_control 97 * @param service 98 * @param service_record_handle 99 * @param hid_device_subclass 100 * @param hid_country_code 101 * @param hid_virtual_cable 102 * @param hid_reconnect_initiate 103 * @param hid_boot_device 104 * @param hid_descriptor 105 * @param hid_descriptor_size size of hid_descriptor 106 * @param device_name 107 */ 108 void hid_create_sdp_record( 109 uint8_t * service, 110 uint32_t service_record_handle, 111 uint16_t hid_device_subclass, 112 uint8_t hid_country_code, 113 uint8_t hid_virtual_cable, 114 uint8_t hid_reconnect_initiate, 115 uint8_t hid_boot_device, 116 const uint8_t * hid_descriptor, 117 uint16_t hid_descriptor_size, 118 const char * device_name); 119 120 121 /** 122 * @brief Set up HID Device 123 * @param boot_protocol_mode_supported 124 * @param hid_descriptor_len 125 * @param hid_descriptor 126 */ 127 void hid_device_init(uint8_t boot_protocol_mode_supported, uint16_t hid_descriptor_len, const uint8_t * hid_descriptor); 128 129 /** 130 * @brief Register callback for the HID Device client. 131 * @param callback 132 */ 133 void hid_device_register_packet_handler(btstack_packet_handler_t callback); 134 135 /** 136 * @brief Register get report callback for the HID Device client. 137 * @param callback 138 */ 139 void hid_device_register_report_request_callback(int (*callback)(uint16_t hid_cid, hid_report_type_t report_type, uint16_t report_id, int * out_report_size, uint8_t * out_report)); 140 141 /** 142 * @brief Register set report callback for the HID Device client. 143 * @param callback 144 */ 145 void hid_device_register_set_report_callback(void (*callback)(uint16_t hid_cid, hid_report_type_t report_type, int report_size, uint8_t * report)); 146 147 /** 148 * @brief Register callback to receive report data for the HID Device client. 149 * @param callback 150 */ 151 void hid_device_register_report_data_callback(void (*callback)(uint16_t cid, hid_report_type_t report_type, uint16_t report_id, int report_size, uint8_t * report)); 152 153 /* 154 * @brief Create HID connection to HID Host 155 * @param addr 156 * @param hid_cid to use for other commands 157 * @result status 158 */ 159 uint8_t hid_device_connect(bd_addr_t addr, uint16_t * hid_cid); 160 161 /* 162 * @brief Disconnect from HID Host 163 * @param hid_cid 164 */ 165 void hid_device_disconnect(uint16_t hid_cid); 166 167 /** 168 * @brief Request can send now event to send HID Report 169 * Generates an HID_SUBEVENT_CAN_SEND_NOW subevent 170 * @param hid_cid 171 */ 172 void hid_device_request_can_send_now_event(uint16_t hid_cid); 173 174 /** 175 * @brief Send HID messageon interrupt channel 176 * @param hid_cid 177 */ 178 void hid_device_send_interrupt_message(uint16_t hid_cid, const uint8_t * message, uint16_t message_len); 179 180 /** 181 * @brief Send HID messageon control channel 182 * @param hid_cid 183 */ 184 void hid_device_send_control_message(uint16_t hid_cid, const uint8_t * message, uint16_t message_len); 185 186 /** 187 * @brief Retutn 1 if boot protocol mode active 188 * @param hid_cid 189 */ 190 int hid_device_in_boot_protocol_mode(uint16_t hid_cid); 191 192 /** 193 * @brief De-Init HID Device 194 */ 195 void hid_device_deinit(void); 196 197 /* API_END */ 198 199 /* Only needed for PTS Testing */ 200 void hid_device_disconnect_interrupt_channel(uint16_t hid_cid); 201 void hid_device_disconnect_control_channel(uint16_t hid_cid); 202 203 #if defined __cplusplus 204 } 205 #endif 206 207 #endif 208