STM32H735xx HAL User Manual
Defines
CORDIC Private Macros
CORDIC

Defines

#define IS_CORDIC_FUNCTION(__FUNCTION__)
 Verify the CORDIC function.
#define IS_CORDIC_PRECISION(__PRECISION__)
 Verify the CORDIC precision.
#define IS_CORDIC_SCALE(__SCALE__)
 Verify the CORDIC scaling factor.
#define IS_CORDIC_NBWRITE(__NBWRITE__)
 Verify the CORDIC number of 32-bits write expected for one calculation.
#define IS_CORDIC_NBREAD(__NBREAD__)
 Verify the CORDIC number of 32-bits read expected after one calculation.
#define IS_CORDIC_INSIZE(__INSIZE__)
 Verify the CORDIC input data size for one calculation.
#define IS_CORDIC_OUTSIZE(__OUTSIZE__)
 Verify the CORDIC output data size for one calculation.
#define IS_CORDIC_DMA_DIRECTION(__DMADIR__)
 Verify the CORDIC DMA transfer Direction.

Define Documentation

#define IS_CORDIC_DMA_DIRECTION (   __DMADIR__)
Value:
(((__DMADIR__) == CORDIC_DMA_DIR_IN)  || \
                                             ((__DMADIR__) == CORDIC_DMA_DIR_OUT) || \
                                             ((__DMADIR__) == CORDIC_DMA_DIR_IN_OUT))

Verify the CORDIC DMA transfer Direction.

Parameters:
__DMADIR__DMA transfer direction.
Return values:
SET(__DMADIR__ is a valid value) or RESET (__DMADIR__ is invalid)

Definition at line 513 of file stm32h7xx_hal_cordic.h.

Referenced by HAL_CORDIC_Calculate_DMA().

#define IS_CORDIC_FUNCTION (   __FUNCTION__)
Value:
(((__FUNCTION__) == CORDIC_FUNCTION_COSINE)       || \
                                          ((__FUNCTION__) == CORDIC_FUNCTION_SINE)         || \
                                          ((__FUNCTION__) == CORDIC_FUNCTION_PHASE)        || \
                                          ((__FUNCTION__) == CORDIC_FUNCTION_MODULUS)      || \
                                          ((__FUNCTION__) == CORDIC_FUNCTION_ARCTANGENT)   || \
                                          ((__FUNCTION__) == CORDIC_FUNCTION_HCOSINE)      || \
                                          ((__FUNCTION__) == CORDIC_FUNCTION_HSINE)        || \
                                          ((__FUNCTION__) == CORDIC_FUNCTION_HARCTANGENT)  || \
                                          ((__FUNCTION__) == CORDIC_FUNCTION_NATURALLOG)   || \
                                          ((__FUNCTION__) == CORDIC_FUNCTION_SQUAREROOT))

Verify the CORDIC function.

Parameters:
__FUNCTION__Name of the function.
Return values:
SET(__FUNCTION__ is a valid value) or RESET (__FUNCTION__ is invalid)

Definition at line 429 of file stm32h7xx_hal_cordic.h.

Referenced by HAL_CORDIC_Configure().

#define IS_CORDIC_INSIZE (   __INSIZE__)
Value:
(((__INSIZE__) == CORDIC_INSIZE_32BITS)  || \
                                      ((__INSIZE__) == CORDIC_INSIZE_16BITS))

Verify the CORDIC input data size for one calculation.

Parameters:
__INSIZE__input data size for one calculation.
Return values:
SET(__INSIZE__ is a valid value) or RESET (__INSIZE__ is invalid)

Definition at line 497 of file stm32h7xx_hal_cordic.h.

Referenced by HAL_CORDIC_Configure().

#define IS_CORDIC_NBREAD (   __NBREAD__)
Value:
(((__NBREAD__) == CORDIC_NBREAD_1)  || \
                                      ((__NBREAD__) == CORDIC_NBREAD_2))

Verify the CORDIC number of 32-bits read expected after one calculation.

Parameters:
__NBREAD__Number of 32-bits read expected after one calculation.
Return values:
SET(__NBREAD__ is a valid value) or RESET (__NBREAD__ is invalid)

