src/main/vcp/usb_prop.c

   1 /**
   2  ******************************************************************************
   3  * @file    usb_prop.c
   4  * @author  MCD Application Team
   5  * @version V4.0.0
   6  * @date    21-January-2013
   7  * @brief   All processing related to Virtual Com Port Demo
   8  ******************************************************************************
   9  * @attention
  10  *
  11  * <h2><center>&copy; COPYRIGHT 2013 STMicroelectronics</center></h2>
  12  *
  13  * Licensed under MCD-ST Liberty SW License Agreement V2, (the "License");
  14  * You may not use this file except in compliance with the License.
  15  * You may obtain a copy of the License at:
  16  *
  17  *        http://www.st.com/software_license_agreement_liberty_v2
  18  *
  19  * Unless required by applicable law or agreed to in writing, software
  20  * distributed under the License is distributed on an "AS IS" BASIS,
  21  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  22  * See the License for the specific language governing permissions and
  23  * limitations under the License.
  24  *
  25  ******************************************************************************
  26  */
  27
  28 /* Includes ------------------------------------------------------------------*/
  29
  30 #include "platform.h"
  31
  32 #include "usb_lib.h"
  33 #include "usb_conf.h"
  34 #include "usb_prop.h"
  35 #include "usb_desc.h"
  36 #include "usb_pwr.h"
  37 #include "hw_config.h"
  38
  39 /* Private typedef -----------------------------------------------------------*/
  40 /* Private define ------------------------------------------------------------*/
  41 /* Private macro -------------------------------------------------------------*/
  42 /* Private variables ---------------------------------------------------------*/
  43 uint8_t Request = 0;
  44
  45 LINE_CODING linecoding = { 115200, /* baud rate*/
  46 0x00, /* stop bits-1*/
  47 0x00, /* parity - none*/
  48 0x08 /* no. of bits 8*/
  49 };
  50
  51 /* -------------------------------------------------------------------------- */
  52 /*  Structures initializations */
  53 /* -------------------------------------------------------------------------- */
  54
  55 DEVICE Device_Table = {
  56 EP_NUM, 1 };
  57
  58 DEVICE_PROP Device_Property = { Virtual_Com_Port_init, Virtual_Com_Port_Reset, Virtual_Com_Port_Status_In, Virtual_Com_Port_Status_Out, Virtual_Com_Port_Data_Setup, Virtual_Com_Port_NoData_Setup, Virtual_Com_Port_Get_Interface_Setting, Virtual_Com_Port_GetDeviceDescriptor,
  59         Virtual_Com_Port_GetConfigDescriptor, Virtual_Com_Port_GetStringDescriptor, 0, 0x40 /*MAX PACKET SIZE*/
  60 };
  61
  62 USER_STANDARD_REQUESTS User_Standard_Requests = {
  63 Virtual_Com_Port_GetConfiguration, Virtual_Com_Port_SetConfiguration,
  64 Virtual_Com_Port_GetInterface,
  65 Virtual_Com_Port_SetInterface,
  66 Virtual_Com_Port_GetStatus,
  67 Virtual_Com_Port_ClearFeature,
  68 Virtual_Com_Port_SetEndPointFeature,
  69 Virtual_Com_Port_SetDeviceFeature, Virtual_Com_Port_SetDeviceAddress };
  70
  71 ONE_DESCRIPTOR Device_Descriptor = { (uint8_t*)Virtual_Com_Port_DeviceDescriptor,
  72 VIRTUAL_COM_PORT_SIZ_DEVICE_DESC };
  73
  74 ONE_DESCRIPTOR Config_Descriptor = { (uint8_t*)Virtual_Com_Port_ConfigDescriptor,
  75 VIRTUAL_COM_PORT_SIZ_CONFIG_DESC };
  76
  77 ONE_DESCRIPTOR String_Descriptor[4] = { { (uint8_t*)Virtual_Com_Port_StringLangID, VIRTUAL_COM_PORT_SIZ_STRING_LANGID }, { (uint8_t*)Virtual_Com_Port_StringVendor, VIRTUAL_COM_PORT_SIZ_STRING_VENDOR }, { (uint8_t*)Virtual_Com_Port_StringProduct,
  78         VIRTUAL_COM_PORT_SIZ_STRING_PRODUCT }, { (uint8_t*)Virtual_Com_Port_StringSerial, VIRTUAL_COM_PORT_SIZ_STRING_SERIAL } };
  79
  80 /* Extern variables ----------------------------------------------------------*/
  81 /* Private function prototypes -----------------------------------------------*/
  82 /* Extern function prototypes ------------------------------------------------*/
  83 /* Private functions ---------------------------------------------------------*/
  84 /*******************************************************************************
  85  * Function Name  : Virtual_Com_Port_init.
  86  * Description    : Virtual COM Port Mouse init routine.
  87  * Input          : None.
  88  * Output         : None.
  89  * Return         : None.
  90  *******************************************************************************/
  91 void Virtual_Com_Port_init(void)
  92 {
  93 #ifdef STM32F10X
  94     /* Make absolutly sure interrupts are disabled. */
  95     USB_Interrupts_Disable();
  96 #endif
  97
  98     /* Update the serial number string descriptor with the data from the unique
  99      ID*/
 100     Get_SerialNum();
 101
 102     pInformation->Current_Configuration = 0;
 103
 104     /* Connect the device */
 105     PowerOn();
 106
 107     /* Perform basic device initialization operations */
 108     USB_SIL_Init();
 109
 110     bDeviceState = UNCONNECTED;
 111 }
 112
 113 /*******************************************************************************
 114  * Function Name  : Virtual_Com_Port_Reset
 115  * Description    : Virtual_Com_Port Mouse reset routine
 116  * Input          : None.
 117  * Output         : None.
 118  * Return         : None.
 119  *******************************************************************************/
 120 void Virtual_Com_Port_Reset(void)
 121 {
 122     /* Set Virtual_Com_Port DEVICE as not configured */
 123     pInformation->Current_Configuration = 0;
 124
 125     /* Current Feature initialization */
 126     pInformation->Current_Feature = Virtual_Com_Port_ConfigDescriptor[7];
 127
 128     /* Set Virtual_Com_Port DEVICE with the default Interface*/
 129     pInformation->Current_Interface = 0;
 130
 131     SetBTABLE(BTABLE_ADDRESS);
 132
 133     /* Initialize Endpoint 0 */
 134     SetEPType(ENDP0, EP_CONTROL);
 135     SetEPTxStatus(ENDP0, EP_TX_STALL);
 136     SetEPRxAddr(ENDP0, ENDP0_RXADDR);
 137     SetEPTxAddr(ENDP0, ENDP0_TXADDR);
 138     Clear_Status_Out(ENDP0);
 139     SetEPRxCount(ENDP0, Device_Property.MaxPacketSize);
 140     SetEPRxValid(ENDP0);
 141
 142     /* Initialize Endpoint 1 */
 143     SetEPType(ENDP1, EP_BULK);
 144     SetEPTxAddr(ENDP1, ENDP1_TXADDR);
 145     SetEPTxStatus(ENDP1, EP_TX_NAK);
 146     SetEPRxStatus(ENDP1, EP_RX_DIS);
 147
 148     /* Initialize Endpoint 2 */
 149     SetEPType(ENDP2, EP_INTERRUPT);
 150     SetEPTxAddr(ENDP2, ENDP2_TXADDR);
 151     SetEPRxStatus(ENDP2, EP_RX_DIS);
 152     SetEPTxStatus(ENDP2, EP_TX_NAK);
 153
 154     /* Initialize Endpoint 3 */
 155     SetEPType(ENDP3, EP_BULK);
 156     SetEPRxAddr(ENDP3, ENDP3_RXADDR);
 157     SetEPRxCount(ENDP3, VIRTUAL_COM_PORT_DATA_SIZE);
 158     SetEPRxStatus(ENDP3, EP_RX_VALID);
 159     SetEPTxStatus(ENDP3, EP_TX_DIS);
 160
 161     /* Set this device to response on default address */
 162     SetDeviceAddress(0);
 163
 164     bDeviceState = ATTACHED;
 165 }
 166
 167 /*******************************************************************************
 168  * Function Name  : Virtual_Com_Port_SetConfiguration.
 169  * Description    : Update the device state to configured.
 170  * Input          : None.
 171  * Output         : None.
 172  * Return         : None.
 173  *******************************************************************************/
 174 void Virtual_Com_Port_SetConfiguration(void)
 175 {
 176     DEVICE_INFO *pInfo = &Device_Info;
 177
 178     if (pInfo->Current_Configuration != 0) {
 179         /* Device configured */
 180         bDeviceState = CONFIGURED;
 181     }
 182 }
 183
 184 /*******************************************************************************
 185  * Function Name  : Virtual_Com_Port_SetConfiguration.
 186  * Description    : Update the device state to addressed.
 187  * Input          : None.
 188  * Output         : None.
 189  * Return         : None.
 190  *******************************************************************************/
 191 void Virtual_Com_Port_SetDeviceAddress(void)
 192 {
 193     bDeviceState = ADDRESSED;
 194 }
 195
 196 /*******************************************************************************
 197  * Function Name  : Virtual_Com_Port_Status_In.
 198  * Description    : Virtual COM Port Status In Routine.
 199  * Input          : None.
 200  * Output         : None.
 201  * Return         : None.
 202  *******************************************************************************/
 203 void Virtual_Com_Port_Status_In(void)
 204 {
 205     if (Request == SET_LINE_CODING) {
 206         Request = 0;
 207     }
 208 }
 209
 210 /*******************************************************************************
 211  * Function Name  : Virtual_Com_Port_Status_Out
 212  * Description    : Virtual COM Port Status OUT Routine.
 213  * Input          : None.
 214  * Output         : None.
 215  * Return         : None.
 216  *******************************************************************************/
 217 void Virtual_Com_Port_Status_Out(void)
 218 {
 219 }
 220
 221 /*******************************************************************************
 222  * Function Name  : Virtual_Com_Port_Data_Setup
 223  * Description    : handle the data class specific requests
 224  * Input          : Request Nb.
 225  * Output         : None.
 226  * Return         : USB_UNSUPPORT or USB_SUCCESS.
 227  *******************************************************************************/
 228 RESULT Virtual_Com_Port_Data_Setup(uint8_t RequestNo)
 229 {
 230     uint8_t *(*CopyRoutine)( uint16_t);
 231
 232     CopyRoutine = NULL;
 233
 234     if (RequestNo == GET_LINE_CODING) {
 235         if (Type_Recipient == (CLASS_REQUEST | INTERFACE_RECIPIENT)) {
 236             CopyRoutine = Virtual_Com_Port_GetLineCoding;
 237         }
 238     } else if (RequestNo == SET_LINE_CODING) {
 239         if (Type_Recipient == (CLASS_REQUEST | INTERFACE_RECIPIENT)) {
 240             CopyRoutine = Virtual_Com_Port_SetLineCoding;
 241         }
 242         Request = SET_LINE_CODING;
 243     }
 244
 245     if (CopyRoutine == NULL) {
 246         return USB_UNSUPPORT;
 247     }
 248
 249     pInformation->Ctrl_Info.CopyData = CopyRoutine;
 250     pInformation->Ctrl_Info.Usb_wOffset = 0;
 251     (*CopyRoutine)(0);
 252     return USB_SUCCESS;
 253 }
 254
 255 /*******************************************************************************
 256  * Function Name  : Virtual_Com_Port_NoData_Setup.
 257  * Description    : handle the no data class specific requests.
 258  * Input          : Request Nb.
 259  * Output         : None.
 260  * Return         : USB_UNSUPPORT or USB_SUCCESS.
 261  *******************************************************************************/
 262 RESULT Virtual_Com_Port_NoData_Setup(uint8_t RequestNo)
 263 {
 264
 265     if (Type_Recipient == (CLASS_REQUEST | INTERFACE_RECIPIENT)) {
 266         if (RequestNo == SET_COMM_FEATURE) {
 267             return USB_SUCCESS;
 268         } else if (RequestNo == SET_CONTROL_LINE_STATE) {
 269             return USB_SUCCESS;
 270         }
 271     }
 272
 273     return USB_UNSUPPORT;
 274 }
 275
 276 /*******************************************************************************
 277  * Function Name  : Virtual_Com_Port_GetDeviceDescriptor.
 278  * Description    : Gets the device descriptor.
 279  * Input          : Length.
 280  * Output         : None.
 281  * Return         : The address of the device descriptor.
 282  *******************************************************************************/
 283 uint8_t *Virtual_Com_Port_GetDeviceDescriptor(uint16_t Length)
 284 {
 285     return Standard_GetDescriptorData(Length, &Device_Descriptor);
 286 }
 287
 288 /*******************************************************************************
 289  * Function Name  : Virtual_Com_Port_GetConfigDescriptor.
 290  * Description    : get the configuration descriptor.
 291  * Input          : Length.
 292  * Output         : None.
 293  * Return         : The address of the configuration descriptor.
 294  *******************************************************************************/
 295 uint8_t *Virtual_Com_Port_GetConfigDescriptor(uint16_t Length)
 296 {
 297     return Standard_GetDescriptorData(Length, &Config_Descriptor);
 298 }
 299
 300 /*******************************************************************************
 301  * Function Name  : Virtual_Com_Port_GetStringDescriptor
 302  * Description    : Gets the string descriptors according to the needed index
 303  * Input          : Length.
 304  * Output         : None.
 305  * Return         : The address of the string descriptors.
 306  *******************************************************************************/
 307 uint8_t *Virtual_Com_Port_GetStringDescriptor(uint16_t Length)
 308 {
 309     uint8_t wValue0 = pInformation->USBwValue0;
 310     if (wValue0 > 4) {
 311         return NULL;
 312     } else {
 313         return Standard_GetDescriptorData(Length, &String_Descriptor[wValue0]);
 314     }
 315 }
 316
 317 /*******************************************************************************
 318  * Function Name  : Virtual_Com_Port_Get_Interface_Setting.
 319  * Description    : test the interface and the alternate setting according to the
 320  *                  supported one.
 321  * Input1         : uint8_t: Interface : interface number.
 322  * Input2         : uint8_t: AlternateSetting : Alternate Setting number.
 323  * Output         : None.
 324  * Return         : The address of the string descriptors.
 325  *******************************************************************************/
 326 RESULT Virtual_Com_Port_Get_Interface_Setting(uint8_t Interface, uint8_t AlternateSetting)
 327 {
 328     if (AlternateSetting > 0) {
 329         return USB_UNSUPPORT;
 330     } else if (Interface > 1) {
 331         return USB_UNSUPPORT;
 332     }
 333     return USB_SUCCESS;
 334 }
 335
 336 /*******************************************************************************
 337  * Function Name  : Virtual_Com_Port_GetLineCoding.
 338  * Description    : send the linecoding structure to the PC host.
 339  * Input          : Length.
 340  * Output         : None.
 341  * Return         : Linecoding structure base address.
 342  *******************************************************************************/
 343 uint8_t *Virtual_Com_Port_GetLineCoding(uint16_t Length)
 344 {
 345     if (Length == 0) {
 346         pInformation->Ctrl_Info.Usb_wLength = sizeof(linecoding);
 347         return NULL;
 348     }
 349     return (uint8_t *)&linecoding;
 350 }
 351
 352 /*******************************************************************************
 353  * Function Name  : Virtual_Com_Port_SetLineCoding.
 354  * Description    : Set the linecoding structure fields.
 355  * Input          : Length.
 356  * Output         : None.
 357  * Return         : Linecoding structure base address.
 358  *******************************************************************************/
 359 uint8_t *Virtual_Com_Port_SetLineCoding(uint16_t Length)
 360 {
 361     if (Length == 0) {
 362         pInformation->Ctrl_Info.Usb_wLength = sizeof(linecoding);
 363         return NULL;
 364     }
 365     return (uint8_t *)&linecoding;
 366 }
 367
 368 /*******************************************************************************
 369  * Function Name  : Virtual_Com_Port_GetBaudRate.
 370  * Description    : Get the current baudrate
 371  * Input          : None.
 372  * Output         : None.
 373  * Return         : baudrate in bps
 374  *******************************************************************************/
 375 uint32_t Virtual_Com_Port_GetBaudRate(void)
 376 {
 377     return linecoding.bitrate;
 378 }
 379
 380 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/