[thirdparty/linux.git] / drivers / net / ethernet / broadcom / bgmac-platform.c

/*
 * Copyright (C) 2016 Broadcom
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation version 2.
 *
 * This program is distributed "as is" WITHOUT ANY WARRANTY of any
 * kind, whether express or implied; without even the implied warranty
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */

#define pr_fmt(fmt)		KBUILD_MODNAME ": " fmt

#include <linux/bcma/bcma.h>
#include <linux/brcmphy.h>
#include <linux/etherdevice.h>
#include <linux/of_address.h>
#include <linux/of_mdio.h>
#include <linux/of_net.h>
#include "bgmac.h"

#define NICPM_PADRING_CFG		0x00000004
#define NICPM_IOMUX_CTRL		0x00000008

#define NICPM_PADRING_CFG_INIT_VAL	0x74000000
#define NICPM_IOMUX_CTRL_INIT_VAL_AX	0x21880000

#define NICPM_IOMUX_CTRL_INIT_VAL	0x3196e000
#define NICPM_IOMUX_CTRL_SPD_SHIFT	10
#define NICPM_IOMUX_CTRL_SPD_10M	0
#define NICPM_IOMUX_CTRL_SPD_100M	1
#define NICPM_IOMUX_CTRL_SPD_1000M	2

static u32 platform_bgmac_read(struct bgmac *bgmac, u16 offset)
{
	return readl(bgmac->plat.base + offset);
}

static void platform_bgmac_write(struct bgmac *bgmac, u16 offset, u32 value)
{
	writel(value, bgmac->plat.base + offset);
}

static u32 platform_bgmac_idm_read(struct bgmac *bgmac, u16 offset)
{
	return readl(bgmac->plat.idm_base + offset);
}

static void platform_bgmac_idm_write(struct bgmac *bgmac, u16 offset, u32 value)
{
	writel(value, bgmac->plat.idm_base + offset);
}

static bool platform_bgmac_clk_enabled(struct bgmac *bgmac)
{
	if (!bgmac->plat.idm_base)
		return true;

	if ((bgmac_idm_read(bgmac, BCMA_IOCTL) & BGMAC_CLK_EN) != BGMAC_CLK_EN)
		return false;
	if (bgmac_idm_read(bgmac, BCMA_RESET_CTL) & BCMA_RESET_CTL_RESET)
		return false;
	return true;
}

static void platform_bgmac_clk_enable(struct bgmac *bgmac, u32 flags)
{
	u32 val;

	if (!bgmac->plat.idm_base)
		return;

	/* The Reset Control register only contains a single bit to show if the
	 * controller is currently in reset.  Do a sanity check here, just in
	 * case the bootloader happened to leave the device in reset.
	 */
	val = bgmac_idm_read(bgmac, BCMA_RESET_CTL);
	if (val) {
		bgmac_idm_write(bgmac, BCMA_RESET_CTL, 0);
		bgmac_idm_read(bgmac, BCMA_RESET_CTL);
		udelay(1);
	}

	val = bgmac_idm_read(bgmac, BCMA_IOCTL);
	/* Some bits of BCMA_IOCTL set by HW/ATF and should not change */
	val |= flags & ~(BGMAC_AWCACHE | BGMAC_ARCACHE | BGMAC_AWUSER |
			 BGMAC_ARUSER);
	val |= BGMAC_CLK_EN;
	bgmac_idm_write(bgmac, BCMA_IOCTL, val);
	bgmac_idm_read(bgmac, BCMA_IOCTL);
	udelay(1);
}

static void platform_bgmac_cco_ctl_maskset(struct bgmac *bgmac, u32 offset,
					   u32 mask, u32 set)
{
	/* This shouldn't be encountered */
	WARN_ON(1);
}

static u32 platform_bgmac_get_bus_clock(struct bgmac *bgmac)
{
	/* This shouldn't be encountered */
	WARN_ON(1);

	return 0;
}

static void platform_bgmac_cmn_maskset32(struct bgmac *bgmac, u16 offset,
					 u32 mask, u32 set)
{
	/* This shouldn't be encountered */
	WARN_ON(1);
}

