xref: /btstack/src/ble/gatt-service/hids_device.h (revision 1b464e99afd70ddaf6b75be1ba7cc563a5f5dfd8)
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 #ifndef HIDS_DEVICE_H
38 #define HIDS_DEVICE_H
39 
40 #include <stdint.h>
41 #include "btstack_defines.h"
42 #include "bluetooth.h"
43 
44 #if defined __cplusplus
45 extern "C" {
46 #endif
47 
48 /**
49  * Implementation of the GATT HIDS Device
50  * To use with your application, add '#import <hids.gatt>' to your .gatt file
51  */
52 
53 /**
54  * @brief Set up HIDS Device
55  */
56 void hids_device_init(uint8_t hid_country_code, const uint8_t * hid_descriptor, uint16_t hid_descriptor_size);
57 
58 /**
59  * @brief Register callback for the HIDS Device client.
60  * @param callback
61  */
62 void hids_device_register_packet_handler(btstack_packet_handler_t callback);
63 
64 /**
65  * @brief Request can send now event to send HID Report
66  * Generates an HIDS_SUBEVENT_CAN_SEND_NOW subevent
67  * @param hid_cid
68  */
69 void hids_device_request_can_send_now_event(hci_con_handle_t con_handle);
70 
71 /**
72  * @brief Send HID Report: Input
73  */
74 void hids_device_send_input_report(hci_con_handle_t con_handle, const uint8_t * report, uint16_t report_len);
75 
76 /**
77  * @brief Send HID Report: Output
78  */
79 void hids_device_send_output_report(hci_con_handle_t con_handle, const uint8_t * report, uint16_t report_len);
80 
81 /**
82  * @brief Send HID Report: Feature
83  */
84 void hids_device_send_feature_report(hci_con_handle_t con_handle, const uint8_t * report, uint16_t report_len);
85 
86 /**
87  * @brief Send HID Boot Mouse Input Report
88  */
89 void hids_device_send_boot_mouse_input_report(hci_con_handle_t con_handle, const uint8_t * report, uint16_t report_len);
90 
91 /**
92  * @brief Send HID Boot Mouse Input Report
93  */
94 void hids_device_send_boot_keyboard_input_report(hci_con_handle_t con_handle, const uint8_t * report, uint16_t report_len);
95 
96 #if defined __cplusplus
97 }
98 #endif
99 
100 #endif
101