The ADIN1200 & ADIN1300 PHYs support EEE by using standard Clause 45 access to access MMD registers for EEE. The EEE register addresses (when using Clause 22) are available at different addresses (than Clause 45), and since accessing these regs (via Clause 22) needs a special mechanism, a translation table is required to convert these addresses. For Clause 45, this is not needed since the driver will likely never use this access mode. Reviewed-by: Florian Fainelli <f.fainelli@gmail.com> Reviewed-by: Andrew Lunn <andrew@lunn.ch> Signed-off-by: Alexandru Ardelean <alexandru.ardelean@analog.com> Signed-off-by: David S. Miller <davem@davemloft.net>
485 lines
12 KiB
C
485 lines
12 KiB
C
// SPDX-License-Identifier: GPL-2.0+
|
|
/**
|
|
* Driver for Analog Devices Industrial Ethernet PHYs
|
|
*
|
|
* Copyright 2019 Analog Devices Inc.
|
|
*/
|
|
#include <linux/kernel.h>
|
|
#include <linux/bitfield.h>
|
|
#include <linux/errno.h>
|
|
#include <linux/init.h>
|
|
#include <linux/module.h>
|
|
#include <linux/mii.h>
|
|
#include <linux/phy.h>
|
|
#include <linux/property.h>
|
|
|
|
#define PHY_ID_ADIN1200 0x0283bc20
|
|
#define PHY_ID_ADIN1300 0x0283bc30
|
|
|
|
#define ADIN1300_MII_EXT_REG_PTR 0x0010
|
|
#define ADIN1300_MII_EXT_REG_DATA 0x0011
|
|
|
|
#define ADIN1300_PHY_CTRL1 0x0012
|
|
#define ADIN1300_AUTO_MDI_EN BIT(10)
|
|
#define ADIN1300_MAN_MDIX_EN BIT(9)
|
|
|
|
#define ADIN1300_INT_MASK_REG 0x0018
|
|
#define ADIN1300_INT_MDIO_SYNC_EN BIT(9)
|
|
#define ADIN1300_INT_ANEG_STAT_CHNG_EN BIT(8)
|
|
#define ADIN1300_INT_ANEG_PAGE_RX_EN BIT(6)
|
|
#define ADIN1300_INT_IDLE_ERR_CNT_EN BIT(5)
|
|
#define ADIN1300_INT_MAC_FIFO_OU_EN BIT(4)
|
|
#define ADIN1300_INT_RX_STAT_CHNG_EN BIT(3)
|
|
#define ADIN1300_INT_LINK_STAT_CHNG_EN BIT(2)
|
|
#define ADIN1300_INT_SPEED_CHNG_EN BIT(1)
|
|
#define ADIN1300_INT_HW_IRQ_EN BIT(0)
|
|
#define ADIN1300_INT_MASK_EN \
|
|
(ADIN1300_INT_LINK_STAT_CHNG_EN | ADIN1300_INT_HW_IRQ_EN)
|
|
#define ADIN1300_INT_STATUS_REG 0x0019
|
|
|
|
#define ADIN1300_PHY_STATUS1 0x001a
|
|
#define ADIN1300_PAIR_01_SWAP BIT(11)
|
|
|
|
/* EEE register addresses, accessible via Clause 22 access using
|
|
* ADIN1300_MII_EXT_REG_PTR & ADIN1300_MII_EXT_REG_DATA.
|
|
* The bit-fields are the same as specified by IEEE for EEE.
|
|
*/
|
|
#define ADIN1300_EEE_CAP_REG 0x8000
|
|
#define ADIN1300_EEE_ADV_REG 0x8001
|
|
#define ADIN1300_EEE_LPABLE_REG 0x8002
|
|
#define ADIN1300_CLOCK_STOP_REG 0x9400
|
|
#define ADIN1300_LPI_WAKE_ERR_CNT_REG 0xa000
|
|
|
|
#define ADIN1300_GE_RGMII_CFG_REG 0xff23
|
|
#define ADIN1300_GE_RGMII_RX_MSK GENMASK(8, 6)
|
|
#define ADIN1300_GE_RGMII_RX_SEL(x) \
|
|
FIELD_PREP(ADIN1300_GE_RGMII_RX_MSK, x)
|
|
#define ADIN1300_GE_RGMII_GTX_MSK GENMASK(5, 3)
|
|
#define ADIN1300_GE_RGMII_GTX_SEL(x) \
|
|
FIELD_PREP(ADIN1300_GE_RGMII_GTX_MSK, x)
|
|
#define ADIN1300_GE_RGMII_RXID_EN BIT(2)
|
|
#define ADIN1300_GE_RGMII_TXID_EN BIT(1)
|
|
#define ADIN1300_GE_RGMII_EN BIT(0)
|
|
|
|
/* RGMII internal delay settings for rx and tx for ADIN1300 */
|
|
#define ADIN1300_RGMII_1_60_NS 0x0001
|
|
#define ADIN1300_RGMII_1_80_NS 0x0002
|
|
#define ADIN1300_RGMII_2_00_NS 0x0000
|
|
#define ADIN1300_RGMII_2_20_NS 0x0006
|
|
#define ADIN1300_RGMII_2_40_NS 0x0007
|
|
|
|
#define ADIN1300_GE_RMII_CFG_REG 0xff24
|
|
#define ADIN1300_GE_RMII_FIFO_DEPTH_MSK GENMASK(6, 4)
|
|
#define ADIN1300_GE_RMII_FIFO_DEPTH_SEL(x) \
|
|
FIELD_PREP(ADIN1300_GE_RMII_FIFO_DEPTH_MSK, x)
|
|
#define ADIN1300_GE_RMII_EN BIT(0)
|
|
|
|
/* RMII fifo depth values */
|
|
#define ADIN1300_RMII_4_BITS 0x0000
|
|
#define ADIN1300_RMII_8_BITS 0x0001
|
|
#define ADIN1300_RMII_12_BITS 0x0002
|
|
#define ADIN1300_RMII_16_BITS 0x0003
|
|
#define ADIN1300_RMII_20_BITS 0x0004
|
|
#define ADIN1300_RMII_24_BITS 0x0005
|
|
|
|
/**
|
|
* struct adin_cfg_reg_map - map a config value to aregister value
|
|
* @cfg value in device configuration
|
|
* @reg value in the register
|
|
*/
|
|
struct adin_cfg_reg_map {
|
|
int cfg;
|
|
int reg;
|
|
};
|
|
|
|
static const struct adin_cfg_reg_map adin_rgmii_delays[] = {
|
|
{ 1600, ADIN1300_RGMII_1_60_NS },
|
|
{ 1800, ADIN1300_RGMII_1_80_NS },
|
|
{ 2000, ADIN1300_RGMII_2_00_NS },
|
|
{ 2200, ADIN1300_RGMII_2_20_NS },
|
|
{ 2400, ADIN1300_RGMII_2_40_NS },
|
|
{ },
|
|
};
|
|
|
|
static const struct adin_cfg_reg_map adin_rmii_fifo_depths[] = {
|
|
{ 4, ADIN1300_RMII_4_BITS },
|
|
{ 8, ADIN1300_RMII_8_BITS },
|
|
{ 12, ADIN1300_RMII_12_BITS },
|
|
{ 16, ADIN1300_RMII_16_BITS },
|
|
{ 20, ADIN1300_RMII_20_BITS },
|
|
{ 24, ADIN1300_RMII_24_BITS },
|
|
{ },
|
|
};
|
|
|
|
/**
|
|
* struct adin_clause45_mmd_map - map to convert Clause 45 regs to Clause 22
|
|
* @devad device address used in Clause 45 access
|
|
* @cl45_regnum register address defined by Clause 45
|
|
* @adin_regnum equivalent register address accessible via Clause 22
|
|
*/
|
|
struct adin_clause45_mmd_map {
|
|
int devad;
|
|
u16 cl45_regnum;
|
|
u16 adin_regnum;
|
|
};
|
|
|
|
static struct adin_clause45_mmd_map adin_clause45_mmd_map[] = {
|
|
{ MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE, ADIN1300_EEE_CAP_REG },
|
|
{ MDIO_MMD_AN, MDIO_AN_EEE_LPABLE, ADIN1300_EEE_LPABLE_REG },
|
|
{ MDIO_MMD_AN, MDIO_AN_EEE_ADV, ADIN1300_EEE_ADV_REG },
|
|
{ MDIO_MMD_PCS, MDIO_CTRL1, ADIN1300_CLOCK_STOP_REG },
|
|
{ MDIO_MMD_PCS, MDIO_PCS_EEE_WK_ERR, ADIN1300_LPI_WAKE_ERR_CNT_REG },
|
|
};
|
|
|
|
static int adin_lookup_reg_value(const struct adin_cfg_reg_map *tbl, int cfg)
|
|
{
|
|
size_t i;
|
|
|
|
for (i = 0; tbl[i].cfg; i++) {
|
|
if (tbl[i].cfg == cfg)
|
|
return tbl[i].reg;
|
|
}
|
|
|
|
return -EINVAL;
|
|
}
|
|
|
|
static u32 adin_get_reg_value(struct phy_device *phydev,
|
|
const char *prop_name,
|
|
const struct adin_cfg_reg_map *tbl,
|
|
u32 dflt)
|
|
{
|
|
struct device *dev = &phydev->mdio.dev;
|
|
u32 val;
|
|
int rc;
|
|
|
|
if (device_property_read_u32(dev, prop_name, &val))
|
|
return dflt;
|
|
|
|
rc = adin_lookup_reg_value(tbl, val);
|
|
if (rc < 0) {
|
|
phydev_warn(phydev,
|
|
"Unsupported value %u for %s using default (%u)\n",
|
|
val, prop_name, dflt);
|
|
return dflt;
|
|
}
|
|
|
|
return rc;
|
|
}
|
|
|
|
static int adin_config_rgmii_mode(struct phy_device *phydev)
|
|
{
|
|
u32 val;
|
|
int reg;
|
|
|
|
if (!phy_interface_is_rgmii(phydev))
|
|
return phy_clear_bits_mmd(phydev, MDIO_MMD_VEND1,
|
|
ADIN1300_GE_RGMII_CFG_REG,
|
|
ADIN1300_GE_RGMII_EN);
|
|
|
|
reg = phy_read_mmd(phydev, MDIO_MMD_VEND1, ADIN1300_GE_RGMII_CFG_REG);
|
|
if (reg < 0)
|
|
return reg;
|
|
|
|
reg |= ADIN1300_GE_RGMII_EN;
|
|
|
|
if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID ||
|
|
phydev->interface == PHY_INTERFACE_MODE_RGMII_RXID) {
|
|
reg |= ADIN1300_GE_RGMII_RXID_EN;
|
|
|
|
val = adin_get_reg_value(phydev, "adi,rx-internal-delay-ps",
|
|
adin_rgmii_delays,
|
|
ADIN1300_RGMII_2_00_NS);
|
|
reg &= ~ADIN1300_GE_RGMII_RX_MSK;
|
|
reg |= ADIN1300_GE_RGMII_RX_SEL(val);
|
|
} else {
|
|
reg &= ~ADIN1300_GE_RGMII_RXID_EN;
|
|
}
|
|
|
|
if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID ||
|
|
phydev->interface == PHY_INTERFACE_MODE_RGMII_TXID) {
|
|
reg |= ADIN1300_GE_RGMII_TXID_EN;
|
|
|
|
val = adin_get_reg_value(phydev, "adi,tx-internal-delay-ps",
|
|
adin_rgmii_delays,
|
|
ADIN1300_RGMII_2_00_NS);
|
|
reg &= ~ADIN1300_GE_RGMII_GTX_MSK;
|
|
reg |= ADIN1300_GE_RGMII_GTX_SEL(val);
|
|
} else {
|
|
reg &= ~ADIN1300_GE_RGMII_TXID_EN;
|
|
}
|
|
|
|
return phy_write_mmd(phydev, MDIO_MMD_VEND1,
|
|
ADIN1300_GE_RGMII_CFG_REG, reg);
|
|
}
|
|
|
|
static int adin_config_rmii_mode(struct phy_device *phydev)
|
|
{
|
|
u32 val;
|
|
int reg;
|
|
|
|
if (phydev->interface != PHY_INTERFACE_MODE_RMII)
|
|
return phy_clear_bits_mmd(phydev, MDIO_MMD_VEND1,
|
|
ADIN1300_GE_RMII_CFG_REG,
|
|
ADIN1300_GE_RMII_EN);
|
|
|
|
reg = phy_read_mmd(phydev, MDIO_MMD_VEND1, ADIN1300_GE_RMII_CFG_REG);
|
|
if (reg < 0)
|
|
return reg;
|
|
|
|
reg |= ADIN1300_GE_RMII_EN;
|
|
|
|
val = adin_get_reg_value(phydev, "adi,fifo-depth-bits",
|
|
adin_rmii_fifo_depths,
|
|
ADIN1300_RMII_8_BITS);
|
|
|
|
reg &= ~ADIN1300_GE_RMII_FIFO_DEPTH_MSK;
|
|
reg |= ADIN1300_GE_RMII_FIFO_DEPTH_SEL(val);
|
|
|
|
return phy_write_mmd(phydev, MDIO_MMD_VEND1,
|
|
ADIN1300_GE_RMII_CFG_REG, reg);
|
|
}
|
|
|
|
static int adin_config_init(struct phy_device *phydev)
|
|
{
|
|
int rc;
|
|
|
|
phydev->mdix_ctrl = ETH_TP_MDI_AUTO;
|
|
|
|
rc = genphy_config_init(phydev);
|
|
if (rc < 0)
|
|
return rc;
|
|
|
|
rc = adin_config_rgmii_mode(phydev);
|
|
if (rc < 0)
|
|
return rc;
|
|
|
|
rc = adin_config_rmii_mode(phydev);
|
|
if (rc < 0)
|
|
return rc;
|
|
|
|
phydev_dbg(phydev, "PHY is using mode '%s'\n",
|
|
phy_modes(phydev->interface));
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int adin_phy_ack_intr(struct phy_device *phydev)
|
|
{
|
|
/* Clear pending interrupts */
|
|
int rc = phy_read(phydev, ADIN1300_INT_STATUS_REG);
|
|
|
|
return rc < 0 ? rc : 0;
|
|
}
|
|
|
|
static int adin_phy_config_intr(struct phy_device *phydev)
|
|
{
|
|
if (phydev->interrupts == PHY_INTERRUPT_ENABLED)
|
|
return phy_set_bits(phydev, ADIN1300_INT_MASK_REG,
|
|
ADIN1300_INT_MASK_EN);
|
|
|
|
return phy_clear_bits(phydev, ADIN1300_INT_MASK_REG,
|
|
ADIN1300_INT_MASK_EN);
|
|
}
|
|
|
|
static int adin_cl45_to_adin_reg(struct phy_device *phydev, int devad,
|
|
u16 cl45_regnum)
|
|
{
|
|
struct adin_clause45_mmd_map *m;
|
|
int i;
|
|
|
|
if (devad == MDIO_MMD_VEND1)
|
|
return cl45_regnum;
|
|
|
|
for (i = 0; i < ARRAY_SIZE(adin_clause45_mmd_map); i++) {
|
|
m = &adin_clause45_mmd_map[i];
|
|
if (m->devad == devad && m->cl45_regnum == cl45_regnum)
|
|
return m->adin_regnum;
|
|
}
|
|
|
|
phydev_err(phydev,
|
|
"No translation available for devad: %d reg: %04x\n",
|
|
devad, cl45_regnum);
|
|
|
|
return -EINVAL;
|
|
}
|
|
|
|
static int adin_read_mmd(struct phy_device *phydev, int devad, u16 regnum)
|
|
{
|
|
struct mii_bus *bus = phydev->mdio.bus;
|
|
int phy_addr = phydev->mdio.addr;
|
|
int adin_regnum;
|
|
int err;
|
|
|
|
adin_regnum = adin_cl45_to_adin_reg(phydev, devad, regnum);
|
|
if (adin_regnum < 0)
|
|
return adin_regnum;
|
|
|
|
err = __mdiobus_write(bus, phy_addr, ADIN1300_MII_EXT_REG_PTR,
|
|
adin_regnum);
|
|
if (err)
|
|
return err;
|
|
|
|
return __mdiobus_read(bus, phy_addr, ADIN1300_MII_EXT_REG_DATA);
|
|
}
|
|
|
|
static int adin_write_mmd(struct phy_device *phydev, int devad, u16 regnum,
|
|
u16 val)
|
|
{
|
|
struct mii_bus *bus = phydev->mdio.bus;
|
|
int phy_addr = phydev->mdio.addr;
|
|
int adin_regnum;
|
|
int err;
|
|
|
|
adin_regnum = adin_cl45_to_adin_reg(phydev, devad, regnum);
|
|
if (adin_regnum < 0)
|
|
return adin_regnum;
|
|
|
|
err = __mdiobus_write(bus, phy_addr, ADIN1300_MII_EXT_REG_PTR,
|
|
adin_regnum);
|
|
if (err)
|
|
return err;
|
|
|
|
return __mdiobus_write(bus, phy_addr, ADIN1300_MII_EXT_REG_DATA, val);
|
|
}
|
|
|
|
static int adin_config_mdix(struct phy_device *phydev)
|
|
{
|
|
bool auto_en, mdix_en;
|
|
int reg;
|
|
|
|
mdix_en = false;
|
|
auto_en = false;
|
|
switch (phydev->mdix_ctrl) {
|
|
case ETH_TP_MDI:
|
|
break;
|
|
case ETH_TP_MDI_X:
|
|
mdix_en = true;
|
|
break;
|
|
case ETH_TP_MDI_AUTO:
|
|
auto_en = true;
|
|
break;
|
|
default:
|
|
return -EINVAL;
|
|
}
|
|
|
|
reg = phy_read(phydev, ADIN1300_PHY_CTRL1);
|
|
if (reg < 0)
|
|
return reg;
|
|
|
|
if (mdix_en)
|
|
reg |= ADIN1300_MAN_MDIX_EN;
|
|
else
|
|
reg &= ~ADIN1300_MAN_MDIX_EN;
|
|
|
|
if (auto_en)
|
|
reg |= ADIN1300_AUTO_MDI_EN;
|
|
else
|
|
reg &= ~ADIN1300_AUTO_MDI_EN;
|
|
|
|
return phy_write(phydev, ADIN1300_PHY_CTRL1, reg);
|
|
}
|
|
|
|
static int adin_config_aneg(struct phy_device *phydev)
|
|
{
|
|
int ret;
|
|
|
|
ret = adin_config_mdix(phydev);
|
|
if (ret)
|
|
return ret;
|
|
|
|
return genphy_config_aneg(phydev);
|
|
}
|
|
|
|
static int adin_mdix_update(struct phy_device *phydev)
|
|
{
|
|
bool auto_en, mdix_en;
|
|
bool swapped;
|
|
int reg;
|
|
|
|
reg = phy_read(phydev, ADIN1300_PHY_CTRL1);
|
|
if (reg < 0)
|
|
return reg;
|
|
|
|
auto_en = !!(reg & ADIN1300_AUTO_MDI_EN);
|
|
mdix_en = !!(reg & ADIN1300_MAN_MDIX_EN);
|
|
|
|
/* If MDI/MDIX is forced, just read it from the control reg */
|
|
if (!auto_en) {
|
|
if (mdix_en)
|
|
phydev->mdix = ETH_TP_MDI_X;
|
|
else
|
|
phydev->mdix = ETH_TP_MDI;
|
|
return 0;
|
|
}
|
|
|
|
/**
|
|
* Otherwise, we need to deduce it from the PHY status2 reg.
|
|
* When Auto-MDI is enabled, the ADIN1300_MAN_MDIX_EN bit implies
|
|
* a preference for MDIX when it is set.
|
|
*/
|
|
reg = phy_read(phydev, ADIN1300_PHY_STATUS1);
|
|
if (reg < 0)
|
|
return reg;
|
|
|
|
swapped = !!(reg & ADIN1300_PAIR_01_SWAP);
|
|
|
|
if (mdix_en != swapped)
|
|
phydev->mdix = ETH_TP_MDI_X;
|
|
else
|
|
phydev->mdix = ETH_TP_MDI;
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int adin_read_status(struct phy_device *phydev)
|
|
{
|
|
int ret;
|
|
|
|
ret = adin_mdix_update(phydev);
|
|
if (ret < 0)
|
|
return ret;
|
|
|
|
return genphy_read_status(phydev);
|
|
}
|
|
|
|
static struct phy_driver adin_driver[] = {
|
|
{
|
|
PHY_ID_MATCH_MODEL(PHY_ID_ADIN1200),
|
|
.name = "ADIN1200",
|
|
.config_init = adin_config_init,
|
|
.config_aneg = adin_config_aneg,
|
|
.read_status = adin_read_status,
|
|
.ack_interrupt = adin_phy_ack_intr,
|
|
.config_intr = adin_phy_config_intr,
|
|
.resume = genphy_resume,
|
|
.suspend = genphy_suspend,
|
|
.read_mmd = adin_read_mmd,
|
|
.write_mmd = adin_write_mmd,
|
|
},
|
|
{
|
|
PHY_ID_MATCH_MODEL(PHY_ID_ADIN1300),
|
|
.name = "ADIN1300",
|
|
.config_init = adin_config_init,
|
|
.config_aneg = adin_config_aneg,
|
|
.read_status = adin_read_status,
|
|
.ack_interrupt = adin_phy_ack_intr,
|
|
.config_intr = adin_phy_config_intr,
|
|
.resume = genphy_resume,
|
|
.suspend = genphy_suspend,
|
|
.read_mmd = adin_read_mmd,
|
|
.write_mmd = adin_write_mmd,
|
|
},
|
|
};
|
|
|
|
module_phy_driver(adin_driver);
|
|
|
|
static struct mdio_device_id __maybe_unused adin_tbl[] = {
|
|
{ PHY_ID_MATCH_MODEL(PHY_ID_ADIN1200) },
|
|
{ PHY_ID_MATCH_MODEL(PHY_ID_ADIN1300) },
|
|
{ }
|
|
};
|
|
|
|
MODULE_DEVICE_TABLE(mdio, adin_tbl);
|
|
MODULE_DESCRIPTION("Analog Devices Industrial Ethernet PHY driver");
|
|
MODULE_LICENSE("GPL");
|