usb_descriptors.c

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2019 Ha Thach (tinyusb.org)
 *
 * 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.
 *
 */

#include "tusb.h"
//#include <hid.h>
#include "usb_descriptors.h"
#include "pico/unique_id.h"
#include <string.h>

static bool forcePlayer1Only = false;

void set_usb_descriptor_player1_only(bool set)
{
    forcePlayer1Only = set;
}

bool is_usb_descriptor_player1_only()
{
    return forcePlayer1Only;
}

//--------------------------------------------------------------------+
// Device Descriptors
//--------------------------------------------------------------------+
tusb_desc_device_t const desc_device =
{
    .bLength            = sizeof(tusb_desc_device_t),
    .bDescriptorType    = TUSB_DESC_DEVICE,
    .bcdUSB             = 0x0200,
    .bDeviceClass       = 0x00,
    .bDeviceSubClass    = 0x00,
    .bDeviceProtocol    = 0x00,
    .bMaxPacketSize0    = CFG_TUD_ENDPOINT0_SIZE,

    .idVendor           = 0xCafe,
    .idProduct          = 0xF00d,
    .bcdDevice          = 0x0100,

    .iManufacturer      = 0x01,
    .iProduct           = 0x02,
    .iSerialNumber      = 0x03,

    .bNumConfigurations = 0x01
};

// Invoked when received GET DEVICE DESCRIPTOR
// Application return pointer to descriptor
uint8_t const *tud_descriptor_device_cb(void) {
    return (uint8_t const *) &desc_device;
}

//--------------------------------------------------------------------+
// HID Report Descriptor
//--------------------------------------------------------------------+

uint8_t const desc_hid_report1[] =
{
#if (PLAYER_1_USB_TYPE == USB_TYPE_KEYBOARD)
    TUD_HID_REPORT_DESC_KEYBOARD()
#elif (PLAYER_1_USB_TYPE == USB_TYPE_GAMEPAD)
    TUD_HID_REPORT_DESC_GAMEPAD()
#endif
};

uint8_t const desc_hid_report2[] =
{
#if (PLAYER_2_USB_TYPE == USB_TYPE_KEYBOARD)
    TUD_HID_REPORT_DESC_KEYBOARD()
#elif (PLAYER_2_USB_TYPE == USB_TYPE_GAMEPAD)
    TUD_HID_REPORT_DESC_GAMEPAD()
#endif
};

// Invoked when received GET HID REPORT DESCRIPTOR
// Application return pointer to descriptor
// Descriptor contents must exist long enough for transfer to complete
uint8_t const *tud_hid_descriptor_report_cb(uint8_t instance)
{
    switch (instance)
    {
        case ITF_NUM_HID1:
            return desc_hid_report1;
#if (NUMBER_OF_DEVICES > 1)
        case ITF_NUM_HID2:
            return desc_hid_report2;
#endif
        default:
            return NULL;
    }
}

//--------------------------------------------------------------------+
// Configuration Descriptor
//--------------------------------------------------------------------+

#define  CONFIG_TOTAL_LEN  (TUD_CONFIG_DESC_LEN + (NUMBER_OF_DEVICES * TUD_HID_DESC_LEN))

#define EPNUM_HID1   (ITF_NUM_HID1 + 1)
#define EPNUM_HID2   (ITF_NUM_HID2 + 1)

// Just make the report size the max of the two supported types
#define REPORT_SIZE (sizeof(hid_keyboard_report_t) > sizeof(hid_gamepad_report_t) ? sizeof(hid_keyboard_report_t) : sizeof(hid_gamepad_report_t))

