STM32H735xx HAL User Manual
Defines
FMAC Private Macros
FMAC

Defines

#define FMAC_GET_X1_SIZE(__HANDLE__)   ((((__HANDLE__)->Instance->X1BUFCFG) & (FMAC_X1BUFCFG_X1_BUF_SIZE)) >> (FMAC_X1BUFCFG_X1_BUF_SIZE_Pos))
 Get the X1 memory area size.
#define FMAC_GET_X1_FULL_WM(__HANDLE__)   (((__HANDLE__)->Instance->X1BUFCFG) & (FMAC_X1BUFCFG_FULL_WM))
 Get the X1 watermark.
#define FMAC_GET_X2_SIZE(__HANDLE__)   ((((__HANDLE__)->Instance->X2BUFCFG) & (FMAC_X2BUFCFG_X2_BUF_SIZE)) >> (FMAC_X2BUFCFG_X2_BUF_SIZE_Pos))
 Get the X2 memory area size.
#define FMAC_GET_Y_SIZE(__HANDLE__)   ((((__HANDLE__)->Instance->YBUFCFG) & (FMAC_YBUFCFG_Y_BUF_SIZE)) >> (FMAC_YBUFCFG_Y_BUF_SIZE_Pos))
 Get the Y memory area size.
#define FMAC_GET_Y_EMPTY_WM(__HANDLE__)   (((__HANDLE__)->Instance->YBUFCFG) & (FMAC_YBUFCFG_EMPTY_WM))
 Get the Y watermark.
#define FMAC_GET_START_BIT(__HANDLE__)   ((((__HANDLE__)->Instance->PARAM) & (FMAC_PARAM_START)) >> (FMAC_PARAM_START_Pos))
 Get the start bit state.
#define FMAC_GET_THRESHOLD_FROM_WM(__WM__)
 Get the threshold matching the watermark.
#define IS_FMAC_FUNCTION(__FUNCTION__)
 Verify the FMAC function.
#define IS_FMAC_LOAD_FUNCTION(__FUNCTION__)
 Verify the FMAC load function used for input data, output data or coefficients.
#define IS_FMAC_N_LOAD_FUNCTION(__FUNCTION__)
 Verify the FMAC load function used with N values as input or output data.
#define IS_FMAC_N_M_LOAD_FUNCTION(__FUNCTION__)   ((__FUNCTION__) == FMAC_FUNC_LOAD_X2)
 Verify the FMAC load function used with N + M values as coefficients.
#define IS_FMAC_FILTER_FUNCTION(__FUNCTION__)
 Verify the FMAC filter function.
#define IS_FMAC_THRESHOLD(__THRESHOLD__)
 Verify the FMAC threshold.
#define IS_FMAC_PARAM_P(__FUNCTION__, __P__)
 Verify the FMAC filter parameter P.
#define IS_FMAC_PARAM_Q(__FUNCTION__, __Q__)
 Verify the FMAC filter parameter Q.
#define IS_FMAC_PARAM_R(__FUNCTION__, __R__)
 Verify the FMAC filter parameter R.
#define IS_FMAC_BUFFER_ACCESS(__BUFFER_ACCESS__)
 Verify the FMAC buffer access.
#define IS_FMAC_CLIP_STATE(__CLIP_STATE__)
 Verify the FMAC clip feature.
#define IS_FMAC_THRESHOLD_APPLICABLE(__SIZE__, __WM__, __ACCESS__)
 Check whether the threshold is applicable.

Define Documentation

#define FMAC_GET_START_BIT (   __HANDLE__)    ((((__HANDLE__)->Instance->PARAM) & (FMAC_PARAM_START)) >> (FMAC_PARAM_START_Pos))

Get the start bit state.

Parameters:
__HANDLE__FMAC handle.
Return values:
START

Definition at line 306 of file stm32h7xx_hal_fmac.c.

Referenced by FMAC_FilterConfig(), FMAC_FilterPreload(), HAL_FMAC_AppendFilterData(), HAL_FMAC_ConfigFilterOutputBuffer(), HAL_FMAC_FilterStart(), and HAL_FMAC_PollFilterData().

#define FMAC_GET_THRESHOLD_FROM_WM (   __WM__)
Value:
(((__WM__) == FMAC_THRESHOLD_1)? 1U: \
                                            ((__WM__) == FMAC_THRESHOLD_2)? 2U: \
                                            ((__WM__) == FMAC_THRESHOLD_4)? 4U:8U)

Get the threshold matching the watermark.

Parameters:
__WM__Watermark value.
Return values:
THRESHOLD

Definition at line 314 of file stm32h7xx_hal_fmac.c.

Referenced by FMAC_ReadDataIncrementPtr(), and FMAC_WriteDataIncrementPtr().

#define FMAC_GET_X1_FULL_WM (   __HANDLE__)    (((__HANDLE__)->Instance->X1BUFCFG) & (FMAC_X1BUFCFG_FULL_WM))

