xinput gamepad descriptor parsing issues

[johndoe3535]

Hi, right now I'm looking to port an xinput gamepad (xbox 360 gamepad) that I have working with the tinyusb stack
to zephyr. After a few hours and unsuccessfuly tries later, I hope that someone can point me in the right direction.
Down below are the descriptors

static const uint8_t xinputDeviceDescriptor[] =
{
	0x12,       // bLength
	0x01,       // bDescriptorType (Device)
	0x00, 0x02, // bcdUSB 2.00
	0xFF,	      // bDeviceClass
	0xFF,	      // bDeviceSubClass
	0xFF,	      // bDeviceProtocol
	0x40,	      // bMaxPacketSize0 64
	0x5E, 0x04, // idVendor 0x045E
	0x8E, 0x02, // idProduct 0x028E
	0x14, 0x01, // bcdDevice 2.14
	0x01,       // iManufacturer (String Index)
	0x02,       // iProduct (String Index)
	0x03,       // iSerialNumber (String Index)
	0x01,       // bNumConfigurations 1
};

static const uint8_t xinputConfigurationDescriptor[] =
{
	0x09,        // bLength
	0x02,        // bDescriptorType (Configuration)
	0x30, 0x00,  // wTotalLength 48
	0x01,        // bNumInterfaces 1
	0x01,        // bConfigurationValue
	0x00,        // iConfiguration (String Index)
	0x80,        // bmAttributes
	0xFA,        // bMaxPower 500mA

	0x09,        // bLength
	0x04,        // bDescriptorType (Interface)
	0x00,        // bInterfaceNumber 0
	0x00,        // bAlternateSetting
	0x02,        // bNumEndpoints 2
	0xFF,        // bInterfaceClass
	0x5D,        // bInterfaceSubClass
	0x01,        // bInterfaceProtocol
	0x00,        // iInterface (String Index)
=============================Custom Vendor Stuff====================
	0x10,        // bLength
	0x21,        // bDescriptorType (HID)
	0x10, 0x01,  // bcdHID 1.10
	0x01,        // bCountryCode
	0x24,        // bNumDescriptors
	0x81,        // bDescriptorType[0] (Unknown 0x81)
	0x14, 0x03,  // wDescriptorLength[0] 788
	0x00,        // bDescriptorType[1] (Unknown 0x00)
	0x03, 0x13,  // wDescriptorLength[1] 4867
	0x01,        // bDescriptorType[2] (Unknown 0x02)
	0x00, 0x03,  // wDescriptorLength[2] 768
	0x00,        // bDescriptorType[3] (Unknown 0x00)
=========================================================================
	0x07,        // bLength
	0x05,        // bDescriptorType (Endpoint)
	0x81,        // bEndpointAddress (IN/D2H)
	0x03,        // bmAttributes (Interrupt)
	0x20, 0x00,  // wMaxPacketSize 32
	0x01,        // bInterval 1 (unit depends on device speed)

	0x07,        // bLength
	0x05,        // bDescriptorType (Endpoint)
	0x01,        // bEndpointAddress (OUT/H2D)
	0x03,        // bmAttributes (Interrupt)
	0x20, 0x00,  // wMaxPacketSize 32
	0x08,        // bInterval 8 (unit depends on device speed)
};

The xinput standard is missing the hid report descriptor.
Instead there is this custom vendor descriptor, see "Custom Vendor Stuff" above. Without it
the Microsoft Driver doesn't identify the device as xinput.

The Input Report itself is sent via 0x81, and the rumble and led data are received via endpoint 0x01.
When looking at the dfu class here
https://github.com/zephyrproject-rtos/zephyr/blob/main/subsys/usb/device/class/dfu/usb_dfu.c
and
https://github.com/zephyrproject-rtos/zephyr/blob/main/include/zephyr/usb/usb_ch9.h

I came up with the following structure to make the descriptors working with zephyr:

