STM32H735xx HAL User Manual: __FMAC_HandleTypeDef Struct Reference

STM32H735xx HAL User Manual

FMAC Handle Structure definition. More...

#include <stm32h7xx_hal_fmac.h>

Data Fields
FMAC_TypeDef *	Instance
uint32_t	FilterParam
uint8_t	InputAccess
uint8_t	OutputAccess
int16_t *	pInput
uint16_t	InputCurrentSize
uint16_t *	pInputSize
int16_t *	pOutput
uint16_t	OutputCurrentSize
uint16_t *	pOutputSize
DMA_HandleTypeDef *	hdmaIn
DMA_HandleTypeDef *	hdmaOut
DMA_HandleTypeDef *	hdmaPreload
void(*	ErrorCallback )(struct __FMAC_HandleTypeDef *hfmac)
void(*	HalfGetDataCallback )(struct __FMAC_HandleTypeDef *hfmac)
void(*	GetDataCallback )(struct __FMAC_HandleTypeDef *hfmac)
void(*	HalfOutputDataReadyCallback )(struct __FMAC_HandleTypeDef *hfmac)
void(*	OutputDataReadyCallback )(struct __FMAC_HandleTypeDef *hfmac)
void(*	FilterConfigCallback )(struct __FMAC_HandleTypeDef *hfmac)
void(*	FilterPreloadCallback )(struct __FMAC_HandleTypeDef *hfmac)
void(*	MspInitCallback )(struct __FMAC_HandleTypeDef *hfmac)
void(*	MspDeInitCallback )(struct __FMAC_HandleTypeDef *hfmac)
HAL_LockTypeDef	Lock
__IO HAL_FMAC_StateTypeDef	State
__IO HAL_FMAC_StateTypeDef	RdState
__IO HAL_FMAC_StateTypeDef	WrState
__IO uint32_t	ErrorCode

Detailed Description

FMAC Handle Structure definition.

Definition at line 62 of file stm32h7xx_hal_fmac.h.

Field Documentation

void(* __FMAC_HandleTypeDef::ErrorCallback)(struct __FMAC_HandleTypeDef *hfmac)

FMAC error callback

Definition at line 101 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_DMAError(), FMAC_DMAFilterConfig(), FMAC_DMAFilterPreload(), HAL_FMAC_Init(), HAL_FMAC_IRQHandler(), HAL_FMAC_RegisterCallback(), and HAL_FMAC_UnRegisterCallback().

__IO uint32_t __FMAC_HandleTypeDef::ErrorCode

FMAC peripheral error code This parameter can be a value of FMAC Error code

Definition at line 132 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_DMAError(), FMAC_DMAFilterConfig(), FMAC_DMAFilterPreload(), FMAC_FilterConfig(), FMAC_FilterPreload(), FMAC_Reset(), FMAC_WaitOnStartUntilTimeout(), HAL_FMAC_DeInit(), HAL_FMAC_FilterStop(), HAL_FMAC_GetError(), HAL_FMAC_Init(), HAL_FMAC_IRQHandler(), HAL_FMAC_PollFilterData(), HAL_FMAC_RegisterCallback(), and HAL_FMAC_UnRegisterCallback().

void(* __FMAC_HandleTypeDef::FilterConfigCallback)(struct __FMAC_HandleTypeDef *hfmac)

FMAC filter configuration callback

Definition at line 111 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_DMAFilterConfig(), HAL_FMAC_Init(), HAL_FMAC_RegisterCallback(), and HAL_FMAC_UnRegisterCallback().

uint32_t __FMAC_HandleTypeDef::FilterParam

Filter configuration (operation and parameters). Set to 0 if no valid configuration was applied.

Definition at line 69 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_FilterConfig(), FMAC_FilterPreload(), HAL_FMAC_DeInit(), HAL_FMAC_FilterStart(), and HAL_FMAC_Init().

void(* __FMAC_HandleTypeDef::FilterPreloadCallback)(struct __FMAC_HandleTypeDef *hfmac)

FMAC filter preload callback

Definition at line 113 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_DMAFilterPreload(), HAL_FMAC_Init(), HAL_FMAC_RegisterCallback(), and HAL_FMAC_UnRegisterCallback().

void(* __FMAC_HandleTypeDef::GetDataCallback)(struct __FMAC_HandleTypeDef *hfmac)

FMAC get data callback

Definition at line 105 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_DMAGetData(), HAL_FMAC_Init(), HAL_FMAC_IRQHandler(), HAL_FMAC_RegisterCallback(), and HAL_FMAC_UnRegisterCallback().

