/**
 * @file enc424j600_driver.c
 * @brief ENC424J600 Ethernet controller
 *
 * @section License
 *
 * Copyright (C) 2021-2026 Oryx Embedded SARL. All rights reserved.
 *
 * This file is part of CycloneTCP Open
 * 
 * SPDX-License-Identifier: GPL-2.0-or-later
 *
 * 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.6.0
 **/

//Switch to the appropriate trace level
#define TRACE_LEVEL NIC_TRACE_LEVEL

//Dependencies
#include "core/net.h"
#include "drivers/eth/enc424j600_driver.h"
#include "debug.h"


/**
 * @brief ENC424J600 driver
 **/

const NicDriver enc424j600Driver =
{
   NIC_TYPE_ETHERNET,
   ETH_MTU,
   enc424j600Init,
   enc424j600Tick,
   enc424j600EnableIrq,
   enc424j600DisableIrq,
   enc424j600EventHandler,
   enc424j600SendPacket,
   enc424j600UpdateMacAddrFilter,
   NULL,
   NULL,
   NULL,
   TRUE,
   TRUE,
   TRUE,
   FALSE
};


/**
 * @brief ENC424J600 controller initialization
 * @param[in] interface Underlying network interface
 * @return Error code
 **/

error_t enc424j600Init(NetInterface *interface)
{
   uint16_t temp;
   Enc624j600Context *context;

   //Debug message
   TRACE_INFO("Initializing ENC424J600 Ethernet controller...\r\n");

   //Initialize SPI interface
   interface->spiDriver->init();

   //Initialize external interrupt line driver
   if(interface->extIntDriver != NULL)
   {
      interface->extIntDriver->init();
   }

   //Point to the driver context
   context = (Enc624j600Context *) interface->nicContext;

   //Initialize driver specific variables
   context->nextPacket = ENC424J600_RX_BUFFER_START;

   //Issue a system reset
   enc424j600SoftReset(interface);

   //Disable CLKOUT output
   enc424j600WriteReg(interface, ENC424J600_ECON2, ENC424J600_ECON2_ETHEN |
      ENC424J600_ECON2_STRCH);

   //Optionally set the station MAC address
   if(macCompAddr(&interface->macAddr, &MAC_UNSPECIFIED_ADDR))
   {
      //Use the factory preprogrammed station address
      temp = enc424j600ReadReg(interface, ENC424J600_MAADR1);
      interface->macAddr.w[0] = letoh16(temp);
      temp = enc424j600ReadReg(interface, ENC424J600_MAADR2);
      interface->macAddr.w[1] = letoh16(temp);
      temp = enc424j600ReadReg(interface, ENC424J600_MAADR3);
      interface->macAddr.w[2] = letoh16(temp);

      //Generate the 64-bit interface identifier
      macAddrToEui64(&interface->macAddr, &interface->eui64);
   }
   else
   {
      //Override the factory preprogrammed address
      temp = htole16(interface->macAddr.w[0]);
      enc424j600WriteReg(interface, ENC424J600_MAADR1, temp);
      temp = htole16(interface->macAddr.w[1]);
      enc424j600WriteReg(interface, ENC424J600_MAADR2, temp);
      temp = htole16(interface->macAddr.w[2]);
      enc424j600WriteReg(interface, ENC424J600_MAADR3, temp);
   }

   //Set receive buffer location
   enc424j600WriteReg(interface, ENC424J600_ERXST, ENC424J600_RX_BUFFER_START);
   //Program the tail pointer ERXTAIL to the last even address of the buffer
   enc424j600WriteReg(interface, ENC424J600_ERXTAIL, ENC424J600_RX_BUFFER_STOP);

   //Configure the receive filters
   enc424j600WriteReg(interface, ENC424J600_ERXFCON, ENC424J600_ERXFCON_HTEN |
      ENC424J600_ERXFCON_CRCEN | ENC424J600_ERXFCON_RUNTEN |
      ENC424J600_ERXFCON_UCEN | ENC424J600_ERXFCON_BCEN);

   //Initialize the hash table
   enc424j600WriteReg(interface, ENC424J600_EHT1, 0x0000);
   enc424j600WriteReg(interface, ENC424J600_EHT2, 0x0000);
   enc424j600WriteReg(interface, ENC424J600_EHT3, 0x0000);
   enc424j600WriteReg(interface, ENC424J600_EHT4, 0x0000);

   //All short frames will be zero-padded to 60 bytes and a valid CRC is then
   //appended
   enc424j600WriteReg(interface, ENC424J600_MACON2, ENC424J600_MACON2_DEFER |
      ENC424J600_MACON2_PADCFG_AUTO | ENC424J600_MACON2_TXCRCEN |
      ENC424J600_MACON2_R1_DEFAULT);

   //Program the MAMXFL register with the maximum frame length to be accepted
   enc424j600WriteReg(interface, ENC424J600_MAMXFL,
      ENC424J600_ETH_RX_BUFFER_SIZE);

   //PHY initialization
   enc424j600WritePhyReg(interface, ENC424J600_PHANA, ENC424J600_PHANA_ADPAUS0 |
      ENC424J600_PHANA_AD100FD | ENC424J600_PHANA_AD100 | ENC424J600_PHANA_AD10FD |
      ENC424J600_PHANA_AD10 | ENC424J600_PHANA_ADIEEE_DEFAULT);

   //Clear interrupt flags
   enc424j600WriteReg(interface, ENC424J600_EIR, 0x0000);

   //Configure interrupts as desired
   enc424j600WriteReg(interface, ENC424J600_EIE, ENC424J600_EIE_INTIE |
      ENC424J600_EIE_LINKIE | ENC424J600_EIE_PKTIE | ENC424J600_EIE_TXIE |
      ENC424J600_EIE_TXABTIE);

   //Set RXEN to enable reception
   enc424j600SetBit(interface, ENC424J600_ECON1, ENC424J600_ECON1_RXEN);

   //Perform custom configuration
   enc424j600InitHook(interface);

   //Dump registers for debugging purpose
   enc424j600DumpReg(interface);
   enc424j600DumpPhyReg(interface);

   //Accept any packets from the upper layer
   osSetEvent(&interface->nicTxEvent);

   //Force the TCP/IP stack to poll the link state at startup
   interface->nicEvent = TRUE;
   //Notify the TCP/IP stack of the event
   osSetEvent(&interface->netContext->event);

   //Successful initialization
   return NO_ERROR;
}


