hid.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2021 Nils Ollrogge
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
 
#include "usb/hid/hid_usage.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define USB_TYPE_DESCRIPTOR_HID      0x21

#define USB_HID_VERSION_BCD          0x0110

#define USB_HID_SUBCLASS_NONE 0x0
#define USB_HID_SUBCLASS_BOOT 0x1

#define USB_HID_PROTOCOL_NONE       0x0
#define USB_HID_PROTOCOL_KEYBOARD   0x1
#define USB_HID_PROTOCOL_MOUSE      0x2

#define USB_HID_DESCR_HID       0x21
#define USB_HID_DESCR_REPORT    0x22
#define USB_HID_DESCR_PHYSICAL  0x23

#define USB_HID_COUNTRY_CODE_NOTSUPPORTED 0x00

#define USB_HID_REQUEST_GET_REPORT    0x01
#define USB_HID_REQUEST_GET_IDLE      0x02
#define USB_HID_REQUEST_GET_PROTOCOL  0x03
#define USB_HID_REQUEST_SET_REPORT    0x09
#define USB_HID_REQUEST_SET_IDLE      0x0a
#define USB_HID_REQUEST_SET_PROTOCOL  0x0b

#define USBUS_HID_EP_IN_REQUIRED_NUMOF   1

#define USBUS_HID_EP_OUT_REQUIRED_NUMOF  1

typedef struct __attribute__((packed)){
    uint8_t length;         
    uint8_t desc_type;      
 
    uint16_t bcd_hid;       
    uint8_t country_code;   
    uint8_t num_descrs;     
 
    uint8_t report_type;    
    uint16_t report_length; 
} usb_desc_hid_t;


#define USB_HID_ITEM_TYPE_MAIN      0x0

#define USB_HID_ITEM_TYPE_GLOBAL        0x1

#define USB_HID_ITEM_TYPE_LOCAL     0x2

#define USB_HID_ITEM_TAG_INPUT      0x8

#define USB_HID_ITEM_TAG_OUTPUT     0x9

#define USB_HID_ITEM_TAG_COLLECTION     0xA

#define USB_HID_ITEM_TAG_FEATURE        0xB

#define USB_HID_ITEM_TAG_COLLECTION_END 0xC

#define USB_HID_ITEM_TAG_USAGE_PAGE     0x0
#define USB_HID_ITEM_TAG_LOGICAL_MIN    0x1

#define USB_HID_ITEM_TAG_LOGICAL_MAX    0x2

#define USB_HID_ITEM_TAG_PHYSICAL_MIN   0x3

#define USB_HID_ITEM_TAG_PHYSICAL_MAX   0x4

#define USB_HID_ITEM_TAG_UNIT_EXPONENT  0x5

#define USB_HID_ITEM_TAG_UNIT       0x6

#define USB_HID_ITEM_TAG_REPORT_SIZE    0x7

#define USB_HID_ITEM_TAG_REPORT_ID      0x8

#define USB_HID_ITEM_TAG_REPORT_COUNT   0x9

#define USB_HID_ITEM_TAG_USAGE      0x0

#define USB_HID_ITEM_TAG_USAGE_MIN      0x1

#define USB_HID_ITEM_TAG_USAGE_MAX      0x2

#define USB_HID_COLLECTION_PHYSICAL     0x00

#define USB_HID_COLLECTION_APPLICATION  0x01

#define USB_HID_COLLECTION_LOGICAL      0x02

#define USB_HID_COLLECTION_REPORT       0x03

#define USB_HID_COLLECTION_NAMED_ARRAY  0x04

#define USB_HID_COLLECTION_USAGE_SWITCH 0x05

#define USB_HID_COLLECTION_USAGE_MOD    0x06

#define USB_HID_ITEM(tag, type, size) \
    (((tag & 0xF) << 4) | ((type & 0x3) << 2) | (size & 0x3))

#define USB_HID_INPUT(input)  \
    USB_HID_ITEM(USB_HID_ITEM_TAG_INPUT, USB_HID_ITEM_TYPE_MAIN, 1), \
    input

#define USB_HID_OUTPUT(output) \
    USB_HID_ITEM(USB_HID_ITEM_TAG_OUTPUT, USB_HID_ITEM_TYPE_MAIN, 1), \
    output

#define USB_HID_FEATURE(feature) \
    USB_HID_ITEM(USB_HID_ITEM_TAG_FEATURE, USB_HID_ITEM_TYPE_MAIN, 1), \
    feature