Get the X1 watermark.

Parameters:
__HANDLE__FMAC handle.
Return values:
FULL_WM

Definition at line 274 of file stm32h7xx_hal_fmac.c.

Referenced by FMAC_WriteDataIncrementPtr().

#define FMAC_GET_X1_SIZE (   __HANDLE__)    ((((__HANDLE__)->Instance->X1BUFCFG) & (FMAC_X1BUFCFG_X1_BUF_SIZE)) >> (FMAC_X1BUFCFG_X1_BUF_SIZE_Pos))

Get the X1 memory area size.

Parameters:
__HANDLE__FMAC handle.
Return values:
X1_BUF_SIZE

Definition at line 266 of file stm32h7xx_hal_fmac.c.

Referenced by FMAC_FilterConfig(), FMAC_FilterPreload(), and HAL_FMAC_IRQHandler().

#define FMAC_GET_X2_SIZE (   __HANDLE__)    ((((__HANDLE__)->Instance->X2BUFCFG) & (FMAC_X2BUFCFG_X2_BUF_SIZE)) >> (FMAC_X2BUFCFG_X2_BUF_SIZE_Pos))

Get the X2 memory area size.

Parameters:
__HANDLE__FMAC handle.
Return values:
X2_BUF_SIZE

Definition at line 282 of file stm32h7xx_hal_fmac.c.

Referenced by FMAC_FilterConfig().

#define FMAC_GET_Y_EMPTY_WM (   __HANDLE__)    (((__HANDLE__)->Instance->YBUFCFG) & (FMAC_YBUFCFG_EMPTY_WM))

Get the Y watermark.

Parameters:
__HANDLE__FMAC handle.
Return values:
EMPTY_WM

Definition at line 298 of file stm32h7xx_hal_fmac.c.

Referenced by FMAC_ReadDataIncrementPtr().

#define FMAC_GET_Y_SIZE (   __HANDLE__)    ((((__HANDLE__)->Instance->YBUFCFG) & (FMAC_YBUFCFG_Y_BUF_SIZE)) >> (FMAC_YBUFCFG_Y_BUF_SIZE_Pos))

Get the Y memory area size.

Parameters:
__HANDLE__FMAC handle.
Return values:
Y_BUF_SIZE

Definition at line 290 of file stm32h7xx_hal_fmac.c.

Referenced by FMAC_FilterConfig(), FMAC_FilterPreload(), and HAL_FMAC_IRQHandler().

#define IS_FMAC_BUFFER_ACCESS (   __BUFFER_ACCESS__)
Value:
(((__BUFFER_ACCESS__) == FMAC_BUFFER_ACCESS_NONE)    || \
                                                  ((__BUFFER_ACCESS__) == FMAC_BUFFER_ACCESS_DMA)     || \
                                                  ((__BUFFER_ACCESS__) == FMAC_BUFFER_ACCESS_POLLING) || \
                                                  ((__BUFFER_ACCESS__) == FMAC_BUFFER_ACCESS_IT))

Verify the FMAC buffer access.

Parameters:
__BUFFER_ACCESS__Type of access.
Return values:
SET(__BUFFER_ACCESS__ is a valid value) or RESET (__BUFFER_ACCESS__ is invalid)

Definition at line 563 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_FilterConfig().

#define IS_FMAC_CLIP_STATE (   __CLIP_STATE__)
Value:
(((__CLIP_STATE__) == FMAC_CLIP_DISABLED)                  || \
                                            ((__CLIP_STATE__) == FMAC_CLIP_ENABLED))

Verify the FMAC clip feature.

Parameters:
__CLIP_STATE__Clip state.
Return values:
SET(__CLIP_STATE__ is a valid value) or RESET (__CLIP_STATE__ is invalid)

Definition at line 573 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_FilterConfig().

#define IS_FMAC_FILTER_FUNCTION (   __FUNCTION__)
Value:
(((__FUNCTION__) == FMAC_FUNC_CONVO_FIR)                || \
                                               ((__FUNCTION__) == FMAC_FUNC_IIR_DIRECT_FORM_1))

Verify the FMAC filter function.

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

Definition at line 512 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_FilterConfig().

#define IS_FMAC_FUNCTION (   __FUNCTION__)
Value:
(((__FUNCTION__) == FMAC_FUNC_LOAD_X1)                         || \
                                        ((__FUNCTION__) == FMAC_FUNC_LOAD_X2)                         || \
                                        ((__FUNCTION__) == FMAC_FUNC_LOAD_Y)                          || \
                                        ((__FUNCTION__) == FMAC_FUNC_CONVO_FIR)                       || \
                                        ((__FUNCTION__) == FMAC_FUNC_IIR_DIRECT_FORM_1))

Verify the FMAC function.

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

Definition at line 477 of file stm32h7xx_hal_fmac.h.

