drivers/net/ethernet/stmicro/stmmac/hwif.c

// SPDX-License-Identifier: (GPL-2.0 OR MIT)
/*
 * Copyright (c) 2018 Synopsys, Inc. and/or its affiliates.
 * stmmac HW Interface Handling
 */

#include "common.h"
#include "stmmac.h"
#include "stmmac_fpe.h"
#include "stmmac_ptp.h"
#include "stmmac_est.h"
#include "stmmac_vlan.h"
#include "dwmac4_descs.h"
#include "dwxgmac2.h"

struct stmmac_version {
	u8 snpsver;
	u8 dev_id;
};

static void stmmac_get_version(struct stmmac_priv *priv,
			       struct stmmac_version *ver)
{
	enum dwmac_core_type core_type = priv->plat->core_type;
	unsigned int version_offset;
	u32 version;

	ver->snpsver = 0;
	ver->dev_id = 0;

	if (core_type == DWMAC_CORE_MAC100)
		return;

	if (core_type == DWMAC_CORE_GMAC)
		version_offset = GMAC_VERSION;
	else
		version_offset = GMAC4_VERSION;

	version = readl(priv->ioaddr + version_offset);
	if (version == 0) {
		dev_info(priv->device, "Version ID not available\n");
		return;
	}

	dev_info(priv->device, "User ID: 0x%x, Synopsys ID: 0x%x\n",
		 FIELD_GET(DWMAC_USERVER, version),
		 FIELD_GET(DWMAC_SNPSVER, version));

	ver->snpsver = FIELD_GET(DWMAC_SNPSVER, version);
	if (core_type == DWMAC_CORE_XGMAC)
		ver->dev_id = FIELD_GET(DWMAC_USERVER, version);
}

static void stmmac_dwmac_mode_quirk(struct stmmac_priv *priv)
{
	struct mac_device_info *mac = priv->hw;

	if (priv->chain_mode) {
		dev_info(priv->device, "Chain mode enabled\n");
		priv->descriptor_mode = STMMAC_CHAIN_MODE;
		mac->mode = &chain_mode_ops;
	} else {
		dev_info(priv->device, "Ring mode enabled\n");
		priv->descriptor_mode = STMMAC_RING_MODE;
		mac->mode = &ring_mode_ops;
	}
}

static int stmmac_dwmac1_quirks(struct stmmac_priv *priv)
{
	struct mac_device_info *mac = priv->hw;

	if (priv->plat->enh_desc) {
		dev_info(priv->device, "Enhanced/Alternate descriptors\n");

		/* GMAC older than 3.50 has no extended descriptors */
		if (priv->synopsys_id >= DWMAC_CORE_3_50) {
			dev_info(priv->device, "Enabled extended descriptors\n");
			priv->extend_desc = true;
		} else {
			dev_warn(priv->device, "Extended descriptors not supported\n");
		}

		mac->desc = &enh_desc_ops;
	} else {
		dev_info(priv->device, "Normal descriptors\n");
		mac->desc = &ndesc_ops;
	}

	stmmac_dwmac_mode_quirk(priv);
	return 0;
}

static int stmmac_dwmac4_quirks(struct stmmac_priv *priv)
{
	stmmac_dwmac_mode_quirk(priv);
	return 0;
}

int stmmac_reset(struct stmmac_priv *priv)
{
	struct plat_stmmacenet_data *plat = priv->plat;
	void __iomem *ioaddr = priv->ioaddr;

	if (plat && plat->fix_soc_reset)
		return plat->fix_soc_reset(priv);

	return stmmac_do_callback(priv, dma, reset, ioaddr);
}

