doc/ksz8031__driver_8h_source.html

/**

 * @file ksz8031_driver.h

 * @brief KSZ8031 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 _KSZ8031_DRIVER_H

#define _KSZ8031_DRIVER_H


//Dependencies

#include "core/nic.h"


//PHY address

#ifndef KSZ8031_PHY_ADDR

   #define KSZ8031_PHY_ADDR 0

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

   #error KSZ8031_PHY_ADDR parameter is not valid

#endif


//KSZ8031 PHY registers

#define KSZ8031_BMCR                        0x00

#define KSZ8031_BMSR                        0x01

#define KSZ8031_PHYID1                      0x02

#define KSZ8031_PHYID2                      0x03

#define KSZ8031_ANAR                        0x04

#define KSZ8031_ANLPAR                      0x05

#define KSZ8031_ANER                        0x06

#define KSZ8031_ANNPR                       0x07

#define KSZ8031_ANLPNPR                     0x08

#define KSZ8031_DRCON                       0x10

#define KSZ8031_AFECON1                     0x11

#define KSZ8031_RXERCTR                     0x15

#define KSZ8031_OMSO                        0x16

#define KSZ8031_OMSS                        0x17

#define KSZ8031_EXCON                       0x18

#define KSZ8031_ICSR                        0x1B

#define KSZ8031_LINKMD                      0x1D

#define KSZ8031_PHYCON1                     0x1E

#define KSZ8031_PHYCON2                     0x1F


//Basic Control register

#define KSZ8031_BMCR_RESET                  0x8000

#define KSZ8031_BMCR_LOOPBACK               0x4000

#define KSZ8031_BMCR_SPEED_SEL              0x2000

#define KSZ8031_BMCR_AN_EN                  0x1000

#define KSZ8031_BMCR_POWER_DOWN             0x0800

#define KSZ8031_BMCR_ISOLATE                0x0400

#define KSZ8031_BMCR_RESTART_AN             0x0200

#define KSZ8031_BMCR_DUPLEX_MODE            0x0100

#define KSZ8031_BMCR_COL_TEST               0x0080


//Basic Status register

#define KSZ8031_BMSR_100BT4                 0x8000

#define KSZ8031_BMSR_100BTX_FD              0x4000

#define KSZ8031_BMSR_100BTX_HD              0x2000

#define KSZ8031_BMSR_10BT_FD                0x1000

#define KSZ8031_BMSR_10BT_HD                0x0800

#define KSZ8031_BMSR_NO_PREAMBLE            0x0040

#define KSZ8031_BMSR_AN_COMPLETE            0x0020

#define KSZ8031_BMSR_REMOTE_FAULT           0x0010

#define KSZ8031_BMSR_AN_CAPABLE             0x0008

#define KSZ8031_BMSR_LINK_STATUS            0x0004

#define KSZ8031_BMSR_JABBER_DETECT          0x0002

#define KSZ8031_BMSR_EXTENDED_CAPABLE       0x0001


//PHY Identifier 1 register

#define KSZ8031_PHYID1_PHY_ID_MSB           0xFFFF

#define KSZ8031_PHYID1_PHY_ID_MSB_DEFAULT   0x0022


//PHY Identifier 2 register

#define KSZ8031_PHYID2_PHY_ID_LSB           0xFC00

#define KSZ8031_PHYID2_PHY_ID_LSB_DEFAULT   0x1400

#define KSZ8031_PHYID2_MODEL_NUM            0x03F0

#define KSZ8031_PHYID2_MODEL_NUM_DEFAULT    0x0150

#define KSZ8031_PHYID2_REVISION_NUM         0x000F


//Auto-Negotiation Advertisement register

#define KSZ8031_ANAR_NEXT_PAGE              0x8000

#define KSZ8031_ANAR_REMOTE_FAULT           0x2000

#define KSZ8031_ANAR_PAUSE                  0x0C00

#define KSZ8031_ANAR_100BT4                 0x0200

#define KSZ8031_ANAR_100BTX_FD              0x0100

#define KSZ8031_ANAR_100BTX_HD              0x0080

#define KSZ8031_ANAR_10BT_FD                0x0040

#define KSZ8031_ANAR_10BT_HD                0x0020

#define KSZ8031_ANAR_SELECTOR               0x001F

#define KSZ8031_ANAR_SELECTOR_DEFAULT       0x0001


//Auto-Negotiation Link Partner Ability register

#define KSZ8031_ANLPAR_NEXT_PAGE            0x8000

#define KSZ8031_ANLPAR_ACK                  0x4000

#define KSZ8031_ANLPAR_REMOTE_FAULT         0x2000

#define KSZ8031_ANLPAR_PAUSE                0x0C00

#define KSZ8031_ANLPAR_100BT4               0x0200

#define KSZ8031_ANLPAR_100BTX_FD            0x0100

#define KSZ8031_ANLPAR_100BTX_HD            0x0080

#define KSZ8031_ANLPAR_10BT_FD              0x0040

#define KSZ8031_ANLPAR_10BT_HD              0x0020

#define KSZ8031_ANLPAR_SELECTOR             0x001F

#define KSZ8031_ANLPAR_SELECTOR_DEFAULT     0x0001


//Auto-Negotiation Expansion register

#define KSZ8031_ANER_PAR_DETECT_FAULT       0x0010

#define KSZ8031_ANER_LP_NEXT_PAGE_ABLE      0x0008

#define KSZ8031_ANER_NEXT_PAGE_ABLE         0x0004

#define KSZ8031_ANER_PAGE_RECEIVED          0x0002

#define KSZ8031_ANER_LP_AN_ABLE             0x0001


//Auto-Negotiation Next Page register

#define KSZ8031_ANNPR_NEXT_PAGE             0x8000

#define KSZ8031_ANNPR_MSG_PAGE              0x2000

#define KSZ8031_ANNPR_ACK2                  0x1000

#define KSZ8031_ANNPR_TOGGLE                0x0800

#define KSZ8031_ANNPR_MESSAGE               0x07FF


//Link Partner Next Page Ability register

#define KSZ8031_ANLPNPR_NEXT_PAGE           0x8000

#define KSZ8031_ANLPNPR_ACK                 0x4000

#define KSZ8031_ANLPNPR_MSG_PAGE            0x2000

#define KSZ8031_ANLPNPR_ACK2                0x1000

#define KSZ8031_ANLPNPR_TOGGLE              0x0800

#define KSZ8031_ANLPNPR_MESSAGE             0x07FF


//Digital Reserved Control register

#define KSZ8031_DRCON_PLL_OFF               0x0010


//AFE Control 1 register

#define KSZ8031_AFECON1_SLOW_OSC_MODE_EN    0x0020


//Operation Mode Strap Override register

#define KSZ8031_OMSO_RMII_BTB_OVERRIDE      0x0040

#define KSZ8031_OMSO_NAND_TREE_OVERRIDE     0x0020

#define KSZ8031_OMSO_RMII_OVERRIDE          0x0002


//Operation Mode Strap Status register

#define KSZ8031_OMSS_PHYAD                  0xE000

#define KSZ8031_OMSS_RMII_STRAP_STATUS      0x0002


//Expanded Control register

#define KSZ8031_EXCON_EDPD_DIS              0x0800


//Interrupt Control/Status register

#define KSZ8031_ICSR_JABBER_IE              0x8000

#define KSZ8031_ICSR_RECEIVE_ERROR_IE       0x4000

#define KSZ8031_ICSR_PAGE_RECEIVED_IE       0x2000

#define KSZ8031_ICSR_PAR_DETECT_FAULT_IE    0x1000

#define KSZ8031_ICSR_LP_ACK_IE              0x0800

#define KSZ8031_ICSR_LINK_DOWN_IE           0x0400

#define KSZ8031_ICSR_REMOTE_FAULT_IE        0x0200

#define KSZ8031_ICSR_LINK_UP_IE             0x0100

#define KSZ8031_ICSR_JABBER_IF              0x0080

#define KSZ8031_ICSR_RECEIVE_ERROR_IF       0x0040

#define KSZ8031_ICSR_PAGE_RECEIVED_IF       0x0020

#define KSZ8031_ICSR_PAR_DETECT_FAULT_IF    0x0010

#define KSZ8031_ICSR_LP_ACK_IF              0x0008

#define KSZ8031_ICSR_LINK_DOWN_IF           0x0004

#define KSZ8031_ICSR_REMOTE_FAULT_IF        0x0002

#define KSZ8031_ICSR_LINK_UP_IF             0x0001


//LinkMD Control/Status register

#define KSZ8031_LINKMD_TEST_EN              0x8000

#define KSZ8031_LINKMD_RESULT               0x6000

#define KSZ8031_LINKMD_SHORT                0x1000

#define KSZ8031_LINKMD_FAULT_COUNT          0x01FF


//PHY Control 1 register

#define KSZ8031_PHYCON1_PAUSE_EN            0x0200

#define KSZ8031_PHYCON1_LINK_STATUS         0x0100

#define KSZ8031_PHYCON1_POL_STATUS          0x0080

#define KSZ8031_PHYCON1_MDIX_STATE          0x0020

#define KSZ8031_PHYCON1_ENERGY_DETECT       0x0010

#define KSZ8031_PHYCON1_PHY_ISOLATE         0x0008

#define KSZ8031_PHYCON1_OP_MODE             0x0007

#define KSZ8031_PHYCON1_OP_MODE_AN          0x0000

#define KSZ8031_PHYCON1_OP_MODE_10BT_HD     0x0001

#define KSZ8031_PHYCON1_OP_MODE_100BTX_HD   0x0002

#define KSZ8031_PHYCON1_OP_MODE_10BT_FD     0x0005

#define KSZ8031_PHYCON1_OP_MODE_100BTX_FD   0x0006


//PHY Control 2 register

#define KSZ8031_PHYCON2_HP_MDIX             0x8000

#define KSZ8031_PHYCON2_MDIX_SEL            0x4000

#define KSZ8031_PHYCON2_PAIR_SWAP_DIS       0x2000

#define KSZ8031_PHYCON2_FORCE_LINK          0x0800

#define KSZ8031_PHYCON2_POWER_SAVING        0x0400

#define KSZ8031_PHYCON2_INT_LEVEL           0x0200

#define KSZ8031_PHYCON2_JABBER_EN           0x0100

#define KSZ8031_PHYCON2_RMII_REF_CLK_SEL    0x0080

#define KSZ8031_PHYCON2_LED_MODE            0x0030

#define KSZ8031_PHYCON2_TX_DIS              0x0008

#define KSZ8031_PHYCON2_REMOTE_LOOPBACK     0x0004

#define KSZ8031_PHYCON2_DATA_SCRAMBLING_DIS 0x0001


//C++ guard

#ifdef __cplusplus

extern "C" {

#endif


//KSZ8031 Ethernet PHY driver

extern const PhyDriver ksz8031PhyDriver;


//KSZ8031 related functions

error_t ksz8031Init(NetInterface *interface);

void ksz8031InitHook(NetInterface *interface);


void ksz8031Tick(NetInterface *interface);


void ksz8031EnableIrq(NetInterface *interface);

void ksz8031DisableIrq(NetInterface *interface);


void ksz8031EventHandler(NetInterface *interface);


void ksz8031WritePhyReg(NetInterface *interface, uint8_t address,

   uint16_t data);


uint16_t ksz8031ReadPhyReg(NetInterface *interface, uint8_t address);


void ksz8031DumpPhyReg(NetInterface *interface);


//C++ guard

#ifdef __cplusplus

}

#endif


#endif