void(* __FMAC_HandleTypeDef::HalfGetDataCallback)(struct __FMAC_HandleTypeDef *hfmac)

FMAC get half data callback

Definition at line 103 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_DMAHalfGetData(), HAL_FMAC_Init(), HAL_FMAC_RegisterCallback(), and HAL_FMAC_UnRegisterCallback().

void(* __FMAC_HandleTypeDef::HalfOutputDataReadyCallback)(struct __FMAC_HandleTypeDef *hfmac)

FMAC half output data ready callback

Definition at line 107 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_DMAHalfOutputDataReady(), HAL_FMAC_Init(), HAL_FMAC_RegisterCallback(), and HAL_FMAC_UnRegisterCallback().

DMA_HandleTypeDef* __FMAC_HandleTypeDef::hdmaIn

FMAC peripheral input data DMA handle parameters

Definition at line 94 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_AppendFilterDataUpdateState().

DMA_HandleTypeDef* __FMAC_HandleTypeDef::hdmaOut

FMAC peripheral output data DMA handle parameters

Definition at line 96 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_ConfigFilterOutputBufferUpdateState().

DMA_HandleTypeDef* __FMAC_HandleTypeDef::hdmaPreload

FMAC peripheral preloaded data (X1, X2 and Y) DMA handle parameters

Definition at line 98 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_DMAFilterConfig(), FMAC_DMAFilterPreload(), FMAC_FilterConfig(), and FMAC_FilterPreload().

uint8_t __FMAC_HandleTypeDef::InputAccess

Access to the input buffer (internal memory area): DMA, IT, Polling, None. This parameter can be a value of FMAC Buffer Access.

Definition at line 72 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_AppendFilterDataUpdateState(), FMAC_FilterConfig(), HAL_FMAC_AppendFilterData(), HAL_FMAC_FilterStart(), HAL_FMAC_FilterStop(), and HAL_FMAC_PollFilterData().

uint16_t __FMAC_HandleTypeDef::InputCurrentSize

Number of the input elements already written into FMAC

Definition at line 80 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_AppendFilterDataUpdateState(), FMAC_DMAFilterConfig(), FMAC_DMAFilterPreload(), FMAC_FilterConfig(), FMAC_FilterPreload(), FMAC_ResetInputStateAndDataPointers(), FMAC_WriteDataIncrementPtr(), HAL_FMAC_AppendFilterData(), HAL_FMAC_FilterStop(), HAL_FMAC_IRQHandler(), and HAL_FMAC_PollFilterData().

FMAC_TypeDef* __FMAC_HandleTypeDef::Instance

Register base address

Definition at line 67 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_AppendFilterDataUpdateState(), FMAC_ConfigFilterOutputBufferUpdateState(), FMAC_DMAFilterConfig(), FMAC_DMAFilterPreload(), FMAC_FilterConfig(), FMAC_FilterPreload(), FMAC_ReadDataIncrementPtr(), FMAC_Reset(), FMAC_WaitOnStartUntilTimeout(), FMAC_WriteDataIncrementPtr(), FMAC_WritePreloadDataIncrementPtr(), HAL_FMAC_DeInit(), HAL_FMAC_FilterStart(), HAL_FMAC_FilterStop(), and HAL_FMAC_Init().

HAL_LockTypeDef __FMAC_HandleTypeDef::Lock

FMAC locking object

Definition at line 121 of file stm32h7xx_hal_fmac.h.

Referenced by HAL_FMAC_Init().

void(* __FMAC_HandleTypeDef::MspDeInitCallback)(struct __FMAC_HandleTypeDef *hfmac)

FMAC Msp DeInit callback

Definition at line 117 of file stm32h7xx_hal_fmac.h.

Referenced by HAL_FMAC_DeInit(), HAL_FMAC_RegisterCallback(), and HAL_FMAC_UnRegisterCallback().

void(* __FMAC_HandleTypeDef::MspInitCallback)(struct __FMAC_HandleTypeDef *hfmac)

FMAC Msp Init callback

Definition at line 115 of file stm32h7xx_hal_fmac.h.

Referenced by HAL_FMAC_Init(), HAL_FMAC_RegisterCallback(), and HAL_FMAC_UnRegisterCallback().

uint8_t __FMAC_HandleTypeDef::OutputAccess

Access to the output buffer (internal memory area): DMA, IT, Polling, None. This parameter can be a value of FMAC Buffer Access.

Definition at line 75 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_ConfigFilterOutputBufferUpdateState(), FMAC_FilterConfig(), HAL_FMAC_ConfigFilterOutputBuffer(), HAL_FMAC_FilterStart(), HAL_FMAC_FilterStop(), and HAL_FMAC_PollFilterData().

