stm32h7xx_hal_mdios.h File Reference

Header file of MDIOS HAL module. More...

#include "stm32h7xx_hal_def.h"

Go to the source code of this file.

Data Structures
struct	MDIOS_InitTypeDef
struct	__MDIOS_HandleTypeDef
Defines
#define	MDIOS_PREAMBLE_CHECK_ENABLE   ((uint32_t)0x00000000U)
#define	MDIOS_PREAMBLE_CHECK_DISABLE   MDIOS_CR_DPC
#define	MDIOS_REG0   ((uint32_t)0x00000000U)
#define	MDIOS_REG1   ((uint32_t)0x00000001U)
#define	MDIOS_REG2   ((uint32_t)0x00000002U)
#define	MDIOS_REG3   ((uint32_t)0x00000003U)
#define	MDIOS_REG4   ((uint32_t)0x00000004U)
#define	MDIOS_REG5   ((uint32_t)0x00000005U)
#define	MDIOS_REG6   ((uint32_t)0x00000006U)
#define	MDIOS_REG7   ((uint32_t)0x00000007U)
#define	MDIOS_REG8   ((uint32_t)0x00000008U)
#define	MDIOS_REG9   ((uint32_t)0x00000009U)
#define	MDIOS_REG10   ((uint32_t)0x0000000AU)
#define	MDIOS_REG11   ((uint32_t)0x0000000BU)
#define	MDIOS_REG12   ((uint32_t)0x0000000CU)
#define	MDIOS_REG13   ((uint32_t)0x0000000DU)
#define	MDIOS_REG14   ((uint32_t)0x0000000EU)
#define	MDIOS_REG15   ((uint32_t)0x0000000FU)
#define	MDIOS_REG16   ((uint32_t)0x00000010U)
#define	MDIOS_REG17   ((uint32_t)0x00000011U)
#define	MDIOS_REG18   ((uint32_t)0x00000012U)
#define	MDIOS_REG19   ((uint32_t)0x00000013U)
#define	MDIOS_REG20   ((uint32_t)0x00000014U)
#define	MDIOS_REG21   ((uint32_t)0x00000015U)
#define	MDIOS_REG22   ((uint32_t)0x00000016U)
#define	MDIOS_REG23   ((uint32_t)0x00000017U)
#define	MDIOS_REG24   ((uint32_t)0x00000018U)
#define	MDIOS_REG25   ((uint32_t)0x00000019U)
#define	MDIOS_REG26   ((uint32_t)0x0000001AU)
#define	MDIOS_REG27   ((uint32_t)0x0000001BU)
#define	MDIOS_REG28   ((uint32_t)0x0000001CU)
#define	MDIOS_REG29   ((uint32_t)0x0000001DU)
#define	MDIOS_REG30   ((uint32_t)0x0000001EU)
#define	MDIOS_REG31   ((uint32_t)0x0000001FU)
#define	MDIOS_REG0_FLAG   ((uint32_t)0x00000001U)
#define	MDIOS_REG1_FLAG   ((uint32_t)0x00000002U)
#define	MDIOS_REG2_FLAG   ((uint32_t)0x00000004U)
#define	MDIOS_REG3_FLAG   ((uint32_t)0x00000008U)
#define	MDIOS_REG4_FLAG   ((uint32_t)0x00000010U)
#define	MDIOS_REG5_FLAG   ((uint32_t)0x00000020U)
#define	MDIOS_REG6_FLAG   ((uint32_t)0x00000040U)
#define	MDIOS_REG7_FLAG   ((uint32_t)0x00000080U)
#define	MDIOS_REG8_FLAG   ((uint32_t)0x00000100U)
#define	MDIOS_REG9_FLAG   ((uint32_t)0x00000200U)
#define	MDIOS_REG10_FLAG   ((uint32_t)0x00000400U)
#define	MDIOS_REG11_FLAG   ((uint32_t)0x00000800U)
#define	MDIOS_REG12_FLAG   ((uint32_t)0x00001000U)
#define	MDIOS_REG13_FLAG   ((uint32_t)0x00002000U)
#define	MDIOS_REG14_FLAG   ((uint32_t)0x00004000U)
#define	MDIOS_REG15_FLAG   ((uint32_t)0x00008000U)
#define	MDIOS_REG16_FLAG   ((uint32_t)0x00010000U)
#define	MDIOS_REG17_FLAG   ((uint32_t)0x00020000U)
#define	MDIOS_REG18_FLAG   ((uint32_t)0x00040000U)
#define	MDIOS_REG19_FLAG   ((uint32_t)0x00080000U)
#define	MDIOS_REG20_FLAG   ((uint32_t)0x00100000U)
#define	MDIOS_REG21_FLAG   ((uint32_t)0x00200000U)
#define	MDIOS_REG22_FLAG   ((uint32_t)0x00400000U)
#define	MDIOS_REG23_FLAG   ((uint32_t)0x00800000U)
#define	MDIOS_REG24_FLAG   ((uint32_t)0x01000000U)
#define	MDIOS_REG25_FLAG   ((uint32_t)0x02000000U)
#define	MDIOS_REG26_FLAG   ((uint32_t)0x04000000U)
#define	MDIOS_REG27_FLAG   ((uint32_t)0x08000000U)
#define	MDIOS_REG28_FLAG   ((uint32_t)0x10000000U)
#define	MDIOS_REG29_FLAG   ((uint32_t)0x20000000U)
#define	MDIOS_REG30_FLAG   ((uint32_t)0x40000000U)
#define	MDIOS_REG31_FLAG   ((uint32_t)0x80000000U)
#define	MDIOS_ALLREG_FLAG   ((uint32_t)0xFFFFFFFFU)
#define	MDIOS_IT_WRITE   MDIOS_CR_WRIE
#define	MDIOS_IT_READ   MDIOS_CR_RDIE
#define	MDIOS_IT_ERROR   MDIOS_CR_EIE
#define	MDIOS_TURNAROUND_ERROR_FLAG   MDIOS_SR_TERF
#define	MDIOS_START_ERROR_FLAG   MDIOS_SR_SERF
#define	MDIOS_PREAMBLE_ERROR_FLAG   MDIOS_SR_PERF
#define	HAL_MDIOS_ERROR_NONE   ((uint32_t)0x00000000U)
#define	HAL_MDIOS_ERROR_PARAM   ((uint32_t)0x00000001U)
#define	HAL_MDIOS_ERROR_BUSY   ((uint32_t)0x00000002U)
#define	HAL_MDIOS_ERROR_TIMEOUT   ((uint32_t)0x00000004U)
#define	HAL_MDIOS_ERROR_DATA   ((uint32_t)0x00000010U)
#define	HAL_MDIOS_ERROR_INVALID_CALLBACK   ((uint32_t)0x00000020U)
#define	MDIOS_WAKEUP_EXTI_LINE   ((uint32_t)0x00000400) /* !< 42 - 32 = 10 */
#define	__HAL_MDIOS_RESET_HANDLE_STATE(__HANDLE__)
	Reset MDIOS handle state.
