[deliverable/linux.git] / drivers / net / ethernet / amd / xgbe / xgbe-main.c

/*
 * AMD 10Gb Ethernet driver
 *
 * This file is available to you under your choice of the following two
 * licenses:
 *
 * License 1: GPLv2
 *
 * Copyright (c) 2014 Advanced Micro Devices, Inc.
 *
 * This file is free software; you may copy, redistribute and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or (at
 * your option) any later version.
 *
 * This file is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * This file incorporates work covered by the following copyright and
 * permission notice:
 *     The Synopsys DWC ETHER XGMAC Software Driver and documentation
 *     (hereinafter "Software") is an unsupported proprietary work of Synopsys,
 *     Inc. unless otherwise expressly agreed to in writing between Synopsys
 *     and you.
 *
 *     The Software IS NOT an item of Licensed Software or Licensed Product
 *     under any End User Software License Agreement or Agreement for Licensed
 *     Product with Synopsys or any supplement thereto.  Permission is hereby
 *     granted, free of charge, to any person obtaining a copy of this software
 *     annotated with this license and the Software, to deal in the Software
 *     without restriction, including without limitation the rights to use,
 *     copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 *     of the Software, and to permit persons to whom the Software is furnished
 *     to do so, subject to the following conditions:
 *
 *     The above copyright notice and this permission notice shall be included
 *     in all copies or substantial portions of the Software.
 *
 *     THIS SOFTWARE IS BEING DISTRIBUTED BY SYNOPSYS SOLELY ON AN "AS IS"
 *     BASIS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 *     TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 *     PARTICULAR PURPOSE ARE HEREBY DISCLAIMED. IN NO EVENT SHALL SYNOPSYS
 *     BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *     SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *     INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 *     THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * License 2: Modified BSD
 *
 * Copyright (c) 2014 Advanced Micro Devices, Inc.
 * All rights reserved.
 *
 * 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.
 *     * Neither the name of Advanced Micro Devices, Inc. nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This file incorporates work covered by the following copyright and
 * permission notice:
 *     The Synopsys DWC ETHER XGMAC Software Driver and documentation
 *     (hereinafter "Software") is an unsupported proprietary work of Synopsys,
 *     Inc. unless otherwise expressly agreed to in writing between Synopsys
 *     and you.
 *
 *     The Software IS NOT an item of Licensed Software or Licensed Product
 *     under any End User Software License Agreement or Agreement for Licensed
 *     Product with Synopsys or any supplement thereto.  Permission is hereby
 *     granted, free of charge, to any person obtaining a copy of this software
 *     annotated with this license and the Software, to deal in the Software
 *     without restriction, including without limitation the rights to use,
 *     copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 *     of the Software, and to permit persons to whom the Software is furnished
 *     to do so, subject to the following conditions:
 *
 *     The above copyright notice and this permission notice shall be included
 *     in all copies or substantial portions of the Software.
 *
 *     THIS SOFTWARE IS BEING DISTRIBUTED BY SYNOPSYS SOLELY ON AN "AS IS"
 *     BASIS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 *     TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 *     PARTICULAR PURPOSE ARE HEREBY DISCLAIMED. IN NO EVENT SHALL SYNOPSYS
 *     BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *     SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *     INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 *     THE POSSIBILITY OF SUCH DAMAGE.
 */

#include <linux/module.h>
#include <linux/device.h>
#include <linux/platform_device.h>
#include <linux/spinlock.h>
#include <linux/netdevice.h>
#include <linux/etherdevice.h>
#include <linux/io.h>
#include <linux/of.h>
#include <linux/of_net.h>
#include <linux/clk.h>

#include "xgbe.h"
#include "xgbe-common.h"

MODULE_AUTHOR("Tom Lendacky <thomas.lendacky@amd.com>");
MODULE_LICENSE("Dual BSD/GPL");
MODULE_VERSION(XGBE_DRV_VERSION);
MODULE_DESCRIPTION(XGBE_DRV_DESC);

static void xgbe_default_config(struct xgbe_prv_data *pdata)
{
	DBGPR("-->xgbe_default_config\n");

	pdata->pblx8 = DMA_PBL_X8_ENABLE;
	pdata->tx_sf_mode = MTL_TSF_ENABLE;
	pdata->tx_threshold = MTL_TX_THRESHOLD_64;
	pdata->tx_pbl = DMA_PBL_16;
	pdata->tx_osp_mode = DMA_OSP_ENABLE;
	pdata->rx_sf_mode = MTL_RSF_DISABLE;
	pdata->rx_threshold = MTL_RX_THRESHOLD_64;
	pdata->rx_pbl = DMA_PBL_16;
	pdata->pause_autoneg = 1;
	pdata->tx_pause = 1;
	pdata->rx_pause = 1;
	pdata->power_down = 0;
	pdata->default_autoneg = AUTONEG_ENABLE;
	pdata->default_speed = SPEED_10000;

	DBGPR("<--xgbe_default_config\n");
}

