stm32h7xx_hal_fmac.h File Reference

Header for stm32h7xx_hal_fmac.c module. More...

#include "stm32h7xx_hal_def.h"

Go to the source code of this file.

Data Structures
struct	__FMAC_HandleTypeDef
	FMAC Handle Structure definition. More...
struct	FMAC_FilterConfigTypeDef
	FMAC Filter Configuration Structure definition. More...
Defines
#define	HAL_FMAC_ERROR_NONE   0x00000000U
#define	HAL_FMAC_ERROR_SAT   0x00000001U
#define	HAL_FMAC_ERROR_UNFL   0x00000002U
#define	HAL_FMAC_ERROR_OVFL   0x00000004U
#define	HAL_FMAC_ERROR_DMA   0x00000008U
#define	HAL_FMAC_ERROR_RESET   0x00000010U
#define	HAL_FMAC_ERROR_PARAM   0x00000020U
#define	HAL_FMAC_ERROR_INVALID_CALLBACK   0x00000040U
#define	HAL_FMAC_ERROR_TIMEOUT   0x00000080U
#define	FMAC_FUNC_LOAD_X1   (FMAC_PARAM_FUNC_0)
#define	FMAC_FUNC_LOAD_X2   (FMAC_PARAM_FUNC_1)
#define	FMAC_FUNC_LOAD_Y   (FMAC_PARAM_FUNC_1 | FMAC_PARAM_FUNC_0)
#define	FMAC_FUNC_CONVO_FIR   (FMAC_PARAM_FUNC_3)
#define	FMAC_FUNC_IIR_DIRECT_FORM_1   (FMAC_PARAM_FUNC_3 | FMAC_PARAM_FUNC_0)
#define	FMAC_THRESHOLD_1   0x00000000U
#define	FMAC_THRESHOLD_2   0x01000000U
#define	FMAC_THRESHOLD_4   0x02000000U
#define	FMAC_THRESHOLD_8   0x03000000U
#define	FMAC_THRESHOLD_NO_VALUE   0xFFFFFFFFU
#define	FMAC_BUFFER_ACCESS_NONE   0x00U
#define	FMAC_BUFFER_ACCESS_DMA   0x01U
#define	FMAC_BUFFER_ACCESS_POLLING   0x02U
#define	FMAC_BUFFER_ACCESS_IT   0x03U
#define	FMAC_CLIP_DISABLED   0x00000000U
#define	FMAC_CLIP_ENABLED   FMAC_CR_CLIPEN
#define	FMAC_FLAG_YEMPTY   FMAC_SR_YEMPTY
#define	FMAC_FLAG_X1FULL   FMAC_SR_X1FULL
#define	FMAC_FLAG_OVFL   FMAC_SR_OVFL
#define	FMAC_FLAG_UNFL   FMAC_SR_UNFL
#define	FMAC_FLAG_SAT   FMAC_SR_SAT
#define	FMAC_IT_RIEN   FMAC_CR_RIEN
#define	FMAC_IT_WIEN   FMAC_CR_WIEN
#define	FMAC_IT_OVFLIEN   FMAC_CR_OVFLIEN
#define	FMAC_IT_UNFLIEN   FMAC_CR_UNFLIEN
#define	FMAC_IT_SATIEN   FMAC_CR_SATIEN
#define	__HAL_FMAC_RESET_HANDLE_STATE(__HANDLE__)
	Reset FMAC handle state.
#define	__HAL_FMAC_ENABLE_IT(__HANDLE__, __INTERRUPT__)   (((__HANDLE__)->Instance->CR) |= (__INTERRUPT__))
	Enable the specified FMAC interrupt.
#define	__HAL_FMAC_DISABLE_IT(__HANDLE__, __INTERRUPT__)   (((__HANDLE__)->Instance->CR) &= ~(__INTERRUPT__))
	Disable the FMAC interrupt.
#define	__HAL_FMAC_GET_IT(__HANDLE__, __INTERRUPT__)   (((__HANDLE__)->Instance->SR) &= ~(__INTERRUPT__))
	Check whether the specified FMAC interrupt occurred or not.
#define	__HAL_FMAC_CLEAR_IT(__HANDLE__, __INTERRUPT__)   /* Dummy macro */
	Clear specified FMAC interrupt status.
#define	__HAL_FMAC_GET_FLAG(__HANDLE__, __FLAG__)   ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
	Check whether the specified FMAC status flag is set or not.
#define	__HAL_FMAC_CLEAR_FLAG(__HANDLE__, __FLAG__)   /* Dummy macro */
	Clear specified FMAC status flag.
#define	__HAL_FMAC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)   (((__HANDLE__)->Instance->CR) & (__INTERRUPT__))
	Check whether the specified FMAC interrupt is enabled or not.
#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.
Typedefs
typedef struct __FMAC_HandleTypeDef	FMAC_HandleTypeDef
	FMAC Handle Structure definition.
typedef void(*	pFMAC_CallbackTypeDef )(FMAC_HandleTypeDef *hfmac)
	HAL FMAC Callback pointer definition.
Enumerations
enum	HAL_FMAC_StateTypeDef {   HAL_FMAC_STATE_RESET = 0x00U, HAL_FMAC_STATE_READY = 0x20U, HAL_FMAC_STATE_BUSY = 0x24U, HAL_FMAC_STATE_BUSY_RD = 0x25U,   HAL_FMAC_STATE_BUSY_WR = 0x26U, HAL_FMAC_STATE_TIMEOUT = 0xA0U, HAL_FMAC_STATE_ERROR = 0xE0U }
	FMAC HAL State Structure definition. More...