/**
 * @brief ENC424J600 custom configuration
 * @param[in] interface Underlying network interface
 **/

__weak_func void enc424j600InitHook(NetInterface *interface)
{
}


/**
 * @brief ENC424J600 timer handler
 * @param[in] interface Underlying network interface
 **/

void enc424j600Tick(NetInterface *interface)
{
}


/**
 * @brief Enable interrupts
 * @param[in] interface Underlying network interface
 **/

void enc424j600EnableIrq(NetInterface *interface)
{
   //Enable interrupts
   if(interface->extIntDriver != NULL)
   {
      interface->extIntDriver->enableIrq();
   }
}


/**
 * @brief Disable interrupts
 * @param[in] interface Underlying network interface
 **/

void enc424j600DisableIrq(NetInterface *interface)
{
   //Disable interrupts
   if(interface->extIntDriver != NULL)
   {
      interface->extIntDriver->disableIrq();
   }
}


/**
 * @brief ENC424J600 interrupt service routine
 * @param[in] interface Underlying network interface
 * @return TRUE if a higher priority task must be woken. Else FALSE is returned
 **/

bool_t enc424j600IrqHandler(NetInterface *interface)
{
   bool_t flag;
   uint16_t status;

   //This flag will be set if a higher priority task must be woken
   flag = FALSE;

   //Clear the INTIE bit, immediately after an interrupt event
   enc424j600ClearBit(interface, ENC424J600_EIE, ENC424J600_EIE_INTIE);

   //Read interrupt status register
   status = enc424j600ReadReg(interface, ENC424J600_EIR);

   //Link status change?
   if((status & ENC424J600_EIR_LINKIF) != 0)
   {
      //Disable LINKIE interrupt
      enc424j600ClearBit(interface, ENC424J600_EIE, ENC424J600_EIE_LINKIE);

      //Set event flag
      interface->nicEvent = TRUE;
      //Notify the TCP/IP stack of the event
      flag |= osSetEventFromIsr(&interface->netContext->event);
   }

   //Packet received?
   if((status & ENC424J600_EIR_PKTIF) != 0)
   {
      //Disable PKTIE interrupt
      enc424j600ClearBit(interface, ENC424J600_EIE, ENC424J600_EIE_PKTIE);

      //Set event flag
      interface->nicEvent = TRUE;
      //Notify the TCP/IP stack of the event
      flag |= osSetEventFromIsr(&interface->netContext->event);
   }

   //Packet transmission complete?
   if((status & (ENC424J600_EIR_TXIF | ENC424J600_EIR_TXABTIF)) != 0)
   {
      //Clear interrupt flags
      enc424j600ClearBit(interface, ENC424J600_EIR, ENC424J600_EIR_TXIF |
         ENC424J600_EIR_TXABTIF);

      //Notify the TCP/IP stack that the transmitter is ready to send
      flag |= osSetEventFromIsr(&interface->nicTxEvent);
   }

   //Once the interrupt has been serviced, the INTIE bit is set again to
   //re-enable interrupts
   enc424j600SetBit(interface, ENC424J600_EIE, ENC424J600_EIE_INTIE);

   //A higher priority task must be woken?
   return flag;
}


