source: asp3_wo_tecs/trunk/arch/arm_m_gcc/stm32f4xx_stm32cube/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_pcd.h@ 303

Last change on this file since 303 was 303, checked in by ertl-honda, 7 years ago

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