#define USB_HID_COLLECTION(collection) \
    USB_HID_ITEM(USB_HID_ITEM_TAG_COLLECTION, USB_HID_ITEM_TYPE_MAIN, 1), \
    collection

#define USB_HID_END_COLLECTION \
    USB_HID_ITEM(USB_HID_ITEM_TAG_COLLECTION_END, USB_HID_ITEM_TYPE_MAIN, 0)

#define USB_HID_USAGE_PAGE(page) \
    USB_HID_ITEM(USB_HID_ITEM_TAG_USAGE_PAGE, USB_HID_ITEM_TYPE_GLOBAL, 1), \
    page

#define USB_HID_USAGE_PAGE16(page) \
    USB_HID_ITEM(USB_HID_ITEM_TAG_USAGE_PAGE, USB_HID_ITEM_TYPE_GLOBAL, 2), \
    page & 0xff, (page >> 8)

#define USB_HID_LOGICAL_MIN8(minimum) \
    USB_HID_ITEM(USB_HID_ITEM_TAG_LOGICAL_MIN, USB_HID_ITEM_TYPE_GLOBAL, 1), \
    minimum

#define USB_HID_LOGICAL_MIN16(minimum) \
    USB_HID_ITEM(USB_HID_ITEM_TAG_LOGICAL_MIN, USB_HID_ITEM_TYPE_GLOBAL, 2), \
    minimum & 0xff, (minimum >> 8)

#define USB_HID_LOGICAL_MIN32(minimum) \
    USB_HID_ITEM(USB_HID_ITEM_TAG_LOGICAL_MIN, USB_HID_ITEM_TYPE_GLOBAL, 3), \
    minimum & 0xff, \
    (minimum >> 8) & 0xff, \
    (minimum >> 16) & 0xff, \
    (minimum >> 24) & 0xff

#define USB_HID_LOGICAL_MAX8(maximum) \
    USB_HID_ITEM(USB_HID_ITEM_TAG_LOGICAL_MAX, USB_HID_ITEM_TYPE_GLOBAL, 1), \
    maximum

#define USB_HID_LOGICAL_MAX16(maximum) \
    USB_HID_ITEM(USB_HID_ITEM_TAG_LOGICAL_MAX, USB_HID_ITEM_TYPE_GLOBAL, 2), \
    (maximum & 0xff), (maximum >> 8)

#define USB_HID_LOGICAL_MAX32(maximum) \
    USB_HID_ITEM(USB_HID_ITEM_TAG_LOGICAL_MAX, USB_HID_ITEM_TYPE_GLOBAL, 3), \
    maximum & 0xff, \
    (maximum >> 8) & 0xff, \
    (maximum >> 16) & 0xff, \
    (maximum >> 24) & 0xff

#define USB_HID_REPORT_SIZE(size)       \
    USB_HID_ITEM(USB_HID_ITEM_TAG_REPORT_SIZE, USB_HID_ITEM_TYPE_GLOBAL, 1), \
    size

#define USB_HID_REPORT_ID(id)       \
    USB_HID_ITEM(USB_HID_ITEM_TAG_REPORT_ID, USB_HID_ITEM_TYPE_GLOBAL, 1), \
    id

#define USB_HID_REPORT_COUNT(count)     \
    USB_HID_ITEM(USB_HID_ITEM_TAG_REPORT_COUNT, USB_HID_ITEM_TYPE_GLOBAL, 1), \
    count

#define USB_HID_USAGE(index)            \
    USB_HID_ITEM(USB_HID_ITEM_TAG_USAGE, USB_HID_ITEM_TYPE_LOCAL, 1), \
    index

#define USB_HID_USAGE_MIN8(start)       \
    USB_HID_ITEM(USB_HID_ITEM_TAG_USAGE_MIN, USB_HID_ITEM_TYPE_LOCAL, 1), \
    start

#define USB_HID_USAGE_MIN16(start)      \
    USB_HID_ITEM(USB_HID_ITEM_TAG_USAGE_MIN, USB_HID_ITEM_TYPE_LOCAL, 2), \
    start & 0xff, (start >> 8) & 0xff

#define USB_HID_USAGE_MAX8(end)     \
    USB_HID_ITEM(USB_HID_ITEM_TAG_USAGE_MAX, USB_HID_ITEM_TYPE_LOCAL, 1), \
    end

#define USB_HID_USAGE_MAX16(end)      \
    USB_HID_ITEM(USB_HID_ITEM_TAG_USAGE_MAX, USB_HID_ITEM_TYPE_LOCAL, 2), \
    end & 0xff, (end >> 8) & 0xff

 
#ifdef __cplusplus
}
#endif