doc/ar8035__driver_8h_source.html

/**

 * @file ar8035_driver.h

 * @brief AR8035 Gigabit Ethernet PHY driver

 *

 * @section License

 *

 * SPDX-License-Identifier: GPL-2.0-or-later

 *

 * Copyright (C) 2010-2025 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.5.4

 **/


#ifndef _AR8035_DRIVER_H

#define _AR8035_DRIVER_H


//Dependencies

#include "core/nic.h"


//PHY address

#ifndef AR8035_PHY_ADDR

   #define AR8035_PHY_ADDR 0

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

   #error AR8035_PHY_ADDR parameter is not valid

#endif


//AR8035 PHY registers

#define AR8035_BMCR                             0x00

#define AR8035_BMSR                             0x01

#define AR8035_PHYID1                           0x02

#define AR8035_PHYID2                           0x03

#define AR8035_ANAR                             0x04

#define AR8035_ANLPAR                           0x05

#define AR8035_ANER                             0x06

#define AR8035_ANNPTR                           0x07

#define AR8035_ANLPNPR                          0x08

#define AR8035_GBCR                             0x09

#define AR8035_GBSR                             0x0A

#define AR8035_MMDACR                           0x0D

#define AR8035_MMDAADR                          0x0E

#define AR8035_GBESR                            0x0F

#define AR8035_FUNC_CTRL                        0x10

#define AR8035_PHY_STATUS                       0x11

#define AR8035_INT_EN                           0x12

#define AR8035_INT_STATUS                       0x13

#define AR8035_SMART_SPEED                      0x14

#define AR8035_CDT_CTRL                         0x16

#define AR8035_LED_CTRL                         0x18

#define AR8035_CDT_STATUS                       0x1C

#define AR8035_DBG_PORT_ADDR_OFFSET             0x1D

#define AR8035_DBG_PORT_DATA                    0x1E


//AR8035 MMD registers

#define AR8035_PCS_CTRL                         0x03, 0x0000

#define AR8035_PCS_STAT                         0x03, 0x0001

#define AR8035_EEE_CAPABILITY                   0x03, 0x0014

#define AR8035_EEE_WAKE_ERROR_COUNTER           0x03, 0x0016

#define AR8035_AN_CTRL                          0x07, 0x0000

#define AR8035_AN_STAT                          0x07, 0x0001

#define AR8035_AN_XNP_TRANSMIT                  0x07, 0x0016

#define AR8035_AN_XNP_TRANSMIT1                 0x07, 0x0017

#define AR8035_AN_XNP_TRANSMIT2                 0x07, 0x0018

#define AR8035_AN_XNP_ABILITY                   0x07, 0x0019

#define AR8035_AN_XNP_ABILITY1                  0x07, 0x001A

#define AR8035_AN_XNP_ABILITY2                  0x07, 0x001B

#define AR8035_EEE_ADV                          0x07, 0x003C

#define AR8035_EEE_LP_ADV                       0x07, 0x003D

#define AR8035_EEE_ABILITY_AN_RES               0x07, 0x8000


//Control register

#define AR8035_BMCR_RESET                       0x8000

#define AR8035_BMCR_LOOPBACK                    0x4000

#define AR8035_BMCR_SPEED_SEL_LSB               0x2000

#define AR8035_BMCR_AN_EN                       0x1000

#define AR8035_BMCR_POWER_DOWN                  0x0800

#define AR8035_BMCR_ISOLATE                     0x0400

#define AR8035_BMCR_RESTART_AN                  0x0200

#define AR8035_BMCR_DUPLEX_MODE                 0x0100

#define AR8035_BMCR_COL_TEST                    0x0080

#define AR8035_BMCR_SPEED_SEL_MSB               0x0040


//Status register

#define AR8035_BMSR_100BT4                      0x8000

#define AR8035_BMSR_100BTX_FD                   0x4000

#define AR8035_BMSR_100BTX_HD                   0x2000

#define AR8035_BMSR_10BT_FD                     0x1000

#define AR8035_BMSR_10BT_HD                     0x0800

#define AR8035_BMSR_100BT2_FD                   0x0400

#define AR8035_BMSR_100BT2_HD                   0x0200

#define AR8035_BMSR_EXTENDED_STATUS             0x0100

#define AR8035_BMSR_MF_PREAMBLE_SUPPR           0x0040

#define AR8035_BMSR_AN_COMPLETE                 0x0020

#define AR8035_BMSR_REMOTE_FAULT                0x0010

#define AR8035_BMSR_AN_CAPABLE                  0x0008

#define AR8035_BMSR_LINK_STATUS                 0x0004

#define AR8035_BMSR_JABBER_DETECT               0x0002

#define AR8035_BMSR_EXTENDED_CAPABLE            0x0001


//PHY Identifier 1 register

#define AR8035_PHYID1_OUI_MSB                   0xFFFF

#define AR8035_PHYID1_OUI_MSB_DEFAULT           0x004D


//PHY Identifier 2 register

#define AR8035_PHYID2_OUI_LSB                   0xFC00

#define AR8035_PHYID2_OUI_LSB_DEFAULT           0xD000

