2 ******************************************************************************
3 * @file stm32f7xx_ll_usb.h
4 * @author MCD Application Team
7 * @brief Header file of USB Core HAL module.
8 ******************************************************************************
11 * <h2><center>© COPYRIGHT(c) 2017 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 __STM32F7xx_LL_USB_H
40 #define __STM32F7xx_LL_USB_H
46 /* Includes ------------------------------------------------------------------*/
47 #include "stm32f7xx_hal_def.h"
49 /** @addtogroup STM32F7xx_HAL
53 /** @addtogroup USB_Core
57 /* Exported types ------------------------------------------------------------*/
60 * @brief USB Mode definition
64 USB_OTG_DEVICE_MODE
= 0U,
65 USB_OTG_HOST_MODE
= 1U,
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 lpm_enable
; /*!< Enable or disable Link Power Management. */
129 uint32_t battery_charging_enable
; /*!< Enable or disable Battery charging. */
131 uint32_t vbus_sensing_enable
; /*!< Enable or disable the VBUS Sensing feature. */
133 uint32_t use_dedicated_ep1
; /*!< Enable or disable the use of the dedicated EP1 interrupt. */
135 uint32_t use_external_vbus
; /*!< Enable or disable the use of the external VBUS. */
141 uint8_t num
; /*!< Endpoint number
142 This parameter must be a number between Min_Data = 1 and Max_Data = 15 */
144 uint8_t is_in
; /*!< Endpoint direction
145 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
147 uint8_t is_stall
; /*!< Endpoint stall condition
148 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
150 uint8_t type
; /*!< Endpoint type
151 This parameter can be any value of @ref USB_EP_Type_ */
153 uint8_t data_pid_start
; /*!< Initial data PID
154 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
156 uint8_t even_odd_frame
; /*!< IFrame parity
157 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
159 uint16_t tx_fifo_num
; /*!< Transmission FIFO number
160 This parameter must be a number between Min_Data = 1 and Max_Data = 15 */
162 uint32_t maxpacket
; /*!< Endpoint Max packet size
163 This parameter must be a number between Min_Data = 0 and Max_Data = 64KB */
165 uint8_t *xfer_buff
; /*!< Pointer to transfer buffer */
167 uint32_t dma_addr
; /*!< 32 bits aligned transfer buffer address */
169 uint32_t xfer_len
; /*!< Current transfer length */
171 uint32_t xfer_count
; /*!< Partial transfer length in case of multi packet transfer */
177 uint8_t dev_addr
; /*!< USB device address.
178 This parameter must be a number between Min_Data = 1 and Max_Data = 255 */
180 uint8_t ch_num
; /*!< Host channel number.
181 This parameter must be a number between Min_Data = 1 and Max_Data = 15 */
183 uint8_t ep_num
; /*!< Endpoint number.
184 This parameter must be a number between Min_Data = 1 and Max_Data = 15 */
186 uint8_t ep_is_in
; /*!< Endpoint direction
187 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
189 uint8_t speed
; /*!< USB Host speed.
190 This parameter can be any value of @ref USB_Core_Speed_ */
192 uint8_t do_ping
; /*!< Enable or disable the use of the PING protocol for HS mode. */
194 uint8_t process_ping
; /*!< Execute the PING protocol for HS mode. */
196 uint8_t ep_type
; /*!< Endpoint Type.
197 This parameter can be any value of @ref USB_EP_Type_ */
199 uint16_t max_packet
; /*!< Endpoint Max packet size.
200 This parameter must be a number between Min_Data = 0 and Max_Data = 64KB */
202 uint8_t data_pid
; /*!< Initial data PID.
203 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
205 uint8_t *xfer_buff
; /*!< Pointer to transfer buffer. */
207 uint32_t xfer_len
; /*!< Current transfer length. */
209 uint32_t xfer_count
; /*!< Partial transfer length in case of multi packet transfer. */
211 uint8_t toggle_in
; /*!< IN transfer current toggle flag.
212 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
214 uint8_t toggle_out
; /*!< OUT transfer current toggle flag
215 This parameter must be a number between Min_Data = 0 and Max_Data = 1 */
217 uint32_t dma_addr
; /*!< 32 bits aligned transfer buffer address. */
219 uint32_t ErrCnt
; /*!< Host channel error count.*/
221 USB_OTG_URBStateTypeDef urb_state
; /*!< URB state.
222 This parameter can be any value of @ref USB_OTG_URBStateTypeDef */
224 USB_OTG_HCStateTypeDef state
; /*!< Host Channel state.
225 This parameter can be any value of @ref USB_OTG_HCStateTypeDef */
229 /* Exported constants --------------------------------------------------------*/
231 /** @defgroup PCD_Exported_Constants PCD Exported Constants
235 /** @defgroup USB_Core_Mode_ USB Core Mode
238 #define USB_OTG_MODE_DEVICE 0U
239 #define USB_OTG_MODE_HOST 1U
240 #define USB_OTG_MODE_DRD 2U
245 /** @defgroup USB_Core_Speed_ USB Core Speed
248 #define USB_OTG_SPEED_HIGH 0U
249 #define USB_OTG_SPEED_HIGH_IN_FULL 1U
250 #define USB_OTG_SPEED_LOW 2U
251 #define USB_OTG_SPEED_FULL 3U
256 /** @defgroup USB_Core_PHY_ USB Core PHY
259 #define USB_OTG_ULPI_PHY 1U
260 #define USB_OTG_EMBEDDED_PHY 2U
261 #define USB_OTG_HS_EMBEDDED_PHY 3U
263 #if !defined (USB_HS_PHYC_TUNE_VALUE)
264 #define USB_HS_PHYC_TUNE_VALUE 0x00000F13U /*!< Value of USB HS PHY Tune */
265 #endif /* USB_HS_PHYC_TUNE_VALUE */
271 /** @defgroup USB_Core_MPS_ USB Core MPS
274 #define USB_OTG_HS_MAX_PACKET_SIZE 512U
275 #define USB_OTG_FS_MAX_PACKET_SIZE 64U
276 #define USB_OTG_MAX_EP0_SIZE 64U
281 /** @defgroup USB_Core_Phy_Frequency_ USB Core Phy Frequency
284 #define DSTS_ENUMSPD_HS_PHY_30MHZ_OR_60MHZ (0 << 1)
285 #define DSTS_ENUMSPD_FS_PHY_30MHZ_OR_60MHZ (1 << 1)
286 #define DSTS_ENUMSPD_LS_PHY_6MHZ (2 << 1)
287 #define DSTS_ENUMSPD_FS_PHY_48MHZ (3 << 1)
292 /** @defgroup USB_CORE_Frame_Interval_ USB CORE Frame Interval
295 #define DCFG_FRAME_INTERVAL_80 0U
296 #define DCFG_FRAME_INTERVAL_85 1U
297 #define DCFG_FRAME_INTERVAL_90 2U
298 #define DCFG_FRAME_INTERVAL_95 3U
303 /** @defgroup USB_EP0_MPS_ USB EP0 MPS
306 #define DEP0CTL_MPS_64 0U
307 #define DEP0CTL_MPS_32 1U
308 #define DEP0CTL_MPS_16 2U
309 #define DEP0CTL_MPS_8 3U
314 /** @defgroup USB_EP_Speed_ USB EP Speed
317 #define EP_SPEED_LOW 0U
318 #define EP_SPEED_FULL 1U
319 #define EP_SPEED_HIGH 2U
324 /** @defgroup USB_EP_Type_ USB EP Type
327 #define EP_TYPE_CTRL 0U
328 #define EP_TYPE_ISOC 1U
329 #define EP_TYPE_BULK 2U
330 #define EP_TYPE_INTR 3U
331 #define EP_TYPE_MSK 3U
336 /** @defgroup USB_STS_Defines_ USB STS Defines
339 #define STS_GOUT_NAK 1U
340 #define STS_DATA_UPDT 2U
341 #define STS_XFER_COMP 3U
342 #define STS_SETUP_COMP 4U
343 #define STS_SETUP_UPDT 6U
348 /** @defgroup HCFG_SPEED_Defines_ HCFG SPEED Defines
351 #define HCFG_30_60_MHZ 0U
352 #define HCFG_48_MHZ 1U
353 #define HCFG_6_MHZ 2U
358 /** @defgroup HPRT0_PRTSPD_SPEED_Defines_ HPRT0 PRTSPD SPEED Defines
361 #define HPRT0_PRTSPD_HIGH_SPEED 0U
362 #define HPRT0_PRTSPD_FULL_SPEED 1U
363 #define HPRT0_PRTSPD_LOW_SPEED 2U
368 #define HCCHAR_CTRL 0U
369 #define HCCHAR_ISOC 1U
370 #define HCCHAR_BULK 2U
371 #define HCCHAR_INTR 3U
373 #define HC_PID_DATA0 0U
374 #define HC_PID_DATA2 1U
375 #define HC_PID_DATA1 2U
376 #define HC_PID_SETUP 3U
378 #define GRXSTS_PKTSTS_IN 2U
379 #define GRXSTS_PKTSTS_IN_XFER_COMP 3U
380 #define GRXSTS_PKTSTS_DATA_TOGGLE_ERR 5U
381 #define GRXSTS_PKTSTS_CH_HALTED 7U
383 #define USBx_PCGCCTL *(__IO uint32_t *)((uint32_t)USBx + USB_OTG_PCGCCTL_BASE)
384 #define USBx_HPRT0 *(__IO uint32_t *)((uint32_t)USBx + USB_OTG_HOST_PORT_BASE)
386 #define USBx_DEVICE ((USB_OTG_DeviceTypeDef *)((uint32_t )USBx + USB_OTG_DEVICE_BASE))
387 #define USBx_INEP(i) ((USB_OTG_INEndpointTypeDef *)((uint32_t)USBx + USB_OTG_IN_ENDPOINT_BASE + (i)*USB_OTG_EP_REG_SIZE))
388 #define USBx_OUTEP(i) ((USB_OTG_OUTEndpointTypeDef *)((uint32_t)USBx + USB_OTG_OUT_ENDPOINT_BASE + (i)*USB_OTG_EP_REG_SIZE))
389 #define USBx_DFIFO(i) *(__IO uint32_t *)((uint32_t)USBx + USB_OTG_FIFO_BASE + (i) * USB_OTG_FIFO_SIZE)
391 #define USBx_HOST ((USB_OTG_HostTypeDef *)((uint32_t )USBx + USB_OTG_HOST_BASE))
392 #define USBx_HC(i) ((USB_OTG_HostChannelTypeDef *)((uint32_t)USBx + USB_OTG_HOST_CHANNEL_BASE + (i)*USB_OTG_HOST_CHANNEL_SIZE))
393 #define USBPHYC ((USBPHYC_GlobalTypeDef *)((uint32_t )USB_PHY_HS_CONTROLLER_BASE))
399 /* Exported macro ------------------------------------------------------------*/
400 #define USB_MASK_INTERRUPT(__INSTANCE__, __INTERRUPT__) ((__INSTANCE__)->GINTMSK &= ~(__INTERRUPT__))
401 #define USB_UNMASK_INTERRUPT(__INSTANCE__, __INTERRUPT__) ((__INSTANCE__)->GINTMSK |= (__INTERRUPT__))
403 #define CLEAR_IN_EP_INTR(__EPNUM__, __INTERRUPT__) (USBx_INEP(__EPNUM__)->DIEPINT = (__INTERRUPT__))
404 #define CLEAR_OUT_EP_INTR(__EPNUM__, __INTERRUPT__) (USBx_OUTEP(__EPNUM__)->DOEPINT = (__INTERRUPT__))
406 /* Exported functions --------------------------------------------------------*/
407 HAL_StatusTypeDef
USB_CoreInit(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_CfgTypeDef Init
);
408 HAL_StatusTypeDef
USB_DevInit(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_CfgTypeDef Init
);
409 HAL_StatusTypeDef
USB_EnableGlobalInt(USB_OTG_GlobalTypeDef
*USBx
);
410 HAL_StatusTypeDef
USB_DisableGlobalInt(USB_OTG_GlobalTypeDef
*USBx
);
411 HAL_StatusTypeDef
USB_SetCurrentMode(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_ModeTypeDef mode
);
412 HAL_StatusTypeDef
USB_SetDevSpeed(USB_OTG_GlobalTypeDef
*USBx
, uint8_t speed
);
413 HAL_StatusTypeDef
USB_FlushRxFifo (USB_OTG_GlobalTypeDef
*USBx
);
414 HAL_StatusTypeDef
USB_FlushTxFifo (USB_OTG_GlobalTypeDef
*USBx
, uint32_t num
);
415 HAL_StatusTypeDef
USB_ActivateEndpoint(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_EPTypeDef
*ep
);
416 HAL_StatusTypeDef
USB_DeactivateEndpoint(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_EPTypeDef
*ep
);
417 HAL_StatusTypeDef
USB_ActivateDedicatedEndpoint(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_EPTypeDef
*ep
);
418 HAL_StatusTypeDef
USB_DeactivateDedicatedEndpoint(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_EPTypeDef
*ep
);
419 HAL_StatusTypeDef
USB_EPStartXfer(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_EPTypeDef
*ep
, uint8_t dma
);
420 HAL_StatusTypeDef
USB_EP0StartXfer(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_EPTypeDef
*ep
, uint8_t dma
);
421 HAL_StatusTypeDef
USB_WritePacket(USB_OTG_GlobalTypeDef
*USBx
, uint8_t *src
, uint8_t ch_ep_num
, uint16_t len
, uint8_t dma
);
422 void * USB_ReadPacket(USB_OTG_GlobalTypeDef
*USBx
, uint8_t *dest
, uint16_t len
);
423 HAL_StatusTypeDef
USB_EPSetStall(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_EPTypeDef
*ep
);
424 HAL_StatusTypeDef
USB_EPClearStall(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_EPTypeDef
*ep
);
425 HAL_StatusTypeDef
USB_SetDevAddress (USB_OTG_GlobalTypeDef
*USBx
, uint8_t address
);
426 HAL_StatusTypeDef
USB_DevConnect (USB_OTG_GlobalTypeDef
*USBx
);
427 HAL_StatusTypeDef
USB_DevDisconnect (USB_OTG_GlobalTypeDef
*USBx
);
428 HAL_StatusTypeDef
USB_StopDevice(USB_OTG_GlobalTypeDef
*USBx
);
429 HAL_StatusTypeDef
USB_ActivateSetup (USB_OTG_GlobalTypeDef
*USBx
);
430 HAL_StatusTypeDef
USB_EP0_OutStart(USB_OTG_GlobalTypeDef
*USBx
, uint8_t dma
, uint8_t *psetup
);
431 uint8_t USB_GetDevSpeed(USB_OTG_GlobalTypeDef
*USBx
);
432 uint32_t USB_GetMode(USB_OTG_GlobalTypeDef
*USBx
);
433 uint32_t USB_ReadInterrupts (USB_OTG_GlobalTypeDef
*USBx
);
434 uint32_t USB_ReadDevAllOutEpInterrupt (USB_OTG_GlobalTypeDef
*USBx
);
435 uint32_t USB_ReadDevOutEPInterrupt (USB_OTG_GlobalTypeDef
*USBx
, uint8_t epnum
);
436 uint32_t USB_ReadDevAllInEpInterrupt (USB_OTG_GlobalTypeDef
*USBx
);
437 uint32_t USB_ReadDevInEPInterrupt (USB_OTG_GlobalTypeDef
*USBx
, uint8_t epnum
);
438 void USB_ClearInterrupts (USB_OTG_GlobalTypeDef
*USBx
, uint32_t interrupt
);
440 HAL_StatusTypeDef
USB_HostInit (USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_CfgTypeDef cfg
);
441 HAL_StatusTypeDef
USB_InitFSLSPClkSel(USB_OTG_GlobalTypeDef
*USBx
, uint8_t freq
);
442 HAL_StatusTypeDef
USB_ResetPort(USB_OTG_GlobalTypeDef
*USBx
);
443 HAL_StatusTypeDef
USB_DriveVbus (USB_OTG_GlobalTypeDef
*USBx
, uint8_t state
);
444 uint32_t USB_GetHostSpeed (USB_OTG_GlobalTypeDef
*USBx
);
445 uint32_t USB_GetCurrentFrame (USB_OTG_GlobalTypeDef
*USBx
);
446 HAL_StatusTypeDef
USB_HC_Init(USB_OTG_GlobalTypeDef
*USBx
,
453 HAL_StatusTypeDef
USB_HC_StartXfer(USB_OTG_GlobalTypeDef
*USBx
, USB_OTG_HCTypeDef
*hc
, uint8_t dma
);
454 uint32_t USB_HC_ReadInterrupt (USB_OTG_GlobalTypeDef
*USBx
);
455 HAL_StatusTypeDef
USB_HC_Halt(USB_OTG_GlobalTypeDef
*USBx
, uint8_t hc_num
);
456 HAL_StatusTypeDef
USB_DoPing(USB_OTG_GlobalTypeDef
*USBx
, uint8_t ch_num
);
457 HAL_StatusTypeDef
USB_StopHost(USB_OTG_GlobalTypeDef
*USBx
);
472 #endif /* __STM32F7xx_LL_USB_H */
474 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/