STM32H735xx HAL User Manual
Functions
IO operation functions
MDIOS Exported Functions

MDIOS Read/Write functions. More...

Functions

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.

Detailed Description

MDIOS Read/Write functions.

 ===============================================================================
                      ##### IO operation functions #####
 ===============================================================================
    This subsection provides a set of functions allowing to manage the MDIOS
    read and write operations.

    (#) APIs that allow to the MDIOS to read/write from/to the
        values of one of the DINn/DOUTn registers:
        (+) Read the value of a DINn register: HAL_MDIOS_ReadReg()
        (+) Write a value to a DOUTn register: HAL_MDIOS_WriteReg()

    (#) APIs that provide if there are some Slave registres have been
        read or written by the Master:
        (+) DOUTn registers read by Master: HAL_MDIOS_GetReadRegAddress()
        (+) DINn registers written by Master : HAL_MDIOS_GetWrittenRegAddress()

    (#) APIs that Clear the read/write flags:
        (+) Clear read registers flags: HAL_MDIOS_ClearReadRegAddress()
        (+) Clear write registers flags: HAL_MDIOS_ClearWriteRegAddress()

    (#) A set of Callbacks are provided:
        (+) HAL_MDIOS_WriteCpltCallback()
        (+) HAL_MDIOS_ReadCpltCallback()
        (+) HAL_MDIOS_ErrorCallback()


Function Documentation

HAL_StatusTypeDef HAL_MDIOS_ClearReadRegAddress ( MDIOS_HandleTypeDef hmdios,
uint32_t  RegNum 
)

Clears Read register flag.

Parameters:
hmdios,:mdios handle
RegNum,:registers addresses to be cleared
Return values:
HALstatus

Definition at line 671 of file stm32h7xx_hal_mdios.c.

References assert_param, __MDIOS_HandleTypeDef::Instance, and IS_MDIOS_REGISTER.

HAL_StatusTypeDef HAL_MDIOS_ClearWriteRegAddress ( MDIOS_HandleTypeDef hmdios,
uint32_t  RegNum 
)

Clears Write registers flag.

Parameters:
hmdios,:mdios handle
RegNum,:registers addresses to be cleared
Return values:
HALstatus

Definition at line 648 of file stm32h7xx_hal_mdios.c.

References assert_param, __MDIOS_HandleTypeDef::Instance, and IS_MDIOS_REGISTER.

HAL_StatusTypeDef HAL_MDIOS_EnableEvents ( MDIOS_HandleTypeDef hmdios)

Enables Events for MDIOS peripheral.

Parameters:
hmdios,:mdios handle
Return values:
HALstatus

Definition at line 693 of file stm32h7xx_hal_mdios.c.

References __HAL_MDIOS_ENABLE_IT, MDIOS_IT_ERROR, MDIOS_IT_READ, and MDIOS_IT_WRITE.

Error Callback.

Parameters:
hmdios,:mdios handle
Return values:
None

Definition at line 858 of file stm32h7xx_hal_mdios.c.

Referenced by HAL_MDIOS_IRQHandler(), HAL_MDIOS_UnRegisterCallback(), and MDIOS_InitCallbacksToDefault().

Gets Read registers by MDIO master.

Parameters:
hmdios,:mdios handle
Return values:
bitmap of read registers addresses

Definition at line 637 of file stm32h7xx_hal_mdios.c.

References __MDIOS_HandleTypeDef::Instance.

Referenced by HAL_MDIOS_IRQHandler().

Gets Written registers by MDIO master.

Parameters:
hmdios,:mdios handle
Return values:
bitmap of written registers addresses

Definition at line 627 of file stm32h7xx_hal_mdios.c.

References __MDIOS_HandleTypeDef::Instance.

Referenced by HAL_MDIOS_IRQHandler().

Read Complete Callback.

Parameters:
hmdios,:mdios handle
Return values:
None

Definition at line 843 of file stm32h7xx_hal_mdios.c.

Referenced by HAL_MDIOS_IRQHandler(), HAL_MDIOS_UnRegisterCallback(), and MDIOS_InitCallbacksToDefault().

HAL_StatusTypeDef HAL_MDIOS_ReadReg ( MDIOS_HandleTypeDef hmdios,
uint32_t  RegNum,
uint16_t *  pData 
)

Reads an MDIOS input register.

Parameters:
hmdios,:mdios handle
RegNum,:MDIOS input register address
pData,:pointer to Data
Return values:
HALstatus

Definition at line 600 of file stm32h7xx_hal_mdios.c.

References assert_param, IS_MDIOS_REGISTER, and MDIOS_DIN_BASE_ADDR.

MDIOS WAKEUP interrupt callback.

Parameters:
hmdios,:mdios handle
Return values:
None

Definition at line 873 of file stm32h7xx_hal_mdios.c.

Referenced by HAL_MDIOS_IRQHandler(), HAL_MDIOS_UnRegisterCallback(), and MDIOS_InitCallbacksToDefault().

Write Complete Callback.

Parameters:
hmdios,:mdios handle
Return values:
None

Definition at line 828 of file stm32h7xx_hal_mdios.c.

Referenced by HAL_MDIOS_IRQHandler(), HAL_MDIOS_UnRegisterCallback(), and MDIOS_InitCallbacksToDefault().

HAL_StatusTypeDef HAL_MDIOS_WriteReg ( MDIOS_HandleTypeDef hmdios,
uint32_t  RegNum,
uint16_t  Data 
)

Writes to an MDIOS output register.

Parameters:
hmdios,:mdios handle
RegNum,:MDIOS output register address
Data,:Data to write
Return values:
HALstatus

Definition at line 571 of file stm32h7xx_hal_mdios.c.

References assert_param, IS_MDIOS_REGISTER, and MDIOS_DOUT_BASE_ADDR.