#define AR8035_PHYID2_MODEL_NUM                 0x03F0

#define AR8035_PHYID2_MODEL_NUM_DEFAULT         0x0070

#define AR8035_PHYID2_REVISION_NUM              0x000F


//Auto-Negotiation Advertisement register

#define AR8035_ANAR_NEXT_PAGE                   0x8000

#define AR8035_ANAR_ACK                         0x4000

#define AR8035_ANAR_REMOTE_FAULT                0x2000

#define AR8035_ANAR_XNP_ABLE                    0x1000

#define AR8035_ANAR_ASYM_PAUSE                  0x0800

#define AR8035_ANAR_PAUSE                       0x0400

#define AR8035_ANAR_100BT4                      0x0200

#define AR8035_ANAR_100BTX_FD                   0x0100

#define AR8035_ANAR_100BTX_HD                   0x0080

#define AR8035_ANAR_10BT_FD                     0x0040

#define AR8035_ANAR_10BT_HD                     0x0020

#define AR8035_ANAR_SELECTOR                    0x001F

#define AR8035_ANAR_SELECTOR_DEFAULT            0x0001


//Link Partner Ability register

#define AR8035_ANLPAR_NEXT_PAGE                 0x8000

#define AR8035_ANLPAR_ACK                       0x4000

#define AR8035_ANLPAR_REMOTE_FAULT              0x2000

#define AR8035_ANLPAR_ASYM_PAUSE                0x0800

#define AR8035_ANLPAR_PAUSE                     0x0400

#define AR8035_ANLPAR_100BT4                    0x0200

#define AR8035_ANLPAR_100BTX_FD                 0x0100

#define AR8035_ANLPAR_100BTX_HD                 0x0080

#define AR8035_ANLPAR_10BT_FD                   0x0040

#define AR8035_ANLPAR_10BT_HD                   0x0020

#define AR8035_ANLPAR_SELECTOR                  0x001F

#define AR8035_ANLPAR_SELECTOR_DEFAULT          0x0001


//Auto-Negotiation Expansion register

#define AR8035_ANER_PAR_DETECT_FAULT            0x0010

#define AR8035_ANER_LP_NEXT_PAGE_ABLE           0x0008

#define AR8035_ANER_NEXT_PAGE_ABLE              0x0004

#define AR8035_ANER_PAGE_RECEIVED               0x0002

#define AR8035_ANER_LP_AN_ABLE                  0x0001


//Auto-Negotiation Next Page Transmit register

#define AR8035_ANNPTR_NEXT_PAGE                 0x8000

#define AR8035_ANNPTR_MSG_PAGE                  0x2000

#define AR8035_ANNPTR_ACK2                      0x1000

#define AR8035_ANNPTR_TOGGLE                    0x0800

#define AR8035_ANNPTR_MESSAGE                   0x07FF


//Link Partner Next Page register

#define AR8035_ANLPNPR_NEXT_PAGE                0x8000

#define AR8035_ANLPNPR_ACK                      0x4000

#define AR8035_ANLPNPR_MSG_PAGE                 0x2000

#define AR8035_ANLPNPR_ACK2                     0x1000

#define AR8035_ANLPNPR_TOGGLE                   0x0800

#define AR8035_ANLPNPR_MESSAGE                  0x07FF


//1000BASE-T Control register

#define AR8035_GBCR_TEST_MODE                   0xE000

#define AR8035_GBCR_MS_MAN_CONF_EN              0x1000

#define AR8035_GBCR_MS_MAN_CONF_VAL             0x0800

#define AR8035_GBCR_PORT_TYPE                   0x0400

#define AR8035_GBCR_1000BT_FD                   0x0200

#define AR8035_GBCR_1000BT_HD                   0x0100


//1000BASE-T Status register

#define AR8035_GBSR_MS_CONF_FAULT               0x8000

#define AR8035_GBSR_MS_CONF_RES                 0x4000

#define AR8035_GBSR_LOCAL_RECEIVER_STATUS       0x2000

#define AR8035_GBSR_REMOTE_RECEIVER_STATUS      0x1000

#define AR8035_GBSR_LP_1000BT_FD                0x0800

#define AR8035_GBSR_LP_1000BT_HD                0x0400

#define AR8035_GBSR_IDLE_ERR_COUNT              0x00FF


//MMD Access Control register

#define AR8035_MMDACR_FUNC                      0xC000

#define AR8035_MMDACR_FUNC_ADDR                 0x0000

#define AR8035_MMDACR_FUNC_DATA_NO_POST_INC     0x4000

#define AR8035_MMDACR_FUNC_DATA_POST_INC_RW     0x8000

#define AR8035_MMDACR_FUNC_DATA_POST_INC_W      0xC000

#define AR8035_MMDACR_DEVAD                     0x001F


//Extended Status register

#define AR8035_GBESR_1000BX_FD                  0x8000

#define AR8035_GBESR_1000BX_HD                  0x4000

#define AR8035_GBESR_1000BT_FD                  0x2000

#define AR8035_GBESR_1000BT_HD                  0x1000


//Function Control register

#define AR8035_FUNC_CTRL_ASSERT_CRS_ON_TX       0x0800

