CubeMX USB Custom HID code generation bug

Posted on December 08, 2017 at 05:49

Pretty sure this is a codegen bug in CubeMX v4.23.0 with latest libraries.

To reproduce: start a fresh project, select STM32F103, enable USB, choose Custom HID Device, press Generate. When run, this generates a hard fault.

We see that the 'user string' feature is enabled by default:

C:\Temp\Test\Inc\usbd_conf.h:

83 &sharpdefine USBD_SUPPORT_USER_STRING 1

And this results in an additional callback added to the end of 

USBD_ClassTypeDef

:

C:\Temp\Test\Middlewares\ST\STM32_USB_Device_Library\Core\Inc\usbd_def.h:

177 uint8_t *(*GetOtherSpeedConfigDescriptor)(uint16_t *length);

178 uint8_t *(*GetDeviceQualifierDescriptor)(uint16_t *length);

179: &sharpif (USBD_SUPPORT_USER_STRING == 1)

180 uint8_t *(*GetUsrStrDescriptor)(struct _USBD_HandleTypeDef *pdev ,uint8_t index, uint16_t *length);

181 &sharpendif

This is used during enumeration, where the hard fault is triggered when the device is plugged in to the host:

C:\Temp\Test\Middlewares\ST\STM32_USB_Device_Library\Core\Src\usbd_ctlreq.c:

388

389 default:

390: &sharpif (USBD_SUPPORT_USER_STRING == 1)

391 pbuf = pdev->pClass->GetUsrStrDescriptor(pdev, (req->wValue) , &len);

392 break;

The code faults here because this function pointer is zero when it tries to branch.

The origin of the fault is explained by the fact that this additional field is not initialised when the callbacks are defined, and is thus zero due to partial initialisation (the member should appear after line 132):

C:\Temp\Test\Middlewares\ST\STM32_USB_Device_Library\Class\CustomHID\Src\usbd_customhid.c:

132 USBD_CUSTOM_HID_GetDeviceQualifierDesc,

133 };

Disabling this feature by changing the &sharpdefine at top fixes the problem and the device enumerates and functions correctly.

I hope this is enough info to reproduce for a fix.

Regards -

  :: Gavin

#usb-device #usb-hid #hard-fault #code-generation #cube-mx