source: rtems/c/src/lib/libbsp/arm/stm32f7x/hal/STM32F7xx_HAL_Driver/Inc/stm32f7xx_hal_pcd.h @ c20847a5

5
Last change on this file since c20847a5 was c20847a5, checked in by Isaac Gutekunst <isaac.gutekunst@…>, on 09/16/15 at 13:16:02

Add STM32F7 HAL Files

These files originated as:

+ STC32CubeF7 V1.1.0 from ​http://www.st.com/web/en/catalog/tools/PF261909
  • Property mode set to 100644
File size: 13.1 KB
Line 
1/**
2  ******************************************************************************
3  * @file    stm32f7xx_hal_pcd.h
4  * @author  MCD Application Team
5  * @version V1.0.1
6  * @date    25-June-2015
7  * @brief   Header file of PCD HAL module.
8  ******************************************************************************
9  * @attention
10  *
11  * <h2><center>&copy; COPYRIGHT(c) 2015 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 __STM32F7xx_HAL_PCD_H
40#define __STM32F7xx_HAL_PCD_H
41
42#ifdef __cplusplus
43 extern "C" {
44#endif
45
46/* Includes ------------------------------------------------------------------*/
47#include "stm32f7xx_ll_usb.h"
48
49/** @addtogroup STM32F7xx_HAL_Driver
50  * @{
51  */
52
53/** @addtogroup PCD
54  * @{
55  */
56
57/* Exported types ------------------------------------------------------------*/
58/** @defgroup PCD_Exported_Types PCD Exported Types
59  * @{
60  */
61
62/**
63  * @brief  PCD State structure definition
64  */
65typedef enum
66{
67  HAL_PCD_STATE_RESET   = 0x00,
68  HAL_PCD_STATE_READY   = 0x01,
69  HAL_PCD_STATE_ERROR   = 0x02,
70  HAL_PCD_STATE_BUSY    = 0x03,
71  HAL_PCD_STATE_TIMEOUT = 0x04
72} PCD_StateTypeDef;
73
74/* Device LPM suspend state */
75typedef enum
76{
77  LPM_L0 = 0x00, /* on */
78  LPM_L1 = 0x01, /* LPM L1 sleep */
79  LPM_L2 = 0x02, /* suspend */
80  LPM_L3 = 0x03, /* off */
81}PCD_LPM_StateTypeDef;
82
83typedef USB_OTG_GlobalTypeDef  PCD_TypeDef;
84typedef USB_OTG_CfgTypeDef     PCD_InitTypeDef;
85typedef USB_OTG_EPTypeDef      PCD_EPTypeDef ;
86
87/**
88  * @brief  PCD Handle Structure definition
89  */
90typedef struct
91{
92  PCD_TypeDef             *Instance;   /*!< Register base address              */
93  PCD_InitTypeDef         Init;       /*!< PCD required parameters            */
94  PCD_EPTypeDef           IN_ep[15];  /*!< IN endpoint parameters             */
95  PCD_EPTypeDef           OUT_ep[15]; /*!< OUT endpoint parameters            */
96  HAL_LockTypeDef         Lock;       /*!< PCD peripheral status              */
97  __IO PCD_StateTypeDef   State;      /*!< PCD communication state            */
98  uint32_t                Setup[12];  /*!< Setup packet buffer                */
99  PCD_LPM_StateTypeDef    LPM_State;    /*!< LPM State                          */
100  uint32_t                BESL;
101  uint32_t                lpm_active;   /*!< Enable or disable the Link Power Management .
102                                        This parameter can be set to ENABLE or DISABLE */
103  void                    *pData;       /*!< Pointer to upper stack Handler */
104} PCD_HandleTypeDef;
105
106/**
107  * @}
108  */
109
110/* Include PCD HAL Extension module */
111#include "stm32f7xx_hal_pcd_ex.h"
112
113/* Exported constants --------------------------------------------------------*/
114/** @defgroup PCD_Exported_Constants PCD Exported Constants
115  * @{
116  */
117
118/** @defgroup PCD_Speed PCD Speed
119  * @{
120  */
121#define PCD_SPEED_HIGH               0
122#define PCD_SPEED_HIGH_IN_FULL       1
123#define PCD_SPEED_FULL               2
124/**
125  * @}
126  */
127
128/** @defgroup PCD_PHY_Module PCD PHY Module
129  * @{
130  */
131#define PCD_PHY_ULPI                 1
132#define PCD_PHY_EMBEDDED             2
133/**
134  * @}
135  */
136
137/** @defgroup PCD_Turnaround_Timeout Turnaround Timeout Value
138  * @{
139  */
140#ifndef USBD_HS_TRDT_VALUE
141 #define USBD_HS_TRDT_VALUE           9
142#endif /* USBD_HS_TRDT_VALUE */
143#ifndef USBD_FS_TRDT_VALUE
144 #define USBD_FS_TRDT_VALUE           5
145#endif /* USBD_HS_TRDT_VALUE */
146
147/**
148  * @}
149  */
150
151/**
152  * @}
153  */
154
155/* Exported macros -----------------------------------------------------------*/
156/** @defgroup PCD_Exported_Macros PCD Exported Macros
157 *  @brief macros to handle interrupts and specific clock configurations
158 * @{
159 */
160#define __HAL_PCD_ENABLE(__HANDLE__)                   USB_EnableGlobalInt ((__HANDLE__)->Instance)
161#define __HAL_PCD_DISABLE(__HANDLE__)                  USB_DisableGlobalInt ((__HANDLE__)->Instance)
162
163#define __HAL_PCD_GET_FLAG(__HANDLE__, __INTERRUPT__)      ((USB_ReadInterrupts((__HANDLE__)->Instance) & (__INTERRUPT__)) == (__INTERRUPT__))
164#define __HAL_PCD_CLEAR_FLAG(__HANDLE__, __INTERRUPT__)    (((__HANDLE__)->Instance->GINTSTS) = (__INTERRUPT__))
165#define __HAL_PCD_IS_INVALID_INTERRUPT(__HANDLE__)         (USB_ReadInterrupts((__HANDLE__)->Instance) == 0)
166
167
168#define __HAL_PCD_UNGATE_PHYCLOCK(__HANDLE__)             *(__IO uint32_t *)((uint32_t)((__HANDLE__)->Instance) + USB_OTG_PCGCCTL_BASE) &= \
169                                                       ~(USB_OTG_PCGCCTL_STOPCLK)
170
171#define __HAL_PCD_GATE_PHYCLOCK(__HANDLE__)               *(__IO uint32_t *)((uint32_t)((__HANDLE__)->Instance) + USB_OTG_PCGCCTL_BASE) |= USB_OTG_PCGCCTL_STOPCLK
172
173#define __HAL_PCD_IS_PHY_SUSPENDED(__HANDLE__)            ((*(__IO uint32_t *)((uint32_t)((__HANDLE__)->Instance) + USB_OTG_PCGCCTL_BASE))&0x10)
174
175#define USB_OTG_FS_WAKEUP_EXTI_RISING_EDGE      ((uint32_t)0x08)
176#define USB_OTG_FS_WAKEUP_EXTI_FALLING_EDGE     ((uint32_t)0x0C)
177#define USB_OTG_FS_WAKEUP_EXTI_RISING_FALLING_EDGE        ((uint32_t)0x10)
178
179#define USB_OTG_HS_WAKEUP_EXTI_RISING_EDGE      ((uint32_t)0x08)
180#define USB_OTG_HS_WAKEUP_EXTI_FALLING_EDGE     ((uint32_t)0x0C)
181#define USB_OTG_HS_WAKEUP_EXTI_RISING_FALLING_EDGE        ((uint32_t)0x10)
182
183#define USB_OTG_HS_WAKEUP_EXTI_LINE              ((uint32_t)0x00100000)  /*!< External interrupt line 20 Connected to the USB HS EXTI Line */
184#define USB_OTG_FS_WAKEUP_EXTI_LINE              ((uint32_t)0x00040000)  /*!< External interrupt line 18 Connected to the USB FS EXTI Line */
185
186#define __HAL_USB_OTG_HS_WAKEUP_EXTI_ENABLE_IT()    EXTI->IMR |= (USB_OTG_HS_WAKEUP_EXTI_LINE)
187#define __HAL_USB_OTG_HS_WAKEUP_EXTI_DISABLE_IT()   EXTI->IMR &= ~(USB_OTG_HS_WAKEUP_EXTI_LINE)
188#define __HAL_USB_OTG_HS_WAKEUP_EXTI_GET_FLAG()     EXTI->PR & (USB_OTG_HS_WAKEUP_EXTI_LINE)
189#define __HAL_USB_OTG_HS_WAKEUP_EXTI_CLEAR_FLAG()   EXTI->PR = (USB_OTG_HS_WAKEUP_EXTI_LINE)
190
191#define __HAL_USB_OTG_HS_WAKEUP_EXTI_ENABLE_RISING_EDGE() EXTI->FTSR &= ~(USB_OTG_HS_WAKEUP_EXTI_LINE);\
192                                                          EXTI->RTSR |= USB_OTG_HS_WAKEUP_EXTI_LINE
193
194#define __HAL_USB_OTG_HS_WAKEUP_EXTI_ENABLE_FALLING_EDGE()  EXTI->FTSR |= (USB_OTG_HS_WAKEUP_EXTI_LINE);\
195                                                            EXTI->RTSR &= ~(USB_OTG_HS_WAKEUP_EXTI_LINE)
196
197#define __HAL_USB_OTG_HS_WAKEUP_EXTI_ENABLE_RISING_FALLING_EDGE()   EXTI->RTSR &= ~(USB_OTG_HS_WAKEUP_EXTI_LINE);\
198                                                                    EXTI->FTSR &= ~(USB_OTG_HS_WAKEUP_EXTI_LINE;)\
199                                                                    EXTI->RTSR |= USB_OTG_HS_WAKEUP_EXTI_LINE;\
200                                                                    EXTI->FTSR |= USB_OTG_HS_WAKEUP_EXTI_LINE
201
202#define __HAL_USB_OTG_HS_WAKEUP_EXTI_GENERATE_SWIT()   (EXTI->SWIER |= USB_OTG_FS_WAKEUP_EXTI_LINE)
203
204#define __HAL_USB_OTG_FS_WAKEUP_EXTI_ENABLE_IT()    EXTI->IMR |= USB_OTG_FS_WAKEUP_EXTI_LINE
205#define __HAL_USB_OTG_FS_WAKEUP_EXTI_DISABLE_IT()   EXTI->IMR &= ~(USB_OTG_FS_WAKEUP_EXTI_LINE)
206#define __HAL_USB_OTG_FS_WAKEUP_EXTI_GET_FLAG()     EXTI->PR & (USB_OTG_FS_WAKEUP_EXTI_LINE)
207#define __HAL_USB_OTG_FS_WAKEUP_EXTI_CLEAR_FLAG()   EXTI->PR = USB_OTG_FS_WAKEUP_EXTI_LINE
208
209#define __HAL_USB_OTG_FS_WAKEUP_EXTI_ENABLE_RISING_EDGE() EXTI->FTSR &= ~(USB_OTG_FS_WAKEUP_EXTI_LINE);\
210                                                          EXTI->RTSR |= USB_OTG_FS_WAKEUP_EXTI_LINE
211
212
213#define __HAL_USB_OTG_FS_WAKEUP_EXTI_ENABLE_FALLING_EDGE()  EXTI->FTSR |= (USB_OTG_FS_WAKEUP_EXTI_LINE);\
214                                                            EXTI->RTSR &= ~(USB_OTG_FS_WAKEUP_EXTI_LINE)
215
216#define __HAL_USB_OTG_FS_WAKEUP_EXTI_ENABLE_RISING_FALLING_EDGE()  EXTI->RTSR &= ~(USB_OTG_FS_WAKEUP_EXTI_LINE);\
217                                                                   EXTI->FTSR &= ~(USB_OTG_FS_WAKEUP_EXTI_LINE);\
218                                                                   EXTI->RTSR |= USB_OTG_FS_WAKEUP_EXTI_LINE;\
219                                                                   EXTI->FTSR |= USB_OTG_FS_WAKEUP_EXTI_LINE
220
221#define __HAL_USB_OTG_FS_WAKEUP_EXTI_GENERATE_SWIT()  (EXTI->SWIER |= USB_OTG_FS_WAKEUP_EXTI_LINE)
222
223/* Exported functions --------------------------------------------------------*/
224/** @addtogroup PCD_Exported_Functions PCD Exported Functions
225  * @{
226  */
227
228/* Initialization/de-initialization functions  ********************************/
229/** @addtogroup PCD_Exported_Functions_Group1 Initialization and de-initialization functions
230  * @{
231  */
232HAL_StatusTypeDef HAL_PCD_Init(PCD_HandleTypeDef *hpcd);
233HAL_StatusTypeDef HAL_PCD_DeInit (PCD_HandleTypeDef *hpcd);
234void HAL_PCD_MspInit(PCD_HandleTypeDef *hpcd);
235void HAL_PCD_MspDeInit(PCD_HandleTypeDef *hpcd);
236/**
237  * @}
238  */
239
240/* I/O operation functions  ***************************************************/
241/* Non-Blocking mode: Interrupt */
242/** @addtogroup PCD_Exported_Functions_Group2 IO operation functions
243  * @{
244  */
245HAL_StatusTypeDef HAL_PCD_Start(PCD_HandleTypeDef *hpcd);
246HAL_StatusTypeDef HAL_PCD_Stop(PCD_HandleTypeDef *hpcd);
247void HAL_PCD_IRQHandler(PCD_HandleTypeDef *hpcd);
248
249void HAL_PCD_DataOutStageCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
250void HAL_PCD_DataInStageCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
251void HAL_PCD_SetupStageCallback(PCD_HandleTypeDef *hpcd);
252void HAL_PCD_SOFCallback(PCD_HandleTypeDef *hpcd);
253void HAL_PCD_ResetCallback(PCD_HandleTypeDef *hpcd);
254void HAL_PCD_SuspendCallback(PCD_HandleTypeDef *hpcd);
255void HAL_PCD_ResumeCallback(PCD_HandleTypeDef *hpcd);
256void HAL_PCD_ISOOUTIncompleteCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
257void HAL_PCD_ISOINIncompleteCallback(PCD_HandleTypeDef *hpcd, uint8_t epnum);
258void HAL_PCD_ConnectCallback(PCD_HandleTypeDef *hpcd);
259void HAL_PCD_DisconnectCallback(PCD_HandleTypeDef *hpcd);
260/**
261  * @}
262  */
263
264/* Peripheral Control functions  **********************************************/
265/** @addtogroup PCD_Exported_Functions_Group3 Peripheral Control functions
266  * @{
267  */
268HAL_StatusTypeDef HAL_PCD_DevConnect(PCD_HandleTypeDef *hpcd);
269HAL_StatusTypeDef HAL_PCD_DevDisconnect(PCD_HandleTypeDef *hpcd);
270HAL_StatusTypeDef HAL_PCD_SetAddress(PCD_HandleTypeDef *hpcd, uint8_t address);
271HAL_StatusTypeDef HAL_PCD_EP_Open(PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint16_t ep_mps, uint8_t ep_type);
272HAL_StatusTypeDef HAL_PCD_EP_Close(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
273HAL_StatusTypeDef HAL_PCD_EP_Receive(PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf, uint32_t len);
274HAL_StatusTypeDef HAL_PCD_EP_Transmit(PCD_HandleTypeDef *hpcd, uint8_t ep_addr, uint8_t *pBuf, uint32_t len);
275uint16_t          HAL_PCD_EP_GetRxCount(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
276HAL_StatusTypeDef HAL_PCD_EP_SetStall(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
277HAL_StatusTypeDef HAL_PCD_EP_ClrStall(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
278HAL_StatusTypeDef HAL_PCD_EP_Flush(PCD_HandleTypeDef *hpcd, uint8_t ep_addr);
279HAL_StatusTypeDef HAL_PCD_ActivateRemoteWakeup(PCD_HandleTypeDef *hpcd);
280HAL_StatusTypeDef HAL_PCD_DeActivateRemoteWakeup(PCD_HandleTypeDef *hpcd);
281/**
282  * @}
283  */
284
285/* Peripheral State functions  ************************************************/
286/** @addtogroup PCD_Exported_Functions_Group4 Peripheral State functions
287  * @{
288  */
289PCD_StateTypeDef HAL_PCD_GetState(PCD_HandleTypeDef *hpcd);
290/**
291  * @}
292  */
293
294/**
295  * @}
296  */
297
298/** @defgroup PCD_Instance_definition PCD Instance definition
299  * @{
300  */
301#define IS_PCD_ALL_INSTANCE(INSTANCE) (((INSTANCE) == USB_OTG_FS) || \
302                                       ((INSTANCE) == USB_OTG_HS))
303/**
304  * @}
305  */
306
307/**
308  * @}
309  */
310
311/**
312  * @}
313  */
314
315/**
316  * @}
317  */
318
319#ifdef __cplusplus
320}
321#endif
322
323
324#endif /* __STM32F7xx_HAL_PCD_H */
325
326/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
Note: See TracBrowser for help on using the repository browser.