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

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

nucleo_f401re依存部の追加
File size: 10.2 KB
Line 
1/**
2 ******************************************************************************
3 * @file stm32f4xx_hal_hcd.h
4 * @author MCD Application Team
5 * @version V1.4.1
6 * @date 09-October-2015
7 * @brief Header file of HCD 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_HCD_H
40#define __STM32F4xx_HAL_HCD_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 HCD
57 * @{
58 */
59
60/* Exported types ------------------------------------------------------------*/
61/** @defgroup HCD_Exported_Types HCD Exported Types
62 * @{
63 */
64
65/** @defgroup HCD_Exported_Types_Group1 HCD State Structure definition
66 * @{
67 */
68typedef enum
69{
70 HAL_HCD_STATE_RESET = 0x00,
71 HAL_HCD_STATE_READY = 0x01,
72 HAL_HCD_STATE_ERROR = 0x02,
73 HAL_HCD_STATE_BUSY = 0x03,
74 HAL_HCD_STATE_TIMEOUT = 0x04
75} HCD_StateTypeDef;
76
77typedef USB_OTG_GlobalTypeDef HCD_TypeDef;
78typedef USB_OTG_CfgTypeDef HCD_InitTypeDef;
79typedef USB_OTG_HCTypeDef HCD_HCTypeDef ;
80typedef USB_OTG_URBStateTypeDef HCD_URBStateTypeDef ;
81typedef USB_OTG_HCStateTypeDef HCD_HCStateTypeDef ;
82/**
83 * @}
84 */
85
86/** @defgroup HCD_Exported_Types_Group2 HCD Handle Structure definition
87 * @{
88 */
89typedef struct
90{
91 HCD_TypeDef *Instance; /*!< Register base address */
92 HCD_InitTypeDef Init; /*!< HCD required parameters */
93 HCD_HCTypeDef hc[15]; /*!< Host channels parameters */
94 HAL_LockTypeDef Lock; /*!< HCD peripheral status */
95 __IO HCD_StateTypeDef State; /*!< HCD communication state */
96 void *pData; /*!< Pointer Stack Handler */
97} HCD_HandleTypeDef;
98/**
99 * @}
100 */
101
102/**
103 * @}
104 */
105
106/* Exported constants --------------------------------------------------------*/
107/** @defgroup HCD_Exported_Constants HCD Exported Constants
108 * @{
109 */
110
111/** @defgroup HCD_Speed HCD Speed
112 * @{
113 */
114#define HCD_SPEED_HIGH 0
115#define HCD_SPEED_LOW 2
116#define HCD_SPEED_FULL 3
117/**
118 * @}
119 */
120
121/** @defgroup HCD_PHY_Module HCD PHY Module
122 * @{
123 */
124#define HCD_PHY_ULPI 1
125#define HCD_PHY_EMBEDDED 2
126/**
127 * @}
128 */
129
130/**
131 * @}
132 */
133
134/* Exported macro ------------------------------------------------------------*/
135/** @defgroup HCD_Exported_Macros HCD Exported Macros
136 * @brief macros to handle interrupts and specific clock configurations
137 * @{
138 */
139#define __HAL_HCD_ENABLE(__HANDLE__) USB_EnableGlobalInt ((__HANDLE__)->Instance)
140#define __HAL_HCD_DISABLE(__HANDLE__) USB_DisableGlobalInt ((__HANDLE__)->Instance)
141
142#define __HAL_HCD_GET_FLAG(__HANDLE__, __INTERRUPT__) ((USB_ReadInterrupts((__HANDLE__)->Instance) & (__INTERRUPT__)) == (__INTERRUPT__))
143#define __HAL_HCD_CLEAR_FLAG(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->GINTSTS) = (__INTERRUPT__))
144#define __HAL_HCD_IS_INVALID_INTERRUPT(__HANDLE__) (USB_ReadInterrupts((__HANDLE__)->Instance) == 0)
145
146#define __HAL_HCD_CLEAR_HC_INT(chnum, __INTERRUPT__) (USBx_HC(chnum)->HCINT = (__INTERRUPT__))
147#define __HAL_HCD_MASK_HALT_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK &= ~USB_OTG_HCINTMSK_CHHM)
148#define __HAL_HCD_UNMASK_HALT_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK |= USB_OTG_HCINTMSK_CHHM)
149#define __HAL_HCD_MASK_ACK_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK &= ~USB_OTG_HCINTMSK_ACKM)
150#define __HAL_HCD_UNMASK_ACK_HC_INT(chnum) (USBx_HC(chnum)->HCINTMSK |= USB_OTG_HCINTMSK_ACKM)
151/**
152 * @}
153 */
154
155/* Exported functions --------------------------------------------------------*/
156/** @addtogroup HCD_Exported_Functions HCD Exported Functions
157 * @{
158 */
159
160/* Initialization/de-initialization functions ********************************/
161/** @addtogroup HCD_Exported_Functions_Group1 Initialization and de-initialization functions
162 * @{
163 */
164HAL_StatusTypeDef HAL_HCD_Init(HCD_HandleTypeDef *hhcd);
165HAL_StatusTypeDef HAL_HCD_DeInit(HCD_HandleTypeDef *hhcd);
166HAL_StatusTypeDef HAL_HCD_HC_Init(HCD_HandleTypeDef *hhcd,
167 uint8_t ch_num,
168 uint8_t epnum,
169 uint8_t dev_address,
170 uint8_t speed,
171 uint8_t ep_type,
172 uint16_t mps);
173
174HAL_StatusTypeDef HAL_HCD_HC_Halt(HCD_HandleTypeDef *hhcd, uint8_t ch_num);
175
176void HAL_HCD_MspInit(HCD_HandleTypeDef *hhcd);
177void HAL_HCD_MspDeInit(HCD_HandleTypeDef *hhcd);
178/**
179 * @}
180 */
181
182/* I/O operation functions ***************************************************/
183/** @addtogroup HCD_Exported_Functions_Group2 Input and Output operation functions
184 * @{
185 */
186HAL_StatusTypeDef HAL_HCD_HC_SubmitRequest(HCD_HandleTypeDef *hhcd,
187 uint8_t pipe,
188 uint8_t direction,
189 uint8_t ep_type,
190 uint8_t token,
191 uint8_t* pbuff,
192 uint16_t length,
193 uint8_t do_ping);
194
195/* Non-Blocking mode: Interrupt */
196void HAL_HCD_IRQHandler(HCD_HandleTypeDef *hhcd);
197void HAL_HCD_SOF_Callback(HCD_HandleTypeDef *hhcd);
198void HAL_HCD_Connect_Callback(HCD_HandleTypeDef *hhcd);
199void HAL_HCD_Disconnect_Callback(HCD_HandleTypeDef *hhcd);
200void HAL_HCD_HC_NotifyURBChange_Callback(HCD_HandleTypeDef *hhcd,
201 uint8_t chnum,
202 HCD_URBStateTypeDef urb_state);
203/**
204 * @}
205 */
206
207/* Peripheral Control functions **********************************************/
208/** @addtogroup HCD_Exported_Functions_Group3 Peripheral Control functions
209 * @{
210 */
211HAL_StatusTypeDef HAL_HCD_ResetPort(HCD_HandleTypeDef *hhcd);
212HAL_StatusTypeDef HAL_HCD_Start(HCD_HandleTypeDef *hhcd);
213HAL_StatusTypeDef HAL_HCD_Stop(HCD_HandleTypeDef *hhcd);
214/**
215 * @}
216 */
217
218/* Peripheral State functions ************************************************/
219/** @addtogroup HCD_Exported_Functions_Group4 Peripheral State functions
220 * @{
221 */
222HCD_StateTypeDef HAL_HCD_GetState(HCD_HandleTypeDef *hhcd);
223HCD_URBStateTypeDef HAL_HCD_HC_GetURBState(HCD_HandleTypeDef *hhcd, uint8_t chnum);
224uint32_t HAL_HCD_HC_GetXferCount(HCD_HandleTypeDef *hhcd, uint8_t chnum);
225HCD_HCStateTypeDef HAL_HCD_HC_GetState(HCD_HandleTypeDef *hhcd, uint8_t chnum);
226uint32_t HAL_HCD_GetCurrentFrame(HCD_HandleTypeDef *hhcd);
227uint32_t HAL_HCD_GetCurrentSpeed(HCD_HandleTypeDef *hhcd);
228/**
229 * @}
230 */
231
232/**
233 * @}
234 */
235
236/* Private macros ------------------------------------------------------------*/
237/** @defgroup HCD_Private_Macros HCD Private Macros
238 * @{
239 */
240/** @defgroup HCD_Instance_definition HCD Instance definition
241 * @{
242 */
243#if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || defined(STM32F427xx) ||\
244 defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) || defined(STM32F446xx) || defined(STM32F469xx) ||\
245 defined(STM32F479xx)
246 #define IS_HCD_ALL_INSTANCE(INSTANCE) (((INSTANCE) == USB_OTG_FS) || \
247 ((INSTANCE) == USB_OTG_HS))
248#elif defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F411xE)
249 #define IS_HCD_ALL_INSTANCE(INSTANCE) (((INSTANCE) == USB_OTG_FS))
250#endif
251/**
252 * @}
253 */
254
255/**
256 * @}
257 */
258
259/**
260 * @}
261 */
262
263/**
264 * @}
265 */
266#endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx ||
267 STM32F401xC || STM32F401xE || STM32F411xE || STM32F446xx || STM32F469xx || STM32F479xx */
268#ifdef __cplusplus
269}
270#endif
271
272#endif /* __STM32F4xx_HAL_HCD_H */
273
274/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
Note: See TracBrowser for help on using the repository browser.