/**
 * @brief ENC424J600 event handler
 * @param[in] interface Underlying network interface
 **/

void enc424j600EventHandler(NetInterface *interface)
{
   error_t error;
   uint16_t status;
   uint16_t value;

   //Read interrupt status register
   status = enc424j600ReadReg(interface, ENC424J600_EIR);

   //Check whether the link state has changed
   if((status & ENC424J600_EIR_LINKIF) != 0)
   {
      //Clear interrupt flag
      enc424j600ClearBit(interface, ENC424J600_EIR, ENC424J600_EIR_LINKIF);
      //Read Ethernet status register
      value = enc424j600ReadReg(interface, ENC424J600_ESTAT);

      //Check link state
      if((value & ENC424J600_ESTAT_PHYLNK) != 0)
      {
         //Read PHY status register 3
         value = enc424j600ReadPhyReg(interface, ENC424J600_PHSTAT3);

         //Get current speed
         if((value & ENC424J600_PHSTAT3_SPDDPX1) != 0)
         {
            interface->linkSpeed = NIC_LINK_SPEED_100MBPS;
         }
         else
         {
            interface->linkSpeed = NIC_LINK_SPEED_10MBPS;
         }

         //Determine the new duplex mode
         if((value & ENC424J600_PHSTAT3_SPDDPX2) != 0)
         {
            interface->duplexMode = NIC_FULL_DUPLEX_MODE;
         }
         else
         {
            interface->duplexMode = NIC_HALF_DUPLEX_MODE;
         }

         //Link is up
         interface->linkState = TRUE;

         //Update MAC configuration parameters for proper operation
         enc424j600UpdateMacConfig(interface);
      }
      else
      {
         //Link is down
         interface->linkState = FALSE;
      }

      //Process link state change event
      nicNotifyLinkChange(interface);
   }

   //Check whether a packet has been received?
   if((status & ENC424J600_EIR_PKTIF) != 0)
   {
      //Clear interrupt flag
      enc424j600ClearBit(interface, ENC424J600_EIR, ENC424J600_EIR_PKTIF);

      //Process all pending packets
      do
      {
         //Read incoming packet
         error = enc424j600ReceivePacket(interface);

         //No more data in the receive buffer?
      } while(error != ERROR_BUFFER_EMPTY);
   }

   //Re-enable LINKIE and PKTIE interrupts
   enc424j600SetBit(interface, ENC424J600_EIE, ENC424J600_EIE_LINKIE |
      ENC424J600_EIE_PKTIE);
}


