// SPDX-License-Identifier: GPL-2.0-only
/****************************************************************************
 * Driver for Solarflare network controllers and boards
 * Copyright 2005-2006 Fen Systems Ltd.
 * Copyright 2006-2013 Solarflare Communications Inc.
 */

#include <linux/netdevice.h>
#include <linux/ethtool.h>
#include <linux/rtnetlink.h>
#include <linux/in.h>
#include "net_driver.h"
#include "workarounds.h"
#include "selftest.h"
#include "efx.h"
#include "efx_channels.h"
#include "rx_common.h"
#include "tx_common.h"
#include "ethtool_common.h"
#include "filter.h"
#include "nic.h"

#define EFX_ETHTOOL_EEPROM_MAGIC 0xEFAB

/**************************************************************************
 *
 * Ethtool operations
 *
 **************************************************************************
 */

/* Identify device by flashing LEDs */
static int efx_ethtool_phys_id(struct net_device *net_dev,
                               enum ethtool_phys_id_state state)
{
        struct efx_nic *efx = netdev_priv(net_dev);
        enum efx_led_mode mode = EFX_LED_DEFAULT;

        switch (state) {
        case ETHTOOL_ID_ON:
                mode = EFX_LED_ON;
                break;
        case ETHTOOL_ID_OFF:
                mode = EFX_LED_OFF;
                break;
        case ETHTOOL_ID_INACTIVE:
                mode = EFX_LED_DEFAULT;
                break;
        case ETHTOOL_ID_ACTIVE:
                return 1;       /* cycle on/off once per second */
        }

        return efx_mcdi_set_id_led(efx, mode);
}

static int efx_ethtool_get_regs_len(struct net_device *net_dev)
{
        return efx_nic_get_regs_len(netdev_priv(net_dev));
}

static void efx_ethtool_get_regs(struct net_device *net_dev,
                                 struct ethtool_regs *regs, void *buf)
{
        struct efx_nic *efx = netdev_priv(net_dev);

        regs->version = efx->type->revision;
        efx_nic_get_regs(efx, buf);
}

/*
 * Each channel has a single IRQ and moderation timer, started by any
 * completion (or other event).  Unless the module parameter
 * separate_tx_channels is set, IRQs and moderation are therefore
 * shared between RX and TX completions.  In this case, when RX IRQ
 * moderation is explicitly changed then TX IRQ moderation is
 * automatically changed too, but otherwise we fail if the two values
 * are requested to be different.
 *
 * The hardware does not support a limit on the number of completions
 * before an IRQ, so we do not use the max_frames fields.  We should
 * report and require that max_frames == (usecs != 0), but this would
 * invalidate existing user documentation.
 *
 * The hardware does not have distinct settings for interrupt
 * moderation while the previous IRQ is being handled, so we should
 * not use the 'irq' fields.  However, an earlier developer
 * misunderstood the meaning of the 'irq' fields and the driver did
 * not support the standard fields.  To avoid invalidating existing
 * user documentation, we report and accept changes through either the
 * standard or 'irq' fields.  If both are changed at the same time, we
 * prefer the standard field.
 *
 * We implement adaptive IRQ moderation, but use a different algorithm
 * from that assumed in the definition of struct ethtool_coalesce.
 * Therefore we do not use any of the adaptive moderation parameters
 * in it.
 */

static int efx_ethtool_get_coalesce(struct net_device *net_dev,
                                    struct ethtool_coalesce *coalesce)
{
        struct efx_nic *efx = netdev_priv(net_dev);
        unsigned int tx_usecs, rx_usecs;
        bool rx_adaptive;

        efx_get_irq_moderation(efx, &tx_usecs, &rx_usecs, &rx_adaptive);

        coalesce->tx_coalesce_usecs = tx_usecs;
        coalesce->tx_coalesce_usecs_irq = tx_usecs;
        coalesce->rx_coalesce_usecs = rx_usecs;
        coalesce->rx_coalesce_usecs_irq = rx_usecs;
        coalesce->use_adaptive_rx_coalesce = rx_adaptive;

        return 0;
}

static int efx_ethtool_set_coalesce(struct net_device *net_dev,
                                    struct ethtool_coalesce *coalesce)
{
        struct efx_nic *efx = netdev_priv(net_dev);
        struct efx_channel *channel;
        unsigned int tx_usecs, rx_usecs;
        bool adaptive, rx_may_override_tx;
        int rc;

        efx_get_irq_moderation(efx, &tx_usecs, &rx_usecs, &adaptive);

        if (coalesce->rx_coalesce_usecs != rx_usecs)
                rx_usecs = coalesce->rx_coalesce_usecs;
        else
                rx_usecs = coalesce->rx_coalesce_usecs_irq;

        adaptive = coalesce->use_adaptive_rx_coalesce;

        /* If channels are shared, TX IRQ moderation can be quietly
         * overridden unless it is changed from its old value.
         */
        rx_may_override_tx = (coalesce->tx_coalesce_usecs == tx_usecs &&
                              coalesce->tx_coalesce_usecs_irq == tx_usecs);
        if (coalesce->tx_coalesce_usecs != tx_usecs)
                tx_usecs = coalesce->tx_coalesce_usecs;
        else
                tx_usecs = coalesce->tx_coalesce_usecs_irq;

        rc = efx_init_irq_moderation(efx, tx_usecs, rx_usecs, adaptive,
                                     rx_may_override_tx);
        if (rc != 0)
                return rc;

        efx_for_each_channel(channel, efx)
                efx->type->push_irq_moderation(channel);