static void bgmac_nicpm_speed_set(struct net_device *net_dev)
{
	struct bgmac *bgmac = netdev_priv(net_dev);
	u32 val;

	if (!bgmac->plat.nicpm_base)
		return;

	/* SET RGMII IO CONFIG */
	writel(NICPM_PADRING_CFG_INIT_VAL,
	       bgmac->plat.nicpm_base + NICPM_PADRING_CFG);

	val = NICPM_IOMUX_CTRL_INIT_VAL;
	switch (bgmac->net_dev->phydev->speed) {
	default:
		netdev_err(net_dev, "Unsupported speed. Defaulting to 1000Mb\n");
		/* fall through */
	case SPEED_1000:
		val |= NICPM_IOMUX_CTRL_SPD_1000M << NICPM_IOMUX_CTRL_SPD_SHIFT;
		break;
	case SPEED_100:
		val |= NICPM_IOMUX_CTRL_SPD_100M << NICPM_IOMUX_CTRL_SPD_SHIFT;
		break;
	case SPEED_10:
		val |= NICPM_IOMUX_CTRL_SPD_10M << NICPM_IOMUX_CTRL_SPD_SHIFT;
		break;
	}

	writel(val, bgmac->plat.nicpm_base + NICPM_IOMUX_CTRL);

	bgmac_adjust_link(bgmac->net_dev);
}

static int platform_phy_connect(struct bgmac *bgmac)
{
	struct phy_device *phy_dev;

	if (bgmac->plat.nicpm_base)
		phy_dev = of_phy_get_and_connect(bgmac->net_dev,
						 bgmac->dev->of_node,
						 bgmac_nicpm_speed_set);
	else
		phy_dev = of_phy_get_and_connect(bgmac->net_dev,
						 bgmac->dev->of_node,
						 bgmac_adjust_link);
	if (!phy_dev) {
		dev_err(bgmac->dev, "PHY connection failed\n");
		return -ENODEV;
	}

	return 0;
}

static int bgmac_probe(struct platform_device *pdev)
{
	struct device_node *np = pdev->dev.of_node;
	struct bgmac *bgmac;
	struct resource *regs;
	const u8 *mac_addr;

	bgmac = bgmac_alloc(&pdev->dev);
	if (!bgmac)
		return -ENOMEM;

	platform_set_drvdata(pdev, bgmac);

	/* Set the features of the 4707 family */
	bgmac->feature_flags |= BGMAC_FEAT_CLKCTLST;
	bgmac->feature_flags |= BGMAC_FEAT_NO_RESET;
	bgmac->feature_flags |= BGMAC_FEAT_CMDCFG_SR_REV4;
	bgmac->feature_flags |= BGMAC_FEAT_TX_MASK_SETUP;
	bgmac->feature_flags |= BGMAC_FEAT_RX_MASK_SETUP;
	bgmac->feature_flags |= BGMAC_FEAT_IDM_MASK;

	bgmac->dev = &pdev->dev;
	bgmac->dma_dev = &pdev->dev;

	mac_addr = of_get_mac_address(np);
	if (!IS_ERR(mac_addr))
		ether_addr_copy(bgmac->net_dev->dev_addr, mac_addr);
	else
		dev_warn(&pdev->dev, "MAC address not present in device tree\n");

	bgmac->irq = platform_get_irq(pdev, 0);
	if (bgmac->irq < 0)
		return bgmac->irq;

	bgmac->plat.base =
		devm_platform_ioremap_resource_byname(pdev, "amac_base");
	if (IS_ERR(bgmac->plat.base))
		return PTR_ERR(bgmac->plat.base);

	regs = platform_get_resource_byname(pdev, IORESOURCE_MEM, "idm_base");
	if (regs) {
		bgmac->plat.idm_base = devm_ioremap_resource(&pdev->dev, regs);
		if (IS_ERR(bgmac->plat.idm_base))
			return PTR_ERR(bgmac->plat.idm_base);
		bgmac->feature_flags &= ~BGMAC_FEAT_IDM_MASK;
	}

	regs = platform_get_resource_byname(pdev, IORESOURCE_MEM, "nicpm_base");
	if (regs) {
		bgmac->plat.nicpm_base = devm_ioremap_resource(&pdev->dev,
							       regs);
		if (IS_ERR(bgmac->plat.nicpm_base))
			return PTR_ERR(bgmac->plat.nicpm_base);
	}

	bgmac->read = platform_bgmac_read;
	bgmac->write = platform_bgmac_write;
	bgmac->idm_read = platform_bgmac_idm_read;
	bgmac->idm_write = platform_bgmac_idm_write;
	bgmac->clk_enabled = platform_bgmac_clk_enabled;
	bgmac->clk_enable = platform_bgmac_clk_enable;
	bgmac->cco_ctl_maskset = platform_bgmac_cco_ctl_maskset;
	bgmac->get_bus_clock = platform_bgmac_get_bus_clock;
	bgmac->cmn_maskset32 = platform_bgmac_cmn_maskset32;
	if (of_parse_phandle(np, "phy-handle", 0)) {
		bgmac->phy_connect = platform_phy_connect;
	} else {
		bgmac->phy_connect = bgmac_phy_connect_direct;
		bgmac->feature_flags |= BGMAC_FEAT_FORCE_SPEED_2500;
	}

	return bgmac_enet_probe(bgmac);
}

