227 lines
8.4 KiB
C
227 lines
8.4 KiB
C
/*
|
|
* This file is part of the Micro Python project, http://micropython.org/
|
|
*/
|
|
|
|
/**
|
|
******************************************************************************
|
|
* @file USB_Device/CDC_Standalone/Src/usbd_desc.c
|
|
* @author MCD Application Team
|
|
* @version V1.0.1
|
|
* @date 26-February-2014
|
|
* @brief This file provides the USBD descriptors and string formating method.
|
|
******************************************************************************
|
|
* @attention
|
|
*
|
|
* <h2><center>© COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
|
|
*
|
|
* Licensed under MCD-ST Liberty SW License Agreement V2, (the "License");
|
|
* You may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at:
|
|
*
|
|
* http://www.st.com/software_license_agreement_liberty_v2
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*
|
|
******************************************************************************
|
|
*/
|
|
|
|
#include "usbd_core.h"
|
|
#include "usbd_desc.h"
|
|
#include "usbd_conf.h"
|
|
|
|
// need these headers just for MP_HAL_UNIQUE_ID_ADDRESS
|
|
#include "py/misc.h"
|
|
#include "py/mphal.h"
|
|
|
|
// So we don't clash with existing ST boards, we use the unofficial FOSS VID.
|
|
// This needs a proper solution.
|
|
#define USBD_VID 0xf055
|
|
#define USBD_PID 0x9800
|
|
#define USBD_LANGID_STRING 0x409
|
|
#define USBD_MANUFACTURER_STRING "MicroPython"
|
|
#define USBD_PRODUCT_HS_STRING "Pyboard Virtual Comm Port in HS Mode"
|
|
#define USBD_PRODUCT_FS_STRING "Pyboard Virtual Comm Port in FS Mode"
|
|
#define USBD_CONFIGURATION_HS_STRING "Pyboard Config"
|
|
#define USBD_INTERFACE_HS_STRING "Pyboard Interface"
|
|
#define USBD_CONFIGURATION_FS_STRING "Pyboard Config"
|
|
#define USBD_INTERFACE_FS_STRING "Pyboard Interface"
|
|
|
|
// USB Standard Device Descriptor
|
|
// needs to be in RAM because we modify the VID and PID
|
|
__ALIGN_BEGIN static uint8_t hUSBDDeviceDesc[USB_LEN_DEV_DESC] __ALIGN_END = {
|
|
0x12, // bLength
|
|
USB_DESC_TYPE_DEVICE, // bDescriptorType
|
|
0x00, // bcdUSB
|
|
0x02,
|
|
0xef, // bDeviceClass: Miscellaneous Device Class
|
|
0x02, // bDeviceSubClass: Common Class
|
|
0x01, // bDeviceProtocol: Interface Association Descriptor
|
|
USB_MAX_EP0_SIZE, // bMaxPacketSize
|
|
LOBYTE(USBD_VID), // idVendor
|
|
HIBYTE(USBD_VID), // idVendor
|
|
LOBYTE(USBD_PID), // idVendor
|
|
HIBYTE(USBD_PID), // idVendor
|
|
0x00, // bcdDevice rel. 2.00
|
|
0x02,
|
|
USBD_IDX_MFC_STR, // Index of manufacturer string
|
|
USBD_IDX_PRODUCT_STR, // Index of product string
|
|
USBD_IDX_SERIAL_STR, // Index of serial number string
|
|
USBD_MAX_NUM_CONFIGURATION // bNumConfigurations
|
|
};
|
|
|
|
__ALIGN_BEGIN static uint8_t USBD_LangIDDesc[USB_LEN_LANGID_STR_DESC] __ALIGN_END = {
|
|
USB_LEN_LANGID_STR_DESC,
|
|
USB_DESC_TYPE_STRING,
|
|
LOBYTE(USBD_LANGID_STRING),
|
|
HIBYTE(USBD_LANGID_STRING),
|
|
};
|
|
|
|
__ALIGN_BEGIN static uint8_t USBD_StrDesc[USBD_MAX_STR_DESC_SIZ] __ALIGN_END;
|
|
|
|
// set the VID, PID and device release number
|
|
void USBD_SetVIDPIDRelease(uint16_t vid, uint16_t pid, uint16_t device_release_num, int cdc_only) {
|
|
if (cdc_only) {
|
|
// Make it look like a Communications device if we're only
|
|
// using CDC. Otherwise, windows gets confused when we tell it that
|
|
// its a composite device with only a cdc serial interface.
|
|
hUSBDDeviceDesc[4] = 0x02;
|
|
hUSBDDeviceDesc[5] = 0x00;
|
|
hUSBDDeviceDesc[6] = 0x00;
|
|
} else {
|
|
// For the other modes, we make this look like a composite device.
|
|
hUSBDDeviceDesc[4] = 0xef;
|
|
hUSBDDeviceDesc[5] = 0x02;
|
|
hUSBDDeviceDesc[6] = 0x01;
|
|
}
|
|
hUSBDDeviceDesc[8] = LOBYTE(vid);
|
|
hUSBDDeviceDesc[9] = HIBYTE(vid);
|
|
hUSBDDeviceDesc[10] = LOBYTE(pid);
|
|
hUSBDDeviceDesc[11] = HIBYTE(pid);
|
|
hUSBDDeviceDesc[12] = LOBYTE(device_release_num);
|
|
hUSBDDeviceDesc[13] = HIBYTE(device_release_num);
|
|
}
|
|
|
|
/**
|
|
* @brief Returns the device descriptor.
|
|
* @param speed: Current device speed
|
|
* @param length: Pointer to data length variable
|
|
* @retval Pointer to descriptor buffer
|
|
*/
|
|
STATIC uint8_t *USBD_DeviceDescriptor(USBD_SpeedTypeDef speed, uint16_t *length) {
|
|
*length = sizeof(hUSBDDeviceDesc);
|
|
return hUSBDDeviceDesc;
|
|
}
|
|
|
|
/**
|
|
* @brief Returns the LangID string descriptor.
|
|
* @param speed: Current device speed
|
|
* @param length: Pointer to data length variable
|
|
* @retval Pointer to descriptor buffer
|
|
*/
|
|
STATIC uint8_t *USBD_LangIDStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length) {
|
|
*length = sizeof(USBD_LangIDDesc);
|
|
return USBD_LangIDDesc;
|
|
}
|
|
|
|
/**
|
|
* @brief Returns the product string descriptor.
|
|
* @param speed: Current device speed
|
|
* @param length: Pointer to data length variable
|
|
* @retval Pointer to descriptor buffer
|
|
*/
|
|
STATIC uint8_t *USBD_ProductStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length) {
|
|
if(speed == 0) {
|
|
USBD_GetString((uint8_t *)USBD_PRODUCT_HS_STRING, USBD_StrDesc, length);
|
|
} else {
|
|
USBD_GetString((uint8_t *)USBD_PRODUCT_FS_STRING, USBD_StrDesc, length);
|
|
}
|
|
return USBD_StrDesc;
|
|
}
|
|
|
|
/**
|
|
* @brief Returns the manufacturer string descriptor.
|
|
* @param speed: Current device speed
|
|
* @param length: Pointer to data length variable
|
|
* @retval Pointer to descriptor buffer
|
|
*/
|
|
STATIC uint8_t *USBD_ManufacturerStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length) {
|
|
USBD_GetString((uint8_t *)USBD_MANUFACTURER_STRING, USBD_StrDesc, length);
|
|
return USBD_StrDesc;
|
|
}
|
|
|
|
/**
|
|
* @brief Returns the serial number string descriptor.
|
|
* @param speed: Current device speed
|
|
* @param length: Pointer to data length variable
|
|
* @retval Pointer to descriptor buffer
|
|
*/
|
|
STATIC uint8_t *USBD_SerialStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length) {
|
|
// This document: http://www.usb.org/developers/docs/devclass_docs/usbmassbulk_10.pdf
|
|
// says that the serial number has to be at least 12 digits long and that
|
|
// the last 12 digits need to be unique. It also stipulates that the valid
|
|
// character set is that of upper-case hexadecimal digits.
|
|
//
|
|
// The onboard DFU bootloader produces a 12-digit serial number based on
|
|
// the 96-bit unique ID, so for consistency we go with this algorithm.
|
|
// You can see the serial number if you do:
|
|
//
|
|
// dfu-util -l
|
|
//
|
|
// See: https://my.st.com/52d187b7 for the algorithim used.
|
|
|
|
uint8_t *id = (uint8_t *)MP_HAL_UNIQUE_ID_ADDRESS;
|
|
char serial_buf[16];
|
|
snprintf(serial_buf, sizeof(serial_buf),
|
|
"%02X%02X%02X%02X%02X%02X",
|
|
id[11], id[10] + id[2], id[9], id[8] + id[0], id[7], id[6]);
|
|
|
|
USBD_GetString((uint8_t *)serial_buf, USBD_StrDesc, length);
|
|
return USBD_StrDesc;
|
|
}
|
|
|
|
/**
|
|
* @brief Returns the configuration string descriptor.
|
|
* @param speed: Current device speed
|
|
* @param length: Pointer to data length variable
|
|
* @retval Pointer to descriptor buffer
|
|
*/
|
|
STATIC uint8_t *USBD_ConfigStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length) {
|
|
if(speed == USBD_SPEED_HIGH) {
|
|
USBD_GetString((uint8_t *)USBD_CONFIGURATION_HS_STRING, USBD_StrDesc, length);
|
|
} else {
|
|
USBD_GetString((uint8_t *)USBD_CONFIGURATION_FS_STRING, USBD_StrDesc, length);
|
|
}
|
|
return USBD_StrDesc;
|
|
}
|
|
|
|
/**
|
|
* @brief Returns the interface string descriptor.
|
|
* @param speed: Current device speed
|
|
* @param length: Pointer to data length variable
|
|
* @retval Pointer to descriptor buffer
|
|
*/
|
|
STATIC uint8_t *USBD_InterfaceStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length) {
|
|
if(speed == 0) {
|
|
USBD_GetString((uint8_t *)USBD_INTERFACE_HS_STRING, USBD_StrDesc, length);
|
|
} else {
|
|
USBD_GetString((uint8_t *)USBD_INTERFACE_FS_STRING, USBD_StrDesc, length);
|
|
}
|
|
return USBD_StrDesc;
|
|
}
|
|
|
|
const USBD_DescriptorsTypeDef USBD_Descriptors = {
|
|
USBD_DeviceDescriptor,
|
|
USBD_LangIDStrDescriptor,
|
|
USBD_ManufacturerStrDescriptor,
|
|
USBD_ProductStrDescriptor,
|
|
USBD_SerialStrDescriptor,
|
|
USBD_ConfigStrDescriptor,
|
|
USBD_InterfaceStrDescriptor,
|
|
};
|
|
|
|
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
|