lan8700_driver.h

Go to the documentation of this file.

/**
 * @file lan8700_driver.h
 * @brief LAN8700 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.0
 **/
 
#ifndef _LAN8700_DRIVER_H
#define _LAN8700_DRIVER_H
 
//Dependencies
#include "core/nic.h"
 
//PHY address
#ifndef LAN8700_PHY_ADDR
   #define LAN8700_PHY_ADDR 0
#elif (LAN8700_PHY_ADDR < 0 || LAN8700_PHY_ADDR > 31)
   #error LAN8700_PHY_ADDR parameter is not valid
#endif
 
//LAN8700 PHY registers
#define LAN8700_BMCR                        0x00
#define LAN8700_BMSR                        0x01
#define LAN8700_PHYID1                      0x02
#define LAN8700_PHYID2                      0x03
#define LAN8700_ANAR                        0x04
#define LAN8700_ANLPAR                      0x05
#define LAN8700_ANER                        0x06
#define LAN8700_SRR                         0x10
#define LAN8700_MCSR                        0x11
#define LAN8700_SMR                         0x12
#define LAN8700_SECR                        0x1A
#define LAN8700_SCSIR                       0x1B
#define LAN8700_ISR                         0x1D
#define LAN8700_IMR                         0x1E
#define LAN8700_PSCSR                       0x1F
 
//Basic Control register
#define LAN8700_BMCR_RESET                  0x8000
#define LAN8700_BMCR_LOOPBACK               0x4000
#define LAN8700_BMCR_SPEED_SEL              0x2000
#define LAN8700_BMCR_AN_EN                  0x1000
#define LAN8700_BMCR_POWER_DOWN             0x0800
#define LAN8700_BMCR_ISOLATE                0x0400
#define LAN8700_BMCR_RESTART_AN             0x0200
#define LAN8700_BMCR_DUPLEX_MODE            0x0100
#define LAN8700_BMCR_COL_TEST               0x0080
 
//Basic Status register
#define LAN8700_BMSR_100BT4                 0x8000
#define LAN8700_BMSR_100BTX_FD              0x4000
#define LAN8700_BMSR_100BTX_HD              0x2000
#define LAN8700_BMSR_10BT_FD                0x1000
#define LAN8700_BMSR_10BT_HD                0x0800
#define LAN8700_BMSR_AN_COMPLETE            0x0020
#define LAN8700_BMSR_REMOTE_FAULT           0x0010
#define LAN8700_BMSR_AN_CAPABLE             0x0008
#define LAN8700_BMSR_LINK_STATUS            0x0004
#define LAN8700_BMSR_JABBER_DETECT          0x0002
#define LAN8700_BMSR_EXTENDED_CAPABLE       0x0001
 
//PHY Identifier 1 register
#define LAN8700_PHYID1_PHY_ID_MSB           0xFFFF
#define LAN8700_PHYID1_PHY_ID_MSB_DEFAULT   0x0007
 
//PHY Identifier 2 register
#define LAN8700_PHYID2_PHY_ID_LSB           0xFC00
#define LAN8700_PHYID2_PHY_ID_LSB_DEFAULT   0xC000
#define LAN8700_PHYID2_MODEL_NUM            0x03F0
#define LAN8700_PHYID2_MODEL_NUM_DEFAULT    0x00C0
#define LAN8700_PHYID2_REVISION_NUM         0x000F
 
//Auto-Negotiation Advertisement register
#define LAN8700_ANAR_NEXT_PAGE              0x8000
#define LAN8700_ANAR_REMOTE_FAULT           0x2000
#define LAN8700_ANAR_PAUSE                  0x0C00
#define LAN8700_ANAR_100BT4                 0x0200
#define LAN8700_ANAR_100BTX_FD              0x0100
#define LAN8700_ANAR_100BTX_HD              0x0080
#define LAN8700_ANAR_10BT_FD                0x0040
#define LAN8700_ANAR_10BT_HD                0x0020
#define LAN8700_ANAR_SELECTOR               0x001F
#define LAN8700_ANAR_SELECTOR_DEFAULT       0x0001
 
//Auto-Negotiation Link Partner Ability register
#define LAN8700_ANLPAR_NEXT_PAGE            0x8000
#define LAN8700_ANLPAR_ACK                  0x4000
#define LAN8700_ANLPAR_REMOTE_FAULT         0x2000
#define LAN8700_ANLPAR_PAUSE                0x0400
#define LAN8700_ANLPAR_100BT4               0x0200
#define LAN8700_ANLPAR_100BTX_FD            0x0100
#define LAN8700_ANLPAR_100BTX_HD            0x0080
#define LAN8700_ANLPAR_10BT_FD              0x0040
#define LAN8700_ANLPAR_10BT_HD              0x0020
#define LAN8700_ANLPAR_SELECTOR             0x001F
#define LAN8700_ANLPAR_SELECTOR_DEFAULT     0x0001
 
