1 /* 2 * Copyright (C) 2021 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 /** 39 * @title Human Interface Device (HID) 40 * 41 */ 42 43 #ifndef HID_H 44 #define HID_H 45 46 #if defined __cplusplus 47 extern "C" { 48 #endif 49 50 51 #include <stdint.h> 52 53 #define HID_BOOT_MODE_KEYBOARD_ID 1 54 #define HID_BOOT_MODE_MOUSE_ID 2 55 56 typedef enum { 57 HID_MESSAGE_TYPE_HANDSHAKE = 0, 58 HID_MESSAGE_TYPE_HID_CONTROL, 59 HID_MESSAGE_TYPE_RESERVED_2, 60 HID_MESSAGE_TYPE_RESERVED_3, 61 HID_MESSAGE_TYPE_GET_REPORT, 62 HID_MESSAGE_TYPE_SET_REPORT, 63 HID_MESSAGE_TYPE_GET_PROTOCOL, 64 HID_MESSAGE_TYPE_SET_PROTOCOL, 65 HID_MESSAGE_TYPE_GET_IDLE_DEPRECATED, 66 HID_MESSAGE_TYPE_SET_IDLE_DEPRECATED, 67 HID_MESSAGE_TYPE_DATA, 68 HID_MESSAGE_TYPE_DATC_DEPRECATED 69 } hid_message_type_t; 70 71 typedef enum { 72 HID_HANDSHAKE_PARAM_TYPE_SUCCESSFUL = 0x00, // This code is used to acknowledge requests. A device that has correctly received SET_REPORT, SET_IDLE or SET_PROTOCOL payload transmits an acknowledgment to the host. 73 HID_HANDSHAKE_PARAM_TYPE_NOT_READY, // This code indicates that a device is too busy to accept data. The Bluetooth HID Host should retransmit the data the next time it communicates with the device. 74 HID_HANDSHAKE_PARAM_TYPE_ERR_INVALID_REPORT_ID, // Invalid report ID transmitted. 75 HID_HANDSHAKE_PARAM_TYPE_ERR_UNSUPPORTED_REQUEST, // The device does not support the request. This result code shall be used if the HIDP message type is unsupported. 76 HID_HANDSHAKE_PARAM_TYPE_ERR_INVALID_PARAMETER, // A parameter value is out of range or inappropriate for the request. 77 HID_HANDSHAKE_PARAM_TYPE_ERR_UNKNOWN = 0x0E, // Device could not identify the error condition. 78 HID_HANDSHAKE_PARAM_TYPE_ERR_FATAL = 0x0F, // Restart is essential to resume functionality 79 // BTstack custom error codes 80 HID_HANDSHAKE_PARAM_TYPE_ERR_DISCONNECT 81 } hid_handshake_param_type_t; 82 83 typedef enum { 84 HID_CONTROL_PARAM_NOP_DEPRECATED = 0, // Deprecated: No Operation. 85 HID_CONTROL_PARAM_HARD_RESET_DEPRECATED, // Deprecated: Device performs Power On System Test (POST) then initializes all internal variables and initiates normal operations. 86 HID_CONTROL_PARAM_SOFT_RESET_DEPRECATED, // Deprecated: Device initializes all internal variables and initiates normal operations. 87 HID_CONTROL_PARAM_SUSPEND = 0x03, // Go to reduced power mode. 88 HID_CONTROL_PARAM_EXIT_SUSPEND, // Exit reduced power mode. 89 HID_CONTROL_PARAM_VIRTUAL_CABLE_UNPLUG 90 } hid_control_param_t; 91 92 typedef enum { 93 HID_PROTOCOL_MODE_BOOT = 0, 94 HID_PROTOCOL_MODE_REPORT, 95 96 // the following item is only used for API calls in hid_host.h: hid_host_connect, hid_host_accept_connection 97 // in contrast to previous two enum items that will enforce given mode, this one enables fallback from report to boot mode 98 HID_PROTOCOL_MODE_REPORT_WITH_FALLBACK_TO_BOOT 99 } hid_protocol_mode_t; 100 101 typedef enum { 102 HID_REPORT_TYPE_RESERVED = 0, 103 HID_REPORT_TYPE_INPUT, 104 HID_REPORT_TYPE_OUTPUT, 105 HID_REPORT_TYPE_FEATURE 106 } hid_report_type_t; 107 108 typedef enum { 109 HID_REPORT_ID_UNDECLARED, 110 HID_REPORT_ID_VALID, 111 HID_REPORT_ID_INVALID 112 } hid_report_id_status_t; 113 114 /* API_START */ 115 116 /* 117 * @brief Get boot descriptor data 118 * @result data 119 */ 120 const uint8_t * btstack_hid_get_boot_descriptor_data(void); 121 122 /* 123 * @brief Get boot descriptor length 124 * @result length 125 */ 126 uint16_t btstack_hid_get_boot_descriptor_len(void); 127 128 /* API_END */ 129 130 #if defined __cplusplus 131 } 132 #endif 133 134 #endif 135