uint8_t const desc_configuration[] =
{
    // Config number, interface count, string index, total length, attribute, power in mA
    TUD_CONFIG_DESCRIPTOR(1, ITF_NUM_TOTAL, 0, CONFIG_TOTAL_LEN, TUSB_DESC_CONFIG_ATT_REMOTE_WAKEUP, 100),

    // Interface number, string index, protocol, report descriptor len, EP In address, size & polling interval
    TUD_HID_DESCRIPTOR(ITF_NUM_HID1, 4, HID_ITF_PROTOCOL_NONE, sizeof(desc_hid_report1),
                                0x80 | EPNUM_HID1, 1 + REPORT_SIZE, 10),
#if (NUMBER_OF_DEVICES > 1)
    TUD_HID_DESCRIPTOR(ITF_NUM_HID2, 5, HID_ITF_PROTOCOL_NONE, sizeof(desc_hid_report2),
                                0x80 | EPNUM_HID2, 1 + REPORT_SIZE, 10)
#endif
};

#define  CONFIG_PLAYER1_ONLY_TOTAL_LEN  (TUD_CONFIG_DESC_LEN + TUD_HID_DESC_LEN)

uint8_t const desc_player1_only_configuration[] =
{
    // Config number, interface count, string index, total length, attribute, power in mA
    TUD_CONFIG_DESCRIPTOR(1, 1, 0, CONFIG_PLAYER1_ONLY_TOTAL_LEN, TUSB_DESC_CONFIG_ATT_REMOTE_WAKEUP, 100),

    // Interface number, string index, protocol, report descriptor len, EP In address, size & polling interval
    TUD_HID_DESCRIPTOR(ITF_NUM_HID1, 4, HID_ITF_PROTOCOL_NONE, sizeof(desc_hid_report1),
                                0x80 | EPNUM_HID1, 1 + REPORT_SIZE, 10),
};

// Invoked when received GET CONFIGURATION DESCRIPTOR
// Application return pointer to descriptor
// Descriptor contents must exist long enough for transfer to complete
uint8_t const *tud_descriptor_configuration_cb(uint8_t index) {
    (void) index; // for multiple configurations
    if (forcePlayer1Only)
    {
        return desc_player1_only_configuration;
    }
    else
    {
        return desc_configuration;
    }
}

//--------------------------------------------------------------------+
// String Descriptors
//--------------------------------------------------------------------+

// array of pointer to string descriptors
char const *string_desc_arr[] =
{
    (const char[]) {0x09, 0x04}, // 0: is supported language is English (0x0409)
    "DIY"  ,                     // 1: Manufacturer
    "Genesis Controller USB",    // 2: Product
    NULL,                        // 3: Serial (special case; get pico serial)
    "Player 1",                  // 4: Device 1
    "Player 2"                   // 5: Device 2
};

static uint16_t _desc_str[32];

// Invoked when received GET STRING DESCRIPTOR request
// Application return pointer to descriptor, whose contents must exist long enough for transfer to complete
uint16_t const *tud_descriptor_string_cb(uint8_t index, uint16_t langid) {
    (void) langid;

    uint8_t chr_count;
    char buffer[32] = {0};

    if (index == 0) {
        memcpy(&_desc_str[1], string_desc_arr[0], 2);
        chr_count = 1;
    } else {
        // Convert ASCII string into UTF-16

        if (!(index < sizeof(string_desc_arr) / sizeof(string_desc_arr[0]))) return NULL;

        const char *str = string_desc_arr[index];

        if (str == NULL)
        {
            if (index == 3)
            {
                // Special case: try to get pico serial number
                pico_get_unique_board_id_string(buffer, sizeof(buffer));
                if (buffer[0] != '\0')
                {
                    str = buffer;
                }
                else
                {
                    // Something failed, have host assign serial
                    return NULL;
                }
            }
            else
            {
                return NULL;
            }
        }

        // Cap at max char
        chr_count = strlen(str);
        if (chr_count > 31) chr_count = 31;

        for (uint8_t i = 0; i < chr_count; i++) {
            _desc_str[1 + i] = str[i];
        }
    }

    // first byte is length (including header), second byte is string type
    _desc_str[0] = (TUSB_DESC_STRING << 8) | (2 * chr_count + 2);

    return _desc_str;
}