//Auto-Negotiation Expansion register
#define LAN8700_ANER_PAR_DETECT_FAULT       0x0010
#define LAN8700_ANER_LP_NEXT_PAGE_ABLE      0x0008
#define LAN8700_ANER_NEXT_PAGE_ABLE         0x0004
#define LAN8700_ANER_PAGE_RECEIVED          0x0002
#define LAN8700_ANER_LP_AN_ABLE             0x0001
 
//Silicon Revision register
#define LAN8700_SRR_SILICON_REV             0x03C0
 
//Mode Control/Status register
#define LAN8700_MCSR_EDPWRDOWN              0x2000
#define LAN8700_MCSR_LOWSQEN                0x0800
#define LAN8700_MCSR_MDPREBP                0x0400
#define LAN8700_MCSR_FARLOOPBACK            0x0200
#define LAN8700_MCSR_ALTINT                 0x0040
#define LAN8700_MCSR_PHYADBP                0x0008
#define LAN8700_MCSR_FORCE_GOOD_LINK_STATUS 0x0004
#define LAN8700_MCSR_ENERGYON               0x0002
 
//Special Modes register
#define LAN8700_SMR_MIIMODE                 0x4000
#define LAN8700_SMR_MODE                    0x00E0
#define LAN8700_SMR_PHYAD                   0x001F
 
//Symbol Error Counter register
#define LAN8700_SECR_SYM_ERR_CNT            0xFFFF
 
//Special Control/Status Indication register
#define LAN8700_SCSIR_AMDIXCTRL             0x8000
#define LAN8700_SCSIR_CH_SELECT             0x2000
#define LAN8700_SCSIR_SQEOFF                0x0800
#define LAN8700_SCSIR_XPOL                  0x0010
 
//Interrupt Source register
#define LAN8700_ISR_ENERGYON                0x0080
#define LAN8700_ISR_AN_COMPLETE             0x0040
#define LAN8700_ISR_REMOTE_FAULT            0x0020
#define LAN8700_ISR_LINK_DOWN               0x0010
#define LAN8700_ISR_AN_LP_ACK               0x0008
#define LAN8700_ISR_PAR_DETECT_FAULT        0x0004
#define LAN8700_ISR_AN_PAGE_RECEIVED        0x0002
 
//Interrupt Mask register
#define LAN8700_IMR_ENERGYON                0x0080
#define LAN8700_IMR_AN_COMPLETE             0x0040
#define LAN8700_IMR_REMOTE_FAULT            0x0020
#define LAN8700_IMR_LINK_DOWN               0x0010
#define LAN8700_IMR_AN_LP_ACK               0x0008
#define LAN8700_IMR_PAR_DETECT_FAULT        0x0004
#define LAN8700_IMR_AN_PAGE_RECEIVED        0x0002
 
//PHY Special Control/Status register
#define LAN8700_PSCSR_AUTODONE              0x1000
#define LAN8700_PSCSR_4B5B_EN               0x0040
#define LAN8700_PSCSR_HCDSPEED              0x001C
#define LAN8700_PSCSR_HCDSPEED_10BT_HD      0x0004
#define LAN8700_PSCSR_HCDSPEED_100BTX_HD    0x0008
#define LAN8700_PSCSR_HCDSPEED_10BT_FD      0x0014
#define LAN8700_PSCSR_HCDSPEED_100BTX_FD    0x0018
#define LAN8700_PSCSR_SCRAMBLE_DIS          0x0001
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
//LAN8700 Ethernet PHY driver
extern const PhyDriver lan8700PhyDriver;
 
//LAN8700 related functions
error_t lan8700Init(NetInterface *interface);
void lan8700InitHook(NetInterface *interface);
 
void lan8700Tick(NetInterface *interface);
 
void lan8700EnableIrq(NetInterface *interface);
void lan8700DisableIrq(NetInterface *interface);
 
void lan8700EventHandler(NetInterface *interface);
 
void lan8700WritePhyReg(NetInterface *interface, uint8_t address,
   uint16_t data);
 
uint16_t lan8700ReadPhyReg(NetInterface *interface, uint8_t address);
 
void lan8700DumpPhyReg(NetInterface *interface);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif