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