40 HAL PCD Generic Driver

40.1PCD Firmware driver registers structures

40.1.1PCD_HandleTypeDef

Data Fields

PCD_TypeDef * Instance

PCD_InitTypeDef Init

PCD_EPTypeDef IN_ep

PCD_EPTypeDef OUT_ep

HAL_LockTypeDef Lock

__IO PCD_StateTypeDef State

uint32_t Setup

void * pData

Field Documentation

PCD_TypeDef* PCD_HandleTypeDef::Instance

Register base address

PCD_InitTypeDef PCD_HandleTypeDef::Init

PCD required parameters

PCD_EPTypeDef PCD_HandleTypeDef::IN_ep[15]

IN endpoint parameters

PCD_EPTypeDef PCD_HandleTypeDef::OUT_ep[15]

OUT endpoint parameters

HAL_LockTypeDef PCD_HandleTypeDef::Lock

PCD peripheral status

__IO PCD_StateTypeDef PCD_HandleTypeDef::State

PCD communication state

uint32_t PCD_HandleTypeDef::Setup[12]

Setup packet buffer

void* PCD_HandleTypeDef::pData

Pointer to upper stack Handler

40.2PCD Firmware driver API description

40.2.1How to use this driver

The PCD HAL driver can be used as follows:

1.Declare a PCD_HandleTypeDef handle structure, for example: PCD_HandleTypeDef hpcd;

2.Fill parameters of Init structure in HCD handle

3.Call HAL_PCD_Init() API to initialize the HCD peripheral (Core, Device core, ...)

4.Initialize the PCD low level resources through the HAL_PCD_MspInit() API: a. Enable the PCD/USB Low Level interface clock using

__OTGFS-OTG_CLK_ENABLE()/__OTGHS-OTG_CLK_ENABLE();

__OTGHSULPI_CLK_ENABLE(); (For High Speed Mode)

b.Initialize the related GPIO clocks

c.Configure PCD pin-out

d.Configure PCD NVIC interrupt

5.Associate the Upper USB device stack to the HAL PCD Driver:

a.hpcd.pData = pdev;

6.Enable HCD transmission and reception:

a.HAL_PCD_Start();

40.2.2Initialization and de-initialization functions

This section provides functions allowing to:

This section contains the following APIs:

HAL_PCD_Init()

HAL_PCD_DeInit()

HAL_PCD_MspInit()

HAL_PCD_MspDeInit()

40.2.3IO operation functions

This subsection provides a set of functions allowing to manage the PCD data transfers. This section contains the following APIs:

HAL_PCD_Start()

HAL_PCD_Stop()

HAL_PCD_IRQHandler()

HAL_PCD_DataOutStageCallback()

HAL_PCD_DataInStageCallback()

HAL_PCD_SetupStageCallback()

HAL_PCD_SOFCallback()

HAL_PCD_ResetCallback()

HAL_PCD_SuspendCallback()

HAL_PCD_ResumeCallback()

HAL_PCD_ISOOUTIncompleteCallback()

HAL_PCD_ISOINIncompleteCallback()

HAL_PCD_ConnectCallback()

HAL_PCD_DisconnectCallback()

40.2.4Peripheral Control functions

This subsection provides a set of functions allowing to control the PCD data transfers. This section contains the following APIs:

HAL_PCD_DevConnect()

HAL_PCD_DevDisconnect()

HAL_PCD_SetAddress()

HAL_PCD_EP_Open()

HAL_PCD_EP_Close()

HAL_PCD_EP_Receive()

HAL_PCD_EP_GetRxCount()

HAL_PCD_EP_Transmit()

HAL_PCD_EP_SetStall()

HAL_PCD_EP_ClrStall()

HAL_PCD_EP_Flush()

HAL_PCD_ActivateRemoteWakeup()

HAL_PCD_DeActivateRemoteWakeup()

40.2.5Peripheral State functions

This subsection permits to get in run-time the status of the peripheral and the data flow.

This section contains the following APIs:

HAL_PCD_GetState()

40.2.6HAL_PCD_Init

40.2.7HAL_PCD_DeInit

40.2.8HAL_PCD_MspInit

40.2.9HAL_PCD_MspDeInit

40.2.10 HAL_PCD_Start

40.2.11 HAL_PCD_Stop

40.2.12HAL_PCD_IRQHandler

40.2.13HAL_PCD_DataOutStageCallback

40.2.14HAL_PCD_DataInStageCallback

40.2.15HAL_PCD_SetupStageCallback

40.2.16HAL_PCD_SOFCallback