path: root/src/vendorcode/cavium/bdk/libbdk-driver/bdk-driver-mdio.c

/***********************license start***********************************
* Copyright (c) 2003-2017  Cavium Inc. (support@cavium.com). All rights
* reserved.
*
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
*   * Redistributions of source code must retain the above copyright
*     notice, this list of conditions and the following disclaimer.
*
*   * Redistributions in binary form must reproduce the above
*     copyright notice, this list of conditions and the following
*     disclaimer in the documentation and/or other materials provided
*     with the distribution.
*
*   * Neither the name of Cavium Inc. nor the names of
*     its contributors may be used to endorse or promote products
*     derived from this software without specific prior written
*     permission.
*
* This Software, including technical data, may be subject to U.S. export
* control laws, including the U.S. Export Administration Act and its
* associated regulations, and may be subject to export or import
* regulations in other countries.
*
* TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
* AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS OR
* WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT
* TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY
* REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT
* DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES
* OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR
* PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT,
* QUIET POSSESSION OR CORRESPONDENCE TO DESCRIPTION. THE ENTIRE  RISK
* ARISING OUT OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
***********************license end**************************************/
#include <bdk.h>
#include <libbdk-arch/bdk-csrs-pccpf.h>
#include <libbdk-arch/bdk-csrs-smi.h>
#include <libbdk-hal/device/bdk-device.h>
#include <libbdk-hal/bdk-mdio.h>

/* This code is an optional part of the BDK. It is only linked in
    if BDK_REQUIRE() needs it */
BDK_REQUIRE_DEFINE(MDIO);

/* To maintain backwards compatibility for the old MDIO API we need
   to lookup the MDIO device on the ECAM bus by ID. This defines
   the ID */
#define MDIO_DEVID ((BDK_PCC_PROD_E_GEN << 24) | BDK_PCC_VENDOR_E_CAVIUM | (BDK_PCC_DEV_IDL_E_SMI << 16))

#define BDK_MDIO_TIMEOUT   100000 /* 100 millisec */

/* Operating request encodings. */
#define MDIO_CLAUSE_22_WRITE    0
#define MDIO_CLAUSE_22_READ     1

#define MDIO_CLAUSE_45_ADDRESS  0
#define MDIO_CLAUSE_45_WRITE    1
#define MDIO_CLAUSE_45_READ_INC 2
#define MDIO_CLAUSE_45_READ     3

/**
 * Helper function to put MDIO interface into clause 45 mode
 *
 * @param bus_id
 */
static void __bdk_mdio_set_clause45_mode(const bdk_device_t *device, int bus_id)
{
    bdk_smi_x_clk_t smi_clk;
    /* Put bus into clause 45 mode */
    smi_clk.u = BDK_BAR_READ(device, BDK_SMI_X_CLK(bus_id));
    if (smi_clk.s.mode != 1)
    {
        smi_clk.s.mode = 1;
        smi_clk.s.preamble = 1;
        BDK_BAR_WRITE(device, BDK_SMI_X_CLK(bus_id), smi_clk.u);
    }
}

/**
 * Helper function to put MDIO interface into clause 22 mode
 *
 * @param bus_id
 */
static void __bdk_mdio_set_clause22_mode(const bdk_device_t *device, int bus_id)
{
    bdk_smi_x_clk_t smi_clk;
    /* Put bus into clause 22 mode */
    smi_clk.u = BDK_BAR_READ(device, BDK_SMI_X_CLK(bus_id));
    if (smi_clk.s.mode != 0)
    {
        smi_clk.s.mode = 0;
        BDK_BAR_WRITE(device, BDK_SMI_X_CLK(bus_id), smi_clk.u);
    }
}

/**
 * @INTERNAL
 * Function to read SMIX_RD_DAT and check for timeouts. This
 * code sequence is done fairly often, so put in in one spot.
 *
 * @param bus_id SMI/MDIO bus to read
 *
 * @return Value of SMIX_RD_DAT. pending will be set on
 *         a timeout.
 */
static bdk_smi_x_rd_dat_t __bdk_mdio_read_rd_dat(const bdk_device_t *device, int bus_id)
{
    bdk_smi_x_rd_dat_t smi_rd;
    uint64_t done = bdk_clock_get_count(BDK_CLOCK_TIME) + (uint64_t)BDK_MDIO_TIMEOUT *
                       bdk_clock_get_rate(bdk_numa_local(), BDK_CLOCK_TIME) / 1000000;
    do
    {
        smi_rd.u = BDK_BAR_READ(device, BDK_SMI_X_RD_DAT(bus_id));
    } while (smi_rd.s.pending && (bdk_clock_get_count(BDK_CLOCK_TIME) < done));
    return smi_rd;
}


