doc/lan8720__driver_8h_source.html

/**

 * @file lan8720_driver.h

 * @brief LAN8720 Ethernet PHY driver

 *

 * @section License

 *

 * SPDX-License-Identifier: GPL-2.0-or-later

 *

 * Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.

 *

 * This file is part of CycloneTCP Open.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

 *

 * @author Oryx Embedded SARL (www.oryx-embedded.com)

 * @version 2.4.4

 **/


#ifndef _LAN8720_DRIVER_H

#define _LAN8720_DRIVER_H


//Dependencies

#include "core/nic.h"


//PHY address

#ifndef LAN8720_PHY_ADDR

   #define LAN8720_PHY_ADDR 0

#elif (LAN8720_PHY_ADDR < 0 || LAN8720_PHY_ADDR > 31)

   #error LAN8720_PHY_ADDR parameter is not valid

#endif


//LAN8720 PHY registers

#define LAN8720_BMCR                      0x00

#define LAN8720_BMSR                      0x01

#define LAN8720_PHYID1                    0x02

#define LAN8720_PHYID2                    0x03

#define LAN8720_ANAR                      0x04

#define LAN8720_ANLPAR                    0x05

#define LAN8720_ANER                      0x06

#define LAN8720_MCSR                      0x11

#define LAN8720_SMR                       0x12

#define LAN8720_SECR                      0x1A

#define LAN8720_SCSIR                     0x1B

#define LAN8720_ISR                       0x1D

#define LAN8720_IMR                       0x1E

#define LAN8720_PSCSR                     0x1F


//Basic Control register

#define LAN8720_BMCR_RESET                0x8000

#define LAN8720_BMCR_LOOPBACK             0x4000

#define LAN8720_BMCR_SPEED_SEL            0x2000

#define LAN8720_BMCR_AN_EN                0x1000

#define LAN8720_BMCR_POWER_DOWN           0x0800

#define LAN8720_BMCR_ISOLATE              0x0400

#define LAN8720_BMCR_RESTART_AN           0x0200

#define LAN8720_BMCR_DUPLEX_MODE          0x0100


//Basic Status register

#define LAN8720_BMSR_100BT4               0x8000

#define LAN8720_BMSR_100BTX_FD            0x4000

#define LAN8720_BMSR_100BTX_HD            0x2000

#define LAN8720_BMSR_10BT_FD              0x1000

#define LAN8720_BMSR_10BT_HD              0x0800

#define LAN8720_BMSR_100BT2_FD            0x0400

#define LAN8720_BMSR_100BT2_HD            0x0200

#define LAN8720_BMSR_EXTENDED_STATUS      0x0100

#define LAN8720_BMSR_AN_COMPLETE          0x0020

#define LAN8720_BMSR_REMOTE_FAULT         0x0010

#define LAN8720_BMSR_AN_CAPABLE           0x0008

#define LAN8720_BMSR_LINK_STATUS          0x0004

#define LAN8720_BMSR_JABBER_DETECT        0x0002

#define LAN8720_BMSR_EXTENDED_CAPABLE     0x0001


//PHY Identifier 1 register

#define LAN8720_PHYID1_PHY_ID_MSB         0xFFFF

#define LAN8720_PHYID1_PHY_ID_MSB_DEFAULT 0x0007


//PHY Identifier 2 register

#define LAN8720_PHYID2_PHY_ID_LSB         0xFC00

#define LAN8720_PHYID2_PHY_ID_LSB_DEFAULT 0xC000

#define LAN8720_PHYID2_MODEL_NUM          0x03F0

#define LAN8720_PHYID2_MODEL_NUM_DEFAULT  0x00F0

#define LAN8720_PHYID2_REVISION_NUM       0x000F


//Auto-Negotiation Advertisement register

#define LAN8720_ANAR_REMOTE_FAULT         0x2000

#define LAN8720_ANAR_PAUSE                0x0C00

#define LAN8720_ANAR_100BTX_FD            0x0100

#define LAN8720_ANAR_100BTX_HD            0x0080

#define LAN8720_ANAR_10BT_FD              0x0040

#define LAN8720_ANAR_10BT_HD              0x0020

#define LAN8720_ANAR_SELECTOR             0x001F

#define LAN8720_ANAR_SELECTOR_DEFAULT     0x0001


//Auto-Negotiation Link Partner Ability register

#define LAN8720_ANLPAR_NEXT_PAGE          0x8000