USBD_DEVICE_DESCR_DEFINE(primary) struct DEVICEANDCONFIGDESC desc = {

	.device_descriptor = {
		.bLength = 0x12,
		.bDescriptorType = 0x01,
		.bcdUSB = 0x0200,
		.bDeviceClass = 0xFF,
		.bDeviceSubClass = 0xFF,
		.bDeviceProtocol = 0xFF,
		.bMaxPacketSize0 = 0x40,
		.idVendor = 0x045E,
		.idProduct = 0x028E,
		.bcdDevice = 0x0114,
		.iManufacturer = 0x01,
		.iProduct = 0x02,
		.iSerialNumber = 0x03,
		.bNumConfigurations = 0x01
	},

	.cfg_descr = {
		.bLength = 0x09,
		.bDescriptorType = 0x02,
		.wTotalLength = 0x0030,
		.bNumInterfaces = 0x01,
		.bConfigurationValue = 0x01,
		.iConfiguration = 0x00,
		.bmAttributes = 0x80,
		.bMaxPower = 0xFA
	},

};

USBD_CLASS_DESCR_DEFINE(primary, 0) struct CLASSDESC cdesc = {

	.if0 = {
		.bLength = 0x09,
		.bDescriptorType = 0x04,
		.bInterfaceNumber = 0x00,
		.bAlternateSetting = 0x00,
		.bNumEndpoints = 0x02,
		.bInterfaceClass = 0xFF,
		.bInterfaceSubClass = 0x5D,
		.bInterfaceProtocol = 0x01,
		.iInterface = 0x00
	},
	
	.custom_vendor = {
		.bLength = 0x10,
		.bDescriptorType = 0x21,
		.bcdHID = 0x1001,
		.bCountryCode = 0x01,
		.bNumDescriptors = 0x24,
		.bDescriptorType0 = 0x81,
		.wDescriptorLength0 = 0x1403,
		.bDescriptorType1 = 0x00,
		.wDescriptorLength1 = 0x0313,
		.bDescriptorType2 = 0x01,
		.wDescriptorLength2 = 0x0003,
		.bDescriptorType3 = 0x00
	},
	.ep0 = {
		.bLength = 0x07,
		.bDescriptorType = 0x05,
		.bEndpointAddress = 0x81,
		.bmAttributes = 0x03,
		.wMaxPacketSize = 0x0020,
		.bInterval = 0x01
	},
	.ep1 = {
		.bLength = 0x07,
		.bDescriptorType = 0x05,
		.bEndpointAddress = 0x01,
		.bmAttributes = 0x03,
		.wMaxPacketSize = 0x0020,
		.bInterval = 0x08
	}
};

int main(void)
{
	int ret;
	ret = usb_enable(NULL);
	if (ret != 0)
	{
		LOG_ERR("Failed to enable USB");
		return 0;
	}

	LOG_INF("entered main.");
	return 0;
}

prj.conf

CONFIG_USB_DEVICE_STACK=y
CONFIG_USB_DEVICE_INITIALIZE_AT_BOOT=n

CONFIG_LOG=y
CONFIG_USB_DRIVER_LOG_LEVEL_ERR=y
CONFIG_USB_DEVICE_LOG_LEVEL_ERR=y

CONFIG_USB_DEVICE_SOF=y

CONFIG_CONSOLE=y
CONFIG_UART_CONSOLE=y
CONFIG_LOG=y
CONFIG_LOG_BACKEND_UART=y
CONFIG_SERIAL=y

First I tried it with USBD_DEVICE_DESCR_DEFINE only. This works
and I can view the data with thesycon usb descriptor dumper.

However as soon as I use USBD_CLASS_DESCR_DEFINE in conjunction with USBD_DEVICE_DESCR_DEFINE
it sadly crashes the usb stack.

usb_device: Erroneous device descriptor or bMaxPacketSize0[1B][0m
[00:00:00.250,610] [1B][1;31m<err> main: Failed to enable USB[1B][0m
[00:00:00.254,669] [1B][0m<inf> usb_cdc_acm: Device suspended[1B][0m
[00:00:00.353,942] [1B][0m<inf> usb_cdc_acm: Device resumed[1B][0m
[00:00:00.402,282] [1B][1;31m<err> os: ***** USAGE FAULT *****[1B][0m
[00:00:00.402,313] [1B][1;31m<err> os:   Illegal use of the EPSR[1B][0m

I tried it a 2nd time by packing my uint_8t[] arrays directly into the structs for the two macros,
with the same outcome.
My assumption is that the data which I defined as
.custom_vendor struct is in an unexpected format that can't be parsed by zephyr.

Maybe I'm also missing some other crucial parts, for correct initialization of the stack.
Does anyone have any idea?

[blitzRahul]

@johndoe3535 Hello! Were you able to get it to work?