root/drivers/net/ethernet/freescale/enetc/enetc_msg.c
// SPDX-License-Identifier: (GPL-2.0+ OR BSD-3-Clause)
/* Copyright 2017-2019 NXP */

#include "enetc_pf_common.h"

#define ENETC_PF_MSG_SUCCESS    FIELD_PREP(ENETC_PF_MSG_CLASS_ID, \
                                           ENETC_MSG_CLASS_ID_CMD_SUCCESS)
#define ENETC_PF_MSG_NOTSUPP    FIELD_PREP(ENETC_PF_MSG_CLASS_ID, \
                                           ENETC_MSG_CLASS_ID_CMD_NOT_SUPPORT)

static void enetc_msg_disable_mr_int(struct enetc_pf *pf)
{
        struct enetc_hw *hw = &pf->si->hw;
        u32 psiier;

        psiier = enetc_rd(hw, ENETC_PSIIER) & ~ENETC_PSIMR_MASK(pf->num_vfs);

        /* disable MR int source(s) */
        enetc_wr(hw, ENETC_PSIIER, psiier);
}

static void enetc_msg_enable_mr_int(struct enetc_pf *pf)
{
        struct enetc_hw *hw = &pf->si->hw;
        u32 psiier;

        psiier = enetc_rd(hw, ENETC_PSIIER) | ENETC_PSIMR_MASK(pf->num_vfs);

        enetc_wr(hw, ENETC_PSIIER, psiier);
}

static irqreturn_t enetc_msg_psi_msix(int irq, void *data)
{
        struct enetc_si *si = (struct enetc_si *)data;
        struct enetc_pf *pf = enetc_si_priv(si);

        enetc_msg_disable_mr_int(pf);
        schedule_work(&pf->msg_task);

        return IRQ_HANDLED;
}

/* Messaging */
static bool enetc_msg_check_crc16(void *msg_addr, u32 msg_size)
{
        u32 data_size = msg_size - 2;
        u8 *data_buf = msg_addr + 2;
        u16 verify_val;

        verify_val = crc_itu_t(ENETC_CRC_INIT, data_buf, data_size);
        verify_val = crc_itu_t(verify_val, msg_addr, 2);
        if (verify_val)
                return false;

        return true;
}

static u16 enetc_msg_set_vf_primary_mac_addr(struct enetc_pf *pf, int vf_id,
                                             void *vf_msg)
{
        struct enetc_vf_state *vf_state = &pf->vf_state[vf_id];
        struct enetc_msg_mac_exact_filter *msg = vf_msg;
        struct device *dev = &pf->si->pdev->dev;
        char *addr = msg->mac[0].addr;

        if (!is_valid_ether_addr(addr)) {
                dev_err_ratelimited(dev, "VF%d attempted to set invalid MAC\n",
                                    vf_id);
                return (FIELD_PREP(ENETC_PF_MSG_CLASS_ID,
                                   ENETC_MSG_CLASS_ID_MAC_FILTER) |
                        FIELD_PREP(ENETC_PF_MSG_CLASS_CODE,
                                   ENETC_MF_CLASS_CODE_INVALID_MAC));
        }

        mutex_lock(&vf_state->lock);
        if (vf_state->flags & ENETC_VF_FLAG_PF_SET_MAC) {
                mutex_unlock(&vf_state->lock);
                dev_err_ratelimited(dev,
                                    "VF%d attempted to override PF set MAC\n",
                                    vf_id);
                return FIELD_PREP(ENETC_PF_MSG_CLASS_ID,
                                  ENETC_MSG_CLASS_ID_CMD_NOT_PERMITTED);
        }

        enetc_set_si_hw_addr(pf, vf_id + 1, addr);
        mutex_unlock(&vf_state->lock);

        return ENETC_PF_MSG_SUCCESS;
}

static u16 enetc_msg_handle_mac_filter(struct enetc_pf *pf, int vf_id,
                                       void *vf_msg)
{
        struct enetc_msg_header *msg_hdr = vf_msg;

        switch (msg_hdr->cmd_id) {
        case ENETC_MSG_SET_PRIMARY_MAC:
                return enetc_msg_set_vf_primary_mac_addr(pf, vf_id, vf_msg);
        default:
                return ENETC_PF_MSG_NOTSUPP;
        }
}

static u16 enetc_msg_handle_ip_revision(struct enetc_pf *pf, void *vf_msg)
{
        struct enetc_msg_header *msg_hdr = vf_msg;

        switch (msg_hdr->cmd_id) {
        case ENETC_MSG_GET_IP_MN:
                return (FIELD_PREP(ENETC_PF_MSG_CLASS_ID,
                                   ENETC_MSG_CLASS_ID_IP_REVISION) |
                        FIELD_PREP(ENETC_PF_MSG_CLASS_CODE_U8,
                                   pf->si->revision));
        default:
                return ENETC_PF_MSG_NOTSUPP;
        }
}

