/** ****************************************************************************** * @file lan8742.h * @author MCD Application Team * @brief This file contains all the functions prototypes for the * lan8742.c PHY driver. ****************************************************************************** * @attention * *

© Copyright (c) 2017 STMicroelectronics. * All rights reserved.

* * This software component is licensed by ST under BSD 3-Clause license, * the "License"; You may not use this file except in compliance with the * License. You may obtain a copy of the License at: * opensource.org/licenses/BSD-3-Clause * ****************************************************************************** */ /* Define to prevent recursive inclusion -------------------------------------*/ #ifndef LAN8742_H #define LAN8742_H #ifdef __cplusplus extern "C" { #endif /* Includes ------------------------------------------------------------------*/ #include /** @addtogroup BSP * @{ */ /** @addtogroup Component * @{ */ /** @defgroup LAN8742 * @{ */ /* Exported constants --------------------------------------------------------*/ /** @defgroup LAN8742_Exported_Constants LAN8742 Exported Constants * @{ */ /** @defgroup LAN8742_Registers_Mapping LAN8742 Registers Mapping * @{ */ #define LAN8742_BCR ((uint16_t)0x0000U) #define LAN8742_BSR ((uint16_t)0x0001U) #define LAN8742_PHYI1R ((uint16_t)0x0002U) #define LAN8742_PHYI2R ((uint16_t)0x0003U) #define LAN8742_ANAR ((uint16_t)0x0004U) #define LAN8742_ANLPAR ((uint16_t)0x0005U) #define LAN8742_ANER ((uint16_t)0x0006U) #define LAN8742_ANNPTR ((uint16_t)0x0007U) #define LAN8742_ANNPRR ((uint16_t)0x0008U) #define LAN8742_MMDACR ((uint16_t)0x000DU) #define LAN8742_MMDAADR ((uint16_t)0x000EU) #define LAN8742_ENCTR ((uint16_t)0x0010U) #define LAN8742_MCSR ((uint16_t)0x0011U) #define LAN8742_SMR ((uint16_t)0x0012U) #define LAN8742_TPDCR ((uint16_t)0x0018U) #define LAN8742_TCSR ((uint16_t)0x0019U) #define LAN8742_SECR ((uint16_t)0x001AU) #define LAN8742_SCSIR ((uint16_t)0x001BU) #define LAN8742_CLR ((uint16_t)0x001CU) #define LAN8742_ISFR ((uint16_t)0x001DU) #define LAN8742_IMR ((uint16_t)0x001EU) #define LAN8742_PHYSCSR ((uint16_t)0x001FU) /** * @} */ /** @defgroup LAN8742_BCR_Bit_Definition LAN8742 BCR Bit Definition * @{ */ #define LAN8742_BCR_SOFT_RESET ((uint16_t)0x8000U) #define LAN8742_BCR_LOOPBACK ((uint16_t)0x4000U) #define LAN8742_BCR_SPEED_SELECT ((uint16_t)0x2000U) #define LAN8742_BCR_AUTONEGO_EN ((uint16_t)0x1000U) #define LAN8742_BCR_POWER_DOWN ((uint16_t)0x0800U) #define LAN8742_BCR_ISOLATE ((uint16_t)0x0400U) #define LAN8742_BCR_RESTART_AUTONEGO ((uint16_t)0x0200U) #define LAN8742_BCR_DUPLEX_MODE ((uint16_t)0x0100U) /** * @} */ /** @defgroup LAN8742_BSR_Bit_Definition LAN8742 BSR Bit Definition * @{ */ #define LAN8742_BSR_100BASE_T4 ((uint16_t)0x8000U) #define LAN8742_BSR_100BASE_TX_FD ((uint16_t)0x4000U) #define LAN8742_BSR_100BASE_TX_HD ((uint16_t)0x2000U) #define LAN8742_BSR_10BASE_T_FD ((uint16_t)0x1000U) #define LAN8742_BSR_10BASE_T_HD ((uint16_t)0x0800U) #define LAN8742_BSR_100BASE_T2_FD ((uint16_t)0x0400U) #define LAN8742_BSR_100BASE_T2_HD ((uint16_t)0x0200U) #define LAN8742_BSR_EXTENDED_STATUS ((uint16_t)0x0100U) #define LAN8742_BSR_AUTONEGO_CPLT ((uint16_t)0x0020U) #define LAN8742_BSR_REMOTE_FAULT ((uint16_t)0x0010U) #define LAN8742_BSR_AUTONEGO_ABILITY ((uint16_t)0x0008U) #define LAN8742_BSR_LINK_STATUS ((uint16_t)0x0004U) #define LAN8742_BSR_JABBER_DETECT ((uint16_t)0x0002U) #define LAN8742_BSR_EXTENDED_CAP ((uint16_t)0x0001U) /** * @} */ /** @defgroup LAN8742_PHYI1R_Bit_Definition LAN8742 PHYI1R Bit Definition * @{ */ #define LAN8742_PHYI1R_OUI_3_18 ((uint16_t)0xFFFFU) /** * @} */ /** @defgroup LAN8742_PHYI2R_Bit_Definition LAN8742 PHYI2R Bit Definition * @{ */ #define LAN8742_PHYI2R_OUI_19_24 ((uint16_t)0xFC00U) #define LAN8742_PHYI2R_MODEL_NBR ((uint16_t)0x03F0U) #define LAN8742_PHYI2R_REVISION_NBR ((uint16_t)0x000FU) /** * @} */ /** @defgroup LAN8742_ANAR_Bit_Definition LAN8742 ANAR Bit Definition * @{ */ #define LAN8742_ANAR_NEXT_PAGE ((uint16_t)0x8000U) #define LAN8742_ANAR_REMOTE_FAULT ((uint16_t)0x2000U) #define LAN8742_ANAR_PAUSE_OPERATION ((uint16_t)0x0C00U) #define LAN8742_ANAR_PO_NOPAUSE ((uint16_t)0x0000U) #define LAN8742_ANAR_PO_SYMMETRIC_PAUSE ((uint16_t)0x0400U) #define LAN8742_ANAR_PO_ASYMMETRIC_PAUSE ((uint16_t)0x0800U) #define LAN8742_ANAR_PO_ADVERTISE_SUPPORT ((uint16_t)0x0C00U) #define LAN8742_ANAR_100BASE_TX_FD ((uint16_t)0x0100U) #define LAN8742_ANAR_100BASE_TX ((uint16_t)0x0080U) #define LAN8742_ANAR_10BASE_T_FD ((uint16_t)0x0040U) #define LAN8742_ANAR_10BASE_T ((uint16_t)0x0020U) #define LAN8742_ANAR_SELECTOR_FIELD ((uint16_t)0x000FU) /** * @} */ /** @defgroup LAN8742_ANLPAR_Bit_Definition LAN8742 ANLPAR Bit Definition * @{ */ #define LAN8742_ANLPAR_NEXT_PAGE ((uint16_t)0x8000U) #define LAN8742_ANLPAR_REMOTE_FAULT ((uint16_t)0x2000U) #define LAN8742_ANLPAR_PAUSE_OPERATION ((uint16_t)0x0C00U) #define LAN8742_ANLPAR_PO_NOPAUSE ((uint16_t)0x0000U) #define LAN8742_ANLPAR_PO_SYMMETRIC_PAUSE ((uint16_t)0x0400U) #define LAN8742_ANLPAR_PO_ASYMMETRIC_PAUSE ((uint16_t)0x0800U) #define LAN8742_ANLPAR_PO_ADVERTISE_SUPPORT ((uint16_t)0x0C00U) #define LAN8742_ANLPAR_100BASE_TX_FD ((uint16_t)0x0100U) #define LAN8742_ANLPAR_100BASE_TX ((uint16_t)0x0080U) #define LAN8742_ANLPAR_10BASE_T_FD ((uint16_t)0x0040U) #define LAN8742_ANLPAR_10BASE_T ((uint16_t)0x0020U) #define LAN8742_ANLPAR_SELECTOR_FIELD ((uint16_t)0x000FU) /** * @} */ /** @defgroup LAN8742_ANER_Bit_Definition LAN8742 ANER Bit Definition * @{ */ #define LAN8742_ANER_RX_NP_LOCATION_ABLE ((uint16_t)0x0040U) #define LAN8742_ANER_RX_NP_STORAGE_LOCATION ((uint16_t)0x0020U) #define LAN8742_ANER_PARALLEL_DETECT_FAULT ((uint16_t)0x0010U) #define LAN8742_ANER_LP_NP_ABLE ((uint16_t)0x0008U) #define LAN8742_ANER_NP_ABLE ((uint16_t)0x0004U) #define LAN8742_ANER_PAGE_RECEIVED ((uint16_t)0x0002U) #define LAN8742_ANER_LP_AUTONEG_ABLE ((uint16_t)0x0001U) /** * @} */ /** @defgroup LAN8742_ANNPTR_Bit_Definition LAN8742 ANNPTR Bit Definition * @{ */ #define LAN8742_ANNPTR_NEXT_PAGE ((uint16_t)0x8000U) #define LAN8742_ANNPTR_MESSAGE_PAGE ((uint16_t)0x2000U) #define LAN8742_ANNPTR_ACK2 ((uint16_t)0x1000U) #define LAN8742_ANNPTR_TOGGLE ((uint16_t)0x0800U) #define LAN8742_ANNPTR_MESSAGGE_CODE ((uint16_t)0x07FFU) /** * @} */ /** @defgroup LAN8742_ANNPRR_Bit_Definition LAN8742 ANNPRR Bit Definition * @{ */ #define LAN8742_ANNPTR_NEXT_PAGE ((uint16_t)0x8000U) #define LAN8742_ANNPRR_ACK ((uint16_t)0x4000U) #define LAN8742_ANNPRR_MESSAGE_PAGE ((uint16_t)0x2000U) #define LAN8742_ANNPRR_ACK2 ((uint16_t)0x1000U) #define LAN8742_ANNPRR_TOGGLE ((uint16_t)0x0800U) #define LAN8742_ANNPRR_MESSAGGE_CODE ((uint16_t)0x07FFU) /** * @} */ /** @defgroup LAN8742_MMDACR_Bit_Definition LAN8742 MMDACR Bit Definition * @{ */ #define LAN8742_MMDACR_MMD_FUNCTION ((uint16_t)0xC000U) #define LAN8742_MMDACR_MMD_FUNCTION_ADDR ((uint16_t)0x0000U) #define LAN8742_MMDACR_MMD_FUNCTION_DATA ((uint16_t)0x4000U) #define LAN8742_MMDACR_MMD_DEV_ADDR ((uint16_t)0x001FU) /** * @} */ /** @defgroup LAN8742_ENCTR_Bit_Definition LAN8742 ENCTR Bit Definition * @{ */ #define LAN8742_ENCTR_TX_ENABLE ((uint16_t)0x8000U) #define LAN8742_ENCTR_TX_TIMER ((uint16_t)0x6000U) #define LAN8742_ENCTR_TX_TIMER_1S ((uint16_t)0x0000U) #define LAN8742_ENCTR_TX_TIMER_768MS ((uint16_t)0x2000U) #define LAN8742_ENCTR_TX_TIMER_512MS ((uint16_t)0x4000U) #define LAN8742_ENCTR_TX_TIMER_265MS ((uint16_t)0x6000U) #define LAN8742_ENCTR_RX_ENABLE ((uint16_t)0x1000U) #define LAN8742_ENCTR_RX_MAX_INTERVAL ((uint16_t)0x0C00U) #define LAN8742_ENCTR_RX_MAX_INTERVAL_64MS ((uint16_t)0x0000U) #define LAN8742_ENCTR_RX_MAX_INTERVAL_256MS ((uint16_t)0x0400U) #define LAN8742_ENCTR_RX_MAX_INTERVAL_512MS ((uint16_t)0x0800U) #define LAN8742_ENCTR_RX_MAX_INTERVAL_1S ((uint16_t)0x0C00U) #define LAN8742_ENCTR_EX_CROSS_OVER ((uint16_t)0x0002U) #define LAN8742_ENCTR_EX_MANUAL_CROSS_OVER ((uint16_t)0x0001U) /** * @} */ /** @defgroup LAN8742_MCSR_Bit_Definition LAN8742 MCSR Bit Definition * @{ */ #define LAN8742_MCSR_EDPWRDOWN ((uint16_t)0x2000U) #define LAN8742_MCSR_FARLOOPBACK ((uint16_t)0x0200U) #define LAN8742_MCSR_ALTINT ((uint16_t)0x0040U) #define LAN8742_MCSR_ENERGYON ((uint16_t)0x0002U) /** * @} */ /** @defgroup LAN8742_SMR_Bit_Definition LAN8742 SMR Bit Definition * @{ */ #define LAN8742_SMR_MODE ((uint16_t)0x00E0U) #define LAN8742_SMR_PHY_ADDR ((uint16_t)0x001FU) /** * @} */ /** @defgroup LAN8742_TPDCR_Bit_Definition LAN8742 TPDCR Bit Definition * @{ */ #define LAN8742_TPDCR_DELAY_IN ((uint16_t)0x8000U) #define LAN8742_TPDCR_LINE_BREAK_COUNTER ((uint16_t)0x7000U) #define LAN8742_TPDCR_PATTERN_HIGH ((uint16_t)0x0FC0U) #define LAN8742_TPDCR_PATTERN_LOW ((uint16_t)0x003FU) /** * @} */ /** @defgroup LAN8742_TCSR_Bit_Definition LAN8742 TCSR Bit Definition * @{ */ #define LAN8742_TCSR_TDR_ENABLE ((uint16_t)0x8000U) #define LAN8742_TCSR_TDR_AD_FILTER_ENABLE ((uint16_t)0x4000U) #define LAN8742_TCSR_TDR_CH_CABLE_TYPE ((uint16_t)0x0600U) #define LAN8742_TCSR_TDR_CH_CABLE_DEFAULT ((uint16_t)0x0000U) #define LAN8742_TCSR_TDR_CH_CABLE_SHORTED ((uint16_t)0x0200U) #define LAN8742_TCSR_TDR_CH_CABLE_OPEN ((uint16_t)0x0400U) #define LAN8742_TCSR_TDR_CH_CABLE_MATCH ((uint16_t)0x0600U) #define LAN8742_TCSR_TDR_CH_STATUS ((uint16_t)0x0100U) #define LAN8742_TCSR_TDR_CH_LENGTH ((uint16_t)0x00FFU) /** * @} */ /** @defgroup LAN8742_SCSIR_Bit_Definition LAN8742 SCSIR Bit Definition * @{ */ #define LAN8742_SCSIR_AUTO_MDIX_ENABLE ((uint16_t)0x8000U) #define LAN8742_SCSIR_CHANNEL_SELECT ((uint16_t)0x2000U) #define LAN8742_SCSIR_SQE_DISABLE ((uint16_t)0x0800U) #define LAN8742_SCSIR_XPOLALITY ((uint16_t)0x0010U) /** * @} */ /** @defgroup LAN8742_CLR_Bit_Definition LAN8742 CLR Bit Definition * @{ */ #define LAN8742_CLR_CABLE_LENGTH ((uint16_t)0xF000U) /** * @} */ /** @defgroup LAN8742_IMR_ISFR_Bit_Definition LAN8742 IMR ISFR Bit Definition * @{ */ #define LAN8742_INT_8 ((uint16_t)0x0100U) #define LAN8742_INT_7 ((uint16_t)0x0080U) #define LAN8742_INT_6 ((uint16_t)0x0040U) #define LAN8742_INT_5 ((uint16_t)0x0020U) #define LAN8742_INT_4 ((uint16_t)0x0010U) #define LAN8742_INT_3 ((uint16_t)0x0008U) #define LAN8742_INT_2 ((uint16_t)0x0004U) #define LAN8742_INT_1 ((uint16_t)0x0002U) /** * @} */ /** @defgroup LAN8742_PHYSCSR_Bit_Definition LAN8742 PHYSCSR Bit Definition * @{ */ #define LAN8742_PHYSCSR_AUTONEGO_DONE ((uint16_t)0x1000U) #define LAN8742_PHYSCSR_HCDSPEEDMASK ((uint16_t)0x001CU) #define LAN8742_PHYSCSR_10BT_HD ((uint16_t)0x0004U) #define LAN8742_PHYSCSR_10BT_FD ((uint16_t)0x0014U) #define LAN8742_PHYSCSR_100BTX_HD ((uint16_t)0x0008U) #define LAN8742_PHYSCSR_100BTX_FD ((uint16_t)0x0018U) /** * @} */ /** @defgroup LAN8742_Status LAN8742 Status * @{ */ #define LAN8742_STATUS_READ_ERROR ((int32_t)-5) #define LAN8742_STATUS_WRITE_ERROR ((int32_t)-4) #define LAN8742_STATUS_ADDRESS_ERROR ((int32_t)-3) #define LAN8742_STATUS_RESET_TIMEOUT ((int32_t)-2) #define LAN8742_STATUS_ERROR ((int32_t)-1) #define LAN8742_STATUS_OK ((int32_t)0) #define LAN8742_STATUS_LINK_DOWN ((int32_t)1) #define LAN8742_STATUS_100MBITS_FULLDUPLEX ((int32_t)2) #define LAN8742_STATUS_100MBITS_HALFDUPLEX ((int32_t)3) #define LAN8742_STATUS_10MBITS_FULLDUPLEX ((int32_t)4) #define LAN8742_STATUS_10MBITS_HALFDUPLEX ((int32_t)5) #define LAN8742_STATUS_AUTONEGO_NOTDONE ((int32_t)6) /** * @} */ /** @defgroup LAN8742_IT_Flags LAN8742 IT Flags * @{ */ #define LAN8742_WOL_IT LAN8742_INT_8 #define LAN8742_ENERGYON_IT LAN8742_INT_7 #define LAN8742_AUTONEGO_COMPLETE_IT LAN8742_INT_6 #define LAN8742_REMOTE_FAULT_IT LAN8742_INT_5 #define LAN8742_LINK_DOWN_IT LAN8742_INT_4 #define LAN8742_AUTONEGO_LP_ACK_IT LAN8742_INT_3 #define LAN8742_PARALLEL_DETECTION_FAULT_IT LAN8742_INT_2 #define LAN8742_AUTONEGO_PAGE_RECEIVED_IT LAN8742_INT_1 /** * @} */ /** * @} */ /* Exported types ------------------------------------------------------------*/ /** @defgroup LAN8742_Exported_Types LAN8742 Exported Types * @{ */ typedef int32_t (*lan8742_Init_Func)(void); typedef int32_t (*lan8742_DeInit_Func)(void); typedef int32_t (*lan8742_ReadReg_Func)(uint32_t, uint32_t, uint32_t *); typedef int32_t (*lan8742_WriteReg_Func)(uint32_t, uint32_t, uint32_t); typedef int32_t (*lan8742_GetTick_Func)(void); typedef struct { lan8742_Init_Func Init; lan8742_DeInit_Func DeInit; lan8742_WriteReg_Func WriteReg; lan8742_ReadReg_Func ReadReg; lan8742_GetTick_Func GetTick; } lan8742_IOCtx_t; typedef struct { uint32_t DevAddr; uint32_t Is_Initialized; lan8742_IOCtx_t IO; void *pData; } lan8742_Object_t; /** * @} */ /* Exported macro ------------------------------------------------------------*/ /* Exported functions --------------------------------------------------------*/ /** @defgroup LAN8742_Exported_Functions LAN8742 Exported Functions * @{ */ int32_t LAN8742_RegisterBusIO(lan8742_Object_t *pObj, lan8742_IOCtx_t *ioctx); int32_t LAN8742_Init(lan8742_Object_t *pObj); int32_t LAN8742_DeInit(lan8742_Object_t *pObj); int32_t LAN8742_DisablePowerDownMode(lan8742_Object_t *pObj); int32_t LAN8742_EnablePowerDownMode(lan8742_Object_t *pObj); int32_t LAN8742_StartAutoNego(lan8742_Object_t *pObj); int32_t LAN8742_GetLinkState(lan8742_Object_t *pObj); int32_t LAN8742_SetLinkState(lan8742_Object_t *pObj, uint32_t LinkState); int32_t LAN8742_EnableLoopbackMode(lan8742_Object_t *pObj); int32_t LAN8742_DisableLoopbackMode(lan8742_Object_t *pObj); int32_t LAN8742_EnableIT(lan8742_Object_t *pObj, uint32_t Interrupt); int32_t LAN8742_DisableIT(lan8742_Object_t *pObj, uint32_t Interrupt); int32_t LAN8742_ClearIT(lan8742_Object_t *pObj, uint32_t Interrupt); int32_t LAN8742_GetITStatus(lan8742_Object_t *pObj, uint32_t Interrupt); /** * @} */ #ifdef __cplusplus } #endif #endif /* LAN8742_H */ /** * @} */ /** * @} */ /** * @} */ /** * @} */ /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/