stm32g4xx_hal_pcd.c

转至该文件的文档。

/**
  ******************************************************************************
  * @file    stm32g4xx_hal_pcd.c
  * @author  MCD Application Team
  * @brief   PCD HAL 模块驱动程序。
  *          本文件提供固件函数用于管理以下
  *          USB 外设控制器的功能：
  *           + 初始化和去初始化函数
  *           + IO 操作函数
  *           + 外设控制函数
  *           + 外设状态函数
  *
  ******************************************************************************
  * @attention
  *
  * Copyright (c) 2019 STMicroelectronics.
  * All rights reserved.
  *
  * This software is licensed under terms that can be found in the LICENSE file
  * in the root directory of this software component.
  * If no LICENSE file comes with this software, it is provided AS-IS.
  *
  ******************************************************************************
  @verbatim
  ==============================================================================
                    ##### 如何使用本驱动程序 #####
  ==============================================================================
    [..]
      PCD HAL 驱动程序的使用方法如下：

     (#) 声明一个 PCD_HandleTypeDef 句柄结构，例如：
         PCD_HandleTypeDef  hpcd;

     (#) 在 HCD 句柄中填充 Init 结构体参数

     (#) 调用 HAL_PCD_Init() API 初始化 PCD 外设（核心、设备核心...）

     (#) 通过 HAL_PCD_MspInit() API 初始化 PCD 低层资源：
         (##) 使用以下方式启用 PCD/USB 低层接口时钟
              (+++) __HAL_RCC_USB_CLK_ENABLE(); 用于 USB 设备 FS 外设

         (##) 初始化相关的 GPIO 时钟
         (##) 配置 PCD 引脚分配
         (##) 配置 PCD NVIC 中断

     (#)将上级 USB 设备栈关联到 HAL PCD 驱动程序：
         (##) hpcd.pData = pdev;

     (#)启用 PCD 发送和接收：
         (##) HAL_PCD_Start();

     (#)注意：对于不使用双缓冲模式的应用程序，定义符号
               'USE_USB_DOUBLE_BUFFER' 为 0 以减小驱动程序的内存占用。

  @endverbatim
  ******************************************************************************
  */

/* Includes ------------------------------------------------------------------*/
#include "stm32g4xx_hal.h"

/** @addtogroup STM32G4xx_HAL_Driver
  * @{
  */

/** @defgroup PCD PCD
  * @brief PCD HAL 模块驱动程序
  * @{
  */

#ifdef HAL_PCD_MODULE_ENABLED

#if defined (USB)

/* Private types -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/* Private constants ---------------------------------------------------------*/
/* Private macros ------------------------------------------------------------*/
/** @defgroup PCD_Private_Macros PCD 私有宏
  * @{
  */
#define PCD_MIN(a, b)  (((a) < (b)) ? (a) : (b))
#define PCD_MAX(a, b)  (((a) > (b)) ? (a) : (b))
/**
  * @}
  */

/* Private functions prototypes ----------------------------------------------*/
/** @defgroup PCD_Private_Functions PCD 私有函数
  * @{
  */

static HAL_StatusTypeDef PCD_EP_ISR_Handler(PCD_HandleTypeDef *hpcd);
#if (USE_USB_DOUBLE_BUFFER == 1U)
static HAL_StatusTypeDef HAL_PCD_EP_DB_Transmit(PCD_HandleTypeDef *hpcd, PCD_EPTypeDef *ep, uint16_t wEPVal);
static uint16_t HAL_PCD_EP_DB_Receive(PCD_HandleTypeDef *hpcd, PCD_EPTypeDef *ep, uint16_t wEPVal);
#endif /* (USE_USB_DOUBLE_BUFFER == 1U) */

/**
  * @}
  */
  */

/* Exported functions --------------------------------------------------------*/
/** @defgroup PCD_Exported_Functions PCD 导出函数
  * @{
  */

/** @defgroup PCD_Exported_Functions_Group1 初始化和去初始化函数
  *  @brief    初始化和配置函数
  *
@verbatim
 ===============================================================================
            ##### 初始化和去初始化函数 #####
 ===============================================================================
    [..]  本节提供以下函数：

@endverbatim
  * @{
  */

/**
  * @brief  根据 PCD_InitTypeDef 中指定的参数初始化 PCD 并初始化关联的句柄。
  * @param  hpcd PCD 句柄
  * @retval HAL 状态
  */
00127 HAL_StatusTypeDef HAL_PCD_Init(PCD_HandleTypeDef *hpcd)
{
  uint8_t i;

  /* 检查 PCD 句柄分配 */
  if (hpcd == NULL)
  {
    return HAL_ERROR;
  }

  /* 检查参数 */
  assert_param(IS_PCD_ALL_INSTANCE(hpcd->Instance));

  if (hpcd->State == HAL_PCD_STATE_RESET)
  {
    /* 分配锁资源并初始化 */
    hpcd->Lock = HAL_UNLOCKED;

#if (USE_HAL_PCD_REGISTER_CALLBACKS == 1U)
    hpcd->SOFCallback = HAL_PCD_SOFCallback;
    hpcd->SetupStageCallback = HAL_PCD_SetupStageCallback;
    hpcd->ResetCallback = HAL_PCD_ResetCallback;
    hpcd->SuspendCallback = HAL_PCD_SuspendCallback;
    hpcd->ResumeCallback = HAL_PCD_ResumeCallback;
    hpcd->ConnectCallback = HAL_PCD_ConnectCallback;
    hpcd->DisconnectCallback = HAL_PCD_DisconnectCallback;
    hpcd->DataOutStageCallback = HAL_PCD_DataOutStageCallback;
    hpcd->DataInStageCallback = HAL_PCD_DataInStageCallback;
    hpcd->ISOOUTIncompleteCallback = HAL_PCD_ISOOUTIncompleteCallback;
    hpcd->ISOINIncompleteCallback = HAL_PCD_ISOINIncompleteCallback;
    hpcd->LPMCallback = HAL_PCDEx_LPM_Callback;
    hpcd->BCDCallback = HAL_PCDEx_BCD_Callback;

    if (hpcd->MspInitCallback == NULL)
    {
      hpcd->MspInitCallback = HAL_PCD_MspInit;
    }

    /* 初始化底层硬件 */
    hpcd->MspInitCallback(hpcd);
#else
    /* 初始化底层硬件：GPIO、时钟、NVIC... */