xref: /linux/drivers/net/ethernet/wangxun/ngbevf/ngbevf_main.c (revision ccde82e909467abdf098a8ee6f63e1ecf9a47ce5)
1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (c) 2015 - 2025 Beijing WangXun Technology Co., Ltd. */
3 
4 #include <linux/types.h>
5 #include <linux/module.h>
6 #include <linux/pci.h>
7 #include <linux/netdevice.h>
8 #include <linux/string.h>
9 #include <linux/etherdevice.h>
10 
11 #include "../libwx/wx_type.h"
12 #include "../libwx/wx_hw.h"
13 #include "../libwx/wx_lib.h"
14 #include "../libwx/wx_mbx.h"
15 #include "../libwx/wx_vf.h"
16 #include "../libwx/wx_vf_common.h"
17 #include "ngbevf_type.h"
18 
19 /* ngbevf_pci_tbl - PCI Device ID Table
20  *
21  * Wildcard entries (PCI_ANY_ID) should come last
22  * Last entry must be all 0s
23  *
24  * { Vendor ID, Device ID, SubVendor ID, SubDevice ID,
25  *   Class, Class Mask, private data (not used) }
26  */
27 static const struct pci_device_id ngbevf_pci_tbl[] = {
28 	{ PCI_VDEVICE(WANGXUN, NGBEVF_DEV_ID_EM_WX1860AL_W), 0},
29 	{ PCI_VDEVICE(WANGXUN, NGBEVF_DEV_ID_EM_WX1860A2), 0},
30 	{ PCI_VDEVICE(WANGXUN, NGBEVF_DEV_ID_EM_WX1860A2S), 0},
31 	{ PCI_VDEVICE(WANGXUN, NGBEVF_DEV_ID_EM_WX1860A4), 0},
32 	{ PCI_VDEVICE(WANGXUN, NGBEVF_DEV_ID_EM_WX1860A4S), 0},
33 	{ PCI_VDEVICE(WANGXUN, NGBEVF_DEV_ID_EM_WX1860AL2), 0},
34 	{ PCI_VDEVICE(WANGXUN, NGBEVF_DEV_ID_EM_WX1860AL2S), 0},
35 	{ PCI_VDEVICE(WANGXUN, NGBEVF_DEV_ID_EM_WX1860AL4), 0},
36 	{ PCI_VDEVICE(WANGXUN, NGBEVF_DEV_ID_EM_WX1860AL4S), 0},
37 	{ PCI_VDEVICE(WANGXUN, NGBEVF_DEV_ID_EM_WX1860NCSI), 0},
38 	{ PCI_VDEVICE(WANGXUN, NGBEVF_DEV_ID_EM_WX1860A1), 0},
39 	{ PCI_VDEVICE(WANGXUN, NGBEVF_DEV_ID_EM_WX1860AL1), 0},
40 	/* required last entry */
41 	{ .device = 0 }
42 };
43 
44 static const struct net_device_ops ngbevf_netdev_ops = {
45 	.ndo_open               = wxvf_open,
46 	.ndo_stop               = wxvf_close,
47 	.ndo_start_xmit         = wx_xmit_frame,
48 	.ndo_validate_addr      = eth_validate_addr,
49 	.ndo_set_mac_address    = wx_set_mac_vf,
50 };
51 
52 static void ngbevf_set_num_queues(struct wx *wx)
53 {
54 	/* Start with base case */
55 	wx->num_rx_queues = 1;
56 	wx->num_tx_queues = 1;
57 }
58 
59 static int ngbevf_sw_init(struct wx *wx)
60 {
61 	struct net_device *netdev = wx->netdev;
62 	struct pci_dev *pdev = wx->pdev;
63 	int err;
64 
65 	/* Initialize pcie info and common capability flags */
66 	err = wx_sw_init(wx);
67 	if (err < 0)
68 		goto err_wx_sw_init;
69 
70 	/* Initialize the mailbox */
71 	err = wx_init_mbx_params_vf(wx);
72 	if (err)
73 		goto err_init_mbx_params;
74 
75 	/* Initialize the device type */
76 	wx->mac.type = wx_mac_em;
77 	wx->mac.max_msix_vectors = NGBEVF_MAX_MSIX_VECTORS;
78 	/* lock to protect mailbox accesses */
79 	spin_lock_init(&wx->mbx.mbx_lock);
80 
81 	err = wx_reset_hw_vf(wx);
82 	if (err) {
83 		wx_err(wx, "PF still in reset state. Is the PF interface up?\n");
84 		goto err_reset_hw;
85 	}
86 	wx_init_hw_vf(wx);
87 	wx_negotiate_api_vf(wx);
88 	if (is_zero_ether_addr(wx->mac.addr))
89 		dev_info(&pdev->dev,
90 			 "MAC address not assigned by administrator.\n");
91 	eth_hw_addr_set(netdev, wx->mac.addr);
92 
93 	if (!is_valid_ether_addr(netdev->dev_addr)) {
94 		dev_info(&pdev->dev, "Assigning random MAC address\n");
95 		eth_hw_addr_random(netdev);
96 		ether_addr_copy(wx->mac.addr, netdev->dev_addr);
97 		ether_addr_copy(wx->mac.perm_addr, netdev->dev_addr);
98 	}
99 
100 	wx->mac.max_tx_queues = NGBEVF_MAX_TX_QUEUES;
101 	wx->mac.max_rx_queues = NGBEVF_MAX_RX_QUEUES;
102 	/* Enable dynamic interrupt throttling rates */
103 	wx->adaptive_itr = true;
104 	wx->rx_itr_setting = 1;
105 	wx->tx_itr_setting = 1;
106 	/* set default ring sizes */
107 	wx->tx_ring_count = NGBEVF_DEFAULT_TXD;
108 	wx->rx_ring_count = NGBEVF_DEFAULT_RXD;
109 	/* set default work limits */
110 	wx->tx_work_limit = NGBEVF_DEFAULT_TX_WORK;
111 	wx->rx_work_limit = NGBEVF_DEFAULT_RX_WORK;
112 	wx->set_num_queues = ngbevf_set_num_queues;
113 
114 	return 0;
115 err_reset_hw:
116 	kfree(wx->vfinfo);
117 err_init_mbx_params:
118 	kfree(wx->rss_key);
119 	kfree(wx->mac_table);
120 err_wx_sw_init:
121 	return err;
122 }
123 
124 /**
125  * ngbevf_probe - Device Initialization Routine
126  * @pdev: PCI device information struct
127  * @ent: entry in ngbevf_pci_tbl
128  *
129  * Return: return 0 on success, negative on failure
130  *
131  * ngbevf_probe initializes an adapter identified by a pci_dev structure.
132  * The OS initialization, configuring of the adapter private structure,
133  * and a hardware reset occur.
134  **/
135 static int ngbevf_probe(struct pci_dev *pdev,
136 			const struct pci_device_id __always_unused *ent)
137 {
138 	struct net_device *netdev;
139 	struct wx *wx = NULL;
140 	int err;
141 
142 	err = pci_enable_device_mem(pdev);
143 	if (err)
144 		return err;
145 
146 	err = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64));
147 	if (err) {
148 		dev_err(&pdev->dev,
149 			"No usable DMA configuration, aborting\n");
150 		goto err_pci_disable_dev;
151 	}
152 
153 	err = pci_request_selected_regions(pdev,
154 					   pci_select_bars(pdev, IORESOURCE_MEM),
155 					   dev_driver_string(&pdev->dev));
156 	if (err) {
157 		dev_err(&pdev->dev,
158 			"pci_request_selected_regions failed 0x%x\n", err);
159 		goto err_pci_disable_dev;
160 	}
161 
162 	pci_set_master(pdev);
163 
164 	netdev = devm_alloc_etherdev_mqs(&pdev->dev,
165 					 sizeof(struct wx),
166 					 NGBEVF_MAX_TX_QUEUES,
167 					 NGBEVF_MAX_RX_QUEUES);
168 	if (!netdev) {
169 		err = -ENOMEM;
170 		goto err_pci_release_regions;
171 	}
172 
173 	SET_NETDEV_DEV(netdev, &pdev->dev);
174 
175 	wx = netdev_priv(netdev);
176 	wx->netdev = netdev;
177 	wx->pdev = pdev;
178 
179 	wx->msg_enable = netif_msg_init(-1, NETIF_MSG_DRV |
180 					NETIF_MSG_PROBE | NETIF_MSG_LINK);
181 	wx->hw_addr = devm_ioremap(&pdev->dev,
182 				   pci_resource_start(pdev, 0),
183 				   pci_resource_len(pdev, 0));
184 	if (!wx->hw_addr) {
185 		err = -EIO;
186 		goto err_pci_release_regions;
187 	}
188 
189 	netdev->netdev_ops = &ngbevf_netdev_ops;
190 
191 	/* setup the private structure */
192 	err = ngbevf_sw_init(wx);
193 	if (err)
194 		goto err_pci_release_regions;
195 
196 	netdev->features |= NETIF_F_HIGHDMA;
197 
198 	eth_hw_addr_set(netdev, wx->mac.perm_addr);
199 	ether_addr_copy(netdev->perm_addr, wx->mac.addr);
200 
201 	wxvf_init_service(wx);
202 	err = wx_init_interrupt_scheme(wx);
203 	if (err)
204 		goto err_free_sw_init;
205 
206 	err = register_netdev(netdev);
207 	if (err)
208 		goto err_register;
209 
210 	pci_set_drvdata(pdev, wx);
211 	netif_tx_stop_all_queues(netdev);
212 
213 	return 0;
214 
215 err_register:
216 	wx_clear_interrupt_scheme(wx);
217 err_free_sw_init:
218 	timer_delete_sync(&wx->service_timer);
219 	cancel_work_sync(&wx->service_task);
220 	kfree(wx->vfinfo);
221 	kfree(wx->rss_key);
222 	kfree(wx->mac_table);
223 err_pci_release_regions:
224 	pci_release_selected_regions(pdev,
225 				     pci_select_bars(pdev, IORESOURCE_MEM));
226 err_pci_disable_dev:
227 	pci_disable_device(pdev);
228 	return err;
229 }
230 
231 /**
232  * ngbevf_remove - Device Removal Routine
233  * @pdev: PCI device information struct
234  *
235  * ngbevf_remove is called by the PCI subsystem to alert the driver
236  * that it should release a PCI device.  The could be caused by a
237  * Hot-Plug event, or because the driver is going to be removed from
238  * memory.
239  **/
240 static void ngbevf_remove(struct pci_dev *pdev)
241 {
242 	wxvf_remove(pdev);
243 }
244 
245 static DEFINE_SIMPLE_DEV_PM_OPS(ngbevf_pm_ops, wxvf_suspend, wxvf_resume);
246 
247 static struct pci_driver ngbevf_driver = {
248 	.name     = KBUILD_MODNAME,
249 	.id_table = ngbevf_pci_tbl,
250 	.probe    = ngbevf_probe,
251 	.remove   = ngbevf_remove,
252 	.shutdown = wxvf_shutdown,
253 	/* Power Management Hooks */
254 	.driver.pm	= pm_sleep_ptr(&ngbevf_pm_ops)
255 };
256 
257 module_pci_driver(ngbevf_driver);
258 
259 MODULE_DEVICE_TABLE(pci, ngbevf_pci_tbl);
260 MODULE_AUTHOR("Beijing WangXun Technology Co., Ltd, <software@trustnetic.com>");
261 MODULE_DESCRIPTION("WangXun(R) Gigabit PCI Express Network Driver");
262 MODULE_LICENSE("GPL");
263