1 /* Copyright 2011-2014 Autronica Fire and Security AS
3 * This program is free software; you can redistribute it and/or modify it
4 * under the terms of the GNU General Public License as published by the Free
5 * Software Foundation; either version 2 of the License, or (at your option)
9 * 2011-2014 Arvid Brodin, arvid.brodin@alten.se
11 * This file contains device methods for creating, using and destroying
12 * virtual HSR devices.
15 #include <linux/netdevice.h>
16 #include <linux/skbuff.h>
17 #include <linux/etherdevice.h>
18 #include <linux/rtnetlink.h>
19 #include <linux/pkt_sched.h>
20 #include "hsr_device.h"
21 #include "hsr_slave.h"
22 #include "hsr_framereg.h"
24 #include "hsr_forward.h"
27 static bool is_admin_up(struct net_device *dev)
29 return dev && (dev->flags & IFF_UP);
32 static bool is_slave_up(struct net_device *dev)
34 return dev && is_admin_up(dev) && netif_oper_up(dev);
37 static void __hsr_set_operstate(struct net_device *dev, int transition)
39 write_lock_bh(&dev_base_lock);
40 if (dev->operstate != transition) {
41 dev->operstate = transition;
42 write_unlock_bh(&dev_base_lock);
43 netdev_state_change(dev);
45 write_unlock_bh(&dev_base_lock);
49 static void hsr_set_operstate(struct hsr_port *master, bool has_carrier)
51 if (!is_admin_up(master->dev)) {
52 __hsr_set_operstate(master->dev, IF_OPER_DOWN);
57 __hsr_set_operstate(master->dev, IF_OPER_UP);
59 __hsr_set_operstate(master->dev, IF_OPER_LOWERLAYERDOWN);
62 static bool hsr_check_carrier(struct hsr_port *master)
64 struct hsr_port *port;
70 hsr_for_each_port(master->hsr, port)
71 if ((port->type != HSR_PT_MASTER) && is_slave_up(port->dev)) {
78 netif_carrier_on(master->dev);
80 netif_carrier_off(master->dev);
86 static void hsr_check_announce(struct net_device *hsr_dev,
87 unsigned char old_operstate)
91 hsr = netdev_priv(hsr_dev);
93 if ((hsr_dev->operstate == IF_OPER_UP)
94 && (old_operstate != IF_OPER_UP)) {
96 hsr->announce_count = 0;
97 mod_timer(&hsr->announce_timer,
98 jiffies + msecs_to_jiffies(HSR_ANNOUNCE_INTERVAL));
101 if ((hsr_dev->operstate != IF_OPER_UP) && (old_operstate == IF_OPER_UP))
103 del_timer(&hsr->announce_timer);
106 void hsr_check_carrier_and_operstate(struct hsr_priv *hsr)
108 struct hsr_port *master;
109 unsigned char old_operstate;
112 master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
113 /* netif_stacked_transfer_operstate() cannot be used here since
114 * it doesn't set IF_OPER_LOWERLAYERDOWN (?)
116 old_operstate = master->dev->operstate;
117 has_carrier = hsr_check_carrier(master);
118 hsr_set_operstate(master, has_carrier);
119 hsr_check_announce(master->dev, old_operstate);
122 int hsr_get_max_mtu(struct hsr_priv *hsr)
124 unsigned int mtu_max;
125 struct hsr_port *port;
127 mtu_max = ETH_DATA_LEN;
129 hsr_for_each_port(hsr, port)
130 if (port->type != HSR_PT_MASTER)
131 mtu_max = min(port->dev->mtu, mtu_max);
134 if (mtu_max < HSR_HLEN)
136 return mtu_max - HSR_HLEN;
140 static int hsr_dev_change_mtu(struct net_device *dev, int new_mtu)
142 struct hsr_priv *hsr;
143 struct hsr_port *master;
145 hsr = netdev_priv(dev);
146 master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
148 if (new_mtu > hsr_get_max_mtu(hsr)) {
149 netdev_info(master->dev, "A HSR master's MTU cannot be greater than the smallest MTU of its slaves minus the HSR Tag length (%d octets).\n",
159 static int hsr_dev_open(struct net_device *dev)
161 struct hsr_priv *hsr;
162 struct hsr_port *port;
165 hsr = netdev_priv(dev);
169 hsr_for_each_port(hsr, port) {
170 if (port->type == HSR_PT_MASTER)
172 switch (port->type) {
182 if (!is_slave_up(port->dev))
183 netdev_warn(dev, "Slave %c (%s) is not up; please bring it up to get a fully working HSR network\n",
184 designation, port->dev->name);
188 if (designation == '\0')
189 netdev_warn(dev, "No slave devices configured\n");
195 static int hsr_dev_close(struct net_device *dev)
197 /* Nothing to do here. */
202 static netdev_features_t hsr_features_recompute(struct hsr_priv *hsr,
203 netdev_features_t features)
205 netdev_features_t mask;
206 struct hsr_port *port;
210 /* Mask out all features that, if supported by one device, should be
211 * enabled for all devices (see NETIF_F_ONE_FOR_ALL).
213 * Anything that's off in mask will not be enabled - so only things
214 * that were in features originally, and also is in NETIF_F_ONE_FOR_ALL,
215 * may become enabled.
217 features &= ~NETIF_F_ONE_FOR_ALL;
218 hsr_for_each_port(hsr, port)
219 features = netdev_increment_features(features,
226 static netdev_features_t hsr_fix_features(struct net_device *dev,
227 netdev_features_t features)
229 struct hsr_priv *hsr = netdev_priv(dev);
231 return hsr_features_recompute(hsr, features);
235 static int hsr_dev_xmit(struct sk_buff *skb, struct net_device *dev)
237 struct hsr_priv *hsr = netdev_priv(dev);
238 struct hsr_port *master;
240 master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
241 skb->dev = master->dev;
242 hsr_forward_skb(skb, master);
248 static const struct header_ops hsr_header_ops = {
249 .create = eth_header,
250 .parse = eth_header_parse,
253 static void send_hsr_supervision_frame(struct hsr_port *master,
258 struct hsr_tag *hsr_tag;
259 struct hsr_sup_tag *hsr_stag;
260 struct hsr_sup_payload *hsr_sp;
261 unsigned long irqflags;
263 hlen = LL_RESERVED_SPACE(master->dev);
264 tlen = master->dev->needed_tailroom;
266 sizeof(struct hsr_tag) +
267 sizeof(struct hsr_sup_tag) +
268 sizeof(struct hsr_sup_payload) + hlen + tlen);
273 skb_reserve(skb, hlen);
275 skb->dev = master->dev;
276 skb->protocol = htons(hsrVer ? ETH_P_HSR : ETH_P_PRP);
277 skb->priority = TC_PRIO_CONTROL;
279 if (dev_hard_header(skb, skb->dev, (hsrVer ? ETH_P_HSR : ETH_P_PRP),
280 master->hsr->sup_multicast_addr,
281 skb->dev->dev_addr, skb->len) <= 0)
283 skb_reset_mac_header(skb);
284 skb_reset_network_header(skb);
285 skb_reset_transport_header(skb);
288 hsr_tag = (typeof(hsr_tag)) skb_put(skb, sizeof(struct hsr_tag));
289 hsr_tag->encap_proto = htons(ETH_P_PRP);
290 set_hsr_tag_LSDU_size(hsr_tag, HSR_V1_SUP_LSDUSIZE);
293 hsr_stag = (typeof(hsr_stag)) skb_put(skb, sizeof(struct hsr_sup_tag));
294 set_hsr_stag_path(hsr_stag, (hsrVer ? 0x0 : 0xf));
295 set_hsr_stag_HSR_Ver(hsr_stag, hsrVer);
297 /* From HSRv1 on we have separate supervision sequence numbers. */
298 spin_lock_irqsave(&master->hsr->seqnr_lock, irqflags);
300 hsr_stag->sequence_nr = htons(master->hsr->sup_sequence_nr);
301 hsr_tag->sequence_nr = htons(master->hsr->sequence_nr);
302 master->hsr->sup_sequence_nr++;
303 master->hsr->sequence_nr++;
305 hsr_stag->sequence_nr = htons(master->hsr->sequence_nr);
306 master->hsr->sequence_nr++;
308 spin_unlock_irqrestore(&master->hsr->seqnr_lock, irqflags);
310 hsr_stag->HSR_TLV_Type = type;
311 /* TODO: Why 12 in HSRv0? */
312 hsr_stag->HSR_TLV_Length = hsrVer ? sizeof(struct hsr_sup_payload) : 12;
314 /* Payload: MacAddressA */
315 hsr_sp = (typeof(hsr_sp)) skb_put(skb, sizeof(struct hsr_sup_payload));
316 ether_addr_copy(hsr_sp->MacAddressA, master->dev->dev_addr);
318 if (skb_put_padto(skb, ETH_ZLEN + HSR_HLEN))
321 hsr_forward_skb(skb, master);
325 WARN_ONCE(1, "HSR: Could not send supervision frame\n");
330 /* Announce (supervision frame) timer function
332 static void hsr_announce(unsigned long data)
334 struct hsr_priv *hsr;
335 struct hsr_port *master;
336 unsigned long interval;
338 hsr = (struct hsr_priv *) data;
341 master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
343 if (hsr->announce_count < 3 && hsr->protVersion == 0) {
344 send_hsr_supervision_frame(master, HSR_TLV_ANNOUNCE,
346 hsr->announce_count++;
348 interval = msecs_to_jiffies(HSR_ANNOUNCE_INTERVAL);
350 send_hsr_supervision_frame(master, HSR_TLV_LIFE_CHECK,
353 interval = msecs_to_jiffies(HSR_LIFE_CHECK_INTERVAL);
356 if (is_admin_up(master->dev))
357 mod_timer(&hsr->announce_timer, jiffies + interval);
363 /* According to comments in the declaration of struct net_device, this function
364 * is "Called from unregister, can be used to call free_netdev". Ok then...
366 static void hsr_dev_destroy(struct net_device *hsr_dev)
368 struct hsr_priv *hsr;
369 struct hsr_port *port;
371 hsr = netdev_priv(hsr_dev);
374 hsr_for_each_port(hsr, port)
378 del_timer_sync(&hsr->prune_timer);
379 del_timer_sync(&hsr->announce_timer);
382 free_netdev(hsr_dev);
385 static const struct net_device_ops hsr_device_ops = {
386 .ndo_change_mtu = hsr_dev_change_mtu,
387 .ndo_open = hsr_dev_open,
388 .ndo_stop = hsr_dev_close,
389 .ndo_start_xmit = hsr_dev_xmit,
390 .ndo_fix_features = hsr_fix_features,
393 static struct device_type hsr_type = {
397 void hsr_dev_setup(struct net_device *dev)
399 random_ether_addr(dev->dev_addr);
402 dev->header_ops = &hsr_header_ops;
403 dev->netdev_ops = &hsr_device_ops;
404 SET_NETDEV_DEVTYPE(dev, &hsr_type);
405 dev->priv_flags |= IFF_NO_QUEUE;
407 dev->destructor = hsr_dev_destroy;
409 dev->hw_features = NETIF_F_SG | NETIF_F_FRAGLIST | NETIF_F_HIGHDMA |
410 NETIF_F_GSO_MASK | NETIF_F_HW_CSUM |
411 NETIF_F_HW_VLAN_CTAG_TX;
413 dev->features = dev->hw_features;
415 /* Prevent recursive tx locking */
416 dev->features |= NETIF_F_LLTX;
417 /* VLAN on top of HSR needs testing and probably some work on
418 * hsr_header_create() etc.
420 dev->features |= NETIF_F_VLAN_CHALLENGED;
421 /* Not sure about this. Taken from bridge code. netdev_features.h says
422 * it means "Does not change network namespaces".
424 dev->features |= NETIF_F_NETNS_LOCAL;
428 /* Return true if dev is a HSR master; return false otherwise.
430 inline bool is_hsr_master(struct net_device *dev)
432 return (dev->netdev_ops->ndo_start_xmit == hsr_dev_xmit);
435 /* Default multicast address for HSR Supervision frames */
436 static const unsigned char def_multicast_addr[ETH_ALEN] __aligned(2) = {
437 0x01, 0x15, 0x4e, 0x00, 0x01, 0x00
440 int hsr_dev_finalize(struct net_device *hsr_dev, struct net_device *slave[2],
441 unsigned char multicast_spec, u8 protocol_version)
443 struct hsr_priv *hsr;
444 struct hsr_port *port;
447 hsr = netdev_priv(hsr_dev);
448 INIT_LIST_HEAD(&hsr->ports);
449 INIT_LIST_HEAD(&hsr->node_db);
450 INIT_LIST_HEAD(&hsr->self_node_db);
452 ether_addr_copy(hsr_dev->dev_addr, slave[0]->dev_addr);
454 /* Make sure we recognize frames from ourselves in hsr_rcv() */
455 res = hsr_create_self_node(&hsr->self_node_db, hsr_dev->dev_addr,
460 spin_lock_init(&hsr->seqnr_lock);
461 /* Overflow soon to find bugs easier: */
462 hsr->sequence_nr = HSR_SEQNR_START;
463 hsr->sup_sequence_nr = HSR_SUP_SEQNR_START;
465 setup_timer(&hsr->announce_timer, hsr_announce, (unsigned long)hsr);
467 setup_timer(&hsr->prune_timer, hsr_prune_nodes, (unsigned long)hsr);
469 ether_addr_copy(hsr->sup_multicast_addr, def_multicast_addr);
470 hsr->sup_multicast_addr[ETH_ALEN - 1] = multicast_spec;
472 hsr->protVersion = protocol_version;
474 /* FIXME: should I modify the value of these?
476 * - hsr_dev->flags - i.e.
478 * - hsr_dev->priv_flags - i.e.
480 * IFF_TX_SKB_SHARING?
481 * IFF_HSR_MASTER/SLAVE?
484 /* Make sure the 1st call to netif_carrier_on() gets through */
485 netif_carrier_off(hsr_dev);
487 res = hsr_add_port(hsr, hsr_dev, HSR_PT_MASTER);
491 res = register_netdevice(hsr_dev);
495 res = hsr_add_port(hsr, slave[0], HSR_PT_SLAVE_A);
498 res = hsr_add_port(hsr, slave[1], HSR_PT_SLAVE_B);
502 mod_timer(&hsr->prune_timer, jiffies + msecs_to_jiffies(PRUNE_PERIOD));
507 hsr_for_each_port(hsr, port)
510 hsr_del_node(&hsr->self_node_db);