xref: /btstack/src/classic/hid_host.h (revision 63bf37cdf290a24499821ad093bb095cca27d8e2)
1 /*
2  * Copyright (C) 2020 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_HOST_H
39 #define HID_HOST_H
40 
41 #include <stdint.h>
42 #include "btstack_defines.h"
43 #include "bluetooth.h"
44 #include "btstack_hid_parser.h"
45 #include "classic/hid.h"
46 
47 #if defined __cplusplus
48 extern "C" {
49 #endif
50 
51 /* API_START */
52 /**
53  * @brief Set up HID Host
54  * @param boot_protocol_mode_supported
55  * @param hid_descriptor_storage
56  * @param hid_descriptor_storage_len
57  */
58 void hid_host_init(const uint8_t * hid_descriptor_storage, uint16_t hid_descriptor_storage_len);
59 
60 /**
61  * @brief Register callback for the HID Device Host.
62  * @param callback
63  */
64 void hid_host_register_packet_handler(btstack_packet_handler_t callback);
65 
66 /*
67  * @brief Create HID connection to HID Host
68  * @param addr
69  * @param hid_cid to use for other commands
70  * @result status
71  */
72 uint8_t hid_host_connect(bd_addr_t addr, hid_protocol_mode_t protocol_mode, uint16_t * hid_cid);
73 
74 /*
75  * @brief Disconnect from HID Host
76  * @param hid_cid
77  */
78 void hid_host_disconnect(uint16_t hid_cid);
79 
80 /**
81  * @brief Request can send now event to send HID Report
82  * Generates an HID_SUBEVENT_CAN_SEND_NOW subevent
83  * @param hid_cid
84  */
85 void hid_host_request_can_send_now_event(uint16_t hid_cid);
86 
87 /**
88  * @brief Send HID message on interrupt channel
89  * @param hid_cid
90  */
91 void hid_host_send_interrupt_message(uint16_t hid_cid, const uint8_t * message, uint16_t message_len);
92 
93 /**
94  * @brief Send HID message on control channel
95  * @param hid_cid
96  */
97 void hid_host_send_control_message(uint16_t hid_cid, const uint8_t * message, uint16_t message_len);
98 
99 
100 
101 /* API_END */
102 
103 
104 #if defined __cplusplus
105 }
106 #endif
107 
108 #endif
109