stm32g4xx_hal_cordic.c

转至该文件的文档。

/**
  ******************************************************************************
  * @file    stm32g4xx_hal_cordic.c
  * @author  MCD Application Team
  * @brief   CORDIC HAL模块驱动程序。
  *          本文件提供用于管理CORDIC外设以下功能的固件函数：
  *           + 初始化和反初始化函数
  *           + 外设控制函数
  *           + 回调函数
  *           + IRQ处理程序管理
  *           + 外设状态函数
  *
  ******************************************************************************
  * @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
  ================================================================================
            ##### 如何使用此驱动程序 #####
  ================================================================================
    [..]
      CORDIC HAL驱动程序可按如下方式使用：

      (#) 通过实现HAL_CORDIC_MspInit()初始化CORDIC低层资源：
         (++) 使用__HAL_RCC_CORDIC_CLK_ENABLE()使能CORDIC接口时钟
         (++) 如果使用中断（例如HAL_CORDIC_Calculate_IT()）
             (+++) 使用HAL_NVIC_SetPriority()配置CORDIC中断优先级
             (+++) 使用HAL_NVIC_EnableIRQ()使能CORDIC IRQ处理程序
             (+++) 在CORDIC IRQ处理程序中调用HAL_CORDIC_IRQHandler()
         (++) 如果使用DMA控制数据传输（例如HAL_CORDIC_Calculate_DMA()）
             (+++) 使用__HAL_RCC_DMA2_CLK_ENABLE()使能DMA2接口时钟
             (+++) 配置并使能两个DMA通道，一个用于管理从内存到外设的数据传输
                 （输入通道），另一个用于管理从外设到内存的数据传输
                 （输出通道）
             (+++) 使用__HAL_LINKDMA()将初始化的DMA句柄关联到CORDIC DMA句柄
             (+++) 配置两个DMA通道的传输完成中断的优先级并使能NVIC。
                 使用HAL_NVIC_SetPriority()和HAL_NVIC_EnableIRQ()

      (#) 使用HAL_CORDIC_Init()初始化CORDIC HAL。此函数
         (++) 依赖于HAL_CORDIC_MspInit()进行低层初始化，

      (#) 使用HAL_CORDIC_Configure()配置CORDIC处理（计算）。
          此函数配置：
         (++) 处理函数：余弦、正弦、相位、模量、反正切、
              双曲余弦、双曲正弦、双曲反正切、
              自然对数、平方根
         (++) 缩放因子：1至2exp(-7)
         (++) 输入数据宽度：32位输入数据大小（Q1.31格式）或16位
              输入数据大小（Q1.15格式）
         (++) 输出数据宽度：32位输出数据大小（Q1.31格式）或16位
              输出数据大小（Q1.15格式）
         (++) 一次计算预期的32位写入次数：一次32位写入
              或两次32位写入
         (++) 一次计算后预期的32位读取次数：一次32位读取
              或两次32位读取
         (++) 精度：计算1至15个周期（周期越多，精度越高）

      (#) 提供四种处理（计算）函数：
         (++) 轮询模式：处理API是阻塞函数
              即它处理数据并等待处理完成
              API为HAL_CORDIC_Calculate
         (++) 零开销轮询模式：处理API是阻塞函数
              即它处理数据并等待处理完成
              比标准轮询模式稍快，但也阻塞AHB总线
              API为HAL_CORDIC_CalculateZO
         (++) 中断模式：处理API是非阻塞函数
              即它在中断下处理数据
              API为HAL_CORDIC_Calculate_IT
         (++) DMA模式：处理API是非阻塞函数，CPU不用于
              数据传输，
              即数据传输由DMA保证
              API为HAL_CORDIC_Calculate_DMA

      (#) 调用HAL_CORDIC_DeInit()反初始化CORDIC外设。此函数
         (++) 依赖于HAL_CORDIC_MspDeInit()进行低层反初始化，

  *** 回调注册 ***
  =============================================

  编译定义USE_HAL_CORDIC_REGISTER_CALLBACKS设置为1时
  允许用户动态配置驱动程序回调。
  使用函数HAL_CORDIC_RegisterCallback()注册中断回调。

  函数HAL_CORDIC_RegisterCallback()允许注册以下回调：
    (+) ErrorCallback             : 错误回调。
    (+) CalculateCpltCallback     : 计算完成回调。
    (+) MspInitCallback           : CORDIC MspInit。
    (+) MspDeInitCallback         : CORDIC MspDeInit。
  此函数需要HAL外设句柄、回调ID
  以及指向用户回调函数的指针作为参数。

  使用函数HAL_CORDIC_UnRegisterCallback()将回调重置为默认
  弱函数。
  HAL_CORDIC_UnRegisterCallback需要HAL外设句柄
  和回调ID作为参数。
  此函数允许重置以下回调：
    (+) ErrorCallback             : 错误回调。
    (+) CalculateCpltCallback     : 计算完成回调。
    (+) MspInitCallback           : CORDIC MspInit。
    (+) MspDeInitCallback         : CORDIC MspDeInit。

  默认情况下，在HAL_CORDIC_Init()之后且状态为HAL_CORDIC_STATE_RESET时，
  所有回调都设置为对应的弱函数：
  示例HAL_CORDIC_ErrorCallback()、HAL_CORDIC_CalculateCpltCallback()。
  MspInit和MspDeInit函数例外，它们在HAL_CORDIC_Init()/ HAL_CORDIC_DeInit()中
  仅当这些回调为空（未预先注册）时才重置为遗留弱函数。
  否则，如果MspInit或MspDeInit不为空，HAL_CORDIC_Init()/ HAL_CORDIC_DeInit()
  保留并使用用户预先注册的MspInit/MspDeInit回调

  回调只能在HAL_CORDIC_STATE_READY状态下注册/注销。
  MspInit/MspDeInit例外，可以在HAL_CORDIC_STATE_READY或HAL_CORDIC_STATE_RESET状态下
  注册/注销，因此已注册的（用户）MspInit/DeInit回调可在Init/DeInit期间使用。
  在这种情况下，首先使用HAL_CORDIC_RegisterCallback()注册MspInit/MspDeInit用户回调
  再调用HAL_CORDIC_DeInit()
  或HAL_CORDIC_Init()函数。

  当编译定义USE_HAL_CORDIC_REGISTER_CALLBACKS设置为0或
  未定义时，回调注册功能不可用，所有回调都设置为对应的弱函数。

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

/* Includes ------------------------------------------------------------------*/
#include "stm32g4xx_hal.h"
#if defined(CORDIC)
#ifdef HAL_CORDIC_MODULE_ENABLED

