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

source code of linux/drivers/net/ethernet/sun/ldmvsw.c