static int bgmac_remove(struct platform_device *pdev)
{
	struct bgmac *bgmac = platform_get_drvdata(pdev);

	bgmac_enet_remove(bgmac);

	return 0;
}

#ifdef CONFIG_PM
static int bgmac_suspend(struct device *dev)
{
	struct bgmac *bgmac = dev_get_drvdata(dev);

	return bgmac_enet_suspend(bgmac);
}

static int bgmac_resume(struct device *dev)
{
	struct bgmac *bgmac = dev_get_drvdata(dev);

	return bgmac_enet_resume(bgmac);
}

static const struct dev_pm_ops bgmac_pm_ops = {
	.suspend = bgmac_suspend,
	.resume = bgmac_resume
};

#define BGMAC_PM_OPS (&bgmac_pm_ops)
#else
#define BGMAC_PM_OPS NULL
#endif /* CONFIG_PM */

static const struct of_device_id bgmac_of_enet_match[] = {
	{.compatible = "brcm,amac",},
	{.compatible = "brcm,nsp-amac",},
	{.compatible = "brcm,ns2-amac",},
	{},
};

MODULE_DEVICE_TABLE(of, bgmac_of_enet_match);

static struct platform_driver bgmac_enet_driver = {
	.driver = {
		.name  = "bgmac-enet",
		.of_match_table = bgmac_of_enet_match,
		.pm = BGMAC_PM_OPS
	},
	.probe = bgmac_probe,
	.remove = bgmac_remove,
};

module_platform_driver(bgmac_enet_driver);
MODULE_LICENSE("GPL");
Commit	Line	Data
f6a95a24 JM	1	/*
	2	* Copyright (C) 2016 Broadcom
	3	*
	4	* This program is free software; you can redistribute it and/or
	5	* modify it under the terms of the GNU General Public License as
	6	* published by the Free Software Foundation version 2.
	7	*
	8	* This program is distributed "as is" WITHOUT ANY WARRANTY of any
	9	* kind, whether express or implied; without even the implied warranty
	10	* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	11	* GNU General Public License for more details.
	12	*/
	13
	14	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
	15
	16	#include <linux/bcma/bcma.h>
dd5c5d03	17	#include <linux/brcmphy.h>
f6a95a24 JM	18	#include <linux/etherdevice.h>
f6a95a24 JM	19	#include <linux/of_address.h>
1676aba5	20	#include <linux/of_mdio.h>
f6a95a24 JM	21	#include <linux/of_net.h>
	22	#include "bgmac.h"
	23
f3537b34	24	#define NICPM_PADRING_CFG 0x00000004
dd5c5d03 JM	25	#define NICPM_IOMUX_CTRL 0x00000008
dd5c5d03 JM	26
f3537b34 JZ	27	#define NICPM_PADRING_CFG_INIT_VAL 0x74000000
	28	#define NICPM_IOMUX_CTRL_INIT_VAL_AX 0x21880000
	29
