HID_definitions.hpp

Go to the documentation of this file.

 
#pragma once
 
//-------------------------------------------------------------------
// Imports
//-------------------------------------------------------------------
 
#include <cinttypes>
 
//-------------------------------------------------------------------
// Report ID's
//-------------------------------------------------------------------
 
#define RID_INPUT_GAMEPAD 0x01
#define RID_FEATURE_CAPABILITIES 0x02
#define RID_FEATURE_CONFIG 0x03
#define RID_FEATURE_BUTTONS_MAP 0x04
#define RID_FEATURE_HARDWARE_ID 0x05
 
#define RID_OUTPUT_POWERTRAIN 0x14 // 20 dec
#define RID_OUTPUT_ECU 0x15 // 21 dec
#define RID_OUTPUT_RACE_CONTROL 0x16 // 22 dec
#define RID_OUTPUT_GAUGES 0x17 // 23 dec
#define RID_OUTPUT_PIXEL 0x1E // 30 dec
 
//-------------------------------------------------------------------
// Report sizes (bytes)
//-------------------------------------------------------------------
 
#define GAMEPAD_REPORT_SIZE 20
#define CAPABILITIES_REPORT_SIZE 20
#define CONFIG_REPORT_SIZE 7
#define BUTTONS_MAP_REPORT_SIZE 3
#define HARDWARE_ID_REPORT_SIZE 6
#define POWERTRAIN_REPORT_SIZE 10
#define ECU_REPORT_SIZE 9
#define RACE_CONTROL_REPORT_SIZE 11
#define GAUGES_REPORT_SIZE 12
#define PIXEL_REPORT_SIZE 6
 
//-------------------------------------------------------------------
// GAME CONTROLLER APPEARANCES
//-------------------------------------------------------------------
 
#define CONTROLLER_TYPE_GAMEPAD 0x05
#define CONTROLLER_TYPE_JOYSTICK 0x04
 
//-------------------------------------------------------------------
// INPUT REPORT constants
//-------------------------------------------------------------------
 
#define BUTTON_COUNT 128
 
//-------------------------------------------------------------------
// BLE implementation
//-------------------------------------------------------------------
 
#define BLE_VENDOR_SOURCE 0x00
#define BLE_VENDOR_ID 0x1d50
#define BLE_PRODUCT_ID 0xffff
#define TEST_HARDWARE_ID 0xffff
#define BLE_SERIAL_NUMBER_CHR_UUID 0x2A25
#define BLE_BATTERY_STATUS_CHR_UUID 0x2BED
 
// See https://devzone.nordicsemi.com/nordic/nordic-blog/b/blog/posts/one-minute-to-understand-ble-mtu-data-package
// BLE_MTU_SIZE must be greater than 23 bytes
// BLE_MTU_SIZE = max report size + report ID + payload metadata
 
#define BLE_MTU_SIZE GAMEPAD_REPORT_SIZE + 1 + 14
 
//-------------------------------------------------------------------
// Hardware revision
//-------------------------------------------------------------------
 
#define PRODUCT_REVISION 0x0100
 
//-------------------------------------------------------------------
// Data specification version
//-------------------------------------------------------------------
 
#define DATA_MAJOR_VERSION 1
#define DATA_MINOR_VERSION 6
 
//-------------------------------------------------------------------
// Magic number, do not change
//-------------------------------------------------------------------
 
#define MAGIC_NUMBER_LOW 0x51
#define MAGIC_NUMBER_HIGH 0xBF
 
//-------------------------------------------------------------------
// HID report descriptor
//-------------------------------------------------------------------
 