enum	HAL_FMAC_CallbackIDTypeDef {   HAL_FMAC_ERROR_CB_ID = 0x00U, HAL_FMAC_HALF_GET_DATA_CB_ID = 0x01U, HAL_FMAC_GET_DATA_CB_ID = 0x02U, HAL_FMAC_HALF_OUTPUT_DATA_READY_CB_ID = 0x03U,   HAL_FMAC_OUTPUT_DATA_READY_CB_ID = 0x04U, HAL_FMAC_FILTER_CONFIG_CB_ID = 0x05U, HAL_FMAC_FILTER_PRELOAD_CB_ID = 0x06U, HAL_FMAC_MSPINIT_CB_ID = 0x07U,   HAL_FMAC_MSPDEINIT_CB_ID = 0x08U }
	FMAC Callback ID enumeration definition. More...
Functions
HAL_StatusTypeDef	HAL_FMAC_Init (FMAC_HandleTypeDef *hfmac)
	Initialize the FMAC peripheral and the associated handle.
HAL_StatusTypeDef	HAL_FMAC_DeInit (FMAC_HandleTypeDef *hfmac)
	De-initialize the FMAC peripheral.
__weak void	HAL_FMAC_MspInit (FMAC_HandleTypeDef *hfmac)
	Initialize the FMAC MSP.
__weak void	HAL_FMAC_MspDeInit (FMAC_HandleTypeDef *hfmac)
	De-initialize the FMAC MSP.
HAL_StatusTypeDef	HAL_FMAC_RegisterCallback (FMAC_HandleTypeDef *hfmac, HAL_FMAC_CallbackIDTypeDef CallbackID, pFMAC_CallbackTypeDef pCallback)
	Register a User FMAC Callback.
HAL_StatusTypeDef	HAL_FMAC_UnRegisterCallback (FMAC_HandleTypeDef *hfmac, HAL_FMAC_CallbackIDTypeDef CallbackID)
	Unregister a FMAC CallBack.
HAL_StatusTypeDef	HAL_FMAC_FilterConfig (FMAC_HandleTypeDef *hfmac, FMAC_FilterConfigTypeDef *pConfig)
	Configure the FMAC filter.
HAL_StatusTypeDef	HAL_FMAC_FilterConfig_DMA (FMAC_HandleTypeDef *hfmac, FMAC_FilterConfigTypeDef *pConfig)
	Configure the FMAC filter.
HAL_StatusTypeDef	HAL_FMAC_FilterPreload (FMAC_HandleTypeDef *hfmac, int16_t *pInput, uint8_t InputSize, int16_t *pOutput, uint8_t OutputSize)
	Preload the input (FIR, IIR) and output data (IIR) of the FMAC filter.
HAL_StatusTypeDef	HAL_FMAC_FilterPreload_DMA (FMAC_HandleTypeDef *hfmac, int16_t *pInput, uint8_t InputSize, int16_t *pOutput, uint8_t OutputSize)
	Preload the input (FIR, IIR) and output data (IIR) of the FMAC filter.
HAL_StatusTypeDef	HAL_FMAC_FilterStart (FMAC_HandleTypeDef *hfmac, int16_t *pOutput, uint16_t *pOutputSize)
	Start the FMAC processing according to the existing FMAC configuration.
HAL_StatusTypeDef	HAL_FMAC_AppendFilterData (FMAC_HandleTypeDef *hfmac, int16_t *pInput, uint16_t *pInputSize)
	Provide a new input buffer that will be loaded into the FMAC input memory area.
HAL_StatusTypeDef	HAL_FMAC_ConfigFilterOutputBuffer (FMAC_HandleTypeDef *hfmac, int16_t *pOutput, uint16_t *pOutputSize)
	Provide a new output buffer to be filled with the data computed by FMAC unit.
HAL_StatusTypeDef	HAL_FMAC_PollFilterData (FMAC_HandleTypeDef *hfmac, uint32_t Timeout)
	Handle the input and/or output data in polling mode.
HAL_StatusTypeDef	HAL_FMAC_FilterStop (FMAC_HandleTypeDef *hfmac)
	Stop the FMAC processing.
__weak void	HAL_FMAC_ErrorCallback (FMAC_HandleTypeDef *hfmac)
	FMAC error callback.
__weak void	HAL_FMAC_HalfGetDataCallback (FMAC_HandleTypeDef *hfmac)
	FMAC get half data callback.
__weak void	HAL_FMAC_GetDataCallback (FMAC_HandleTypeDef *hfmac)
	FMAC get data callback.
__weak void	HAL_FMAC_HalfOutputDataReadyCallback (FMAC_HandleTypeDef *hfmac)
	FMAC half output data ready callback.
__weak void	HAL_FMAC_OutputDataReadyCallback (FMAC_HandleTypeDef *hfmac)
	FMAC output data ready callback.
__weak void	HAL_FMAC_FilterConfigCallback (FMAC_HandleTypeDef *hfmac)
	FMAC filter configuration callback.
__weak void	HAL_FMAC_FilterPreloadCallback (FMAC_HandleTypeDef *hfmac)
	FMAC filter preload callback.
void	HAL_FMAC_IRQHandler (FMAC_HandleTypeDef *hfmac)
	Handle FMAC interrupt request.
HAL_FMAC_StateTypeDef	HAL_FMAC_GetState (FMAC_HandleTypeDef *hfmac)
	Return the FMAC state.
uint32_t	HAL_FMAC_GetError (FMAC_HandleTypeDef *hfmac)
	Return the FMAC peripheral error.

---

Detailed Description

Header for stm32h7xx_hal_fmac.c module.

Author:

MCD Application Team

Attention:

Copyright (c) 2017 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.

Definition in file stm32h7xx_hal_fmac.h.