1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright 2011-2014 Autronica Fire and Security AS
5 * 2011-2014 Arvid Brodin, arvid.brodin@alten.se
7 * This file contains device methods for creating, using and destroying
11 #include <linux/netdevice.h>
12 #include <linux/skbuff.h>
13 #include <linux/etherdevice.h>
14 #include <linux/rtnetlink.h>
15 #include <linux/pkt_sched.h>
16 #include "hsr_device.h"
17 #include "hsr_slave.h"
18 #include "hsr_framereg.h"
20 #include "hsr_forward.h"
22 static bool is_admin_up(struct net_device *dev)
24 return dev && (dev->flags & IFF_UP);
27 static bool is_slave_up(struct net_device *dev)
29 return dev && is_admin_up(dev) && netif_oper_up(dev);
32 static void __hsr_set_operstate(struct net_device *dev, int transition)
34 write_lock_bh(&dev_base_lock);
35 if (dev->operstate != transition) {
36 dev->operstate = transition;
37 write_unlock_bh(&dev_base_lock);
38 netdev_state_change(dev);
40 write_unlock_bh(&dev_base_lock);
44 static void hsr_set_operstate(struct hsr_port *master, bool has_carrier)
46 if (!is_admin_up(master->dev)) {
47 __hsr_set_operstate(master->dev, IF_OPER_DOWN);
52 __hsr_set_operstate(master->dev, IF_OPER_UP);
54 __hsr_set_operstate(master->dev, IF_OPER_LOWERLAYERDOWN);
57 static bool hsr_check_carrier(struct hsr_port *master)
59 struct hsr_port *port;
65 hsr_for_each_port(master->hsr, port)
66 if (port->type != HSR_PT_MASTER && is_slave_up(port->dev)) {
73 netif_carrier_on(master->dev);
75 netif_carrier_off(master->dev);
80 static void hsr_check_announce(struct net_device *hsr_dev,
81 unsigned char old_operstate)
85 hsr = netdev_priv(hsr_dev);
87 if (hsr_dev->operstate == IF_OPER_UP && old_operstate != IF_OPER_UP) {
89 hsr->announce_count = 0;
90 mod_timer(&hsr->announce_timer,
91 jiffies + msecs_to_jiffies(HSR_ANNOUNCE_INTERVAL));
94 if (hsr_dev->operstate != IF_OPER_UP && old_operstate == IF_OPER_UP)
96 del_timer(&hsr->announce_timer);
99 void hsr_check_carrier_and_operstate(struct hsr_priv *hsr)
101 struct hsr_port *master;
102 unsigned char old_operstate;
105 master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
106 /* netif_stacked_transfer_operstate() cannot be used here since
107 * it doesn't set IF_OPER_LOWERLAYERDOWN (?)
109 old_operstate = master->dev->operstate;
110 has_carrier = hsr_check_carrier(master);
111 hsr_set_operstate(master, has_carrier);
112 hsr_check_announce(master->dev, old_operstate);
115 int hsr_get_max_mtu(struct hsr_priv *hsr)
117 unsigned int mtu_max;
118 struct hsr_port *port;
120 mtu_max = ETH_DATA_LEN;
122 hsr_for_each_port(hsr, port)
123 if (port->type != HSR_PT_MASTER)
124 mtu_max = min(port->dev->mtu, mtu_max);
127 if (mtu_max < HSR_HLEN)
129 return mtu_max - HSR_HLEN;
132 static int hsr_dev_change_mtu(struct net_device *dev, int new_mtu)
134 struct hsr_priv *hsr;
135 struct hsr_port *master;
137 hsr = netdev_priv(dev);
138 master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
140 if (new_mtu > hsr_get_max_mtu(hsr)) {
141 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",
151 static int hsr_dev_open(struct net_device *dev)
153 struct hsr_priv *hsr;
154 struct hsr_port *port;
157 hsr = netdev_priv(dev);
161 hsr_for_each_port(hsr, port) {
162 if (port->type == HSR_PT_MASTER)
164 switch (port->type) {
174 if (!is_slave_up(port->dev))
175 netdev_warn(dev, "Slave %c (%s) is not up; please bring it up to get a fully working HSR network\n",
176 designation, port->dev->name);
180 if (designation == '\0')
181 netdev_warn(dev, "No slave devices configured\n");
186 static int hsr_dev_close(struct net_device *dev)
188 /* Nothing to do here. */
192 static netdev_features_t hsr_features_recompute(struct hsr_priv *hsr,
193 netdev_features_t features)
195 netdev_features_t mask;
196 struct hsr_port *port;
200 /* Mask out all features that, if supported by one device, should be
201 * enabled for all devices (see NETIF_F_ONE_FOR_ALL).
203 * Anything that's off in mask will not be enabled - so only things
204 * that were in features originally, and also is in NETIF_F_ONE_FOR_ALL,
205 * may become enabled.
207 features &= ~NETIF_F_ONE_FOR_ALL;
208 hsr_for_each_port(hsr, port)
209 features = netdev_increment_features(features,
216 static netdev_features_t hsr_fix_features(struct net_device *dev,
217 netdev_features_t features)
219 struct hsr_priv *hsr = netdev_priv(dev);
221 return hsr_features_recompute(hsr, features);
224 static int hsr_dev_xmit(struct sk_buff *skb, struct net_device *dev)
226 struct hsr_priv *hsr = netdev_priv(dev);
227 struct hsr_port *master;
229 master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
231 skb->dev = master->dev;
232 hsr_forward_skb(skb, master);
234 atomic_long_inc(&dev->tx_dropped);
235 dev_kfree_skb_any(skb);
240 static const struct header_ops hsr_header_ops = {
241 .create = eth_header,
242 .parse = eth_header_parse,
245 static void send_hsr_supervision_frame(struct hsr_port *master,
250 struct hsr_tag *hsr_tag;
251 struct hsr_sup_tag *hsr_stag;
252 struct hsr_sup_payload *hsr_sp;
253 unsigned long irqflags;
255 hlen = LL_RESERVED_SPACE(master->dev);
256 tlen = master->dev->needed_tailroom;
257 skb = dev_alloc_skb(sizeof(struct hsr_tag) +
258 sizeof(struct hsr_sup_tag) +
259 sizeof(struct hsr_sup_payload) + hlen + tlen);
264 skb_reserve(skb, hlen);
266 skb->dev = master->dev;
267 skb->protocol = htons(hsr_ver ? ETH_P_HSR : ETH_P_PRP);
268 skb->priority = TC_PRIO_CONTROL;
270 if (dev_hard_header(skb, skb->dev, (hsr_ver ? ETH_P_HSR : ETH_P_PRP),
271 master->hsr->sup_multicast_addr,
272 skb->dev->dev_addr, skb->len) <= 0)
274 skb_reset_mac_header(skb);
277 hsr_tag = skb_put(skb, sizeof(struct hsr_tag));
278 hsr_tag->encap_proto = htons(ETH_P_PRP);
279 set_hsr_tag_LSDU_size(hsr_tag, HSR_V1_SUP_LSDUSIZE);
282 hsr_stag = skb_put(skb, sizeof(struct hsr_sup_tag));
283 set_hsr_stag_path(hsr_stag, (hsr_ver ? 0x0 : 0xf));
284 set_hsr_stag_HSR_ver(hsr_stag, hsr_ver);
286 /* From HSRv1 on we have separate supervision sequence numbers. */
287 spin_lock_irqsave(&master->hsr->seqnr_lock, irqflags);
289 hsr_stag->sequence_nr = htons(master->hsr->sup_sequence_nr);
290 hsr_tag->sequence_nr = htons(master->hsr->sequence_nr);
291 master->hsr->sup_sequence_nr++;
292 master->hsr->sequence_nr++;
294 hsr_stag->sequence_nr = htons(master->hsr->sequence_nr);
295 master->hsr->sequence_nr++;
297 spin_unlock_irqrestore(&master->hsr->seqnr_lock, irqflags);
299 hsr_stag->HSR_TLV_type = type;
300 /* TODO: Why 12 in HSRv0? */
301 hsr_stag->HSR_TLV_length =
302 hsr_ver ? sizeof(struct hsr_sup_payload) : 12;
304 /* Payload: MacAddressA */
305 hsr_sp = skb_put(skb, sizeof(struct hsr_sup_payload));
306 ether_addr_copy(hsr_sp->macaddress_A, master->dev->dev_addr);
308 if (skb_put_padto(skb, ETH_ZLEN + HSR_HLEN))
311 hsr_forward_skb(skb, master);
315 WARN_ONCE(1, "HSR: Could not send supervision frame\n");
319 /* Announce (supervision frame) timer function
321 static void hsr_announce(struct timer_list *t)
323 struct hsr_priv *hsr;
324 struct hsr_port *master;
325 unsigned long interval;
327 hsr = from_timer(hsr, t, announce_timer);
330 master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
332 if (hsr->announce_count < 3 && hsr->prot_version == 0) {
333 send_hsr_supervision_frame(master, HSR_TLV_ANNOUNCE,
335 hsr->announce_count++;
337 interval = msecs_to_jiffies(HSR_ANNOUNCE_INTERVAL);
339 send_hsr_supervision_frame(master, HSR_TLV_LIFE_CHECK,
342 interval = msecs_to_jiffies(HSR_LIFE_CHECK_INTERVAL);
345 if (is_admin_up(master->dev))
346 mod_timer(&hsr->announce_timer, jiffies + interval);
351 /* This has to be called after all the readers are gone.
352 * Otherwise we would have to check the return value of
353 * hsr_port_get_hsr().
355 static void hsr_dev_destroy(struct net_device *hsr_dev)
357 struct hsr_priv *hsr;
358 struct hsr_port *port;
359 struct hsr_port *tmp;
361 hsr = netdev_priv(hsr_dev);
363 hsr_debugfs_term(hsr);
365 list_for_each_entry_safe(port, tmp, &hsr->ports, port_list)
368 del_timer_sync(&hsr->prune_timer);
369 del_timer_sync(&hsr->announce_timer);
371 hsr_del_self_node(&hsr->self_node_db);
372 hsr_del_nodes(&hsr->node_db);
375 static const struct net_device_ops hsr_device_ops = {
376 .ndo_change_mtu = hsr_dev_change_mtu,
377 .ndo_open = hsr_dev_open,
378 .ndo_stop = hsr_dev_close,
379 .ndo_start_xmit = hsr_dev_xmit,
380 .ndo_fix_features = hsr_fix_features,
381 .ndo_uninit = hsr_dev_destroy,
384 static struct device_type hsr_type = {
388 void hsr_dev_setup(struct net_device *dev)
390 eth_hw_addr_random(dev);
394 dev->header_ops = &hsr_header_ops;
395 dev->netdev_ops = &hsr_device_ops;
396 SET_NETDEV_DEVTYPE(dev, &hsr_type);
397 dev->priv_flags |= IFF_NO_QUEUE;
399 dev->needs_free_netdev = true;
401 dev->hw_features = NETIF_F_SG | NETIF_F_FRAGLIST | NETIF_F_HIGHDMA |
402 NETIF_F_GSO_MASK | NETIF_F_HW_CSUM |
403 NETIF_F_HW_VLAN_CTAG_TX;
405 dev->features = dev->hw_features;
407 /* Prevent recursive tx locking */
408 dev->features |= NETIF_F_LLTX;
409 /* VLAN on top of HSR needs testing and probably some work on
410 * hsr_header_create() etc.
412 dev->features |= NETIF_F_VLAN_CHALLENGED;
413 /* Not sure about this. Taken from bridge code. netdev_features.h says
414 * it means "Does not change network namespaces".
416 dev->features |= NETIF_F_NETNS_LOCAL;
419 /* Return true if dev is a HSR master; return false otherwise.
421 inline bool is_hsr_master(struct net_device *dev)
423 return (dev->netdev_ops->ndo_start_xmit == hsr_dev_xmit);
426 /* Default multicast address for HSR Supervision frames */
427 static const unsigned char def_multicast_addr[ETH_ALEN] __aligned(2) = {
428 0x01, 0x15, 0x4e, 0x00, 0x01, 0x00
431 int hsr_dev_finalize(struct net_device *hsr_dev, struct net_device *slave[2],
432 unsigned char multicast_spec, u8 protocol_version)
434 struct hsr_priv *hsr;
435 struct hsr_port *port;
436 struct hsr_port *tmp;
439 hsr = netdev_priv(hsr_dev);
440 INIT_LIST_HEAD(&hsr->ports);
441 INIT_LIST_HEAD(&hsr->node_db);
442 INIT_LIST_HEAD(&hsr->self_node_db);
444 ether_addr_copy(hsr_dev->dev_addr, slave[0]->dev_addr);
446 /* Make sure we recognize frames from ourselves in hsr_rcv() */
447 res = hsr_create_self_node(&hsr->self_node_db, hsr_dev->dev_addr,
452 spin_lock_init(&hsr->seqnr_lock);
453 /* Overflow soon to find bugs easier: */
454 hsr->sequence_nr = HSR_SEQNR_START;
455 hsr->sup_sequence_nr = HSR_SUP_SEQNR_START;
457 timer_setup(&hsr->announce_timer, hsr_announce, 0);
458 timer_setup(&hsr->prune_timer, hsr_prune_nodes, 0);
460 ether_addr_copy(hsr->sup_multicast_addr, def_multicast_addr);
461 hsr->sup_multicast_addr[ETH_ALEN - 1] = multicast_spec;
463 hsr->prot_version = protocol_version;
465 /* FIXME: should I modify the value of these?
467 * - hsr_dev->flags - i.e.
469 * - hsr_dev->priv_flags - i.e.
471 * IFF_TX_SKB_SHARING?
472 * IFF_HSR_MASTER/SLAVE?
475 /* Make sure the 1st call to netif_carrier_on() gets through */
476 netif_carrier_off(hsr_dev);
478 res = hsr_add_port(hsr, hsr_dev, HSR_PT_MASTER);
482 res = register_netdevice(hsr_dev);
486 res = hsr_add_port(hsr, slave[0], HSR_PT_SLAVE_A);
489 res = hsr_add_port(hsr, slave[1], HSR_PT_SLAVE_B);
493 mod_timer(&hsr->prune_timer, jiffies + msecs_to_jiffies(PRUNE_PERIOD));
494 res = hsr_debugfs_init(hsr, hsr_dev);
501 list_for_each_entry_safe(port, tmp, &hsr->ports, port_list)
504 hsr_del_self_node(&hsr->self_node_db);