dd5c5d03 JM	30	#define NICPM_IOMUX_CTRL_INIT_VAL 0x3196e000
	31	#define NICPM_IOMUX_CTRL_SPD_SHIFT 10
	32	#define NICPM_IOMUX_CTRL_SPD_10M 0
	33	#define NICPM_IOMUX_CTRL_SPD_100M 1
	34	#define NICPM_IOMUX_CTRL_SPD_1000M 2
	35
f6a95a24 JM	36	static u32 platform_bgmac_read(struct bgmac *bgmac, u16 offset)
	37	{
	38	return readl(bgmac->plat.base + offset);
	39	}
	40
	41	static void platform_bgmac_write(struct bgmac *bgmac, u16 offset, u32 value)
	42	{
	43	writel(value, bgmac->plat.base + offset);
	44	}
	45
	46	static u32 platform_bgmac_idm_read(struct bgmac *bgmac, u16 offset)
	47	{
	48	return readl(bgmac->plat.idm_base + offset);
	49	}
	50
	51	static void platform_bgmac_idm_write(struct bgmac *bgmac, u16 offset, u32 value)
	52	{
83a5c5af	53	writel(value, bgmac->plat.idm_base + offset);
f6a95a24 JM	54	}
	55
	56	static bool platform_bgmac_clk_enabled(struct bgmac *bgmac)
	57	{
a163bdb0 AS	58	if (!bgmac->plat.idm_base)
	59	return true;
	60
16206524	61	if ((bgmac_idm_read(bgmac, BCMA_IOCTL) & BGMAC_CLK_EN) != BGMAC_CLK_EN)
f6a95a24 JM	62	return false;
	63	if (bgmac_idm_read(bgmac, BCMA_RESET_CTL) & BCMA_RESET_CTL_RESET)
	64	return false;
	65	return true;
	66	}
	67
	68	static void platform_bgmac_clk_enable(struct bgmac *bgmac, u32 flags)
	69	{
16206524	70	u32 val;
f6a95a24	71
a163bdb0 AS	72	if (!bgmac->plat.idm_base)
	73	return;
	74
16206524 JM	75	/* The Reset Control register only contains a single bit to show if the
	76	* controller is currently in reset. Do a sanity check here, just in
	77	* case the bootloader happened to leave the device in reset.
	78	*/
	79	val = bgmac_idm_read(bgmac, BCMA_RESET_CTL);
	80	if (val) {
	81	bgmac_idm_write(bgmac, BCMA_RESET_CTL, 0);
	82	bgmac_idm_read(bgmac, BCMA_RESET_CTL);
	83	udelay(1);
	84	}
	85
	86	val = bgmac_idm_read(bgmac, BCMA_IOCTL);
	87	/* Some bits of BCMA_IOCTL set by HW/ATF and should not change */
	88	val \|= flags & ~(BGMAC_AWCACHE \| BGMAC_ARCACHE \| BGMAC_AWUSER \|
	89	BGMAC_ARUSER);
	90	val \|= BGMAC_CLK_EN;
	91	bgmac_idm_write(bgmac, BCMA_IOCTL, val);
f6a95a24 JM	92	bgmac_idm_read(bgmac, BCMA_IOCTL);
	93	udelay(1);
	94	}
	95
	96	static void platform_bgmac_cco_ctl_maskset(struct bgmac *bgmac, u32 offset,
	97	u32 mask, u32 set)
	98	{
	99	/* This shouldn't be encountered */
	100	WARN_ON(1);
	101	}
	102
	103	static u32 platform_bgmac_get_bus_clock(struct bgmac *bgmac)
	104	{
	105	/* This shouldn't be encountered */
	106	WARN_ON(1);
	107
	108	return 0;
	109	}
	110
	111	static void platform_bgmac_cmn_maskset32(struct bgmac *bgmac, u16 offset,
	112	u32 mask, u32 set)
	113	{
	114	/* This shouldn't be encountered */
	115	WARN_ON(1);
	116	}
	117