uint16_t __FMAC_HandleTypeDef::OutputCurrentSize

Number of the output elements already read from FMAC

Definition at line 88 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_ConfigFilterOutputBufferUpdateState(), FMAC_ReadDataIncrementPtr(), FMAC_ResetOutputStateAndDataPointers(), HAL_FMAC_ConfigFilterOutputBuffer(), HAL_FMAC_FilterStop(), HAL_FMAC_IRQHandler(), and HAL_FMAC_PollFilterData().

void(* __FMAC_HandleTypeDef::OutputDataReadyCallback)(struct __FMAC_HandleTypeDef *hfmac)

FMAC output data ready callback

Definition at line 109 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_DMAOutputDataReady(), HAL_FMAC_Init(), HAL_FMAC_IRQHandler(), HAL_FMAC_RegisterCallback(), and HAL_FMAC_UnRegisterCallback().

int16_t* __FMAC_HandleTypeDef::pInput

Pointer to FMAC input data buffer

Definition at line 78 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_AppendFilterDataUpdateState(), FMAC_DMAFilterConfig(), FMAC_DMAFilterPreload(), FMAC_FilterConfig(), FMAC_FilterPreload(), FMAC_ResetInputStateAndDataPointers(), FMAC_WriteDataIncrementPtr(), HAL_FMAC_FilterStop(), HAL_FMAC_IRQHandler(), and HAL_FMAC_PollFilterData().

uint16_t* __FMAC_HandleTypeDef::pInputSize

Number of input elements to write (memory allocated to pInput). In case of early interruption of the filter operation, its value will be updated.

Definition at line 82 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_AppendFilterDataUpdateState(), FMAC_ResetInputStateAndDataPointers(), FMAC_WriteDataIncrementPtr(), HAL_FMAC_AppendFilterData(), HAL_FMAC_FilterStop(), HAL_FMAC_IRQHandler(), and HAL_FMAC_PollFilterData().

int16_t* __FMAC_HandleTypeDef::pOutput

Pointer to FMAC output data buffer

Definition at line 86 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_ConfigFilterOutputBufferUpdateState(), FMAC_ReadDataIncrementPtr(), FMAC_ResetOutputStateAndDataPointers(), HAL_FMAC_FilterStop(), HAL_FMAC_IRQHandler(), and HAL_FMAC_PollFilterData().

uint16_t* __FMAC_HandleTypeDef::pOutputSize

Number of output elements to read (memory allocated to pOutput). In case of early interruption of the filter operation, its value will be updated.

Definition at line 90 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_ConfigFilterOutputBufferUpdateState(), FMAC_ReadDataIncrementPtr(), FMAC_ResetOutputStateAndDataPointers(), HAL_FMAC_ConfigFilterOutputBuffer(), HAL_FMAC_FilterStop(), HAL_FMAC_IRQHandler(), and HAL_FMAC_PollFilterData().

__IO HAL_FMAC_StateTypeDef __FMAC_HandleTypeDef::RdState

FMAC state related to read operations (access to Y buffer) This parameter can be a value of HAL_FMAC_StateTypeDef

Definition at line 126 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_ConfigFilterOutputBufferUpdateState(), FMAC_ResetOutputStateAndDataPointers(), and HAL_FMAC_ConfigFilterOutputBuffer().

__IO HAL_FMAC_StateTypeDef __FMAC_HandleTypeDef::State

FMAC state related to global handle management This parameter can be a value of HAL_FMAC_StateTypeDef

Definition at line 123 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_DMAError(), FMAC_DMAFilterConfig(), FMAC_DMAFilterPreload(), FMAC_FilterConfig(), FMAC_FilterPreload(), HAL_FMAC_DeInit(), HAL_FMAC_FilterStart(), HAL_FMAC_FilterStop(), HAL_FMAC_GetState(), HAL_FMAC_Init(), HAL_FMAC_PollFilterData(), HAL_FMAC_RegisterCallback(), and HAL_FMAC_UnRegisterCallback().

__IO HAL_FMAC_StateTypeDef __FMAC_HandleTypeDef::WrState

FMAC state related to write operations (access to X1 buffer) This parameter can be a value of HAL_FMAC_StateTypeDef

Definition at line 129 of file stm32h7xx_hal_fmac.h.

Referenced by FMAC_AppendFilterDataUpdateState(), FMAC_ResetInputStateAndDataPointers(), and HAL_FMAC_AppendFilterData().

The documentation for this struct was generated from the following file:

stm32h7xx_hal_fmac.h