static void xgbe_init_all_fptrs(struct xgbe_prv_data *pdata)
{
	xgbe_init_function_ptrs_dev(&pdata->hw_if);
	xgbe_init_function_ptrs_desc(&pdata->desc_if);
}

static int xgbe_probe(struct platform_device *pdev)
{
	struct xgbe_prv_data *pdata;
	struct xgbe_hw_if *hw_if;
	struct xgbe_desc_if *desc_if;
	struct net_device *netdev;
	struct device *dev = &pdev->dev;
	struct resource *res;
	const u8 *mac_addr;
	int ret;

	DBGPR("--> xgbe_probe\n");

	netdev = alloc_etherdev_mq(sizeof(struct xgbe_prv_data),
				   XGBE_MAX_DMA_CHANNELS);
	if (!netdev) {
		dev_err(dev, "alloc_etherdev failed\n");
		ret = -ENOMEM;
		goto err_alloc;
	}
	SET_NETDEV_DEV(netdev, dev);
	pdata = netdev_priv(netdev);
	pdata->netdev = netdev;
	pdata->pdev = pdev;
	pdata->dev = dev;
	platform_set_drvdata(pdev, netdev);

	spin_lock_init(&pdata->lock);
	mutex_init(&pdata->xpcs_mutex);
	spin_lock_init(&pdata->tstamp_lock);

	/* Set and validate the number of descriptors for a ring */
	BUILD_BUG_ON_NOT_POWER_OF_2(XGBE_TX_DESC_CNT);
	pdata->tx_desc_count = XGBE_TX_DESC_CNT;
	if (pdata->tx_desc_count & (pdata->tx_desc_count - 1)) {
		dev_err(dev, "tx descriptor count (%d) is not valid\n",
			pdata->tx_desc_count);
		ret = -EINVAL;
		goto err_io;
	}
	BUILD_BUG_ON_NOT_POWER_OF_2(XGBE_RX_DESC_CNT);
	pdata->rx_desc_count = XGBE_RX_DESC_CNT;
	if (pdata->rx_desc_count & (pdata->rx_desc_count - 1)) {
		dev_err(dev, "rx descriptor count (%d) is not valid\n",
			pdata->rx_desc_count);
		ret = -EINVAL;
		goto err_io;
	}

	/* Obtain the system clock setting */
	pdata->sysclk = devm_clk_get(dev, XGBE_DMA_CLOCK);
	if (IS_ERR(pdata->sysclk)) {
		dev_err(dev, "dma devm_clk_get failed\n");
		ret = PTR_ERR(pdata->sysclk);
		goto err_io;
	}

	/* Obtain the PTP clock setting */
	pdata->ptpclk = devm_clk_get(dev, XGBE_PTP_CLOCK);
	if (IS_ERR(pdata->ptpclk)) {
		dev_err(dev, "ptp devm_clk_get failed\n");
		ret = PTR_ERR(pdata->ptpclk);
		goto err_io;
	}

	/* Obtain the mmio areas for the device */
	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	pdata->xgmac_regs = devm_ioremap_resource(dev, res);
	if (IS_ERR(pdata->xgmac_regs)) {
		dev_err(dev, "xgmac ioremap failed\n");
		ret = PTR_ERR(pdata->xgmac_regs);
		goto err_io;
	}
	DBGPR("  xgmac_regs = %p\n", pdata->xgmac_regs);

	res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
	pdata->xpcs_regs = devm_ioremap_resource(dev, res);
	if (IS_ERR(pdata->xpcs_regs)) {
		dev_err(dev, "xpcs ioremap failed\n");
		ret = PTR_ERR(pdata->xpcs_regs);
		goto err_io;
	}
	DBGPR("  xpcs_regs  = %p\n", pdata->xpcs_regs);

	/* Set the DMA mask */
	if (!dev->dma_mask)
		dev->dma_mask = &dev->coherent_dma_mask;
	ret = dma_set_mask_and_coherent(dev, DMA_BIT_MASK(40));
	if (ret) {
		dev_err(dev, "dma_set_mask_and_coherent failed\n");
		goto err_io;
	}

	if (of_property_read_bool(dev->of_node, "dma-coherent")) {
		pdata->axdomain = XGBE_DMA_OS_AXDOMAIN;
		pdata->arcache = XGBE_DMA_OS_ARCACHE;
		pdata->awcache = XGBE_DMA_OS_AWCACHE;
	} else {
		pdata->axdomain = XGBE_DMA_SYS_AXDOMAIN;
		pdata->arcache = XGBE_DMA_SYS_ARCACHE;
		pdata->awcache = XGBE_DMA_SYS_AWCACHE;
	}

	/* Check for per channel interrupt support */
	if (of_property_read_bool(dev->of_node, XGBE_DMA_IRQS))
		pdata->per_channel_irq = 1;

	ret = platform_get_irq(pdev, 0);
	if (ret < 0) {
		dev_err(dev, "platform_get_irq 0 failed\n");
		goto err_io;
	}
	pdata->dev_irq = ret;

	netdev->irq = pdata->dev_irq;
	netdev->base_addr = (unsigned long)pdata->xgmac_regs;

	/* Set all the function pointers */
	xgbe_init_all_fptrs(pdata);
	hw_if = &pdata->hw_if;
	desc_if = &pdata->desc_if;

	/* Issue software reset to device */
	hw_if->exit(pdata);

	/* Populate the hardware features */
	xgbe_get_all_hw_features(pdata);

	/* Retrieve the MAC address */
	mac_addr = of_get_mac_address(dev->of_node);
	if (!mac_addr) {
		dev_err(dev, "invalid mac address for this device\n");
		ret = -EINVAL;
		goto err_io;
	}
	memcpy(netdev->dev_addr, mac_addr, netdev->addr_len);

	/* Retrieve the PHY mode - it must be "xgmii" */
	pdata->phy_mode = of_get_phy_mode(dev->of_node);
	if (pdata->phy_mode != PHY_INTERFACE_MODE_XGMII) {
		dev_err(dev, "invalid phy-mode specified for this device\n");
		ret = -EINVAL;
		goto err_io;
	}

	/* Set default configuration data */
	xgbe_default_config(pdata);

	/* Calculate the number of Tx and Rx rings to be created
	 *  -Tx (DMA) Channels map 1-to-1 to Tx Queues so set
	 *   the number of Tx queues to the number of Tx channels
	 *   enabled
	 *  -Rx (DMA) Channels do not map 1-to-1 so use the actual
	 *   number of Rx queues
	 */
	pdata->tx_ring_count = min_t(unsigned int, num_online_cpus(),
				     pdata->hw_feat.tx_ch_cnt);
	pdata->tx_q_count = pdata->tx_ring_count;
	ret = netif_set_real_num_tx_queues(netdev, pdata->tx_ring_count);
	if (ret) {
		dev_err(dev, "error setting real tx queue count\n");
		goto err_io;
	}

	pdata->rx_ring_count = min_t(unsigned int,
				     netif_get_num_default_rss_queues(),
				     pdata->hw_feat.rx_ch_cnt);
	pdata->rx_q_count = pdata->hw_feat.rx_q_cnt;
	ret = netif_set_real_num_rx_queues(netdev, pdata->rx_ring_count);
	if (ret) {
		dev_err(dev, "error setting real rx queue count\n");
		goto err_io;
	}

	/* Prepare to regsiter with MDIO */
	pdata->mii_bus_id = kasprintf(GFP_KERNEL, "%s", pdev->name);
	if (!pdata->mii_bus_id) {
		dev_err(dev, "failed to allocate mii bus id\n");
		ret = -ENOMEM;
		goto err_io;
	}
	ret = xgbe_mdio_register(pdata);
	if (ret)
		goto err_bus_id;

	/* Set device operations */
	netdev->netdev_ops = xgbe_get_netdev_ops();
	netdev->ethtool_ops = xgbe_get_ethtool_ops();
#ifdef CONFIG_AMD_XGBE_DCB
	netdev->dcbnl_ops = xgbe_get_dcbnl_ops();
#endif

	/* Set device features */
	netdev->hw_features = NETIF_F_SG |
			      NETIF_F_IP_CSUM |
			      NETIF_F_IPV6_CSUM |
			      NETIF_F_RXCSUM |
			      NETIF_F_TSO |
			      NETIF_F_TSO6 |
			      NETIF_F_GRO |
			      NETIF_F_HW_VLAN_CTAG_RX |
			      NETIF_F_HW_VLAN_CTAG_TX |
			      NETIF_F_HW_VLAN_CTAG_FILTER;

	netdev->vlan_features |= NETIF_F_SG |
				 NETIF_F_IP_CSUM |
				 NETIF_F_IPV6_CSUM |
				 NETIF_F_TSO |
				 NETIF_F_TSO6;

	netdev->features |= netdev->hw_features;
	pdata->netdev_features = netdev->features;

	netdev->priv_flags |= IFF_UNICAST_FLT;

	xgbe_init_rx_coalesce(pdata);
	xgbe_init_tx_coalesce(pdata);

	netif_carrier_off(netdev);
	ret = register_netdev(netdev);
	if (ret) {
		dev_err(dev, "net device registration failed\n");
		goto err_reg_netdev;
	}

	xgbe_ptp_register(pdata);

	xgbe_debugfs_init(pdata);

	netdev_notice(netdev, "net device enabled\n");

	DBGPR("<-- xgbe_probe\n");

	return 0;

err_reg_netdev:
	xgbe_mdio_unregister(pdata);

err_bus_id:
	kfree(pdata->mii_bus_id);

err_io:
	free_netdev(netdev);

err_alloc:
	dev_notice(dev, "net device not enabled\n");

	return ret;
}