#define	__HAL_MDIOS_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR |= MDIOS_CR_EN)
	Enable/Disable the MDIOS peripheral.
#define	__HAL_MDIOS_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR &= ~MDIOS_CR_EN)
#define	__HAL_MDIOS_ENABLE_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->CR |= (__INTERRUPT__))
	Enable the MDIOS device interrupt.
#define	__HAL_MDIOS_DISABLE_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->CR &= ~(__INTERRUPT__))
	Disable the MDIOS device interrupt.
#define	__HAL_MDIOS_GET_WRITE_FLAG(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->WRFR & (__FLAG__))
	Set MDIOS slave get write register flag.
#define	__HAL_MDIOS_GET_READ_FLAG(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->RDFR & (__FLAG__))
	MDIOS slave get read register flag.
#define	__HAL_MDIOS_GET_ERROR_FLAG(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->SR & (__FLAG__))
	MDIOS slave get interrupt.
#define	__HAL_MDIOS_CLEAR_ERROR_FLAG(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->CLRFR) |= (__FLAG__)
	MDIOS slave clear interrupt.
#define	__HAL_MDIOS_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->CR & (__INTERRUPT__))
	Checks whether the specified MDIOS interrupt is set or not.
#define	__HAL_MDIOS_WAKEUP_EXTI_ENABLE_IT(__EXTI_LINE__)   (EXTI->IMR2 |= (__EXTI_LINE__))
	Enable the MDIOS WAKEUP Exti Line.
#define	__HAL_MDIOS_WAKEUP_EXTI_GET_FLAG(__EXTI_LINE__)   (EXTI->PR2 & (__EXTI_LINE__))
	checks whether the specified MDIOS WAKEUP Exti interrupt flag is set or not.
#define	__HAL_MDIOS_WAKEUP_EXTI_CLEAR_FLAG(__EXTI_LINE__)   (EXTI->PR2 = (__EXTI_LINE__))
	Clear the MDIOS WAKEUP Exti flag.
#define	__HAL_MDIOS_WAKEUP_EXTI_ENABLE_RISING_EDGE(__EXTI_LINE__)
	enable rising edge interrupt on selected EXTI line.
#define	__HAL_MDIOS_WAKEUP_EXTI_ENABLE_FALLING_EDGE(__EXTI_LINE__)
	enable falling edge interrupt on selected EXTI line.
#define	__HAL_MDIOS_WAKEUP_EXTI_ENABLE_RISING_FALLING_EDGE(__EXTI_LINE__)
	enable falling edge interrupt on selected EXTI line.
#define	__HAL_MDIOS_WAKEUP_EXTI_GENERATE_SWIT(__EXTI_LINE__)   (EXTI->SWIER2 |= (__EXTI_LINE__))
	Generates a Software interrupt on selected EXTI line.
