446 lines
14 KiB
C
446 lines
14 KiB
C
/**
|
||
******************************************************************************
|
||
* @file : usbd_desc.c
|
||
* @version : v1.0_Cube
|
||
* @brief : This file implements the USB device descriptors.
|
||
******************************************************************************
|
||
* This notice applies to any and all portions of this file
|
||
* that are not between comment pairs USER CODE BEGIN and
|
||
* USER CODE END. Other portions of this file, whether
|
||
* inserted by the user or by software development tools
|
||
* are owned by their respective copyright owners.
|
||
*
|
||
* Copyright (c) 2018 STMicroelectronics International N.V.
|
||
* All rights reserved.
|
||
*
|
||
* Redistribution and use in source and binary forms, with or without
|
||
* modification, are permitted, provided that the following conditions are met:
|
||
*
|
||
* 1. Redistribution of source code must retain the above copyright notice,
|
||
* this list of conditions and the following disclaimer.
|
||
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
||
* this list of conditions and the following disclaimer in the documentation
|
||
* and/or other materials provided with the distribution.
|
||
* 3. Neither the name of STMicroelectronics nor the names of other
|
||
* contributors to this software may be used to endorse or promote products
|
||
* derived from this software without specific written permission.
|
||
* 4. This software, including modifications and/or derivative works of this
|
||
* software, must execute solely and exclusively on microcontroller or
|
||
* microprocessor devices manufactured by or for STMicroelectronics.
|
||
* 5. Redistribution and use of this software other than as permitted under
|
||
* this license is void and will automatically terminate your rights under
|
||
* this license.
|
||
*
|
||
* THIS SOFTWARE IS PROVIDED BY STMICROELECTRONICS AND CONTRIBUTORS "AS IS"
|
||
* AND ANY EXPRESS, IMPLIED OR STATUTORY WARRANTIES, INCLUDING, BUT NOT
|
||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
|
||
* PARTICULAR PURPOSE AND NON-INFRINGEMENT OF THIRD PARTY INTELLECTUAL PROPERTY
|
||
* RIGHTS ARE DISCLAIMED TO THE FULLEST EXTENT PERMITTED BY LAW. IN NO EVENT
|
||
* SHALL STMICROELECTRONICS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
||
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
|
||
* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
||
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
||
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
|
||
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
*
|
||
******************************************************************************
|
||
*/
|
||
|
||
/* Includes ------------------------------------------------------------------*/
|
||
#include "usbd_core.h"
|
||
#include "usbd_desc.h"
|
||
#include "usbd_conf.h"
|
||
|
||
/* USER CODE BEGIN INCLUDE */
|
||
#include <MotorControl/odrive_main.h>
|
||
/* USER CODE END INCLUDE */
|
||
|
||
/* Private typedef -----------------------------------------------------------*/
|
||
/* Private define ------------------------------------------------------------*/
|
||
/* Private macro -------------------------------------------------------------*/
|
||
|
||
/* USER CODE BEGIN PV */
|
||
/* Private variables ---------------------------------------------------------*/
|
||
|
||
/* USER CODE END PV */
|
||
|
||
/** @addtogroup STM32_USB_OTG_DEVICE_LIBRARY
|
||
* @{
|
||
*/
|
||
|
||
/** @addtogroup USBD_DESC
|
||
* @{
|
||
*/
|
||
|
||
/** @defgroup USBD_DESC_Private_TypesDefinitions USBD_DESC_Private_TypesDefinitions
|
||
* @brief Private types.
|
||
* @{
|
||
*/
|
||
|
||
/* USER CODE BEGIN PRIVATE_TYPES */
|
||
|
||
/* USER CODE END PRIVATE_TYPES */
|
||
|
||
/**
|
||
* @}
|
||
*/
|
||
|
||
/** @defgroup USBD_DESC_Private_Defines USBD_DESC_Private_Defines
|
||
* @brief Private defines.
|
||
* @{
|
||
*/
|
||
|
||
#define USBD_VID 0x1209
|
||
#define USBD_LANGID_STRING 1033
|
||
#define USBD_MANUFACTURER_STRING "ODrive Robotics"
|
||
#define USBD_PID_FS 0x0D32
|
||
#define USBD_PRODUCT_XSTR(s) USBD_PRODUCT_STR(s)
|
||
#define USBD_PRODUCT_STR(s) #s
|
||
#define USBD_PRODUCT_STRING_FS ODrive HW_VERSION_MAJOR.HW_VERSION_MINOR CDC Interface
|
||
#define NATIVE_STRING ODrive HW_VERSION_MAJOR.HW_VERSION_MINOR Native Interface
|
||
#define USBD_CONFIGURATION_STRING_FS "CDC Config"
|
||
#define USBD_INTERFACE_STRING_FS "CDC Interface"
|
||
|
||
#define USB_SIZ_BOS_DESC 0x0C
|
||
|
||
/* USER CODE BEGIN PRIVATE_DEFINES */
|
||
|
||
/* USER CODE END PRIVATE_DEFINES */
|
||
|
||
/**
|
||
* @}
|
||
*/
|
||
|
||
/* USER CODE BEGIN 0 */
|
||
|
||
// MS OS String descriptor to tell Windows that it may query for other descriptors
|
||
// It's a standard string descriptor.
|
||
// Windows will only query for OS descriptors once!
|
||
// Delete the information about already queried devices in registry by deleting:
|
||
// HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\usbflags\VVVVPPPPRRRR
|
||
__ALIGN_BEGIN uint8_t USBD_MS_OS_StringDescriptor[] __ALIGN_END =
|
||
{
|
||
0x12, // bLength 1 0x12 Length of the descriptor
|
||
0x03, // bDescriptorType 1 0x03 Descriptor type
|
||
// qwSignature 14 ‘MSFT100’ Signature field
|
||
0x4D, 0x00, // 'M'
|
||
0x53, 0x00, // 'S'
|
||
0x46, 0x00, // 'F'
|
||
0x54, 0x00, // 'T'
|
||
0x31, 0x00, // '1'
|
||
0x30, 0x00, // '0'
|
||
0x30, 0x00, // '0'
|
||
MS_VendorCode, // bMS_VendorCode 1 Vendor-specific Vendor code
|
||
0x00 // bPad 1 0x00 Pad field
|
||
};
|
||
|
||
// redefined further down
|
||
__ALIGN_BEGIN uint8_t USBD_StrDesc[USBD_MAX_STR_DESC_SIZ] __ALIGN_END;
|
||
/**
|
||
* @brief UsrStrDescriptor
|
||
* return non standard string descriptor
|
||
* @param pdev: device instance
|
||
* @param index : descriptor index (0xEE for MS OS String Descriptor)
|
||
* @param length : pointer data length
|
||
* @retval pointer to descriptor buffer
|
||
*/
|
||
uint8_t * USBD_UsrStrDescriptor(struct _USBD_HandleTypeDef *pdev, uint8_t index, uint16_t *length)
|
||
{
|
||
*length = 0;
|
||
if (USBD_IDX_MICROSOFT_DESC_STR == index) {
|
||
*length = sizeof (USBD_MS_OS_StringDescriptor);
|
||
return USBD_MS_OS_StringDescriptor;
|
||
} else if (USBD_IDX_ODRIVE_INTF_STR == index) {
|
||
USBD_GetString((uint8_t *)USBD_PRODUCT_XSTR(NATIVE_STRING), USBD_StrDesc, length);
|
||
return USBD_StrDesc;
|
||
}
|
||
return NULL;
|
||
}
|
||
|
||
/* USER CODE END 0 */
|
||
|
||
/** @defgroup USBD_DESC_Private_Macros USBD_DESC_Private_Macros
|
||
* @brief Private macros.
|
||
* @{
|
||
*/
|
||
|
||
/* USER CODE BEGIN PRIVATE_MACRO */
|
||
|
||
/* USER CODE END PRIVATE_MACRO */
|
||
|
||
/**
|
||
* @}
|
||
*/
|
||
|
||
/** @defgroup USBD_DESC_Private_FunctionPrototypes USBD_DESC_Private_FunctionPrototypes
|
||
* @brief Private functions declaration.
|
||
* @{
|
||
*/
|
||
|
||
uint8_t * USBD_FS_DeviceDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
|
||
uint8_t * USBD_FS_LangIDStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
|
||
uint8_t * USBD_FS_ManufacturerStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
|
||
uint8_t * USBD_FS_ProductStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
|
||
uint8_t * USBD_FS_SerialStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
|
||
uint8_t * USBD_FS_ConfigStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
|
||
uint8_t * USBD_FS_InterfaceStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
|
||
|
||
#ifdef USB_SUPPORT_USER_STRING_DESC
|
||
uint8_t * USBD_FS_USRStringDesc(USBD_SpeedTypeDef speed, uint8_t idx, uint16_t *length);
|
||
#endif /* USB_SUPPORT_USER_STRING_DESC */
|
||
|
||
#if (USBD_LPM_ENABLED == 1)
|
||
uint8_t * USBD_FS_USR_BOSDescriptor(USBD_SpeedTypeDef speed, uint16_t *length);
|
||
#endif /* (USBD_LPM_ENABLED == 1) */
|
||
|
||
/**
|
||
* @}
|
||
*/
|
||
|
||
/** @defgroup USBD_DESC_Private_Variables USBD_DESC_Private_Variables
|
||
* @brief Private variables.
|
||
* @{
|
||
*/
|
||
|
||
USBD_DescriptorsTypeDef FS_Desc =
|
||
{
|
||
USBD_FS_DeviceDescriptor
|
||
, USBD_FS_LangIDStrDescriptor
|
||
, USBD_FS_ManufacturerStrDescriptor
|
||
, USBD_FS_ProductStrDescriptor
|
||
, USBD_FS_SerialStrDescriptor
|
||
, USBD_FS_ConfigStrDescriptor
|
||
, USBD_FS_InterfaceStrDescriptor
|
||
#if (USBD_LPM_ENABLED == 1)
|
||
, USBD_FS_USR_BOSDescriptor
|
||
#endif /* (USBD_LPM_ENABLED == 1) */
|
||
};
|
||
|
||
#if defined ( __ICCARM__ ) /* IAR Compiler */
|
||
#pragma data_alignment=4
|
||
#endif /* defined ( __ICCARM__ ) */
|
||
/** USB standard device descriptor. */
|
||
__ALIGN_BEGIN uint8_t USBD_FS_DeviceDesc[USB_LEN_DEV_DESC] __ALIGN_END =
|
||
{
|
||
0x12, /*bLength */
|
||
USB_DESC_TYPE_DEVICE, /*bDescriptorType*/
|
||
#if (USBD_LPM_ENABLED == 1)
|
||
0x01, /*bcdUSB */ /* changed to USB version 2.01
|
||
in order to support LPM L1 suspend
|
||
resume test of USBCV3.0*/
|
||
#else
|
||
0x00, /*bcdUSB */
|
||
#endif /* (USBD_LPM_ENABLED == 1) */
|
||
0x02,
|
||
// Notify OS that this is a composite device
|
||
0xEF, /*bDeviceClass*/
|
||
0x02, /*bDeviceSubClass*/
|
||
0x01, /*bDeviceProtocol*/
|
||
USB_MAX_EP0_SIZE, /*bMaxPacketSize*/
|
||
LOBYTE(USBD_VID), /*idVendor*/
|
||
HIBYTE(USBD_VID), /*idVendor*/
|
||
LOBYTE(USBD_PID_FS), /*idProduct*/
|
||
HIBYTE(USBD_PID_FS), /*idProduct*/
|
||
0x00, /*bcdDevice rel. 2.00*/
|
||
0x03, /* bNumInterfaces */
|
||
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*/
|
||
};
|
||
|
||
/* USB_DeviceDescriptor */
|
||
/** BOS descriptor. */
|
||
#if (USBD_LPM_ENABLED == 1)
|
||
#if defined ( __ICCARM__ ) /* IAR Compiler */
|
||
#pragma data_alignment=4
|
||
#endif /* defined ( __ICCARM__ ) */
|
||
__ALIGN_BEGIN uint8_t USBD_FS_BOSDesc[USB_SIZ_BOS_DESC] __ALIGN_END =
|
||
{
|
||
0x5,
|
||
USB_DESC_TYPE_BOS,
|
||
0xC,
|
||
0x0,
|
||
0x1, /* 1 device capability*/
|
||
/* device capability*/
|
||
0x7,
|
||
USB_DEVICE_CAPABITY_TYPE,
|
||
0x2,
|
||
0x2, /* LPM capability bit set*/
|
||
0x0,
|
||
0x0,
|
||
0x0
|
||
};
|
||
#endif /* (USBD_LPM_ENABLED == 1) */
|
||
|
||
/**
|
||
* @}
|
||
*/
|
||
|
||
/** @defgroup USBD_DESC_Private_Variables USBD_DESC_Private_Variables
|
||
* @brief Private variables.
|
||
* @{
|
||
*/
|
||
|
||
#if defined ( __ICCARM__ ) /* IAR Compiler */
|
||
#pragma data_alignment=4
|
||
#endif /* defined ( __ICCARM__ ) */
|
||
|
||
/** USB lang indentifier descriptor. */
|
||
__ALIGN_BEGIN 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)
|
||
};
|
||
|
||
#if defined ( __ICCARM__ ) /* IAR Compiler */
|
||
#pragma data_alignment=4
|
||
#endif /* defined ( __ICCARM__ ) */
|
||
/* Internal string descriptor. */
|
||
__ALIGN_BEGIN uint8_t USBD_StrDesc[USBD_MAX_STR_DESC_SIZ] __ALIGN_END;
|
||
|
||
/**
|
||
* @}
|
||
*/
|
||
|
||
/** @defgroup USBD_DESC_Private_Functions USBD_DESC_Private_Functions
|
||
* @brief Private functions.
|
||
* @{
|
||
*/
|
||
|
||
/**
|
||
* @brief Return the device descriptor
|
||
* @param speed : Current device speed
|
||
* @param length : Pointer to data length variable
|
||
* @retval Pointer to descriptor buffer
|
||
*/
|
||
uint8_t * USBD_FS_DeviceDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
|
||
{
|
||
*length = sizeof(USBD_FS_DeviceDesc);
|
||
return USBD_FS_DeviceDesc;
|
||
}
|
||
|
||
/**
|
||
* @brief Return the LangID string descriptor
|
||
* @param speed : Current device speed
|
||
* @param length : Pointer to data length variable
|
||
* @retval Pointer to descriptor buffer
|
||
*/
|
||
uint8_t * USBD_FS_LangIDStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
|
||
{
|
||
*length = sizeof(USBD_LangIDDesc);
|
||
return USBD_LangIDDesc;
|
||
}
|
||
|
||
/**
|
||
* @brief Return the product string descriptor
|
||
* @param speed : Current device speed
|
||
* @param length : Pointer to data length variable
|
||
* @retval Pointer to descriptor buffer
|
||
*/
|
||
uint8_t * USBD_FS_ProductStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
|
||
{
|
||
if(speed == 0)
|
||
{
|
||
USBD_GetString((uint8_t *)USBD_PRODUCT_XSTR(USBD_PRODUCT_STRING_FS), USBD_StrDesc, length);
|
||
}
|
||
else
|
||
{
|
||
USBD_GetString((uint8_t *)USBD_PRODUCT_XSTR(USBD_PRODUCT_STRING_FS), USBD_StrDesc, length);
|
||
}
|
||
return USBD_StrDesc;
|
||
}
|
||
|
||
/**
|
||
* @brief Return the manufacturer string descriptor
|
||
* @param speed : Current device speed
|
||
* @param length : Pointer to data length variable
|
||
* @retval Pointer to descriptor buffer
|
||
*/
|
||
uint8_t * USBD_FS_ManufacturerStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
|
||
{
|
||
USBD_GetString((uint8_t *)USBD_MANUFACTURER_STRING, USBD_StrDesc, length);
|
||
return USBD_StrDesc;
|
||
}
|
||
|
||
/**
|
||
* @brief Return the serial number string descriptor
|
||
* @param speed : Current device speed
|
||
* @param length : Pointer to data length variable
|
||
* @retval Pointer to descriptor buffer
|
||
*/
|
||
uint8_t * USBD_FS_SerialStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
|
||
{
|
||
USBD_GetString ((uint8_t *)serial_number_str, USBD_StrDesc, length);
|
||
return USBD_StrDesc;
|
||
}
|
||
|
||
/**
|
||
* @brief Return the configuration string descriptor
|
||
* @param speed : Current device speed
|
||
* @param length : Pointer to data length variable
|
||
* @retval Pointer to descriptor buffer
|
||
*/
|
||
uint8_t * USBD_FS_ConfigStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
|
||
{
|
||
if(speed == USBD_SPEED_HIGH)
|
||
{
|
||
USBD_GetString((uint8_t *)USBD_CONFIGURATION_STRING_FS, USBD_StrDesc, length);
|
||
}
|
||
else
|
||
{
|
||
USBD_GetString((uint8_t *)USBD_CONFIGURATION_STRING_FS, USBD_StrDesc, length);
|
||
}
|
||
return USBD_StrDesc;
|
||
}
|
||
|
||
/**
|
||
* @brief Return the interface string descriptor
|
||
* @param speed : Current device speed
|
||
* @param length : Pointer to data length variable
|
||
* @retval Pointer to descriptor buffer
|
||
*/
|
||
uint8_t * USBD_FS_InterfaceStrDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
|
||
{
|
||
if(speed == 0)
|
||
{
|
||
USBD_GetString((uint8_t *)USBD_INTERFACE_STRING_FS, USBD_StrDesc, length);
|
||
}
|
||
else
|
||
{
|
||
USBD_GetString((uint8_t *)USBD_INTERFACE_STRING_FS, USBD_StrDesc, length);
|
||
}
|
||
return USBD_StrDesc;
|
||
}
|
||
|
||
#if (USBD_LPM_ENABLED == 1)
|
||
/**
|
||
* @brief Return the BOS descriptor
|
||
* @param speed : Current device speed
|
||
* @param length : Pointer to data length variable
|
||
* @retval Pointer to descriptor buffer
|
||
*/
|
||
uint8_t * USBD_FS_USR_BOSDescriptor(USBD_SpeedTypeDef speed, uint16_t *length)
|
||
{
|
||
*length = sizeof(USBD_FS_BOSDesc);
|
||
return (uint8_t*)USBD_FS_BOSDesc;
|
||
}
|
||
#endif /* (USBD_LPM_ENABLED == 1) */
|
||
|
||
/**
|
||
* @}
|
||
*/
|
||
|
||
/**
|
||
* @}
|
||
*/
|
||
|
||
/**
|
||
* @}
|
||
*/
|
||
|
||
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
|