Thomas Lyp / DevLibMemoryController

Initial commit

Dependencies:   FastPWM

mbed-dev-master/targets/TARGET_STM/TARGET_STM32F4/device/stm32f4xx_hal_hcd.h@0:bb348c97df44, 2020-09-16 (annotated)

Committer:
lypinator
Date:
Wed Sep 16 01:11:49 2020 +0000
Revision:
0:bb348c97df44
Added PWM

Who changed what in which revision?

UserRevisionLine numberNew contents of line
lypinator 0:bb348c97df44 1 /**
lypinator 0:bb348c97df44 2 ******************************************************************************
lypinator 0:bb348c97df44 3 * @file stm32f4xx_hal_hcd.h
lypinator 0:bb348c97df44 4 * @author MCD Application Team
lypinator 0:bb348c97df44 5 * @brief Header file of HCD HAL module.
lypinator 0:bb348c97df44 6 ******************************************************************************
lypinator 0:bb348c97df44 7 * @attention
lypinator 0:bb348c97df44 8 *
lypinator 0:bb348c97df44 9 * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
lypinator 0:bb348c97df44 10 *
lypinator 0:bb348c97df44 11 * Redistribution and use in source and binary forms, with or without modification,
lypinator 0:bb348c97df44 12 * are permitted provided that the following conditions are met:
lypinator 0:bb348c97df44 13 * 1. Redistributions of source code must retain the above copyright notice,
lypinator 0:bb348c97df44 14 * this list of conditions and the following disclaimer.
lypinator 0:bb348c97df44 15 * 2. Redistributions in binary form must reproduce the above copyright notice,
lypinator 0:bb348c97df44 16 * this list of conditions and the following disclaimer in the documentation
lypinator 0:bb348c97df44 17 * and/or other materials provided with the distribution.
lypinator 0:bb348c97df44 18 * 3. Neither the name of STMicroelectronics nor the names of its contributors
lypinator 0:bb348c97df44 19 * may be used to endorse or promote products derived from this software
lypinator 0:bb348c97df44 20 * without specific prior written permission.
lypinator 0:bb348c97df44 21 *
lypinator 0:bb348c97df44 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
lypinator 0:bb348c97df44 23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
lypinator 0:bb348c97df44 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
lypinator 0:bb348c97df44 25 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
lypinator 0:bb348c97df44 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
lypinator 0:bb348c97df44 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
lypinator 0:bb348c97df44 28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
lypinator 0:bb348c97df44 29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
lypinator 0:bb348c97df44 30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
lypinator 0:bb348c97df44 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
lypinator 0:bb348c97df44 32 *
lypinator 0:bb348c97df44 33 ******************************************************************************
lypinator 0:bb348c97df44 34 */
lypinator 0:bb348c97df44 35
lypinator 0:bb348c97df44 36 /* Define to prevent recursive inclusion -------------------------------------*/
lypinator 0:bb348c97df44 37 #ifndef __STM32F4xx_HAL_HCD_H
lypinator 0:bb348c97df44 38 #define __STM32F4xx_HAL_HCD_H
lypinator 0:bb348c97df44 39
lypinator 0:bb348c97df44 40 #ifdef __cplusplus
lypinator 0:bb348c97df44 41 extern "C" {
lypinator 0:bb348c97df44 42 #endif
lypinator 0:bb348c97df44 43 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || \
lypinator 0:bb348c97df44 44 defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) || \
lypinator 0:bb348c97df44 45 defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F411xE) || defined(STM32F446xx) || \
lypinator 0:bb348c97df44 46 defined(STM32F469xx) || defined(STM32F479xx) || defined(STM32F412Zx) || defined(STM32F412Vx) || \
lypinator 0:bb348c97df44 47 defined(STM32F412Rx) || defined(STM32F412Cx) || defined(STM32F413xx) || defined(STM32F423xx)
lypinator 0:bb348c97df44 48 /* Includes ------------------------------------------------------------------*/
lypinator 0:bb348c97df44 49 #include "stm32f4xx_ll_usb.h"
lypinator 0:bb348c97df44 50
lypinator 0:bb348c97df44 51 /** @addtogroup STM32F4xx_HAL_Driver
lypinator 0:bb348c97df44 52 * @{
lypinator 0:bb348c97df44 53 */
lypinator 0:bb348c97df44 54
lypinator 0:bb348c97df44 55 /** @addtogroup HCD
lypinator 0:bb348c97df44 56 * @{
lypinator 0:bb348c97df44 57 */
lypinator 0:bb348c97df44 58
lypinator 0:bb348c97df44 59 /* Exported types ------------------------------------------------------------*/
lypinator 0:bb348c97df44 60 /** @defgroup HCD_Exported_Types HCD Exported Types
lypinator 0:bb348c97df44 61 * @{
lypinator 0:bb348c97df44 62 */
lypinator 0:bb348c97df44 63
lypinator 0:bb348c97df44 64 /** @defgroup HCD_Exported_Types_Group1 HCD State Structure definition
lypinator 0:bb348c97df44 65 * @{
lypinator 0:bb348c97df44 66 */
lypinator 0:bb348c97df44 67 typedef enum
lypinator 0:bb348c97df44 68 {
lypinator 0:bb348c97df44 69 HAL_HCD_STATE_RESET = 0x00U,
lypinator 0:bb348c97df44 70 HAL_HCD_STATE_READY = 0x01U,
lypinator 0:bb348c97df44 71 HAL_HCD_STATE_ERROR = 0x02U,
lypinator 0:bb348c97df44 72 HAL_HCD_STATE_BUSY = 0x03U,
lypinator 0:bb348c97df44 73 HAL_HCD_STATE_TIMEOUT = 0x04U
lypinator 0:bb348c97df44 74 } HCD_StateTypeDef;
lypinator 0:bb348c97df44 75
lypinator 0:bb348c97df44 76 typedef USB_OTG_GlobalTypeDef HCD_TypeDef;
lypinator 0:bb348c97df44 77 typedef USB_OTG_CfgTypeDef HCD_InitTypeDef;
lypinator 0:bb348c97df44 78 typedef USB_OTG_HCTypeDef HCD_HCTypeDef ;
lypinator 0:bb348c97df44 79 typedef USB_OTG_URBStateTypeDef HCD_URBStateTypeDef ;
lypinator 0:bb348c97df44 80 typedef USB_OTG_HCStateTypeDef HCD_HCStateTypeDef ;
lypinator 0:bb348c97df44 81 /**
lypinator 0:bb348c97df44 82 * @}
lypinator 0:bb348c97df44 83 */
lypinator 0:bb348c97df44 84
lypinator 0:bb348c97df44 85 /** @defgroup HCD_Exported_Types_Group2 HCD Handle Structure definition
lypinator 0:bb348c97df44 86 * @{
lypinator 0:bb348c97df44 87 */
lypinator 0:bb348c97df44 88 typedef struct
lypinator 0:bb348c97df44 89 {
lypinator 0:bb348c97df44 90 HCD_TypeDef *Instance; /*!< Register base address */
lypinator 0:bb348c97df44 91 HCD_InitTypeDef Init; /*!< HCD required parameters */
lypinator 0:bb348c97df44 92 HCD_HCTypeDef hc[15U]; /*!< Host channels parameters */
lypinator 0:bb348c97df44 93 HAL_LockTypeDef Lock; /*!< HCD peripheral status */
lypinator 0:bb348c97df44 94 __IO HCD_StateTypeDef State; /*!< HCD communication state */
lypinator 0:bb348c97df44 95 void *pData; /*!< Pointer Stack Handler */
lypinator 0:bb348c97df44 96 } HCD_HandleTypeDef;
lypinator 0:bb348c97df44 97 /**
lypinator 0:bb348c97df44 98 * @}
lypinator 0:bb348c97df44 99 */
lypinator 0:bb348c97df44 100
lypinator 0:bb348c97df44 101 /**
lypinator 0:bb348c97df44 102 * @}
lypinator 0:bb348c97df44 103 */
lypinator 0:bb348c97df44 104
lypinator 0:bb348c97df44 105 /* Exported constants --------------------------------------------------------*/
lypinator 0:bb348c97df44 106 /** @defgroup HCD_Exported_Constants HCD Exported Constants
lypinator 0:bb348c97df44 107 * @{
lypinator 0:bb348c97df44 108 */
lypinator 0:bb348c97df44 109
lypinator 0:bb348c97df44 110 /** @defgroup HCD_Speed HCD Speed
lypinator 0:bb348c97df44 111 * @{
lypinator 0:bb348c97df44 112 */
lypinator 0:bb348c97df44 113 #define HCD_SPEED_HIGH 0U
lypinator 0:bb348c97df44 114 #define HCD_SPEED_LOW 2U
lypinator 0:bb348c97df44 115 #define HCD_SPEED_FULL 3U
lypinator 0:bb348c97df44 116 /**
lypinator 0:bb348c97df44 117 * @}
lypinator 0:bb348c97df44 118 */
lypinator 0:bb348c97df44 119
lypinator 0:bb348c97df44 120 /** @defgroup HCD_PHY_Module HCD PHY Module
lypinator 0:bb348c97df44 121 * @{
lypinator 0:bb348c97df44 122 */
lypinator 0:bb348c97df44 123 #define HCD_PHY_ULPI 1U
lypinator 0:bb348c97df44 124 #define HCD_PHY_EMBEDDED 2U
lypinator 0:bb348c97df44 125 /**
lypinator 0:bb348c97df44 126 * @}
lypinator 0:bb348c97df44 127 */
lypinator 0:bb348c97df44 128
lypinator 0:bb348c97df44 129 /**
lypinator 0:bb348c97df44 130 * @}
lypinator 0:bb348c97df44 131 */
lypinator 0:bb348c97df44 132
lypinator 0:bb348c97df44 133 /* Exported macro ------------------------------------------------------------*/
lypinator 0:bb348c97df44 134 /** @defgroup HCD_Exported_Macros HCD Exported Macros
lypinator 0:bb348c97df44 135 * @brief macros to handle interrupts and specific clock configurations
lypinator 0:bb348c97df44 136 * @{
lypinator 0:bb348c97df44 137 */
lypinator 0:bb348c97df44 138 #define __HAL_HCD_ENABLE(__HANDLE__) USB_EnableGlobalInt ((__HANDLE__)->Instance)
lypinator 0:bb348c97df44 139 #define __HAL_HCD_DISABLE(__HANDLE__) USB_DisableGlobalInt ((__HANDLE__)->Instance)
lypinator 0:bb348c97df44 140
lypinator 0:bb348c97df44 141 #define __HAL_HCD_GET_FLAG(__HANDLE__, __INTERRUPT__) ((USB_ReadInterrupts((__HANDLE__)->Instance) & (__INTERRUPT__)) == (__INTERRUPT__))
lypinator 0:bb348c97df44 142 #define __HAL_HCD_CLEAR_FLAG(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->GINTSTS) = (__INTERRUPT__))
lypinator 0:bb348c97df44 143 #define __HAL_HCD_IS_INVALID_INTERRUPT(__HANDLE__) (USB_ReadInterrupts((__HANDLE__)->Instance) == 0U)
lypinator 0:bb348c97df44 144
lypinator 0:bb348c97df44 145 #define __HAL_HCD_CLEAR_HC_INT(chnum, __INTERRUPT__) (USBx_HC(chnum)->HCINT = (__INTERRUPT__))
lypinator 0:bb348c97df44 146 #define __HAL_HCD_MASK_HALT_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK &= ~USB_OTG_HCINTMSK_CHHM)
lypinator 0:bb348c97df44 147 #define __HAL_HCD_UNMASK_HALT_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK |= USB_OTG_HCINTMSK_CHHM)
lypinator 0:bb348c97df44 148 #define __HAL_HCD_MASK_ACK_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK &= ~USB_OTG_HCINTMSK_ACKM)
lypinator 0:bb348c97df44 149 #define __HAL_HCD_UNMASK_ACK_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK |= USB_OTG_HCINTMSK_ACKM)
lypinator 0:bb348c97df44 150 /**
lypinator 0:bb348c97df44 151 * @}
lypinator 0:bb348c97df44 152 */
lypinator 0:bb348c97df44 153
lypinator 0:bb348c97df44 154 /* Exported functions --------------------------------------------------------*/
lypinator 0:bb348c97df44 155 /** @addtogroup HCD_Exported_Functions HCD Exported Functions
lypinator 0:bb348c97df44 156 * @{
lypinator 0:bb348c97df44 157 */
lypinator 0:bb348c97df44 158
lypinator 0:bb348c97df44 159 /* Initialization/de-initialization functions ********************************/
lypinator 0:bb348c97df44 160 /** @addtogroup HCD_Exported_Functions_Group1 Initialization and de-initialization functions
lypinator 0:bb348c97df44 161 * @{
lypinator 0:bb348c97df44 162 */
lypinator 0:bb348c97df44 163 HAL_StatusTypeDef HAL_HCD_Init(HCD_HandleTypeDef *hhcd);
lypinator 0:bb348c97df44 164 HAL_StatusTypeDef HAL_HCD_DeInit(HCD_HandleTypeDef *hhcd);
lypinator 0:bb348c97df44 165 HAL_StatusTypeDef HAL_HCD_HC_Init(HCD_HandleTypeDef *hhcd,
lypinator 0:bb348c97df44 166 uint8_t ch_num,
lypinator 0:bb348c97df44 167 uint8_t epnum,
lypinator 0:bb348c97df44 168 uint8_t dev_address,
lypinator 0:bb348c97df44 169 uint8_t speed,
lypinator 0:bb348c97df44 170 uint8_t ep_type,
lypinator 0:bb348c97df44 171 uint16_t mps);
lypinator 0:bb348c97df44 172
lypinator 0:bb348c97df44 173 HAL_StatusTypeDef HAL_HCD_HC_Halt(HCD_HandleTypeDef *hhcd, uint8_t ch_num);
lypinator 0:bb348c97df44 174
lypinator 0:bb348c97df44 175 void HAL_HCD_MspInit(HCD_HandleTypeDef *hhcd);
lypinator 0:bb348c97df44 176 void HAL_HCD_MspDeInit(HCD_HandleTypeDef *hhcd);
lypinator 0:bb348c97df44 177 /**
lypinator 0:bb348c97df44 178 * @}
lypinator 0:bb348c97df44 179 */
lypinator 0:bb348c97df44 180
lypinator 0:bb348c97df44 181 /* I/O operation functions ***************************************************/
lypinator 0:bb348c97df44 182 /** @addtogroup HCD_Exported_Functions_Group2 Input and Output operation functions
lypinator 0:bb348c97df44 183 * @{
lypinator 0:bb348c97df44 184 */
lypinator 0:bb348c97df44 185 HAL_StatusTypeDef HAL_HCD_HC_SubmitRequest(HCD_HandleTypeDef *hhcd,
lypinator 0:bb348c97df44 186 uint8_t ch_num,
lypinator 0:bb348c97df44 187 uint8_t direction,
lypinator 0:bb348c97df44 188 uint8_t ep_type,
lypinator 0:bb348c97df44 189 uint8_t token,
lypinator 0:bb348c97df44 190 uint8_t* pbuff,
lypinator 0:bb348c97df44 191 uint16_t length,
lypinator 0:bb348c97df44 192 uint8_t do_ping);
lypinator 0:bb348c97df44 193
lypinator 0:bb348c97df44 194 /* Non-Blocking mode: Interrupt */
lypinator 0:bb348c97df44 195 void HAL_HCD_IRQHandler(HCD_HandleTypeDef *hhcd);
lypinator 0:bb348c97df44 196 void HAL_HCD_SOF_Callback(HCD_HandleTypeDef *hhcd);
lypinator 0:bb348c97df44 197 void HAL_HCD_Connect_Callback(HCD_HandleTypeDef *hhcd);
lypinator 0:bb348c97df44 198 void HAL_HCD_Disconnect_Callback(HCD_HandleTypeDef *hhcd);
lypinator 0:bb348c97df44 199 void HAL_HCD_HC_NotifyURBChange_Callback(HCD_HandleTypeDef *hhcd,
lypinator 0:bb348c97df44 200 uint8_t chnum,
lypinator 0:bb348c97df44 201 HCD_URBStateTypeDef urb_state);
lypinator 0:bb348c97df44 202 /**
lypinator 0:bb348c97df44 203 * @}
lypinator 0:bb348c97df44 204 */
lypinator 0:bb348c97df44 205
lypinator 0:bb348c97df44 206 /* Peripheral Control functions **********************************************/
lypinator 0:bb348c97df44 207 /** @addtogroup HCD_Exported_Functions_Group3 Peripheral Control functions
lypinator 0:bb348c97df44 208 * @{
lypinator 0:bb348c97df44 209 */
lypinator 0:bb348c97df44 210 HAL_StatusTypeDef HAL_HCD_ResetPort(HCD_HandleTypeDef *hhcd);
lypinator 0:bb348c97df44 211 HAL_StatusTypeDef HAL_HCD_Start(HCD_HandleTypeDef *hhcd);
lypinator 0:bb348c97df44 212 HAL_StatusTypeDef HAL_HCD_Stop(HCD_HandleTypeDef *hhcd);
lypinator 0:bb348c97df44 213 /**
lypinator 0:bb348c97df44 214 * @}
lypinator 0:bb348c97df44 215 */
lypinator 0:bb348c97df44 216
lypinator 0:bb348c97df44 217 /* Peripheral State functions ************************************************/
lypinator 0:bb348c97df44 218 /** @addtogroup HCD_Exported_Functions_Group4 Peripheral State functions
lypinator 0:bb348c97df44 219 * @{
lypinator 0:bb348c97df44 220 */
lypinator 0:bb348c97df44 221 HCD_StateTypeDef HAL_HCD_GetState(HCD_HandleTypeDef *hhcd);
lypinator 0:bb348c97df44 222 HCD_URBStateTypeDef HAL_HCD_HC_GetURBState(HCD_HandleTypeDef *hhcd, uint8_t chnum);
lypinator 0:bb348c97df44 223 uint32_t HAL_HCD_HC_GetXferCount(HCD_HandleTypeDef *hhcd, uint8_t chnum);
lypinator 0:bb348c97df44 224 HCD_HCStateTypeDef HAL_HCD_HC_GetState(HCD_HandleTypeDef *hhcd, uint8_t chnum);
lypinator 0:bb348c97df44 225 uint32_t HAL_HCD_GetCurrentFrame(HCD_HandleTypeDef *hhcd);
lypinator 0:bb348c97df44 226 uint32_t HAL_HCD_GetCurrentSpeed(HCD_HandleTypeDef *hhcd);
lypinator 0:bb348c97df44 227 /**
lypinator 0:bb348c97df44 228 * @}
lypinator 0:bb348c97df44 229 */
lypinator 0:bb348c97df44 230
lypinator 0:bb348c97df44 231 /**
lypinator 0:bb348c97df44 232 * @}
lypinator 0:bb348c97df44 233 */
lypinator 0:bb348c97df44 234
lypinator 0:bb348c97df44 235 /* Private macros ------------------------------------------------------------*/
lypinator 0:bb348c97df44 236 /** @defgroup HCD_Private_Macros HCD Private Macros
lypinator 0:bb348c97df44 237 * @{
lypinator 0:bb348c97df44 238 */
lypinator 0:bb348c97df44 239
lypinator 0:bb348c97df44 240 /**
lypinator 0:bb348c97df44 241 * @}
lypinator 0:bb348c97df44 242 */
lypinator 0:bb348c97df44 243
lypinator 0:bb348c97df44 244 /**
lypinator 0:bb348c97df44 245 * @}
lypinator 0:bb348c97df44 246 */
lypinator 0:bb348c97df44 247
lypinator 0:bb348c97df44 248 /**
lypinator 0:bb348c97df44 249 * @}
lypinator 0:bb348c97df44 250 */
lypinator 0:bb348c97df44 251 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx ||
lypinator 0:bb348c97df44 252 STM32F401xC || STM32F401xE || STM32F411xE || STM32F446xx || STM32F469xx || STM32F479xx || STM32F412Zx || STM32F412Rx ||
lypinator 0:bb348c97df44 253 STM32F412Vx || STM32F412Cx || defined(STM32F413xx) || defined(STM32F423xx) */
lypinator 0:bb348c97df44 254 #ifdef __cplusplus
lypinator 0:bb348c97df44 255 }
lypinator 0:bb348c97df44 256 #endif
lypinator 0:bb348c97df44 257
lypinator 0:bb348c97df44 258 #endif /* __STM32F4xx_HAL_HCD_H */
lypinator 0:bb348c97df44 259
lypinator 0:bb348c97df44 260 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/