/** * @file dp83620_driver.c * @brief DP83620 Ethernet PHY driver * * @section License * * SPDX-License-Identifier: GPL-2.0-or-later * * Copyright (C) 2010-2021 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.1.2 **/ //Switch to the appropriate trace level #define TRACE_LEVEL NIC_TRACE_LEVEL //Dependencies #include "core/net.h" #include "drivers/phy/dp83620_driver.h" #include "debug.h" /** * @brief DP83620 Ethernet PHY driver **/ const PhyDriver dp83620PhyDriver = { dp83620Init, dp83620Tick, dp83620EnableIrq, dp83620DisableIrq, dp83620EventHandler }; /** * @brief DP83620 PHY transceiver initialization * @param[in] interface Underlying network interface * @return Error code **/ error_t dp83620Init(NetInterface *interface) { //Debug message TRACE_INFO("Initializing DP83620...\r\n"); //Undefined PHY address? if(interface->phyAddr >= 32) { //Use the default address interface->phyAddr = DP83620_PHY_ADDR; } //Initialize serial management interface if(interface->smiDriver != NULL) { interface->smiDriver->init(); } //Initialize external interrupt line driver if(interface->extIntDriver != NULL) { interface->extIntDriver->init(); } //A software reset is accomplished by setting the RESET bit of the BMCR register dp83620WritePhyReg(interface, DP83620_BMCR, DP83620_BMCR_RESET); //Wait for the reset to complete while(dp83620ReadPhyReg(interface, DP83620_BMCR) & DP83620_BMCR_RESET) { } //Dump PHY registers for debugging purpose dp83620DumpPhyReg(interface); //Configure PWR_DOWN/INT pin as an interrupt output dp83620WritePhyReg(interface, DP83620_MICR, DP83620_MICR_INTEN | DP83620_MICR_INT_OE); //The PHY will generate interrupts when link status changes are detected dp83620WritePhyReg(interface, DP83620_MISR, DP83620_MISR_LINK_INT_EN); //Force the TCP/IP stack to poll the link state at startup interface->phyEvent = TRUE; //Notify the TCP/IP stack of the event osSetEvent(&netEvent); //Successful initialization return NO_ERROR; } /** * @brief DP83620 timer handler * @param[in] interface Underlying network interface **/ void dp83620Tick(NetInterface *interface) { uint16_t value; bool_t linkState; //No external interrupt line driver? if(interface->extIntDriver == NULL) { //Read basic status register value = dp83620ReadPhyReg(interface, DP83620_BMSR); //Retrieve current link state linkState = (value & DP83620_BMSR_LINK_STATUS) ? TRUE : FALSE; //Link up event? if(linkState && !interface->linkState) { //Set event flag interface->phyEvent = TRUE; //Notify the TCP/IP stack of the event osSetEvent(&netEvent); } //Link down event? else if(!linkState && interface->linkState) { //Set event flag interface->phyEvent = TRUE; //Notify the TCP/IP stack of the event osSetEvent(&netEvent); } } } /** * @brief Enable interrupts * @param[in] interface Underlying network interface **/ void dp83620EnableIrq(NetInterface *interface) { //Enable PHY transceiver interrupts if(interface->extIntDriver != NULL) { interface->extIntDriver->enableIrq(); } } /** * @brief Disable interrupts * @param[in] interface Underlying network interface **/ void dp83620DisableIrq(NetInterface *interface) { //Disable PHY transceiver interrupts if(interface->extIntDriver != NULL) { interface->extIntDriver->disableIrq(); } } /** * @brief DP83620 event handler * @param[in] interface Underlying network interface **/ void dp83620EventHandler(NetInterface *interface) { uint16_t status; //Read status register to acknowledge the interrupt status = dp83620ReadPhyReg(interface, DP83620_MISR); //Link status change? if((status & DP83620_MISR_LINK_INT) != 0) { //Read PHY status register status = dp83620ReadPhyReg(interface, DP83620_PHYSTS); //Link is up? if((status & DP83620_PHYSTS_LINK_STATUS) != 0) { //Check current speed if((status & DP83620_PHYSTS_SPEED_STATUS) != 0) { interface->linkSpeed = NIC_LINK_SPEED_10MBPS; } else { interface->linkSpeed = NIC_LINK_SPEED_100MBPS; } //Check duplex mode if((status & DP83620_PHYSTS_DUPLEX_STATUS) != 0) { interface->duplexMode = NIC_FULL_DUPLEX_MODE; } else { interface->duplexMode = NIC_HALF_DUPLEX_MODE; } //Update link state interface->linkState = TRUE; //Adjust MAC configuration parameters for proper operation interface->nicDriver->updateMacConfig(interface); } else { //Update link state interface->linkState = FALSE; } //Process link state change event nicNotifyLinkChange(interface); } } /** * @brief Write PHY register * @param[in] interface Underlying network interface * @param[in] address PHY register address * @param[in] data Register value **/ void dp83620WritePhyReg(NetInterface *interface, uint8_t address, uint16_t data) { //Write the specified PHY register if(interface->smiDriver != NULL) { interface->smiDriver->writePhyReg(SMI_OPCODE_WRITE, interface->phyAddr, address, data); } else { interface->nicDriver->writePhyReg(SMI_OPCODE_WRITE, interface->phyAddr, address, data); } } /** * @brief Read PHY register * @param[in] interface Underlying network interface * @param[in] address PHY register address * @return Register value **/ uint16_t dp83620ReadPhyReg(NetInterface *interface, uint8_t address) { uint16_t data; //Read the specified PHY register if(interface->smiDriver != NULL) { data = interface->smiDriver->readPhyReg(SMI_OPCODE_READ, interface->phyAddr, address); } else { data = interface->nicDriver->readPhyReg(SMI_OPCODE_READ, interface->phyAddr, address); } //Return the value of the PHY register return data; } /** * @brief Dump PHY registers for debugging purpose * @param[in] interface Underlying network interface **/ void dp83620DumpPhyReg(NetInterface *interface) { uint8_t i; //Loop through PHY registers for(i = 0; i < 32; i++) { //Display current PHY register TRACE_DEBUG("%02" PRIu8 ": 0x%04" PRIX16 "\r\n", i, dp83620ReadPhyReg(interface, i)); } //Terminate with a line feed TRACE_DEBUG("\r\n"); }