mbed official / mbed

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

TARGET_DISCO_F469NI/stm32f4xx_hal_hcd.h@122:f9eeca106725, 2016-07-07 (annotated)

Committer:
Kojto
Date:
Thu Jul 07 14:34:11 2016 +0100
Revision:
122:f9eeca106725
Parent:
110:165afa46840b 
Release 122 of the mbed library



Changes:

- new targets - Nucleo L432KC, Beetle, Nucleo F446ZE, Nucleo L011K4

- Thread safety addition - mbed API should contain a statement about thread safety

- critical section API addition

- CAS API (core_util_atomic_incr/decr)

- DEVICE_ are generated from targets.json file, device.h deprecated

- Callback replaces FunctionPointer to provide std like interface

- mbed HAL API docs improvements

- toolchain - prexif attributes with MBED_

            - add new attributes - packed, weak, forcedinline, align

- target.json - contains targets definitions

- ST - L1XX - Cube update to 1.5

     - SPI clock selection fix (clock from APB domain)

     - F7 - Cube update v1.4.0

     - L0 -  baudrate init fix

     - L1 - Cube update v1.5

     - F3 - baudrate init fix, 3 targets CAN support

     - F4 - Cube update v1.12.0, 3 targets CAN support

     - L4XX - Cube update v1.5.1

     - F0 - update Cube to v1.5.0

     - L4 - 2 targets (L476RG/VG) CAN support

- NXP - pwm clock fix for KSDK2 MCU

      - LPC2368 - remove ARM toolchain support - due to regression

      - KSDK2 - fix SPI , I2C address and repeat start

- Silabs - some fixes backported from mbed 3

- Renesas - RZ_A1H - SystemCoreClockUpdate addition

Who changed what in which revision?

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