lib/main/STM32F7/Drivers/STM32F7xx_HAL_Driver/Inc/stm32f7xx_hal_pcd.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f7xx_hal_pcd.h
   4   * @author  MCD Application Team
   5   * @version V1.2.2
   6   * @date    14-April-2017
   7   * @brief   Header file of PCD HAL module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
  12   *
  13   * Redistribution and use in source and binary forms, with or without modification,
  14   * are permitted provided that the following conditions are met:
  15   *   1. Redistributions of source code must retain the above copyright notice,
  16   *      this list of conditions and the following disclaimer.
  17   *   2. Redistributions in binary form must reproduce the above copyright notice,
  18   *      this list of conditions and the following disclaimer in the documentation
  19   *      and/or other materials provided with the distribution.
  20   *   3. Neither the name of STMicroelectronics nor the names of its contributors
  21   *      may be used to endorse or promote products derived from this software
  22   *      without specific prior written permission.
  23   *
  24   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  28   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  31   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  32   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34   *
  35   ******************************************************************************
  36   */
  37
  38 /* Define to prevent recursive inclusion -------------------------------------*/
  39 #ifndef __STM32F7xx_HAL_PCD_H
  40 #define __STM32F7xx_HAL_PCD_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32f7xx_ll_usb.h"
  48
  49 /** @addtogroup STM32F7xx_HAL_Driver
  50   * @{
  51   */
  52
  53 /** @addtogroup PCD
  54   * @{
  55   */
  56
  57 /* Exported types ------------------------------------------------------------*/
  58 /** @defgroup PCD_Exported_Types PCD Exported Types
  59   * @{
  60   */
  61
  62 /**
  63   * @brief  PCD State structure definition
  64   */
  65 typedef enum
  66 {
  67   HAL_PCD_STATE_RESET   = 0x00U,
  68   HAL_PCD_STATE_READY   = 0x01U,
  69   HAL_PCD_STATE_ERROR   = 0x02U,
  70   HAL_PCD_STATE_BUSY    = 0x03U,
  71   HAL_PCD_STATE_TIMEOUT = 0x04U
  72 } PCD_StateTypeDef;
  73
  74 /* Device LPM suspend state */
  75 typedef enum
  76 {
  77   LPM_L0 = 0x00U, /* on */
  78   LPM_L1 = 0x01U, /* LPM L1 sleep */
  79   LPM_L2 = 0x02U, /* suspend */
  80   LPM_L3 = 0x03U, /* off */
  81 }PCD_LPM_StateTypeDef;
  82
  83 typedef USB_OTG_GlobalTypeDef  PCD_TypeDef;
  84 typedef USB_OTG_CfgTypeDef     PCD_InitTypeDef;
  85 typedef USB_OTG_EPTypeDef      PCD_EPTypeDef ;
  86
  87 /**
  88   * @brief  PCD Handle Structure definition
  89   */
  90 typedef struct
  91 {
  92   PCD_TypeDef             *Instance;   /*!< Register base address              */
  93   PCD_InitTypeDef         Init;       /*!< PCD required parameters            */
  94   PCD_EPTypeDef           IN_ep[16];  /*!< IN endpoint parameters             */
  95   PCD_EPTypeDef           OUT_ep[16]; /*!< OUT endpoint parameters            */
  96   HAL_LockTypeDef         Lock;       /*!< PCD peripheral status              */
  97   __IO PCD_StateTypeDef   State;      /*!< PCD communication state            */
  98   uint32_t                Setup[12];  /*!< Setup packet buffer                */
  99   PCD_LPM_StateTypeDef    LPM_State;    /*!< LPM State                          */
 100   uint32_t                BESL;
 101   uint32_t                lpm_active;   /*!< Enable or disable the Link Power Management .
 102                                         This parameter can be set to ENABLE or DISABLE */
 103
 104   uint32_t battery_charging_active;     /*!< Enable or disable Battery charging.
 105                                         This parameter can be set to ENABLE or DISABLE                      */
 106   void                    *pData;       /*!< Pointer to upper stack Handler */
 107 } PCD_HandleTypeDef;
 108
 109 /**
 110   * @}
 111   */
 112
 113 /* Include PCD HAL Extension module */
 114 #include "stm32f7xx_hal_pcd_ex.h"
 115
 116 /* Exported constants --------------------------------------------------------*/
 117 /** @defgroup PCD_Exported_Constants PCD Exported Constants
 118   * @{
 119   */
 120
 121 /** @defgroup PCD_Speed PCD Speed
 122   * @{
 123   */
 124 #define PCD_SPEED_HIGH               0U
 125 #define PCD_SPEED_HIGH_IN_FULL       1U
 126 #define PCD_SPEED_FULL               2U
 127 /**
 128   * @}
 129   */
 130
 131 /** @defgroup PCD_PHY_Module PCD PHY Module
 132   * @{
 133   */
 134 #define PCD_PHY_ULPI                 1U
 135 #define PCD_PHY_EMBEDDED             2U
 136 #define PCD_PHY_UTMI                 3U
 137 /**
 138   * @}
 139   */
 140
 141 /** @defgroup PCD_Turnaround_Timeout Turnaround Timeout Value
 142   * @{
 143   */
 144 #ifndef USBD_HS_TRDT_VALUE
 145  #define USBD_HS_TRDT_VALUE           9U
 146 #endif /* USBD_HS_TRDT_VALUE */
 147 #ifndef USBD_FS_TRDT_VALUE
 148  #define USBD_FS_TRDT_VALUE           5U
 149 #endif /* USBD_HS_TRDT_VALUE */
 150
 151 /**
 152   * @}
 153   */
 154
 155 /**
 156   * @}
 157   */
 158
 159 /* Exported macros -----------------------------------------------------------*/
 160 /** @defgroup PCD_Exported_Macros PCD Exported Macros
 161  *  @brief macros to handle interrupts and specific clock configurations
 162  * @{
 163  */
 164 #define __HAL_PCD_ENABLE(__HANDLE__)                   USB_EnableGlobalInt ((__HANDLE__)->Instance)
 165 #define __HAL_PCD_DISABLE(__HANDLE__)                  USB_DisableGlobalInt ((__HANDLE__)->Instance)
 166
 167 #define __HAL_PCD_GET_FLAG(__HANDLE__, __INTERRUPT__)      ((USB_ReadInterrupts((__HANDLE__)->Instance) & (__INTERRUPT__)) == (__INTERRUPT__))
 168 #define __HAL_PCD_CLEAR_FLAG(__HANDLE__, __INTERRUPT__)    (((__HANDLE__)->Instance->GINTSTS) = (__INTERRUPT__))
 169 #define __HAL_PCD_IS_INVALID_INTERRUPT(__HANDLE__)         (USB_ReadInterrupts((__HANDLE__)->Instance) == 0)
 170
 171
 172 #define __HAL_PCD_UNGATE_PHYCLOCK(__HANDLE__)             *(__IO uint32_t *)((uint32_t)((__HANDLE__)->Instance) + USB_OTG_PCGCCTL_BASE) &= \
 173                                                        ~(USB_OTG_PCGCCTL_STOPCLK)
 174
 175 #define __HAL_PCD_GATE_PHYCLOCK(__HANDLE__)               *(__IO uint32_t *)((uint32_t)((__HANDLE__)->Instance) + USB_OTG_PCGCCTL_BASE) |= USB_OTG_PCGCCTL_STOPCLK
 176
 177 #define __HAL_PCD_IS_PHY_SUSPENDED(__HANDLE__)            ((*(__IO uint32_t *)((uint32_t)((__HANDLE__)->Instance) + USB_OTG_PCGCCTL_BASE))&0x10)
 178
 179 #define USB_OTG_FS_WAKEUP_EXTI_RISING_EDGE                ((uint32_t)0x08U)
 180 #define USB_OTG_FS_WAKEUP_EXTI_FALLING_EDGE               ((uint32_t)0x0CU)
 181 #define USB_OTG_FS_WAKEUP_EXTI_RISING_FALLING_EDGE        ((uint32_t)0x10U)
 182
 183 #define USB_OTG_HS_WAKEUP_EXTI_RISING_EDGE                ((uint32_t)0x08U)
 184 #define USB_OTG_HS_WAKEUP_EXTI_FALLING_EDGE               ((uint32_t)0x0CU)
 185 #define USB_OTG_HS_WAKEUP_EXTI_RISING_FALLING_EDGE        ((uint32_t)0x10U)
 186
 187 #define USB_OTG_HS_WAKEUP_EXTI_LINE                       ((uint32_t)0x00100000U)  /*!< External interrupt line 20 Connected to the USB HS EXTI Line */
 188 #define USB_OTG_FS_WAKEUP_EXTI_LINE                       ((uint32_t)0x00040000U)  /*!< External interrupt line 18 Connected to the USB FS EXTI Line */
 189
 190 #define __HAL_USB_OTG_HS_WAKEUP_EXTI_ENABLE_IT()    EXTI->IMR |= (USB_OTG_HS_WAKEUP_EXTI_LINE)
 191 #define __HAL_USB_OTG_HS_WAKEUP_EXTI_DISABLE_IT()   EXTI->IMR &= ~(USB_OTG_HS_WAKEUP_EXTI_LINE)
 192 #define __HAL_USB_OTG_HS_WAKEUP_EXTI_GET_FLAG()     EXTI->PR & (USB_OTG_HS_WAKEUP_EXTI_LINE)
 193 #define __HAL_USB_OTG_HS_WAKEUP_EXTI_CLEAR_FLAG()   EXTI->PR = (USB_OTG_HS_WAKEUP_EXTI_LINE)
 194
 195 #define __HAL_USB_OTG_HS_WAKEUP_EXTI_ENABLE_RISING_EDGE() EXTI->FTSR &= ~(USB_OTG_HS_WAKEUP_EXTI_LINE);\
 196                                                           EXTI->RTSR |= USB_OTG_HS_WAKEUP_EXTI_LINE
 197
 198 #define __HAL_USB_OTG_HS_WAKEUP_EXTI_ENABLE_FALLING_EDGE()  EXTI->FTSR |= (USB_OTG_HS_WAKEUP_EXTI_LINE);\
 199                                                             EXTI->RTSR &= ~(USB_OTG_HS_WAKEUP_EXTI_LINE)
 200
 201 #define __HAL_USB_OTG_HS_WAKEUP_EXTI_ENABLE_RISING_FALLING_EDGE()   EXTI->RTSR &= ~(USB_OTG_HS_WAKEUP_EXTI_LINE);\
 202                                                                     EXTI->FTSR &= ~(USB_OTG_HS_WAKEUP_EXTI_LINE;)\
 203                                                                     EXTI->RTSR |= USB_OTG_HS_WAKEUP_EXTI_LINE;\
 204                                                                     EXTI->FTSR |= USB_OTG_HS_WAKEUP_EXTI_LINE
 205
 206 #define __HAL_USB_OTG_HS_WAKEUP_EXTI_GENERATE_SWIT()   (EXTI->SWIER |= USB_OTG_FS_WAKEUP_EXTI_LINE)
 207
 208 #define __HAL_USB_OTG_FS_WAKEUP_EXTI_ENABLE_IT()    EXTI->IMR |= USB_OTG_FS_WAKEUP_EXTI_LINE
 209 #define __HAL_USB_OTG_FS_WAKEUP_EXTI_DISABLE_IT()   EXTI->IMR &= ~(USB_OTG_FS_WAKEUP_EXTI_LINE)
 210 #define __HAL_USB_OTG_FS_WAKEUP_EXTI_GET_FLAG()     EXTI->PR & (USB_OTG_FS_WAKEUP_EXTI_LINE)
 211 #define __HAL_USB_OTG_FS_WAKEUP_EXTI_CLEAR_FLAG()   EXTI->PR = USB_OTG_FS_WAKEUP_EXTI_LINE
 212
 213 #define __HAL_USB_OTG_FS_WAKEUP_EXTI_ENABLE_RISING_EDGE() EXTI->FTSR &= ~(USB_OTG_FS_WAKEUP_EXTI_LINE);\
 214                                                           EXTI->RTSR |= USB_OTG_FS_WAKEUP_EXTI_LINE
 215
 216
 217 #define __HAL_USB_OTG_FS_WAKEUP_EXTI_ENABLE_FALLING_EDGE()  EXTI->FTSR |= (USB_OTG_FS_WAKEUP_EXTI_LINE);\
 218                                                             EXTI->RTSR &= ~(USB_OTG_FS_WAKEUP_EXTI_LINE)
 219
 220 #define __HAL_USB_OTG_FS_WAKEUP_EXTI_ENABLE_RISING_FALLING_EDGE()  EXTI->RTSR &= ~(USB_OTG_FS_WAKEUP_EXTI_LINE);\
 221                                                                    EXTI->FTSR &= ~(USB_OTG_FS_WAKEUP_EXTI_LINE);\
 222                                                                    EXTI->RTSR |= USB_OTG_FS_WAKEUP_EXTI_LINE;\
 223                                                                    EXTI->FTSR |= USB_OTG_FS_WAKEUP_EXTI_LINE
 224
 225 #define __HAL_USB_OTG_FS_WAKEUP_EXTI_GENERATE_SWIT()  (EXTI->SWIER |= USB_OTG_FS_WAKEUP_EXTI_LINE)
 226 /**
 227   * @}
 228   */
 229
 230 /* Exported functions --------------------------------------------------------*/
 231 /** @addtogroup PCD_Exported_Functions PCD Exported Functions
 232   * @{
 233   */
 234
 235 /* Initialization/de-initialization functions  ********************************/
 236 /** @addtogroup PCD_Exported_Functions_Group1 Initialization and de-initialization functions
 237   * @{
 238   */
 239 HAL_StatusTypeDef HAL_PCD_Init(PCD_HandleTypeDef *hpcd);
 240 HAL_StatusTypeDef HAL_PCD_DeInit (PCD_HandleTypeDef *hpcd);
 241 void HAL_PCD_MspInit(PCD_HandleTypeDef *hpcd);
 242 void HAL_PCD_MspDeInit(PCD_HandleTypeDef *hpcd);
 243 /**
 244   * @}
 245   */
 246
 247 /* I/O operation functions  ***************************************************/
 248 /* Non-Blocking mode: Interrupt */
 249 /** @addtogroup PCD_Exported_Functions_Group2 Input and Output operation functions
 250   * @{
 251   */
 252 HAL_StatusTypeDef HAL_PCD_Start(PCD_HandleTypeDef *hpcd);
 253 HAL_StatusTypeDef HAL_PCD_Stop(PCD_HandleTypeDef *hpcd);
 254 void HAL_PCD_IRQHandler(PCD_HandleTypeDef *hpcd);
 255
 256 void HAL_PCD_DataOutStageCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
 257 void HAL_PCD_DataInStageCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
 258 void HAL_PCD_SetupStageCallback(PCD_HandleTypeDef *hpcd);
 259 void HAL_PCD_SOFCallback(PCD_HandleTypeDef *hpcd);
 260 void HAL_PCD_ResetCallback(PCD_HandleTypeDef *hpcd);
 261 void HAL_PCD_SuspendCallback(PCD_HandleTypeDef *hpcd);
 262 void HAL_PCD_ResumeCallback(PCD_HandleTypeDef *hpcd);
 263 void HAL_PCD_ISOOUTIncompleteCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
 264 void HAL_PCD_ISOINIncompleteCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
 265 void HAL_PCD_ConnectCallback(PCD_HandleTypeDef *hpcd);
 266 void HAL_PCD_DisconnectCallback(PCD_HandleTypeDef *hpcd);
 267 /**
 268   * @}
 269   */
 270
 271 /* Peripheral Control functions  **********************************************/
 272 /** @addtogroup PCD_Exported_Functions_Group3 Peripheral Control functions
 273   * @{
 274   */
 275 HAL_StatusTypeDef HAL_PCD_DevConnect(PCD_HandleTypeDef *hpcd);
 276 HAL_StatusTypeDef HAL_PCD_DevDisconnect(PCD_HandleTypeDef *hpcd);
 277 HAL_StatusTypeDef HAL_PCD_SetAddress(PCD_HandleTypeDef *hpcd, uint8_t address);
 278 HAL_StatusTypeDef HAL_PCD_EP_Open(PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint16_t ep_mps, uint8_t ep_type);
 279 HAL_StatusTypeDef HAL_PCD_EP_Close(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
 280 HAL_StatusTypeDef HAL_PCD_EP_Receive(PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf, uint32_t len);
 281 HAL_StatusTypeDef HAL_PCD_EP_Transmit(PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf, uint32_t len);
 282 uint16_t          HAL_PCD_EP_GetRxCount(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
 283 HAL_StatusTypeDef HAL_PCD_EP_SetStall(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
 284 HAL_StatusTypeDef HAL_PCD_EP_ClrStall(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
 285 HAL_StatusTypeDef HAL_PCD_EP_Flush(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
 286 HAL_StatusTypeDef HAL_PCD_ActivateRemoteWakeup(PCD_HandleTypeDef *hpcd);
 287 HAL_StatusTypeDef HAL_PCD_DeActivateRemoteWakeup(PCD_HandleTypeDef *hpcd);
 288 /**
 289   * @}
 290   */
 291
 292 /* Peripheral State functions  ************************************************/
 293 /** @addtogroup PCD_Exported_Functions_Group4 Peripheral State functions
 294   * @{
 295   */
 296 PCD_StateTypeDef HAL_PCD_GetState(PCD_HandleTypeDef *hpcd);
 297 /**
 298   * @}
 299   */
 300
 301 /**
 302   * @}
 303   */
 304
 305 /* Private macros ------------------------------------------------------------*/
 306 /** @defgroup PCD_Private_Macros PCD Private Macros
 307  * @{
 308  */
 309 /** @defgroup PCD_Instance_definition PCD Instance definition
 310   * @{
 311   */
 312 #define IS_PCD_ALL_INSTANCE(INSTANCE) (((INSTANCE) == USB_OTG_FS) || \
 313                                        ((INSTANCE) == USB_OTG_HS))
 314 /**
 315   * @}
 316   */
 317
 318 /**
 319   * @}
 320   */
 321
 322 /**
 323   * @}
 324   */
 325
 326 /**
 327   * @}
 328   */
 329
 330 #ifdef __cplusplus
 331 }
 332 #endif
 333
 334
 335 #endif /* __STM32F7xx_HAL_PCD_H */
 336
 337 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/