static const struct stmmac_hwif_entry {
	enum dwmac_core_type core_type;
	u32 min_id;
	u32 dev_id;
	const struct stmmac_regs_off regs;
	const void *desc;
	const void *dma;
	const void *mac;
	const void *hwtimestamp;
	const void *ptp;
	const void *mode;
	const void *tc;
	const void *mmc;
	const void *est;
	const void *vlan;
	int (*setup)(struct stmmac_priv *priv);
	int (*quirks)(struct stmmac_priv *priv);
} stmmac_hw[] = {
	/* NOTE: New HW versions shall go to the end of this table */
	{
		.core_type = DWMAC_CORE_MAC100,
		.min_id = 0,
		.regs = {
			.ptp_off = PTP_GMAC3_X_OFFSET,
			.mmc_off = MMC_GMAC3_X_OFFSET,
		},
		.desc = NULL,
		.dma = &dwmac100_dma_ops,
		.mac = &dwmac100_ops,
		.hwtimestamp = &dwmac1000_ptp,
		.ptp = &dwmac1000_ptp_clock_ops,
		.mode = NULL,
		.tc = NULL,
		.mmc = &dwmac_mmc_ops,
		.setup = dwmac100_setup,
		.quirks = stmmac_dwmac1_quirks,
	}, {
		.core_type = DWMAC_CORE_GMAC,
		.min_id = 0,
		.regs = {
			.ptp_off = PTP_GMAC3_X_OFFSET,
			.mmc_off = MMC_GMAC3_X_OFFSET,
		},
		.desc = NULL,
		.dma = &dwmac1000_dma_ops,
		.mac = &dwmac1000_ops,
		.hwtimestamp = &dwmac1000_ptp,
		.ptp = &dwmac1000_ptp_clock_ops,
		.mode = NULL,
		.tc = NULL,
		.mmc = &dwmac_mmc_ops,
		.setup = dwmac1000_setup,
		.quirks = stmmac_dwmac1_quirks,
	}, {
		.core_type = DWMAC_CORE_GMAC4,
		.min_id = 0,
		.regs = {
			.ptp_off = PTP_GMAC4_OFFSET,
			.mmc_off = MMC_GMAC4_OFFSET,
			.est_off = EST_GMAC4_OFFSET,
		},
		.desc = &dwmac4_desc_ops,
		.dma = &dwmac4_dma_ops,
		.mac = &dwmac4_ops,
		.vlan = &dwmac_vlan_ops,
		.hwtimestamp = &stmmac_ptp,
		.ptp = &stmmac_ptp_clock_ops,
		.mode = NULL,
		.tc = &dwmac4_tc_ops,
		.mmc = &dwmac_mmc_ops,
		.est = &dwmac510_est_ops,
		.setup = dwmac4_setup,
		.quirks = stmmac_dwmac4_quirks,
	}, {
		.core_type = DWMAC_CORE_GMAC4,
		.min_id = DWMAC_CORE_4_00,
		.regs = {
			.ptp_off = PTP_GMAC4_OFFSET,
			.mmc_off = MMC_GMAC4_OFFSET,
			.est_off = EST_GMAC4_OFFSET,
			.fpe_reg = &dwmac5_fpe_reg,
		},
		.desc = &dwmac4_desc_ops,
		.dma = &dwmac4_dma_ops,
		.mac = &dwmac410_ops,
		.vlan = &dwmac_vlan_ops,
		.hwtimestamp = &stmmac_ptp,
		.ptp = &stmmac_ptp_clock_ops,
		.mode = &dwmac4_ring_mode_ops,
		.tc = &dwmac510_tc_ops,
		.mmc = &dwmac_mmc_ops,
		.est = &dwmac510_est_ops,
		.setup = dwmac4_setup,
		.quirks = NULL,
	}, {
		.core_type = DWMAC_CORE_GMAC4,
		.min_id = DWMAC_CORE_4_10,
		.regs = {
			.ptp_off = PTP_GMAC4_OFFSET,
			.mmc_off = MMC_GMAC4_OFFSET,
			.est_off = EST_GMAC4_OFFSET,
			.fpe_reg = &dwmac5_fpe_reg,
		},
		.desc = &dwmac4_desc_ops,
		.dma = &dwmac410_dma_ops,
		.mac = &dwmac410_ops,
		.vlan = &dwmac_vlan_ops,
		.hwtimestamp = &stmmac_ptp,
		.ptp = &stmmac_ptp_clock_ops,
		.mode = &dwmac4_ring_mode_ops,
		.tc = &dwmac510_tc_ops,
		.mmc = &dwmac_mmc_ops,
		.est = &dwmac510_est_ops,
		.setup = dwmac4_setup,
		.quirks = NULL,
	}, {
		.core_type = DWMAC_CORE_GMAC4,
		.min_id = DWMAC_CORE_5_10,
		.regs = {
			.ptp_off = PTP_GMAC4_OFFSET,
			.mmc_off = MMC_GMAC4_OFFSET,
			.est_off = EST_GMAC4_OFFSET,
			.fpe_reg = &dwmac5_fpe_reg,
		},
		.desc = &dwmac4_desc_ops,
		.dma = &dwmac410_dma_ops,
		.mac = &dwmac510_ops,
		.vlan = &dwmac_vlan_ops,
		.hwtimestamp = &stmmac_ptp,
		.ptp = &stmmac_ptp_clock_ops,
		.mode = &dwmac4_ring_mode_ops,
		.tc = &dwmac510_tc_ops,
		.mmc = &dwmac_mmc_ops,
		.est = &dwmac510_est_ops,
		.setup = dwmac4_setup,
		.quirks = NULL,
	}, {
		.core_type = DWMAC_CORE_XGMAC,
		.min_id = DWXGMAC_CORE_2_10,
		.dev_id = DWXGMAC_ID,
		.regs = {
			.ptp_off = PTP_XGMAC_OFFSET,
			.mmc_off = MMC_XGMAC_OFFSET,
			.est_off = EST_XGMAC_OFFSET,
			.fpe_reg = &dwxgmac3_fpe_reg,
		},
		.desc = &dwxgmac210_desc_ops,
		.dma = &dwxgmac210_dma_ops,
		.mac = &dwxgmac210_ops,
		.vlan = &dwxgmac210_vlan_ops,
		.hwtimestamp = &stmmac_ptp,
		.ptp = &stmmac_ptp_clock_ops,
		.mode = NULL,
		.tc = &dwmac510_tc_ops,
		.mmc = &dwxgmac_mmc_ops,
		.est = &dwmac510_est_ops,
		.setup = dwxgmac2_setup,
		.quirks = NULL,
	}, {
		.core_type = DWMAC_CORE_XGMAC,
		.min_id = DWXLGMAC_CORE_2_00,
		.dev_id = DWXLGMAC_ID,
		.regs = {
			.ptp_off = PTP_XGMAC_OFFSET,
			.mmc_off = MMC_XGMAC_OFFSET,
			.est_off = EST_XGMAC_OFFSET,
			.fpe_reg = &dwxgmac3_fpe_reg,
		},
		.desc = &dwxgmac210_desc_ops,
		.dma = &dwxgmac210_dma_ops,
		.mac = &dwxlgmac2_ops,
		.vlan = &dwxlgmac2_vlan_ops,
		.hwtimestamp = &stmmac_ptp,
		.ptp = &stmmac_ptp_clock_ops,
		.mode = NULL,
		.tc = &dwmac510_tc_ops,
		.mmc = &dwxgmac_mmc_ops,
		.est = &dwmac510_est_ops,
		.setup = dwxlgmac2_setup,
	},
};

