ksz9031_driver.c

Go to the documentation of this file.

/**
 * @file ksz9031_driver.c
 * @brief KSZ9031 Gigabit 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
 **/
 
//Switch to the appropriate trace level
#define TRACE_LEVEL NIC_TRACE_LEVEL
 
//Dependencies
#include "core/net.h"
#include "drivers/phy/ksz9031_driver.h"
#include "debug.h"
 
 
/**
 * @brief KSZ9031 Ethernet PHY driver
 **/
 
const PhyDriver ksz9031PhyDriver =
{
   ksz9031Init,
   ksz9031Tick,
   ksz9031EnableIrq,
   ksz9031DisableIrq,
   ksz9031EventHandler
};
 
 
/**
 * @brief KSZ9031 PHY transceiver initialization
 * @param[in] interface Underlying network interface
 * @return Error code
 **/
 
error_t ksz9031Init(NetInterface *interface)
{
   uint16_t value;
 
   //Debug message
   TRACE_INFO("Initializing KSZ9031...\r\n");
 
   //Undefined PHY address?
   if(interface->phyAddr >= 32)
   {
      //Use the default address
      interface->phyAddr = KSZ9031_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();
   }
 
   //Reset PHY transceiver
   ksz9031WritePhyReg(interface, KSZ9031_BMCR, KSZ9031_BMCR_RESET);
 
   //Wait for the reset to complete
   while(ksz9031ReadPhyReg(interface, KSZ9031_BMCR) & KSZ9031_BMCR_RESET)
   {
   }
 
   //Dump PHY registers for debugging purpose
   ksz9031DumpPhyReg(interface);
 
   //Select single-LED mode
   value = ksz9031ReadMmdReg(interface, KSZ9031_COMMON_CTRL);
   value |= KSZ9031_COMMON_CTRL_LED_MODE_OVERRIDE;
   ksz9031WriteMmdReg(interface, KSZ9031_COMMON_CTRL, value);
 
   //Change the FLP interval to 16ms (silicon errata workaround 5)
   ksz9031WriteMmdReg(interface, KSZ9031_AN_FLP_BURST_TRANSMIT_HI, 0x0006);
   ksz9031WriteMmdReg(interface, KSZ9031_AN_FLP_BURST_TRANSMIT_LO, 0x1A80);
 
   //Restart auto-negotiation for the 16ms FLP interval setting to take effect
   ksz9031WritePhyReg(interface, KSZ9031_BMCR, KSZ9031_BMCR_AN_EN |
      KSZ9031_BMCR_RESTART_AN);
 
   //The PHY will generate interrupts when link status changes are detected
   ksz9031WritePhyReg(interface, KSZ9031_ICSR, KSZ9031_ICSR_LINK_DOWN_IE |
      KSZ9031_ICSR_LINK_UP_IE);
 
   //Perform custom configuration
   ksz9031InitHook(interface);
 
   //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 KSZ9031 custom configuration
 * @param[in] interface Underlying network interface
 **/
 
__weak_func void ksz9031InitHook(NetInterface *interface)
{
}
 
 
/**
 * @brief KSZ9031 timer handler
 * @param[in] interface Underlying network interface
 **/
 
void ksz9031Tick(NetInterface *interface)
{
   uint16_t value;
   bool_t linkState;
 
   //No external interrupt line driver?
   if(interface->extIntDriver == NULL)
   {
      //Read basic status register
      value = ksz9031ReadPhyReg(interface, KSZ9031_BMSR);
      //Retrieve current link state
      linkState = (value & KSZ9031_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 ksz9031EnableIrq(NetInterface *interface)
{
   //Enable PHY transceiver interrupts
   if(interface->extIntDriver != NULL)
   {
      interface->extIntDriver->enableIrq();
   }
}
 
 
/**
 * @brief Disable interrupts
 * @param[in] interface Underlying network interface
 **/
 
void ksz9031DisableIrq(NetInterface *interface)
{
   //Disable PHY transceiver interrupts
   if(interface->extIntDriver != NULL)
   {
      interface->extIntDriver->disableIrq();
   }
}
 
 
/**
 * @brief KSZ9031 event handler
 * @param[in] interface Underlying network interface
 **/
 
void ksz9031EventHandler(NetInterface *interface)
{
   uint16_t value;
 
   //Read status register to acknowledge the interrupt
   value = ksz9031ReadPhyReg(interface, KSZ9031_ICSR);
 
   //Link status change?
   if((value & (KSZ9031_ICSR_LINK_DOWN_IF | KSZ9031_ICSR_LINK_UP_IF)) != 0)
   {
      //Any link failure condition is latched in the BMSR register. Reading
      //the register twice will always return the actual link status
      value = ksz9031ReadPhyReg(interface, KSZ9031_BMSR);
      value = ksz9031ReadPhyReg(interface, KSZ9031_BMSR);
 
      //Link is up?
      if((value & KSZ9031_BMSR_LINK_STATUS) != 0)
      {
         //Read PHY control register
         value = ksz9031ReadPhyReg(interface, KSZ9031_PHYCON);
 
         //Check current speed
         if((value & KSZ9031_PHYCON_SPEED_1000BT) != 0)
         {
            //1000BASE-T
            interface->linkSpeed = NIC_LINK_SPEED_1GBPS;
         }
         else if((value & KSZ9031_PHYCON_SPEED_100BTX) != 0)
         {
            //100BASE-TX
            interface->linkSpeed = NIC_LINK_SPEED_100MBPS;
         }
         else if((value & KSZ9031_PHYCON_SPEED_10BT) != 0)
         {
            //10BASE-T
            interface->linkSpeed = NIC_LINK_SPEED_10MBPS;
         }
         else
         {
            //Debug message
            TRACE_WARNING("Invalid speed!\r\n");
         }
 
         //Check current duplex mode
         if((value & KSZ9031_PHYCON_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 ksz9031WritePhyReg(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 ksz9031ReadPhyReg(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 ksz9031DumpPhyReg(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,
         ksz9031ReadPhyReg(interface, i));
   }
 
   //Terminate with a line feed
   TRACE_DEBUG("\r\n");
}
 
 
/**
 * @brief Write MMD register
 * @param[in] interface Underlying network interface
 * @param[in] devAddr Device address
 * @param[in] regAddr Register address
 * @param[in] data MMD register value
 **/
 
void ksz9031WriteMmdReg(NetInterface *interface, uint8_t devAddr,
   uint16_t regAddr, uint16_t data)
{
   //Select register operation
   ksz9031WritePhyReg(interface, KSZ9031_MMDACR,
      KSZ9031_MMDACR_FUNC_ADDR | (devAddr & KSZ9031_MMDACR_DEVAD));
 
   //Write MMD register address
   ksz9031WritePhyReg(interface, KSZ9031_MMDAADR, regAddr);
 
   //Select data operation
   ksz9031WritePhyReg(interface, KSZ9031_MMDACR,
      KSZ9031_MMDACR_FUNC_DATA_NO_POST_INC | (devAddr & KSZ9031_MMDACR_DEVAD));
 
   //Write the content of the MMD register
   ksz9031WritePhyReg(interface, KSZ9031_MMDAADR, data);
}
 
 
/**
 * @brief Read MMD register
 * @param[in] interface Underlying network interface
 * @param[in] devAddr Device address
 * @param[in] regAddr Register address
 * @return MMD register value
 **/
 
uint16_t ksz9031ReadMmdReg(NetInterface *interface, uint8_t devAddr,
   uint16_t regAddr)
{
   //Select register operation
   ksz9031WritePhyReg(interface, KSZ9031_MMDACR,
      KSZ9031_MMDACR_FUNC_ADDR | (devAddr & KSZ9031_MMDACR_DEVAD));
 
   //Write MMD register address
   ksz9031WritePhyReg(interface, KSZ9031_MMDAADR, regAddr);
 
   //Select data operation
   ksz9031WritePhyReg(interface, KSZ9031_MMDACR,
      KSZ9031_MMDACR_FUNC_DATA_NO_POST_INC | (devAddr & KSZ9031_MMDACR_DEVAD));
 
   //Read the content of the MMD register
   return ksz9031ReadPhyReg(interface, KSZ9031_MMDAADR);
}