2 ******************************************************************************
5 * @brief : This file implements the board support package for the USB device library
6 ******************************************************************************
7 * This notice applies to any and all portions of this file
8 * that are not between comment pairs USER CODE BEGIN and
9 * USER CODE END. Other portions of this file, whether
10 * inserted by the user or by software development tools
11 * are owned by their respective copyright owners.
13 * Copyright (c) 2018 STMicroelectronics International N.V.
14 * All rights reserved.
16 * Redistribution and use in source and binary forms, with or without
17 * modification, are permitted, provided that the following conditions are met:
19 * 1. Redistribution of source code must retain the above copyright notice,
20 * this list of conditions and the following disclaimer.
21 * 2. Redistributions in binary form must reproduce the above copyright notice,
22 * this list of conditions and the following disclaimer in the documentation
23 * and/or other materials provided with the distribution.
24 * 3. Neither the name of STMicroelectronics nor the names of other
25 * contributors to this software may be used to endorse or promote products
26 * derived from this software without specific written permission.
27 * 4. This software, including modifications and/or derivative works of this
28 * software, must execute solely and exclusively on microcontroller or
29 * microprocessor devices manufactured by or for STMicroelectronics.
30 * 5. Redistribution and use of this software other than as permitted under
31 * this license is void and will automatically terminate your rights under
34 * THIS SOFTWARE IS PROVIDED BY STMICROELECTRONICS AND CONTRIBUTORS "AS IS"
35 * AND ANY EXPRESS, IMPLIED OR STATUTORY WARRANTIES, INCLUDING, BUT NOT
36 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
37 * PARTICULAR PURPOSE AND NON-INFRINGEMENT OF THIRD PARTY INTELLECTUAL PROPERTY
38 * RIGHTS ARE DISCLAIMED TO THE FULLEST EXTENT PERMITTED BY LAW. IN NO EVENT
39 * SHALL STMICROELECTRONICS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
40 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
42 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
43 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
44 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
45 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
47 ******************************************************************************
50 /* Includes ------------------------------------------------------------------*/
51 #include "stm32f1xx.h"
52 #include "stm32f1xx_hal.h"
54 #include "usbd_core.h"
57 /* USER CODE BEGIN Includes */
59 /* USER CODE END Includes */
61 /* Private typedef -----------------------------------------------------------*/
62 /* Private define ------------------------------------------------------------*/
63 /* Private macro -------------------------------------------------------------*/
65 /* USER CODE BEGIN PV */
66 /* Private variables ---------------------------------------------------------*/
68 /* USER CODE END PV */
70 PCD_HandleTypeDef hpcd_USB_FS;
71 void _Error_Handler(char * file, int line);
73 /* USER CODE BEGIN 0 */
77 /* USER CODE BEGIN PFP */
78 /* Private function prototypes -----------------------------------------------*/
80 /* USER CODE END PFP */
82 /* Private functions ---------------------------------------------------------*/
84 /* USER CODE BEGIN 1 */
88 void HAL_PCDEx_SetConnectionState(PCD_HandleTypeDef *hpcd, uint8_t state);
90 /*******************************************************************************
91 LL Driver Callbacks (PCD -> USB Device Library)
92 *******************************************************************************/
95 void HAL_PCD_MspInit(PCD_HandleTypeDef* pcdHandle)
97 if(pcdHandle->Instance==USB)
99 /* USER CODE BEGIN USB_MspInit 0 */
101 /* USER CODE END USB_MspInit 0 */
102 /* Peripheral clock enable */
103 __HAL_RCC_USB_CLK_ENABLE();
105 /* Peripheral interrupt init */
106 HAL_NVIC_SetPriority(USB_HP_CAN1_TX_IRQn, 0, 0);
107 HAL_NVIC_EnableIRQ(USB_HP_CAN1_TX_IRQn);
108 HAL_NVIC_SetPriority(USB_LP_CAN1_RX0_IRQn, 0, 0);
109 HAL_NVIC_EnableIRQ(USB_LP_CAN1_RX0_IRQn);
110 /* USER CODE BEGIN USB_MspInit 1 */
112 /* USER CODE END USB_MspInit 1 */
116 void HAL_PCD_MspDeInit(PCD_HandleTypeDef* pcdHandle)
118 if(pcdHandle->Instance==USB)
120 /* USER CODE BEGIN USB_MspDeInit 0 */
122 /* USER CODE END USB_MspDeInit 0 */
123 /* Peripheral clock disable */
124 __HAL_RCC_USB_CLK_DISABLE();
126 /* Peripheral interrupt Deinit*/
127 HAL_NVIC_DisableIRQ(USB_HP_CAN1_TX_IRQn);
129 HAL_NVIC_DisableIRQ(USB_LP_CAN1_RX0_IRQn);
131 /* USER CODE BEGIN USB_MspDeInit 1 */
133 /* USER CODE END USB_MspDeInit 1 */
138 * @brief Setup stage callback
139 * @param hpcd: PCD handle
142 void HAL_PCD_SetupStageCallback(PCD_HandleTypeDef *hpcd)
144 USBD_LL_SetupStage((USBD_HandleTypeDef*)hpcd->pData, (uint8_t *)hpcd->Setup);
148 * @brief Data Out stage callback.
149 * @param hpcd: PCD handle
150 * @param epnum: Endpoint number
153 void HAL_PCD_DataOutStageCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum)
155 USBD_LL_DataOutStage((USBD_HandleTypeDef*)hpcd->pData, epnum, hpcd->OUT_ep[epnum].xfer_buff);
159 * @brief Data In stage callback.
160 * @param hpcd: PCD handle
161 * @param epnum: Endpoint number
164 void HAL_PCD_DataInStageCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum)
166 USBD_LL_DataInStage((USBD_HandleTypeDef*)hpcd->pData, epnum, hpcd->IN_ep[epnum].xfer_buff);
170 * @brief SOF callback.
171 * @param hpcd: PCD handle
174 void HAL_PCD_SOFCallback(PCD_HandleTypeDef *hpcd)
176 USBD_LL_SOF((USBD_HandleTypeDef*)hpcd->pData);
180 * @brief Reset callback.
181 * @param hpcd: PCD handle
184 void HAL_PCD_ResetCallback(PCD_HandleTypeDef *hpcd)
186 USBD_SpeedTypeDef speed = USBD_SPEED_FULL;
188 /* Set USB current speed. */
189 switch (hpcd->Init.speed)
192 speed = USBD_SPEED_FULL;
196 speed = USBD_SPEED_FULL;
199 USBD_LL_SetSpeed((USBD_HandleTypeDef*)hpcd->pData, speed);
202 USBD_LL_Reset((USBD_HandleTypeDef*)hpcd->pData);
206 * @brief Suspend callback.
207 * When Low power mode is enabled the debug cannot be used (IAR, Keil doesn't support it)
208 * @param hpcd: PCD handle
211 void HAL_PCD_SuspendCallback(PCD_HandleTypeDef *hpcd)
213 /* Inform USB library that core enters in suspend Mode. */
214 USBD_LL_Suspend((USBD_HandleTypeDef*)hpcd->pData);
215 /* Enter in STOP mode. */
216 /* USER CODE BEGIN 2 */
217 if (hpcd->Init.low_power_enable)
219 /* Set SLEEPDEEP bit and SleepOnExit of Cortex System Control Register. */
220 SCB->SCR |= (uint32_t)((uint32_t)(SCB_SCR_SLEEPDEEP_Msk | SCB_SCR_SLEEPONEXIT_Msk));
222 /* USER CODE END 2 */
226 * @brief Resume callback.
227 * When Low power mode is enabled the debug cannot be used (IAR, Keil doesn't support it)
228 * @param hpcd: PCD handle
231 void HAL_PCD_ResumeCallback(PCD_HandleTypeDef *hpcd)
233 /* USER CODE BEGIN 3 */
235 /* USER CODE END 3 */
236 USBD_LL_Resume((USBD_HandleTypeDef*)hpcd->pData);
240 * @brief ISOOUTIncomplete callback.
241 * @param hpcd: PCD handle
242 * @param epnum: Endpoint number
245 void HAL_PCD_ISOOUTIncompleteCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum)
247 USBD_LL_IsoOUTIncomplete((USBD_HandleTypeDef*)hpcd->pData, epnum);
251 * @brief ISOINIncomplete callback.
252 * @param hpcd: PCD handle
253 * @param epnum: Endpoint number
256 void HAL_PCD_ISOINIncompleteCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum)
258 USBD_LL_IsoINIncomplete((USBD_HandleTypeDef*)hpcd->pData, epnum);
262 * @brief Connect callback.
263 * @param hpcd: PCD handle
266 void HAL_PCD_ConnectCallback(PCD_HandleTypeDef *hpcd)
268 USBD_LL_DevConnected((USBD_HandleTypeDef*)hpcd->pData);
272 * @brief Disconnect callback.
273 * @param hpcd: PCD handle
276 void HAL_PCD_DisconnectCallback(PCD_HandleTypeDef *hpcd)
278 USBD_LL_DevDisconnected((USBD_HandleTypeDef*)hpcd->pData);
281 /*******************************************************************************
282 LL Driver Interface (USB Device Library --> PCD)
283 *******************************************************************************/
286 * @brief Initializes the low level portion of the device driver.
287 * @param pdev: Device handle
288 * @retval USBD status
290 USBD_StatusTypeDef USBD_LL_Init(USBD_HandleTypeDef *pdev)
293 /* Link the driver to the stack. */
294 hpcd_USB_FS.pData = pdev;
295 pdev->pData = &hpcd_USB_FS;
297 hpcd_USB_FS.Instance = USB;
298 hpcd_USB_FS.Init.dev_endpoints = 8;
299 hpcd_USB_FS.Init.speed = PCD_SPEED_FULL;
300 hpcd_USB_FS.Init.ep0_mps = DEP0CTL_MPS_64;
301 hpcd_USB_FS.Init.low_power_enable = DISABLE;
302 hpcd_USB_FS.Init.lpm_enable = DISABLE;
303 hpcd_USB_FS.Init.battery_charging_enable = DISABLE;
304 if (HAL_PCD_Init(&hpcd_USB_FS) != HAL_OK)
306 _Error_Handler(__FILE__, __LINE__);
309 HAL_PCDEx_PMAConfig((PCD_HandleTypeDef*)pdev->pData , 0x00 , PCD_SNG_BUF, 0x18);
310 HAL_PCDEx_PMAConfig((PCD_HandleTypeDef*)pdev->pData , 0x80 , PCD_SNG_BUF, 0x58);
315 * @brief De-Initializes the low level portion of the device driver.
316 * @param pdev: Device handle
317 * @retval USBD status
319 USBD_StatusTypeDef USBD_LL_DeInit(USBD_HandleTypeDef *pdev)
321 HAL_StatusTypeDef hal_status = HAL_OK;
322 USBD_StatusTypeDef usb_status = USBD_OK;
324 hal_status = HAL_PCD_DeInit(pdev->pData);
326 switch (hal_status) {
328 usb_status = USBD_OK;
331 usb_status = USBD_FAIL;
334 usb_status = USBD_BUSY;
337 usb_status = USBD_FAIL;
340 usb_status = USBD_FAIL;
347 * @brief Starts the low level portion of the device driver.
348 * @param pdev: Device handle
349 * @retval USBD status
351 USBD_StatusTypeDef USBD_LL_Start(USBD_HandleTypeDef *pdev)
353 HAL_StatusTypeDef hal_status = HAL_OK;
354 USBD_StatusTypeDef usb_status = USBD_OK;
356 hal_status = HAL_PCD_Start(pdev->pData);
358 switch (hal_status) {
360 usb_status = USBD_OK;
363 usb_status = USBD_FAIL;
366 usb_status = USBD_BUSY;
369 usb_status = USBD_FAIL;
372 usb_status = USBD_FAIL;
379 * @brief Stops the low level portion of the device driver.
380 * @param pdev: Device handle
381 * @retval USBD status
383 USBD_StatusTypeDef USBD_LL_Stop(USBD_HandleTypeDef *pdev)
385 HAL_StatusTypeDef hal_status = HAL_OK;
386 USBD_StatusTypeDef usb_status = USBD_OK;
388 hal_status = HAL_PCD_Stop(pdev->pData);
390 switch (hal_status) {
392 usb_status = USBD_OK;
395 usb_status = USBD_FAIL;
398 usb_status = USBD_BUSY;
401 usb_status = USBD_FAIL;
404 usb_status = USBD_FAIL;
411 * @brief Opens an endpoint of the low level driver.
412 * @param pdev: Device handle
413 * @param ep_addr: Endpoint number
414 * @param ep_type: Endpoint type
415 * @param ep_mps: Endpoint max packet size
416 * @retval USBD status
418 USBD_StatusTypeDef USBD_LL_OpenEP(USBD_HandleTypeDef *pdev, uint8_t ep_addr, uint8_t ep_type, uint16_t ep_mps)
420 HAL_StatusTypeDef hal_status = HAL_OK;
421 USBD_StatusTypeDef usb_status = USBD_OK;
423 hal_status = HAL_PCD_EP_Open(pdev->pData, ep_addr, ep_mps, ep_type);
425 switch (hal_status) {
427 usb_status = USBD_OK;
430 usb_status = USBD_FAIL;
433 usb_status = USBD_BUSY;
436 usb_status = USBD_FAIL;
439 usb_status = USBD_FAIL;
446 * @brief Closes an endpoint of the low level driver.
447 * @param pdev: Device handle
448 * @param ep_addr: Endpoint number
449 * @retval USBD status
451 USBD_StatusTypeDef USBD_LL_CloseEP(USBD_HandleTypeDef *pdev, uint8_t ep_addr)
453 HAL_StatusTypeDef hal_status = HAL_OK;
454 USBD_StatusTypeDef usb_status = USBD_OK;
456 hal_status = HAL_PCD_EP_Close(pdev->pData, ep_addr);
458 switch (hal_status) {
460 usb_status = USBD_OK;
463 usb_status = USBD_FAIL;
466 usb_status = USBD_BUSY;
469 usb_status = USBD_FAIL;
472 usb_status = USBD_FAIL;
479 * @brief Flushes an endpoint of the Low Level Driver.
480 * @param pdev: Device handle
481 * @param ep_addr: Endpoint number
482 * @retval USBD status
484 USBD_StatusTypeDef USBD_LL_FlushEP(USBD_HandleTypeDef *pdev, uint8_t ep_addr)
486 HAL_StatusTypeDef hal_status = HAL_OK;
487 USBD_StatusTypeDef usb_status = USBD_OK;
489 hal_status = HAL_PCD_EP_Flush(pdev->pData, ep_addr);
491 switch (hal_status) {
493 usb_status = USBD_OK;
496 usb_status = USBD_FAIL;
499 usb_status = USBD_BUSY;
502 usb_status = USBD_FAIL;
505 usb_status = USBD_FAIL;
512 * @brief Sets a Stall condition on an endpoint of the Low Level Driver.
513 * @param pdev: Device handle
514 * @param ep_addr: Endpoint number
515 * @retval USBD status
517 USBD_StatusTypeDef USBD_LL_StallEP(USBD_HandleTypeDef *pdev, uint8_t ep_addr)
519 HAL_StatusTypeDef hal_status = HAL_OK;
520 USBD_StatusTypeDef usb_status = USBD_OK;
522 hal_status = HAL_PCD_EP_SetStall(pdev->pData, ep_addr);
524 switch (hal_status) {
526 usb_status = USBD_OK;
529 usb_status = USBD_FAIL;
532 usb_status = USBD_BUSY;
535 usb_status = USBD_FAIL;
538 usb_status = USBD_FAIL;
545 * @brief Clears a Stall condition on an endpoint of the Low Level Driver.
546 * @param pdev: Device handle
547 * @param ep_addr: Endpoint number
548 * @retval USBD status
550 USBD_StatusTypeDef USBD_LL_ClearStallEP(USBD_HandleTypeDef *pdev, uint8_t ep_addr)
552 HAL_StatusTypeDef hal_status = HAL_OK;
553 USBD_StatusTypeDef usb_status = USBD_OK;
555 hal_status = HAL_PCD_EP_ClrStall(pdev->pData, ep_addr);
557 switch (hal_status) {
559 usb_status = USBD_OK;
562 usb_status = USBD_FAIL;
565 usb_status = USBD_BUSY;
568 usb_status = USBD_FAIL;
571 usb_status = USBD_FAIL;
578 * @brief Returns Stall condition.
579 * @param pdev: Device handle
580 * @param ep_addr: Endpoint number
581 * @retval Stall (1: Yes, 0: No)
583 uint8_t USBD_LL_IsStallEP(USBD_HandleTypeDef *pdev, uint8_t ep_addr)
585 PCD_HandleTypeDef *hpcd = (PCD_HandleTypeDef*) pdev->pData;
587 if((ep_addr & 0x80) == 0x80)
589 return hpcd->IN_ep[ep_addr & 0x7F].is_stall;
593 return hpcd->OUT_ep[ep_addr & 0x7F].is_stall;
598 * @brief Assigns a USB address to the device.
599 * @param pdev: Device handle
600 * @param dev_addr: Device address
601 * @retval USBD status
603 USBD_StatusTypeDef USBD_LL_SetUSBAddress(USBD_HandleTypeDef *pdev, uint8_t dev_addr)
605 HAL_StatusTypeDef hal_status = HAL_OK;
606 USBD_StatusTypeDef usb_status = USBD_OK;
608 hal_status = HAL_PCD_SetAddress(pdev->pData, dev_addr);
610 switch (hal_status) {
612 usb_status = USBD_OK;
615 usb_status = USBD_FAIL;
618 usb_status = USBD_BUSY;
621 usb_status = USBD_FAIL;
624 usb_status = USBD_FAIL;
631 * @brief Transmits data over an endpoint.
632 * @param pdev: Device handle
633 * @param ep_addr: Endpoint number
634 * @param pbuf: Pointer to data to be sent
635 * @param size: Data size
636 * @retval USBD status
638 USBD_StatusTypeDef USBD_LL_Transmit(USBD_HandleTypeDef *pdev, uint8_t ep_addr, uint8_t *pbuf, uint16_t size)
640 HAL_StatusTypeDef hal_status = HAL_OK;
641 USBD_StatusTypeDef usb_status = USBD_OK;
643 hal_status = HAL_PCD_EP_Transmit(pdev->pData, ep_addr, pbuf, size);
645 switch (hal_status) {
647 usb_status = USBD_OK;
650 usb_status = USBD_FAIL;
653 usb_status = USBD_BUSY;
656 usb_status = USBD_FAIL;
659 usb_status = USBD_FAIL;
666 * @brief Prepares an endpoint for reception.
667 * @param pdev: Device handle
668 * @param ep_addr: Endpoint number
669 * @param pbuf: Pointer to data to be received
670 * @param size: Data size
671 * @retval USBD status
673 USBD_StatusTypeDef USBD_LL_PrepareReceive(USBD_HandleTypeDef *pdev, uint8_t ep_addr, uint8_t *pbuf, uint16_t size)
675 HAL_StatusTypeDef hal_status = HAL_OK;
676 USBD_StatusTypeDef usb_status = USBD_OK;
678 hal_status = HAL_PCD_EP_Receive(pdev->pData, ep_addr, pbuf, size);
680 switch (hal_status) {
682 usb_status = USBD_OK;
685 usb_status = USBD_FAIL;
688 usb_status = USBD_BUSY;
691 usb_status = USBD_FAIL;
694 usb_status = USBD_FAIL;
701 * @brief Returns the last transfered packet size.
702 * @param pdev: Device handle
703 * @param ep_addr: Endpoint number
704 * @retval Recived Data Size
706 uint32_t USBD_LL_GetRxDataSize(USBD_HandleTypeDef *pdev, uint8_t ep_addr)
708 return HAL_PCD_EP_GetRxCount((PCD_HandleTypeDef*) pdev->pData, ep_addr);
712 * @brief Delays routine for the USB device library.
713 * @param Delay: Delay in ms
716 void USBD_LL_Delay(uint32_t Delay)
722 * @brief Static single allocation.
723 * @param size: Size of allocated memory
726 void *USBD_static_malloc(uint32_t size)
728 static uint32_t mem[(sizeof(USBD_DFU_HandleTypeDef)/4)+1];/* On 32-bit boundary */
733 * @brief Dummy memory free
734 * @param p: Pointer to allocated memory address
737 void USBD_static_free(void *p)
743 * @brief Software Device Connection
744 * @param hpcd: PCD handle
745 * @param state: Connection state (0: disconnected / 1: connected)
748 void HAL_PCDEx_SetConnectionState(PCD_HandleTypeDef *hpcd, uint8_t state)
750 /* USER CODE BEGIN 6 */
753 /* Configure Low connection state. */
758 /* Configure High connection state. */
761 /* USER CODE END 6 */
764 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/