1 // SPDX-License-Identifier: GPL-2.0
2 /* ldmvsw.c: Sun4v LDOM Virtual Switch Driver.
4 * Copyright (C) 2016-2017 Oracle. All rights reserved.
7 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
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>
22 #if defined(CONFIG_IPV6)
23 #include <linux/icmpv6.h>
28 #include <net/route.h>
33 /* This driver makes use of the common code in sunvnet_common.c */
34 #include "sunvnet_common.h"
36 /* Length of time before we decide the hardware is hung,
37 * and dev->tx_timeout() should be called to fix the problem.
39 #define VSW_TX_TIMEOUT (10 * HZ)
41 /* Static HW Addr used for the network interfaces representing vsw ports */
42 static u8 vsw_port_hwaddr[ETH_ALEN] = {0xFE, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF};
44 #define DRV_MODULE_NAME "ldmvsw"
45 #define DRV_MODULE_VERSION "1.2"
46 #define DRV_MODULE_RELDATE "March 4, 2017"
48 static char version[] =
49 DRV_MODULE_NAME " " DRV_MODULE_VERSION " (" DRV_MODULE_RELDATE ")";
50 MODULE_AUTHOR("Oracle");
51 MODULE_DESCRIPTION("Sun4v LDOM Virtual Switch Driver");
52 MODULE_LICENSE("GPL");
53 MODULE_VERSION(DRV_MODULE_VERSION);
55 /* Ordered from largest major to lowest */
56 static 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 },
63 static void vsw_get_drvinfo(struct net_device *dev,
64 struct ethtool_drvinfo *info)
66 strlcpy(info->driver, DRV_MODULE_NAME, sizeof(info->driver));
67 strlcpy(info->version, DRV_MODULE_VERSION, sizeof(info->version));
70 static u32 vsw_get_msglevel(struct net_device *dev)
72 struct vnet_port *port = netdev_priv(dev);
74 return port->vp->msg_enable;
77 static void vsw_set_msglevel(struct net_device *dev, u32 value)
79 struct vnet_port *port = netdev_priv(dev);
81 port->vp->msg_enable = value;
84 static 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,
91 static LIST_HEAD(vnet_list);
92 static DEFINE_MUTEX(vnet_list_mutex);
94 /* func arg to vnet_start_xmit_common() to get the proper tx port */
95 static struct vnet_port *vsw_tx_port_find(struct sk_buff *skb,
96 struct net_device *dev)
98 struct vnet_port *port = netdev_priv(dev);
103 static u16 vsw_select_queue(struct net_device *dev, struct sk_buff *skb,
104 struct net_device *sb_dev)
106 struct vnet_port *port = netdev_priv(dev);
111 return port->q_index;
114 /* Wrappers to common functions */
115 static netdev_tx_t vsw_start_xmit(struct sk_buff *skb, struct net_device *dev)
117 return sunvnet_start_xmit_common(skb, dev, vsw_tx_port_find);
120 static void vsw_set_rx_mode(struct net_device *dev)
122 struct vnet_port *port = netdev_priv(dev);
124 return sunvnet_set_rx_mode_common(dev, port->vp);
127 int ldmvsw_open(struct net_device *dev)
129 struct vnet_port *port = netdev_priv(dev);
130 struct vio_driver_state *vio = &port->vio;
132 /* reset the channel */
133 vio_link_state_change(vio, LDC_EVENT_RESET);
134 vnet_port_reset(port);
139 EXPORT_SYMBOL_GPL(ldmvsw_open);
141 #ifdef CONFIG_NET_POLL_CONTROLLER
142 static void vsw_poll_controller(struct net_device *dev)
144 struct vnet_port *port = netdev_priv(dev);
146 return sunvnet_poll_controller_common(dev, port->vp);
150 static const struct net_device_ops vsw_ops = {
151 .ndo_open = ldmvsw_open,
152 .ndo_stop = sunvnet_close_common,
153 .ndo_set_rx_mode = vsw_set_rx_mode,
154 .ndo_set_mac_address = sunvnet_set_mac_addr_common,
155 .ndo_validate_addr = eth_validate_addr,
156 .ndo_tx_timeout = sunvnet_tx_timeout_common,
157 .ndo_start_xmit = vsw_start_xmit,
158 .ndo_select_queue = vsw_select_queue,
159 #ifdef CONFIG_NET_POLL_CONTROLLER
160 .ndo_poll_controller = vsw_poll_controller,
164 static const char *local_mac_prop = "local-mac-address";
165 static const char *cfg_handle_prop = "cfg-handle";
167 static struct vnet *vsw_get_vnet(struct mdesc_handle *hp,
173 const u64 *local_mac = NULL;
174 const u64 *cfghandle = NULL;
177 /* Get the parent virtual-network-switch macaddr and cfghandle */
178 mdesc_for_each_arc(a, hp, port_node, MDESC_ARC_TYPE_BACK) {
179 u64 target = mdesc_arc_target(hp, a);
182 name = mdesc_get_property(hp, target, "name", NULL);
183 if (!name || strcmp(name, "virtual-network-switch"))
186 local_mac = mdesc_get_property(hp, target,
187 local_mac_prop, NULL);
188 cfghandle = mdesc_get_property(hp, target,
189 cfg_handle_prop, NULL);
192 if (!local_mac || !cfghandle)
193 return ERR_PTR(-ENODEV);
195 /* find or create associated vnet */
197 mutex_lock(&vnet_list_mutex);
198 list_for_each_entry(iter, &vnet_list, list) {
199 if (iter->local_mac == *local_mac) {
206 vp = kzalloc(sizeof(*vp), GFP_KERNEL);
208 mutex_unlock(&vnet_list_mutex);
209 return ERR_PTR(-ENOMEM);
212 spin_lock_init(&vp->lock);
213 INIT_LIST_HEAD(&vp->port_list);
214 INIT_LIST_HEAD(&vp->list);
215 vp->local_mac = *local_mac;
216 list_add(&vp->list, &vnet_list);
219 mutex_unlock(&vnet_list_mutex);
221 *handle = (u64)*cfghandle;
226 static struct net_device *vsw_alloc_netdev(u8 hwaddr[],
227 struct vio_dev *vdev,
231 struct net_device *dev;
232 struct vnet_port *port;
234 dev = alloc_etherdev_mqs(sizeof(*port), VNET_MAX_TXQS, 1);
236 return ERR_PTR(-ENOMEM);
237 dev->needed_headroom = VNET_PACKET_SKIP + 8;
238 dev->needed_tailroom = 8;
240 eth_hw_addr_set(dev, hwaddr);
241 ether_addr_copy(dev->perm_addr, dev->dev_addr);
243 sprintf(dev->name, "vif%d.%d", (int)handle, (int)port_id);
245 dev->netdev_ops = &vsw_ops;
246 dev->ethtool_ops = &vsw_ethtool_ops;
247 dev->watchdog_timeo = VSW_TX_TIMEOUT;
249 dev->hw_features = NETIF_F_HW_CSUM | NETIF_F_SG;
250 dev->features = dev->hw_features;
252 /* MTU range: 68 - 65535 */
253 dev->min_mtu = ETH_MIN_MTU;
254 dev->max_mtu = VNET_MAX_MTU;
256 SET_NETDEV_DEV(dev, &vdev->dev);
261 static struct ldc_channel_config vsw_ldc_cfg = {
262 .event = sunvnet_event_common,
264 .mode = LDC_MODE_UNRELIABLE,
267 static struct vio_driver_ops vsw_vio_ops = {
268 .send_attr = sunvnet_send_attr_common,
269 .handle_attr = sunvnet_handle_attr_common,
270 .handshake_complete = sunvnet_handshake_complete_common,
273 static const char *remote_macaddr_prop = "remote-mac-address";
274 static const char *id_prop = "id";
276 static int vsw_port_probe(struct vio_dev *vdev, const struct vio_device_id *id)
278 struct mdesc_handle *hp;
279 struct vnet_port *port;
282 struct net_device *dev;
290 rmac = mdesc_get_property(hp, vdev->mp, remote_macaddr_prop, &len);
293 pr_err("Port lacks %s property\n", remote_macaddr_prop);
298 port_id = mdesc_get_property(hp, vdev->mp, id_prop, NULL);
301 pr_err("Port lacks %s property\n", id_prop);
306 /* Get (or create) the vnet associated with this port */
307 vp = vsw_get_vnet(hp, vdev->mp, &handle);
310 pr_err("Failed to get vnet for vsw-port\n");
317 dev = vsw_alloc_netdev(vsw_port_hwaddr, vdev, handle, *port_id);
320 pr_err("Failed to alloc netdev for vsw-port\n");
324 port = netdev_priv(dev);
326 INIT_LIST_HEAD(&port->list);
328 for (i = 0; i < ETH_ALEN; i++)
329 port->raddr[i] = (*rmac >> (5 - i) * 8) & 0xff;
333 port->switch_port = 1;
334 port->tso = false; /* no tso in vsw, misbehaves in bridge */
337 /* Mark the port as belonging to ldmvsw which directs the
338 * the common code to use the net_device in the vnet_port
339 * rather than the net_device in the vnet (which is used
340 * by sunvnet). This bit is used by the VNET_PORT_TO_NET_DEVICE
345 err = vio_driver_init(&port->vio, vdev, VDEV_NETWORK,
346 vsw_versions, ARRAY_SIZE(vsw_versions),
347 &vsw_vio_ops, dev->name);
349 goto err_out_free_dev;
351 err = vio_ldc_alloc(&port->vio, &vsw_ldc_cfg, port);
353 goto err_out_free_dev;
355 dev_set_drvdata(&vdev->dev, port);
357 netif_napi_add(dev, &port->napi, sunvnet_poll_common,
360 spin_lock_irqsave(&vp->lock, flags);
361 list_add_rcu(&port->list, &vp->port_list);
362 spin_unlock_irqrestore(&vp->lock, flags);
364 timer_setup(&port->clean_timer, sunvnet_clean_timer_expire_common, 0);
366 err = register_netdev(dev);
368 pr_err("Cannot register net device, aborting\n");
369 goto err_out_del_timer;
372 spin_lock_irqsave(&vp->lock, flags);
373 sunvnet_port_add_txq_common(port);
374 spin_unlock_irqrestore(&vp->lock, flags);
376 napi_enable(&port->napi);
377 vio_port_up(&port->vio);
379 /* assure no carrier until we receive an LDC_EVENT_UP,
380 * even if the vsw config script tries to force us up
382 netif_carrier_off(dev);
384 netdev_info(dev, "LDOM vsw-port %pM\n", dev->dev_addr);
386 pr_info("%s: PORT ( remote-mac %pM%s )\n", dev->name,
387 port->raddr, " switch-port");
392 del_timer_sync(&port->clean_timer);
393 list_del_rcu(&port->list);
395 netif_napi_del(&port->napi);
396 dev_set_drvdata(&vdev->dev, NULL);
397 vio_ldc_free(&port->vio);
404 static void vsw_port_remove(struct vio_dev *vdev)
406 struct vnet_port *port = dev_get_drvdata(&vdev->dev);
410 del_timer_sync(&port->vio.timer);
411 del_timer_sync(&port->clean_timer);
413 napi_disable(&port->napi);
414 unregister_netdev(port->dev);
416 list_del_rcu(&port->list);
419 spin_lock_irqsave(&port->vp->lock, flags);
420 sunvnet_port_rm_txq_common(port);
421 spin_unlock_irqrestore(&port->vp->lock, flags);
422 netif_napi_del(&port->napi);
423 sunvnet_port_free_tx_bufs_common(port);
424 vio_ldc_free(&port->vio);
426 dev_set_drvdata(&vdev->dev, NULL);
428 free_netdev(port->dev);
432 static void vsw_cleanup(void)
436 /* just need to free up the vnet list */
437 mutex_lock(&vnet_list_mutex);
438 while (!list_empty(&vnet_list)) {
439 vp = list_first_entry(&vnet_list, struct vnet, list);
441 /* vio_unregister_driver() should have cleaned up port_list */
442 if (!list_empty(&vp->port_list))
443 pr_err("Ports not removed by VIO subsystem!\n");
446 mutex_unlock(&vnet_list_mutex);
449 static const struct vio_device_id vsw_port_match[] = {
455 MODULE_DEVICE_TABLE(vio, vsw_port_match);
457 static struct vio_driver vsw_port_driver = {
458 .id_table = vsw_port_match,
459 .probe = vsw_port_probe,
460 .remove = vsw_port_remove,
464 static int __init vsw_init(void)
466 pr_info("%s\n", version);
467 return vio_register_driver(&vsw_port_driver);
470 static void __exit vsw_exit(void)
472 vio_unregister_driver(&vsw_port_driver);
476 module_init(vsw_init);
477 module_exit(vsw_exit);