Control functions. More...

Functions
HAL_StatusTypeDef	HAL_CORDIC_Configure (CORDIC_HandleTypeDef hcordic, CORDIC_ConfigTypeDef sConfig)
	Configure the CORDIC processing according to the specified parameters in the CORDIC_ConfigTypeDef structure.
HAL_StatusTypeDef	HAL_CORDIC_Calculate (CORDIC_HandleTypeDef hcordic, int32_t pInBuff, int32_t *pOutBuff, uint32_t NbCalc, uint32_t Timeout)
	Carry out data of CORDIC processing in polling mode, according to the existing CORDIC configuration.
HAL_StatusTypeDef	HAL_CORDIC_CalculateZO (CORDIC_HandleTypeDef hcordic, int32_t pInBuff, int32_t *pOutBuff, uint32_t NbCalc, uint32_t Timeout)
	Carry out data of CORDIC processing in Zero-Overhead mode (output data being read soon as input data are written), according to the existing CORDIC configuration.
HAL_StatusTypeDef	HAL_CORDIC_Calculate_IT (CORDIC_HandleTypeDef hcordic, int32_t pInBuff, int32_t *pOutBuff, uint32_t NbCalc)
	Carry out data of CORDIC processing in interrupt mode, according to the existing CORDIC configuration.
HAL_StatusTypeDef	HAL_CORDIC_Calculate_DMA (CORDIC_HandleTypeDef hcordic, int32_t pInBuff, int32_t *pOutBuff, uint32_t NbCalc, uint32_t DMADirection)
	Carry out input and/or output data of CORDIC processing in DMA mode, according to the existing CORDIC configuration.

Detailed Description

Control functions.

  ==============================================================================
                      ##### Peripheral Control functions #####
  ==============================================================================
    [..]  This section provides functions allowing to:
      (+) Configure the CORDIC peripheral: function, precision, scaling factor,
          number of input data and output data, size of input data and output data.
      (+) Calculate output data of CORDIC processing on input date, using the
          existing CORDIC configuration
    [..]  Four processing functions are available for calculation:
      (+) Polling mode
      (+) Polling mode, with Zero-Overhead register access
      (+) Interrupt mode
      (+) DMA mode

Function Documentation

HAL_StatusTypeDef HAL_CORDIC_Calculate	(	CORDIC_HandleTypeDef *	hcordic,
		int32_t *	pInBuff,
		int32_t *	pOutBuff,
		uint32_t	NbCalc,
		uint32_t	Timeout
	)

Carry out data of CORDIC processing in polling mode, according to the existing CORDIC configuration.

Parameters:

hcordic	pointer to a CORDIC_HandleTypeDef structure that contains the configuration information for CORDIC module.
pInBuff	Pointer to buffer containing input data for CORDIC processing.
pOutBuff	Pointer to buffer where output data of CORDIC processing will be stored.
NbCalc	Number of CORDIC calculation to process.
Timeout	Specify Timeout value

Return values:

HAL status

Definition at line 605 of file stm32h7xx_hal_cordic.c.

References CORDIC_ReadOutDataIncrementPtr(), CORDIC_WriteInDataIncrementPtr(), __CORDIC_HandleTypeDef::ErrorCode, HAL_CORDIC_ERROR_NONE, HAL_CORDIC_ERROR_NOT_READY, HAL_CORDIC_ERROR_PARAM, HAL_CORDIC_ERROR_TIMEOUT, HAL_CORDIC_STATE_BUSY, HAL_CORDIC_STATE_READY, HAL_GetTick(), __CORDIC_HandleTypeDef::Instance, and __CORDIC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_CORDIC_Calculate_DMA	(	CORDIC_HandleTypeDef *	hcordic,
		int32_t *	pInBuff,
		int32_t *	pOutBuff,
		uint32_t	NbCalc,
		uint32_t	DMADirection
	)

Carry out input and/or output data of CORDIC processing in DMA mode, according to the existing CORDIC configuration.

Parameters:

hcordic	pointer to a CORDIC_HandleTypeDef structure that contains the configuration information for CORDIC module.
pInBuff	Pointer to buffer containing input data for CORDIC processing.
pOutBuff	Pointer to buffer where output data of CORDIC processing will be stored.
NbCalc	Number of CORDIC calculation to process.
DMADirection	Direction of DMA transfers. This parameter can be one of the following values: CORDIC DMA direction CORDIC DMA direction

Note:: pInBuff or pOutBuff is unused in case of unique DMADirection transfer, and can be set to NULL value in this case.; pInBuff and pOutBuff buffers must be 32-bit aligned to ensure a correct DMA transfer to and from the Peripheral.

Return values:

HAL status

Definition at line 884 of file stm32h7xx_hal_cordic.c.

