xref: /openbmc/linux/drivers/net/ethernet/sun/ldmvsw.c (revision 8730046c)
1 /* ldmvsw.c: Sun4v LDOM Virtual Switch Driver.
2  *
3  * Copyright (C) 2016 Oracle. All rights reserved.
4  */
5 
6 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
7 
8 #include <linux/delay.h>
9 #include <linux/etherdevice.h>
10 #include <linux/ethtool.h>
11 #include <linux/highmem.h>
12 #include <linux/if_vlan.h>
13 #include <linux/init.h>
14 #include <linux/kernel.h>
15 #include <linux/module.h>
16 #include <linux/mutex.h>
17 #include <linux/netdevice.h>
18 #include <linux/slab.h>
19 #include <linux/types.h>
20 
21 #if defined(CONFIG_IPV6)
22 #include <linux/icmpv6.h>
23 #endif
24 
25 #include <net/ip.h>
26 #include <net/icmp.h>
27 #include <net/route.h>
28 
29 #include <asm/vio.h>
30 #include <asm/ldc.h>
31 
32 /* This driver makes use of the common code in sunvnet_common.c */
33 #include "sunvnet_common.h"
34 
35 /* Length of time before we decide the hardware is hung,
36  * and dev->tx_timeout() should be called to fix the problem.
37  */
38 #define VSW_TX_TIMEOUT			(10 * HZ)
39 
40 /* Static HW Addr used for the network interfaces representing vsw ports */
41 static u8 vsw_port_hwaddr[ETH_ALEN] = {0xFE, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF};
42 
43 #define DRV_MODULE_NAME		"ldmvsw"
44 #define DRV_MODULE_VERSION	"1.0"
45 #define DRV_MODULE_RELDATE	"Jan 15, 2016"
46 
47 static char version[] =
48 	DRV_MODULE_NAME ".c:v" DRV_MODULE_VERSION " (" DRV_MODULE_RELDATE ")\n";
49 MODULE_AUTHOR("Oracle");
50 MODULE_DESCRIPTION("Sun4v LDOM Virtual Switch Driver");
51 MODULE_LICENSE("GPL");
52 MODULE_VERSION(DRV_MODULE_VERSION);
53 
54 /* Ordered from largest major to lowest */
55 static struct vio_version vsw_versions[] = {
56 	{ .major = 1, .minor = 8 },
57 	{ .major = 1, .minor = 7 },
58 	{ .major = 1, .minor = 6 },
59 	{ .major = 1, .minor = 0 },
60 };
61 
62 static void vsw_get_drvinfo(struct net_device *dev,
63 			    struct ethtool_drvinfo *info)
64 {
65 	strlcpy(info->driver, DRV_MODULE_NAME, sizeof(info->driver));
66 	strlcpy(info->version, DRV_MODULE_VERSION, sizeof(info->version));
67 }
68 
69 static u32 vsw_get_msglevel(struct net_device *dev)
70 {
71 	struct vnet_port *port = netdev_priv(dev);
72 
73 	return port->vp->msg_enable;
74 }
75 
76 static void vsw_set_msglevel(struct net_device *dev, u32 value)
77 {
78 	struct vnet_port *port = netdev_priv(dev);
79 
80 	port->vp->msg_enable = value;
81 }
82 
83 static const struct ethtool_ops vsw_ethtool_ops = {
84 	.get_drvinfo		= vsw_get_drvinfo,
85 	.get_msglevel		= vsw_get_msglevel,
86 	.set_msglevel		= vsw_set_msglevel,
87 	.get_link		= ethtool_op_get_link,
88 };
89 
90 static LIST_HEAD(vnet_list);
91 static DEFINE_MUTEX(vnet_list_mutex);
92 
93 /* func arg to vnet_start_xmit_common() to get the proper tx port */
94 static struct vnet_port *vsw_tx_port_find(struct sk_buff *skb,
95 					  struct net_device *dev)
96 {
97 	struct vnet_port *port = netdev_priv(dev);
98 
99 	return port;
100 }
101 
102 static u16 vsw_select_queue(struct net_device *dev, struct sk_buff *skb,
103 			    void *accel_priv, select_queue_fallback_t fallback)
104 {
105 	struct vnet_port *port = netdev_priv(dev);
106 
107 	if (!port)
108 		return 0;
109 
110 	return port->q_index;
111 }
112 
113 /* Wrappers to common functions */
114 static int vsw_start_xmit(struct sk_buff *skb, struct net_device *dev)
115 {
116 	return sunvnet_start_xmit_common(skb, dev, vsw_tx_port_find);
117 }
118 
119 static void vsw_set_rx_mode(struct net_device *dev)
120 {
121 	struct vnet_port *port = netdev_priv(dev);
122 
123 	return sunvnet_set_rx_mode_common(dev, port->vp);
124 }
125 
126 #ifdef CONFIG_NET_POLL_CONTROLLER
127 static void vsw_poll_controller(struct net_device *dev)
128 {
129 	struct vnet_port *port = netdev_priv(dev);
130 
131 	return sunvnet_poll_controller_common(dev, port->vp);
132 }
133 #endif
134 
135 static const struct net_device_ops vsw_ops = {
136 	.ndo_open		= sunvnet_open_common,
137 	.ndo_stop		= sunvnet_close_common,
138 	.ndo_set_rx_mode	= vsw_set_rx_mode,
139 	.ndo_set_mac_address	= sunvnet_set_mac_addr_common,
140 	.ndo_validate_addr	= eth_validate_addr,
141 	.ndo_tx_timeout		= sunvnet_tx_timeout_common,
142 	.ndo_start_xmit		= vsw_start_xmit,
143 	.ndo_select_queue	= vsw_select_queue,
144 #ifdef CONFIG_NET_POLL_CONTROLLER
145 	.ndo_poll_controller    = vsw_poll_controller,
146 #endif
147 };
148 
149 static const char *local_mac_prop = "local-mac-address";
150 static const char *cfg_handle_prop = "cfg-handle";
151 
152 static struct vnet *vsw_get_vnet(struct mdesc_handle *hp,
153 				 u64 port_node,
154 				 u64 *handle)
155 {
156 	struct vnet *vp;
157 	struct vnet *iter;
158 	const u64 *local_mac = NULL;
159 	const u64 *cfghandle = NULL;
160 	u64 a;
161 
162 	/* Get the parent virtual-network-switch macaddr and cfghandle */
163 	mdesc_for_each_arc(a, hp, port_node, MDESC_ARC_TYPE_BACK) {
164 		u64 target = mdesc_arc_target(hp, a);
165 		const char *name;
166 
167 		name = mdesc_get_property(hp, target, "name", NULL);
168 		if (!name || strcmp(name, "virtual-network-switch"))
169 			continue;
170 
171 		local_mac = mdesc_get_property(hp, target,
172 					       local_mac_prop, NULL);
173 		cfghandle = mdesc_get_property(hp, target,
174 					       cfg_handle_prop, NULL);
175 		break;
176 	}
177 	if (!local_mac || !cfghandle)
178 		return ERR_PTR(-ENODEV);
179 
180 	/* find or create associated vnet */
181 	vp = NULL;
182 	mutex_lock(&vnet_list_mutex);
183 	list_for_each_entry(iter, &vnet_list, list) {
184 		if (iter->local_mac == *local_mac) {
185 			vp = iter;
186 			break;
187 		}
188 	}
189 
190 	if (!vp) {
191 		vp = kzalloc(sizeof(*vp), GFP_KERNEL);
192 		if (unlikely(!vp)) {
193 			mutex_unlock(&vnet_list_mutex);
194 			return ERR_PTR(-ENOMEM);
195 		}
196 
197 		spin_lock_init(&vp->lock);
198 		INIT_LIST_HEAD(&vp->port_list);
199 		INIT_LIST_HEAD(&vp->list);
200 		vp->local_mac = *local_mac;
201 		list_add(&vp->list, &vnet_list);
202 	}
203 
204 	mutex_unlock(&vnet_list_mutex);
205 
206 	*handle = (u64)*cfghandle;
207 
208 	return vp;
209 }
210 
211 static struct net_device *vsw_alloc_netdev(u8 hwaddr[],
212 					   struct vio_dev *vdev,
213 					   u64 handle,
214 					   u64 port_id)
215 {
216 	struct net_device *dev;
217 	struct vnet_port *port;
218 	int i;
219 
220 	dev = alloc_etherdev_mqs(sizeof(*port), VNET_MAX_TXQS, 1);
221 	if (!dev)
222 		return ERR_PTR(-ENOMEM);
223 	dev->needed_headroom = VNET_PACKET_SKIP + 8;
224 	dev->needed_tailroom = 8;
225 
226 	for (i = 0; i < ETH_ALEN; i++) {
227 		dev->dev_addr[i] = hwaddr[i];
228 		dev->perm_addr[i] = dev->dev_addr[i];
229 	}
230 
231 	sprintf(dev->name, "vif%d.%d", (int)handle, (int)port_id);
232 
233 	dev->netdev_ops = &vsw_ops;
234 	dev->ethtool_ops = &vsw_ethtool_ops;
235 	dev->watchdog_timeo = VSW_TX_TIMEOUT;
236 
237 	dev->hw_features = NETIF_F_TSO | NETIF_F_GSO | NETIF_F_GSO_SOFTWARE |
238 			   NETIF_F_HW_CSUM | NETIF_F_SG;
239 	dev->features = dev->hw_features;
240 
241 	/* MTU range: 68 - 65535 */
242 	dev->min_mtu = ETH_MIN_MTU;
243 	dev->max_mtu = VNET_MAX_MTU;
244 
245 	SET_NETDEV_DEV(dev, &vdev->dev);
246 
247 	return dev;
248 }
249 
250 static struct ldc_channel_config vsw_ldc_cfg = {
251 	.event		= sunvnet_event_common,
252 	.mtu		= 64,
253 	.mode		= LDC_MODE_UNRELIABLE,
254 };
255 
256 static struct vio_driver_ops vsw_vio_ops = {
257 	.send_attr		= sunvnet_send_attr_common,
258 	.handle_attr		= sunvnet_handle_attr_common,
259 	.handshake_complete	= sunvnet_handshake_complete_common,
260 };
261 
262 static void print_version(void)
263 {
264 	printk_once(KERN_INFO "%s", version);
265 }
266 
267 static const char *remote_macaddr_prop = "remote-mac-address";
268 static const char *id_prop = "id";
269 
270 static int vsw_port_probe(struct vio_dev *vdev, const struct vio_device_id *id)
271 {
272 	struct mdesc_handle *hp;
273 	struct vnet_port *port;
274 	unsigned long flags;
275 	struct vnet *vp;
276 	struct net_device *dev;
277 	const u64 *rmac;
278 	int len, i, err;
279 	const u64 *port_id;
280 	u64 handle;
281 
282 	print_version();
283 
284 	hp = mdesc_grab();
285 
286 	rmac = mdesc_get_property(hp, vdev->mp, remote_macaddr_prop, &len);
287 	err = -ENODEV;
288 	if (!rmac) {
289 		pr_err("Port lacks %s property\n", remote_macaddr_prop);
290 		mdesc_release(hp);
291 		return err;
292 	}
293 
294 	port_id = mdesc_get_property(hp, vdev->mp, id_prop, NULL);
295 	err = -ENODEV;
296 	if (!port_id) {
297 		pr_err("Port lacks %s property\n", id_prop);
298 		mdesc_release(hp);
299 		return err;
300 	}
301 
302 	/* Get (or create) the vnet associated with this port */
303 	vp = vsw_get_vnet(hp, vdev->mp, &handle);
304 	if (unlikely(IS_ERR(vp))) {
305 		err = PTR_ERR(vp);
306 		pr_err("Failed to get vnet for vsw-port\n");
307 		mdesc_release(hp);
308 		return err;
309 	}
310 
311 	mdesc_release(hp);
312 
313 	dev = vsw_alloc_netdev(vsw_port_hwaddr, vdev, handle, *port_id);
314 	if (IS_ERR(dev)) {
315 		err = PTR_ERR(dev);
316 		pr_err("Failed to alloc netdev for vsw-port\n");
317 		return err;
318 	}
319 
320 	port = netdev_priv(dev);
321 
322 	INIT_LIST_HEAD(&port->list);
323 
324 	for (i = 0; i < ETH_ALEN; i++)
325 		port->raddr[i] = (*rmac >> (5 - i) * 8) & 0xff;
326 
327 	port->vp = vp;
328 	port->dev = dev;
329 	port->switch_port = 1;
330 	port->tso = true;
331 	port->tsolen = 0;
332 
333 	/* Mark the port as belonging to ldmvsw which directs the
334 	 * the common code to use the net_device in the vnet_port
335 	 * rather than the net_device in the vnet (which is used
336 	 * by sunvnet). This bit is used by the VNET_PORT_TO_NET_DEVICE
337 	 * macro.
338 	 */
339 	port->vsw = 1;
340 
341 	err = vio_driver_init(&port->vio, vdev, VDEV_NETWORK,
342 			      vsw_versions, ARRAY_SIZE(vsw_versions),
343 			      &vsw_vio_ops, dev->name);
344 	if (err)
345 		goto err_out_free_dev;
346 
347 	err = vio_ldc_alloc(&port->vio, &vsw_ldc_cfg, port);
348 	if (err)
349 		goto err_out_free_dev;
350 
351 	dev_set_drvdata(&vdev->dev, port);
352 
353 	netif_napi_add(dev, &port->napi, sunvnet_poll_common,
354 		       NAPI_POLL_WEIGHT);
355 
356 	spin_lock_irqsave(&vp->lock, flags);
357 	list_add_rcu(&port->list, &vp->port_list);
358 	spin_unlock_irqrestore(&vp->lock, flags);
359 
360 	setup_timer(&port->clean_timer, sunvnet_clean_timer_expire_common,
361 		    (unsigned long)port);
362 
363 	err = register_netdev(dev);
364 	if (err) {
365 		pr_err("Cannot register net device, aborting\n");
366 		goto err_out_del_timer;
367 	}
368 
369 	spin_lock_irqsave(&vp->lock, flags);
370 	sunvnet_port_add_txq_common(port);
371 	spin_unlock_irqrestore(&vp->lock, flags);
372 
373 	napi_enable(&port->napi);
374 	vio_port_up(&port->vio);
375 
376 	netdev_info(dev, "LDOM vsw-port %pM\n", dev->dev_addr);
377 
378 	pr_info("%s: PORT ( remote-mac %pM%s )\n", dev->name,
379 		port->raddr, " switch-port");
380 
381 	return 0;
382 
383 err_out_del_timer:
384 	del_timer_sync(&port->clean_timer);
385 	list_del_rcu(&port->list);
386 	synchronize_rcu();
387 	netif_napi_del(&port->napi);
388 	dev_set_drvdata(&vdev->dev, NULL);
389 	vio_ldc_free(&port->vio);
390 
391 err_out_free_dev:
392 	free_netdev(dev);
393 	return err;
394 }
395 
396 static int vsw_port_remove(struct vio_dev *vdev)
397 {
398 	struct vnet_port *port = dev_get_drvdata(&vdev->dev);
399 	unsigned long flags;
400 
401 	if (port) {
402 		del_timer_sync(&port->vio.timer);
403 
404 		napi_disable(&port->napi);
405 
406 		list_del_rcu(&port->list);
407 
408 		synchronize_rcu();
409 		del_timer_sync(&port->clean_timer);
410 		spin_lock_irqsave(&port->vp->lock, flags);
411 		sunvnet_port_rm_txq_common(port);
412 		spin_unlock_irqrestore(&port->vp->lock, flags);
413 		netif_napi_del(&port->napi);
414 		sunvnet_port_free_tx_bufs_common(port);
415 		vio_ldc_free(&port->vio);
416 
417 		dev_set_drvdata(&vdev->dev, NULL);
418 
419 		unregister_netdev(port->dev);
420 		free_netdev(port->dev);
421 	}
422 
423 	return 0;
424 }
425 
426 static void vsw_cleanup(void)
427 {
428 	struct vnet *vp;
429 
430 	/* just need to free up the vnet list */
431 	mutex_lock(&vnet_list_mutex);
432 	while (!list_empty(&vnet_list)) {
433 		vp = list_first_entry(&vnet_list, struct vnet, list);
434 		list_del(&vp->list);
435 		/* vio_unregister_driver() should have cleaned up port_list */
436 		if (!list_empty(&vp->port_list))
437 			pr_err("Ports not removed by VIO subsystem!\n");
438 		kfree(vp);
439 	}
440 	mutex_unlock(&vnet_list_mutex);
441 }
442 
443 static const struct vio_device_id vsw_port_match[] = {
444 	{
445 		.type = "vsw-port",
446 	},
447 	{},
448 };
449 MODULE_DEVICE_TABLE(vio, vsw_port_match);
450 
451 static struct vio_driver vsw_port_driver = {
452 	.id_table	= vsw_port_match,
453 	.probe		= vsw_port_probe,
454 	.remove		= vsw_port_remove,
455 	.name		= "vsw_port",
456 };
457 
458 static int __init vsw_init(void)
459 {
460 	return vio_register_driver(&vsw_port_driver);
461 }
462 
463 static void __exit vsw_exit(void)
464 {
465 	vio_unregister_driver(&vsw_port_driver);
466 	vsw_cleanup();
467 }
468 
469 module_init(vsw_init);
470 module_exit(vsw_exit);
471