tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F4/stm32f4xx_hal_pcd.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f4xx_hal_pcd.h
   4   * @author  MCD Application Team
   5   * @version V1.1.0
   6   * @date    19-June-2014
   7   * @brief   Header file of PCD HAL module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2014 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 __STM32F4xx_HAL_PCD_H
  40 #define __STM32F4xx_HAL_PCD_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32f4xx_ll_usb.h"
  48
  49 /** @addtogroup STM32F4xx_HAL_Driver
  50   * @{
  51   */
  52
  53 /** @addtogroup PCD
  54   * @{
  55   */
  56
  57 /* Exported types ------------------------------------------------------------*/
  58
  59    /**
  60   * @brief  PCD State structures definition
  61   */
  62 typedef enum
  63 {
  64   HAL_PCD_STATE_RESET   = 0x00,
  65   HAL_PCD_STATE_READY   = 0x01,
  66   HAL_PCD_STATE_ERROR   = 0x02,
  67   HAL_PCD_STATE_BUSY    = 0x03,
  68   HAL_PCD_STATE_TIMEOUT = 0x04
  69 } PCD_StateTypeDef;
  70
  71
  72 typedef USB_OTG_GlobalTypeDef  PCD_TypeDef;
  73 typedef USB_OTG_CfgTypeDef     PCD_InitTypeDef;
  74 typedef USB_OTG_EPTypeDef      PCD_EPTypeDef ;
  75
  76 /**
  77   * @brief  PCD Handle Structure definition
  78   */
  79 typedef struct
  80 {
  81   PCD_TypeDef             *Instance;   /*!< Register base address              */
  82   PCD_InitTypeDef         Init;       /*!< PCD required parameters            */
  83   PCD_EPTypeDef           IN_ep[15];  /*!< IN endpoint parameters             */
  84   PCD_EPTypeDef           OUT_ep[15]; /*!< OUT endpoint parameters            */
  85   HAL_LockTypeDef         Lock;       /*!< PCD peripheral status              */
  86   __IO PCD_StateTypeDef   State;      /*!< PCD communication state            */
  87   uint32_t                Setup[12];  /*!< Setup packet buffer                */
  88   void                    *pData;      /*!< Pointer to upper stack Handler     */
  89
  90 } PCD_HandleTypeDef;
  91
  92 /* Exported constants --------------------------------------------------------*/
  93 /** @defgroup PCD_Exported_Constants
  94   * @{
  95   */
  96
  97 /** @defgroup PCD_Speed
  98   * @{
  99   */
 100 #define PCD_SPEED_HIGH               0
 101 #define PCD_SPEED_HIGH_IN_FULL       1
 102 #define PCD_SPEED_FULL               2
 103 /**
 104   * @}
 105   */
 106
 107   /** @defgroup PCD_PHY_Module
 108   * @{
 109   */
 110 #define PCD_PHY_ULPI                 1
 111 #define PCD_PHY_EMBEDDED             2
 112 /**
 113   * @}
 114   */
 115
 116 /** @defgroup PCD_Instance_definition
 117   * @{
 118   */
 119 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx)
 120  #define IS_PCD_ALL_INSTANCE(INSTANCE) (((INSTANCE) == USB_OTG_FS) || \
 121                                         ((INSTANCE) == USB_OTG_HS))
 122 #elif defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F411xE)
 123  #define IS_PCD_ALL_INSTANCE(INSTANCE) (((INSTANCE) == USB_OTG_FS))
 124 #endif
 125
 126 /**
 127   * @}
 128   */
 129
 130 /**
 131   * @}
 132   */
 133
 134 /* Exported macro ------------------------------------------------------------*/
 135
 136 /** @defgroup PCD_Interrupt_Clock
 137  *  @brief macros to handle interrupts and specific clock configurations
 138  * @{
 139  */
 140 #define __HAL_PCD_ENABLE(__HANDLE__)                   USB_EnableGlobalInt ((__HANDLE__)->Instance)
 141 #define __HAL_PCD_DISABLE(__HANDLE__)                  USB_DisableGlobalInt ((__HANDLE__)->Instance)
 142
 143 #define __HAL_PCD_GET_FLAG(__HANDLE__, __INTERRUPT__)      ((USB_ReadInterrupts((__HANDLE__)->Instance) & (__INTERRUPT__)) == (__INTERRUPT__))
 144 #define __HAL_PCD_CLEAR_FLAG(__HANDLE__, __INTERRUPT__)    (((__HANDLE__)->Instance->GINTSTS) = (__INTERRUPT__))
 145 #define __HAL_PCD_IS_INVALID_INTERRUPT(__HANDLE__)         (USB_ReadInterrupts((__HANDLE__)->Instance) == 0)
 146
 147
 148 #define __HAL_PCD_UNGATE_PHYCLOCK(__HANDLE__)             *(__IO uint32_t *)((uint32_t)((__HANDLE__)->Instance) + USB_OTG_PCGCCTL_BASE) &= \
 149                                                        ~(USB_OTG_PCGCCTL_STOPCLK)
 150
 151
 152 #define __HAL_PCD_GATE_PHYCLOCK(__HANDLE__)               *(__IO uint32_t *)((uint32_t)((__HANDLE__)->Instance) + USB_OTG_PCGCCTL_BASE) |= USB_OTG_PCGCCTL_STOPCLK
 153
 154 #define __HAL_PCD_IS_PHY_SUSPENDED(__HANDLE__)            ((*(__IO uint32_t *)((uint32_t)((__HANDLE__)->Instance) + USB_OTG_PCGCCTL_BASE))&0x10)
 155
 156 #define USB_FS_EXTI_TRIGGER_RISING_EDGE      ((uint32_t)0x08)
 157 #define USB_FS_EXTI_TRIGGER_FALLING_EDGE     ((uint32_t)0x0C)
 158 #define USB_FS_EXTI_TRIGGER_BOTH_EDGE        ((uint32_t)0x10)
 159
 160 #define USB_HS_EXTI_TRIGGER_RISING_EDGE      ((uint32_t)0x08)
 161 #define USB_HS_EXTI_TRIGGER_FALLING_EDGE     ((uint32_t)0x0C)
 162 #define USB_HS_EXTI_TRIGGER_BOTH_EDGE        ((uint32_t)0x10)
 163
 164
 165 #define USB_HS_EXTI_LINE_WAKEUP              ((uint32_t)0x00100000)  /*!< External interrupt line 20 Connected to the USB HS EXTI Line */
 166 #define USB_FS_EXTI_LINE_WAKEUP              ((uint32_t)0x00040000)  /*!< External interrupt line 18 Connected to the USB FS EXTI Line */
 167
 168
 169
 170 #define __HAL_USB_HS_EXTI_ENABLE_IT()    EXTI->IMR |= (USB_HS_EXTI_LINE_WAKEUP)
 171 #define __HAL_USB_HS_EXTI_DISABLE_IT()   EXTI->IMR &= ~(USB_HS_EXTI_LINE_WAKEUP)
 172 #define __HAL_USB_HS_EXTI_GET_FLAG()     EXTI->PR & (USB_HS_EXTI_LINE_WAKEUP)
 173 #define __HAL_USB_HS_EXTI_CLEAR_FLAG()   EXTI->PR = (USB_HS_EXTI_LINE_WAKEUP)
 174
 175 #define __HAL_USB_HS_EXTI_SET_RISING_EGDE_TRIGGER() EXTI->FTSR &= ~(USB_HS_EXTI_LINE_WAKEUP);\
 176                                                     EXTI->RTSR |= USB_HS_EXTI_LINE_WAKEUP
 177
 178
 179 #define __HAL_USB_HS_EXTI_SET_FALLING_EGDE_TRIGGER()  EXTI->FTSR |= (USB_HS_EXTI_LINE_WAKEUP);\
 180                                                       EXTI->RTSR &= ~(USB_HS_EXTI_LINE_WAKEUP)
 181
 182
 183 #define __HAL_USB_HS_EXTI_SET_FALLINGRISING_TRIGGER()   EXTI->RTSR &= ~(USB_HS_EXTI_LINE_WAKEUP);\
 184                                                         EXTI->FTSR &= ~(USB_HS_EXTI_LINE_WAKEUP;)\
 185                                                         EXTI->RTSR |= USB_HS_EXTI_LINE_WAKEUP;\
 186                                                         EXTI->FTSR |= USB_HS_EXTI_LINE_WAKEUP
 187
 188 #define __HAL_USB_HS_EXTI_GENERATE_SWIT()             (EXTI->SWIER |= USB_FS_EXTI_LINE_WAKEUP)
 189
 190
 191 #define __HAL_USB_FS_EXTI_ENABLE_IT()    EXTI->IMR |= USB_FS_EXTI_LINE_WAKEUP
 192 #define __HAL_USB_FS_EXTI_DISABLE_IT()   EXTI->IMR &= ~(USB_FS_EXTI_LINE_WAKEUP)
 193 #define __HAL_USB_FS_EXTI_GET_FLAG()     EXTI->PR & (USB_FS_EXTI_LINE_WAKEUP)
 194 #define __HAL_USB_FS_EXTI_CLEAR_FLAG()   EXTI->PR = USB_FS_EXTI_LINE_WAKEUP
 195
 196 #define __HAL_USB_FS_EXTI_SET_RISING_EGDE_TRIGGER() EXTI->FTSR &= ~(USB_FS_EXTI_LINE_WAKEUP);\
 197                                                     EXTI->RTSR |= USB_FS_EXTI_LINE_WAKEUP
 198
 199
 200 #define __HAL_USB_FS_EXTI_SET_FALLING_EGDE_TRIGGER()  EXTI->FTSR |= (USB_FS_EXTI_LINE_WAKEUP);\
 201                                                       EXTI->RTSR &= ~(USB_FS_EXTI_LINE_WAKEUP)
 202
 203
 204 #define __HAL_USB_FS_EXTI_SET_FALLINGRISING_TRIGGER()  EXTI->RTSR &= ~(USB_FS_EXTI_LINE_WAKEUP);\
 205                                                        EXTI->FTSR &= ~(USB_FS_EXTI_LINE_WAKEUP);\
 206                                                        EXTI->RTSR |= USB_FS_EXTI_LINE_WAKEUP;\
 207                                                        EXTI->FTSR |= USB_FS_EXTI_LINE_WAKEUP
 208
 209 #define __HAL_USB_FS_EXTI_GENERATE_SWIT()             (EXTI->SWIER |= USB_FS_EXTI_LINE_WAKEUP)
 210
 211 /**
 212   * @}
 213   */
 214
 215 /* Include PCD HAL Extension module */
 216 #include "stm32f4xx_hal_pcd_ex.h"
 217
 218 /* Exported functions --------------------------------------------------------*/
 219
 220 /* Initialization/de-initialization functions  **********************************/
 221 HAL_StatusTypeDef HAL_PCD_Init(PCD_HandleTypeDef *hpcd);
 222 HAL_StatusTypeDef HAL_PCD_DeInit (PCD_HandleTypeDef *hpcd);
 223 void HAL_PCD_MspInit(PCD_HandleTypeDef *hpcd);
 224 void HAL_PCD_MspDeInit(PCD_HandleTypeDef *hpcd);
 225
 226 /* I/O operation functions  *****************************************************/
 227  /* Non-Blocking mode: Interrupt */
 228 HAL_StatusTypeDef HAL_PCD_Start(PCD_HandleTypeDef *hpcd);
 229 HAL_StatusTypeDef HAL_PCD_Stop(PCD_HandleTypeDef *hpcd);
 230 void HAL_PCD_IRQHandler(PCD_HandleTypeDef *hpcd);
 231
 232 void HAL_PCD_DataOutStageCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
 233 void HAL_PCD_DataInStageCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
 234 void HAL_PCD_SetupStageCallback(PCD_HandleTypeDef *hpcd);
 235 void HAL_PCD_SOFCallback(PCD_HandleTypeDef *hpcd);
 236 void HAL_PCD_ResetCallback(PCD_HandleTypeDef *hpcd);
 237 void HAL_PCD_SuspendCallback(PCD_HandleTypeDef *hpcd);
 238 void HAL_PCD_ResumeCallback(PCD_HandleTypeDef *hpcd);
 239 void HAL_PCD_ISOOUTIncompleteCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
 240 void HAL_PCD_ISOINIncompleteCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
 241 void HAL_PCD_ConnectCallback(PCD_HandleTypeDef *hpcd);
 242 void HAL_PCD_DisconnectCallback(PCD_HandleTypeDef *hpcd);
 243
 244 /* Peripheral Control functions  ************************************************/
 245 HAL_StatusTypeDef HAL_PCD_DevConnect(PCD_HandleTypeDef *hpcd);
 246 HAL_StatusTypeDef HAL_PCD_DevDisconnect(PCD_HandleTypeDef *hpcd);
 247 HAL_StatusTypeDef HAL_PCD_SetAddress(PCD_HandleTypeDef *hpcd, uint8_t address);
 248 HAL_StatusTypeDef HAL_PCD_EP_Open(PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint16_t ep_mps, uint8_t ep_type);
 249 HAL_StatusTypeDef HAL_PCD_EP_Close(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
 250 HAL_StatusTypeDef HAL_PCD_EP_Receive(PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf, uint32_t len);
 251 HAL_StatusTypeDef HAL_PCD_EP_Transmit(PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf, uint32_t len);
 252 uint16_t          HAL_PCD_EP_GetRxCount(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
 253 HAL_StatusTypeDef HAL_PCD_EP_SetStall(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
 254 HAL_StatusTypeDef HAL_PCD_EP_ClrStall(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
 255 HAL_StatusTypeDef HAL_PCD_EP_Flush(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
 256 HAL_StatusTypeDef HAL_PCD_ActiveRemoteWakeup(PCD_HandleTypeDef *hpcd);
 257 HAL_StatusTypeDef HAL_PCD_DeActiveRemoteWakeup(PCD_HandleTypeDef *hpcd);
 258
 259 /* Create an alias to keep compatibility with the old name */
 260 #define HAL_PCD_SetTxFiFo    HAL_PCDEx_SetTxFiFo
 261 #define HAL_PCD_SetRxFiFo    HAL_PCDEx_SetRxFiFo
 262
 263 /* Peripheral State functions  **************************************************/
 264 PCD_StateTypeDef HAL_PCD_GetState(PCD_HandleTypeDef *hpcd);
 265
 266 /**
 267   * @}
 268   */
 269
 270 /**
 271   * @}
 272   */
 273
 274 #ifdef __cplusplus
 275 }
 276 #endif
 277
 278
 279 #endif /* __STM32F4xx_HAL_PCD_H */
 280
 281 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/