References assert_param, CORDIC_DMA_DIR_IN, CORDIC_DMA_DIR_IN_OUT, CORDIC_DMA_DIR_OUT, CORDIC_DMA_REN, CORDIC_DMA_WEN, CORDIC_DMAError(), CORDIC_DMAInCplt(), CORDIC_DMAOutCplt(), __CORDIC_HandleTypeDef::DMADirection, __CORDIC_HandleTypeDef::ErrorCode, HAL_CORDIC_ERROR_DMA, HAL_CORDIC_ERROR_NONE, HAL_CORDIC_ERROR_NOT_READY, HAL_CORDIC_ERROR_PARAM, HAL_CORDIC_STATE_BUSY, HAL_CORDIC_STATE_READY, HAL_DMA_Start_IT(), __CORDIC_HandleTypeDef::hdmaIn, __CORDIC_HandleTypeDef::hdmaOut, __CORDIC_HandleTypeDef::Instance, IS_CORDIC_DMA_DIRECTION, __CORDIC_HandleTypeDef::State, __DMA_HandleTypeDef::XferCpltCallback, and __DMA_HandleTypeDef::XferErrorCallback.

HAL_StatusTypeDef HAL_CORDIC_Calculate_IT	(	CORDIC_HandleTypeDef *	hcordic,
		int32_t *	pInBuff,
		int32_t *	pOutBuff,
		uint32_t	NbCalc
	)

Carry out data of CORDIC processing in interrupt mode, according to the existing CORDIC configuration.

Parameters:

hcordic	pointer to a CORDIC_HandleTypeDef structure that contains the configuration information for CORDIC module.
pInBuff	Pointer to buffer containing input data for CORDIC processing.
pOutBuff	Pointer to buffer where output data of CORDIC processing will be stored.
NbCalc	Number of CORDIC calculation to process.

Return values:

HAL status

Definition at line 792 of file stm32h7xx_hal_cordic.c.

References __HAL_CORDIC_ENABLE_IT, CORDIC_IT_IEN, __CORDIC_HandleTypeDef::ErrorCode, HAL_CORDIC_ERROR_NONE, HAL_CORDIC_ERROR_NOT_READY, HAL_CORDIC_ERROR_PARAM, HAL_CORDIC_STATE_BUSY, HAL_CORDIC_STATE_READY, __CORDIC_HandleTypeDef::Instance, __CORDIC_HandleTypeDef::NbCalcToGet, __CORDIC_HandleTypeDef::NbCalcToOrder, __CORDIC_HandleTypeDef::pInBuff, __CORDIC_HandleTypeDef::pOutBuff, and __CORDIC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_CORDIC_CalculateZO	(	CORDIC_HandleTypeDef *	hcordic,
		int32_t *	pInBuff,
		int32_t *	pOutBuff,
		uint32_t	NbCalc,
		uint32_t	Timeout
	)

Carry out data of CORDIC processing in Zero-Overhead mode (output data being read soon as input data are written), according to the existing CORDIC configuration.

Parameters:

hcordic	pointer to a CORDIC_HandleTypeDef structure that contains the configuration information for CORDIC module.
pInBuff	Pointer to buffer containing input data for CORDIC processing.
pOutBuff	Pointer to buffer where output data of CORDIC processing will be stored.
NbCalc	Number of CORDIC calculation to process.
Timeout	Specify Timeout value

Return values:

HAL status

Definition at line 699 of file stm32h7xx_hal_cordic.c.

References CORDIC_ReadOutDataIncrementPtr(), CORDIC_WriteInDataIncrementPtr(), __CORDIC_HandleTypeDef::ErrorCode, HAL_CORDIC_ERROR_NONE, HAL_CORDIC_ERROR_NOT_READY, HAL_CORDIC_ERROR_PARAM, HAL_CORDIC_ERROR_TIMEOUT, HAL_CORDIC_STATE_BUSY, HAL_CORDIC_STATE_READY, HAL_GetTick(), and __CORDIC_HandleTypeDef::State.

HAL_StatusTypeDef HAL_CORDIC_Configure	(	CORDIC_HandleTypeDef *	hcordic,
		CORDIC_ConfigTypeDef *	sConfig
	)

Configure the CORDIC processing according to the specified parameters in the CORDIC_ConfigTypeDef structure.

Parameters:

hcordic	pointer to a CORDIC_HandleTypeDef structure that contains the configuration information for CORDIC module
sConfig	pointer to a CORDIC_ConfigTypeDef structure that contains the CORDIC configuration information.

Return values:

HAL status

Definition at line 558 of file stm32h7xx_hal_cordic.c.

References assert_param, __CORDIC_HandleTypeDef::ErrorCode, CORDIC_ConfigTypeDef::Function, HAL_CORDIC_ERROR_NOT_READY, HAL_CORDIC_STATE_READY, CORDIC_ConfigTypeDef::InSize, __CORDIC_HandleTypeDef::Instance, IS_CORDIC_FUNCTION, IS_CORDIC_INSIZE, IS_CORDIC_NBREAD, IS_CORDIC_NBWRITE, IS_CORDIC_OUTSIZE, IS_CORDIC_PRECISION, IS_CORDIC_SCALE, CORDIC_ConfigTypeDef::NbRead, CORDIC_ConfigTypeDef::NbWrite, CORDIC_ConfigTypeDef::OutSize, CORDIC_ConfigTypeDef::Precision, CORDIC_ConfigTypeDef::Scale, and __CORDIC_HandleTypeDef::State.

Functions

Detailed Description

Function Documentation