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.h" 45 #include "btstack_hid_parser.h" 46 47 #if defined __cplusplus 48 extern "C" { 49 #endif 50 51 52 /* API_START */ 53 54 typedef struct { 55 uint16_t hid_device_subclass; 56 uint8_t hid_country_code; 57 uint8_t hid_virtual_cable; 58 uint8_t hid_remote_wake; 59 uint8_t hid_reconnect_initiate; 60 bool hid_normally_connectable; 61 bool hid_boot_device; 62 uint16_t hid_ssr_host_max_latency; 63 uint16_t hid_ssr_host_min_timeout; 64 uint16_t hid_supervision_timeout; 65 const uint8_t * hid_descriptor; 66 uint16_t hid_descriptor_size; 67 const char * device_name; 68 } hid_sdp_record_t; 69 70 /** 71 * @brief Create HID Device SDP service record. 72 * @param service Empty buffer in which a new service record will be stored. 73 * @param have_remote_audio_control 74 * @param service 75 * @param service_record_handle 76 * @param params 77 */ 78 void hid_create_sdp_record(uint8_t * service, uint32_t service_record_handle, const hid_sdp_record_t * params); 79 80 /** 81 * @brief Set up HID Device 82 * @param boot_protocol_mode_supported 83 * @param hid_descriptor_len 84 * @param hid_descriptor 85 */ 86 void hid_device_init(bool boot_protocol_mode_supported, uint16_t hid_descriptor_len, const uint8_t * hid_descriptor); 87 88 /** 89 * @brief Register callback for the HID Device client. 90 * @param callback 91 */ 92 void hid_device_register_packet_handler(btstack_packet_handler_t callback); 93 94 /** 95 * @brief Register get report callback for the HID Device client. 96 * @param callback 97 */ 98 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)); 99 100 /** 101 * @brief Register set report callback for the HID Device client. 102 * @param callback 103 */ 104 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)); 105 106 /** 107 * @brief Register callback to receive report data for the HID Device client. 108 * @param callback 109 */ 110 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)); 111 112 /* 113 * @brief Create HID connection to HID Host 114 * @param addr 115 * @param hid_cid to use for other commands 116 * @result status 117 */ 118 uint8_t hid_device_connect(bd_addr_t addr, uint16_t * hid_cid); 119 120 /* 121 * @brief Disconnect from HID Host 122 * @param hid_cid 123 */ 124 void hid_device_disconnect(uint16_t hid_cid); 125 126 /** 127 * @brief Request can send now event to send HID Report 128 * Generates an HID_SUBEVENT_CAN_SEND_NOW subevent 129 * @param hid_cid 130 */ 131 void hid_device_request_can_send_now_event(uint16_t hid_cid); 132 133 /** 134 * @brief Send HID message on interrupt channel 135 * @param hid_cid 136 */ 137 void hid_device_send_interrupt_message(uint16_t hid_cid, const uint8_t * message, uint16_t message_len); 138 139 /** 140 * @brief Send HID message on control channel 141 * @param hid_cid 142 */ 143 void hid_device_send_control_message(uint16_t hid_cid, const uint8_t * message, uint16_t message_len); 144 145 /** 146 * @brief Retutn 1 if boot protocol mode active 147 * @param hid_cid 148 */ 149 int hid_device_in_boot_protocol_mode(uint16_t hid_cid); 150 151 /** 152 * @brief De-Init HID Device 153 */ 154 void hid_device_deinit(void); 155 156 /* API_END */ 157 158 /* Only needed for PTS Testing */ 159 void hid_device_disconnect_interrupt_channel(uint16_t hid_cid); 160 void hid_device_disconnect_control_channel(uint16_t hid_cid); 161 162 #if defined __cplusplus 163 } 164 #endif 165 166 #endif 167