root/drivers/net/ethernet/mellanox/mlx5/core/en_selftest.c
/*
 * Copyright (c) 2016, Mellanox Technologies, Ltd.  All rights reserved.
 *
 * This software is available to you under a choice of one of two
 * licenses.  You may choose to be licensed under the terms of the GNU
 * General Public License (GPL) Version 2, available from the file
 * COPYING in the main directory of this source tree, or the
 * OpenIB.org BSD license below:
 *
 *     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.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#include <linux/ip.h>
#include <linux/udp.h>
#include <net/udp.h>
#include "en.h"
#include "en/port.h"
#include "eswitch.h"
#include "lib/mlx5.h"

static int mlx5e_test_health_info(struct mlx5e_priv *priv)
{
        struct mlx5_core_health *health = &priv->mdev->priv.health;

        return health->fatal_error ? 1 : 0;
}

static int mlx5e_test_link_state(struct mlx5e_priv *priv)
{
        u8 port_state;

        if (!netif_carrier_ok(priv->netdev))
                return 1;

        port_state = mlx5_query_vport_state(priv->mdev, MLX5_VPORT_STATE_OP_MOD_VNIC_VPORT, 0);
        return port_state == VPORT_STATE_UP ? 0 : 1;
}

static int mlx5e_test_link_speed(struct mlx5e_priv *priv)
{
        u32 speed;

        if (!netif_carrier_ok(priv->netdev))
                return 1;

        return mlx5e_port_linkspeed(priv->mdev, &speed);
}

struct mlx5ehdr {
        __be32 version;
        __be64 magic;
};

#ifdef CONFIG_INET
/* loopback test */
#define MLX5E_TEST_PKT_SIZE (sizeof(struct ethhdr) + sizeof(struct iphdr) +\
                             sizeof(struct udphdr) + sizeof(struct mlx5ehdr))
#define MLX5E_TEST_MAGIC 0x5AEED15C001ULL

static struct sk_buff *mlx5e_test_get_udp_skb(struct mlx5e_priv *priv)
{
        struct sk_buff *skb = NULL;
        struct mlx5ehdr *mlxh;
        struct ethhdr *ethh;
        struct udphdr *udph;
        struct iphdr *iph;
        int    iplen;

        skb = netdev_alloc_skb(priv->netdev, MLX5E_TEST_PKT_SIZE);
        if (!skb) {
                netdev_err(priv->netdev, "\tFailed to alloc loopback skb\n");
                return NULL;
        }

        net_prefetchw(skb->data);
        skb_reserve(skb, NET_IP_ALIGN);

        /*  Reserve for ethernet and IP header  */
        ethh = skb_push(skb, ETH_HLEN);
        skb_reset_mac_header(skb);

        skb_set_network_header(skb, skb->len);
        iph = skb_put(skb, sizeof(struct iphdr));

        skb_set_transport_header(skb, skb->len);
        udph = skb_put(skb, sizeof(struct udphdr));

        /* Fill ETH header */
        ether_addr_copy(ethh->h_dest, priv->netdev->dev_addr);
        eth_zero_addr(ethh->h_source);
        ethh->h_proto = htons(ETH_P_IP);

        /* Fill UDP header */
        udph->source = htons(9);
        udph->dest = htons(9); /* Discard Protocol */
        udph->len = htons(sizeof(struct mlx5ehdr) + sizeof(struct udphdr));
        udph->check = 0;

        /* Fill IP header */
        iph->ihl = 5;
        iph->ttl = 32;
        iph->version = 4;
        iph->protocol = IPPROTO_UDP;
        iplen = sizeof(struct iphdr) + sizeof(struct udphdr) +
                sizeof(struct mlx5ehdr);
        iph->tot_len = htons(iplen);
        iph->frag_off = 0;
        iph->saddr = 0;
        iph->daddr = 0;
        iph->tos = 0;
        iph->id = 0;
        ip_send_check(iph);