static int xgbe_remove(struct platform_device *pdev)
{
	struct net_device *netdev = platform_get_drvdata(pdev);
	struct xgbe_prv_data *pdata = netdev_priv(netdev);

	DBGPR("-->xgbe_remove\n");

	xgbe_debugfs_exit(pdata);

	xgbe_ptp_unregister(pdata);

	unregister_netdev(netdev);

	xgbe_mdio_unregister(pdata);

	kfree(pdata->mii_bus_id);

	free_netdev(netdev);

	DBGPR("<--xgbe_remove\n");

	return 0;
}

#ifdef CONFIG_PM
static int xgbe_suspend(struct device *dev)
{
	struct net_device *netdev = dev_get_drvdata(dev);
	int ret;

	DBGPR("-->xgbe_suspend\n");

	if (!netif_running(netdev)) {
		DBGPR("<--xgbe_dev_suspend\n");
		return -EINVAL;
	}

	ret = xgbe_powerdown(netdev, XGMAC_DRIVER_CONTEXT);

	DBGPR("<--xgbe_suspend\n");

	return ret;
}

static int xgbe_resume(struct device *dev)
{
	struct net_device *netdev = dev_get_drvdata(dev);
	int ret;

	DBGPR("-->xgbe_resume\n");

	if (!netif_running(netdev)) {
		DBGPR("<--xgbe_dev_resume\n");
		return -EINVAL;
	}

	ret = xgbe_powerup(netdev, XGMAC_DRIVER_CONTEXT);

	DBGPR("<--xgbe_resume\n");

	return ret;
}
#endif /* CONFIG_PM */

