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 Service Server 40 * 41 */ 42 43 #ifndef HIDS_DEVICE_H 44 #define HIDS_DEVICE_H 45 46 #include <stdint.h> 47 #include "btstack_defines.h" 48 #include "btstack_hid.h" 49 #include "bluetooth.h" 50 51 #if defined __cplusplus 52 extern "C" { 53 #endif 54 55 /* API_START */ 56 57 typedef struct { 58 uint16_t value_handle; 59 uint16_t client_configuration_handle; 60 uint16_t client_configuration_value; 61 62 hid_report_type_t type; 63 uint8_t id; 64 uint8_t size; 65 } hids_device_report_t; 66 67 /** 68 * @text Implementation of the GATT HIDS Device 69 * To use with your application, add '#import <hids.gatt>' to your .gatt file 70 */ 71 72 /** 73 * @brief Set up HIDS Device with single INPUT, OUTPUT and FEATURE report 74 */ 75 void hids_device_init(uint8_t hid_country_code, const uint8_t * hid_descriptor, uint16_t hid_descriptor_size); 76 77 /** 78 * @brief Set up HIDS Device for multiple instances of INPUT, OUTPUT and FEATURE reports 79 */ 80 void hids_device_init_with_storage(uint8_t hid_country_code, const uint8_t * hid_descriptor, uint16_t hid_descriptor_size, 81 uint16_t num_reports, hids_device_report_t * report_storage); 82 83 /** 84 * @brief Register callback for the HIDS Device client. 85 * @param callback 86 */ 87 void hids_device_register_packet_handler(btstack_packet_handler_t callback); 88 89 /** 90 * @brief Register report callback for Get Report operation 91 * @param callback 92 */ 93 void hids_device_register_get_report_callback(void (*callback)(hci_con_handle_t con_handle, hid_report_type_t report_type, uint16_t report_id, uint16_t max_report_size, uint8_t * out_report)); 94 95 /** 96 * @brief Request can send now event to send HID Report 97 * Generates an HIDS_SUBEVENT_CAN_SEND_NOW subevent 98 * @param hid_cid 99 * @return ERROR_CODE_SUCCESS if ok, ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if handle unknown, and ERROR_CODE_COMMAND_DISALLOWED if callback already registered 100 */ 101 uint8_t hids_device_request_can_send_now_event(hci_con_handle_t con_handle); 102 103 /** 104 * @brief Send HID Input Report for Report ID 105 * @param con_handle 106 * @param report_id 107 * @param report 108 * @param report_len 109 * @returns status 110 */ 111 uint8_t hids_device_send_input_report_for_id(hci_con_handle_t con_handle, uint16_t report_id, const uint8_t * report, uint16_t report_len); 112 113 /** 114 * @brief Send HID Input Report for first Input Report 115 * @param con_handle 116 * @param report 117 * @param report_len 118 * @returns status 119 */ 120 uint8_t hids_device_send_input_report(hci_con_handle_t con_handle, const uint8_t * report, uint16_t report_len); 121 122 /** 123 * @brief Send HID Boot Mouse Input Report 124 * @param con_handle 125 * @param report 126 * @param report_len 127 * @returns status 128 */ 129 uint8_t hids_device_send_boot_mouse_input_report(hci_con_handle_t con_handle, const uint8_t * report, uint16_t report_len); 130 131 /** 132 * @brief Send HID Boot Mouse Input Report 133 * @param con_handle 134 * @param report 135 * @param report_len 136 * @returns status 137 */ 138 uint8_t hids_device_send_boot_keyboard_input_report(hci_con_handle_t con_handle, const uint8_t * report, uint16_t report_len); 139 140 /* API_END */ 141 142 #if defined __cplusplus 143 } 144 #endif 145 146 #endif 147