Egor Rumjantsev / mbed

The official mbed C/C SDK provides the software platform and libraries to build your applications.

Fork of mbed by mbed official

TARGET_NUCLEO_F401RE/stm32f4xx_hal_pcd.h@77:869cf507173a, 2014-02-14 (annotated)

Committer:
emilmont
Date:
Fri Feb 14 14:36:43 2014 +0000
Revision:
77:869cf507173a
Child:
81:7d30d6019079
Release 77 of the mbed library



Main changes:

* Add target NUCLEO_F030R8

* Add target NUCLEO_F401RE

* Add target NUCLEO_F103RB

* Add target NUCLEO_L152RE

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 77:869cf507173a 1 /**
emilmont 77:869cf507173a 2 ******************************************************************************
emilmont 77:869cf507173a 3 * @file stm32f4xx_hal_pcd.h
emilmont 77:869cf507173a 4 * @author MCD Application Team
emilmont 77:869cf507173a 5 * @version V1.0.0RC2
emilmont 77:869cf507173a 6 * @date 04-February-2014
emilmont 77:869cf507173a 7 * @brief Header file of PCD HAL module.
emilmont 77:869cf507173a 8 ******************************************************************************
emilmont 77:869cf507173a 9 * @attention
emilmont 77:869cf507173a 10 *
emilmont 77:869cf507173a 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
emilmont 77:869cf507173a 12 *
emilmont 77:869cf507173a 13 * Redistribution and use in source and binary forms, with or without modification,
emilmont 77:869cf507173a 14 * are permitted provided that the following conditions are met:
emilmont 77:869cf507173a 15 * 1. Redistributions of source code must retain the above copyright notice,
emilmont 77:869cf507173a 16 * this list of conditions and the following disclaimer.
emilmont 77:869cf507173a 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
emilmont 77:869cf507173a 18 * this list of conditions and the following disclaimer in the documentation
emilmont 77:869cf507173a 19 * and/or other materials provided with the distribution.
emilmont 77:869cf507173a 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
emilmont 77:869cf507173a 21 * may be used to endorse or promote products derived from this software
emilmont 77:869cf507173a 22 * without specific prior written permission.
emilmont 77:869cf507173a 23 *
emilmont 77:869cf507173a 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
emilmont 77:869cf507173a 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
emilmont 77:869cf507173a 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
emilmont 77:869cf507173a 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
emilmont 77:869cf507173a 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
emilmont 77:869cf507173a 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
emilmont 77:869cf507173a 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
emilmont 77:869cf507173a 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
emilmont 77:869cf507173a 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
emilmont 77:869cf507173a 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
emilmont 77:869cf507173a 34 *
emilmont 77:869cf507173a 35 ******************************************************************************
emilmont 77:869cf507173a 36 */
emilmont 77:869cf507173a 37
emilmont 77:869cf507173a 38 /* Define to prevent recursive inclusion -------------------------------------*/
emilmont 77:869cf507173a 39 #ifndef __STM32F4xx_HAL_PCD_H
emilmont 77:869cf507173a 40 #define __STM32F4xx_HAL_PCD_H
emilmont 77:869cf507173a 41
emilmont 77:869cf507173a 42 #ifdef __cplusplus
emilmont 77:869cf507173a 43 extern "C" {
emilmont 77:869cf507173a 44 #endif
emilmont 77:869cf507173a 45
emilmont 77:869cf507173a 46 /* Includes ------------------------------------------------------------------*/
emilmont 77:869cf507173a 47 #include "stm32f4xx_ll_usb.h"
emilmont 77:869cf507173a 48
emilmont 77:869cf507173a 49 /** @addtogroup STM32F4xx_HAL_Driver
emilmont 77:869cf507173a 50 * @{
emilmont 77:869cf507173a 51 */
emilmont 77:869cf507173a 52
emilmont 77:869cf507173a 53 /** @addtogroup PCD
emilmont 77:869cf507173a 54 * @{
emilmont 77:869cf507173a 55 */
emilmont 77:869cf507173a 56
emilmont 77:869cf507173a 57 /* Exported types ------------------------------------------------------------*/
emilmont 77:869cf507173a 58
emilmont 77:869cf507173a 59 /**
emilmont 77:869cf507173a 60 * @brief PCD State structures definition
emilmont 77:869cf507173a 61 */
emilmont 77:869cf507173a 62 typedef enum
emilmont 77:869cf507173a 63 {
emilmont 77:869cf507173a 64 PCD_READY = 0x00,
emilmont 77:869cf507173a 65 PCD_ERROR = 0x01,
emilmont 77:869cf507173a 66 PCD_BUSY = 0x02,
emilmont 77:869cf507173a 67 PCD_TIMEOUT = 0x03
emilmont 77:869cf507173a 68 } PCD_StateTypeDef;
emilmont 77:869cf507173a 69
emilmont 77:869cf507173a 70
emilmont 77:869cf507173a 71 typedef USB_OTG_GlobalTypeDef PCD_TypeDef;
emilmont 77:869cf507173a 72 typedef USB_OTG_CfgTypeDef PCD_InitTypeDef;
emilmont 77:869cf507173a 73 typedef USB_OTG_EPTypeDef PCD_EPTypeDef ;
emilmont 77:869cf507173a 74
emilmont 77:869cf507173a 75 /**
emilmont 77:869cf507173a 76 * @brief PCD Handle Structure definition
emilmont 77:869cf507173a 77 */
emilmont 77:869cf507173a 78 typedef struct
emilmont 77:869cf507173a 79 {
emilmont 77:869cf507173a 80 PCD_TypeDef *Instance; /*!< Register base address */
emilmont 77:869cf507173a 81 PCD_InitTypeDef Init; /*!< PCD required parameters */
emilmont 77:869cf507173a 82 PCD_EPTypeDef IN_ep[15]; /*!< IN endpoint parameters */
emilmont 77:869cf507173a 83 PCD_EPTypeDef OUT_ep[15]; /*!< OUT endpoint parameters */
emilmont 77:869cf507173a 84 HAL_LockTypeDef Lock; /*!< PCD peripheral status */
emilmont 77:869cf507173a 85 __IO PCD_StateTypeDef State; /*!< PCD communication state */
emilmont 77:869cf507173a 86 uint32_t Setup[12]; /*!< Setup packet buffer */
emilmont 77:869cf507173a 87 void *pData; /*!< Pointer to upper stack Handler */
emilmont 77:869cf507173a 88
emilmont 77:869cf507173a 89 } PCD_HandleTypeDef;
emilmont 77:869cf507173a 90
emilmont 77:869cf507173a 91 /* Exported constants --------------------------------------------------------*/
emilmont 77:869cf507173a 92 /** @defgroup PCD_Exported_Constants
emilmont 77:869cf507173a 93 * @{
emilmont 77:869cf507173a 94 */
emilmont 77:869cf507173a 95
emilmont 77:869cf507173a 96 /** @defgroup PCD_Speed
emilmont 77:869cf507173a 97 * @{
emilmont 77:869cf507173a 98 */
emilmont 77:869cf507173a 99 #define PCD_SPEED_HIGH 0
emilmont 77:869cf507173a 100 #define PCD_SPEED_HIGH_IN_FULL 1
emilmont 77:869cf507173a 101 #define PCD_SPEED_LOW 2
emilmont 77:869cf507173a 102 #define PCD_SPEED_FULL 3
emilmont 77:869cf507173a 103 /**
emilmont 77:869cf507173a 104 * @}
emilmont 77:869cf507173a 105 */
emilmont 77:869cf507173a 106
emilmont 77:869cf507173a 107 /** @defgroup PCD_PHY_Module
emilmont 77:869cf507173a 108 * @{
emilmont 77:869cf507173a 109 */
emilmont 77:869cf507173a 110 #define PCD_PHY_ULPI 1
emilmont 77:869cf507173a 111 #define PCD_PHY_EMBEDDED 2
emilmont 77:869cf507173a 112 /**
emilmont 77:869cf507173a 113 * @}
emilmont 77:869cf507173a 114 */
emilmont 77:869cf507173a 115
emilmont 77:869cf507173a 116 /** @defgroup PCD_Instance_definition
emilmont 77:869cf507173a 117 * @{
emilmont 77:869cf507173a 118 */
emilmont 77:869cf507173a 119 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx)
emilmont 77:869cf507173a 120 #define IS_PCD_ALL_INSTANCE(INSTANCE) (((INSTANCE) == USB_OTG_FS) || \
emilmont 77:869cf507173a 121 ((INSTANCE) == USB_OTG_HS))
emilmont 77:869cf507173a 122 #elif defined(STM32F401xC) || defined(STM32F401xE)
emilmont 77:869cf507173a 123 #define IS_PCD_ALL_INSTANCE(INSTANCE) (((INSTANCE) == USB_OTG_FS))
emilmont 77:869cf507173a 124 #endif
emilmont 77:869cf507173a 125
emilmont 77:869cf507173a 126 /**
emilmont 77:869cf507173a 127 * @}
emilmont 77:869cf507173a 128 */
emilmont 77:869cf507173a 129
emilmont 77:869cf507173a 130 /**
emilmont 77:869cf507173a 131 * @}
emilmont 77:869cf507173a 132 */
emilmont 77:869cf507173a 133
emilmont 77:869cf507173a 134 /* Exported macro ------------------------------------------------------------*/
emilmont 77:869cf507173a 135
emilmont 77:869cf507173a 136 /** @defgroup PCD_Interrupt_Clock
emilmont 77:869cf507173a 137 * @brief macros to handle interrupts and specific clock configurations
emilmont 77:869cf507173a 138 * @{
emilmont 77:869cf507173a 139 */
emilmont 77:869cf507173a 140 #define __HAL_PCD_ENABLE(__HANDLE__) USB_EnableGlobalInt ((__HANDLE__)->Instance)
emilmont 77:869cf507173a 141 #define __HAL_PCD_DISABLE(__HANDLE__) USB_DisableGlobalInt ((__HANDLE__)->Instance)
emilmont 77:869cf507173a 142
emilmont 77:869cf507173a 143 #define __HAL_GET_FLAG(__HANDLE__, __INTERRUPT__) ((USB_ReadInterrupts((__HANDLE__)->Instance) & (__INTERRUPT__)) == (__INTERRUPT__))
emilmont 77:869cf507173a 144 #define __HAL_CLEAR_FLAG(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->GINTSTS) |= (__INTERRUPT__))
emilmont 77:869cf507173a 145 #define __HAL_IS_INVALID_INTERRUPT(__HANDLE__) (USB_ReadInterrupts((__HANDLE__)->Instance) == 0)
emilmont 77:869cf507173a 146 /**
emilmont 77:869cf507173a 147 * @}
emilmont 77:869cf507173a 148 */
emilmont 77:869cf507173a 149
emilmont 77:869cf507173a 150 /* Exported functions --------------------------------------------------------*/
emilmont 77:869cf507173a 151
emilmont 77:869cf507173a 152 /* Initialization/de-initialization functions **********************************/
emilmont 77:869cf507173a 153 HAL_StatusTypeDef HAL_PCD_Init(PCD_HandleTypeDef *hpcd);
emilmont 77:869cf507173a 154 HAL_StatusTypeDef HAL_PCD_DeInit (PCD_HandleTypeDef *hpcd);
emilmont 77:869cf507173a 155 void HAL_PCD_MspInit(PCD_HandleTypeDef *hpcd);
emilmont 77:869cf507173a 156 void HAL_PCD_MspDeInit(PCD_HandleTypeDef *hpcd);
emilmont 77:869cf507173a 157
emilmont 77:869cf507173a 158 /* I/O operation functions *****************************************************/
emilmont 77:869cf507173a 159 /* Non-Blocking mode: Interrupt */
emilmont 77:869cf507173a 160 HAL_StatusTypeDef HAL_PCD_Start(PCD_HandleTypeDef *hpcd);
emilmont 77:869cf507173a 161 HAL_StatusTypeDef HAL_PCD_Stop(PCD_HandleTypeDef *hpcd);
emilmont 77:869cf507173a 162 void HAL_PCD_IRQHandler(PCD_HandleTypeDef *hpcd);
emilmont 77:869cf507173a 163
emilmont 77:869cf507173a 164 __weak void HAL_PCD_DataOutStageCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
emilmont 77:869cf507173a 165 __weak void HAL_PCD_DataInStageCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
emilmont 77:869cf507173a 166 __weak void HAL_PCD_SetupStageCallback(PCD_HandleTypeDef *hpcd);
emilmont 77:869cf507173a 167 __weak void HAL_PCD_SOFCallback(PCD_HandleTypeDef *hpcd);
emilmont 77:869cf507173a 168 __weak void HAL_PCD_ResetCallback(PCD_HandleTypeDef *hpcd);
emilmont 77:869cf507173a 169 __weak void HAL_PCD_SuspendCallback(PCD_HandleTypeDef *hpcd);
emilmont 77:869cf507173a 170 __weak void HAL_PCD_ResumeCallback(PCD_HandleTypeDef *hpcd);
emilmont 77:869cf507173a 171 __weak void HAL_PCD_ISOOUTIncompleteCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
emilmont 77:869cf507173a 172 __weak void HAL_PCD_ISOINIncompleteCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
emilmont 77:869cf507173a 173 __weak void HAL_PCD_ConnectCallback(PCD_HandleTypeDef *hpcd);
emilmont 77:869cf507173a 174 __weak void HAL_PCD_DisconnectCallback(PCD_HandleTypeDef *hpcd);
emilmont 77:869cf507173a 175
emilmont 77:869cf507173a 176 /* Peripheral Control functions ************************************************/
emilmont 77:869cf507173a 177 HAL_StatusTypeDef HAL_PCD_DevConnect(PCD_HandleTypeDef *hpcd);
emilmont 77:869cf507173a 178 HAL_StatusTypeDef HAL_PCD_DevDisconnect(PCD_HandleTypeDef *hpcd);
emilmont 77:869cf507173a 179 HAL_StatusTypeDef HAL_PCD_SetAddress(PCD_HandleTypeDef *hpcd, uint8_t address);
emilmont 77:869cf507173a 180 HAL_StatusTypeDef HAL_PCD_EP_Open(PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint16_t ep_mps, uint8_t ep_type);
emilmont 77:869cf507173a 181 HAL_StatusTypeDef HAL_PCD_EP_Close(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
emilmont 77:869cf507173a 182 HAL_StatusTypeDef HAL_PCD_EP_Receive(PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf, uint32_t len);
emilmont 77:869cf507173a 183 HAL_StatusTypeDef HAL_PCD_EP_Transmit(PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf, uint32_t len);
emilmont 77:869cf507173a 184 uint16_t HAL_PCD_EP_GetRxCount(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
emilmont 77:869cf507173a 185 HAL_StatusTypeDef HAL_PCD_EP_SetStall(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
emilmont 77:869cf507173a 186 HAL_StatusTypeDef HAL_PCD_EP_ClrStall(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
emilmont 77:869cf507173a 187 HAL_StatusTypeDef HAL_PCD_EP_Flush(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
emilmont 77:869cf507173a 188 HAL_StatusTypeDef HAL_PCD_SetTxFiFo(PCD_HandleTypeDef *hpcd, uint8_t fifo, uint16_t size);
emilmont 77:869cf507173a 189 HAL_StatusTypeDef HAL_PCD_SetRxFiFo(PCD_HandleTypeDef *hpcd, uint16_t size);
emilmont 77:869cf507173a 190
emilmont 77:869cf507173a 191 /* Peripheral State functions **************************************************/
emilmont 77:869cf507173a 192 PCD_StateTypeDef HAL_PCD_GetState(PCD_HandleTypeDef *hpcd);
emilmont 77:869cf507173a 193
emilmont 77:869cf507173a 194 /**
emilmont 77:869cf507173a 195 * @}
emilmont 77:869cf507173a 196 */
emilmont 77:869cf507173a 197
emilmont 77:869cf507173a 198 /**
emilmont 77:869cf507173a 199 * @}
emilmont 77:869cf507173a 200 */
emilmont 77:869cf507173a 201
emilmont 77:869cf507173a 202 #ifdef __cplusplus
emilmont 77:869cf507173a 203 }
emilmont 77:869cf507173a 204 #endif
emilmont 77:869cf507173a 205
emilmont 77:869cf507173a 206
emilmont 77:869cf507173a 207 #endif /* __STM32F4xx_HAL_PCD_H */
emilmont 77:869cf507173a 208
emilmont 77:869cf507173a 209 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/