xref: /btstack/example/hid_keyboard_demo.c (revision 6518788a7f581e9f851e34d4cc0f6002e911bbce)
12fa56ea6SMatthias Ringwald /*
22fa56ea6SMatthias Ringwald  * Copyright (C) 2014 BlueKitchen GmbH
32fa56ea6SMatthias Ringwald  *
42fa56ea6SMatthias Ringwald  * Redistribution and use in source and binary forms, with or without
52fa56ea6SMatthias Ringwald  * modification, are permitted provided that the following conditions
62fa56ea6SMatthias Ringwald  * are met:
72fa56ea6SMatthias Ringwald  *
82fa56ea6SMatthias Ringwald  * 1. Redistributions of source code must retain the above copyright
92fa56ea6SMatthias Ringwald  *    notice, this list of conditions and the following disclaimer.
102fa56ea6SMatthias Ringwald  * 2. Redistributions in binary form must reproduce the above copyright
112fa56ea6SMatthias Ringwald  *    notice, this list of conditions and the following disclaimer in the
122fa56ea6SMatthias Ringwald  *    documentation and/or other materials provided with the distribution.
132fa56ea6SMatthias Ringwald  * 3. Neither the name of the copyright holders nor the names of
142fa56ea6SMatthias Ringwald  *    contributors may be used to endorse or promote products derived
152fa56ea6SMatthias Ringwald  *    from this software without specific prior written permission.
162fa56ea6SMatthias Ringwald  * 4. Any redistribution, use, or modification is done solely for
172fa56ea6SMatthias Ringwald  *    personal benefit and not for any commercial purpose or for
182fa56ea6SMatthias Ringwald  *    monetary gain.
192fa56ea6SMatthias Ringwald  *
202fa56ea6SMatthias Ringwald  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
212fa56ea6SMatthias Ringwald  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
222fa56ea6SMatthias Ringwald  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
232fa56ea6SMatthias Ringwald  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
242fa56ea6SMatthias Ringwald  * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
252fa56ea6SMatthias Ringwald  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
262fa56ea6SMatthias Ringwald  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
272fa56ea6SMatthias Ringwald  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
282fa56ea6SMatthias Ringwald  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
292fa56ea6SMatthias Ringwald  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
302fa56ea6SMatthias Ringwald  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
312fa56ea6SMatthias Ringwald  * SUCH DAMAGE.
322fa56ea6SMatthias Ringwald  *
332fa56ea6SMatthias Ringwald  * Please inquire about commercial licensing options at
342fa56ea6SMatthias Ringwald  * [email protected]
352fa56ea6SMatthias Ringwald  *
362fa56ea6SMatthias Ringwald  */
372fa56ea6SMatthias Ringwald 
382fa56ea6SMatthias Ringwald #define __BTSTACK_FILE__ "hid_device_demo.c"
392fa56ea6SMatthias Ringwald 
402fa56ea6SMatthias Ringwald // *****************************************************************************
412fa56ea6SMatthias Ringwald /* EXAMPLE_START(hid_device_demo): HID Device (Server) Demo
422fa56ea6SMatthias Ringwald  *
432fa56ea6SMatthias Ringwald  * @text This HID Device example demonstrates how to implement
44*6518788aSMatthias Ringwald  * an HID keyboard. Without a HAVE_POSIX_STDIN, a fixed demo text is sent
45*6518788aSMatthias Ringwald  * If HAVE_POSIX_STDIN is defined, you can type from the terminal
462fa56ea6SMatthias Ringwald  */
472fa56ea6SMatthias Ringwald // *****************************************************************************
482fa56ea6SMatthias Ringwald 
492fa56ea6SMatthias Ringwald 
502fa56ea6SMatthias Ringwald #include <stdint.h>
512fa56ea6SMatthias Ringwald #include <stdio.h>
522fa56ea6SMatthias Ringwald #include <stdlib.h>
532fa56ea6SMatthias Ringwald #include <string.h>
542fa56ea6SMatthias Ringwald #include <unistd.h>
550316aa6fSMatthias Ringwald #include <inttypes.h>
562fa56ea6SMatthias Ringwald 
572fa56ea6SMatthias Ringwald #include "btstack.h"
58*6518788aSMatthias Ringwald 
59*6518788aSMatthias Ringwald #undef HAVE_POSIX_STDIN
60*6518788aSMatthias Ringwald 
612fa56ea6SMatthias Ringwald #ifdef HAVE_POSIX_STDIN
622fa56ea6SMatthias Ringwald #include "stdin_support.h"
632fa56ea6SMatthias Ringwald #endif
642fa56ea6SMatthias Ringwald 
650316aa6fSMatthias Ringwald uint8_t hid_service_buffer[250];
662fa56ea6SMatthias Ringwald const char hid_device_name[] = "BTstack HID Keyboard";
672fa56ea6SMatthias Ringwald static btstack_packet_callback_registration_t hci_event_callback_registration;
682fa56ea6SMatthias Ringwald 
690316aa6fSMatthias Ringwald // hid device state
700316aa6fSMatthias Ringwald static uint16_t hid_control_cid;
710316aa6fSMatthias Ringwald static uint16_t hid_interrupt_cid;
720316aa6fSMatthias Ringwald 
732fa56ea6SMatthias Ringwald // from USB HID Specification 1.1, Appendix B.1
742fa56ea6SMatthias Ringwald const uint8_t hid_descriptor_keyboard_boot_mode[] = {
752fa56ea6SMatthias Ringwald 
762fa56ea6SMatthias Ringwald     0x05, 0x01,                    // Usage Page (Generic Desktop)
772fa56ea6SMatthias Ringwald     0x09, 0x06,                    // Usage (Keyboard)
782fa56ea6SMatthias Ringwald     0xa1, 0x01,                    // Collection (Application)
792fa56ea6SMatthias Ringwald 
802fa56ea6SMatthias Ringwald     // Modifier byte
812fa56ea6SMatthias Ringwald 
822fa56ea6SMatthias Ringwald     0x75, 0x01,                    //   Report Size (1)
832fa56ea6SMatthias Ringwald     0x95, 0x08,                    //   Report Count (8)
842fa56ea6SMatthias Ringwald     0x05, 0x07,                    //   Usage Page (Key codes)
852fa56ea6SMatthias Ringwald     0x19, 0xe0,                    //   Usage Minimum (Keyboard LeftControl)
862fa56ea6SMatthias Ringwald     0x29, 0xe7,                    //   Usage Maxium (Keyboard Right GUI)
872fa56ea6SMatthias Ringwald     0x15, 0x00,                    //   Logical Minimum (0)
882fa56ea6SMatthias Ringwald     0x25, 0x01,                    //   Logical Maximum (1)
892fa56ea6SMatthias Ringwald     0x81, 0x02,                    //   Input (Data, Variable, Absolute)
902fa56ea6SMatthias Ringwald 
912fa56ea6SMatthias Ringwald     // Reserved byte
922fa56ea6SMatthias Ringwald 
932fa56ea6SMatthias Ringwald     0x75, 0x01,                    //   Report Size (1)
942fa56ea6SMatthias Ringwald     0x95, 0x08,                    //   Report Count (8)
952fa56ea6SMatthias Ringwald     0x81, 0x03,                    //   Input (Constant, Variable, Absolute)
962fa56ea6SMatthias Ringwald 
974cf72855SMatthias Ringwald     // LED report + padding
982fa56ea6SMatthias Ringwald 
992fa56ea6SMatthias Ringwald     0x95, 0x05,                    //   Report Count (5)
1002fa56ea6SMatthias Ringwald     0x75, 0x01,                    //   Report Size (1)
1012fa56ea6SMatthias Ringwald     0x05, 0x08,                    //   Usage Page (LEDs)
1022fa56ea6SMatthias Ringwald     0x19, 0x01,                    //   Usage Minimum (Num Lock)
1032fa56ea6SMatthias Ringwald     0x29, 0x05,                    //   Usage Maxium (Kana)
1042fa56ea6SMatthias Ringwald     0x91, 0x02,                    //   Output (Data, Variable, Absolute)
1052fa56ea6SMatthias Ringwald 
1062fa56ea6SMatthias Ringwald     0x95, 0x01,                    //   Report Count (1)
1072fa56ea6SMatthias Ringwald     0x75, 0x03,                    //   Report Size (3)
1082fa56ea6SMatthias Ringwald     0x91, 0x03,                    //   Output (Constant, Variable, Absolute)
1092fa56ea6SMatthias Ringwald 
1102fa56ea6SMatthias Ringwald     // Keycodes
1112fa56ea6SMatthias Ringwald 
1122fa56ea6SMatthias Ringwald     0x95, 0x06,                    //   Report Count (6)
1132fa56ea6SMatthias Ringwald     0x75, 0x08,                    //   Report Size (8)
1142fa56ea6SMatthias Ringwald     0x15, 0x00,                    //   Logical Minimum (0)
1152fa56ea6SMatthias Ringwald     0x25, 0xff,                    //   Logical Maximum (1)
1162fa56ea6SMatthias Ringwald     0x05, 0x07,                    //   Usage Page (Key codes)
1172fa56ea6SMatthias Ringwald     0x19, 0x00,                    //   Usage Minimum (Reserved (no event indicated))
1182fa56ea6SMatthias Ringwald     0x29, 0xff,                    //   Usage Maxium (Reserved)
1192fa56ea6SMatthias Ringwald     0x81, 0x00,                    //   Input (Data, Array)
1202fa56ea6SMatthias Ringwald 
1212fa56ea6SMatthias Ringwald     0xc0,                          // End collection
1222fa56ea6SMatthias Ringwald };
1232fa56ea6SMatthias Ringwald 
124ca44a803SMatthias Ringwald //
125ca44a803SMatthias Ringwald 
126ca44a803SMatthias Ringwald #define CHAR_ILLEGAL     0xff
127ca44a803SMatthias Ringwald #define CHAR_RETURN     '\n'
128ca44a803SMatthias Ringwald #define CHAR_ESCAPE      27
129ca44a803SMatthias Ringwald #define CHAR_TAB         '\t'
130ca44a803SMatthias Ringwald #define CHAR_BACKSPACE   0x7f
131ca44a803SMatthias Ringwald 
132ca44a803SMatthias Ringwald // Simplified US Keyboard with Shift modifier
133ca44a803SMatthias Ringwald 
134ca44a803SMatthias Ringwald /**
135ca44a803SMatthias Ringwald  * English (US)
136ca44a803SMatthias Ringwald  */
137ca44a803SMatthias Ringwald static const uint8_t keytable_us_none [] = {
138ca44a803SMatthias Ringwald     CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL,             /*   0-3 */
139ca44a803SMatthias Ringwald     'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j',                   /*  4-13 */
140ca44a803SMatthias Ringwald     'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't',                   /* 14-23 */
141ca44a803SMatthias Ringwald     'u', 'v', 'w', 'x', 'y', 'z',                                       /* 24-29 */
142ca44a803SMatthias Ringwald     '1', '2', '3', '4', '5', '6', '7', '8', '9', '0',                   /* 30-39 */
143ca44a803SMatthias Ringwald     CHAR_RETURN, CHAR_ESCAPE, CHAR_BACKSPACE, CHAR_TAB, ' ',            /* 40-44 */
144ca44a803SMatthias Ringwald     '-', '=', '[', ']', '\\', CHAR_ILLEGAL, ';', '\'', 0x60, ',',       /* 45-54 */
145ca44a803SMatthias Ringwald     '.', '/', CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL,   /* 55-60 */
146ca44a803SMatthias Ringwald     CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL,             /* 61-64 */
147ca44a803SMatthias Ringwald     CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL,             /* 65-68 */
148ca44a803SMatthias Ringwald     CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL,             /* 69-72 */
149ca44a803SMatthias Ringwald     CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL,             /* 73-76 */
150ca44a803SMatthias Ringwald     CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL,             /* 77-80 */
151ca44a803SMatthias Ringwald     CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL,             /* 81-84 */
152ca44a803SMatthias Ringwald     '*', '-', '+', '\n', '1', '2', '3', '4', '5',                       /* 85-97 */
153ca44a803SMatthias Ringwald     '6', '7', '8', '9', '0', '.', 0xa7,                                 /* 97-100 */
154ca44a803SMatthias Ringwald };
155ca44a803SMatthias Ringwald 
156ca44a803SMatthias Ringwald static const uint8_t keytable_us_shift[] = {
157ca44a803SMatthias Ringwald     CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL,             /*  0-3  */
158ca44a803SMatthias Ringwald     'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J',                   /*  4-13 */
159ca44a803SMatthias Ringwald     'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T',                   /* 14-23 */
160ca44a803SMatthias Ringwald     'U', 'V', 'W', 'X', 'Y', 'Z',                                       /* 24-29 */
161ca44a803SMatthias Ringwald     '!', '@', '#', '$', '%', '^', '&', '*', '(', ')',                   /* 30-39 */
162ca44a803SMatthias Ringwald     CHAR_RETURN, CHAR_ESCAPE, CHAR_BACKSPACE, CHAR_TAB, ' ',            /* 40-44 */
163ca44a803SMatthias Ringwald     '_', '+', '{', '}', '|', CHAR_ILLEGAL, ':', '"', 0x7E, '<',         /* 45-54 */
164ca44a803SMatthias Ringwald     '>', '?', CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL,   /* 55-60 */
165ca44a803SMatthias Ringwald     CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL,             /* 61-64 */
166ca44a803SMatthias Ringwald     CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL,             /* 65-68 */
167ca44a803SMatthias Ringwald     CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL,             /* 69-72 */
168ca44a803SMatthias Ringwald     CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL,             /* 73-76 */
169ca44a803SMatthias Ringwald     CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL,             /* 77-80 */
170ca44a803SMatthias Ringwald     CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL,             /* 81-84 */
171ca44a803SMatthias Ringwald     '*', '-', '+', '\n', '1', '2', '3', '4', '5',                       /* 85-97 */
172ca44a803SMatthias Ringwald     '6', '7', '8', '9', '0', '.', 0xb1,                                 /* 97-100 */
173ca44a803SMatthias Ringwald };
174ca44a803SMatthias Ringwald 
175ca44a803SMatthias Ringwald 
1762fa56ea6SMatthias Ringwald void hid_create_sdp_record(
1772fa56ea6SMatthias Ringwald     uint8_t *service,
1782fa56ea6SMatthias Ringwald     uint32_t service_record_handle,
1792fa56ea6SMatthias Ringwald     uint16_t hid_device_subclass,
1802fa56ea6SMatthias Ringwald     uint8_t  hid_country_code,
1812fa56ea6SMatthias Ringwald     uint8_t  hid_virtual_cable,
1822fa56ea6SMatthias Ringwald     uint8_t  hid_reconnect_initiate,
1832fa56ea6SMatthias Ringwald     uint8_t  hid_boot_device,
1842fa56ea6SMatthias Ringwald     const uint8_t * hid_descriptor, uint16_t hid_descriptor_size,
1852fa56ea6SMatthias Ringwald     const char *device_name);
1860316aa6fSMatthias Ringwald 
1872fa56ea6SMatthias Ringwald void hid_create_sdp_record(
1882fa56ea6SMatthias Ringwald     uint8_t *service,
1892fa56ea6SMatthias Ringwald     uint32_t service_record_handle,
1902fa56ea6SMatthias Ringwald     uint16_t hid_device_subclass,
1912fa56ea6SMatthias Ringwald     uint8_t  hid_country_code,
1922fa56ea6SMatthias Ringwald     uint8_t  hid_virtual_cable,
1932fa56ea6SMatthias Ringwald     uint8_t  hid_reconnect_initiate,
1942fa56ea6SMatthias Ringwald     uint8_t  hid_boot_device,
1952fa56ea6SMatthias Ringwald     const uint8_t * hid_descriptor, uint16_t hid_descriptor_size,
1962fa56ea6SMatthias Ringwald     const char *device_name){
1972fa56ea6SMatthias Ringwald 
1982fa56ea6SMatthias Ringwald     uint8_t * attribute;
1992fa56ea6SMatthias Ringwald     de_create_sequence(service);
2002fa56ea6SMatthias Ringwald 
2012fa56ea6SMatthias Ringwald     de_add_number(service, DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_SERVICE_RECORD_HANDLE);
2022fa56ea6SMatthias Ringwald     de_add_number(service, DE_UINT, DE_SIZE_32, service_record_handle);
2032fa56ea6SMatthias Ringwald 
2042fa56ea6SMatthias Ringwald     de_add_number(service, DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_SERVICE_CLASS_ID_LIST);
2052fa56ea6SMatthias Ringwald     attribute = de_push_sequence(service);
2062fa56ea6SMatthias Ringwald     {
2072fa56ea6SMatthias Ringwald         de_add_number(attribute,  DE_UUID, DE_SIZE_16, BLUETOOTH_SERVICE_CLASS_HUMAN_INTERFACE_DEVICE_SERVICE);
2082fa56ea6SMatthias Ringwald     }
2092fa56ea6SMatthias Ringwald     de_pop_sequence(service, attribute);
2102fa56ea6SMatthias Ringwald 
2112fa56ea6SMatthias Ringwald     de_add_number(service,  DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_PROTOCOL_DESCRIPTOR_LIST);
2122fa56ea6SMatthias Ringwald     attribute = de_push_sequence(service);
2132fa56ea6SMatthias Ringwald     {
2142fa56ea6SMatthias Ringwald         uint8_t * l2cpProtocol = de_push_sequence(attribute);
2152fa56ea6SMatthias Ringwald         {
2162fa56ea6SMatthias Ringwald             de_add_number(l2cpProtocol,  DE_UUID, DE_SIZE_16, BLUETOOTH_PROTOCOL_L2CAP);
2172fa56ea6SMatthias Ringwald             de_add_number(l2cpProtocol,  DE_UINT, DE_SIZE_16, PSM_HID_CONTROL);
2182fa56ea6SMatthias Ringwald         }
2192fa56ea6SMatthias Ringwald         de_pop_sequence(attribute, l2cpProtocol);
2202fa56ea6SMatthias Ringwald 
2212fa56ea6SMatthias Ringwald         uint8_t * hidProtocol = de_push_sequence(attribute);
2222fa56ea6SMatthias Ringwald         {
2232fa56ea6SMatthias Ringwald             de_add_number(hidProtocol,  DE_UUID, DE_SIZE_16, BLUETOOTH_PROTOCOL_HIDP);
2242fa56ea6SMatthias Ringwald         }
2252fa56ea6SMatthias Ringwald         de_pop_sequence(attribute, hidProtocol);
2262fa56ea6SMatthias Ringwald     }
2272fa56ea6SMatthias Ringwald     de_pop_sequence(service, attribute);
2282fa56ea6SMatthias Ringwald 
2292fa56ea6SMatthias Ringwald     // TODO?
2302fa56ea6SMatthias Ringwald     de_add_number(service,  DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_LANGUAGE_BASE_ATTRIBUTE_ID_LIST);
2312fa56ea6SMatthias Ringwald     attribute = de_push_sequence(service);
2322fa56ea6SMatthias Ringwald     {
2332fa56ea6SMatthias Ringwald         de_add_number(attribute, DE_UINT, DE_SIZE_16, 0x656e);
2342fa56ea6SMatthias Ringwald         de_add_number(attribute, DE_UINT, DE_SIZE_16, 0x006a);
2352fa56ea6SMatthias Ringwald         de_add_number(attribute, DE_UINT, DE_SIZE_16, 0x0100);
2362fa56ea6SMatthias Ringwald     }
2372fa56ea6SMatthias Ringwald     de_pop_sequence(service, attribute);
2382fa56ea6SMatthias Ringwald 
2392fa56ea6SMatthias Ringwald     de_add_number(service,  DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_ADDITIONAL_PROTOCOL_DESCRIPTOR_LISTS);
2402fa56ea6SMatthias Ringwald     attribute = de_push_sequence(service);
2412fa56ea6SMatthias Ringwald     {
2422fa56ea6SMatthias Ringwald         uint8_t * additionalDescriptorAttribute = de_push_sequence(attribute);
2432fa56ea6SMatthias Ringwald         {
2442fa56ea6SMatthias Ringwald             uint8_t * l2cpProtocol = de_push_sequence(additionalDescriptorAttribute);
2452fa56ea6SMatthias Ringwald             {
2462fa56ea6SMatthias Ringwald                 de_add_number(l2cpProtocol,  DE_UUID, DE_SIZE_16, BLUETOOTH_PROTOCOL_L2CAP);
2472fa56ea6SMatthias Ringwald                 de_add_number(l2cpProtocol,  DE_UINT, DE_SIZE_16, PSM_HID_INTERRUPT);
2482fa56ea6SMatthias Ringwald             }
2492fa56ea6SMatthias Ringwald             de_pop_sequence(additionalDescriptorAttribute, l2cpProtocol);
2502fa56ea6SMatthias Ringwald 
2512fa56ea6SMatthias Ringwald             uint8_t * hidProtocol = de_push_sequence(attribute);
2522fa56ea6SMatthias Ringwald             {
2532fa56ea6SMatthias Ringwald                 de_add_number(hidProtocol,  DE_UUID, DE_SIZE_16, BLUETOOTH_PROTOCOL_HIDP);
2542fa56ea6SMatthias Ringwald             }
2552fa56ea6SMatthias Ringwald             de_pop_sequence(attribute, hidProtocol);
2562fa56ea6SMatthias Ringwald         }
2572fa56ea6SMatthias Ringwald         de_pop_sequence(attribute, additionalDescriptorAttribute);
2582fa56ea6SMatthias Ringwald     }
2592fa56ea6SMatthias Ringwald     de_pop_sequence(service, attribute);
2602fa56ea6SMatthias Ringwald 
2612fa56ea6SMatthias Ringwald     // 0x0100 "ServiceName"
2622fa56ea6SMatthias Ringwald     de_add_number(service,  DE_UINT, DE_SIZE_16, 0x0100);
2632fa56ea6SMatthias Ringwald     de_add_data(service,  DE_STRING, strlen(device_name), (uint8_t *) device_name);
2642fa56ea6SMatthias Ringwald 
2652fa56ea6SMatthias Ringwald     de_add_number(service,  DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_BLUETOOTH_PROFILE_DESCRIPTOR_LIST);
2662fa56ea6SMatthias Ringwald     attribute = de_push_sequence(service);
2672fa56ea6SMatthias Ringwald     {
2682fa56ea6SMatthias Ringwald         uint8_t * hidProfile = de_push_sequence(attribute);
2692fa56ea6SMatthias Ringwald         {
2702fa56ea6SMatthias Ringwald             de_add_number(hidProfile,  DE_UUID, DE_SIZE_16, BLUETOOTH_SERVICE_CLASS_HUMAN_INTERFACE_DEVICE_SERVICE);
2712fa56ea6SMatthias Ringwald             de_add_number(hidProfile,  DE_UINT, DE_SIZE_16, 0x0101);    // Version 1.1
2722fa56ea6SMatthias Ringwald         }
2732fa56ea6SMatthias Ringwald         de_pop_sequence(attribute, hidProfile);
2742fa56ea6SMatthias Ringwald     }
2752fa56ea6SMatthias Ringwald     de_pop_sequence(service, attribute);
2762fa56ea6SMatthias Ringwald 
2772fa56ea6SMatthias Ringwald     // Deprecated in v1.1.1
2782fa56ea6SMatthias Ringwald     // de_add_number(service,  DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_HID_DEVICE_RELEASE_NUMBER);
2792fa56ea6SMatthias Ringwald     // de_add_number(service,  DE_UINT, DE_SIZE_16, 0x0101);
2802fa56ea6SMatthias Ringwald 
2812fa56ea6SMatthias Ringwald     de_add_number(service,  DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_HID_PARSER_VERSION);
2822fa56ea6SMatthias Ringwald     de_add_number(service,  DE_UINT, DE_SIZE_16, 0x0111);  // v1.1.1
2832fa56ea6SMatthias Ringwald 
2842fa56ea6SMatthias Ringwald     de_add_number(service,  DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_HID_DEVICE_SUBCLASS);
2852fa56ea6SMatthias Ringwald     de_add_number(service,  DE_UINT, DE_SIZE_16, hid_device_subclass);
2862fa56ea6SMatthias Ringwald 
2872fa56ea6SMatthias Ringwald     de_add_number(service,  DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_HID_COUNTRY_CODE);
2882fa56ea6SMatthias Ringwald     de_add_number(service,  DE_UINT, DE_SIZE_16, hid_country_code);
2892fa56ea6SMatthias Ringwald 
2902fa56ea6SMatthias Ringwald     de_add_number(service,  DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_HID_VIRTUAL_CABLE);
2912fa56ea6SMatthias Ringwald     de_add_number(service,  DE_BOOL, DE_SIZE_8,  hid_virtual_cable);
2922fa56ea6SMatthias Ringwald 
2932fa56ea6SMatthias Ringwald     de_add_number(service,  DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_HID_RECONNECT_INITIATE);
2942fa56ea6SMatthias Ringwald     de_add_number(service,  DE_BOOL, DE_SIZE_8,  hid_reconnect_initiate);
2952fa56ea6SMatthias Ringwald 
2962fa56ea6SMatthias Ringwald     de_add_number(service,  DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_HID_DESCRIPTOR_LIST);
2972fa56ea6SMatthias Ringwald     attribute = de_push_sequence(service);
2982fa56ea6SMatthias Ringwald     {
2992fa56ea6SMatthias Ringwald         uint8_t* hidDescriptor = de_push_sequence(attribute);
3002fa56ea6SMatthias Ringwald         {
3012fa56ea6SMatthias Ringwald             de_add_number(hidDescriptor,  DE_UINT, DE_SIZE_8, 0x22);    // Report Descriptor
3022fa56ea6SMatthias Ringwald             de_add_data(hidDescriptor,  DE_STRING, hid_descriptor_size, (uint8_t *) hid_descriptor);
3032fa56ea6SMatthias Ringwald         }
3042fa56ea6SMatthias Ringwald         de_pop_sequence(attribute, hidDescriptor);
3052fa56ea6SMatthias Ringwald     }
3062fa56ea6SMatthias Ringwald     de_pop_sequence(service, attribute);
3072fa56ea6SMatthias Ringwald 
3082fa56ea6SMatthias Ringwald     de_add_number(service,  DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_HID_BOOT_DEVICE);
3092fa56ea6SMatthias Ringwald     de_add_number(service,  DE_BOOL, DE_SIZE_8,  hid_boot_device);
3102fa56ea6SMatthias Ringwald }
3112fa56ea6SMatthias Ringwald 
312ca44a803SMatthias Ringwald // HID Keyboard lookup
313ca44a803SMatthias Ringwald static int lookup_keycode(uint8_t character, const uint8_t * table, int size, uint8_t * keycode){
314ca44a803SMatthias Ringwald     int i;
315ca44a803SMatthias Ringwald     for (i=0;i<size;i++){
316ca44a803SMatthias Ringwald         if (table[i] != character) continue;
317ca44a803SMatthias Ringwald         *keycode = i;
318ca44a803SMatthias Ringwald         return 1;
319ca44a803SMatthias Ringwald     }
320ca44a803SMatthias Ringwald     return 0;
321ca44a803SMatthias Ringwald }
322ca44a803SMatthias Ringwald 
323ca44a803SMatthias Ringwald static int keycode_and_modifer_us_for_character(uint8_t character, uint8_t * keycode, uint8_t * modifier){
324ca44a803SMatthias Ringwald     int found;
325ca44a803SMatthias Ringwald     found = lookup_keycode(character, keytable_us_none, sizeof(keytable_us_none), keycode);
326ca44a803SMatthias Ringwald     if (found) {
327ca44a803SMatthias Ringwald         *modifier = 0;  // none
328ca44a803SMatthias Ringwald         return 1;
329ca44a803SMatthias Ringwald     }
330ca44a803SMatthias Ringwald     found = lookup_keycode(character, keytable_us_shift, sizeof(keytable_us_shift), keycode);
331ca44a803SMatthias Ringwald     if (found) {
332ca44a803SMatthias Ringwald         *modifier = 2;  // shift
333ca44a803SMatthias Ringwald         return 1;
334ca44a803SMatthias Ringwald     }
335ca44a803SMatthias Ringwald     return 0;
336ca44a803SMatthias Ringwald }
337ca44a803SMatthias Ringwald 
338ca44a803SMatthias Ringwald // HID Report sending
3394cf72855SMatthias Ringwald static int send_keycode;
3404cf72855SMatthias Ringwald static int send_modifier;
3414cf72855SMatthias Ringwald 
3424cf72855SMatthias Ringwald static void send_key(int modifier, int keycode){
3434cf72855SMatthias Ringwald     send_keycode = keycode;
3444cf72855SMatthias Ringwald     send_modifier = modifier;
3454cf72855SMatthias Ringwald     l2cap_request_can_send_now_event(hid_interrupt_cid);
3464cf72855SMatthias Ringwald }
3474cf72855SMatthias Ringwald 
3484cf72855SMatthias Ringwald static void send_report(int modifier, int keycode){
3494cf72855SMatthias Ringwald     uint8_t report[] = { 0xa1, modifier, 0, 0, keycode, 0, 0, 0, 0, 0};
3504cf72855SMatthias Ringwald     l2cap_send(hid_interrupt_cid, &report[0], sizeof(report));
3514cf72855SMatthias Ringwald }
3524cf72855SMatthias Ringwald 
353*6518788aSMatthias Ringwald static int hid_connected(void){
354*6518788aSMatthias Ringwald     return hid_control_cid && hid_interrupt_cid;
355*6518788aSMatthias Ringwald }
356ca44a803SMatthias Ringwald 
3572fa56ea6SMatthias Ringwald #ifdef HAVE_POSIX_STDIN
3582fa56ea6SMatthias Ringwald 
3592fa56ea6SMatthias Ringwald // prototypes
3602fa56ea6SMatthias Ringwald static void show_usage(void);
3612fa56ea6SMatthias Ringwald 
3622fa56ea6SMatthias Ringwald // Testig User Interface
3632fa56ea6SMatthias Ringwald static void show_usage(void){
3642fa56ea6SMatthias Ringwald     bd_addr_t iut_address;
3652fa56ea6SMatthias Ringwald     gap_local_bd_addr(iut_address);
3662fa56ea6SMatthias Ringwald 
3672fa56ea6SMatthias Ringwald     printf("\n--- Bluetooth HID Device Test Console %s ---\n", bd_addr_to_str(iut_address));
3682fa56ea6SMatthias Ringwald     printf("\n");
3692fa56ea6SMatthias Ringwald     printf("---\n");
3702fa56ea6SMatthias Ringwald     printf("Ctrl-c - exit\n");
3712fa56ea6SMatthias Ringwald     printf("---\n");
3722fa56ea6SMatthias Ringwald }
3732fa56ea6SMatthias Ringwald 
3742fa56ea6SMatthias Ringwald static void stdin_process(btstack_data_source_t *ds, btstack_data_source_callback_type_t callback_type){
3752fa56ea6SMatthias Ringwald     UNUSED(ds);
3762fa56ea6SMatthias Ringwald     UNUSED(callback_type);
3772fa56ea6SMatthias Ringwald 
378ca44a803SMatthias Ringwald     char character = btstack_stdin_read();
3794cf72855SMatthias Ringwald 
380ca44a803SMatthias Ringwald     uint8_t modifier;
381ca44a803SMatthias Ringwald     uint8_t keycode;
382ca44a803SMatthias Ringwald     int found = keycode_and_modifer_us_for_character(character, &keycode, &modifier);
383ca44a803SMatthias Ringwald     if (found){
384ca44a803SMatthias Ringwald         send_key(modifier, keycode);
3854cf72855SMatthias Ringwald         return;
3862fa56ea6SMatthias Ringwald     }
3874cf72855SMatthias Ringwald     show_usage();
3882fa56ea6SMatthias Ringwald }
389*6518788aSMatthias Ringwald #else
3902fa56ea6SMatthias Ringwald 
391*6518788aSMatthias Ringwald // On embedded systems, send constant demo text with fixed period
392*6518788aSMatthias Ringwald 
393*6518788aSMatthias Ringwald #define TYPING_PERIOD_MS 100
394*6518788aSMatthias Ringwald static const char * demo_text = "\n\nHello World!\n\nThis is the BTstack HID Keyboard Demo running on an Embedded Device.\n\n";
395*6518788aSMatthias Ringwald 
396*6518788aSMatthias Ringwald static int demo_pos;
397*6518788aSMatthias Ringwald static btstack_timer_source_t typing_timer;
398*6518788aSMatthias Ringwald 
399*6518788aSMatthias Ringwald static void typing_timer_handler(btstack_timer_source_t * ts){
400*6518788aSMatthias Ringwald 
401*6518788aSMatthias Ringwald     // abort if not connected
402*6518788aSMatthias Ringwald     if (!hid_connected()) return;
403*6518788aSMatthias Ringwald 
404*6518788aSMatthias Ringwald     // get next character
405*6518788aSMatthias Ringwald     uint8_t character = demo_text[demo_pos++];
406*6518788aSMatthias Ringwald     if (demo_text[demo_pos] == 0){
407*6518788aSMatthias Ringwald         demo_pos = 0;
4080316aa6fSMatthias Ringwald     }
4090316aa6fSMatthias Ringwald 
410*6518788aSMatthias Ringwald     // get keycodeand send
411*6518788aSMatthias Ringwald     uint8_t modifier;
412*6518788aSMatthias Ringwald     uint8_t keycode;
413*6518788aSMatthias Ringwald     int found = keycode_and_modifer_us_for_character(character, &keycode, &modifier);
414*6518788aSMatthias Ringwald     if (found){
415*6518788aSMatthias Ringwald         send_key(modifier, keycode);
416*6518788aSMatthias Ringwald     }
417*6518788aSMatthias Ringwald 
418*6518788aSMatthias Ringwald     // set next timer
419*6518788aSMatthias Ringwald     btstack_run_loop_set_timer(ts, TYPING_PERIOD_MS);
420*6518788aSMatthias Ringwald     btstack_run_loop_add_timer(ts);
421*6518788aSMatthias Ringwald }
422*6518788aSMatthias Ringwald 
423*6518788aSMatthias Ringwald static void hid_start_typing(void){
424*6518788aSMatthias Ringwald     demo_pos = 0;
425*6518788aSMatthias Ringwald     // set one-shot timer
426*6518788aSMatthias Ringwald     typing_timer.process = &typing_timer_handler;
427*6518788aSMatthias Ringwald     btstack_run_loop_set_timer(&typing_timer, TYPING_PERIOD_MS);
428*6518788aSMatthias Ringwald     btstack_run_loop_add_timer(&typing_timer);
429*6518788aSMatthias Ringwald }
430*6518788aSMatthias Ringwald 
431*6518788aSMatthias Ringwald #endif
432*6518788aSMatthias Ringwald 
4330316aa6fSMatthias Ringwald static void packet_handler(uint8_t packet_type, uint16_t channel, uint8_t * packet, uint16_t packet_size){
4342fa56ea6SMatthias Ringwald     UNUSED(channel);
4350316aa6fSMatthias Ringwald     UNUSED(packet_size);
4360316aa6fSMatthias Ringwald     int connected_before;
4372fa56ea6SMatthias Ringwald     switch (packet_type){
4382fa56ea6SMatthias Ringwald         case HCI_EVENT_PACKET:
4390316aa6fSMatthias Ringwald             switch (packet[0]){
4400316aa6fSMatthias Ringwald                 case HCI_EVENT_USER_CONFIRMATION_REQUEST:
4410316aa6fSMatthias Ringwald                     // ssp: inform about user confirmation request
4420316aa6fSMatthias Ringwald                     log_info("SSP User Confirmation Request with numeric value '%06"PRIu32"'\n", hci_event_user_confirmation_request_get_numeric_value(packet));
4430316aa6fSMatthias Ringwald                     log_info("SSP User Confirmation Auto accept\n");
4440316aa6fSMatthias Ringwald                     break;
4450316aa6fSMatthias Ringwald 
4460316aa6fSMatthias Ringwald                 // into HID Device/Server
4470316aa6fSMatthias Ringwald                 case L2CAP_EVENT_INCOMING_CONNECTION:
4480316aa6fSMatthias Ringwald                     switch (l2cap_event_incoming_connection_get_psm(packet)){
4490316aa6fSMatthias Ringwald                         case PSM_HID_CONTROL:
4500316aa6fSMatthias Ringwald                         case PSM_HID_INTERRUPT:
4510316aa6fSMatthias Ringwald                             l2cap_accept_connection(channel);
4520316aa6fSMatthias Ringwald                             break;
4530316aa6fSMatthias Ringwald                         default:
4540316aa6fSMatthias Ringwald                             l2cap_decline_connection(channel);
4550316aa6fSMatthias Ringwald                             break;
4560316aa6fSMatthias Ringwald                     }
4570316aa6fSMatthias Ringwald                     break;
4580316aa6fSMatthias Ringwald                 case L2CAP_EVENT_CHANNEL_OPENED:
4590316aa6fSMatthias Ringwald                     if (packet[2]) return;
4600316aa6fSMatthias Ringwald                     connected_before = hid_connected();
4610316aa6fSMatthias Ringwald                     switch (l2cap_event_channel_opened_get_psm(packet)){
4620316aa6fSMatthias Ringwald                         case PSM_HID_CONTROL:
4630316aa6fSMatthias Ringwald                             hid_control_cid = l2cap_event_channel_opened_get_local_cid(packet);
4640316aa6fSMatthias Ringwald                             log_info("HID Control opened, cid 0x%02x", hid_control_cid);
4650316aa6fSMatthias Ringwald                             break;
4660316aa6fSMatthias Ringwald                         case PSM_HID_INTERRUPT:
4670316aa6fSMatthias Ringwald                             hid_interrupt_cid = l2cap_event_channel_opened_get_local_cid(packet);
4680316aa6fSMatthias Ringwald                             log_info("HID Interrupt opened, cid 0x%02x", hid_interrupt_cid);
4690316aa6fSMatthias Ringwald                             break;
4700316aa6fSMatthias Ringwald                         default:
4710316aa6fSMatthias Ringwald                             break;
4720316aa6fSMatthias Ringwald                     }
4730316aa6fSMatthias Ringwald                     if (!connected_before && hid_connected()){
4740316aa6fSMatthias Ringwald                         printf("HID Connected\n");
475*6518788aSMatthias Ringwald #ifndef HAVE_POSIX_STDIN
476*6518788aSMatthias Ringwald                         hid_start_typing();
477*6518788aSMatthias Ringwald #endif
4780316aa6fSMatthias Ringwald                     }
4790316aa6fSMatthias Ringwald                     break;
4800316aa6fSMatthias Ringwald                 case L2CAP_EVENT_CHANNEL_CLOSED:
4810316aa6fSMatthias Ringwald                     connected_before = hid_connected();
4820316aa6fSMatthias Ringwald                     if (l2cap_event_channel_closed_get_local_cid(packet) == hid_control_cid){
4830316aa6fSMatthias Ringwald                         log_info("HID Control closed");
4840316aa6fSMatthias Ringwald                         hid_control_cid = 0;
4850316aa6fSMatthias Ringwald                     }
4860316aa6fSMatthias Ringwald                     if (l2cap_event_channel_closed_get_local_cid(packet) == hid_interrupt_cid){
4870316aa6fSMatthias Ringwald                         log_info("HID Interrupt closed");
4880316aa6fSMatthias Ringwald                         hid_interrupt_cid = 0;
4890316aa6fSMatthias Ringwald                     }
4900316aa6fSMatthias Ringwald                     if (connected_before && !hid_connected()){
4910316aa6fSMatthias Ringwald                         printf("HID Disconnected\n");
4920316aa6fSMatthias Ringwald                     }
4930316aa6fSMatthias Ringwald                     break;
4944cf72855SMatthias Ringwald                 case L2CAP_EVENT_CAN_SEND_NOW:
4954cf72855SMatthias Ringwald                     if (send_keycode){
4964cf72855SMatthias Ringwald                         send_report(send_modifier, send_keycode);
4974cf72855SMatthias Ringwald                         send_keycode = 0;
4984cf72855SMatthias Ringwald                         send_modifier = 0;
4994cf72855SMatthias Ringwald                         l2cap_request_can_send_now_event(hid_interrupt_cid);
5004cf72855SMatthias Ringwald                     } else {
5014cf72855SMatthias Ringwald                         send_report(0, 0);
5024cf72855SMatthias Ringwald                     }
5032fa56ea6SMatthias Ringwald                 default:
5042fa56ea6SMatthias Ringwald                     break;
5052fa56ea6SMatthias Ringwald             }
5062fa56ea6SMatthias Ringwald             break;
5072fa56ea6SMatthias Ringwald         default:
5082fa56ea6SMatthias Ringwald             break;
5092fa56ea6SMatthias Ringwald     }
5102fa56ea6SMatthias Ringwald }
5112fa56ea6SMatthias Ringwald 
5122fa56ea6SMatthias Ringwald /* @section Main Application Setup
5132fa56ea6SMatthias Ringwald  *
5142fa56ea6SMatthias Ringwald  * @text Listing MainConfiguration shows main application code.
5152fa56ea6SMatthias Ringwald  * To run a HID Device service you need to initialize the SDP, and to create and register HID Device record with it.
5162fa56ea6SMatthias Ringwald  * At the end the Bluetooth stack is started.
5172fa56ea6SMatthias Ringwald  */
5182fa56ea6SMatthias Ringwald 
5192fa56ea6SMatthias Ringwald /* LISTING_START(MainConfiguration): Setup HID Device */
5202fa56ea6SMatthias Ringwald 
5212fa56ea6SMatthias Ringwald int btstack_main(int argc, const char * argv[]);
5222fa56ea6SMatthias Ringwald int btstack_main(int argc, const char * argv[]){
5232fa56ea6SMatthias Ringwald     (void)argc;
5242fa56ea6SMatthias Ringwald     (void)argv;
5252fa56ea6SMatthias Ringwald 
5262fa56ea6SMatthias Ringwald     // register for HCI events
5272fa56ea6SMatthias Ringwald     hci_event_callback_registration.callback = &packet_handler;
5282fa56ea6SMatthias Ringwald     hci_add_event_handler(&hci_event_callback_registration);
5292fa56ea6SMatthias Ringwald     hci_register_sco_packet_handler(&packet_handler);
5302fa56ea6SMatthias Ringwald 
5312fa56ea6SMatthias Ringwald     gap_discoverable_control(1);
5322fa56ea6SMatthias Ringwald     gap_set_class_of_device(0x2540);
5330316aa6fSMatthias Ringwald     gap_set_local_name(hid_device_name);
5342fa56ea6SMatthias Ringwald 
5352fa56ea6SMatthias Ringwald     // L2CAP
5362fa56ea6SMatthias Ringwald     l2cap_init();
5370316aa6fSMatthias Ringwald     l2cap_register_service(packet_handler, PSM_HID_INTERRUPT, 100, LEVEL_0);
5380316aa6fSMatthias Ringwald     l2cap_register_service(packet_handler, PSM_HID_CONTROL,   100, LEVEL_0);
5392fa56ea6SMatthias Ringwald 
5402fa56ea6SMatthias Ringwald     // SDP Server
5412fa56ea6SMatthias Ringwald     sdp_init();
5422fa56ea6SMatthias Ringwald     memset(hid_service_buffer, 0, sizeof(hid_service_buffer));
5432fa56ea6SMatthias Ringwald     // hid sevice subclass 2540 Keyboard, hid counntry code 33 US, hid virtual cable off, hid reconnect initiate off, hid boot device off
5442fa56ea6SMatthias Ringwald     hid_create_sdp_record(hid_service_buffer, 0x10001, 0x2540, 33, 0, 0, 0, hid_descriptor_keyboard_boot_mode, sizeof(hid_descriptor_keyboard_boot_mode), hid_device_name);
5452fa56ea6SMatthias Ringwald     printf("SDP service record size: %u\n", de_get_len( hid_service_buffer));
5462fa56ea6SMatthias Ringwald     sdp_register_service(hid_service_buffer);
5472fa56ea6SMatthias Ringwald 
5482fa56ea6SMatthias Ringwald #ifdef HAVE_POSIX_STDIN
5492fa56ea6SMatthias Ringwald     btstack_stdin_setup(stdin_process);
5502fa56ea6SMatthias Ringwald #endif
5512fa56ea6SMatthias Ringwald     // turn on!
5522fa56ea6SMatthias Ringwald     hci_power_control(HCI_POWER_ON);
5532fa56ea6SMatthias Ringwald     return 0;
5542fa56ea6SMatthias Ringwald }
5552fa56ea6SMatthias Ringwald /* LISTING_END */
5562fa56ea6SMatthias Ringwald /* EXAMPLE_END */
557