root/drivers/net/ethernet/stmicro/stmmac/dwxgmac2_descs.c
// SPDX-License-Identifier: (GPL-2.0 OR MIT)
/*
 * Copyright (c) 2018 Synopsys, Inc. and/or its affiliates.
 * stmmac XGMAC support.
 */

#include <linux/bitfield.h>
#include <linux/stmmac.h>
#include "common.h"
#include "dwxgmac2.h"

static int dwxgmac2_get_tx_status(struct stmmac_extra_stats *x,
                                  struct dma_desc *p, void __iomem *ioaddr)
{
        u32 tdes3 = le32_to_cpu(p->des3);
        int ret = tx_done;

        if (unlikely(tdes3 & XGMAC_TDES3_OWN))
                return tx_dma_own;
        if (likely(!(tdes3 & XGMAC_TDES3_LD)))
                return tx_not_ls;

        return ret;
}

static int dwxgmac2_get_rx_status(struct stmmac_extra_stats *x,
                                  struct dma_desc *p)
{
        u32 rdes3 = le32_to_cpu(p->des3);

        if (unlikely(rdes3 & XGMAC_RDES3_OWN))
                return dma_own;
        if (unlikely(rdes3 & XGMAC_RDES3_CTXT))
                return discard_frame;
        if (likely(!(rdes3 & XGMAC_RDES3_LD)))
                return rx_not_ls;
        if (unlikely((rdes3 & XGMAC_RDES3_ES) && (rdes3 & XGMAC_RDES3_LD)))
                return discard_frame;

        return good_frame;
}

static int dwxgmac2_get_tx_len(struct dma_desc *p)
{
        return (le32_to_cpu(p->des2) & XGMAC_TDES2_B1L);
}

static int dwxgmac2_get_tx_owner(struct dma_desc *p)
{
        return (le32_to_cpu(p->des3) & XGMAC_TDES3_OWN) > 0;
}

static void dwxgmac2_set_tx_owner(struct dma_desc *p)
{
        p->des3 |= cpu_to_le32(XGMAC_TDES3_OWN);
}

static void dwxgmac2_set_rx_owner(struct dma_desc *p, int disable_rx_ic)
{
        u32 flags = XGMAC_RDES3_OWN;

        if (!disable_rx_ic)
                flags |= XGMAC_RDES3_IOC;

        p->des3 |= cpu_to_le32(flags);
}

static int dwxgmac2_get_tx_ls(struct dma_desc *p)
{
        return (le32_to_cpu(p->des3) & XGMAC_RDES3_LD) > 0;
}

static u16 dwxgmac2_wrback_get_rx_vlan_tci(struct dma_desc *p)
{
        return le32_to_cpu(p->des0) & XGMAC_RDES0_VLAN_TAG_MASK;
}

static bool dwxgmac2_wrback_get_rx_vlan_valid(struct dma_desc *p)
{
        u32 et_lt;

        et_lt = FIELD_GET(XGMAC_RDES3_ET_LT, le32_to_cpu(p->des3));

        return et_lt >= XGMAC_ET_LT_VLAN_STAG &&
               et_lt <= XGMAC_ET_LT_DVLAN_STAG_CTAG;
}

static int dwxgmac2_get_rx_frame_len(struct dma_desc *p, int rx_coe)
{
        return (le32_to_cpu(p->des3) & XGMAC_RDES3_PL);
}

static void dwxgmac2_enable_tx_timestamp(struct dma_desc *p)
{
        p->des2 |= cpu_to_le32(XGMAC_TDES2_TTSE);
}

static int dwxgmac2_get_tx_timestamp_status(struct dma_desc *p)
{
        return 0; /* Not supported */
}

static inline void dwxgmac2_get_timestamp(void *desc, u32 ats, u64 *ts)
{
        struct dma_desc *p = (struct dma_desc *)desc;
        u64 ns = 0;

        ns += le32_to_cpu(p->des1) * 1000000000ULL;
        ns += le32_to_cpu(p->des0);

        *ts = ns;
}

static int dwxgmac2_rx_check_timestamp(void *desc)
{
        struct dma_desc *p = (struct dma_desc *)desc;
        u32 rdes3 = le32_to_cpu(p->des3);
        bool desc_valid, ts_valid;

        dma_rmb();

        desc_valid = !(rdes3 & XGMAC_RDES3_OWN) && (rdes3 & XGMAC_RDES3_CTXT);
        ts_valid = !(rdes3 & XGMAC_RDES3_TSD) && (rdes3 & XGMAC_RDES3_TSA);

        if (likely(desc_valid && ts_valid)) {
                if ((p->des0 == 0xffffffff) && (p->des1 == 0xffffffff))
                        return -EINVAL;
                return 0;
        }

        return -EINVAL;
}