        /* Fill test header and data */
        mlxh = skb_put(skb, sizeof(*mlxh));
        mlxh->version = 0;
        mlxh->magic = cpu_to_be64(MLX5E_TEST_MAGIC);

        skb->csum = 0;
        skb->ip_summed = CHECKSUM_PARTIAL;
        udp4_hwcsum(skb, iph->saddr, iph->daddr);

        skb->protocol = htons(ETH_P_IP);
        skb->pkt_type = PACKET_HOST;
        skb->dev = priv->netdev;

        return skb;
}

struct mlx5e_lbt_priv {
        struct packet_type pt;
        struct completion comp;
        bool loopback_ok;
        bool local_lb;
};

static int
mlx5e_test_loopback_validate(struct sk_buff *skb,
                             struct net_device *ndev,
                             struct packet_type *pt,
                             struct net_device *orig_ndev)
{
        struct mlx5e_lbt_priv *lbtp = pt->af_packet_priv;
        struct mlx5ehdr *mlxh;
        struct ethhdr *ethh;
        struct udphdr *udph;
        struct iphdr *iph;

        if (skb_linearize(skb))
                goto out;

        /* We are only going to peek, no need to clone the SKB */
        if (MLX5E_TEST_PKT_SIZE - ETH_HLEN > skb_headlen(skb))
                goto out;

        ethh = (struct ethhdr *)skb_mac_header(skb);
        if (!ether_addr_equal(ethh->h_dest, orig_ndev->dev_addr))
                goto out;

        iph = ip_hdr(skb);
        if (iph->protocol != IPPROTO_UDP)
                goto out;

        /* Don't assume skb_transport_header() was set */
        udph = (struct udphdr *)((u8 *)iph + 4 * iph->ihl);
        if (udph->dest != htons(9))
                goto out;

        mlxh = (struct mlx5ehdr *)((char *)udph + sizeof(*udph));
        if (mlxh->magic != cpu_to_be64(MLX5E_TEST_MAGIC))
                goto out; /* so close ! */

        /* bingo */
        lbtp->loopback_ok = true;
        complete(&lbtp->comp);
out:
        kfree_skb(skb);
        return 0;
}

static int mlx5e_test_loopback_setup(struct mlx5e_priv *priv,
                                     struct mlx5e_lbt_priv *lbtp)
{
        int err = 0;

        /* Temporarily enable local_lb */
        err = mlx5_nic_vport_query_local_lb(priv->mdev, &lbtp->local_lb);
        if (err)
                return err;

        if (!lbtp->local_lb) {
                err = mlx5_nic_vport_update_local_lb(priv->mdev, true);
                if (err)
                        return err;
        }

        err = mlx5e_modify_tirs_lb(priv->mdev, true, false);
        if (err)
                goto out;

        lbtp->loopback_ok = false;
        init_completion(&lbtp->comp);

        lbtp->pt.type = htons(ETH_P_IP);
        lbtp->pt.func = mlx5e_test_loopback_validate;
        lbtp->pt.dev = priv->netdev;
        lbtp->pt.af_packet_priv = lbtp;
        dev_add_pack(&lbtp->pt);

        return 0;

out:
        if (!lbtp->local_lb)
                mlx5_nic_vport_update_local_lb(priv->mdev, false);

        return err;
}

static void mlx5e_test_loopback_cleanup(struct mlx5e_priv *priv,
                                        struct mlx5e_lbt_priv *lbtp)
{
        if (!lbtp->local_lb)
                mlx5_nic_vport_update_local_lb(priv->mdev, false);

        dev_remove_pack(&lbtp->pt);
        mlx5e_modify_tirs_lb(priv->mdev, false, false);
}

static int mlx5e_cond_loopback(struct mlx5e_priv *priv)
{
        if (is_mdev_switchdev_mode(priv->mdev))
                return -EOPNOTSUPP;

        if (mlx5_get_sd(priv->mdev))
                return -EOPNOTSUPP;

        return 0;
}