static const uint8_t hid_descriptor[] = {
    0x05, 0x01,                    // UsagePage(Generic Desktop[1])
    0x09, CONTROLLER_TYPE_GAMEPAD, // UsageId
    0xA1, 0x01,                    // Collection(Application)
 
    // ___ INPUT REPORT ___
    0x85, RID_INPUT_GAMEPAD, //     ReportId
 
    //     Buttons (128 bits=16 bytes)
    0x05, 0x09, //     UsagePage(Button[9])
    0x19, 0x01, //     UsageIdMin(Button 1[1])
    0x29, 0x80, //     UsageIdMax(Button 128[128])
    0x15, 0x00, //     LogicalMinimum(0)
    0x25, 0x01, //     LogicalMaximum(1)
    0x95, 0x80, //     ReportCount(128)
    0x75, 0x01, //     ReportSize(1)
    0x81, 0x02, //     Input(Data, Variable, Absolute, NoWrap, Linear, PreferredState, NoNullPosition, BitField)
 
    //     axis (1 byte)
    0x05, 0x01, //     UsagePage(Generic Desktop[1])
    0x09, 0x35, //     UsageId(Rz[53])
    // 0x15, 0x00, //     LogicalMinimum
    // 0x25, CLUTCH_FULL_VALUE, //     LogicalMaximum
    0x26, 0xFE, 0x00, //     LogicalMaximum(254)
    0x95, 0x01,       //     ReportCount(1)
    0x75, 0x08,       //     ReportSize(8)
    0x81, 0x02,       //     Input(Data, Variable, Absolute, NoWrap, Linear, PreferredState, NoNullPosition, BitField)
 
    //     axis (1 byte)
    0x09, 0x34, //     UsageId(Ry[52])
    0x81, 0x02, //     Input(Data, Variable, Absolute, NoWrap, Linear, PreferredState, NoNullPosition, BitField)
 
    //     axis (1 byte)
    0x09, 0x33, //     UsageId(Rx[51])
    0x81, 0x02, //     Input(Data, Variable, Absolute, NoWrap, Linear, PreferredState, NoNullPosition, BitField)
 
    //     D-PAD (hat switch), (4 bits)
    0x09, 0x39,       //     UsageId(Hat Switch[57])
    0x46, 0x40, 0x01, //     PhysicalMaximum(320)
    0x65, 0x14,       //     Unit('degrees', EnglishRotation, Degrees:1)
    0x15, 0x01,       //     LogicalMinimum(1)
    0x25, 0x08,       //     LogicalMaximum(8)
    0x75, 0x04,       //     ReportSize(4)
    0x81, 0x02,       //     Input(Data, Variable, Absolute, NoWrap, Linear, PreferredState, NoNullPosition, BitField)
 
    //     Feature notification (4 bits)
    0x09, 0x47, //     UsageId(Feature Notification[71])
    0x45, 0x00, //     PhysicalMaximum(0)
    0x65, 0x00, //     Unit(None)
    0x81, 0x02, //     Input(Data, Variable, Absolute, NoWrap, Linear, PreferredState, NoNullPosition, BitField)
 
    // ___ CAPABILITIES (FEATURE) REPORT ___
    0x09, 0x00,                     // USAGE (undefined)
    0x15, 0x00,                     // LogicalMinimum(0)
    0x25, 0xff,                     // LogicalMaximum(256)
    0x85, RID_FEATURE_CAPABILITIES, // REPORT ID
    0x75, 0x08,                     // Report Size (8)
    0x95, CAPABILITIES_REPORT_SIZE, // Report count
    0xb1, 0x23,                     // FEATURE (Cnst,var,abs,Nprf)
 
    // ___ CONFIG (FEATURE) REPORT ___
    0x09, 0x00,               // USAGE (undefined)
    0x85, RID_FEATURE_CONFIG, // REPORT ID
    0x75, 0x08,               // Report Size (8)
    0x95, CONFIG_REPORT_SIZE, // Report count
    0xb1, 0xa2,               // FEATURE (Data,var,abs,Nprf,Vol)
 
    // ___ MAP (FEATURE) REPORT ___
    0x09, 0x00,                    // USAGE (undefined)
    0x85, RID_FEATURE_BUTTONS_MAP, // REPORT ID
    0x75, 0x08,                    // Report Size (8)
    0x95, BUTTONS_MAP_REPORT_SIZE, // Report count
    0xb1, 0xa2,                    // FEATURE (Data,var,abs,Nprf,Vol)
 
    // ___ HARDWARE ID (FEATURE) REPORT ___
    0x09, 0x00,                    // USAGE (undefined)
    0x85, RID_FEATURE_HARDWARE_ID, // REPORT ID
    0x75, 0x08,                    // Report Size (8)
    0x95, HARDWARE_ID_REPORT_SIZE, // Report count
    0xb1, 0xa2,                    // FEATURE (Data,var,abs,Nprf,Vol)
 
    // ___ POWERTRAIN TELEMETRY (OUTPUT) REPORT ___
    0x09, 0x00,                   // USAGE (undefined)
    0x85, RID_OUTPUT_POWERTRAIN,  // REPORT ID
    0x75, 0x08,                   // Report Size (8)
    0x95, POWERTRAIN_REPORT_SIZE, // Report count
    0x91, 0x22,                   // OUTPUT (Data,var,abs,Nprf)
 
    // ___ ECU TELEMETRY (OUTPUT) REPORT ___
    0x09, 0x00,            // USAGE (undefined)
    0x85, RID_OUTPUT_ECU,  // REPORT ID
    0x75, 0x08,            // Report Size (8)
    0x95, ECU_REPORT_SIZE, // Report count
    0x91, 0x22,            // OUTPUT (Data,var,abs,Nprf)
 
    // ___ RACE CONTROL TELEMETRY (OUTPUT) REPORT ___
    0x09, 0x00,                     // USAGE (undefined)
    0x85, RID_OUTPUT_RACE_CONTROL,  // REPORT ID
    0x75, 0x08,                     // Report Size (8)
    0x95, RACE_CONTROL_REPORT_SIZE, // Report count
    0x91, 0x22,                     // OUTPUT (Data,var,abs,Nprf)
 
    // ___ GAUGES (OUTPUT) REPORT ___
    0x09, 0x00,               // USAGE (undefined)
    0x85, RID_OUTPUT_GAUGES,  // REPORT ID
    0x75, 0x08,               // Report Size (8)
    0x95, GAUGES_REPORT_SIZE, // Report count
    0x91, 0x22,               // OUTPUT (Data,var,abs,Nprf)
 
    // ___ PIXEL CONTROL (OUTPUT) REPORT ___
    0x09, 0x00,              // USAGE (undefined)
    0x85, RID_OUTPUT_PIXEL,  // REPORT ID
    0x75, 0x08,              // Report Size (8)
    0x95, PIXEL_REPORT_SIZE, // Report count
    0x91, 0x22,              // OUTPUT (Data,var,abs,Nprf)
 
    // END APPLICATION
    0xC0 // EndCollection()
};
 
// Input report packed structure:
// typedef struct {
//     uint64_t inputsLow;
//     uint64_t inputsHigh;
//     uint8_t clutchAxis;
//     uint8_t leftAxis;
//     uint8_t rightAxis;
//     uint8_t POVState: 4;
//     uint8_t notifyConfigChanges: 4;
// } hidInputReport_t;