xref: /btstack/src/classic/hid_device.h (revision e6c9673776c7f85e24c76da7f4b1b83031102d2b)
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 
38 #include <stdint.h>
39 #include "btstack_defines.h"
40 /**
41  * @brief Create HID Device SDP service record.
42  * @param service Empty buffer in which a new service record will be stored.
43  * @param have_remote_audio_control
44  * @param service
45  * @param service_record_handle
46  * @param hid_device_subclass
47  * @param hid_country_code
48  * @param hid_virtual_cable
49  * @param hid_reconnect_initiate
50  * @param hid_boot_device
51  * @param hid_descriptor
52  * @param hid_descriptor_size size of hid_descriptor
53  * @param device_name
54  */
55 void hid_create_sdp_record(
56     uint8_t *       service,
57     uint32_t        service_record_handle,
58     uint16_t        hid_device_subclass,
59     uint8_t         hid_country_code,
60     uint8_t         hid_virtual_cable,
61     uint8_t         hid_reconnect_initiate,
62     uint8_t         hid_boot_device,
63     const uint8_t * hid_descriptor,
64     uint16_t 		hid_descriptor_size,
65     const char *    device_name);
66 
67 /**
68  * @brief Set up HID Device
69  */
70 void hid_device_init(void);
71 
72 /**
73  * @brief Register callback for the HID Device client.
74  * @param callback
75  */
76 void hid_device_register_packet_handler(btstack_packet_handler_t callback);
77 
78 /**
79  * @brief Request can send now event to send HID Report
80  * Generates an HID_SUBEVENT_CAN_SEND_NOW subevent
81  * @param hid_cid
82  */
83 void hid_device_request_can_send_now_event(uint16_t hid_cid);
84 
85 /**
86  * @brief Send HID messageon interrupt channel
87  * @param hid_cid
88  */
89 void hid_device_send_interrupt_message(uint16_t hid_cid, const uint8_t * message, uint16_t message_len);
90 
91 /**
92  * @brief Send HID messageon control channel
93  * @param hid_cid
94  */
95 void hid_device_send_contro_message(uint16_t hid_cid, const uint8_t * message, uint16_t message_len);
96 
97 
98