/**
 * Perform an MII read. This function is used to read PHY
 * registers controlling auto negotiation.
 *
 * @param bus_id   MDIO bus number. Zero on most chips, but some chips (ex CN56XX)
 *                 support multiple busses.
 * @param phy_id   The MII phy id
 * @param location Register location to read
 *
 * @return Result from the read or -1 on failure
 */
int bdk_mdio_read(bdk_node_t node, int bus_id, int phy_id, int location)
{
    const bdk_device_t *device = bdk_device_lookup(node, MDIO_DEVID, 0);
    if (!device)
    {
        bdk_error("MDIO: ECAM device not found\n");
        return -1;
    }
    bdk_smi_x_cmd_t smi_cmd;
    bdk_smi_x_rd_dat_t smi_rd;

    __bdk_mdio_set_clause22_mode(device, bus_id);

    smi_cmd.u = 0;
    smi_cmd.s.phy_op = MDIO_CLAUSE_22_READ;
    smi_cmd.s.phy_adr = phy_id;
    smi_cmd.s.reg_adr = location;
    BDK_BAR_WRITE(device, BDK_SMI_X_CMD(bus_id), smi_cmd.u);

    smi_rd = __bdk_mdio_read_rd_dat(device, bus_id);
    if (smi_rd.s.val)
        return smi_rd.s.dat;
    else
        return -1;
}


/**
 * Perform an MII write. This function is used to write PHY
 * registers controlling auto negotiation.
 *
 * @param bus_id   MDIO bus number. Zero on most chips, but some chips (ex CN56XX)
 *                 support multiple busses.
 * @param phy_id   The MII phy id
 * @param location Register location to write
 * @param val      Value to write
 *
 * @return -1 on error
 *         0 on success
 */
int bdk_mdio_write(bdk_node_t node, int bus_id, int phy_id, int location, int val)
{
    const bdk_device_t *device = bdk_device_lookup(node, MDIO_DEVID, 0);
    if (!device)
    {
        bdk_error("MDIO: ECAM device not found\n");
        return -1;
    }
    bdk_smi_x_cmd_t smi_cmd;
    bdk_smi_x_wr_dat_t smi_wr;

    __bdk_mdio_set_clause22_mode(device, bus_id);

    smi_wr.u = 0;
    smi_wr.s.dat = val;
    BDK_BAR_WRITE(device, BDK_SMI_X_WR_DAT(bus_id), smi_wr.u);

    smi_cmd.u = 0;
    smi_cmd.s.phy_op = MDIO_CLAUSE_22_WRITE;
    smi_cmd.s.phy_adr = phy_id;
    smi_cmd.s.reg_adr = location;
    BDK_BAR_WRITE(device, BDK_SMI_X_CMD(bus_id), smi_cmd.u);

    if (BDK_BAR_WAIT_FOR_FIELD(device, BDK_SMI_X_WR_DAT(bus_id), pending, ==, 0, BDK_MDIO_TIMEOUT))
        return -1;

    return 0;
}

/**
 * Perform an IEEE 802.3 clause 45 MII read. This function is used to read PHY
 * registers controlling auto negotiation.
 *
 * @param bus_id   MDIO bus number. Zero on most chips, but some chips (ex CN56XX)
 *                 support multiple busses.
 * @param phy_id   The MII phy id
 * @param device   MDIO Manageable Device (MMD) id
 * @param location Register location to read
 *
 * @return Result from the read or -1 on failure
 */

