WebSVN – canSerial – Diff – /trunk/Drivers/STM32F1xx_HAL_Driver/Src/stm32f1xx_hal_pcd_ex.c

 /**
   ******************************************************************************
   * @file    stm32f1xx_hal_pcd_ex.c
   * @author  MCD Application Team
   * @brief   PCD Extended HAL module driver.
   *          This file provides firmware functions to manage the following
   *          functionalities of the USB Peripheral Controller:
   *           + Extended features functions
   *
   ******************************************************************************
   * @attention
   *
-  * <h2><center>&copy; Copyright (c) 2016 STMicroelectronics.
+  * Copyright (c) 2016 STMicroelectronics.
-  * All rights reserved.</center></h2>
+  * All rights reserved.
   *
-  * This software component is licensed by ST under BSD 3-Clause license,
+  * This software is licensed under terms that can be found in the LICENSE file
-  * the "License"; You may not use this file except in compliance with the
+  * in the root directory of this software component.
-  * License. You may obtain a copy of the License at:
+  * If no LICENSE file comes with this software, it is provided AS-IS.
-  *                        opensource.org/licenses/BSD-3-Clause
+  *
-  *
+  ******************************************************************************
-  ******************************************************************************
+  */
-  */
+/* Includes ------------------------------------------------------------------*/
-/* Includes ------------------------------------------------------------------*/
+#include "stm32f1xx_hal.h"
-#include "stm32f1xx_hal.h"
+/** @addtogroup STM32F1xx_HAL_Driver
-/** @addtogroup STM32F1xx_HAL_Driver
+  * @{
-  * @{
+  */
-  */
+/** @defgroup PCDEx PCDEx
-/** @defgroup PCDEx PCDEx
+  * @brief PCD Extended HAL module driver
-  * @brief PCD Extended HAL module driver
+  * @{
-  * @{
+  */
-  */
+#ifdef HAL_PCD_MODULE_ENABLED
-#ifdef HAL_PCD_MODULE_ENABLED
+#if defined (USB) || defined (USB_OTG_FS)
-#if defined (USB) || defined (USB_OTG_FS)
+/* Private types -------------------------------------------------------------*/
-/* Private types -------------------------------------------------------------*/
+/* Private variables ---------------------------------------------------------*/
-/* Private variables ---------------------------------------------------------*/
+/* Private constants ---------------------------------------------------------*/
-/* Private constants ---------------------------------------------------------*/
+/* Private macros ------------------------------------------------------------*/
-/* Private macros ------------------------------------------------------------*/
+/* Private functions ---------------------------------------------------------*/
-/* Private functions ---------------------------------------------------------*/
+/* Exported functions --------------------------------------------------------*/
-/* Exported functions --------------------------------------------------------*/
+/** @defgroup PCDEx_Exported_Functions PCDEx Exported Functions
-/** @defgroup PCDEx_Exported_Functions PCDEx Exported Functions
+  * @{
-  * @{
+  */
-  */
+/** @defgroup PCDEx_Exported_Functions_Group1 Peripheral Control functions
-/** @defgroup PCDEx_Exported_Functions_Group1 Peripheral Control functions
+  * @brief    PCDEx control functions
-  * @brief    PCDEx control functions
+  *
-  *
+@verbatim
-@verbatim
+ ===============================================================================
- ===============================================================================
+                 ##### Extended features functions #####
-                 ##### Extended features functions #####
+ ===============================================================================
- ===============================================================================
+    [..]  This section provides functions allowing to:
-    [..]  This section provides functions allowing to:
+      (+) Update FIFO configuration
-      (+) Update FIFO configuration
+@endverbatim
-@endverbatim
+  * @{
-  * @{
+  */
-  */
+#if defined (USB_OTG_FS)
-#if defined (USB_OTG_FS)
+/**
-/**
+  * @brief  Set Tx FIFO
-  * @brief  Set Tx FIFO
+  * @param  hpcd PCD handle
-  * @param  hpcd PCD handle
+  * @param  fifo The number of Tx fifo
-  * @param  fifo The number of Tx fifo
+  * @param  size Fifo size
-  * @param  size Fifo size
+  * @retval HAL status
-  * @retval HAL status
+  */
-  */
+HAL_StatusTypeDef HAL_PCDEx_SetTxFiFo(PCD_HandleTypeDef *hpcd, uint8_t fifo, uint16_t size)
-HAL_StatusTypeDef HAL_PCDEx_SetTxFiFo(PCD_HandleTypeDef *hpcd, uint8_t fifo, uint16_t size)
+{
-{
+  uint8_t i;
-  uint8_t i;
+  uint32_t Tx_Offset;
-  uint32_t Tx_Offset;
+  /*  TXn min size = 16 words. (n  : Transmit FIFO index)
-  /*  TXn min size = 16 words. (n  : Transmit FIFO index)
+      When a TxFIFO is not used, the Configuration should be as follows:
-      When a TxFIFO is not used, the Configuration should be as follows:
+          case 1 :  n > m    and Txn is not used    (n,m  : Transmit FIFO indexes)
-          case 1 :  n > m    and Txn is not used    (n,m  : Transmit FIFO indexes)
+         --> Txm can use the space allocated for Txn.
-         --> Txm can use the space allocated for Txn.
+         case2  :  n < m    and Txn is not used    (n,m  : Transmit FIFO indexes)
-         case2  :  n < m    and Txn is not used    (n,m  : Transmit FIFO indexes)
+         --> Txn should be configured with the minimum space of 16 words
-         --> Txn should be configured with the minimum space of 16 words
+     The FIFO is used optimally when used TxFIFOs are allocated in the top
-     The FIFO is used optimally when used TxFIFOs are allocated in the top
+         of the FIFO.Ex: use EP1 and EP2 as IN instead of EP1 and EP3 as IN ones.
-         of the FIFO.Ex: use EP1 and EP2 as IN instead of EP1 and EP3 as IN ones.
+     When DMA is used 3n * FIFO locations should be reserved for internal DMA registers */
-     When DMA is used 3n * FIFO locations should be reserved for internal DMA registers */
+  Tx_Offset = hpcd->Instance->GRXFSIZ;
-  Tx_Offset = hpcd->Instance->GRXFSIZ;
+  if (fifo == 0U)
-  if (fifo == 0U)
+  {
-  {
+    hpcd->Instance->DIEPTXF0_HNPTXFSIZ = ((uint32_t)size << 16) | Tx_Offset;
-    hpcd->Instance->DIEPTXF0_HNPTXFSIZ = ((uint32_t)size << 16) | Tx_Offset;
+  }
-  }
+  else
-  else
+  {
-  {
+    Tx_Offset += (hpcd->Instance->DIEPTXF0_HNPTXFSIZ) >> 16;
-    Tx_Offset += (hpcd->Instance->DIEPTXF0_HNPTXFSIZ) >> 16;
+    for (i = 0U; i < (fifo - 1U); i++)
-    for (i = 0U; i < (fifo - 1U); i++)
+    {
-    {
+      Tx_Offset += (hpcd->Instance->DIEPTXF[i] >> 16);
-      Tx_Offset += (hpcd->Instance->DIEPTXF[i] >> 16);
+    }
-    }
+    /* Multiply Tx_Size by 2 to get higher performance */
-    /* Multiply Tx_Size by 2 to get higher performance */
+    hpcd->Instance->DIEPTXF[fifo - 1U] = ((uint32_t)size << 16) | Tx_Offset;
-    hpcd->Instance->DIEPTXF[fifo - 1U] = ((uint32_t)size << 16) | Tx_Offset;
+  }
-  }
+  return HAL_OK;
-  return HAL_OK;
+}
-}
+/**
-/**
+  * @brief  Set Rx FIFO
-  * @brief  Set Rx FIFO
+  * @param  hpcd PCD handle
-  * @param  hpcd PCD handle
+  * @param  size Size of Rx fifo
-  * @param  size Size of Rx fifo
+  * @retval HAL status
-  * @retval HAL status
+  */
-  */
+HAL_StatusTypeDef HAL_PCDEx_SetRxFiFo(PCD_HandleTypeDef *hpcd, uint16_t size)
-HAL_StatusTypeDef HAL_PCDEx_SetRxFiFo(PCD_HandleTypeDef *hpcd, uint16_t size)
+{
-{
+  hpcd->Instance->GRXFSIZ = size;
-  hpcd->Instance->GRXFSIZ = size;
+  return HAL_OK;
-  return HAL_OK;
+}
-}
+#endif /* defined (USB_OTG_FS) */
-#endif /* defined (USB_OTG_FS) */
+#if defined (USB)
-#if defined (USB)
+/**
-/**
+  * @brief  Configure PMA for EP
-  * @brief  Configure PMA for EP
+  * @param  hpcd  Device instance
-  * @param  hpcd  Device instance
+  * @param  ep_addr endpoint address
-  * @param  ep_addr endpoint address
+  * @param  ep_kind endpoint Kind
-  * @param  ep_kind endpoint Kind
+  *                  USB_SNG_BUF: Single Buffer used
-  *                  USB_SNG_BUF: Single Buffer used
+  *                  USB_DBL_BUF: Double Buffer used
-  *                  USB_DBL_BUF: Double Buffer used
+  * @param  pmaadress: EP address in The PMA: In case of single buffer endpoint
-  * @param  pmaadress: EP address in The PMA: In case of single buffer endpoint
+  *                   this parameter is 16-bit value providing the address
-  *                   this parameter is 16-bit value providing the address
+  *                   in PMA allocated to endpoint.
-  *                   in PMA allocated to endpoint.
+  *                   In case of double buffer endpoint this parameter
-  *                   In case of double buffer endpoint this parameter
+  *                   is a 32-bit value providing the endpoint buffer 0 address
-  *                   is a 32-bit value providing the endpoint buffer 0 address
+  *                   in the LSB part of 32-bit value and endpoint buffer 1 address
-  *                   in the LSB part of 32-bit value and endpoint buffer 1 address
+  *                   in the MSB part of 32-bit value.
-  *                   in the MSB part of 32-bit value.
+  * @retval HAL status
-  * @retval HAL status
+  */
-  */
+HAL_StatusTypeDef  HAL_PCDEx_PMAConfig(PCD_HandleTypeDef *hpcd, uint16_t ep_addr,
-HAL_StatusTypeDef  HAL_PCDEx_PMAConfig(PCD_HandleTypeDef *hpcd, uint16_t ep_addr,
+                                       uint16_t ep_kind, uint32_t pmaadress)
-                                       uint16_t ep_kind, uint32_t pmaadress)
+{
-{
+  PCD_EPTypeDef *ep;
-  PCD_EPTypeDef *ep;
+  /* initialize ep structure*/
-  /* initialize ep structure*/
+  if ((0x80U & ep_addr) == 0x80U)
-  if ((0x80U & ep_addr) == 0x80U)
+  {
-  {
+    ep = &hpcd->IN_ep[ep_addr & EP_ADDR_MSK];
-    ep = &hpcd->IN_ep[ep_addr & EP_ADDR_MSK];
+  }
-  }
+  else
-  else
+  {
-  {
+    ep = &hpcd->OUT_ep[ep_addr];
-    ep = &hpcd->OUT_ep[ep_addr];
+  }
-  }
+  /* Here we check if the endpoint is single or double Buffer*/
-  /* Here we check if the endpoint is single or double Buffer*/
+  if (ep_kind == PCD_SNG_BUF)
-  if (ep_kind == PCD_SNG_BUF)
+  {
-  {
+    /* Single Buffer */
-    /* Single Buffer */
+    ep->doublebuffer = 0U;
-    ep->doublebuffer = 0U;
+    /* Configure the PMA */
-    /* Configure the PMA */
+    ep->pmaadress = (uint16_t)pmaadress;
-    ep->pmaadress = (uint16_t)pmaadress;
+  }
-  }
+#if (USE_USB_DOUBLE_BUFFER == 1U)
   else /* USB_DBL_BUF */
   {
     /* Double Buffer Endpoint */
     ep->doublebuffer = 1U;
     /* Configure the PMA */
     ep->pmaaddr0 = (uint16_t)(pmaadress & 0xFFFFU);
     ep->pmaaddr1 = (uint16_t)((pmaadress & 0xFFFF0000U) >> 16);
   }
+#endif /* (USE_USB_DOUBLE_BUFFER == 1U) */
-  return HAL_OK;
-}
+  return HAL_OK;
+}
-/**
-  * @brief  Software Device Connection,
+/**
-  *         this function is not required by USB OTG FS peripheral, it is used
+  * @brief  Software Device Connection,
-  *         only by USB Device FS peripheral.
+  *         this function is not required by USB OTG FS peripheral, it is used
-  * @param  hpcd PCD handle
+  *         only by USB Device FS peripheral.
-  * @param  state connection state (0 : disconnected / 1: connected)
+  * @param  hpcd PCD handle
-  * @retval None
+  * @param  state connection state (0 : disconnected / 1: connected)
-  */
+  * @retval None
-__weak void HAL_PCDEx_SetConnectionState(PCD_HandleTypeDef *hpcd, uint8_t state)
+  */
-{
+__weak void HAL_PCDEx_SetConnectionState(PCD_HandleTypeDef *hpcd, uint8_t state)
-  /* Prevent unused argument(s) compilation warning */
+{
-  UNUSED(hpcd);
+  /* Prevent unused argument(s) compilation warning */
-  UNUSED(state);
+  UNUSED(hpcd);
-  /* NOTE : This function Should not be modified, when the callback is needed,
+  UNUSED(state);
-            the HAL_PCDEx_SetConnectionState could be implemented in the user file
+  /* NOTE : This function Should not be modified, when the callback is needed,
-   */
+            the HAL_PCDEx_SetConnectionState could be implemented in the user file
-}
+   */
-#endif /* defined (USB) */
+}
+#endif /* defined (USB) */
-/**
-  * @brief  Send LPM message to user layer callback.
+/**
-  * @param  hpcd PCD handle
+  * @brief  Send LPM message to user layer callback.
-  * @param  msg LPM message
+  * @param  hpcd PCD handle
-  * @retval HAL status
+  * @param  msg LPM message
-  */
+  * @retval HAL status
-__weak void HAL_PCDEx_LPM_Callback(PCD_HandleTypeDef *hpcd, PCD_LPM_MsgTypeDef msg)
+  */
-{
+__weak void HAL_PCDEx_LPM_Callback(PCD_HandleTypeDef *hpcd, PCD_LPM_MsgTypeDef msg)
-  /* Prevent unused argument(s) compilation warning */
+{
-  UNUSED(hpcd);
+  /* Prevent unused argument(s) compilation warning */
-  UNUSED(msg);
+  UNUSED(hpcd);
+  UNUSED(msg);
-  /* NOTE : This function should not be modified, when the callback is needed,
-            the HAL_PCDEx_LPM_Callback could be implemented in the user file
+  /* NOTE : This function should not be modified, when the callback is needed,
-   */
+            the HAL_PCDEx_LPM_Callback could be implemented in the user file
-}
+   */
+}
-/**
-  * @brief  Send BatteryCharging message to user layer callback.
+/**
-  * @param  hpcd PCD handle
+  * @brief  Send BatteryCharging message to user layer callback.
-  * @param  msg LPM message
+  * @param  hpcd PCD handle
-  * @retval HAL status
+  * @param  msg LPM message
-  */
+  * @retval HAL status
-__weak void HAL_PCDEx_BCD_Callback(PCD_HandleTypeDef *hpcd, PCD_BCD_MsgTypeDef msg)
+  */
-{
+__weak void HAL_PCDEx_BCD_Callback(PCD_HandleTypeDef *hpcd, PCD_BCD_MsgTypeDef msg)
-  /* Prevent unused argument(s) compilation warning */
+{
-  UNUSED(hpcd);
+  /* Prevent unused argument(s) compilation warning */
-  UNUSED(msg);
+  UNUSED(hpcd);
+  UNUSED(msg);
-  /* NOTE : This function should not be modified, when the callback is needed,
-            the HAL_PCDEx_BCD_Callback could be implemented in the user file
+  /* NOTE : This function should not be modified, when the callback is needed,
-   */
+            the HAL_PCDEx_BCD_Callback could be implemented in the user file
-}
+   */
+}
-/**
-  * @}
+/**
-  */
+  * @}
+  */
-/**
-  * @}
+/**
-  */
+  * @}
-#endif /* defined (USB) || defined (USB_OTG_FS) */
+  */
-#endif /* HAL_PCD_MODULE_ENABLED */
+#endif /* defined (USB) || defined (USB_OTG_FS) */
+#endif /* HAL_PCD_MODULE_ENABLED */
-/**
-  * @}
+/**
-  */
+  * @}
+  */
-/**
-  * @}
+/**
-  */
+  * @}
+  */
-/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/

Subversion Repositories canSerial

(root)/trunk/Drivers/STM32F1xx_HAL_Driver/Src/stm32f1xx_hal_pcd_ex.c – Rev 2 → 3