static const struct of_device_id xgbe_of_match[] = {
	{ .compatible = "amd,xgbe-seattle-v1a", },
	{},
};

MODULE_DEVICE_TABLE(of, xgbe_of_match);
static SIMPLE_DEV_PM_OPS(xgbe_pm_ops, xgbe_suspend, xgbe_resume);

static struct platform_driver xgbe_driver = {
	.driver = {
		.name = "amd-xgbe",
		.of_match_table = xgbe_of_match,
		.pm = &xgbe_pm_ops,
	},
	.probe = xgbe_probe,
	.remove = xgbe_remove,
};

module_platform_driver(xgbe_driver);
Commit	Line	Data
c5aa9e3b LT	1	/*
	2	* AMD 10Gb Ethernet driver
	3	*
	4	* This file is available to you under your choice of the following two
	5	* licenses:
	6	*
	7	* License 1: GPLv2
	8	*
	9	* Copyright (c) 2014 Advanced Micro Devices, Inc.
	10	*
	11	* This file is free software; you may copy, redistribute and/or modify
	12	* it under the terms of the GNU General Public License as published by
	13	* the Free Software Foundation, either version 2 of the License, or (at
	14	* your option) any later version.
	15	*
	16	* This file is distributed in the hope that it will be useful, but
	17	* WITHOUT ANY WARRANTY; without even the implied warranty of
	18	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	19	* General Public License for more details.
	20	*
	21	* You should have received a copy of the GNU General Public License
	22	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	23	*
	24	* This file incorporates work covered by the following copyright and
	25	* permission notice:
	26	* The Synopsys DWC ETHER XGMAC Software Driver and documentation
	27	* (hereinafter "Software") is an unsupported proprietary work of Synopsys,
	28	* Inc. unless otherwise expressly agreed to in writing between Synopsys
	29	* and you.
	30	*
	31	* The Software IS NOT an item of Licensed Software or Licensed Product
	32	* under any End User Software License Agreement or Agreement for Licensed
	33	* Product with Synopsys or any supplement thereto. Permission is hereby
	34	* granted, free of charge, to any person obtaining a copy of this software
	35	* annotated with this license and the Software, to deal in the Software
	36	* without restriction, including without limitation the rights to use,
	37	* copy, modify, merge, publish, distribute, sublicense, and/or sell copies
	38	* of the Software, and to permit persons to whom the Software is furnished
	39	* to do so, subject to the following conditions:
	40	*
	41	* The above copyright notice and this permission notice shall be included
	42	* in all copies or substantial portions of the Software.
	43	*
	44	* THIS SOFTWARE IS BEING DISTRIBUTED BY SYNOPSYS SOLELY ON AN "AS IS"
	45	* BASIS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
	46	* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
	47	* PARTICULAR PURPOSE ARE HEREBY DISCLAIMED. IN NO EVENT SHALL SYNOPSYS
	48	* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
	49	* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
	50	* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
	51	* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
	52	* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
	53	* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
	54	* THE POSSIBILITY OF SUCH DAMAGE.
	55	*
	56	*
	57	* License 2: Modified BSD
	58	*
	59	* Copyright (c) 2014 Advanced Micro Devices, Inc.
	60	* All rights reserved.
	61	*
	62	* Redistribution and use in source and binary forms, with or without
	63	* modification, are permitted provided that the following conditions are met:
	64	* * Redistributions of source code must retain the above copyright
65	* notice, this list of conditions and the following disclaimer.
66	* * Redistributions in binary form must reproduce the above copyright
67	* notice, this list of conditions and the following disclaimer in the
68	* documentation and/or other materials provided with the distribution.
69	* * Neither the name of Advanced Micro Devices, Inc. nor the
70	* names of its contributors may be used to endorse or promote products
71	* derived from this software without specific prior written permission.
72	*
73	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
74	* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
75	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
76	* ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
77	* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
78	* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
79	* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
80	* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
81	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
82	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
83	*
84	* This file incorporates work covered by the following copyright and
85	* permission notice:
86	* The Synopsys DWC ETHER XGMAC Software Driver and documentation
87	* (hereinafter "Software") is an unsupported proprietary work of Synopsys,
88	* Inc. unless otherwise expressly agreed to in writing between Synopsys
89	* and you.
90	*
91	* The Software IS NOT an item of Licensed Software or Licensed Product
92	* under any End User Software License Agreement or Agreement for Licensed
93	* Product with Synopsys or any supplement thereto. Permission is hereby
94	* granted, free of charge, to any person obtaining a copy of this software
95	* annotated with this license and the Software, to deal in the Software
96	* without restriction, including without limitation the rights to use,
97	* copy, modify, merge, publish, distribute, sublicense, and/or sell copies
98	* of the Software, and to permit persons to whom the Software is furnished
99	* to do so, subject to the following conditions:
100	*
101	* The above copyright notice and this permission notice shall be included
102	* in all copies or substantial portions of the Software.
103	*
104	* THIS SOFTWARE IS BEING DISTRIBUTED BY SYNOPSYS SOLELY ON AN "AS IS"
105	* BASIS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
106	* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
107	* PARTICULAR PURPOSE ARE HEREBY DISCLAIMED. IN NO EVENT SHALL SYNOPSYS
108	* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
109	* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
110	* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
111	* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
112	* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
113	* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
114	* THE POSSIBILITY OF SUCH DAMAGE.
115	*/
116
117	#include <linux/module.h>
118	#include <linux/device.h>
119	#include <linux/platform_device.h>
120	#include <linux/spinlock.h>
121	#include <linux/netdevice.h>
122	#include <linux/etherdevice.h>
123	#include <linux/io.h>
124	#include <linux/of.h>
125	#include <linux/of_net.h>
126	#include <linux/clk.h>
127
128	#include "xgbe.h"
129	#include "xgbe-common.h"
130
c5aa9e3b LT	131	MODULE_AUTHOR("Tom Lendacky <thomas.lendacky@amd.com>");
	132	MODULE_LICENSE("Dual BSD/GPL");
	133	MODULE_VERSION(XGBE_DRV_VERSION);
	134	MODULE_DESCRIPTION(XGBE_DRV_DESC);
	135
