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 uint16_t id; 64 } hids_device_report_t; 65 66 /** 67 * @text Implementation of the GATT HIDS Device 68 * To use with your application, add '#import <hids.gatt>' to your .gatt file 69 */ 70 71 /** 72 * @brief Set up HIDS Device with single INPUT, OUTPUT and FEATURE report 73 */ 74 void hids_device_init(uint8_t hid_country_code, const uint8_t * hid_descriptor, uint16_t hid_descriptor_size); 75 76 /** 77 * @brief Set up HIDS Device for multiple instances of INPUT, OUTPUT and FEATURE reports 78 */ 79 void hids_device_init_with_storage(uint8_t hid_country_code, const uint8_t * hid_descriptor, uint16_t hid_descriptor_size, 80 uint16_t num_reports, hids_device_report_t * report_storage); 81 82 /** 83 * @brief Register callback for the HIDS Device client. 84 * @param callback 85 */ 86 void hids_device_register_packet_handler(btstack_packet_handler_t callback); 87 88 /** 89 * @brief Request can send now event to send HID Report 90 * Generates an HIDS_SUBEVENT_CAN_SEND_NOW subevent 91 * @param hid_cid 92 */ 93 void hids_device_request_can_send_now_event(hci_con_handle_t con_handle); 94 95 /** 96 * @brief Send HID Report with given ID 97 */ 98 uint8_t hids_device_send_report_with_id(hci_con_handle_t con_handle, uint16_t report_id, const uint8_t * report, uint16_t report_len); 99 100 /** 101 * @brief Send HID Report: Input 102 */ 103 void hids_device_send_input_report(hci_con_handle_t con_handle, const uint8_t * report, uint16_t report_len); 104 105 /** 106 * @brief Send HID Report: Output 107 */ 108 void hids_device_send_output_report(hci_con_handle_t con_handle, const uint8_t * report, uint16_t report_len); 109 110 /** 111 * @brief Send HID Report: Feature 112 */ 113 void hids_device_send_feature_report(hci_con_handle_t con_handle, const uint8_t * report, uint16_t report_len); 114 115 /** 116 * @brief Send HID Boot Mouse Input Report 117 */ 118 void hids_device_send_boot_mouse_input_report(hci_con_handle_t con_handle, const uint8_t * report, uint16_t report_len); 119 120 /** 121 * @brief Send HID Boot Mouse Input Report 122 */ 123 void hids_device_send_boot_keyboard_input_report(hci_con_handle_t con_handle, const uint8_t * report, uint16_t report_len); 124 125 /* API_END */ 126 127 #if defined __cplusplus 128 } 129 #endif 130 131 #endif 132