static void enetc_msg_handle_rxmsg(struct enetc_pf *pf, int vf_id,
                                   u16 *pf_msg)
{
        struct enetc_msg_swbd *msg_swbd = &pf->rxmsg[vf_id];
        struct enetc_msg_header *msg_hdr = msg_swbd->vaddr;
        u32 msg_size = ENETC_MSG_SIZE(msg_hdr->len);
        struct device *dev = &pf->si->pdev->dev;
        u8 *msg;

        if (msg_size > ENETC_DEFAULT_MSG_SIZE) {
                dev_err_ratelimited(dev,
                                    "Invalid message size: %u\n", msg_size);
                *pf_msg = FIELD_PREP(ENETC_PF_MSG_CLASS_ID,
                                     ENETC_MSG_CLASS_ID_INVALID_MSG_LEN);
                return;
        }

        /* To prevent malicious VF from tampering with the original data by
         * sending new messages after passing the check, the DMA buffer data
         * is copied to the msg buffer before validation.
         */
        msg = kzalloc_objs(*msg, msg_size);
        if (!msg) {
                dev_err_ratelimited(dev,
                                    "Failed to allocate message buffer\n");
                *pf_msg = FIELD_PREP(ENETC_PF_MSG_CLASS_ID,
                                     ENETC_MSG_CLASS_ID_CMD_FAIL);
                return;
        }

        memcpy(msg, msg_swbd->vaddr, msg_size);
        if (!enetc_msg_check_crc16(msg, msg_size)) {
                dev_err_ratelimited(dev, "VSI to PSI Message CRC16 error\n");
                *pf_msg = FIELD_PREP(ENETC_PF_MSG_CLASS_ID,
                                     ENETC_MSG_CLASS_ID_CRC_ERROR);

                goto free_msg;
        }

        /* Default to not supported */
        *pf_msg = ENETC_PF_MSG_NOTSUPP;
        msg_hdr = (struct enetc_msg_header *)msg;

        /* Currently, asynchronous actions are not supported */
        if (FIELD_GET(ENETC_VF_MSG_COOKIE, msg_hdr->cookie)) {
                dev_err_ratelimited(dev,
                                    "Cookie field is not supported yet\n");
                goto free_msg;
        }

        /* Currently only support protocol version 0 */
        if (msg_hdr->proto_ver) {
                dev_err_ratelimited(dev, "Unsupported protocol version %u\n",
                                    msg_hdr->proto_ver);
                goto free_msg;
        }

        /* The new messages are currently only supported on ENETC v4. If v1
         * requires them, the current restriction can be lifted.
         */
        if (is_enetc_rev1(pf->si) &&
            !(msg_hdr->class_id == ENETC_MSG_CLASS_ID_MAC_FILTER &&
              msg_hdr->cmd_id == ENETC_MSG_SET_PRIMARY_MAC)) {
                dev_err_ratelimited(dev, "Unsupported message for ENETC v1\n");

                goto free_msg;
        }

        switch (msg_hdr->class_id) {
        case ENETC_MSG_CLASS_ID_MAC_FILTER:
                *pf_msg = enetc_msg_handle_mac_filter(pf, vf_id, msg);
                break;
        case ENETC_MSG_CLASS_ID_IP_REVISION:
                *pf_msg = enetc_msg_handle_ip_revision(pf, msg);
                break;
        default:
                dev_err_ratelimited(dev,
                                    "Unsupported message class ID: 0x%x\n",
                                    msg_hdr->class_id);
        }

free_msg:
        kfree(msg);
}

static void enetc_msg_task(struct work_struct *work)
{
        struct enetc_pf *pf = container_of(work, struct enetc_pf, msg_task);
        u32 mr_mask = ENETC_PSIMR_MASK(pf->num_vfs);
        struct enetc_hw *hw = &pf->si->hw;
        u32 mr_status;
        int i;

        mr_status = (enetc_rd(hw, ENETC_PSIMSGRR) & mr_mask) |
                    (enetc_rd(hw, ENETC_PSIIDR) & mr_mask);
        if (!mr_status)
                goto out;

        for (i = 0; i < pf->num_vfs; i++) {
                u32 psimsgrr;
                u16 msg_code;

                if (!(ENETC_PSIMR_BIT(i) & mr_status))
                        continue;

                enetc_msg_handle_rxmsg(pf, i, &msg_code);

                /* w1c to clear the corresponding VF MR bit */
                enetc_wr(hw, ENETC_PSIIDR, ENETC_PSIMR_BIT(i));

                psimsgrr = ENETC_SIMSGSR_SET_MC(msg_code);
                psimsgrr |= ENETC_PSIMR_BIT(i); /* w1c */
                enetc_wr(hw, ENETC_PSIMSGRR, psimsgrr);
        }

out:
        enetc_msg_enable_mr_int(pf);
}

