xref: /btstack/src/btstack_hid.h (revision fe796163cf1ecb6bfabb8bf4cb51a6e5baea3f93)

/*
 * Copyright (C) 2021 BlueKitchen GmbH
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the copyright holders nor the names of
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 * 4. Any redistribution, use, or modification is done solely for
 *    personal benefit and not for any commercial purpose or for
 *    monetary gain.
 *
 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
 * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * Please inquire about commercial licensing options at
 * [email protected]
 *
 */

/**
 * @title Human Interface Device (HID)
 *
 */

#ifndef HID_H
#define HID_H

#if defined __cplusplus
extern "C" {
#endif


#include <stdint.h>

#define HID_BOOT_MODE_KEYBOARD_ID 1
#define HID_BOOT_MODE_MOUSE_ID    2

// used to indicate that no 8-bit Report ID has been set / is used
#define HID_REPORT_ID_UNDEFINED 0xffff

typedef enum {
    HID_MESSAGE_TYPE_HANDSHAKE = 0,
    HID_MESSAGE_TYPE_HID_CONTROL,
    HID_MESSAGE_TYPE_RESERVED_2,
    HID_MESSAGE_TYPE_RESERVED_3,
    HID_MESSAGE_TYPE_GET_REPORT,
    HID_MESSAGE_TYPE_SET_REPORT,
    HID_MESSAGE_TYPE_GET_PROTOCOL,
    HID_MESSAGE_TYPE_SET_PROTOCOL,
    HID_MESSAGE_TYPE_GET_IDLE_DEPRECATED,
    HID_MESSAGE_TYPE_SET_IDLE_DEPRECATED,
    HID_MESSAGE_TYPE_DATA,
    HID_MESSAGE_TYPE_DATC_DEPRECATED
} hid_message_type_t;

typedef enum {
    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.
    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.
    HID_HANDSHAKE_PARAM_TYPE_ERR_INVALID_REPORT_ID,    // Invalid report ID transmitted.
    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.
    HID_HANDSHAKE_PARAM_TYPE_ERR_INVALID_PARAMETER,    // A parameter value is out of range or inappropriate for the request.
    HID_HANDSHAKE_PARAM_TYPE_ERR_UNKNOWN = 0x0E,       // Device could not identify the error condition.
    HID_HANDSHAKE_PARAM_TYPE_ERR_FATAL = 0x0F,         // Restart is essential to resume functionality
    // BTstack custom error codes
    HID_HANDSHAKE_PARAM_TYPE_ERR_DISCONNECT
} hid_handshake_param_type_t;

typedef enum {
    HID_CONTROL_PARAM_NOP_DEPRECATED = 0,              // Deprecated: No Operation.
    HID_CONTROL_PARAM_HARD_RESET_DEPRECATED,           // Deprecated: Device performs Power On System Test (POST) then initializes all internal variables and initiates normal operations.
    HID_CONTROL_PARAM_SOFT_RESET_DEPRECATED,           // Deprecated: Device initializes all internal variables and initiates normal operations.
    HID_CONTROL_PARAM_SUSPEND = 0x03,                  // Go to reduced power mode.
    HID_CONTROL_PARAM_EXIT_SUSPEND,                    // Exit reduced power mode.
    HID_CONTROL_PARAM_VIRTUAL_CABLE_UNPLUG
} hid_control_param_t;

typedef enum {
    HID_PROTOCOL_MODE_BOOT = 0,
    HID_PROTOCOL_MODE_REPORT,

    // the following item is only used for API calls in hid_host.h: hid_host_connect, hid_host_accept_connection
    // in contrast to previous two enum items that will enforce given mode, this one enables fallback from report to boot mode
    HID_PROTOCOL_MODE_REPORT_WITH_FALLBACK_TO_BOOT
} hid_protocol_mode_t;

typedef enum {
    HID_REPORT_TYPE_RESERVED = 0,
    HID_REPORT_TYPE_INPUT,
    HID_REPORT_TYPE_OUTPUT,
    HID_REPORT_TYPE_FEATURE
} hid_report_type_t;

typedef enum {
    HID_REPORT_ID_UNDECLARED,
    HID_REPORT_ID_VALID,
    HID_REPORT_ID_INVALID
} hid_report_id_status_t;

// HID Usage Pages
#define HID_USAGE_PAGE_DESKTOP                   0x01
#define HID_USAGE_PAGE_SIMULATE                  0x02
#define HID_USAGE_PAGE_VIRTUAL_REALITY           0x03
#define HID_USAGE_PAGE_SPORT                     0x04
#define HID_USAGE_PAGE_GAME                      0x05
#define HID_USAGE_PAGE_GENERIC_DEVICE            0x06
#define HID_USAGE_PAGE_KEYBOARD                  0x07
#define HID_USAGE_PAGE_LED                       0x08
#define HID_USAGE_PAGE_BUTTON                    0x09
#define HID_USAGE_PAGE_ORDINAL                   0x0a
#define HID_USAGE_PAGE_TELEPHONY                 0x0b
#define HID_USAGE_PAGE_CONSUMER                  0x0c
#define HID_USAGE_PAGE_DIGITIZER                 0x0d
#define HID_USAGE_PAGE_PID                       0x0f
#define HID_USAGE_PAGE_UNICODE                   0x10
#define HID_USAGE_PAGE_ALPHA_DISPLAY             0x14
#define HID_USAGE_PAGE_MEDICAL                   0x40
#define HID_USAGE_PAGE_LIGHTING_AND_ILLUMINATION 0x59
#define HID_USAGE_PAGE_MONITOR                   0x80    // 0x80 - 0x83
#define HID_USAGE_PAGE_POWER                     0x84    // 0x084 - 0x87
#define HID_USAGE_PAGE_BARCODE_SCANNER           0x8c
#define HID_USAGE_PAGE_SCALE                     0x8d
#define HID_USAGE_PAGE_MSR                       0x8e
#define HID_USAGE_PAGE_CAMERA                    0x90
#define HID_USAGE_PAGE_ARCADE                    0x91
#define HID_USAGE_PAGE_FIDO                      0xF1D0  // FIDO alliance
#define HID_USAGE_PAGE_VENDOR                    0xFF00  // 0xFF00 - 0xFFFF

// HID Usage Keyboard (partial) 0x0007
#define HID_USAGE_KEY_RESERVED                   0x00
#define HID_USAGE_KEY_KEYBOARD_CAPS_LOCK         0x39
#define HID_USAGE_KEY_KEYBOARD_SCROLL_LOCK       0x47
#define HID_USAGE_KEY_KEYPAD_NUM_LOCK_AND_CLEAR  0x53
#define HID_USAGE_KEY_KEYBOARD_LEFTCONTROL       0xE0
#define HID_USAGE_KEY_KEYBOARD_LEFTSHIFT         0xE1
#define HID_USAGE_KEY_KEYBOARD_LEFTALT           0xE2
#define HID_USAGE_KEY_KEYBOARD_LEFT_GUI          0xE3
#define HID_USAGE_KEY_KEYBOARD_RIGHTCONTROL      0xE4
#define HID_USAGE_KEY_KEYBOARD_RIGHTSHIFT        0xE5
#define HID_USAGE_KEY_KEYBOARD_RIGHTALT          0xE6
#define HID_USAGE_KEY_KEYBOARD_RIGHT_GUI         0xE7

// HID Usage LED (partial) 0x0008
#define HID_USAGE_LED_NUM_LOCK                   0x01
#define HID_USAGE_LED_CAPS_LOCK                  0x02
#define HID_USAGE_LED_SCROLL_LOCK                0x03
#define HID_USAGE_LED_COMPOSE                    0x04
#define HID_USAGE_LED_KANA                       0x05
#define HID_USAGE_LED_POWER                      0x06
#define HID_USAGE_LED_SHIFT                      0x07


/* API_START */

/*
 * @brief Get boot descriptor data
 * @result data
 */
const uint8_t * btstack_hid_get_boot_descriptor_data(void);

/*
 * @brief Get boot descriptor length
 * @result length
 */
uint16_t btstack_hid_get_boot_descriptor_len(void);

/* API_END */

#if defined __cplusplus
}
#endif

#endif