#define AR8035_FUNC_CTRL_MDIX_MODE              0x0060

#define AR8035_FUNC_CTRL_MDIX_MODE_MANUAL_MDI   0x0000

#define AR8035_FUNC_CTRL_MDIX_MODE_MANUAL_MDIX  0x0020

#define AR8035_FUNC_CTRL_MDIX_MODE_AUTO         0x0060

#define AR8035_FUNC_CTRL_SQE_TEST               0x0004

#define AR8035_FUNC_CTRL_POLARITY_REVERSAL      0x0002

#define AR8035_FUNC_CTRL_JABBER_DIS             0x0001


//PHY-Specific Status register

#define AR8035_PHY_STATUS_SPEED                 0xC000

#define AR8035_PHY_STATUS_SPEED_10MBPS          0x0000

#define AR8035_PHY_STATUS_SPEED_100MBPS         0x4000

#define AR8035_PHY_STATUS_SPEED_1000MBPS        0x8000

#define AR8035_PHY_STATUS_DUPLEX                0x2000

#define AR8035_PHY_STATUS_PAGE_RECEIVED         0x1000

#define AR8035_PHY_STATUS_SPEED_DUPLEX_RESOLVED 0x0800

#define AR8035_PHY_STATUS_LINK                  0x0400

#define AR8035_PHY_STATUS_MDI_CROSSOVER_STATUS  0x0040

#define AR8035_PHY_STATUS_WIRESPEED_DOWNGRADE   0x0020

#define AR8035_PHY_STATUS_TX_PAUSE_EN           0x0008

#define AR8035_PHY_STATUS_RX_PAUSE_EN           0x0004

#define AR8035_PHY_STATUS_POLARITY              0x0002

#define AR8035_PHY_STATUS_JABBER                0x0001


//Interrupt Enable Register register

#define AR8035_INT_EN_AN_ERROR                  0x8000

#define AR8035_INT_EN_SPEED_CHANGED             0x4000

#define AR8035_INT_EN_DUPLEX_CHANGED            0x2000

#define AR8035_INT_EN_PAGE_RECEIVED             0x1000

#define AR8035_INT_EN_LINK_FAIL                 0x0800

#define AR8035_INT_EN_LINK_SUCCESS              0x0400

#define AR8035_INT_EN_WIRESPEED_DOWNGRADE       0x0020

#define AR8035_INT_EN_POLARITY_CHANGED          0x0002

#define AR8035_INT_EN_WOL_PTP                   0x0001


//Interrupt Status register

#define AR8035_INT_STATUS_AN_ERROR              0x8000

#define AR8035_INT_STATUS_SPEED_CHANGED         0x4000

#define AR8035_INT_STATUS_DUPLEX_CHANGED        0x2000

#define AR8035_INT_STATUS_PAGE_RECEIVED         0x1000

#define AR8035_INT_STATUS_LINK_FAIL             0x0800

#define AR8035_INT_STATUS_LINK_SUCCESS          0x0400

#define AR8035_INT_STATUS_WIRESPEED_DOWNGRADE   0x0020

#define AR8035_INT_STATUS_POLARITY_CHANGED      0x0002

#define AR8035_INT_STATUS_WOL_PTP               0x0001


//Smart Speed register

#define AR8035_SMART_SPEED_EN                   0x0020

#define AR8035_SMART_SPEED_RETRY_LIMIT          0x001C

#define AR8035_SMART_SPEED_BYPASS_TIMER         0x0002


//Cable Diagnostic Tester (CDT) Control register

#define AR8035_CDT_CTRL_MDI_PAIR_SELECT         0x0300

#define AR8035_CDT_CTRL_TEST_EN                 0x0001


//LED Control register

#define AR8035_LED_CTRL_LED_ON_TIME             0x7000

#define AR8035_LED_CTRL_LED_OFF_TIME            0x0700


//Cable Diagnostic Tester Status register

#define AR8035_CDT_STATUS_STATUS                0x0300

#define AR8035_CDT_STATUS_DELTA_TIME            0x00FF


//C++ guard

#ifdef __cplusplus

extern "C" {

#endif


//AR8035 Ethernet PHY driver

extern const PhyDriver ar8035PhyDriver;


//AR8035 related functions

error_t ar8035Init(NetInterface *interface);

void ar8035InitHook(NetInterface *interface);


void ar8035Tick(NetInterface *interface);


void ar8035EnableIrq(NetInterface *interface);

void ar8035DisableIrq(NetInterface *interface);


void ar8035EventHandler(NetInterface *interface);


void ar8035WritePhyReg(NetInterface *interface, uint8_t address,

   uint16_t data);


uint16_t ar8035ReadPhyReg(NetInterface *interface, uint8_t address);


void ar8035DumpPhyReg(NetInterface *interface);


void ar8035WriteMmdReg(NetInterface *interface, uint8_t devAddr,

   uint16_t regAddr, uint16_t data);


uint16_t ar8035ReadMmdReg(NetInterface *interface, uint8_t devAddr,

   uint16_t regAddr);


//C++ guard

#ifdef __cplusplus

}

#endif


#endif