#define	IS_MDIOS_PORTADDRESS(__ADDR__)   ((__ADDR__) < 32U)
#define	IS_MDIOS_REGISTER(__REGISTER__)   ((__REGISTER__) < 32U)
#define	IS_MDIOS_PREAMBLECHECK(__PREAMBLECHECK__)
Typedefs
typedef struct __MDIOS_HandleTypeDef	MDIOS_HandleTypeDef
typedef void(*	pMDIOS_CallbackTypeDef )(MDIOS_HandleTypeDef *hmdios)
	HAL MDIOS Callback pointer definition.
Enumerations
enum	HAL_MDIOS_StateTypeDef { HAL_MDIOS_STATE_RESET = 0x00U, HAL_MDIOS_STATE_READY = 0x01U, HAL_MDIOS_STATE_BUSY = 0x02U, HAL_MDIOS_STATE_ERROR = 0x04U }
enum	HAL_MDIOS_CallbackIDTypeDef {   HAL_MDIOS_MSPINIT_CB_ID = 0x00U, HAL_MDIOS_MSPDEINIT_CB_ID = 0x01U, HAL_MDIOS_WRITE_COMPLETE_CB_ID = 0x02U, HAL_MDIOS_READ_COMPLETE_CB_ID = 0x03U,   HAL_MDIOS_ERROR_CB_ID = 0x04U, HAL_MDIOS_WAKEUP_CB_ID = 0x05U }
	HAL MDIOS Callback ID enumeration definition. More...
Functions
HAL_StatusTypeDef	HAL_MDIOS_Init (MDIOS_HandleTypeDef *hmdios)
	Initializes the MDIOS according to the specified parameters in the MDIOS_InitTypeDef and creates the associated handle .
HAL_StatusTypeDef	HAL_MDIOS_DeInit (MDIOS_HandleTypeDef *hmdios)
	DeInitializes the MDIOS peripheral.
__weak void	HAL_MDIOS_MspInit (MDIOS_HandleTypeDef *hmdios)
	MDIOS MSP Init.
__weak void	HAL_MDIOS_MspDeInit (MDIOS_HandleTypeDef *hmdios)
	MDIOS MSP DeInit.
HAL_StatusTypeDef	HAL_MDIOS_RegisterCallback (MDIOS_HandleTypeDef *hmdios, HAL_MDIOS_CallbackIDTypeDef CallbackID, pMDIOS_CallbackTypeDef pCallback)
	Register a User MDIOS Callback To be used instead of the weak predefined callback.
HAL_StatusTypeDef	HAL_MDIOS_UnRegisterCallback (MDIOS_HandleTypeDef *hmdios, HAL_MDIOS_CallbackIDTypeDef CallbackID)
	Unregister an MDIOS Callback MDIOS callabck is redirected to the weak predefined callback.
HAL_StatusTypeDef	HAL_MDIOS_WriteReg (MDIOS_HandleTypeDef *hmdios, uint32_t RegNum, uint16_t Data)
	Writes to an MDIOS output register.
HAL_StatusTypeDef	HAL_MDIOS_ReadReg (MDIOS_HandleTypeDef *hmdios, uint32_t RegNum, uint16_t *pData)
	Reads an MDIOS input register.
uint32_t	HAL_MDIOS_GetWrittenRegAddress (MDIOS_HandleTypeDef *hmdios)
	Gets Written registers by MDIO master.
uint32_t	HAL_MDIOS_GetReadRegAddress (MDIOS_HandleTypeDef *hmdios)
	Gets Read registers by MDIO master.
HAL_StatusTypeDef	HAL_MDIOS_ClearWriteRegAddress (MDIOS_HandleTypeDef *hmdios, uint32_t RegNum)
	Clears Write registers flag.
HAL_StatusTypeDef	HAL_MDIOS_ClearReadRegAddress (MDIOS_HandleTypeDef *hmdios, uint32_t RegNum)
	Clears Read register flag.
HAL_StatusTypeDef	HAL_MDIOS_EnableEvents (MDIOS_HandleTypeDef *hmdios)
	Enables Events for MDIOS peripheral.
void	HAL_MDIOS_IRQHandler (MDIOS_HandleTypeDef *hmdios)
	This function handles MDIOS interrupt request.
__weak void	HAL_MDIOS_WriteCpltCallback (MDIOS_HandleTypeDef *hmdios)
	Write Complete Callback.
__weak void	HAL_MDIOS_ReadCpltCallback (MDIOS_HandleTypeDef *hmdios)
	Read Complete Callback.
__weak void	HAL_MDIOS_ErrorCallback (MDIOS_HandleTypeDef *hmdios)
	Error Callback.
__weak void	HAL_MDIOS_WakeUpCallback (MDIOS_HandleTypeDef *hmdios)
	MDIOS WAKEUP interrupt callback.
uint32_t	HAL_MDIOS_GetError (MDIOS_HandleTypeDef *hmdios)
	Gets MDIOS error code.
HAL_MDIOS_StateTypeDef	HAL_MDIOS_GetState (MDIOS_HandleTypeDef *hmdios)
	Return the MDIOS HAL state.

---

Detailed Description

Header file of MDIOS HAL 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_mdios.h.