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-2016 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-2016 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/spinlock.h>
120 #include <linux/netdevice.h>
121 #include <linux/etherdevice.h>
122 #include <linux/io.h>
123 
124 #include "xgbe.h"
125 #include "xgbe-common.h"
126 
127 MODULE_AUTHOR("Tom Lendacky <thomas.lendacky@amd.com>");
128 MODULE_LICENSE("Dual BSD/GPL");
129 MODULE_VERSION(XGBE_DRV_VERSION);
130 MODULE_DESCRIPTION(XGBE_DRV_DESC);
131 
132 static int debug = -1;
133 module_param(debug, int, S_IWUSR | S_IRUGO);
134 MODULE_PARM_DESC(debug, " Network interface message level setting");
135 
136 static const u32 default_msg_level = (NETIF_MSG_LINK | NETIF_MSG_IFDOWN |
137 				      NETIF_MSG_IFUP);
138 
139 static void xgbe_default_config(struct xgbe_prv_data *pdata)
140 {
141 	DBGPR("-->xgbe_default_config\n");
142 
143 	pdata->blen = DMA_SBMR_BLEN_64;
144 	pdata->pbl = DMA_PBL_128;
145 	pdata->aal = 1;
146 	pdata->rd_osr_limit = 8;
147 	pdata->wr_osr_limit = 8;
148 	pdata->tx_sf_mode = MTL_TSF_ENABLE;
149 	pdata->tx_threshold = MTL_TX_THRESHOLD_64;
150 	pdata->tx_osp_mode = DMA_OSP_ENABLE;
151 	pdata->rx_sf_mode = MTL_RSF_DISABLE;
152 	pdata->rx_threshold = MTL_RX_THRESHOLD_64;
153 	pdata->pause_autoneg = 1;
154 	pdata->tx_pause = 1;
155 	pdata->rx_pause = 1;
156 	pdata->phy_speed = SPEED_UNKNOWN;
157 	pdata->power_down = 0;
158 
159 	DBGPR("<--xgbe_default_config\n");
160 }
161 
162 static void xgbe_init_all_fptrs(struct xgbe_prv_data *pdata)
163 {
164 	xgbe_init_function_ptrs_dev(&pdata->hw_if);
165 	xgbe_init_function_ptrs_phy(&pdata->phy_if);
166 	xgbe_init_function_ptrs_i2c(&pdata->i2c_if);
167 	xgbe_init_function_ptrs_desc(&pdata->desc_if);
168 
169 	pdata->vdata->init_function_ptrs_phy_impl(&pdata->phy_if);
170 }
171 
172 struct xgbe_prv_data *xgbe_alloc_pdata(struct device *dev)
173 {
174 	struct xgbe_prv_data *pdata;
175 	struct net_device *netdev;
176 
177 	netdev = alloc_etherdev_mq(sizeof(struct xgbe_prv_data),
178 				   XGBE_MAX_DMA_CHANNELS);
179 	if (!netdev) {
180 		dev_err(dev, "alloc_etherdev_mq failed\n");
181 		return ERR_PTR(-ENOMEM);
182 	}
183 	SET_NETDEV_DEV(netdev, dev);
184 	pdata = netdev_priv(netdev);
185 	pdata->netdev = netdev;
186 	pdata->dev = dev;
187 
188 	spin_lock_init(&pdata->lock);
189 	spin_lock_init(&pdata->xpcs_lock);
190 	mutex_init(&pdata->rss_mutex);
191 	spin_lock_init(&pdata->tstamp_lock);
192 	mutex_init(&pdata->i2c_mutex);
193 	init_completion(&pdata->i2c_complete);
194 	init_completion(&pdata->mdio_complete);
195 
196 	pdata->msg_enable = netif_msg_init(debug, default_msg_level);
197 
198 	set_bit(XGBE_DOWN, &pdata->dev_state);
199 	set_bit(XGBE_STOPPED, &pdata->dev_state);
200 
201 	return pdata;
202 }
203 
204 void xgbe_free_pdata(struct xgbe_prv_data *pdata)
205 {
206 	struct net_device *netdev = pdata->netdev;
207 
208 	free_netdev(netdev);
209 }
210 
211 void xgbe_set_counts(struct xgbe_prv_data *pdata)
212 {
213 	/* Set all the function pointers */
214 	xgbe_init_all_fptrs(pdata);
215 
216 	/* Populate the hardware features */
217 	xgbe_get_all_hw_features(pdata);
218 
219 	/* Set default max values if not provided */
220 	if (!pdata->tx_max_channel_count)
221 		pdata->tx_max_channel_count = pdata->hw_feat.tx_ch_cnt;
222 	if (!pdata->rx_max_channel_count)
223 		pdata->rx_max_channel_count = pdata->hw_feat.rx_ch_cnt;
224 
225 	if (!pdata->tx_max_q_count)
226 		pdata->tx_max_q_count = pdata->hw_feat.tx_q_cnt;
227 	if (!pdata->rx_max_q_count)
228 		pdata->rx_max_q_count = pdata->hw_feat.rx_q_cnt;
229 
230 	/* Calculate the number of Tx and Rx rings to be created
231 	 *  -Tx (DMA) Channels map 1-to-1 to Tx Queues so set
232 	 *   the number of Tx queues to the number of Tx channels
233 	 *   enabled
234 	 *  -Rx (DMA) Channels do not map 1-to-1 so use the actual
235 	 *   number of Rx queues or maximum allowed
236 	 */
237 	pdata->tx_ring_count = min_t(unsigned int, num_online_cpus(),
238 				     pdata->hw_feat.tx_ch_cnt);
239 	pdata->tx_ring_count = min_t(unsigned int, pdata->tx_ring_count,
240 				     pdata->tx_max_channel_count);
241 	pdata->tx_ring_count = min_t(unsigned int, pdata->tx_ring_count,
242 				     pdata->tx_max_q_count);
243 
244 	pdata->tx_q_count = pdata->tx_ring_count;
245 
246 	pdata->rx_ring_count = min_t(unsigned int, num_online_cpus(),
247 				     pdata->hw_feat.rx_ch_cnt);
248 	pdata->rx_ring_count = min_t(unsigned int, pdata->rx_ring_count,
249 				     pdata->rx_max_channel_count);
250 
251 	pdata->rx_q_count = min_t(unsigned int, pdata->hw_feat.rx_q_cnt,
252 				  pdata->rx_max_q_count);
253 
254 	if (netif_msg_probe(pdata)) {
255 		dev_dbg(pdata->dev, "TX/RX DMA channel count = %u/%u\n",
256 			pdata->tx_ring_count, pdata->rx_ring_count);
257 		dev_dbg(pdata->dev, "TX/RX hardware queue count = %u/%u\n",
258 			pdata->tx_q_count, pdata->rx_q_count);
259 	}
260 }
261 
262 int xgbe_config_netdev(struct xgbe_prv_data *pdata)
263 {
264 	struct net_device *netdev = pdata->netdev;
265 	struct device *dev = pdata->dev;
266 	unsigned int i;
267 	int ret;
268 
269 	netdev->irq = pdata->dev_irq;
270 	netdev->base_addr = (unsigned long)pdata->xgmac_regs;
271 	memcpy(netdev->dev_addr, pdata->mac_addr, netdev->addr_len);
272 
273 	/* Initialize ECC timestamps */
274 	pdata->tx_sec_period = jiffies;
275 	pdata->tx_ded_period = jiffies;
276 	pdata->rx_sec_period = jiffies;
277 	pdata->rx_ded_period = jiffies;
278 	pdata->desc_sec_period = jiffies;
279 	pdata->desc_ded_period = jiffies;
280 
281 	/* Issue software reset to device */
282 	ret = pdata->hw_if.exit(pdata);
283 	if (ret) {
284 		dev_err(dev, "software reset failed\n");
285 		return ret;
286 	}
287 
288 	/* Set default configuration data */
289 	xgbe_default_config(pdata);
290 
291 	/* Set the DMA mask */
292 	ret = dma_set_mask_and_coherent(dev,
293 					DMA_BIT_MASK(pdata->hw_feat.dma_width));
294 	if (ret) {
295 		dev_err(dev, "dma_set_mask_and_coherent failed\n");
296 		return ret;
297 	}
298 
299 	/* Set default max values if not provided */
300 	if (!pdata->tx_max_fifo_size)
301 		pdata->tx_max_fifo_size = pdata->hw_feat.tx_fifo_size;
302 	if (!pdata->rx_max_fifo_size)
303 		pdata->rx_max_fifo_size = pdata->hw_feat.rx_fifo_size;
304 
305 	/* Set and validate the number of descriptors for a ring */
306 	BUILD_BUG_ON_NOT_POWER_OF_2(XGBE_TX_DESC_CNT);
307 	pdata->tx_desc_count = XGBE_TX_DESC_CNT;
308 
309 	BUILD_BUG_ON_NOT_POWER_OF_2(XGBE_RX_DESC_CNT);
310 	pdata->rx_desc_count = XGBE_RX_DESC_CNT;
311 
312 	/* Adjust the number of queues based on interrupts assigned */
313 	if (pdata->channel_irq_count) {
314 		pdata->tx_ring_count = min_t(unsigned int, pdata->tx_ring_count,
315 					     pdata->channel_irq_count);
316 		pdata->rx_ring_count = min_t(unsigned int, pdata->rx_ring_count,
317 					     pdata->channel_irq_count);
318 
319 		if (netif_msg_probe(pdata))
320 			dev_dbg(pdata->dev,
321 				"adjusted TX/RX DMA channel count = %u/%u\n",
322 				pdata->tx_ring_count, pdata->rx_ring_count);
323 	}
324 
325 	/* Set the number of queues */
326 	ret = netif_set_real_num_tx_queues(netdev, pdata->tx_ring_count);
327 	if (ret) {
328 		dev_err(dev, "error setting real tx queue count\n");
329 		return ret;
330 	}
331 
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 		return ret;
336 	}
337 
338 	/* Initialize RSS hash key and lookup table */
339 	netdev_rss_key_fill(pdata->rss_key, sizeof(pdata->rss_key));
340 
341 	for (i = 0; i < XGBE_RSS_MAX_TABLE_SIZE; i++)
342 		XGMAC_SET_BITS(pdata->rss_table[i], MAC_RSSDR, DMCH,
343 			       i % pdata->rx_ring_count);
344 
345 	XGMAC_SET_BITS(pdata->rss_options, MAC_RSSCR, IP2TE, 1);
346 	XGMAC_SET_BITS(pdata->rss_options, MAC_RSSCR, TCP4TE, 1);
347 	XGMAC_SET_BITS(pdata->rss_options, MAC_RSSCR, UDP4TE, 1);
348 
349 	/* Call MDIO/PHY initialization routine */
350 	ret = pdata->phy_if.phy_init(pdata);
351 	if (ret)
352 		return ret;
353 
354 	/* Set device operations */
355 	netdev->netdev_ops = xgbe_get_netdev_ops();
356 	netdev->ethtool_ops = xgbe_get_ethtool_ops();
357 #ifdef CONFIG_AMD_XGBE_DCB
358 	netdev->dcbnl_ops = xgbe_get_dcbnl_ops();
359 #endif
360 
361 	/* Set device features */
362 	netdev->hw_features = NETIF_F_SG |
363 			      NETIF_F_IP_CSUM |
364 			      NETIF_F_IPV6_CSUM |
365 			      NETIF_F_RXCSUM |
366 			      NETIF_F_TSO |
367 			      NETIF_F_TSO6 |
368 			      NETIF_F_GRO |
369 			      NETIF_F_HW_VLAN_CTAG_RX |
370 			      NETIF_F_HW_VLAN_CTAG_TX |
371 			      NETIF_F_HW_VLAN_CTAG_FILTER;
372 
373 	if (pdata->hw_feat.rss)
374 		netdev->hw_features |= NETIF_F_RXHASH;
375 
376 	netdev->vlan_features |= NETIF_F_SG |
377 				 NETIF_F_IP_CSUM |
378 				 NETIF_F_IPV6_CSUM |
379 				 NETIF_F_TSO |
380 				 NETIF_F_TSO6;
381 
382 	netdev->features |= netdev->hw_features;
383 	pdata->netdev_features = netdev->features;
384 
385 	netdev->priv_flags |= IFF_UNICAST_FLT;
386 	netdev->min_mtu = 0;
387 	netdev->max_mtu = XGMAC_JUMBO_PACKET_MTU;
388 
389 	/* Use default watchdog timeout */
390 	netdev->watchdog_timeo = 0;
391 
392 	xgbe_init_rx_coalesce(pdata);
393 	xgbe_init_tx_coalesce(pdata);
394 
395 	netif_carrier_off(netdev);
396 	ret = register_netdev(netdev);
397 	if (ret) {
398 		dev_err(dev, "net device registration failed\n");
399 		return ret;
400 	}
401 
402 	/* Create the PHY/ANEG name based on netdev name */
403 	snprintf(pdata->an_name, sizeof(pdata->an_name) - 1, "%s-pcs",
404 		 netdev_name(netdev));
405 
406 	/* Create the ECC name based on netdev name */
407 	snprintf(pdata->ecc_name, sizeof(pdata->ecc_name) - 1, "%s-ecc",
408 		 netdev_name(netdev));
409 
410 	/* Create the I2C name based on netdev name */
411 	snprintf(pdata->i2c_name, sizeof(pdata->i2c_name) - 1, "%s-i2c",
412 		 netdev_name(netdev));
413 
414 	/* Create workqueues */
415 	pdata->dev_workqueue =
416 		create_singlethread_workqueue(netdev_name(netdev));
417 	if (!pdata->dev_workqueue) {
418 		netdev_err(netdev, "device workqueue creation failed\n");
419 		ret = -ENOMEM;
420 		goto err_netdev;
421 	}
422 
423 	pdata->an_workqueue =
424 		create_singlethread_workqueue(pdata->an_name);
425 	if (!pdata->an_workqueue) {
426 		netdev_err(netdev, "phy workqueue creation failed\n");
427 		ret = -ENOMEM;
428 		goto err_wq;
429 	}
430 
431 	if (IS_REACHABLE(CONFIG_PTP_1588_CLOCK))
432 		xgbe_ptp_register(pdata);
433 
434 	xgbe_debugfs_init(pdata);
435 
436 	netif_dbg(pdata, drv, pdata->netdev, "%u Tx software queues\n",
437 		  pdata->tx_ring_count);
438 	netif_dbg(pdata, drv, pdata->netdev, "%u Rx software queues\n",
439 		  pdata->rx_ring_count);
440 
441 	return 0;
442 
443 err_wq:
444 	destroy_workqueue(pdata->dev_workqueue);
445 
446 err_netdev:
447 	unregister_netdev(netdev);
448 
449 	return ret;
450 }
451 
452 void xgbe_deconfig_netdev(struct xgbe_prv_data *pdata)
453 {
454 	struct net_device *netdev = pdata->netdev;
455 
456 	xgbe_debugfs_exit(pdata);
457 
458 	if (IS_REACHABLE(CONFIG_PTP_1588_CLOCK))
459 		xgbe_ptp_unregister(pdata);
460 
461 	pdata->phy_if.phy_exit(pdata);
462 
463 	flush_workqueue(pdata->an_workqueue);
464 	destroy_workqueue(pdata->an_workqueue);
465 
466 	flush_workqueue(pdata->dev_workqueue);
467 	destroy_workqueue(pdata->dev_workqueue);
468 
469 	unregister_netdev(netdev);
470 }
471 
472 static int __init xgbe_mod_init(void)
473 {
474 	int ret;
475 
476 	ret = xgbe_platform_init();
477 	if (ret)
478 		return ret;
479 
480 	ret = xgbe_pci_init();
481 	if (ret)
482 		return ret;
483 
484 	return 0;
485 }
486 
487 static void __exit xgbe_mod_exit(void)
488 {
489 	xgbe_pci_exit();
490 
491 	xgbe_platform_exit();
492 }
493 
494 module_init(xgbe_mod_init);
495 module_exit(xgbe_mod_exit);
496