static const struct stmmac_hwif_entry *
stmmac_hwif_find(enum dwmac_core_type core_type, u8 snpsver, u8 dev_id)
{
	const struct stmmac_hwif_entry *entry;
	int i;

	for (i = ARRAY_SIZE(stmmac_hw) - 1; i >= 0; i--) {
		entry = &stmmac_hw[i];

		if (core_type != entry->core_type)
			continue;
		/* Use synopsys_id var because some setups can override this */
		if (snpsver < entry->min_id)
			continue;
		if (core_type == DWMAC_CORE_XGMAC &&
		    dev_id != entry->dev_id)
			continue;

		return entry;
	}

	return NULL;
}

int stmmac_hwif_init(struct stmmac_priv *priv)
{
	enum dwmac_core_type core_type = priv->plat->core_type;
	const struct stmmac_hwif_entry *entry;
	struct stmmac_version version;
	struct mac_device_info *mac;
	bool needs_setup = true;
	int ret;

	stmmac_get_version(priv, &version);

	/* Save ID for later use */
	priv->synopsys_id = version.snpsver;

	/* Lets assume some safe values first */
	if (core_type == DWMAC_CORE_GMAC4) {
		priv->ptpaddr = priv->ioaddr + PTP_GMAC4_OFFSET;
		priv->mmcaddr = priv->ioaddr + MMC_GMAC4_OFFSET;
		priv->estaddr = priv->ioaddr + EST_GMAC4_OFFSET;
	} else {
		priv->ptpaddr = priv->ioaddr + PTP_GMAC3_X_OFFSET;
		priv->mmcaddr = priv->ioaddr + MMC_GMAC3_X_OFFSET;
		if (core_type == DWMAC_CORE_XGMAC)
			priv->estaddr = priv->ioaddr + EST_XGMAC_OFFSET;
	}

	mac = devm_kzalloc(priv->device, sizeof(*mac), GFP_KERNEL);
	if (!mac)
		return -ENOMEM;

	/* Check for HW specific setup first */
	if (priv->plat->mac_setup) {
		ret = priv->plat->mac_setup(priv, mac);
		if (ret)
			return ret;

		needs_setup = false;
	}

	spin_lock_init(&mac->irq_ctrl_lock);

	/* Fallback to generic HW */

	/* Use synopsys_id var because some setups can override this */
	entry = stmmac_hwif_find(core_type, priv->synopsys_id, version.dev_id);
	if (!entry) {
		dev_err(priv->device,
			"Failed to find HW IF (id=0x%x, gmac=%d/%d)\n",
			version.snpsver, core_type == DWMAC_CORE_GMAC,
			core_type == DWMAC_CORE_GMAC4);

		return -EINVAL;
	}

	/* Only use generic HW helpers if needed */
	mac->desc = mac->desc ? : entry->desc;
	mac->dma = mac->dma ? : entry->dma;
	mac->mac = mac->mac ? : entry->mac;
	mac->ptp = mac->ptp ? : entry->hwtimestamp;
	mac->mode = mac->mode ? : entry->mode;
	mac->tc = mac->tc ? : entry->tc;
	mac->mmc = mac->mmc ? : entry->mmc;
	mac->est = mac->est ? : entry->est;
	mac->vlan = mac->vlan ? : entry->vlan;

	priv->hw = mac;
	priv->fpe_cfg.reg = entry->regs.fpe_reg;
	priv->ptpaddr = priv->ioaddr + entry->regs.ptp_off;
	priv->mmcaddr = priv->ioaddr + entry->regs.mmc_off;
	memcpy(&priv->ptp_clock_ops, entry->ptp,
	       sizeof(struct ptp_clock_info));

	if (entry->est)
		priv->estaddr = priv->ioaddr + entry->regs.est_off;

	/* Entry found */
	if (needs_setup) {
		ret = entry->setup(priv);
		if (ret)
			return ret;
	}

	/* Save quirks, if needed for posterior use */
	priv->hwif_quirks = entry->quirks;

	return 0;
}