#define LAN8720_ANLPAR_ACK                0x4000

#define LAN8720_ANLPAR_REMOTE_FAULT       0x2000

#define LAN8720_ANLPAR_PAUSE              0x0400

#define LAN8720_ANLPAR_100BT4             0x0200

#define LAN8720_ANLPAR_100BTX_FD          0x0100

#define LAN8720_ANLPAR_100BTX_HD          0x0080

#define LAN8720_ANLPAR_10BT_FD            0x0040

#define LAN8720_ANLPAR_10BT_HD            0x0020

#define LAN8720_ANLPAR_SELECTOR           0x001F

#define LAN8720_ANLPAR_SELECTOR_DEFAULT   0x0001


//Auto-Negotiation Expansion register

#define LAN8720_ANER_PAR_DETECT_FAULT     0x0010

#define LAN8720_ANER_LP_NEXT_PAGE_ABLE    0x0008

#define LAN8720_ANER_NEXT_PAGE_ABLE       0x0004

#define LAN8720_ANER_PAGE_RECEIVED        0x0002

#define LAN8720_ANER_LP_AN_ABLE           0x0001


//Mode Control/Status register

#define LAN8720_MCSR_EDPWRDOWN            0x2000

#define LAN8720_MCSR_FARLOOPBACK          0x0200

#define LAN8720_MCSR_ALTINT               0x0040

#define LAN8720_MCSR_ENERGYON             0x0002


//Special Modes register

#define LAN8720_SMR_MODE                  0x00E0

#define LAN8720_SMR_PHYAD                 0x001F


//Symbol Error Counter register

#define LAN8720_SECR_SYM_ERR_CNT          0xFFFF


//Special Control/Status Indication register

#define LAN8720_SCSIR_AMDIXCTRL           0x8000

#define LAN8720_SCSIR_CH_SELECT           0x2000

#define LAN8720_SCSIR_SQEOFF              0x0800

#define LAN8720_SCSIR_XPOL                0x0010


//Interrupt Source register

#define LAN8720_ISR_ENERGYON              0x0080

#define LAN8720_ISR_AN_COMPLETE           0x0040

#define LAN8720_ISR_REMOTE_FAULT          0x0020

#define LAN8720_ISR_LINK_DOWN             0x0010

#define LAN8720_ISR_AN_LP_ACK             0x0008

#define LAN8720_ISR_PAR_DETECT_FAULT      0x0004

#define LAN8720_ISR_AN_PAGE_RECEIVED      0x0002


//Interrupt Mask register

#define LAN8720_IMR_ENERGYON              0x0080

#define LAN8720_IMR_AN_COMPLETE           0x0040

#define LAN8720_IMR_REMOTE_FAULT          0x0020

#define LAN8720_IMR_LINK_DOWN             0x0010

#define LAN8720_IMR_AN_LP_ACK             0x0008

#define LAN8720_IMR_PAR_DETECT_FAULT      0x0004

#define LAN8720_IMR_AN_PAGE_RECEIVED      0x0002


//PHY Special Control/Status register

#define LAN8720_PSCSR_AUTODONE            0x1000

#define LAN8720_PSCSR_HCDSPEED            0x001C

#define LAN8720_PSCSR_HCDSPEED_10BT_HD    0x0004

#define LAN8720_PSCSR_HCDSPEED_100BTX_HD  0x0008

#define LAN8720_PSCSR_HCDSPEED_10BT_FD    0x0014

#define LAN8720_PSCSR_HCDSPEED_100BTX_FD  0x0018


//C++ guard

#ifdef __cplusplus

extern "C" {

#endif


//LAN8720 Ethernet PHY driver

extern const PhyDriver lan8720PhyDriver;


//LAN8720 related functions

error_t lan8720Init(NetInterface *interface);

void lan8720InitHook(NetInterface *interface);


void lan8720Tick(NetInterface *interface);


void lan8720EnableIrq(NetInterface *interface);

void lan8720DisableIrq(NetInterface *interface);


void lan8720EventHandler(NetInterface *interface);


void lan8720WritePhyReg(NetInterface *interface, uint8_t address,

   uint16_t data);


uint16_t lan8720ReadPhyReg(NetInterface *interface, uint8_t address);


void lan8720DumpPhyReg(NetInterface *interface);


//C++ guard

#ifdef __cplusplus

}

#endif


#endif