|
STM32F439xx HAL User Manual
|
00001 /** 00002 ****************************************************************************** 00003 * @file stm32f4xx_hal_hcd.h 00004 * @author MCD Application Team 00005 * @brief Header file of HCD HAL module. 00006 ****************************************************************************** 00007 * @attention 00008 * 00009 * <h2><center>© COPYRIGHT(c) 2017 STMicroelectronics</center></h2> 00010 * 00011 * Redistribution and use in source and binary forms, with or without modification, 00012 * are permitted provided that the following conditions are met: 00013 * 1. Redistributions of source code must retain the above copyright notice, 00014 * this list of conditions and the following disclaimer. 00015 * 2. Redistributions in binary form must reproduce the above copyright notice, 00016 * this list of conditions and the following disclaimer in the documentation 00017 * and/or other materials provided with the distribution. 00018 * 3. Neither the name of STMicroelectronics nor the names of its contributors 00019 * may be used to endorse or promote products derived from this software 00020 * without specific prior written permission. 00021 * 00022 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 00023 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00024 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 00025 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 00026 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 00027 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 00028 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 00029 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 00030 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 00031 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00032 * 00033 ****************************************************************************** 00034 */ 00035 00036 /* Define to prevent recursive inclusion -------------------------------------*/ 00037 #ifndef __STM32F4xx_HAL_HCD_H 00038 #define __STM32F4xx_HAL_HCD_H 00039 00040 #ifdef __cplusplus 00041 extern "C" { 00042 #endif 00043 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || \ 00044 defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) || \ 00045 defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F411xE) || defined(STM32F446xx) || \ 00046 defined(STM32F469xx) || defined(STM32F479xx) || defined(STM32F412Zx) || defined(STM32F412Vx) || \ 00047 defined(STM32F412Rx) || defined(STM32F412Cx) || defined(STM32F413xx) || defined(STM32F423xx) 00048 /* Includes ------------------------------------------------------------------*/ 00049 #include "stm32f4xx_ll_usb.h" 00050 00051 /** @addtogroup STM32F4xx_HAL_Driver 00052 * @{ 00053 */ 00054 00055 /** @addtogroup HCD 00056 * @{ 00057 */ 00058 00059 /* Exported types ------------------------------------------------------------*/ 00060 /** @defgroup HCD_Exported_Types HCD Exported Types 00061 * @{ 00062 */ 00063 00064 /** @defgroup HCD_Exported_Types_Group1 HCD State Structure definition 00065 * @{ 00066 */ 00067 typedef enum 00068 { 00069 HAL_HCD_STATE_RESET = 0x00U, 00070 HAL_HCD_STATE_READY = 0x01U, 00071 HAL_HCD_STATE_ERROR = 0x02U, 00072 HAL_HCD_STATE_BUSY = 0x03U, 00073 HAL_HCD_STATE_TIMEOUT = 0x04U 00074 } HCD_StateTypeDef; 00075 00076 typedef USB_OTG_GlobalTypeDef HCD_TypeDef; 00077 typedef USB_OTG_CfgTypeDef HCD_InitTypeDef; 00078 typedef USB_OTG_HCTypeDef HCD_HCTypeDef ; 00079 typedef USB_OTG_URBStateTypeDef HCD_URBStateTypeDef ; 00080 typedef USB_OTG_HCStateTypeDef HCD_HCStateTypeDef ; 00081 /** 00082 * @} 00083 */ 00084 00085 /** @defgroup HCD_Exported_Types_Group2 HCD Handle Structure definition 00086 * @{ 00087 */ 00088 typedef struct 00089 { 00090 HCD_TypeDef *Instance; /*!< Register base address */ 00091 HCD_InitTypeDef Init; /*!< HCD required parameters */ 00092 HCD_HCTypeDef hc[15U]; /*!< Host channels parameters */ 00093 HAL_LockTypeDef Lock; /*!< HCD peripheral status */ 00094 __IO HCD_StateTypeDef State; /*!< HCD communication state */ 00095 void *pData; /*!< Pointer Stack Handler */ 00096 } HCD_HandleTypeDef; 00097 /** 00098 * @} 00099 */ 00100 00101 /** 00102 * @} 00103 */ 00104 00105 /* Exported constants --------------------------------------------------------*/ 00106 /** @defgroup HCD_Exported_Constants HCD Exported Constants 00107 * @{ 00108 */ 00109 00110 /** @defgroup HCD_Speed HCD Speed 00111 * @{ 00112 */ 00113 #define HCD_SPEED_HIGH 0U 00114 #define HCD_SPEED_LOW 2U 00115 #define HCD_SPEED_FULL 3U 00116 /** 00117 * @} 00118 */ 00119 00120 /** @defgroup HCD_PHY_Module HCD PHY Module 00121 * @{ 00122 */ 00123 #define HCD_PHY_ULPI 1U 00124 #define HCD_PHY_EMBEDDED 2U 00125 /** 00126 * @} 00127 */ 00128 00129 /** 00130 * @} 00131 */ 00132 00133 /* Exported macro ------------------------------------------------------------*/ 00134 /** @defgroup HCD_Exported_Macros HCD Exported Macros 00135 * @brief macros to handle interrupts and specific clock configurations 00136 * @{ 00137 */ 00138 #define __HAL_HCD_ENABLE(__HANDLE__) USB_EnableGlobalInt ((__HANDLE__)->Instance) 00139 #define __HAL_HCD_DISABLE(__HANDLE__) USB_DisableGlobalInt ((__HANDLE__)->Instance) 00140 00141 #define __HAL_HCD_GET_FLAG(__HANDLE__, __INTERRUPT__) ((USB_ReadInterrupts((__HANDLE__)->Instance) & (__INTERRUPT__)) == (__INTERRUPT__)) 00142 #define __HAL_HCD_CLEAR_FLAG(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->GINTSTS) = (__INTERRUPT__)) 00143 #define __HAL_HCD_IS_INVALID_INTERRUPT(__HANDLE__) (USB_ReadInterrupts((__HANDLE__)->Instance) == 0U) 00144 00145 #define __HAL_HCD_CLEAR_HC_INT(chnum, __INTERRUPT__) (USBx_HC(chnum)->HCINT = (__INTERRUPT__)) 00146 #define __HAL_HCD_MASK_HALT_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK &= ~USB_OTG_HCINTMSK_CHHM) 00147 #define __HAL_HCD_UNMASK_HALT_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK |= USB_OTG_HCINTMSK_CHHM) 00148 #define __HAL_HCD_MASK_ACK_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK &= ~USB_OTG_HCINTMSK_ACKM) 00149 #define __HAL_HCD_UNMASK_ACK_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK |= USB_OTG_HCINTMSK_ACKM) 00150 /** 00151 * @} 00152 */ 00153 00154 /* Exported functions --------------------------------------------------------*/ 00155 /** @addtogroup HCD_Exported_Functions HCD Exported Functions 00156 * @{ 00157 */ 00158 00159 /* Initialization/de-initialization functions ********************************/ 00160 /** @addtogroup HCD_Exported_Functions_Group1 Initialization and de-initialization functions 00161 * @{ 00162 */ 00163 HAL_StatusTypeDef HAL_HCD_Init(HCD_HandleTypeDef *hhcd); 00164 HAL_StatusTypeDef HAL_HCD_DeInit(HCD_HandleTypeDef *hhcd); 00165 HAL_StatusTypeDef HAL_HCD_HC_Init(HCD_HandleTypeDef *hhcd, 00166 uint8_t ch_num, 00167 uint8_t epnum, 00168 uint8_t dev_address, 00169 uint8_t speed, 00170 uint8_t ep_type, 00171 uint16_t mps); 00172 00173 HAL_StatusTypeDef HAL_HCD_HC_Halt(HCD_HandleTypeDef *hhcd, uint8_t ch_num); 00174 00175 void HAL_HCD_MspInit(HCD_HandleTypeDef *hhcd); 00176 void HAL_HCD_MspDeInit(HCD_HandleTypeDef *hhcd); 00177 /** 00178 * @} 00179 */ 00180 00181 /* I/O operation functions ***************************************************/ 00182 /** @addtogroup HCD_Exported_Functions_Group2 Input and Output operation functions 00183 * @{ 00184 */ 00185 HAL_StatusTypeDef HAL_HCD_HC_SubmitRequest(HCD_HandleTypeDef *hhcd, 00186 uint8_t ch_num, 00187 uint8_t direction, 00188 uint8_t ep_type, 00189 uint8_t token, 00190 uint8_t* pbuff, 00191 uint16_t length, 00192 uint8_t do_ping); 00193 00194 /* Non-Blocking mode: Interrupt */ 00195 void HAL_HCD_IRQHandler(HCD_HandleTypeDef *hhcd); 00196 void HAL_HCD_SOF_Callback(HCD_HandleTypeDef *hhcd); 00197 void HAL_HCD_Connect_Callback(HCD_HandleTypeDef *hhcd); 00198 void HAL_HCD_Disconnect_Callback(HCD_HandleTypeDef *hhcd); 00199 void HAL_HCD_HC_NotifyURBChange_Callback(HCD_HandleTypeDef *hhcd, 00200 uint8_t chnum, 00201 HCD_URBStateTypeDef urb_state); 00202 /** 00203 * @} 00204 */ 00205 00206 /* Peripheral Control functions **********************************************/ 00207 /** @addtogroup HCD_Exported_Functions_Group3 Peripheral Control functions 00208 * @{ 00209 */ 00210 HAL_StatusTypeDef HAL_HCD_ResetPort(HCD_HandleTypeDef *hhcd); 00211 HAL_StatusTypeDef HAL_HCD_Start(HCD_HandleTypeDef *hhcd); 00212 HAL_StatusTypeDef HAL_HCD_Stop(HCD_HandleTypeDef *hhcd); 00213 /** 00214 * @} 00215 */ 00216 00217 /* Peripheral State functions ************************************************/ 00218 /** @addtogroup HCD_Exported_Functions_Group4 Peripheral State functions 00219 * @{ 00220 */ 00221 HCD_StateTypeDef HAL_HCD_GetState(HCD_HandleTypeDef *hhcd); 00222 HCD_URBStateTypeDef HAL_HCD_HC_GetURBState(HCD_HandleTypeDef *hhcd, uint8_t chnum); 00223 uint32_t HAL_HCD_HC_GetXferCount(HCD_HandleTypeDef *hhcd, uint8_t chnum); 00224 HCD_HCStateTypeDef HAL_HCD_HC_GetState(HCD_HandleTypeDef *hhcd, uint8_t chnum); 00225 uint32_t HAL_HCD_GetCurrentFrame(HCD_HandleTypeDef *hhcd); 00226 uint32_t HAL_HCD_GetCurrentSpeed(HCD_HandleTypeDef *hhcd); 00227 /** 00228 * @} 00229 */ 00230 00231 /** 00232 * @} 00233 */ 00234 00235 /* Private macros ------------------------------------------------------------*/ 00236 /** @defgroup HCD_Private_Macros HCD Private Macros 00237 * @{ 00238 */ 00239 00240 /** 00241 * @} 00242 */ 00243 00244 /** 00245 * @} 00246 */ 00247 00248 /** 00249 * @} 00250 */ 00251 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx || 00252 STM32F401xC || STM32F401xE || STM32F411xE || STM32F446xx || STM32F469xx || STM32F479xx || STM32F412Zx || STM32F412Rx || 00253 STM32F412Vx || STM32F412Cx || defined(STM32F413xx) || defined(STM32F423xx) */ 00254 #ifdef __cplusplus 00255 } 00256 #endif 00257 00258 #endif /* __STM32F4xx_HAL_HCD_H */ 00259 00260 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
1.7.6.1