Definition at line 489 of file stm32h7xx_hal_cordic.h.

Referenced by HAL_CORDIC_Configure().

#define IS_CORDIC_NBWRITE (   __NBWRITE__)
Value:
(((__NBWRITE__) == CORDIC_NBWRITE_1)  || \
                                        ((__NBWRITE__) == CORDIC_NBWRITE_2))

Verify the CORDIC number of 32-bits write expected for one calculation.

Parameters:
__NBWRITE__Number of 32-bits write expected for one calculation.
Return values:
SET(__NBWRITE__ is a valid value) or RESET (__NBWRITE__ is invalid)

Definition at line 481 of file stm32h7xx_hal_cordic.h.

Referenced by HAL_CORDIC_Configure().

#define IS_CORDIC_OUTSIZE (   __OUTSIZE__)
Value:
(((__OUTSIZE__) == CORDIC_OUTSIZE_32BITS)  || \
                                        ((__OUTSIZE__) == CORDIC_OUTSIZE_16BITS))

Verify the CORDIC output data size for one calculation.

Parameters:
__OUTSIZE__output data size for one calculation.
Return values:
SET(__OUTSIZE__ is a valid value) or RESET (__OUTSIZE__ is invalid)

Definition at line 505 of file stm32h7xx_hal_cordic.h.

Referenced by HAL_CORDIC_Configure().

#define IS_CORDIC_PRECISION (   __PRECISION__)
Value:
(((__PRECISION__) == CORDIC_PRECISION_1CYCLE)   || \
                                            ((__PRECISION__) == CORDIC_PRECISION_2CYCLES)  || \
                                            ((__PRECISION__) == CORDIC_PRECISION_3CYCLES)  || \
                                            ((__PRECISION__) == CORDIC_PRECISION_4CYCLES)  || \
                                            ((__PRECISION__) == CORDIC_PRECISION_5CYCLES)  || \
                                            ((__PRECISION__) == CORDIC_PRECISION_6CYCLES)  || \
                                            ((__PRECISION__) == CORDIC_PRECISION_7CYCLES)  || \
                                            ((__PRECISION__) == CORDIC_PRECISION_8CYCLES)  || \
                                            ((__PRECISION__) == CORDIC_PRECISION_9CYCLES)  || \
                                            ((__PRECISION__) == CORDIC_PRECISION_10CYCLES) || \
                                            ((__PRECISION__) == CORDIC_PRECISION_11CYCLES) || \
                                            ((__PRECISION__) == CORDIC_PRECISION_12CYCLES) || \
                                            ((__PRECISION__) == CORDIC_PRECISION_13CYCLES) || \
                                            ((__PRECISION__) == CORDIC_PRECISION_14CYCLES) || \
                                            ((__PRECISION__) == CORDIC_PRECISION_15CYCLES))

Verify the CORDIC precision.

Parameters:
__PRECISION__CORDIC Precision in Cycles Number.
Return values:
SET(__PRECISION__ is a valid value) or RESET (__PRECISION__ is invalid)

Definition at line 446 of file stm32h7xx_hal_cordic.h.

Referenced by HAL_CORDIC_Configure().

#define IS_CORDIC_SCALE (   __SCALE__)
Value:
(((__SCALE__) == CORDIC_SCALE_0)  || \
                                    ((__SCALE__) == CORDIC_SCALE_1)  || \
                                    ((__SCALE__) == CORDIC_SCALE_2)  || \
                                    ((__SCALE__) == CORDIC_SCALE_3)  || \
                                    ((__SCALE__) == CORDIC_SCALE_4)  || \
                                    ((__SCALE__) == CORDIC_SCALE_5)  || \
                                    ((__SCALE__) == CORDIC_SCALE_6)  || \
                                    ((__SCALE__) == CORDIC_SCALE_7))

Verify the CORDIC scaling factor.

Parameters:
__SCALE__Number of cycles for calculation, 1 cycle corresponding to 4 algorithm iterations.
Return values:
SET(__SCALE__ is a valid value) or RESET (__SCALE__ is invalid)

Definition at line 467 of file stm32h7xx_hal_cordic.h.

Referenced by HAL_CORDIC_Configure().