Loading...
Note: File does not exist in v3.5.6.
1// SPDX-License-Identifier: GPL-2.0
2/* Copyright 2011-2014 Autronica Fire and Security AS
3 *
4 * Author(s):
5 * 2011-2014 Arvid Brodin, arvid.brodin@alten.se
6 *
7 * This file contains device methods for creating, using and destroying
8 * virtual HSR devices.
9 */
10
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"
19#include "hsr_main.h"
20#include "hsr_forward.h"
21
22static bool is_admin_up(struct net_device *dev)
23{
24 return dev && (dev->flags & IFF_UP);
25}
26
27static bool is_slave_up(struct net_device *dev)
28{
29 return dev && is_admin_up(dev) && netif_oper_up(dev);
30}
31
32static void __hsr_set_operstate(struct net_device *dev, int transition)
33{
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);
39 } else {
40 write_unlock_bh(&dev_base_lock);
41 }
42}
43
44static void hsr_set_operstate(struct hsr_port *master, bool has_carrier)
45{
46 if (!is_admin_up(master->dev)) {
47 __hsr_set_operstate(master->dev, IF_OPER_DOWN);
48 return;
49 }
50
51 if (has_carrier)
52 __hsr_set_operstate(master->dev, IF_OPER_UP);
53 else
54 __hsr_set_operstate(master->dev, IF_OPER_LOWERLAYERDOWN);
55}
56
57static bool hsr_check_carrier(struct hsr_port *master)
58{
59 struct hsr_port *port;
60 bool has_carrier;
61
62 has_carrier = false;
63
64 rcu_read_lock();
65 hsr_for_each_port(master->hsr, port)
66 if (port->type != HSR_PT_MASTER && is_slave_up(port->dev)) {
67 has_carrier = true;
68 break;
69 }
70 rcu_read_unlock();
71
72 if (has_carrier)
73 netif_carrier_on(master->dev);
74 else
75 netif_carrier_off(master->dev);
76
77 return has_carrier;
78}
79
80static void hsr_check_announce(struct net_device *hsr_dev,
81 unsigned char old_operstate)
82{
83 struct hsr_priv *hsr;
84
85 hsr = netdev_priv(hsr_dev);
86
87 if (hsr_dev->operstate == IF_OPER_UP && old_operstate != IF_OPER_UP) {
88 /* Went up */
89 hsr->announce_count = 0;
90 mod_timer(&hsr->announce_timer,
91 jiffies + msecs_to_jiffies(HSR_ANNOUNCE_INTERVAL));
92 }
93
94 if (hsr_dev->operstate != IF_OPER_UP && old_operstate == IF_OPER_UP)
95 /* Went down */
96 del_timer(&hsr->announce_timer);
97}
98
99void hsr_check_carrier_and_operstate(struct hsr_priv *hsr)
100{
101 struct hsr_port *master;
102 unsigned char old_operstate;
103 bool has_carrier;
104
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 (?)
108 */
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);
113}
114
115int hsr_get_max_mtu(struct hsr_priv *hsr)
116{
117 unsigned int mtu_max;
118 struct hsr_port *port;
119
120 mtu_max = ETH_DATA_LEN;
121 rcu_read_lock();
122 hsr_for_each_port(hsr, port)
123 if (port->type != HSR_PT_MASTER)
124 mtu_max = min(port->dev->mtu, mtu_max);
125 rcu_read_unlock();
126
127 if (mtu_max < HSR_HLEN)
128 return 0;
129 return mtu_max - HSR_HLEN;
130}
131
132static int hsr_dev_change_mtu(struct net_device *dev, int new_mtu)
133{
134 struct hsr_priv *hsr;
135 struct hsr_port *master;
136
137 hsr = netdev_priv(dev);
138 master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
139
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",
142 HSR_HLEN);
143 return -EINVAL;
144 }
145
146 dev->mtu = new_mtu;
147
148 return 0;
149}
150
151static int hsr_dev_open(struct net_device *dev)
152{
153 struct hsr_priv *hsr;
154 struct hsr_port *port;
155 char designation;
156
157 hsr = netdev_priv(dev);
158 designation = '\0';
159
160 rcu_read_lock();
161 hsr_for_each_port(hsr, port) {
162 if (port->type == HSR_PT_MASTER)
163 continue;
164 switch (port->type) {
165 case HSR_PT_SLAVE_A:
166 designation = 'A';
167 break;
168 case HSR_PT_SLAVE_B:
169 designation = 'B';
170 break;
171 default:
172 designation = '?';
173 }
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);
177 }
178 rcu_read_unlock();
179
180 if (designation == '\0')
181 netdev_warn(dev, "No slave devices configured\n");
182
183 return 0;
184}
185
186static int hsr_dev_close(struct net_device *dev)
187{
188 /* Nothing to do here. */
189 return 0;
190}
191
192static netdev_features_t hsr_features_recompute(struct hsr_priv *hsr,
193 netdev_features_t features)
194{
195 netdev_features_t mask;
196 struct hsr_port *port;
197
198 mask = features;
199
200 /* Mask out all features that, if supported by one device, should be
201 * enabled for all devices (see NETIF_F_ONE_FOR_ALL).
202 *
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.
206 */
207 features &= ~NETIF_F_ONE_FOR_ALL;
208 hsr_for_each_port(hsr, port)
209 features = netdev_increment_features(features,
210 port->dev->features,
211 mask);
212
213 return features;
214}
215
216static netdev_features_t hsr_fix_features(struct net_device *dev,
217 netdev_features_t features)
218{
219 struct hsr_priv *hsr = netdev_priv(dev);
220
221 return hsr_features_recompute(hsr, features);
222}
223
224static int hsr_dev_xmit(struct sk_buff *skb, struct net_device *dev)
225{
226 struct hsr_priv *hsr = netdev_priv(dev);
227 struct hsr_port *master;
228
229 master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
230 skb->dev = master->dev;
231 hsr_forward_skb(skb, master);
232 return NETDEV_TX_OK;
233}
234
235static const struct header_ops hsr_header_ops = {
236 .create = eth_header,
237 .parse = eth_header_parse,
238};
239
240static void send_hsr_supervision_frame(struct hsr_port *master,
241 u8 type, u8 hsr_ver)
242{
243 struct sk_buff *skb;
244 int hlen, tlen;
245 struct hsr_tag *hsr_tag;
246 struct hsr_sup_tag *hsr_stag;
247 struct hsr_sup_payload *hsr_sp;
248 unsigned long irqflags;
249
250 hlen = LL_RESERVED_SPACE(master->dev);
251 tlen = master->dev->needed_tailroom;
252 skb = dev_alloc_skb(sizeof(struct hsr_tag) +
253 sizeof(struct hsr_sup_tag) +
254 sizeof(struct hsr_sup_payload) + hlen + tlen);
255
256 if (!skb)
257 return;
258
259 skb_reserve(skb, hlen);
260
261 skb->dev = master->dev;
262 skb->protocol = htons(hsr_ver ? ETH_P_HSR : ETH_P_PRP);
263 skb->priority = TC_PRIO_CONTROL;
264
265 if (dev_hard_header(skb, skb->dev, (hsr_ver ? ETH_P_HSR : ETH_P_PRP),
266 master->hsr->sup_multicast_addr,
267 skb->dev->dev_addr, skb->len) <= 0)
268 goto out;
269 skb_reset_mac_header(skb);
270
271 if (hsr_ver > 0) {
272 hsr_tag = skb_put(skb, sizeof(struct hsr_tag));
273 hsr_tag->encap_proto = htons(ETH_P_PRP);
274 set_hsr_tag_LSDU_size(hsr_tag, HSR_V1_SUP_LSDUSIZE);
275 }
276
277 hsr_stag = skb_put(skb, sizeof(struct hsr_sup_tag));
278 set_hsr_stag_path(hsr_stag, (hsr_ver ? 0x0 : 0xf));
279 set_hsr_stag_HSR_ver(hsr_stag, hsr_ver);
280
281 /* From HSRv1 on we have separate supervision sequence numbers. */
282 spin_lock_irqsave(&master->hsr->seqnr_lock, irqflags);
283 if (hsr_ver > 0) {
284 hsr_stag->sequence_nr = htons(master->hsr->sup_sequence_nr);
285 hsr_tag->sequence_nr = htons(master->hsr->sequence_nr);
286 master->hsr->sup_sequence_nr++;
287 master->hsr->sequence_nr++;
288 } else {
289 hsr_stag->sequence_nr = htons(master->hsr->sequence_nr);
290 master->hsr->sequence_nr++;
291 }
292 spin_unlock_irqrestore(&master->hsr->seqnr_lock, irqflags);
293
294 hsr_stag->HSR_TLV_type = type;
295 /* TODO: Why 12 in HSRv0? */
296 hsr_stag->HSR_TLV_length =
297 hsr_ver ? sizeof(struct hsr_sup_payload) : 12;
298
299 /* Payload: MacAddressA */
300 hsr_sp = skb_put(skb, sizeof(struct hsr_sup_payload));
301 ether_addr_copy(hsr_sp->macaddress_A, master->dev->dev_addr);
302
303 if (skb_put_padto(skb, ETH_ZLEN + HSR_HLEN))
304 return;
305
306 hsr_forward_skb(skb, master);
307 return;
308
309out:
310 WARN_ONCE(1, "HSR: Could not send supervision frame\n");
311 kfree_skb(skb);
312}
313
314/* Announce (supervision frame) timer function
315 */
316static void hsr_announce(struct timer_list *t)
317{
318 struct hsr_priv *hsr;
319 struct hsr_port *master;
320 unsigned long interval;
321
322 hsr = from_timer(hsr, t, announce_timer);
323
324 rcu_read_lock();
325 master = hsr_port_get_hsr(hsr, HSR_PT_MASTER);
326
327 if (hsr->announce_count < 3 && hsr->prot_version == 0) {
328 send_hsr_supervision_frame(master, HSR_TLV_ANNOUNCE,
329 hsr->prot_version);
330 hsr->announce_count++;
331
332 interval = msecs_to_jiffies(HSR_ANNOUNCE_INTERVAL);
333 } else {
334 send_hsr_supervision_frame(master, HSR_TLV_LIFE_CHECK,
335 hsr->prot_version);
336
337 interval = msecs_to_jiffies(HSR_LIFE_CHECK_INTERVAL);
338 }
339
340 if (is_admin_up(master->dev))
341 mod_timer(&hsr->announce_timer, jiffies + interval);
342
343 rcu_read_unlock();
344}
345
346/* This has to be called after all the readers are gone.
347 * Otherwise we would have to check the return value of
348 * hsr_port_get_hsr().
349 */
350static void hsr_dev_destroy(struct net_device *hsr_dev)
351{
352 struct hsr_priv *hsr;
353 struct hsr_port *port;
354 struct hsr_port *tmp;
355
356 hsr = netdev_priv(hsr_dev);
357
358 hsr_debugfs_term(hsr);
359
360 list_for_each_entry_safe(port, tmp, &hsr->ports, port_list)
361 hsr_del_port(port);
362
363 del_timer_sync(&hsr->prune_timer);
364 del_timer_sync(&hsr->announce_timer);
365
366 hsr_del_self_node(&hsr->self_node_db);
367 hsr_del_nodes(&hsr->node_db);
368}
369
370static const struct net_device_ops hsr_device_ops = {
371 .ndo_change_mtu = hsr_dev_change_mtu,
372 .ndo_open = hsr_dev_open,
373 .ndo_stop = hsr_dev_close,
374 .ndo_start_xmit = hsr_dev_xmit,
375 .ndo_fix_features = hsr_fix_features,
376 .ndo_uninit = hsr_dev_destroy,
377};
378
379static struct device_type hsr_type = {
380 .name = "hsr",
381};
382
383void hsr_dev_setup(struct net_device *dev)
384{
385 eth_hw_addr_random(dev);
386
387 ether_setup(dev);
388 dev->min_mtu = 0;
389 dev->header_ops = &hsr_header_ops;
390 dev->netdev_ops = &hsr_device_ops;
391 SET_NETDEV_DEVTYPE(dev, &hsr_type);
392 dev->priv_flags |= IFF_NO_QUEUE;
393
394 dev->needs_free_netdev = true;
395
396 dev->hw_features = NETIF_F_SG | NETIF_F_FRAGLIST | NETIF_F_HIGHDMA |
397 NETIF_F_GSO_MASK | NETIF_F_HW_CSUM |
398 NETIF_F_HW_VLAN_CTAG_TX;
399
400 dev->features = dev->hw_features;
401
402 /* Prevent recursive tx locking */
403 dev->features |= NETIF_F_LLTX;
404 /* VLAN on top of HSR needs testing and probably some work on
405 * hsr_header_create() etc.
406 */
407 dev->features |= NETIF_F_VLAN_CHALLENGED;
408 /* Not sure about this. Taken from bridge code. netdev_features.h says
409 * it means "Does not change network namespaces".
410 */
411 dev->features |= NETIF_F_NETNS_LOCAL;
412}
413
414/* Return true if dev is a HSR master; return false otherwise.
415 */
416inline bool is_hsr_master(struct net_device *dev)
417{
418 return (dev->netdev_ops->ndo_start_xmit == hsr_dev_xmit);
419}
420
421/* Default multicast address for HSR Supervision frames */
422static const unsigned char def_multicast_addr[ETH_ALEN] __aligned(2) = {
423 0x01, 0x15, 0x4e, 0x00, 0x01, 0x00
424};
425
426int hsr_dev_finalize(struct net_device *hsr_dev, struct net_device *slave[2],
427 unsigned char multicast_spec, u8 protocol_version)
428{
429 struct hsr_priv *hsr;
430 struct hsr_port *port;
431 struct hsr_port *tmp;
432 int res;
433
434 hsr = netdev_priv(hsr_dev);
435 INIT_LIST_HEAD(&hsr->ports);
436 INIT_LIST_HEAD(&hsr->node_db);
437 INIT_LIST_HEAD(&hsr->self_node_db);
438
439 ether_addr_copy(hsr_dev->dev_addr, slave[0]->dev_addr);
440
441 /* Make sure we recognize frames from ourselves in hsr_rcv() */
442 res = hsr_create_self_node(&hsr->self_node_db, hsr_dev->dev_addr,
443 slave[1]->dev_addr);
444 if (res < 0)
445 return res;
446
447 spin_lock_init(&hsr->seqnr_lock);
448 /* Overflow soon to find bugs easier: */
449 hsr->sequence_nr = HSR_SEQNR_START;
450 hsr->sup_sequence_nr = HSR_SUP_SEQNR_START;
451
452 timer_setup(&hsr->announce_timer, hsr_announce, 0);
453 timer_setup(&hsr->prune_timer, hsr_prune_nodes, 0);
454
455 ether_addr_copy(hsr->sup_multicast_addr, def_multicast_addr);
456 hsr->sup_multicast_addr[ETH_ALEN - 1] = multicast_spec;
457
458 hsr->prot_version = protocol_version;
459
460 /* FIXME: should I modify the value of these?
461 *
462 * - hsr_dev->flags - i.e.
463 * IFF_MASTER/SLAVE?
464 * - hsr_dev->priv_flags - i.e.
465 * IFF_EBRIDGE?
466 * IFF_TX_SKB_SHARING?
467 * IFF_HSR_MASTER/SLAVE?
468 */
469
470 /* Make sure the 1st call to netif_carrier_on() gets through */
471 netif_carrier_off(hsr_dev);
472
473 res = hsr_add_port(hsr, hsr_dev, HSR_PT_MASTER);
474 if (res)
475 goto err_add_port;
476
477 res = register_netdevice(hsr_dev);
478 if (res)
479 goto fail;
480
481 res = hsr_add_port(hsr, slave[0], HSR_PT_SLAVE_A);
482 if (res)
483 goto fail;
484 res = hsr_add_port(hsr, slave[1], HSR_PT_SLAVE_B);
485 if (res)
486 goto fail;
487
488 mod_timer(&hsr->prune_timer, jiffies + msecs_to_jiffies(PRUNE_PERIOD));
489 res = hsr_debugfs_init(hsr, hsr_dev);
490 if (res)
491 goto fail;
492
493 return 0;
494
495fail:
496 list_for_each_entry_safe(port, tmp, &hsr->ports, port_list)
497 hsr_del_port(port);
498err_add_port:
499 hsr_del_self_node(&hsr->self_node_db);
500
501 return res;
502}