static int dwxgmac2_get_rx_timestamp_status(void *desc, void *next_desc,
                                            u32 ats)
{
        struct dma_desc *p = (struct dma_desc *)desc;
        u32 rdes3 = le32_to_cpu(p->des3);
        int ret = -EBUSY;

        if (likely(rdes3 & XGMAC_RDES3_CDA))
                ret = dwxgmac2_rx_check_timestamp(next_desc);

        return !ret;
}

static void dwxgmac2_init_rx_desc(struct dma_desc *p, int disable_rx_ic,
                                  int mode, int end, int bfsize)
{
        dwxgmac2_set_rx_owner(p, disable_rx_ic);
}

static void dwxgmac2_init_tx_desc(struct dma_desc *p, int mode, int end)
{
        p->des0 = 0;
        p->des1 = 0;
        p->des2 = 0;
        p->des3 = 0;
}

static void dwxgmac2_prepare_tx_desc(struct dma_desc *p, int is_fs, int len,
                                     bool csum_flag, int mode, bool tx_own,
                                     bool ls, unsigned int tot_pkt_len)
{
        u32 tdes3 = le32_to_cpu(p->des3);

        p->des2 |= cpu_to_le32(len & XGMAC_TDES2_B1L);

        tdes3 |= tot_pkt_len & XGMAC_TDES3_FL;
        if (is_fs)
                tdes3 |= XGMAC_TDES3_FD;
        else
                tdes3 &= ~XGMAC_TDES3_FD;

        if (csum_flag)
                tdes3 |= FIELD_PREP(XGMAC_TDES3_CIC, 0x3);
        else
                tdes3 &= ~XGMAC_TDES3_CIC;

        if (ls)
                tdes3 |= XGMAC_TDES3_LD;
        else
                tdes3 &= ~XGMAC_TDES3_LD;

        /* Finally set the OWN bit. Later the DMA will start! */
        if (tx_own)
                tdes3 |= XGMAC_TDES3_OWN;

        if (is_fs && tx_own)
                /* When the own bit, for the first frame, has to be set, all
                 * descriptors for the same frame has to be set before, to
                 * avoid race condition.
                 */
                dma_wmb();

        p->des3 = cpu_to_le32(tdes3);
}

static void dwxgmac2_prepare_tso_tx_desc(struct dma_desc *p, int is_fs,
                                         int len1, int len2, bool tx_own,
                                         bool ls, unsigned int tcphdrlen,
                                         unsigned int tcppayloadlen)
{
        u32 tdes3 = le32_to_cpu(p->des3);

        if (len1)
                p->des2 |= cpu_to_le32(len1 & XGMAC_TDES2_B1L);
        if (len2)
                p->des2 |= cpu_to_le32(FIELD_PREP(XGMAC_TDES2_B2L, len2));
        if (is_fs) {
                tdes3 |= XGMAC_TDES3_FD | XGMAC_TDES3_TSE;
                tdes3 |= FIELD_PREP(XGMAC_TDES3_THL, tcphdrlen);
                tdes3 |= FIELD_PREP(XGMAC_TDES3_TPL, tcppayloadlen);
        } else {
                tdes3 &= ~XGMAC_TDES3_FD;
        }

        if (ls)
                tdes3 |= XGMAC_TDES3_LD;
        else
                tdes3 &= ~XGMAC_TDES3_LD;

        /* Finally set the OWN bit. Later the DMA will start! */
        if (tx_own)
                tdes3 |= XGMAC_TDES3_OWN;

        if (is_fs && tx_own)
                /* When the own bit, for the first frame, has to be set, all
                 * descriptors for the same frame has to be set before, to
                 * avoid race condition.
                 */
                dma_wmb();

        p->des3 = cpu_to_le32(tdes3);
}

static void dwxgmac2_release_tx_desc(struct dma_desc *p, int mode)
{
        p->des0 = 0;
        p->des1 = 0;
        p->des2 = 0;
        p->des3 = 0;
}

static void dwxgmac2_set_tx_ic(struct dma_desc *p)
{
        p->des2 |= cpu_to_le32(XGMAC_TDES2_IOC);
}

static void dwxgmac2_set_mss(struct dma_desc *p, unsigned int mss)
{
        p->des0 = 0;
        p->des1 = 0;
        p->des2 = cpu_to_le32(mss);
        p->des3 = cpu_to_le32(XGMAC_TDES3_CTXT | XGMAC_TDES3_TCMSSV);
}

static void dwxgmac2_set_addr(struct dma_desc *p, dma_addr_t addr)
{
        p->des0 = cpu_to_le32(lower_32_bits(addr));
        p->des1 = cpu_to_le32(upper_32_bits(addr));
}

static void dwxgmac2_clear(struct dma_desc *p)
{
        p->des0 = 0;
        p->des1 = 0;
        p->des2 = 0;
        p->des3 = 0;
}

static int dwxgmac2_get_rx_hash(struct dma_desc *p, u32 *hash,
                                enum pkt_hash_types *type)
{
        u32 rdes3 = le32_to_cpu(p->des3);
        u32 ptype;