        return 0;
}

static void efx_ethtool_get_ringparam(struct net_device *net_dev,
                                      struct ethtool_ringparam *ring)
{
        struct efx_nic *efx = netdev_priv(net_dev);

        ring->rx_max_pending = EFX_MAX_DMAQ_SIZE;
        ring->tx_max_pending = EFX_TXQ_MAX_ENT(efx);
        ring->rx_pending = efx->rxq_entries;
        ring->tx_pending = efx->txq_entries;
}

static int efx_ethtool_set_ringparam(struct net_device *net_dev,
                                     struct ethtool_ringparam *ring)
{
        struct efx_nic *efx = netdev_priv(net_dev);
        u32 txq_entries;

        if (ring->rx_mini_pending || ring->rx_jumbo_pending ||
            ring->rx_pending > EFX_MAX_DMAQ_SIZE ||
            ring->tx_pending > EFX_TXQ_MAX_ENT(efx))
                return -EINVAL;

        if (ring->rx_pending < EFX_RXQ_MIN_ENT) {
                netif_err(efx, drv, efx->net_dev,
                          "RX queues cannot be smaller than %u\n",
                          EFX_RXQ_MIN_ENT);
                return -EINVAL;
        }

        txq_entries = max(ring->tx_pending, EFX_TXQ_MIN_ENT(efx));
        if (txq_entries != ring->tx_pending)
                netif_warn(efx, drv, efx->net_dev,
                           "increasing TX queue size to minimum of %u\n",
                           txq_entries);

        return efx_realloc_channels(efx, ring->rx_pending, txq_entries);
}

static void efx_ethtool_get_wol(struct net_device *net_dev,
                                struct ethtool_wolinfo *wol)
{
        struct efx_nic *efx = netdev_priv(net_dev);
        return efx->type->get_wol(efx, wol);
}


static int efx_ethtool_set_wol(struct net_device *net_dev,
                               struct ethtool_wolinfo *wol)
{
        struct efx_nic *efx = netdev_priv(net_dev);
        return efx->type->set_wol(efx, wol->wolopts);
}

static void efx_ethtool_get_fec_stats(struct net_device *net_dev,
                                      struct ethtool_fec_stats *fec_stats)
{
        struct efx_nic *efx = netdev_priv(net_dev);

        if (efx->type->get_fec_stats)
                efx->type->get_fec_stats(efx, fec_stats);
}

static int efx_ethtool_get_ts_info(struct net_device *net_dev,
                                   struct ethtool_ts_info *ts_info)
{
        struct efx_nic *efx = netdev_priv(net_dev);

        /* Software capabilities */
        ts_info->so_timestamping = (SOF_TIMESTAMPING_RX_SOFTWARE |
                                    SOF_TIMESTAMPING_SOFTWARE);
        ts_info->phc_index = -1;

        efx_ptp_get_ts_info(efx, ts_info);
        return 0;
}

const struct ethtool_ops efx_ethtool_ops = {
        .supported_coalesce_params = ETHTOOL_COALESCE_USECS |
                                     ETHTOOL_COALESCE_USECS_IRQ |
                                     ETHTOOL_COALESCE_USE_ADAPTIVE_RX,
        .get_drvinfo            = efx_ethtool_get_drvinfo,
        .get_regs_len           = efx_ethtool_get_regs_len,
        .get_regs               = efx_ethtool_get_regs,
        .get_msglevel           = efx_ethtool_get_msglevel,
        .set_msglevel           = efx_ethtool_set_msglevel,
        .get_link               = ethtool_op_get_link,
        .get_coalesce           = efx_ethtool_get_coalesce,
        .set_coalesce           = efx_ethtool_set_coalesce,
        .get_ringparam          = efx_ethtool_get_ringparam,
        .set_ringparam          = efx_ethtool_set_ringparam,
        .get_pauseparam         = efx_ethtool_get_pauseparam,
        .set_pauseparam         = efx_ethtool_set_pauseparam,
        .get_sset_count         = efx_ethtool_get_sset_count,
        .self_test              = efx_ethtool_self_test,
        .get_strings            = efx_ethtool_get_strings,
        .set_phys_id            = efx_ethtool_phys_id,
        .get_ethtool_stats      = efx_ethtool_get_stats,
        .get_wol                = efx_ethtool_get_wol,
        .set_wol                = efx_ethtool_set_wol,
        .reset                  = efx_ethtool_reset,
        .get_rxnfc              = efx_ethtool_get_rxnfc,
        .set_rxnfc              = efx_ethtool_set_rxnfc,
        .get_rxfh_indir_size    = efx_ethtool_get_rxfh_indir_size,
        .get_rxfh_key_size      = efx_ethtool_get_rxfh_key_size,
        .get_rxfh               = efx_ethtool_get_rxfh,
        .set_rxfh               = efx_ethtool_set_rxfh,
        .get_rxfh_context       = efx_ethtool_get_rxfh_context,
        .set_rxfh_context       = efx_ethtool_set_rxfh_context,
        .get_ts_info            = efx_ethtool_get_ts_info,
        .get_module_info        = efx_ethtool_get_module_info,
        .get_module_eeprom      = efx_ethtool_get_module_eeprom,
        .get_link_ksettings     = efx_ethtool_get_link_ksettings,
        .set_link_ksettings     = efx_ethtool_set_link_ksettings,
        .get_fec_stats          = efx_ethtool_get_fec_stats,
        .get_fecparam           = efx_ethtool_get_fecparam,
        .set_fecparam           = efx_ethtool_set_fecparam,
};