2 ******************************************************************************
3 * @file stm32f4xx_ll_usb.h
4 * @author MCD Application Team
7 * @brief Header file of USB Core HAL module.
8 ******************************************************************************
11 * <h2><center>© COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
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.
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.
35 ******************************************************************************
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __STM32F4xx_LL_USB_H
40 #define __STM32F4xx_LL_USB_H
46 /* Includes ------------------------------------------------------------------*/
47 #include "stm32f4xx_hal_def.h"
49 /** @addtogroup STM32F4xx_HAL
53 /** @addtogroup USB_Core
57 /* Exported types ------------------------------------------------------------*/
60 * @brief USB Mode definition
64 USB_OTG_DEVICE_MODE = 0,
65 USB_OTG_HOST_MODE = 1,
71 * @brief URB States definition
81 }USB_OTG_URBStateTypeDef;
84 * @brief Host channel States definition
97 }USB_OTG_HCStateTypeDef;
100 * @brief PCD Initialization Structure definition
104 uint32_t dev_endpoints; /*!< Device Endpoints number.
105 This parameter depends on the used USB core.
106 This parameter must be a number between Min_Data = 1 and Max_Data = 15 */
108 uint32_t Host_channels; /*!< Host Channels number.
109 This parameter Depends on the used USB core.
110 This parameter must be a number between Min_Data = 1 and Max_Data = 15 */
112 uint32_t speed; /*!< USB Core speed.
113 This parameter can be any value of @ref USB_Core_Speed_ */
115 uint32_t dma_enable; /*!< Enable or disable of the USB embedded DMA. */
117 uint32_t ep0_mps; /*!< Set the Endpoint 0 Max Packet size.
118 This parameter can be any value of @ref USB_EP0_MPS_ */
120 uint32_t phy_itface; /*!< Select the used PHY interface.
121 This parameter can be any value of @ref USB_Core_PHY_ */
123 uint32_t Sof_enable; /*!< Enable or disable the output of the SOF signal. */
125 uint32_t low_power_enable; /*!< Enable or disable the low power mode. */
127 uint32_t vbus_sensing_enable; /*!< Enable or disable the VBUS Sensing feature. */
129 uint32_t use_dedicated_ep1; /*!< Enable or disable the use of the dedicated EP1 interrupt. */
131 uint32_t use_external_vbus; /*!< Enable or disable the use of the external VBUS. */
137 uint8_t num; /*!< Endpoint number
138 This parameter must be a number between Min_Data = 1 and Max_Data = 15 */
140 uint8_t is_in; /*!< Endpoint direction
141 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
143 uint8_t is_stall; /*!< Endpoint stall condition
144 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
146 uint8_t type; /*!< Endpoint type
147 This parameter can be any value of @ref USB_EP_Type_ */
149 uint8_t data_pid_start; /*!< Initial data PID
150 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
152 uint8_t even_odd_frame; /*!< IFrame parity
153 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
155 uint16_t tx_fifo_num; /*!< Transmission FIFO number
156 This parameter must be a number between Min_Data = 1 and Max_Data = 15 */
158 uint32_t maxpacket; /*!< Endpoint Max packet size
159 This parameter must be a number between Min_Data = 0 and Max_Data = 64KB */
161 uint8_t *xfer_buff; /*!< Pointer to transfer buffer */
163 uint32_t dma_addr; /*!< 32 bits aligned transfer buffer address */
165 uint32_t xfer_len; /*!< Current transfer length */
167 uint32_t xfer_count; /*!< Partial transfer length in case of multi packet transfer */
173 uint8_t dev_addr ; /*!< USB device address.
174 This parameter must be a number between Min_Data = 1 and Max_Data = 255 */
176 uint8_t ch_num; /*!< Host channel number.
177 This parameter must be a number between Min_Data = 1 and Max_Data = 15 */
179 uint8_t ep_num; /*!< Endpoint number.
180 This parameter must be a number between Min_Data = 1 and Max_Data = 15 */
182 uint8_t ep_is_in; /*!< Endpoint direction
183 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
185 uint8_t speed; /*!< USB Host speed.
186 This parameter can be any value of @ref USB_Core_Speed_ */
188 uint8_t do_ping; /*!< Enable or disable the use of the PING protocol for HS mode. */
190 uint8_t process_ping; /*!< Execute the PING protocol for HS mode. */
192 uint8_t ep_type; /*!< Endpoint Type.
193 This parameter can be any value of @ref USB_EP_Type_ */
195 uint16_t max_packet; /*!< Endpoint Max packet size.
196 This parameter must be a number between Min_Data = 0 and Max_Data = 64KB */
198 uint8_t data_pid; /*!< Initial data PID.
199 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
201 uint8_t *xfer_buff; /*!< Pointer to transfer buffer. */
203 uint32_t xfer_len; /*!< Current transfer length. */
205 uint32_t xfer_count; /*!< Partial transfer length in case of multi packet transfer. */
207 uint8_t toggle_in; /*!< IN transfer current toggle flag.
208 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
210 uint8_t toggle_out; /*!< OUT transfer current toggle flag
211 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
213 uint32_t dma_addr; /*!< 32 bits aligned transfer buffer address. */
215 uint32_t ErrCnt; /*!< Host channel error count.*/
217 USB_OTG_URBStateTypeDef urb_state; /*!< URB state.
218 This parameter can be any value of @ref USB_OTG_URBStateTypeDef */
220 USB_OTG_HCStateTypeDef state; /*!< Host Channel state.
221 This parameter can be any value of @ref USB_OTG_HCStateTypeDef */
225 /* Exported constants --------------------------------------------------------*/
227 /** @defgroup PCD_Exported_Constants
231 /** @defgroup USB_Core_Mode_
234 #define USB_OTG_MODE_DEVICE 0
235 #define USB_OTG_MODE_HOST 1
236 #define USB_OTG_MODE_DRD 2
241 /** @defgroup USB_Core_Speed_
244 #define USB_OTG_SPEED_HIGH 0
245 #define USB_OTG_SPEED_HIGH_IN_FULL 1
246 #define USB_OTG_SPEED_LOW 2
247 #define USB_OTG_SPEED_FULL 3
252 /** @defgroup USB_Core_PHY_
255 #define USB_OTG_ULPI_PHY 1
256 #define USB_OTG_EMBEDDED_PHY 2
261 /** @defgroup USB_Core_MPS_
264 #define USB_OTG_HS_MAX_PACKET_SIZE 512
265 #define USB_OTG_FS_MAX_PACKET_SIZE 64
266 #define USB_OTG_MAX_EP0_SIZE 64
271 /** @defgroup USB_Core_Phy_Frequency_
274 #define DSTS_ENUMSPD_HS_PHY_30MHZ_OR_60MHZ (0 << 1)
275 #define DSTS_ENUMSPD_FS_PHY_30MHZ_OR_60MHZ (1 << 1)
276 #define DSTS_ENUMSPD_LS_PHY_6MHZ (2 << 1)
277 #define DSTS_ENUMSPD_FS_PHY_48MHZ (3 << 1)
282 /** @defgroup USB_CORE_Frame_Interval_
285 #define DCFG_FRAME_INTERVAL_80 0
286 #define DCFG_FRAME_INTERVAL_85 1
287 #define DCFG_FRAME_INTERVAL_90 2
288 #define DCFG_FRAME_INTERVAL_95 3
293 /** @defgroup USB_EP0_MPS_
296 #define DEP0CTL_MPS_64 0
297 #define DEP0CTL_MPS_32 1
298 #define DEP0CTL_MPS_16 2
299 #define DEP0CTL_MPS_8 3
304 /** @defgroup USB_EP_Speed_
307 #define EP_SPEED_LOW 0
308 #define EP_SPEED_FULL 1
309 #define EP_SPEED_HIGH 2
314 /** @defgroup USB_EP_Type_
317 #define EP_TYPE_CTRL 0
318 #define EP_TYPE_ISOC 1
319 #define EP_TYPE_BULK 2
320 #define EP_TYPE_INTR 3
321 #define EP_TYPE_MSK 3
326 /** @defgroup USB_STS_Defines_
329 #define STS_GOUT_NAK 1
330 #define STS_DATA_UPDT 2
331 #define STS_XFER_COMP 3
332 #define STS_SETUP_COMP 4
333 #define STS_SETUP_UPDT 6
338 /** @defgroup HCFG_SPEED_Defines_
341 #define HCFG_30_60_MHZ 0
342 #define HCFG_48_MHZ 1
348 /** @defgroup HPRT0_PRTSPD_SPEED_Defines_
351 #define HPRT0_PRTSPD_HIGH_SPEED 0
352 #define HPRT0_PRTSPD_FULL_SPEED 1
353 #define HPRT0_PRTSPD_LOW_SPEED 2
358 #define HCCHAR_CTRL 0
359 #define HCCHAR_ISOC 1
360 #define HCCHAR_BULK 2
361 #define HCCHAR_INTR 3
363 #define HC_PID_DATA0 0
364 #define HC_PID_DATA2 1
365 #define HC_PID_DATA1 2
366 #define HC_PID_SETUP 3
368 #define GRXSTS_PKTSTS_IN 2
369 #define GRXSTS_PKTSTS_IN_XFER_COMP 3
370 #define GRXSTS_PKTSTS_DATA_TOGGLE_ERR 5
371 #define GRXSTS_PKTSTS_CH_HALTED 7
373 #define USBx_PCGCCTL *(__IO uint32_t *)((uint32_t)USBx + USB_OTG_PCGCCTL_BASE)
374 #define USBx_HPRT0 *(__IO uint32_t *)((uint32_t)USBx + USB_OTG_HOST_PORT_BASE)
376 #define USBx_DEVICE ((USB_OTG_DeviceTypeDef *)((uint32_t )USBx + USB_OTG_DEVICE_BASE))
377 #define USBx_INEP(i) ((USB_OTG_INEndpointTypeDef *)((uint32_t)USBx + USB_OTG_IN_ENDPOINT_BASE + (i)*USB_OTG_EP_REG_SIZE))
378 #define USBx_OUTEP(i) ((USB_OTG_OUTEndpointTypeDef *)((uint32_t)USBx + USB_OTG_OUT_ENDPOINT_BASE + (i)*USB_OTG_EP_REG_SIZE))
379 #define USBx_DFIFO(i) *(__IO uint32_t *)((uint32_t)USBx + USB_OTG_FIFO_BASE + (i) * USB_OTG_FIFO_SIZE)
381 #define USBx_HOST ((USB_OTG_HostTypeDef *)((uint32_t )USBx + USB_OTG_HOST_BASE))
382 #define USBx_HC(i) ((USB_OTG_HostChannelTypeDef *)((uint32_t)USBx + USB_OTG_HOST_CHANNEL_BASE + (i)*USB_OTG_HOST_CHANNEL_SIZE))
384 /* Exported macro ------------------------------------------------------------*/
385 #define USB_MASK_INTERRUPT(__INSTANCE__, __INTERRUPT__) ((__INSTANCE__)->GINTMSK &= ~(__INTERRUPT__))
386 #define USB_UNMASK_INTERRUPT(__INSTANCE__, __INTERRUPT__) ((__INSTANCE__)->GINTMSK |= (__INTERRUPT__))
388 #define CLEAR_IN_EP_INTR(__EPNUM__, __INTERRUPT__) (USBx_INEP(__EPNUM__)->DIEPINT = (__INTERRUPT__))
389 #define CLEAR_OUT_EP_INTR(__EPNUM__, __INTERRUPT__) (USBx_OUTEP(__EPNUM__)->DOEPINT = (__INTERRUPT__))
391 /* Exported functions --------------------------------------------------------*/
392 HAL_StatusTypeDef USB_CoreInit(USB_OTG_GlobalTypeDef *USBx, USB_OTG_CfgTypeDef Init);
393 HAL_StatusTypeDef USB_DevInit(USB_OTG_GlobalTypeDef *USBx, USB_OTG_CfgTypeDef Init);
394 HAL_StatusTypeDef USB_EnableGlobalInt(USB_OTG_GlobalTypeDef *USBx);
395 HAL_StatusTypeDef USB_DisableGlobalInt(USB_OTG_GlobalTypeDef *USBx);
396 HAL_StatusTypeDef USB_SetCurrentMode(USB_OTG_GlobalTypeDef *USBx , USB_OTG_ModeTypeDef mode);
397 HAL_StatusTypeDef USB_SetDevSpeed(USB_OTG_GlobalTypeDef *USBx , uint8_t speed);
398 HAL_StatusTypeDef USB_FlushRxFifo (USB_OTG_GlobalTypeDef *USBx);
399 HAL_StatusTypeDef USB_FlushTxFifo (USB_OTG_GlobalTypeDef *USBx, uint32_t num );
400 HAL_StatusTypeDef USB_ActivateEndpoint(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep);
401 HAL_StatusTypeDef USB_DeactivateEndpoint(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep);
402 HAL_StatusTypeDef USB_ActivateDedicatedEndpoint(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep);
403 HAL_StatusTypeDef USB_DeactivateDedicatedEndpoint(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep);
404 HAL_StatusTypeDef USB_EPStartXfer(USB_OTG_GlobalTypeDef *USBx , USB_OTG_EPTypeDef *ep, uint8_t dma);
405 HAL_StatusTypeDef USB_EP0StartXfer(USB_OTG_GlobalTypeDef *USBx , USB_OTG_EPTypeDef *ep, uint8_t dma);
406 HAL_StatusTypeDef USB_WritePacket(USB_OTG_GlobalTypeDef *USBx, uint8_t *src, uint8_t ch_ep_num, uint16_t len, uint8_t dma);
407 void * USB_ReadPacket(USB_OTG_GlobalTypeDef *USBx, uint8_t *dest, uint16_t len);
408 HAL_StatusTypeDef USB_EPSetStall(USB_OTG_GlobalTypeDef *USBx , USB_OTG_EPTypeDef *ep);
409 HAL_StatusTypeDef USB_EPClearStall(USB_OTG_GlobalTypeDef *USBx , USB_OTG_EPTypeDef *ep);
410 HAL_StatusTypeDef USB_SetDevAddress (USB_OTG_GlobalTypeDef *USBx, uint8_t address);
411 HAL_StatusTypeDef USB_DevConnect (USB_OTG_GlobalTypeDef *USBx);
412 HAL_StatusTypeDef USB_DevDisconnect (USB_OTG_GlobalTypeDef *USBx);
413 HAL_StatusTypeDef USB_StopDevice(USB_OTG_GlobalTypeDef *USBx);
414 HAL_StatusTypeDef USB_ActivateSetup (USB_OTG_GlobalTypeDef *USBx);
415 HAL_StatusTypeDef USB_EP0_OutStart(USB_OTG_GlobalTypeDef *USBx, uint8_t dma, uint8_t *psetup);
416 uint8_t USB_GetDevSpeed(USB_OTG_GlobalTypeDef *USBx);
417 uint32_t USB_GetMode(USB_OTG_GlobalTypeDef *USBx);
418 uint32_t USB_ReadInterrupts (USB_OTG_GlobalTypeDef *USBx);
419 uint32_t USB_ReadDevAllOutEpInterrupt (USB_OTG_GlobalTypeDef *USBx);
420 uint32_t USB_ReadDevOutEPInterrupt (USB_OTG_GlobalTypeDef *USBx , uint8_t epnum);
421 uint32_t USB_ReadDevAllInEpInterrupt (USB_OTG_GlobalTypeDef *USBx);
422 uint32_t USB_ReadDevInEPInterrupt (USB_OTG_GlobalTypeDef *USBx , uint8_t epnum);
423 void USB_ClearInterrupts (USB_OTG_GlobalTypeDef *USBx, uint32_t interrupt);
425 HAL_StatusTypeDef USB_HostInit (USB_OTG_GlobalTypeDef *USBx, USB_OTG_CfgTypeDef cfg);
426 HAL_StatusTypeDef USB_InitFSLSPClkSel(USB_OTG_GlobalTypeDef *USBx , uint8_t freq);
427 HAL_StatusTypeDef USB_ResetPort(USB_OTG_GlobalTypeDef *USBx);
428 HAL_StatusTypeDef USB_DriveVbus (USB_OTG_GlobalTypeDef *USBx, uint8_t state);
429 uint32_t USB_GetHostSpeed (USB_OTG_GlobalTypeDef *USBx);
430 uint32_t USB_GetCurrentFrame (USB_OTG_GlobalTypeDef *USBx);
431 HAL_StatusTypeDef USB_HC_Init(USB_OTG_GlobalTypeDef *USBx,
438 HAL_StatusTypeDef USB_HC_StartXfer(USB_OTG_GlobalTypeDef *USBx, USB_OTG_HCTypeDef *hc, uint8_t dma);
439 uint32_t USB_HC_ReadInterrupt (USB_OTG_GlobalTypeDef *USBx);
440 HAL_StatusTypeDef USB_HC_Halt(USB_OTG_GlobalTypeDef *USBx , uint8_t hc_num);
441 HAL_StatusTypeDef USB_DoPing(USB_OTG_GlobalTypeDef *USBx , uint8_t ch_num);
442 HAL_StatusTypeDef USB_StopHost(USB_OTG_GlobalTypeDef *USBx);
457 #endif /* __STM32F4xx_LL_USB_H */
459 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/