STM CMSIS
stm32f4xx_ll_usb.h
Go to the documentation of this file.
1 
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __STM32F4xx_LL_USB_H
40 #define __STM32F4xx_LL_USB_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) || defined(STM32F412Zx) || defined(STM32F412Vx) || \
49  defined(STM32F412Rx) || defined(STM32F412Cx)
50 /* Includes ------------------------------------------------------------------*/
51 #include "stm32f4xx_hal_def.h"
52 
61 /* Exported types ------------------------------------------------------------*/
62 
66 typedef enum
67 {
68  USB_OTG_DEVICE_MODE = 0U,
69  USB_OTG_HOST_MODE = 1U,
70  USB_OTG_DRD_MODE = 2U
71 
72 }USB_OTG_ModeTypeDef;
73 
77 typedef enum {
78  URB_IDLE = 0U,
79  URB_DONE,
80  URB_NOTREADY,
81  URB_NYET,
82  URB_ERROR,
83  URB_STALL
84 
85 }USB_OTG_URBStateTypeDef;
86 
90 typedef enum {
91  HC_IDLE = 0U,
92  HC_XFRC,
93  HC_HALTED,
94  HC_NAK,
95  HC_NYET,
96  HC_STALL,
97  HC_XACTERR,
98  HC_BBLERR,
99  HC_DATATGLERR
100 
101 }USB_OTG_HCStateTypeDef;
102 
106 typedef struct
107 {
108  uint32_t dev_endpoints;
112  uint32_t Host_channels;
116  uint32_t speed;
119  uint32_t dma_enable;
121  uint32_t ep0_mps;
124  uint32_t phy_itface;
127  uint32_t Sof_enable;
129  uint32_t low_power_enable;
131  uint32_t lpm_enable;
133  uint32_t battery_charging_enable;
135  uint32_t vbus_sensing_enable;
137  uint32_t use_dedicated_ep1;
139  uint32_t use_external_vbus;
141 }USB_OTG_CfgTypeDef;
142 
146 typedef struct
147 {
148  uint8_t num;
151  uint8_t is_in;
154  uint8_t is_stall;
157  uint8_t type;
160  uint8_t data_pid_start;
163  uint8_t even_odd_frame;
166  uint16_t tx_fifo_num;
169  uint32_t maxpacket;
172  uint8_t *xfer_buff;
174  uint32_t dma_addr;
176  uint32_t xfer_len;
178  uint32_t xfer_count;
180 }USB_OTG_EPTypeDef;
181 
185 typedef struct
186 {
187  uint8_t dev_addr ;
190  uint8_t ch_num;
193  uint8_t ep_num;
196  uint8_t ep_is_in;
199  uint8_t speed;
202  uint8_t do_ping;
204  uint8_t process_ping;
206  uint8_t ep_type;
209  uint16_t max_packet;
212  uint8_t data_pid;
215  uint8_t *xfer_buff;
217  uint32_t xfer_len;
219  uint32_t xfer_count;
221  uint8_t toggle_in;
224  uint8_t toggle_out;
227  uint32_t dma_addr;
229  uint32_t ErrCnt;
231  USB_OTG_URBStateTypeDef urb_state;
234  USB_OTG_HCStateTypeDef state;
237 }USB_OTG_HCTypeDef;
238 
239 /* Exported constants --------------------------------------------------------*/
240 
248 #define USB_OTG_MODE_DEVICE 0U
249 #define USB_OTG_MODE_HOST 1U
250 #define USB_OTG_MODE_DRD 2U
251 
258 #define USB_OTG_SPEED_HIGH 0U
259 #define USB_OTG_SPEED_HIGH_IN_FULL 1U
260 #define USB_OTG_SPEED_LOW 2U
261 #define USB_OTG_SPEED_FULL 3U
262 
269 #define USB_OTG_ULPI_PHY 1U
270 #define USB_OTG_EMBEDDED_PHY 2U
271 
278 #define USB_OTG_HS_MAX_PACKET_SIZE 512U
279 #define USB_OTG_FS_MAX_PACKET_SIZE 64U
280 #define USB_OTG_MAX_EP0_SIZE 64U
281 
288 #define DSTS_ENUMSPD_HS_PHY_30MHZ_OR_60MHZ (0U << 1U)
289 #define DSTS_ENUMSPD_FS_PHY_30MHZ_OR_60MHZ (1U << 1U)
290 #define DSTS_ENUMSPD_LS_PHY_6MHZ (2U << 1U)
291 #define DSTS_ENUMSPD_FS_PHY_48MHZ (3U << 1U)
292 
299 #define DCFG_FRAME_INTERVAL_80 0U
300 #define DCFG_FRAME_INTERVAL_85 1U
301 #define DCFG_FRAME_INTERVAL_90 2U
302 #define DCFG_FRAME_INTERVAL_95 3U
303 
310 #define DEP0CTL_MPS_64 0U
311 #define DEP0CTL_MPS_32 1U
312 #define DEP0CTL_MPS_16 2U
313 #define DEP0CTL_MPS_8 3U
314 
321 #define EP_SPEED_LOW 0U
322 #define EP_SPEED_FULL 1U
323 #define EP_SPEED_HIGH 2U
324 
331 #define EP_TYPE_CTRL 0U
332 #define EP_TYPE_ISOC 1U
333 #define EP_TYPE_BULK 2U
334 #define EP_TYPE_INTR 3U
335 #define EP_TYPE_MSK 3U
336 
343 #define STS_GOUT_NAK 1U
344 #define STS_DATA_UPDT 2U
345 #define STS_XFER_COMP 3U
346 #define STS_SETUP_COMP 4U
347 #define STS_SETUP_UPDT 6U
348 
355 #define HCFG_30_60_MHZ 0U
356 #define HCFG_48_MHZ 1U
357 #define HCFG_6_MHZ 2U
358 
365 #define HPRT0_PRTSPD_HIGH_SPEED 0U
366 #define HPRT0_PRTSPD_FULL_SPEED 1U
367 #define HPRT0_PRTSPD_LOW_SPEED 2U
368 
372 #define HCCHAR_CTRL 0U
373 #define HCCHAR_ISOC 1U
374 #define HCCHAR_BULK 2U
375 #define HCCHAR_INTR 3U
376 
377 #define HC_PID_DATA0 0U
378 #define HC_PID_DATA2 1U
379 #define HC_PID_DATA1 2U
380 #define HC_PID_SETUP 3U
381 
382 #define GRXSTS_PKTSTS_IN 2
383 #define GRXSTS_PKTSTS_IN_XFER_COMP 3
384 #define GRXSTS_PKTSTS_DATA_TOGGLE_ERR 5
385 #define GRXSTS_PKTSTS_CH_HALTED 7
386 
387 #define USBx_PCGCCTL *(__IO uint32_t *)((uint32_t)USBx + USB_OTG_PCGCCTL_BASE)
388 #define USBx_HPRT0 *(__IO uint32_t *)((uint32_t)USBx + USB_OTG_HOST_PORT_BASE)
389 
390 #define USBx_DEVICE ((USB_OTG_DeviceTypeDef *)((uint32_t )USBx + USB_OTG_DEVICE_BASE))
391 #define USBx_INEP(i) ((USB_OTG_INEndpointTypeDef *)((uint32_t)USBx + USB_OTG_IN_ENDPOINT_BASE + (i)*USB_OTG_EP_REG_SIZE))
392 #define USBx_OUTEP(i) ((USB_OTG_OUTEndpointTypeDef *)((uint32_t)USBx + USB_OTG_OUT_ENDPOINT_BASE + (i)*USB_OTG_EP_REG_SIZE))
393 #define USBx_DFIFO(i) *(__IO uint32_t *)((uint32_t)USBx + USB_OTG_FIFO_BASE + (i) * USB_OTG_FIFO_SIZE)
394 
395 #define USBx_HOST ((USB_OTG_HostTypeDef *)((uint32_t )USBx + USB_OTG_HOST_BASE))
396 #define USBx_HC(i) ((USB_OTG_HostChannelTypeDef *)((uint32_t)USBx + USB_OTG_HOST_CHANNEL_BASE + (i)*USB_OTG_HOST_CHANNEL_SIZE))
397 
400 /* Exported macro ------------------------------------------------------------*/
401 #define USB_MASK_INTERRUPT(__INSTANCE__, __INTERRUPT__) ((__INSTANCE__)->GINTMSK &= ~(__INTERRUPT__))
402 #define USB_UNMASK_INTERRUPT(__INSTANCE__, __INTERRUPT__) ((__INSTANCE__)->GINTMSK |= (__INTERRUPT__))
403 
404 #define CLEAR_IN_EP_INTR(__EPNUM__, __INTERRUPT__) (USBx_INEP(__EPNUM__)->DIEPINT = (__INTERRUPT__))
405 #define CLEAR_OUT_EP_INTR(__EPNUM__, __INTERRUPT__) (USBx_OUTEP(__EPNUM__)->DOEPINT = (__INTERRUPT__))
406 
407 /* Exported functions --------------------------------------------------------*/
408 HAL_StatusTypeDef USB_CoreInit(USB_OTG_GlobalTypeDef *USBx, USB_OTG_CfgTypeDef Init);
409 HAL_StatusTypeDef USB_DevInit(USB_OTG_GlobalTypeDef *USBx, USB_OTG_CfgTypeDef Init);
410 HAL_StatusTypeDef USB_EnableGlobalInt(USB_OTG_GlobalTypeDef *USBx);
411 HAL_StatusTypeDef USB_DisableGlobalInt(USB_OTG_GlobalTypeDef *USBx);
412 HAL_StatusTypeDef USB_SetCurrentMode(USB_OTG_GlobalTypeDef *USBx , USB_OTG_ModeTypeDef mode);
413 HAL_StatusTypeDef USB_SetDevSpeed(USB_OTG_GlobalTypeDef *USBx , uint8_t speed);
414 HAL_StatusTypeDef USB_FlushRxFifo (USB_OTG_GlobalTypeDef *USBx);
415 HAL_StatusTypeDef USB_FlushTxFifo (USB_OTG_GlobalTypeDef *USBx, uint32_t num );
416 HAL_StatusTypeDef USB_ActivateEndpoint(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep);
417 HAL_StatusTypeDef USB_DeactivateEndpoint(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep);
418 HAL_StatusTypeDef USB_ActivateDedicatedEndpoint(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep);
419 HAL_StatusTypeDef USB_DeactivateDedicatedEndpoint(USB_OTG_GlobalTypeDef *USBx, USB_OTG_EPTypeDef *ep);
420 HAL_StatusTypeDef USB_EPStartXfer(USB_OTG_GlobalTypeDef *USBx , USB_OTG_EPTypeDef *ep, uint8_t dma);
421 HAL_StatusTypeDef USB_EP0StartXfer(USB_OTG_GlobalTypeDef *USBx , USB_OTG_EPTypeDef *ep, uint8_t dma);
422 HAL_StatusTypeDef USB_WritePacket(USB_OTG_GlobalTypeDef *USBx, uint8_t *src, uint8_t ch_ep_num, uint16_t len, uint8_t dma);
423 void * USB_ReadPacket(USB_OTG_GlobalTypeDef *USBx, uint8_t *dest, uint16_t len);
424 HAL_StatusTypeDef USB_EPSetStall(USB_OTG_GlobalTypeDef *USBx , USB_OTG_EPTypeDef *ep);
425 HAL_StatusTypeDef USB_EPClearStall(USB_OTG_GlobalTypeDef *USBx , USB_OTG_EPTypeDef *ep);
426 HAL_StatusTypeDef USB_SetDevAddress (USB_OTG_GlobalTypeDef *USBx, uint8_t address);
427 HAL_StatusTypeDef USB_DevConnect (USB_OTG_GlobalTypeDef *USBx);
428 HAL_StatusTypeDef USB_DevDisconnect (USB_OTG_GlobalTypeDef *USBx);
429 HAL_StatusTypeDef USB_StopDevice(USB_OTG_GlobalTypeDef *USBx);
430 HAL_StatusTypeDef USB_ActivateSetup (USB_OTG_GlobalTypeDef *USBx);
431 HAL_StatusTypeDef USB_EP0_OutStart(USB_OTG_GlobalTypeDef *USBx, uint8_t dma, uint8_t *psetup);
432 uint8_t USB_GetDevSpeed(USB_OTG_GlobalTypeDef *USBx);
433 uint32_t USB_GetMode(USB_OTG_GlobalTypeDef *USBx);
434 uint32_t USB_ReadInterrupts (USB_OTG_GlobalTypeDef *USBx);
435 uint32_t USB_ReadDevAllOutEpInterrupt (USB_OTG_GlobalTypeDef *USBx);
436 uint32_t USB_ReadDevOutEPInterrupt (USB_OTG_GlobalTypeDef *USBx , uint8_t epnum);
437 uint32_t USB_ReadDevAllInEpInterrupt (USB_OTG_GlobalTypeDef *USBx);
438 uint32_t USB_ReadDevInEPInterrupt (USB_OTG_GlobalTypeDef *USBx , uint8_t epnum);
439 void USB_ClearInterrupts (USB_OTG_GlobalTypeDef *USBx, uint32_t interrupt);
440 
441 HAL_StatusTypeDef USB_HostInit (USB_OTG_GlobalTypeDef *USBx, USB_OTG_CfgTypeDef cfg);
442 HAL_StatusTypeDef USB_InitFSLSPClkSel(USB_OTG_GlobalTypeDef *USBx , uint8_t freq);
443 HAL_StatusTypeDef USB_ResetPort(USB_OTG_GlobalTypeDef *USBx);
444 HAL_StatusTypeDef USB_DriveVbus (USB_OTG_GlobalTypeDef *USBx, uint8_t state);
445 uint32_t USB_GetHostSpeed (USB_OTG_GlobalTypeDef *USBx);
446 uint32_t USB_GetCurrentFrame (USB_OTG_GlobalTypeDef *USBx);
447 HAL_StatusTypeDef USB_HC_Init(USB_OTG_GlobalTypeDef *USBx,
448  uint8_t ch_num,
449  uint8_t epnum,
450  uint8_t dev_address,
451  uint8_t speed,
452  uint8_t ep_type,
453  uint16_t mps);
454 HAL_StatusTypeDef USB_HC_StartXfer(USB_OTG_GlobalTypeDef *USBx, USB_OTG_HCTypeDef *hc, uint8_t dma);
455 uint32_t USB_HC_ReadInterrupt (USB_OTG_GlobalTypeDef *USBx);
456 HAL_StatusTypeDef USB_HC_Halt(USB_OTG_GlobalTypeDef *USBx , uint8_t hc_num);
457 HAL_StatusTypeDef USB_DoPing(USB_OTG_GlobalTypeDef *USBx , uint8_t ch_num);
458 HAL_StatusTypeDef USB_StopHost(USB_OTG_GlobalTypeDef *USBx);
459 
467 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx ||
468  STM32F401xC || STM32F401xE || STM32F411xE || STM32F446xx || STM32F469xx || STM32F479xx || STM32F412Zx || STM32F412Rx ||
469  STM32F412Vx || STM32F412Cx */
470 #ifdef __cplusplus
471 }
472 #endif
473 
474 
475 #endif /* __STM32F4xx_LL_USB_H */
476 
477 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
stm32f4xx_hal_def.h
This file contains HAL common defines, enumeration, macros and structures definitions.
USB_OTG_GlobalTypeDef
__USB_OTG_Core_register
Definition: stm32f401xc.h:543
HAL_StatusTypeDef
HAL_StatusTypeDef
HAL Status structures definition.
Definition: stm32f4xx_hal_def.h:57