int bdk_mdio_45_read(bdk_node_t node, int bus_id, int phy_id, int device, int location)
{
    const bdk_device_t *ecam_device = bdk_device_lookup(node, MDIO_DEVID, 0);
    if (!ecam_device)
    {
        bdk_error("MDIO: ECAM device not found\n");
        return -1;
    }
    bdk_smi_x_cmd_t smi_cmd;
    bdk_smi_x_rd_dat_t smi_rd;
    bdk_smi_x_wr_dat_t smi_wr;

    __bdk_mdio_set_clause45_mode(ecam_device, bus_id);

    smi_wr.u = 0;
    smi_wr.s.dat = location;
    BDK_BAR_WRITE(ecam_device, BDK_SMI_X_WR_DAT(bus_id), smi_wr.u);

    smi_cmd.u = 0;
    smi_cmd.s.phy_op = MDIO_CLAUSE_45_ADDRESS;
    smi_cmd.s.phy_adr = phy_id;
    smi_cmd.s.reg_adr = device;
    BDK_BAR_WRITE(ecam_device, BDK_SMI_X_CMD(bus_id), smi_cmd.u);

    if (BDK_BAR_WAIT_FOR_FIELD(ecam_device, BDK_SMI_X_WR_DAT(bus_id), pending, ==, 0, BDK_MDIO_TIMEOUT))
    {
        bdk_error("bdk_mdio_45_read: bus_id %d phy_id %2d device %2d register %2d   TIME OUT(address)\n", bus_id, phy_id, device, location);
        return -1;
    }

    smi_cmd.u = 0;
    smi_cmd.s.phy_op = MDIO_CLAUSE_45_READ;
    smi_cmd.s.phy_adr = phy_id;
    smi_cmd.s.reg_adr = device;
    BDK_BAR_WRITE(ecam_device, BDK_SMI_X_CMD(bus_id), smi_cmd.u);

    smi_rd = __bdk_mdio_read_rd_dat(ecam_device, bus_id);
    if (smi_rd.s.pending)
    {
        bdk_error("bdk_mdio_45_read: bus_id %d phy_id %2d device %2d register %2d   TIME OUT(data)\n", bus_id, phy_id, device, location);
        return -1;
    }

    if (smi_rd.s.val)
        return smi_rd.s.dat;
    else
    {
        bdk_error("bdk_mdio_45_read: bus_id %d phy_id %2d device %2d register %2d   INVALID READ\n", bus_id, phy_id, device, location);
        return -1;
    }
}

/**
 * Perform an IEEE 802.3 clause 45 MII write. This function is used to write PHY
 * registers controlling auto negotiation.
 *
 * @param bus_id   MDIO bus number. Zero on most chips, but some chips (ex CN56XX)
 *                 support multiple busses.
 * @param phy_id   The MII phy id
 * @param device   MDIO Manageable Device (MMD) id
 * @param location Register location to write
 * @param val      Value to write
 *
 * @return -1 on error
 *         0 on success
 */
int bdk_mdio_45_write(bdk_node_t node, int bus_id, int phy_id, int device, int location,
                                     int val)
{
    const bdk_device_t *ecam_device = bdk_device_lookup(node, MDIO_DEVID, 0);
    if (!ecam_device)
    {
        bdk_error("MDIO: ECAM device not found\n");
        return -1;
    }
    bdk_smi_x_cmd_t smi_cmd;
    bdk_smi_x_wr_dat_t smi_wr;

    __bdk_mdio_set_clause45_mode(ecam_device, bus_id);

    smi_wr.u = 0;
    smi_wr.s.dat = location;
    BDK_BAR_WRITE(ecam_device, BDK_SMI_X_WR_DAT(bus_id), smi_wr.u);

    smi_cmd.u = 0;
    smi_cmd.s.phy_op = MDIO_CLAUSE_45_ADDRESS;
    smi_cmd.s.phy_adr = phy_id;
    smi_cmd.s.reg_adr = device;
    BDK_BAR_WRITE(ecam_device, BDK_SMI_X_CMD(bus_id), smi_cmd.u);

    if (BDK_BAR_WAIT_FOR_FIELD(ecam_device, BDK_SMI_X_WR_DAT(bus_id), pending, ==, 0, BDK_MDIO_TIMEOUT))
        return -1;

    smi_wr.u = 0;
    smi_wr.s.dat = val;
    BDK_BAR_WRITE(ecam_device, BDK_SMI_X_WR_DAT(bus_id), smi_wr.u);

    smi_cmd.u = 0;
    smi_cmd.s.phy_op = MDIO_CLAUSE_45_WRITE;
    smi_cmd.s.phy_adr = phy_id;
    smi_cmd.s.reg_adr = device;
    BDK_BAR_WRITE(ecam_device, BDK_SMI_X_CMD(bus_id), smi_cmd.u);

    if (BDK_BAR_WAIT_FOR_FIELD(ecam_device, BDK_SMI_X_WR_DAT(bus_id), pending, ==, 0, BDK_MDIO_TIMEOUT))
        return -1;

    return 0;
}

/**
 * MDIO init() function
 *
 * @param device MDIO/SMI to initialize
 *
 * @return Zero on success, negative on failure
 */
int bdk_mdio_init(bdk_node_t node)
{
    const bdk_device_t *device = bdk_device_lookup(node, MDIO_DEVID, 0);
    if (!device)
    {
        bdk_error("MDIO: ECAM device not found\n");
        return -1;
    }
    /* Change drive strength bits to fix issues when a QLM cable
       is connected, creating a long spur path */
    BDK_CSR_MODIFY(c, device->node, BDK_SMI_DRV_CTL,
        c.s.pctl = 7; /* 30 ohm */
        c.s.nctl = 7); /* 30 ohm */

    for (int i = 0; i < 2; i++)
        BDK_BAR_MODIFY(c, device, BDK_SMI_X_EN(i), c.s.en = 1);

    return 0;
}