dd5c5d03 JM	118	static void bgmac_nicpm_speed_set(struct net_device *net_dev)
	119	{
	120	struct bgmac *bgmac = netdev_priv(net_dev);
	121	u32 val;
	122
	123	if (!bgmac->plat.nicpm_base)
	124	return;
	125
f3537b34 JZ	126	/* SET RGMII IO CONFIG */
	127	writel(NICPM_PADRING_CFG_INIT_VAL,
	128	bgmac->plat.nicpm_base + NICPM_PADRING_CFG);
	129
dd5c5d03 JM	130	val = NICPM_IOMUX_CTRL_INIT_VAL;
	131	switch (bgmac->net_dev->phydev->speed) {
	132	default:
	133	netdev_err(net_dev, "Unsupported speed. Defaulting to 1000Mb\n");
d9b9c0e0	134	/* fall through */
dd5c5d03 JM	135	case SPEED_1000:
	136	val \|= NICPM_IOMUX_CTRL_SPD_1000M << NICPM_IOMUX_CTRL_SPD_SHIFT;
	137	break;
	138	case SPEED_100:
	139	val \|= NICPM_IOMUX_CTRL_SPD_100M << NICPM_IOMUX_CTRL_SPD_SHIFT;
	140	break;
	141	case SPEED_10:
	142	val \|= NICPM_IOMUX_CTRL_SPD_10M << NICPM_IOMUX_CTRL_SPD_SHIFT;
	143	break;
	144	}
	145
	146	writel(val, bgmac->plat.nicpm_base + NICPM_IOMUX_CTRL);
	147
	148	bgmac_adjust_link(bgmac->net_dev);
	149	}
	150
1676aba5 JM	151	static int platform_phy_connect(struct bgmac *bgmac)
	152	{
	153	struct phy_device *phy_dev;
	154
dd5c5d03 JM	155	if (bgmac->plat.nicpm_base)
	156	phy_dev = of_phy_get_and_connect(bgmac->net_dev,
	157	bgmac->dev->of_node,
	158	bgmac_nicpm_speed_set);
	159	else
	160	phy_dev = of_phy_get_and_connect(bgmac->net_dev,
	161	bgmac->dev->of_node,
	162	bgmac_adjust_link);
1676aba5 JM	163	if (!phy_dev) {
	164	dev_err(bgmac->dev, "PHY connection failed\n");
	165	return -ENODEV;
	166	}
	167
	168	return 0;
	169	}
	170