#define IS_FMAC_LOAD_FUNCTION (   __FUNCTION__)
Value:
(((__FUNCTION__) == FMAC_FUNC_LOAD_X1)                    || \
                                             ((__FUNCTION__) == FMAC_FUNC_LOAD_X2)                    || \
                                             ((__FUNCTION__) == FMAC_FUNC_LOAD_Y))

Verify the FMAC load function used for input data, output data or coefficients.

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

Definition at line 488 of file stm32h7xx_hal_fmac.h.

#define IS_FMAC_N_LOAD_FUNCTION (   __FUNCTION__)
Value:
(((__FUNCTION__) == FMAC_FUNC_LOAD_X1)                  || \
                                               ((__FUNCTION__) == FMAC_FUNC_LOAD_Y))

Verify the FMAC load function used with N values as input or output data.

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

Definition at line 497 of file stm32h7xx_hal_fmac.h.

#define IS_FMAC_N_M_LOAD_FUNCTION (   __FUNCTION__)    ((__FUNCTION__) == FMAC_FUNC_LOAD_X2)

Verify the FMAC load function used with N + M values as coefficients.

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

Definition at line 505 of file stm32h7xx_hal_fmac.h.

#define IS_FMAC_PARAM_P (   __FUNCTION__,
  __P__ 
)
Value:
( (((__FUNCTION__) == FMAC_FUNC_CONVO_FIR)               && \
                                                (((__P__) >= 2U) && ((__P__) <= 127U)))               || \
                                               (((__FUNCTION__) == FMAC_FUNC_IIR_DIRECT_FORM_1)       && \
                                                (((__P__) >= 2U) && ((__P__) <= 64U))) )

Verify the FMAC filter parameter P.

Parameters:
__P__Value of the filter parameter P.
__FUNCTION__ID of the filter function.
Return values:
SET(__P__ is a valid value) or RESET (__P__ is invalid)

Definition at line 533 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_FilterConfig().

#define IS_FMAC_PARAM_Q (   __FUNCTION__,
  __Q__ 
)
Value:
( ((__FUNCTION__) == FMAC_FUNC_CONVO_FIR)                || \
                                               (((__FUNCTION__) == FMAC_FUNC_IIR_DIRECT_FORM_1)       && \
                                                (((__Q__) >= 1U) && ((__Q__) <= 63U))) )

Verify the FMAC filter parameter Q.

Parameters:
__Q__Value of the filter parameter Q.
__FUNCTION__ID of the filter function.
Return values:
SET(__Q__ is a valid value) or RESET (__Q__ is invalid)

Definition at line 544 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_FilterConfig().

#define IS_FMAC_PARAM_R (   __FUNCTION__,
  __R__ 
)
Value:
( (((__FUNCTION__) == FMAC_FUNC_CONVO_FIR)               || \
                                                ((__FUNCTION__) == FMAC_FUNC_IIR_DIRECT_FORM_1))      && \
                                               ((__R__) <= 7U))

Verify the FMAC filter parameter R.

Parameters:
__R__Value of the filter parameter.
__FUNCTION__ID of the filter function.
Return values:
SET(__R__ is a valid value) or RESET (__R__ is invalid)

Definition at line 554 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_FilterConfig().

#define IS_FMAC_THRESHOLD (   __THRESHOLD__)
Value:
(((__THRESHOLD__) == FMAC_THRESHOLD_1)                       || \
                                          ((__THRESHOLD__) == FMAC_THRESHOLD_2)                       || \
                                          ((__THRESHOLD__) == FMAC_THRESHOLD_4)                       || \
                                          ((__THRESHOLD__) == FMAC_THRESHOLD_NO_VALUE)                || \
                                          ((__THRESHOLD__) == FMAC_THRESHOLD_8))

Verify the FMAC threshold.

Parameters:
__THRESHOLD__Value of the threshold.
Return values:
SET(__THRESHOLD__ is a valid value) or RESET (__THRESHOLD__ is invalid)

Definition at line 521 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_FilterConfig().

#define IS_FMAC_THRESHOLD_APPLICABLE (   __SIZE__,
  __WM__,
  __ACCESS__ 
)
Value:
(( (__SIZE__) >= (((__WM__) == FMAC_THRESHOLD_1)? 1U: \
                    ((__WM__) == FMAC_THRESHOLD_2)? 2U: \
                    ((__WM__) == FMAC_THRESHOLD_4)? 4U:8U))&& \
   ((((__ACCESS__) == FMAC_BUFFER_ACCESS_DMA)&& \
     ((__WM__) == FMAC_THRESHOLD_1))|| \
    ((__ACCESS__ )!= FMAC_BUFFER_ACCESS_DMA)))

Check whether the threshold is applicable.

Parameters:
__SIZE__Size of the matching buffer.
__WM__Watermark value.
__ACCESS__Access to the buffer (polling, it, dma, none).
Return values:
THRESHOLD

Definition at line 583 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_FilterConfig().