/* Init */
static int enetc_msg_alloc_mbx(struct enetc_si *si, int idx)
{
        struct enetc_pf *pf = enetc_si_priv(si);
        struct device *dev = &si->pdev->dev;
        struct enetc_hw *hw = &si->hw;
        struct enetc_msg_swbd *msg;
        u32 val;

        msg = &pf->rxmsg[idx];
        /* allocate and set receive buffer */
        msg->size = ENETC_DEFAULT_MSG_SIZE;

        msg->vaddr = dma_alloc_coherent(dev, msg->size, &msg->dma,
                                        GFP_KERNEL);
        if (!msg->vaddr) {
                dev_err(dev, "msg: fail to alloc dma buffer of size: %d\n",
                        msg->size);
                return -ENOMEM;
        }

        /* set multiple of 32 bytes */
        val = lower_32_bits(msg->dma);
        enetc_wr(hw, ENETC_PSIVMSGRCVAR0(idx), val);
        val = upper_32_bits(msg->dma);
        enetc_wr(hw, ENETC_PSIVMSGRCVAR1(idx), val);

        return 0;
}

static void enetc_msg_free_mbx(struct enetc_si *si, int idx)
{
        struct enetc_pf *pf = enetc_si_priv(si);
        struct enetc_hw *hw = &si->hw;
        struct enetc_msg_swbd *msg;

        enetc_wr(hw, ENETC_PSIVMSGRCVAR0(idx), 0);
        enetc_wr(hw, ENETC_PSIVMSGRCVAR1(idx), 0);

        msg = &pf->rxmsg[idx];
        dma_free_coherent(&si->pdev->dev, msg->size, msg->vaddr, msg->dma);
        memset(msg, 0, sizeof(*msg));
}

static int enetc_msg_psi_init(struct enetc_pf *pf)
{
        struct enetc_si *si = pf->si;
        int vector, i, err;

        for (i = 0; i < pf->num_vfs; i++) {
                err = enetc_msg_alloc_mbx(si, i);
                if (err)
                        goto free_mbx;
        }

        /* initialize PSI mailbox */
        INIT_WORK(&pf->msg_task, enetc_msg_task);

        /* register message passing interrupt handler */
        snprintf(pf->msg_int_name, sizeof(pf->msg_int_name), "%s-vfmsg",
                 si->ndev->name);
        vector = pci_irq_vector(si->pdev, ENETC_SI_INT_IDX);
        err = request_irq(vector, enetc_msg_psi_msix, 0, pf->msg_int_name, si);
        if (err) {
                dev_err(&si->pdev->dev,
                        "PSI messaging: request_irq() failed!\n");
                goto free_mbx;
        }

        /* set one IRQ entry for PSI message receive notification (SI int) */
        enetc_wr(&si->hw, ENETC_SIMSIVR, ENETC_SI_INT_IDX);

        /* enable MR interrupts */
        enetc_msg_enable_mr_int(pf);

        return 0;

free_mbx:
        for (i--; i >= 0; i--)
                enetc_msg_free_mbx(si, i);

        return err;
}

static void enetc_msg_psi_free(struct enetc_pf *pf)
{
        struct enetc_si *si = pf->si;
        int i;

        /* disable MR interrupts */
        enetc_msg_disable_mr_int(pf);

        /* de-register message passing interrupt handler */
        free_irq(pci_irq_vector(si->pdev, ENETC_SI_INT_IDX), si);

        cancel_work_sync(&pf->msg_task);

        /* MR interrupts may be re-enabled by workqueue */
        enetc_msg_disable_mr_int(pf);

        for (i = 0; i < pf->num_vfs; i++)
                enetc_msg_free_mbx(si, i);
}

int enetc_sriov_configure(struct pci_dev *pdev, int num_vfs)
{
        struct enetc_si *si = pci_get_drvdata(pdev);
        struct enetc_pf *pf = enetc_si_priv(si);
        int err;

        if (!num_vfs) {
                pci_disable_sriov(pdev);
                enetc_msg_psi_free(pf);
                pf->num_vfs = 0;
        } else {
                pf->num_vfs = num_vfs;

                err = enetc_msg_psi_init(pf);
                if (err) {
                        dev_err(&pdev->dev, "enetc_msg_psi_init (%d)\n", err);
                        goto err_msg_psi;
                }

                err = pci_enable_sriov(pdev, num_vfs);
                if (err) {
                        dev_err(&pdev->dev, "pci_enable_sriov err %d\n", err);
                        goto err_en_sriov;
                }
        }

        return num_vfs;

err_en_sriov:
        enetc_msg_psi_free(pf);
err_msg_psi:
        pf->num_vfs = 0;

        return err;
}
EXPORT_SYMBOL_GPL(enetc_sriov_configure);