        if (rdes3 & XGMAC_RDES3_RSV) {
                ptype = FIELD_GET(XGMAC_RDES3_L34T, rdes3);

                switch (ptype) {
                case XGMAC_L34T_IP4TCP:
                case XGMAC_L34T_IP4UDP:
                case XGMAC_L34T_IP6TCP:
                case XGMAC_L34T_IP6UDP:
                        *type = PKT_HASH_TYPE_L4;
                        break;
                default:
                        *type = PKT_HASH_TYPE_L3;
                        break;
                }

                *hash = le32_to_cpu(p->des1);
                return 0;
        }

        return -EINVAL;
}

static void dwxgmac2_get_rx_header_len(struct dma_desc *p, unsigned int *len)
{
        if (le32_to_cpu(p->des3) & XGMAC_RDES3_L34T)
                *len = le32_to_cpu(p->des2) & XGMAC_RDES2_HL;
}

static void dwxgmac2_set_sec_addr(struct dma_desc *p, dma_addr_t addr, bool is_valid)
{
        p->des2 = cpu_to_le32(lower_32_bits(addr));
        p->des3 = cpu_to_le32(upper_32_bits(addr));
}

static void dwxgmac2_set_sarc(struct dma_desc *p, u32 sarc_type)
{
        p->des3 |= cpu_to_le32(FIELD_PREP(XGMAC_TDES3_SAIC, sarc_type));
}

static void dwxgmac2_set_vlan_tag(struct dma_desc *p, u16 tag, u16 inner_tag,
                                  u32 inner_type)
{
        p->des0 = 0;
        p->des1 = 0;
        p->des2 = 0;
        p->des3 = 0;

        /* Inner VLAN */
        if (inner_type) {
                u32 des = FIELD_PREP(XGMAC_TDES2_IVT, inner_tag);

                p->des2 = cpu_to_le32(des);

                des = FIELD_PREP(XGMAC_TDES3_IVTIR, inner_type);
                p->des3 = cpu_to_le32(des | XGMAC_TDES3_IVLTV);
        }

        /* Outer VLAN */
        p->des3 |= cpu_to_le32(tag & XGMAC_TDES3_VT);
        p->des3 |= cpu_to_le32(XGMAC_TDES3_VLTV);

        p->des3 |= cpu_to_le32(XGMAC_TDES3_CTXT);
}

static void dwxgmac2_set_vlan(struct dma_desc *p, u32 type)
{
        p->des2 |= cpu_to_le32(FIELD_PREP(XGMAC_TDES2_VTIR, type));
}

static void dwxgmac2_set_tbs(struct dma_edesc *p, u32 sec, u32 nsec)
{
        p->des4 = cpu_to_le32((sec & XGMAC_TDES0_LT) | XGMAC_TDES0_LTV);
        p->des5 = cpu_to_le32(nsec & XGMAC_TDES1_LT);
        p->des6 = 0;
        p->des7 = 0;
}

const struct stmmac_desc_ops dwxgmac210_desc_ops = {
        .tx_status = dwxgmac2_get_tx_status,
        .rx_status = dwxgmac2_get_rx_status,
        .get_tx_len = dwxgmac2_get_tx_len,
        .get_tx_owner = dwxgmac2_get_tx_owner,
        .set_tx_owner = dwxgmac2_set_tx_owner,
        .set_rx_owner = dwxgmac2_set_rx_owner,
        .get_tx_ls = dwxgmac2_get_tx_ls,
        .get_rx_vlan_tci = dwxgmac2_wrback_get_rx_vlan_tci,
        .get_rx_vlan_valid = dwxgmac2_wrback_get_rx_vlan_valid,
        .get_rx_frame_len = dwxgmac2_get_rx_frame_len,
        .enable_tx_timestamp = dwxgmac2_enable_tx_timestamp,
        .get_tx_timestamp_status = dwxgmac2_get_tx_timestamp_status,
        .get_rx_timestamp_status = dwxgmac2_get_rx_timestamp_status,
        .get_timestamp = dwxgmac2_get_timestamp,
        .set_tx_ic = dwxgmac2_set_tx_ic,
        .prepare_tx_desc = dwxgmac2_prepare_tx_desc,
        .prepare_tso_tx_desc = dwxgmac2_prepare_tso_tx_desc,
        .release_tx_desc = dwxgmac2_release_tx_desc,
        .init_rx_desc = dwxgmac2_init_rx_desc,
        .init_tx_desc = dwxgmac2_init_tx_desc,
        .set_mss = dwxgmac2_set_mss,
        .set_addr = dwxgmac2_set_addr,
        .clear = dwxgmac2_clear,
        .get_rx_hash = dwxgmac2_get_rx_hash,
        .get_rx_header_len = dwxgmac2_get_rx_header_len,
        .set_sec_addr = dwxgmac2_set_sec_addr,
        .set_sarc = dwxgmac2_set_sarc,
        .set_vlan_tag = dwxgmac2_set_vlan_tag,
        .set_vlan = dwxgmac2_set_vlan,
        .set_tbs = dwxgmac2_set_tbs,
};