#define MLX5E_LB_VERIFY_TIMEOUT (msecs_to_jiffies(200))
static int mlx5e_test_loopback(struct mlx5e_priv *priv)
{
        struct mlx5e_lbt_priv *lbtp;
        struct sk_buff *skb = NULL;
        int err;

        if (!test_bit(MLX5E_STATE_OPENED, &priv->state)) {
                netdev_err(priv->netdev,
                           "\tCan't perform loopback test while device is down\n");
                return -ENODEV;
        }

        lbtp = kzalloc_obj(*lbtp);
        if (!lbtp)
                return -ENOMEM;
        lbtp->loopback_ok = false;

        err = mlx5e_test_loopback_setup(priv, lbtp);
        if (err)
                goto out;

        skb = mlx5e_test_get_udp_skb(priv);
        if (!skb) {
                err = -ENOMEM;
                goto cleanup;
        }

        skb_set_queue_mapping(skb, 0);
        err = dev_queue_xmit(skb);
        if (err) {
                netdev_err(priv->netdev,
                           "\tFailed to xmit loopback packet err(%d)\n",
                           err);
                goto cleanup;
        }

        wait_for_completion_timeout(&lbtp->comp, MLX5E_LB_VERIFY_TIMEOUT);
        err = !lbtp->loopback_ok;

cleanup:
        mlx5e_test_loopback_cleanup(priv, lbtp);
out:
        kfree(lbtp);
        return err;
}
#endif

typedef int (*mlx5e_st_func)(struct mlx5e_priv *);

struct mlx5e_st {
        char name[ETH_GSTRING_LEN];
        mlx5e_st_func st_func;
        mlx5e_st_func cond_func;
};

static struct mlx5e_st mlx5e_sts[] = {
        { "Link Test", mlx5e_test_link_state },
        { "Speed Test", mlx5e_test_link_speed },
        { "Health Test", mlx5e_test_health_info },
#ifdef CONFIG_INET
        { "Loopback Test", mlx5e_test_loopback, mlx5e_cond_loopback },
#endif
};

#define MLX5E_ST_NUM ARRAY_SIZE(mlx5e_sts)

void mlx5e_self_test(struct net_device *ndev, struct ethtool_test *etest,
                     u64 *buf)
{
        struct mlx5e_priv *priv = netdev_priv(ndev);
        int i, count = 0;

        mutex_lock(&priv->state_lock);
        netdev_info(ndev, "Self test begin..\n");

        for (i = 0; i < MLX5E_ST_NUM; i++) {
                struct mlx5e_st st = mlx5e_sts[i];

                if (st.cond_func && st.cond_func(priv))
                        continue;
                netdev_info(ndev, "\t[%d] %s start..\n", i, st.name);
                buf[count] = st.st_func(priv);
                netdev_info(ndev, "\t[%d] %s end: result(%lld)\n", i, st.name, buf[count]);
                count++;
        }

        mutex_unlock(&priv->state_lock);

        for (i = 0; i < count; i++) {
                if (buf[i]) {
                        etest->flags |= ETH_TEST_FL_FAILED;
                        break;
                }
        }
        netdev_info(ndev, "Self test out: status flags(0x%x)\n",
                    etest->flags);
}

int mlx5e_self_test_fill_strings(struct mlx5e_priv *priv, u8 *data)
{
        int i, count = 0;

        for (i = 0; i < MLX5E_ST_NUM; i++) {
                struct mlx5e_st st = mlx5e_sts[i];

                if (st.cond_func && st.cond_func(priv))
                        continue;
                if (data)
                        ethtool_puts(&data, st.name);
                count++;
        }
        return count;
}

int mlx5e_self_test_num(struct mlx5e_priv *priv)
{
        return mlx5e_self_test_fill_strings(priv, NULL);
}