/**
 * @brief Send a packet
 * @param[in] interface Underlying network interface
 * @param[in] buffer Multi-part buffer containing the data to send
 * @param[in] offset Offset to the first data byte
 * @param[in] ancillary Additional options passed to the stack along with
 *   the packet
 * @return Error code
 **/

error_t enc424j600SendPacket(NetInterface *interface,
   const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
{
   size_t length;

   //Retrieve the length of the packet
   length = netBufferGetLength(buffer) - offset;

   //Check the frame length
   if(length > 1536)
   {
      //The transmitter can accept another packet
      osSetEvent(&interface->nicTxEvent);
      //Report an error
      return ERROR_INVALID_LENGTH;
   }

   //Make sure the link is up before transmitting the frame
   if(!interface->linkState)
   {
      //The transmitter can accept another packet
      osSetEvent(&interface->nicTxEvent);
      //Drop current packet
      return NO_ERROR;
   }

   //Ensure that the transmitter is ready to send
   if(enc424j600ReadReg(interface, ENC424J600_ECON1) & ENC424J600_ECON1_TXRTS)
   {
      return ERROR_FAILURE;
   }

   //Point to the SRAM buffer
   enc424j600WriteReg(interface, ENC424J600_EGPWRPT, ENC424J600_TX_BUFFER_START);
   //Copy the packet to the SRAM buffer
   enc424j600WriteBuffer(interface, ENC424J600_CMD_WGPDATA, buffer, offset);

   //Program ETXST to the start address of the packet
   enc424j600WriteReg(interface, ENC424J600_ETXST, ENC424J600_TX_BUFFER_START);
   //Program ETXLEN with the length of data copied to the memory
   enc424j600WriteReg(interface, ENC424J600_ETXLEN, length);

   //Clear TXIF and TXABTIF interrupt flags
   enc424j600ClearBit(interface, ENC424J600_EIR, ENC424J600_EIR_TXIF |
      ENC424J600_EIR_TXABTIF);

   //Set the TXRTS bit to initiate transmission
   enc424j600SetBit(interface, ENC424J600_ECON1, ENC424J600_ECON1_TXRTS);

   //Successful processing
   return NO_ERROR;
}


/**
 * @brief Receive a packet
 * @param[in] interface Underlying network interface
 * @return Error code
 **/

error_t enc424j600ReceivePacket(NetInterface *interface)
{
   static uint8_t temp[ENC424J600_ETH_RX_BUFFER_SIZE];
   error_t error;
   uint16_t length;
   uint32_t status;
   uint8_t header[8];
   Enc624j600Context *context;

   //Point to the driver context
   context = (Enc624j600Context *) interface->nicContext;

   //Verify that a packet is waiting by ensuring that PKTCNT is non-zero
   if(enc424j600ReadReg(interface, ENC424J600_ESTAT) & ENC424J600_ESTAT_PKTCNT)
   {
      //Point to the next packet
      enc424j600WriteReg(interface, ENC424J600_ERXRDPT, context->nextPacket);

      //The packet is preceded by a 8-byte header
      enc424j600ReadBuffer(interface, ENC424J600_CMD_RRXDATA, header,
         sizeof(header));

      //The first two bytes are the address of the next packet
      context->nextPacket = LOAD16LE(header);
      //Get the length of the received packet
      length = LOAD16LE(header + 2);
      //Get the receive status vector (RSV)
      status = LOAD32LE(header + 4);

      //Make sure no error occurred
      if((status & ENC424J600_RSV_RECEIVED_OK) != 0)
      {
         //Limit the number of data to read
         length = MIN(length, ENC424J600_ETH_RX_BUFFER_SIZE);
         //Read packet data
         enc424j600ReadBuffer(interface, ENC424J600_CMD_RRXDATA, temp, length);

         //Valid packet received
         error = NO_ERROR;
      }
      else
      {
         //The received packet contains an error
         error = ERROR_INVALID_PACKET;
      }

      //Update the ERXTAIL pointer value to the point where the packet has
      //been processed, taking care to wrap back at the end of the received
      //memory buffer
      if(context->nextPacket == ENC424J600_RX_BUFFER_START)
      {
         enc424j600WriteReg(interface, ENC424J600_ERXTAIL,
            ENC424J600_RX_BUFFER_STOP);
      }
      else
      {
         enc424j600WriteReg(interface, ENC424J600_ERXTAIL,
            context->nextPacket - 2);
      }

      //Set PKTDEC to decrement the PKTCNT bits
      enc424j600SetBit(interface, ENC424J600_ECON1, ENC424J600_ECON1_PKTDEC);
   }
   else
   {
      //No more data in the receive buffer
      error = ERROR_BUFFER_EMPTY;
   }

   //Check whether a valid packet has been received
   if(!error)
   {
      NetRxAncillary ancillary;

      //Additional options can be passed to the stack along with the packet
      ancillary = NET_DEFAULT_RX_ANCILLARY;

      //Pass the packet to the upper layer
      nicProcessPacket(interface, temp, length, &ancillary);
   }

   //Return status code
   return error;
}


/**
 * @brief Configure MAC address filtering
 * @param[in] interface Underlying network interface
 * @return Error code
 **/

error_t enc424j600UpdateMacAddrFilter(NetInterface *interface)
{
   uint_t i;
   uint_t k;
   uint32_t crc;
   uint16_t hashTable[4];
   MacFilterEntry *entry;

   //Debug message
   TRACE_DEBUG("Updating MAC filter...\r\n");

   //Clear hash table
   osMemset(hashTable, 0, sizeof(hashTable));

   //The MAC address filter contains the list of MAC addresses to accept
   //when receiving an Ethernet frame
   for(i = 0; i < MAC_ADDR_FILTER_SIZE; i++)
   {
      //Point to the current entry
      entry = &interface->macAddrFilter[i];

      //Valid entry?
      if(entry->refCount > 0)
      {
         //Compute CRC over the current MAC address
         crc = enc424j600CalcCrc(&entry->addr, sizeof(MacAddr));
         //Calculate the corresponding index in the table
         k = (crc >> 23) & 0x3F;
         //Update hash table contents
         hashTable[k / 16] |= (1 << (k % 16));
      }
   }

   //Write the hash table to the ENC424J600 controller
   enc424j600WriteReg(interface, ENC424J600_EHT1, hashTable[0]);
   enc424j600WriteReg(interface, ENC424J600_EHT2, hashTable[1]);
   enc424j600WriteReg(interface, ENC424J600_EHT3, hashTable[2]);
   enc424j600WriteReg(interface, ENC424J600_EHT4, hashTable[3]);

   //Debug message
   TRACE_DEBUG("  EHT1 = %04" PRIX16 "\r\n", enc424j600ReadReg(interface, ENC424J600_EHT1));
   TRACE_DEBUG("  EHT2 = %04" PRIX16 "\r\n", enc424j600ReadReg(interface, ENC424J600_EHT2));
   TRACE_DEBUG("  EHT3 = %04" PRIX16 "\r\n", enc424j600ReadReg(interface, ENC424J600_EHT3));
   TRACE_DEBUG("  EHT4 = %04" PRIX16 "\r\n", enc424j600ReadReg(interface, ENC424J600_EHT4));

   //Successful processing
   return NO_ERROR;
}


/**
 * @brief Adjust MAC configuration parameters for proper operation
 * @param[in] interface Underlying network interface
 **/

void enc424j600UpdateMacConfig(NetInterface *interface)
{
   uint16_t duplexMode;

   //Determine the new duplex mode by reading the PHYDPX bit
   duplexMode = enc424j600ReadReg(interface, ENC424J600_ESTAT) & ENC424J600_ESTAT_PHYDPX;

   //Full-duplex mode?
   if(duplexMode)
   {
      //Configure the FULDPX bit to match the current duplex mode
      enc424j600WriteReg(interface, ENC424J600_MACON2, ENC424J600_MACON2_DEFER |
         ENC424J600_MACON2_PADCFG_AUTO | ENC424J600_MACON2_TXCRCEN |
         ENC424J600_MACON2_R1_DEFAULT | ENC424J600_MACON2_FULDPX);

      //Configure the Back-to-Back Inter-Packet Gap register
      enc424j600WriteReg(interface, ENC424J600_MABBIPG,
         ENC424J600_MABBIPG_BBIPG_DEFAULT_FD);
   }
   //Half-duplex mode?
   else
   {
      //Configure the FULDPX bit to match the current duplex mode
      enc424j600WriteReg(interface, ENC424J600_MACON2, ENC424J600_MACON2_DEFER |
         ENC424J600_MACON2_PADCFG_AUTO | ENC424J600_MACON2_TXCRCEN |
         ENC424J600_MACON2_R1_DEFAULT);

      //Configure the Back-to-Back Inter-Packet Gap register
      enc424j600WriteReg(interface, ENC424J600_MABBIPG,
         ENC424J600_MABBIPG_BBIPG_DEFAULT_HD);
   }
}


/**
 * @brief Reset ENC424J600 controller
 * @param[in] interface Underlying network interface
 * @return Error code
 **/

error_t enc424j600SoftReset(NetInterface *interface)
{
   //Wait for the SPI interface to be ready
   do
   {
      //Write 0x1234 to EUDAST
      enc424j600WriteReg(interface, ENC424J600_EUDAST, 0x1234);
      //Read back register and check contents
   } while(enc424j600ReadReg(interface, ENC424J600_EUDAST) != 0x1234);

   //Poll CLKRDY and wait for it to become set
   while((enc424j600ReadReg(interface, ENC424J600_ESTAT) & ENC424J600_ESTAT_CLKRDY) == 0)
   {
   }

   //Issue a system reset command by setting ETHRST
   enc424j600SetBit(interface, ENC424J600_ECON2, ENC424J600_ECON2_ETHRST);
   //Wait at least 25us for the reset to take place
   sleep(1);

   //Read EUDAST to confirm that the system reset took place. EUDAST should
   //have reverted back to its reset default
   if(enc424j600ReadReg(interface, ENC424J600_EUDAST) != 0x0000)
   {
      return ERROR_FAILURE;
   }

   //Wait at least 256us for the PHY registers and PHY status bits to become
   //available
   sleep(1);

   //The controller is now ready to accept further commands
   return NO_ERROR;
}


/**
 * @brief Write ENC424J600 register
 * @param[in] interface Underlying network interface
 * @param[in] address Register address
 * @param[in] data Register value
 **/

void enc424j600WriteReg(NetInterface *interface, uint8_t address,
   uint16_t data)
{
   //Pull the CS pin low
   interface->spiDriver->assertCs();

   //Write opcode
   interface->spiDriver->transfer(ENC424J600_CMD_WCRU);
   //Write register address
   interface->spiDriver->transfer(address);
   //Write register value
   interface->spiDriver->transfer(LSB(data));
   interface->spiDriver->transfer(MSB(data));

   //Terminate the operation by raising the CS pin
   interface->spiDriver->deassertCs();
}


/**
 * @brief Read ENC424J600 register
 * @param[in] interface Underlying network interface
 * @param[in] address Register address
 * @return Register value
 **/

uint16_t enc424j600ReadReg(NetInterface *interface, uint8_t address)
{
   uint16_t data;

   //Pull the CS pin low
   interface->spiDriver->assertCs();

   //Write opcode
   interface->spiDriver->transfer(ENC424J600_CMD_RCRU);
   //Write register address
   interface->spiDriver->transfer(address);
   //Read the lower 8 bits of data
   data = interface->spiDriver->transfer(0x00);
   //Read the upper 8 bits of data
   data |= interface->spiDriver->transfer(0x00) << 8;

   //Terminate the operation by raising the CS pin
   interface->spiDriver->deassertCs();

   //Return register contents
   return data;
}


/**
 * @brief Write PHY register
 * @param[in] interface Underlying network interface
 * @param[in] address PHY register address
 * @param[in] data Register value
 **/

void enc424j600WritePhyReg(NetInterface *interface, uint8_t address,
   uint16_t data)
{
   uint16_t status;

   //Write the address of the PHY register to write to
   enc424j600WriteReg(interface, ENC424J600_MIREGADR,
      ENC424J600_MIREGADR_R12_8_DEFAULT | address);

   //Write the 16 bits of data into the MIWR register
   enc424j600WriteReg(interface, ENC424J600_MIWR, data);

   //Wait until the PHY register has been written
   do
   {
      //Read MII Management Status register
      status = enc424j600ReadReg(interface, ENC424J600_MISTAT);
      //Check the value of the busy status bit
   } while((status & ENC424J600_MISTAT_BUSY) != 0);
}


/**
 * @brief Read PHY register
 * @param[in] interface Underlying network interface
 * @param[in] address PHY register address
 * @return Register value
 **/

uint16_t enc424j600ReadPhyReg(NetInterface *interface, uint8_t address)
{
   uint16_t status;

   //Write the address of the PHY register to read from
   enc424j600WriteReg(interface, ENC424J600_MIREGADR,
      ENC424J600_MIREGADR_R12_8_DEFAULT | address);

   //Start read operation
   enc424j600WriteReg(interface, ENC424J600_MICMD, ENC424J600_MICMD_MIIRD);

   //Wait at least 25.6us before polling the BUSY bit
   usleep(100);

   //Wait for the read operation to complete
   do
   {
      //Read MII Management Status register
      status = enc424j600ReadReg(interface, ENC424J600_MISTAT);
      //Check the value of the busy status bit
   } while((status & ENC424J600_MISTAT_BUSY) != 0);

   //Clear command register
   enc424j600WriteReg(interface, ENC424J600_MICMD, 0x00);

   //Return register contents
   return enc424j600ReadReg(interface, ENC424J600_MIRD);
}


/**
 * @brief Write SRAM buffer
 * @param[in] interface Underlying network interface
 * @param[in] opcode SRAM buffer operation
 * @param[in] buffer Multi-part buffer containing the data to be written
 * @param[in] offset Offset to the first data byte
 **/

void enc424j600WriteBuffer(NetInterface *interface,
   uint8_t opcode, const NetBuffer *buffer, size_t offset)
{
   uint_t i;
   size_t j;
   size_t n;
   uint8_t *p;

   //Pull the CS pin low
   interface->spiDriver->assertCs();

   //Write opcode
   interface->spiDriver->transfer(opcode);

   //Loop through data chunks
   for(i = 0; i < buffer->chunkCount; i++)
   {
      //Is there any data to copy from the current chunk?
      if(offset < buffer->chunk[i].length)
      {
         //Point to the first byte to be read
         p = (uint8_t *) buffer->chunk[i].address + offset;
         //Compute the number of bytes to copy at a time
         n = buffer->chunk[i].length - offset;

         //Copy data to SRAM buffer
         for(j = 0; j < n; j++)
         {
            interface->spiDriver->transfer(p[j]);
         }

         //Process the next block from the start
         offset = 0;
      }
      else
      {
         //Skip the current chunk
         offset -= buffer->chunk[i].length;
      }
   }

   //Terminate the operation by raising the CS pin
   interface->spiDriver->deassertCs();
}


/**
 * @brief Read SRAM buffer
 * @param[in] interface Underlying network interface
 * @param[in] opcode SRAM buffer operation
 * @param[out] data Buffer where to store the incoming data
 * @param[in] length Number of data to read
 **/

void enc424j600ReadBuffer(NetInterface *interface,
   uint8_t opcode, uint8_t *data, size_t length)
{
   size_t i;

   //Pull the CS pin low
   interface->spiDriver->assertCs();

   //Write opcode
   interface->spiDriver->transfer(opcode);

   //Copy data from SRAM buffer
   for(i = 0; i < length; i++)
   {
      data[i] = interface->spiDriver->transfer(0x00);
   }

   //Terminate the operation by raising the CS pin
   interface->spiDriver->deassertCs();
}


/**
 * @brief Set bit field
 * @param[in] interface Underlying network interface
 * @param[in] address Register address
 * @param[in] mask Bits to set in the target register
 **/

void enc424j600SetBit(NetInterface *interface, uint8_t address,
   uint16_t mask)
{
   //Pull the CS pin low
   interface->spiDriver->assertCs();

   //Write opcode
   interface->spiDriver->transfer(ENC424J600_CMD_BFSU);
   //Write register address
   interface->spiDriver->transfer(address);
   //Write bit mask
   interface->spiDriver->transfer(LSB(mask));
   interface->spiDriver->transfer(MSB(mask));

   //Terminate the operation by raising the CS pin
   interface->spiDriver->deassertCs();
}


/**
 * @brief Clear bit field
 * @param[in] interface Underlying network interface
 * @param[in] address Register address
 * @param[in] mask Bits to clear in the target register
 **/

void enc424j600ClearBit(NetInterface *interface, uint8_t address,
   uint16_t mask)
{
   //Pull the CS pin low
   interface->spiDriver->assertCs();

   //Write opcode
   interface->spiDriver->transfer(ENC424J600_CMD_BFCU);
   //Write register address
   interface->spiDriver->transfer(address);
   //Write bit mask
   interface->spiDriver->transfer(LSB(mask));
   interface->spiDriver->transfer(MSB(mask));

   //Terminate the operation by raising the CS pin
   interface->spiDriver->deassertCs();
}


/**
 * @brief CRC calculation using the polynomial 0x4C11DB7
 * @param[in] data Pointer to the data over which to calculate the CRC
 * @param[in] length Number of bytes to process
 * @return Resulting CRC value
 **/

uint32_t enc424j600CalcCrc(const void *data, size_t length)
{
   uint_t i;
   uint_t j;
   uint32_t crc;
   const uint8_t *p;

   //Point to the data over which to calculate the CRC
   p = (uint8_t *) data;
   //CRC preset value
   crc = 0xFFFFFFFF;

   //Loop through data
   for(i = 0; i < length; i++)
   {
      //The message is processed bit by bit
      for(j = 0; j < 8; j++)
      {
         //Update CRC value
         if((((crc >> 31) ^ (p[i] >> j)) & 0x01) != 0)
         {
            crc = (crc << 1) ^ 0x04C11DB7;
         }
         else
         {
            crc = crc << 1;
         }
      }
   }

   //Return CRC value
   return crc;
}


/**
 * @brief Dump registers for debugging purpose
 * @param[in] interface Underlying network interface
 **/

void enc424j600DumpReg(NetInterface *interface)
{
#if (TRACE_LEVEL >= TRACE_LEVEL_DEBUG)
   uint8_t i;
   uint8_t bank;
   uint16_t address;

   //Display header
   TRACE_DEBUG("    Bank 0  Bank 1  Bank 2  Bank 3  Unbanked\r\n");

   //Loop through register addresses
   for(i = 0; i < 32; i += 2)
   {
      //Display register address
      TRACE_DEBUG("%02" PRIX8 ": ", i);

      //Loop through bank numbers
      for(bank = 0; bank < 5; bank++)
      {
         //Format register address
         address = 0x7E00 | (bank << 5) | i;
         //Display register contents
         TRACE_DEBUG("0x%04" PRIX16 "  ", enc424j600ReadReg(interface, address));
      }

      //Jump to the following line
      TRACE_DEBUG("\r\n");
   }

   //Terminate with a line feed
   TRACE_DEBUG("\r\n");
#endif
}


/**
 * @brief Dump PHY registers for debugging purpose
 * @param[in] interface Underlying network interface
 **/

void enc424j600DumpPhyReg(NetInterface *interface)
{
#if (TRACE_LEVEL >= TRACE_LEVEL_DEBUG)
   uint8_t i;

   //Loop through PHY registers
   for(i = 0; i < 32; i++)
   {
      //Display current PHY register
      TRACE_DEBUG("%02" PRIX8 ": 0x%04" PRIX16 "\r\n", i, enc424j600ReadPhyReg(interface, i));
   }

   //Terminate with a line feed
   TRACE_DEBUG("\r\n");
#endif
}
