/* * The MIT License (MIT) * * Copyright (c) 2020 Jerzy Kasenbreg * Copyright (c) 2021 Koji KITAYAMA * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. * */ #ifndef _USB_DESCRIPTORS_H_ #define _USB_DESCRIPTORS_H_ #include "tusb.h" enum { REPORT_ID_KEYBOARD = 1, REPORT_ID_FULL_KEY_KEYBOARD, // 2 REPORT_ID_CONSUMER, // 3 REPORT_ID_LIGHTING_LAMP_ARRAY_ATTRIBUTES, // 4 REPORT_ID_LIGHTING_LAMP_ATTRIBUTES_REQUEST, // 5 REPORT_ID_LIGHTING_LAMP_ATTRIBUTES_RESPONSE, // 6 REPORT_ID_LIGHTING_LAMP_MULTI_UPDATE, // 7 REPORT_ID_LIGHTING_LAMP_RANGE_UPDATE, // 8 REPORT_ID_LIGHTING_LAMP_ARRAY_CONTROL, // 9 REPORT_ID_COUNT }; enum { ITF_NUM_HID = 0, ITF_NUM_TOTAL }; enum { EPNUM_DEFAULT = 0, EPNUM_HID_DATA, }; // Keyboard Report Descriptor Full Key Template #define TUD_HID_REPORT_DESC_FULL_KEY_KEYBOARD(...) \ HID_USAGE_PAGE ( HID_USAGE_PAGE_DESKTOP ) ,\ HID_USAGE ( HID_USAGE_DESKTOP_KEYBOARD ) ,\ HID_COLLECTION ( HID_COLLECTION_APPLICATION ) ,\ /* Report ID if any */\ __VA_ARGS__ \ /* 8 bits Modifier Keys (Shift, Control, Alt) */ \ HID_USAGE_PAGE ( HID_USAGE_PAGE_KEYBOARD ) ,\ HID_USAGE_MIN ( 224 ) ,\ HID_USAGE_MAX ( 231 ) ,\ HID_LOGICAL_MIN ( 0 ) ,\ HID_LOGICAL_MAX ( 1 ) ,\ HID_REPORT_COUNT ( 8 ) ,\ HID_REPORT_SIZE ( 1 ) ,\ HID_INPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ) ,\ /* 8 bit reserved */ \ HID_REPORT_COUNT ( 1 ) ,\ HID_REPORT_SIZE ( 8 ) ,\ HID_INPUT ( HID_CONSTANT ) ,\ /* Output 5-bit LED Indicator Kana | Compose | ScrollLock | CapsLock | NumLock */ \ HID_USAGE_PAGE ( HID_USAGE_PAGE_LED ) ,\ HID_USAGE_MIN ( 1 ) ,\ HID_USAGE_MAX ( 5 ) ,\ HID_REPORT_COUNT ( 5 ) ,\ HID_REPORT_SIZE ( 1 ) ,\ HID_OUTPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ) ,\ /* led padding */ \ HID_REPORT_COUNT ( 1 ) ,\ HID_REPORT_SIZE ( 3 ) ,\ HID_OUTPUT ( HID_CONSTANT ) ,\ /* 15-byte Keycodes */ \ HID_USAGE_PAGE ( HID_USAGE_PAGE_KEYBOARD ) ,\ HID_USAGE_MIN ( 4 ) ,\ HID_USAGE_MAX ( 124 ) ,\ HID_LOGICAL_MIN ( 0 ) ,\ HID_LOGICAL_MAX ( 1 ) ,\ HID_REPORT_COUNT ( 120 ) ,\ HID_REPORT_SIZE ( 1 ) ,\ HID_INPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ) ,\ HID_COLLECTION_END \ // HID Lighting and Illumination Report Descriptor Template // - 1st parameter is report id (required) // Creates 6 report ids for lighting HID usages in the following order: // report_id+0: HID_USAGE_LIGHTING_LAMP_ARRAY_ATTRIBUTES_REPORT // report_id+1: HID_USAGE_LIGHTING_LAMP_ATTRIBUTES_REQUEST_REPORT // report_id+2: HID_USAGE_LIGHTING_LAMP_ATTRIBUTES_RESPONSE_REPORT // report_id+3: HID_USAGE_LIGHTING_LAMP_MULTI_UPDATE_REPORT // report_id+4: HID_USAGE_LIGHTING_LAMP_RANGE_UPDATE_REPORT // report_id+5: HID_USAGE_LIGHTING_LAMP_ARRAY_CONTROL_REPORT #define TUD_HID_REPORT_DESC_LIGHTING(report_id) \ HID_USAGE_PAGE ( HID_USAGE_PAGE_LIGHTING_AND_ILLUMINATION ),\ HID_USAGE ( HID_USAGE_LIGHTING_LAMP_ARRAY ),\ HID_COLLECTION ( HID_COLLECTION_APPLICATION ),\ /* Lamp Array Attributes Report */ \ HID_REPORT_ID (report_id ) \ HID_USAGE ( HID_USAGE_LIGHTING_LAMP_ARRAY_ATTRIBUTES_REPORT ),\ HID_COLLECTION ( HID_COLLECTION_LOGICAL ),\ HID_USAGE ( HID_USAGE_LIGHTING_LAMP_COUNT ),\ HID_LOGICAL_MIN ( 0 ),\ HID_LOGICAL_MAX_N ( 65535, 3 ),\ HID_REPORT_SIZE ( 16 ),\ HID_REPORT_COUNT ( 1 ),\ HID_FEATURE ( HID_CONSTANT | HID_VARIABLE | HID_ABSOLUTE ),\ HID_USAGE ( HID_USAGE_LIGHTING_BOUNDING_BOX_WIDTH_IN_MICROMETERS ),\ HID_USAGE ( HID_USAGE_LIGHTING_BOUNDING_BOX_HEIGHT_IN_MICROMETERS ),\ HID_USAGE ( HID_USAGE_LIGHTING_BOUNDING_BOX_DEPTH_IN_MICROMETERS ),\ HID_USAGE ( HID_USAGE_LIGHTING_LAMP_ARRAY_KIND ),\ HID_USAGE ( HID_USAGE_LIGHTING_MIN_UPDATE_INTERVAL_IN_MICROSECONDS ),\ HID_LOGICAL_MIN ( 0 ),\ HID_LOGICAL_MAX_N ( 2147483647, 3 ),\ HID_REPORT_SIZE ( 32 ),\ HID_REPORT_COUNT ( 5 ),\ HID_FEATURE ( HID_CONSTANT | HID_VARIABLE | HID_ABSOLUTE ),\ HID_COLLECTION_END ,\ /* Lamp Attributes Request Report */ \ HID_REPORT_ID ( report_id + 1 ) \ HID_USAGE ( HID_USAGE_LIGHTING_LAMP_ATTRIBUTES_REQUEST_REPORT ),\ HID_COLLECTION ( HID_COLLECTION_LOGICAL ),\ HID_USAGE ( HID_USAGE_LIGHTING_LAMP_ID ),\ HID_LOGICAL_MIN ( 0 ),\ HID_LOGICAL_MAX_N ( 65535, 3 ),\ HID_REPORT_SIZE ( 16 ),\ HID_REPORT_COUNT ( 1 ),\ HID_FEATURE ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\ HID_COLLECTION_END ,\ /* Lamp Attributes Response Report */ \ HID_REPORT_ID ( report_id + 2 ) \ HID_USAGE ( HID_USAGE_LIGHTING_LAMP_ATTRIBUTES_RESPONSE_REPORT ),\ HID_COLLECTION ( HID_COLLECTION_LOGICAL ),\ HID_USAGE ( HID_USAGE_LIGHTING_LAMP_ID ),\ HID_LOGICAL_MIN ( 0 ),\ HID_LOGICAL_MAX_N ( 65535, 3 ),\ HID_REPORT_SIZE ( 16 ),\ HID_REPORT_COUNT ( 1 ),\ HID_FEATURE ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\ HID_USAGE ( HID_USAGE_LIGHTING_POSITION_X_IN_MICROMETERS ),\ HID_USAGE ( HID_USAGE_LIGHTING_POSITION_Y_IN_MICROMETERS ),\ HID_USAGE ( HID_USAGE_LIGHTING_POSITION_Z_IN_MICROMETERS ),\ HID_USAGE ( HID_USAGE_LIGHTING_UPDATE_LATENCY_IN_MICROSECONDS ),\ HID_USAGE ( HID_USAGE_LIGHTING_LAMP_PURPOSES ),\ HID_LOGICAL_MIN ( 0 ),\ HID_LOGICAL_MAX_N ( 2147483647, 3 ),\ HID_REPORT_SIZE ( 32 ),\ HID_REPORT_COUNT ( 5 ),\ HID_FEATURE ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\ HID_USAGE ( HID_USAGE_LIGHTING_RED_LEVEL_COUNT ),\ HID_USAGE ( HID_USAGE_LIGHTING_GREEN_LEVEL_COUNT ),\ HID_USAGE ( HID_USAGE_LIGHTING_BLUE_LEVEL_COUNT ),\ HID_USAGE ( HID_USAGE_LIGHTING_INTENSITY_LEVEL_COUNT ),\ HID_USAGE ( HID_USAGE_LIGHTING_IS_PROGRAMMABLE ),\ HID_USAGE ( HID_USAGE_LIGHTING_INPUT_BINDING ),\ HID_LOGICAL_MIN ( 0 ),\ HID_LOGICAL_MAX_N ( 255, 2 ),\ HID_REPORT_SIZE ( 8 ),\ HID_REPORT_COUNT ( 6 ),\ HID_FEATURE ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\ HID_COLLECTION_END ,\ /* Lamp Multi-Update Report */ \ HID_REPORT_ID ( report_id + 3 ) \ HID_USAGE ( HID_USAGE_LIGHTING_LAMP_MULTI_UPDATE_REPORT ),\ HID_COLLECTION ( HID_COLLECTION_LOGICAL ),\ HID_USAGE ( HID_USAGE_LIGHTING_LAMP_COUNT ),\ HID_USAGE ( HID_USAGE_LIGHTING_LAMP_UPDATE_FLAGS ),\ HID_LOGICAL_MIN ( 0 ),\ HID_LOGICAL_MAX ( 8 ),\ HID_REPORT_SIZE ( 8 ),\ HID_REPORT_COUNT ( 2 ),\ HID_FEATURE ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\ HID_USAGE ( HID_USAGE_LIGHTING_LAMP_ID ),\ HID_LOGICAL_MIN ( 0 ),\ HID_LOGICAL_MAX_N ( 65535, 3 ),\ HID_REPORT_SIZE ( 16 ),\ HID_REPORT_COUNT ( 8 ),\ HID_FEATURE ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\ HID_USAGE ( HID_USAGE_LIGHTING_RED_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_GREEN_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_BLUE_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_INTENSITY_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_RED_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_GREEN_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_BLUE_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_INTENSITY_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_RED_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_GREEN_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_BLUE_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_INTENSITY_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_RED_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_GREEN_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_BLUE_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_INTENSITY_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_RED_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_GREEN_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_BLUE_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_INTENSITY_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_RED_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_GREEN_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_BLUE_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_INTENSITY_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_RED_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_GREEN_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_BLUE_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_INTENSITY_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_RED_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_GREEN_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_BLUE_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_INTENSITY_UPDATE_CHANNEL ),\ HID_LOGICAL_MIN ( 0 ),\ HID_LOGICAL_MAX_N ( 255, 2 ),\ HID_REPORT_SIZE ( 8 ),\ HID_REPORT_COUNT ( 32 ),\ HID_FEATURE ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\ HID_COLLECTION_END ,\ /* Lamp Range Update Report */ \ HID_REPORT_ID ( report_id + 4 ) \ HID_USAGE ( HID_USAGE_LIGHTING_LAMP_RANGE_UPDATE_REPORT ),\ HID_COLLECTION ( HID_COLLECTION_LOGICAL ),\ HID_USAGE ( HID_USAGE_LIGHTING_LAMP_UPDATE_FLAGS ),\ HID_LOGICAL_MIN ( 0 ),\ HID_LOGICAL_MAX ( 8 ),\ HID_REPORT_SIZE ( 8 ),\ HID_REPORT_COUNT ( 1 ),\ HID_FEATURE ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\ HID_USAGE ( HID_USAGE_LIGHTING_LAMP_ID_START ),\ HID_USAGE ( HID_USAGE_LIGHTING_LAMP_ID_END ),\ HID_LOGICAL_MIN ( 0 ),\ HID_LOGICAL_MAX_N ( 65535, 3 ),\ HID_REPORT_SIZE ( 16 ),\ HID_REPORT_COUNT ( 2 ),\ HID_FEATURE ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\ HID_USAGE ( HID_USAGE_LIGHTING_RED_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_GREEN_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_BLUE_UPDATE_CHANNEL ),\ HID_USAGE ( HID_USAGE_LIGHTING_INTENSITY_UPDATE_CHANNEL ),\ HID_LOGICAL_MIN ( 0 ),\ HID_LOGICAL_MAX_N ( 255, 2 ),\ HID_REPORT_SIZE ( 8 ),\ HID_REPORT_COUNT ( 4 ),\ HID_FEATURE ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\ HID_COLLECTION_END ,\ /* Lamp Array Control Report */ \ HID_REPORT_ID ( report_id + 5 ) \ HID_USAGE ( HID_USAGE_LIGHTING_LAMP_ARRAY_CONTROL_REPORT ),\ HID_COLLECTION ( HID_COLLECTION_LOGICAL ),\ HID_USAGE ( HID_USAGE_LIGHTING_AUTONOMOUS_MODE ),\ HID_LOGICAL_MIN ( 0 ),\ HID_LOGICAL_MAX ( 1 ),\ HID_REPORT_SIZE ( 8 ),\ HID_REPORT_COUNT ( 1 ),\ HID_FEATURE ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\ HID_COLLECTION_END ,\ HID_COLLECTION_END \ #endif