c5aa9e3b LT	136	static void xgbe_default_config(struct xgbe_prv_data *pdata)
	137	{
	138	DBGPR("-->xgbe_default_config\n");
	139
	140	pdata->pblx8 = DMA_PBL_X8_ENABLE;
	141	pdata->tx_sf_mode = MTL_TSF_ENABLE;
	142	pdata->tx_threshold = MTL_TX_THRESHOLD_64;
	143	pdata->tx_pbl = DMA_PBL_16;
	144	pdata->tx_osp_mode = DMA_OSP_ENABLE;
	145	pdata->rx_sf_mode = MTL_RSF_DISABLE;
	146	pdata->rx_threshold = MTL_RX_THRESHOLD_64;
	147	pdata->rx_pbl = DMA_PBL_16;
	148	pdata->pause_autoneg = 1;
	149	pdata->tx_pause = 1;
	150	pdata->rx_pause = 1;
	151	pdata->power_down = 0;
	152	pdata->default_autoneg = AUTONEG_ENABLE;
	153	pdata->default_speed = SPEED_10000;
	154
	155	DBGPR("<--xgbe_default_config\n");
	156	}
	157
	158	static void xgbe_init_all_fptrs(struct xgbe_prv_data *pdata)
	159	{
	160	xgbe_init_function_ptrs_dev(&pdata->hw_if);
	161	xgbe_init_function_ptrs_desc(&pdata->desc_if);
	162	}
	163
	164	static int xgbe_probe(struct platform_device *pdev)
	165	{
	166	struct xgbe_prv_data *pdata;
	167	struct xgbe_hw_if *hw_if;
	168	struct xgbe_desc_if *desc_if;
	169	struct net_device *netdev;
	170	struct device *dev = &pdev->dev;
	171	struct resource *res;
	172	const u8 *mac_addr;
	173	int ret;
	174
	175	DBGPR("--> xgbe_probe\n");
	176
	177	netdev = alloc_etherdev_mq(sizeof(struct xgbe_prv_data),
d5c48582	178	XGBE_MAX_DMA_CHANNELS);
c5aa9e3b LT	179	if (!netdev) {
	180	dev_err(dev, "alloc_etherdev failed\n");
	181	ret = -ENOMEM;
	182	goto err_alloc;
	183	}
	184	SET_NETDEV_DEV(netdev, dev);
	185	pdata = netdev_priv(netdev);
	186	pdata->netdev = netdev;
	187	pdata->pdev = pdev;
	188	pdata->dev = dev;
	189	platform_set_drvdata(pdev, netdev);
	190
	191	spin_lock_init(&pdata->lock);
	192	mutex_init(&pdata->xpcs_mutex);
23e4eef7	193	spin_lock_init(&pdata->tstamp_lock);
c5aa9e3b LT	194
c5aa9e3b LT	195	/* Set and validate the number of descriptors for a ring */
d0a8ba6c LT	196	BUILD_BUG_ON_NOT_POWER_OF_2(XGBE_TX_DESC_CNT);
d0a8ba6c LT	197	pdata->tx_desc_count = XGBE_TX_DESC_CNT;
c5aa9e3b LT	198	if (pdata->tx_desc_count & (pdata->tx_desc_count - 1)) {
	199	dev_err(dev, "tx descriptor count (%d) is not valid\n",
	200	pdata->tx_desc_count);
	201	ret = -EINVAL;
	202	goto err_io;
	203	}
d0a8ba6c LT	204	BUILD_BUG_ON_NOT_POWER_OF_2(XGBE_RX_DESC_CNT);
d0a8ba6c LT	205	pdata->rx_desc_count = XGBE_RX_DESC_CNT;
c5aa9e3b LT	206	if (pdata->rx_desc_count & (pdata->rx_desc_count - 1)) {
	207	dev_err(dev, "rx descriptor count (%d) is not valid\n",
	208	pdata->rx_desc_count);
	209	ret = -EINVAL;
	210	goto err_io;
	211	}
	212
	213	/* Obtain the system clock setting */
23e4eef7 LT	214	pdata->sysclk = devm_clk_get(dev, XGBE_DMA_CLOCK);
	215	if (IS_ERR(pdata->sysclk)) {
	216	dev_err(dev, "dma devm_clk_get failed\n");
	217	ret = PTR_ERR(pdata->sysclk);
	218	goto err_io;
	219	}
	220
	221	/* Obtain the PTP clock setting */
	222	pdata->ptpclk = devm_clk_get(dev, XGBE_PTP_CLOCK);
	223	if (IS_ERR(pdata->ptpclk)) {
	224	dev_err(dev, "ptp devm_clk_get failed\n");
	225	ret = PTR_ERR(pdata->ptpclk);
c5aa9e3b LT	226	goto err_io;
	227	}
	228
	229	/* Obtain the mmio areas for the device */
	230	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	231	pdata->xgmac_regs = devm_ioremap_resource(dev, res);
	232	if (IS_ERR(pdata->xgmac_regs)) {
	233	dev_err(dev, "xgmac ioremap failed\n");
	234	ret = PTR_ERR(pdata->xgmac_regs);
	235	goto err_io;
	236	}
	237	DBGPR(" xgmac_regs = %p\n", pdata->xgmac_regs);
	238
	239	res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
	240	pdata->xpcs_regs = devm_ioremap_resource(dev, res);
	241	if (IS_ERR(pdata->xpcs_regs)) {
	242	dev_err(dev, "xpcs ioremap failed\n");
	243	ret = PTR_ERR(pdata->xpcs_regs);
	244	goto err_io;
	245	}
	246	DBGPR(" xpcs_regs = %p\n", pdata->xpcs_regs);
	247
	248	/* Set the DMA mask */
	249	if (!dev->dma_mask)
	250	dev->dma_mask = &dev->coherent_dma_mask;
f3d0e78d LT	251	ret = dma_set_mask_and_coherent(dev, DMA_BIT_MASK(40));
	252	if (ret) {
	253	dev_err(dev, "dma_set_mask_and_coherent failed\n");
	254	goto err_io;
	255	}
c5aa9e3b	256
cfa50c78 LT	257	if (of_property_read_bool(dev->of_node, "dma-coherent")) {
	258	pdata->axdomain = XGBE_DMA_OS_AXDOMAIN;
	259	pdata->arcache = XGBE_DMA_OS_ARCACHE;
	260	pdata->awcache = XGBE_DMA_OS_AWCACHE;
	261	} else {
	262	pdata->axdomain = XGBE_DMA_SYS_AXDOMAIN;
	263	pdata->arcache = XGBE_DMA_SYS_ARCACHE;
	264	pdata->awcache = XGBE_DMA_SYS_AWCACHE;
	265	}
	266
9227dc5e LT	267	/* Check for per channel interrupt support */
	268	if (of_property_read_bool(dev->of_node, XGBE_DMA_IRQS))
	269	pdata->per_channel_irq = 1;
	270
c5aa9e3b LT	271	ret = platform_get_irq(pdev, 0);
c5aa9e3b LT	272	if (ret < 0) {
9227dc5e	273	dev_err(dev, "platform_get_irq 0 failed\n");
c5aa9e3b LT	274	goto err_io;
c5aa9e3b LT	275	}
9227dc5e LT	276	pdata->dev_irq = ret;
	277
	278	netdev->irq = pdata->dev_irq;
c5aa9e3b LT	279	netdev->base_addr = (unsigned long)pdata->xgmac_regs;
	280
	281	/* Set all the function pointers */
	282	xgbe_init_all_fptrs(pdata);
	283	hw_if = &pdata->hw_if;
	284	desc_if = &pdata->desc_if;
	285
	286	/* Issue software reset to device */
	287	hw_if->exit(pdata);
	288
	289	/* Populate the hardware features */
	290	xgbe_get_all_hw_features(pdata);
	291
	292	/* Retrieve the MAC address */
	293	mac_addr = of_get_mac_address(dev->of_node);
	294	if (!mac_addr) {
	295	dev_err(dev, "invalid mac address for this device\n");
	296	ret = -EINVAL;
	297	goto err_io;
	298	}
	299	memcpy(netdev->dev_addr, mac_addr, netdev->addr_len);
	300
	301	/* Retrieve the PHY mode - it must be "xgmii" */
	302	pdata->phy_mode = of_get_phy_mode(dev->of_node);
	303	if (pdata->phy_mode != PHY_INTERFACE_MODE_XGMII) {
	304	dev_err(dev, "invalid phy-mode specified for this device\n");
	305	ret = -EINVAL;
	306	goto err_io;
	307	}
	308
	309	/* Set default configuration data */
	310	xgbe_default_config(pdata);
	311
853eb16b LT	312	/* Calculate the number of Tx and Rx rings to be created
	313	* -Tx (DMA) Channels map 1-to-1 to Tx Queues so set
	314	* the number of Tx queues to the number of Tx channels
	315	* enabled
	316	* -Rx (DMA) Channels do not map 1-to-1 so use the actual
	317	* number of Rx queues
	318	*/
c5aa9e3b LT	319	pdata->tx_ring_count = min_t(unsigned int, num_online_cpus(),
c5aa9e3b LT	320	pdata->hw_feat.tx_ch_cnt);
853eb16b	321	pdata->tx_q_count = pdata->tx_ring_count;
332cfc82 WY	322	ret = netif_set_real_num_tx_queues(netdev, pdata->tx_ring_count);
332cfc82 WY	323	if (ret) {
c5aa9e3b LT	324	dev_err(dev, "error setting real tx queue count\n");
	325	goto err_io;
	326	}
	327
	328	pdata->rx_ring_count = min_t(unsigned int,
	329	netif_get_num_default_rss_queues(),
	330	pdata->hw_feat.rx_ch_cnt);
853eb16b	331	pdata->rx_q_count = pdata->hw_feat.rx_q_cnt;
c5aa9e3b LT	332	ret = netif_set_real_num_rx_queues(netdev, pdata->rx_ring_count);
	333	if (ret) {
	334	dev_err(dev, "error setting real rx queue count\n");
	335	goto err_io;
	336	}
	337
c5aa9e3b LT	338	/* Prepare to regsiter with MDIO */
	339	pdata->mii_bus_id = kasprintf(GFP_KERNEL, "%s", pdev->name);
	340	if (!pdata->mii_bus_id) {
	341	dev_err(dev, "failed to allocate mii bus id\n");
	342	ret = -ENOMEM;
	343	goto err_io;
	344	}
	345	ret = xgbe_mdio_register(pdata);
	346	if (ret)
	347	goto err_bus_id;
	348
fca2d994	349	/* Set device operations */
c5aa9e3b LT	350	netdev->netdev_ops = xgbe_get_netdev_ops();
c5aa9e3b LT	351	netdev->ethtool_ops = xgbe_get_ethtool_ops();
fca2d994 LT	352	#ifdef CONFIG_AMD_XGBE_DCB
	353	netdev->dcbnl_ops = xgbe_get_dcbnl_ops();
	354	#endif
c5aa9e3b LT	355
	356	/* Set device features */
	357	netdev->hw_features = NETIF_F_SG \|
	358	NETIF_F_IP_CSUM \|
	359	NETIF_F_IPV6_CSUM \|
	360	NETIF_F_RXCSUM \|
	361	NETIF_F_TSO \|
	362	NETIF_F_TSO6 \|
	363	NETIF_F_GRO \|
	364	NETIF_F_HW_VLAN_CTAG_RX \|
801c62d9 LT	365	NETIF_F_HW_VLAN_CTAG_TX \|
801c62d9 LT	366	NETIF_F_HW_VLAN_CTAG_FILTER;
c5aa9e3b LT	367
	368	netdev->vlan_features \|= NETIF_F_SG \|
	369	NETIF_F_IP_CSUM \|
	370	NETIF_F_IPV6_CSUM \|
	371	NETIF_F_TSO \|
	372	NETIF_F_TSO6;
	373
	374	netdev->features \|= netdev->hw_features;
	375	pdata->netdev_features = netdev->features;
	376
b85e4d89 LT	377	netdev->priv_flags \|= IFF_UNICAST_FLT;
b85e4d89 LT	378
c5aa9e3b LT	379	xgbe_init_rx_coalesce(pdata);
	380	xgbe_init_tx_coalesce(pdata);
	381
	382	netif_carrier_off(netdev);
	383	ret = register_netdev(netdev);
	384	if (ret) {
	385	dev_err(dev, "net device registration failed\n");
	386	goto err_reg_netdev;
	387	}
	388
23e4eef7 LT	389	xgbe_ptp_register(pdata);
23e4eef7 LT	390
c5aa9e3b LT	391	xgbe_debugfs_init(pdata);
	392
	393	netdev_notice(netdev, "net device enabled\n");
	394
	395	DBGPR("<-- xgbe_probe\n");
	396
	397	return 0;
	398
	399	err_reg_netdev:
	400	xgbe_mdio_unregister(pdata);
	401
	402	err_bus_id:
	403	kfree(pdata->mii_bus_id);
	404
	405	err_io:
	406	free_netdev(netdev);
	407
	408	err_alloc:
	409	dev_notice(dev, "net device not enabled\n");
	410
	411	return ret;
	412	}
	413
	414	static int xgbe_remove(struct platform_device *pdev)
	415	{
	416	struct net_device *netdev = platform_get_drvdata(pdev);
	417	struct xgbe_prv_data *pdata = netdev_priv(netdev);
	418
	419	DBGPR("-->xgbe_remove\n");
	420
	421	xgbe_debugfs_exit(pdata);
	422
23e4eef7 LT	423	xgbe_ptp_unregister(pdata);
23e4eef7 LT	424
c5aa9e3b LT	425	unregister_netdev(netdev);
	426
	427	xgbe_mdio_unregister(pdata);
	428
	429	kfree(pdata->mii_bus_id);
	430
	431	free_netdev(netdev);
	432
	433	DBGPR("<--xgbe_remove\n");
	434
	435	return 0;
	436	}
	437
	438	#ifdef CONFIG_PM
	439	static int xgbe_suspend(struct device *dev)
	440	{
	441	struct net_device *netdev = dev_get_drvdata(dev);
	442	int ret;
	443
	444	DBGPR("-->xgbe_suspend\n");
	445
	446	if (!netif_running(netdev)) {
	447	DBGPR("<--xgbe_dev_suspend\n");
	448	return -EINVAL;
	449	}
	450
	451	ret = xgbe_powerdown(netdev, XGMAC_DRIVER_CONTEXT);
	452
	453	DBGPR("<--xgbe_suspend\n");
	454
	455	return ret;
	456	}
	457
	458	static int xgbe_resume(struct device *dev)
	459	{
	460	struct net_device *netdev = dev_get_drvdata(dev);
	461	int ret;
	462
	463	DBGPR("-->xgbe_resume\n");
	464
	465	if (!netif_running(netdev)) {
	466	DBGPR("<--xgbe_dev_resume\n");
	467	return -EINVAL;
	468	}
	469
	470	ret = xgbe_powerup(netdev, XGMAC_DRIVER_CONTEXT);
	471
	472	DBGPR("<--xgbe_resume\n");
	473
	474	return ret;
	475	}
	476	#endif /* CONFIG_PM */
	477
	478	static const struct of_device_id xgbe_of_match[] = {
	479	{ .compatible = "amd,xgbe-seattle-v1a", },
	480	{},
	481	};
	482
	483	MODULE_DEVICE_TABLE(of, xgbe_of_match);
	484	static SIMPLE_DEV_PM_OPS(xgbe_pm_ops, xgbe_suspend, xgbe_resume);
	485
	486	static struct platform_driver xgbe_driver = {
	487	.driver = {
	488	.name = "amd-xgbe",
489	.of_match_table = xgbe_of_match,
490	.pm = &xgbe_pm_ops,
491	},
492	.probe = xgbe_probe,
493	.remove = xgbe_remove,
494	};
495
496	module_platform_driver(xgbe_driver);