/** @addtogroup STM32G4xx_HAL_Driver
  * @{
  */

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

/* Private typedef -----------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/
/* Private macro -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/* Private function prototypes -----------------------------------------------*/

/** @defgroup CORDIC_Private_Functions CORDIC私有函数
  * @{
  */
static void CORDIC_WriteInDataIncrementPtr(const CORDIC_HandleTypeDef *hcordic, const int32_t **ppInBuff);
static void CORDIC_ReadOutDataIncrementPtr(const CORDIC_HandleTypeDef *hcordic, int32_t **ppOutBuff);
static void CORDIC_DMAInCplt(DMA_HandleTypeDef *hdma);
static void CORDIC_DMAOutCplt(DMA_HandleTypeDef *hdma);
static void CORDIC_DMAError(DMA_HandleTypeDef *hdma);

/**
  * @}
  */

/* Exported functions --------------------------------------------------------*/
/** @defgroup CORDIC_Exported_Functions CORDIC导出函数
  * @{
  */

/** @defgroup CORDIC_Exported_Functions_Group1 初始化和反初始化函数
  *  @brief    初始化和配置函数。
  *
@verbatim
  ==============================================================================
              ##### 初始化和反初始化函数 #####
  ==============================================================================
    [..]  本节提供的函数允许：
      (+) 初始化CORDIC外设及相关句柄
      (+) 反初始化CORDIC外设
      (+) 初始化CORDIC MSP（MCU特定包）
      (+) 反初始化CORDIC MSP

    [..]

@endverbatim
  * @{
  */

/**
  * @brief  初始化CORDIC外设及相关句柄。
  * @param  hcordic 指向CORDIC_HandleTypeDef结构的指针。
  * @retval HAL状态
  */
HAL_StatusTypeDef HAL_CORDIC_Init(CORDIC_HandleTypeDef *hcordic)
{
  /* Check the CORDIC handle allocation */
  if (hcordic == NULL)
  {
    /* Return error status */
    return HAL_ERROR;
  }

  /* Check the instance */
  assert_param(IS_CORDIC_ALL_INSTANCE(hcordic->Instance));

#if USE_HAL_CORDIC_REGISTER_CALLBACKS == 1
  if (hcordic->State == HAL_CORDIC_STATE_RESET)
  {
    /* Allocate lock resource and initialize it */
    hcordic->Lock = HAL_UNLOCKED;

    /* Reset callbacks to legacy functions */
    hcordic->ErrorCallback         =