f6a95a24 JM	171	static int bgmac_probe(struct platform_device *pdev)
	172	{
	173	struct device_node *np = pdev->dev.of_node;
	174	struct bgmac *bgmac;
755f5738	175	struct resource *regs;
f6a95a24 JM	176	const u8 *mac_addr;
f6a95a24 JM	177
34a5102c	178	bgmac = bgmac_alloc(&pdev->dev);
f6a95a24 JM	179	if (!bgmac)
	180	return -ENOMEM;
	181
	182	platform_set_drvdata(pdev, bgmac);
	183
	184	/* Set the features of the 4707 family */
	185	bgmac->feature_flags \|= BGMAC_FEAT_CLKCTLST;
	186	bgmac->feature_flags \|= BGMAC_FEAT_NO_RESET;
f6a95a24 JM	187	bgmac->feature_flags \|= BGMAC_FEAT_CMDCFG_SR_REV4;
	188	bgmac->feature_flags \|= BGMAC_FEAT_TX_MASK_SETUP;
	189	bgmac->feature_flags \|= BGMAC_FEAT_RX_MASK_SETUP;
a163bdb0	190	bgmac->feature_flags \|= BGMAC_FEAT_IDM_MASK;
f6a95a24 JM	191
	192	bgmac->dev = &pdev->dev;
	193	bgmac->dma_dev = &pdev->dev;
	194
	195	mac_addr = of_get_mac_address(np);
a51645f7	196	if (!IS_ERR(mac_addr))
6850f8b5	197	ether_addr_copy(bgmac->net_dev->dev_addr, mac_addr);
f6a95a24 JM	198	else
	199	dev_warn(&pdev->dev, "MAC address not present in device tree\n");
	200
	201	bgmac->irq = platform_get_irq(pdev, 0);
d1a55841	202	if (bgmac->irq < 0)
f6a95a24	203	return bgmac->irq;
f6a95a24	204
d7a5502b DZ	205	bgmac->plat.base =
d7a5502b DZ	206	devm_platform_ioremap_resource_byname(pdev, "amac_base");
ce3a380d	207	if (IS_ERR(bgmac->plat.base))
f6a95a24	208	return PTR_ERR(bgmac->plat.base);
f6a95a24	209
755f5738 DZ	210	regs = platform_get_resource_byname(pdev, IORESOURCE_MEM, "idm_base");
	211	if (regs) {
	212	bgmac->plat.idm_base = devm_ioremap_resource(&pdev->dev, regs);
	213	if (IS_ERR(bgmac->plat.idm_base))
	214	return PTR_ERR(bgmac->plat.idm_base);
	215	bgmac->feature_flags &= ~BGMAC_FEAT_IDM_MASK;
	216	}
f6a95a24	217
755f5738 DZ	218	regs = platform_get_resource_byname(pdev, IORESOURCE_MEM, "nicpm_base");
	219	if (regs) {
	220	bgmac->plat.nicpm_base = devm_ioremap_resource(&pdev->dev,
	221	regs);
	222	if (IS_ERR(bgmac->plat.nicpm_base))
	223	return PTR_ERR(bgmac->plat.nicpm_base);
	224	}
dd5c5d03	225
f6a95a24 JM	226	bgmac->read = platform_bgmac_read;
	227	bgmac->write = platform_bgmac_write;
	228	bgmac->idm_read = platform_bgmac_idm_read;
	229	bgmac->idm_write = platform_bgmac_idm_write;
	230	bgmac->clk_enabled = platform_bgmac_clk_enabled;
	231	bgmac->clk_enable = platform_bgmac_clk_enable;
	232	bgmac->cco_ctl_maskset = platform_bgmac_cco_ctl_maskset;
	233	bgmac->get_bus_clock = platform_bgmac_get_bus_clock;
	234	bgmac->cmn_maskset32 = platform_bgmac_cmn_maskset32;
1676aba5 JM	235	if (of_parse_phandle(np, "phy-handle", 0)) {
	236	bgmac->phy_connect = platform_phy_connect;
	237	} else {
	238	bgmac->phy_connect = bgmac_phy_connect_direct;
	239	bgmac->feature_flags \|= BGMAC_FEAT_FORCE_SPEED_2500;
	240	}
f6a95a24 JM	241
	242	return bgmac_enet_probe(bgmac);
	243	}
	244
	245	static int bgmac_remove(struct platform_device *pdev)
	246	{
	247	struct bgmac *bgmac = platform_get_drvdata(pdev);
	248
	249	bgmac_enet_remove(bgmac);
	250
	251	return 0;
	252	}
	253
f3537b34 JZ	254	#ifdef CONFIG_PM
	255	static int bgmac_suspend(struct device *dev)
	256	{
	257	struct bgmac *bgmac = dev_get_drvdata(dev);
	258
	259	return bgmac_enet_suspend(bgmac);
	260	}
	261
	262	static int bgmac_resume(struct device *dev)
	263	{
	264	struct bgmac *bgmac = dev_get_drvdata(dev);
	265
	266	return bgmac_enet_resume(bgmac);
	267	}
	268
	269	static const struct dev_pm_ops bgmac_pm_ops = {
	270	.suspend = bgmac_suspend,
	271	.resume = bgmac_resume
	272	};
	273
	274	#define BGMAC_PM_OPS (&bgmac_pm_ops)
	275	#else
	276	#define BGMAC_PM_OPS NULL
	277	#endif /* CONFIG_PM */
	278
f6a95a24 JM	279	static const struct of_device_id bgmac_of_enet_match[] = {
	280	{.compatible = "brcm,amac",},
	281	{.compatible = "brcm,nsp-amac",},
dd5c5d03	282	{.compatible = "brcm,ns2-amac",},
f6a95a24 JM	283	{},
	284	};
	285
	286	MODULE_DEVICE_TABLE(of, bgmac_of_enet_match);
	287
	288	static struct platform_driver bgmac_enet_driver = {
	289	.driver = {
	290	.name = "bgmac-enet",
	291	.of_match_table = bgmac_of_enet_match,
f3537b34	292	.pm = BGMAC_PM_OPS
f6a95a24 JM	293	},
	294	.probe = bgmac_probe,
	295	.remove = bgmac_remove,
	296	};
	297
	298	module_platform_driver(bgmac_enet_driver);
	299	MODULE_LICENSE("GPL");