Contiki-NG
tsch.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015, SICS Swedish ICT.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the Institute nor the names of its contributors
14  * may be used to endorse or promote products derived from this software
15  * without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * This file is part of the Contiki operating system.
30  *
31  */
32 
33 /**
34  * \file
35  * IEEE 802.15.4 TSCH MAC implementation.
36  * Does not use any RDC layer. Should be used with nordc.
37  * \author
38  * Simon Duquennoy <simonduq@sics.se>
39  * Beshr Al Nahas <beshr@sics.se>
40  *
41  */
42 
43 /**
44  * \addtogroup tsch
45  * @{
46 */
47 
48 #include "contiki.h"
49 #include "dev/radio.h"
50 #include "net/netstack.h"
51 #include "net/packetbuf.h"
52 #include "net/queuebuf.h"
53 #include "net/nbr-table.h"
54 #include "net/link-stats.h"
56 #include "net/mac/tsch/tsch.h"
57 #include "net/mac/mac-sequence.h"
58 #include "lib/random.h"
59 #include "net/routing/routing.h"
60 
61 #if TSCH_WITH_SIXTOP
63 #endif
64 
65 #if FRAME802154_VERSION < FRAME802154_IEEE802154_2015
66 #error TSCH: FRAME802154_VERSION must be at least FRAME802154_IEEE802154_2015
67 #endif
68 
69 /* Log configuration */
70 #include "sys/log.h"
71 #define LOG_MODULE "TSCH"
72 #define LOG_LEVEL LOG_LEVEL_MAC
73 
74 /* The address of the last node we received an EB from (other than our time source).
75  * Used for recovery */
76 static linkaddr_t last_eb_nbr_addr;
77 /* The join priority advertised by last_eb_nbr_addr */
78 static uint8_t last_eb_nbr_jp;
79 
80 /* Let TSCH select a time source with no help of an upper layer.
81  * We do so using statistics from incoming EBs */
82 #if TSCH_AUTOSELECT_TIME_SOURCE
83 int best_neighbor_eb_count;
84 struct eb_stat {
85  int rx_count;
86  int jp;
87 };
88 NBR_TABLE(struct eb_stat, eb_stats);
89 #endif /* TSCH_AUTOSELECT_TIME_SOURCE */
90 
91 /* TSCH channel hopping sequence */
92 uint8_t tsch_hopping_sequence[TSCH_HOPPING_SEQUENCE_MAX_LEN];
93 struct tsch_asn_divisor_t tsch_hopping_sequence_length;
94 
95 /* Default TSCH timeslot timing (in micro-second) */
96 static const uint16_t *tsch_default_timing_us;
97 /* TSCH timeslot timing (in micro-second) */
98 uint16_t tsch_timing_us[tsch_ts_elements_count];
99 /* TSCH timeslot timing (in rtimer ticks) */
100 rtimer_clock_t tsch_timing[tsch_ts_elements_count];
101 
102 #if LINKADDR_SIZE == 8
103 /* 802.15.4 broadcast MAC address */
104 const linkaddr_t tsch_broadcast_address = { { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff } };
105 /* Address used for the EB virtual neighbor queue */
106 const linkaddr_t tsch_eb_address = { { 0, 0, 0, 0, 0, 0, 0, 0 } };
107 #else /* LINKADDR_SIZE == 8 */
108 const linkaddr_t tsch_broadcast_address = { { 0xff, 0xff } };
109 const linkaddr_t tsch_eb_address = { { 0, 0 } };
110 #endif /* LINKADDR_SIZE == 8 */
111 
112 /* Is TSCH started? */
113 int tsch_is_started = 0;
114 /* Has TSCH initialization failed? */
115 int tsch_is_initialized = 0;
116 /* Are we coordinator of the TSCH network? */
117 int tsch_is_coordinator = 0;
118 /* Are we associated to a TSCH network? */
119 int tsch_is_associated = 0;
120 /* Total number of associations since boot */
121 int tsch_association_count = 0;
122 /* Is the PAN running link-layer security? */
123 int tsch_is_pan_secured = LLSEC802154_ENABLED;
124 /* The current Absolute Slot Number (ASN) */
125 struct tsch_asn_t tsch_current_asn;
126 /* Device rank or join priority:
127  * For PAN coordinator: 0 -- lower is better */
128 uint8_t tsch_join_priority;
129 /* The current TSCH sequence number, used for unicast data frames only */
130 static uint8_t tsch_packet_seqno;
131 /* Current period for EB output */
132 static clock_time_t tsch_current_eb_period;
133 /* Current period for keepalive output */
134 static clock_time_t tsch_current_ka_timeout;
135 
136 /* For scheduling keepalive messages */
137 enum tsch_keepalive_status {
138  KEEPALIVE_SCHEDULING_UNCHANGED,
139  KEEPALIVE_SCHEDULE_OR_STOP,
140  KEEPALIVE_SEND_IMMEDIATELY,
141 };
142 /* Should we send or schedule a keepalive? */
143 static volatile enum tsch_keepalive_status keepalive_status;
144 
145 /* timer for sending keepalive messages */
146 static struct ctimer keepalive_timer;
147 
148 /* Statistics on the current session */
149 unsigned long tx_count;
150 unsigned long rx_count;
151 unsigned long sync_count;
152 int32_t min_drift_seen;
153 int32_t max_drift_seen;
154 
155 /* TSCH processes and protothreads */
156 PT_THREAD(tsch_scan(struct pt *pt));
157 PROCESS(tsch_process, "main process");
158 PROCESS(tsch_send_eb_process, "send EB process");
159 PROCESS(tsch_pending_events_process, "pending events process");
160 
161 /* Other function prototypes */
162 static void packet_input(void);
163 
164 /* Getters and setters */
165 
166 /*---------------------------------------------------------------------------*/
167 void
169 {
170  if(tsch_is_coordinator != enable) {
171  tsch_is_associated = 0;
172  }
173  tsch_is_coordinator = enable;
174  tsch_set_eb_period(TSCH_EB_PERIOD);
175  tsch_roots_set_self_to_root(tsch_is_coordinator ? 1 : 0);
176 }
177 /*---------------------------------------------------------------------------*/
178 void
180 {
181  tsch_is_pan_secured = LLSEC802154_ENABLED && enable;
182 }
183 /*---------------------------------------------------------------------------*/
184 void
186 {
187  tsch_join_priority = jp;
188 }
189 /*---------------------------------------------------------------------------*/
190 void
191 tsch_set_ka_timeout(uint32_t timeout)
192 {
193  tsch_current_ka_timeout = timeout;
195 }
196 /*---------------------------------------------------------------------------*/
197 void
198 tsch_set_eb_period(uint32_t period)
199 {
200  tsch_current_eb_period = MIN(period, TSCH_MAX_EB_PERIOD);
201 }
202 /*---------------------------------------------------------------------------*/
203 static void
204 tsch_reset(void)
205 {
206  int i;
207  frame802154_set_pan_id(0xffff);
208  /* First make sure pending packet callbacks are sent etc */
209  process_post_synch(&tsch_pending_events_process, PROCESS_EVENT_POLL, NULL);
210  /* Reset neighbor queues */
212  /* Remove unused neighbors */
215  /* Initialize global variables */
216  tsch_join_priority = 0xff;
217  TSCH_ASN_INIT(tsch_current_asn, 0, 0);
218  current_link = NULL;
219  /* Reset timeslot timing to defaults */
220  tsch_default_timing_us = TSCH_DEFAULT_TIMESLOT_TIMING;
221  for(i = 0; i < tsch_ts_elements_count; i++) {
222  tsch_timing_us[i] = tsch_default_timing_us[i];
223  tsch_timing[i] = US_TO_RTIMERTICKS(tsch_timing_us[i]);
224  }
225 #ifdef TSCH_CALLBACK_LEAVING_NETWORK
226  TSCH_CALLBACK_LEAVING_NETWORK();
227 #endif
228  linkaddr_copy(&last_eb_nbr_addr, &linkaddr_null);
229 #if TSCH_AUTOSELECT_TIME_SOURCE
230  struct eb_stat *stat;
231  best_neighbor_eb_count = 0;
232  /* Remove all nbr stats */
233  stat = nbr_table_head(eb_stats);
234  while(stat != NULL) {
235  nbr_table_remove(eb_stats, stat);
236  stat = nbr_table_next(eb_stats, stat);
237  }
238 #endif /* TSCH_AUTOSELECT_TIME_SOURCE */
239  tsch_set_eb_period(TSCH_EB_PERIOD);
240  keepalive_status = KEEPALIVE_SCHEDULING_UNCHANGED;
241 }
242 /* TSCH keep-alive functions */
243 
244 /*---------------------------------------------------------------------------*/
245 /* Resynchronize to last_eb_nbr.
246  * Return non-zero if this function schedules the next keepalive.
247  * Return zero otherwise.
248  */
249 static int
250 resynchronize(const linkaddr_t *original_time_source_addr)
251 {
252  const struct tsch_neighbor *current_time_source = tsch_queue_get_time_source();
253  const linkaddr_t *ts_addr = tsch_queue_get_nbr_address(current_time_source);
254  if(ts_addr != NULL && !linkaddr_cmp(ts_addr, original_time_source_addr)) {
255  /* Time source has already been changed (e.g. by RPL). Let's see if it works. */
256  LOG_INFO("time source has been changed to ");
257  LOG_INFO_LLADDR(ts_addr);
258  LOG_INFO_("\n");
259  return 0;
260  }
261  /* Switch time source to the last neighbor we received an EB from */
262  if(linkaddr_cmp(&last_eb_nbr_addr, &linkaddr_null)) {
263  LOG_WARN("not able to re-synchronize, received no EB from other neighbors\n");
264  if(sync_count == 0) {
265  /* We got no synchronization at all in this session, leave the network */
267  }
268  return 0;
269  } else {
270  LOG_WARN("re-synchronizing on ");
271  LOG_WARN_LLADDR(&last_eb_nbr_addr);
272  LOG_WARN_("\n");
273  /* We simply pick the last neighbor we receiver sync information from */
274  tsch_queue_update_time_source(&last_eb_nbr_addr);
275  tsch_join_priority = last_eb_nbr_jp + 1;
276  linkaddr_copy(&last_eb_nbr_addr, &linkaddr_null);
277  /* Try to get in sync ASAP */
279  return 1;
280  }
281 }
282 
283 /*---------------------------------------------------------------------------*/
284 /* Tx callback for keepalive messages */
285 static void
286 keepalive_packet_sent(void *ptr, int status, int transmissions)
287 {
288  int schedule_next_keepalive = 1;
289  /* Update neighbor link statistics */
290  link_stats_packet_sent(packetbuf_addr(PACKETBUF_ADDR_RECEIVER), status, transmissions);
291  /* Call RPL callback if RPL is enabled */
292 #ifdef TSCH_CALLBACK_KA_SENT
293  TSCH_CALLBACK_KA_SENT(status, transmissions);
294 #endif /* TSCH_CALLBACK_KA_SENT */
295  LOG_INFO("KA sent to ");
296  LOG_INFO_LLADDR(packetbuf_addr(PACKETBUF_ADDR_RECEIVER));
297  LOG_INFO_(", st %d-%d\n", status, transmissions);
298 
299  /* We got no ack, try to resynchronize */
300  if(status == MAC_TX_NOACK) {
301  schedule_next_keepalive = !resynchronize(packetbuf_addr(PACKETBUF_ADDR_RECEIVER));
302  }
303 
304  if(schedule_next_keepalive) {
306  }
307 }
308 /*---------------------------------------------------------------------------*/
309 /* Prepare and send a keepalive message */
310 static void
311 keepalive_send(void *ptr)
312 {
313  /* If not here from a timer callback, the timer must be stopped */
314  ctimer_stop(&keepalive_timer);
315 
316  if(tsch_is_associated) {
318  if(n != NULL) {
319  linkaddr_t *destination = tsch_queue_get_nbr_address(n);
320  /* Simply send an empty packet */
321  packetbuf_clear();
322  packetbuf_set_addr(PACKETBUF_ADDR_RECEIVER, destination);
323  NETSTACK_MAC.send(keepalive_packet_sent, NULL);
324  LOG_INFO("sending KA to ");
325  LOG_INFO_LLADDR(destination);
326  LOG_INFO_("\n");
327  } else {
328  LOG_ERR("no timesource - KA not sent\n");
329  }
330  }
331 }
332 /*---------------------------------------------------------------------------*/
333 void
335 {
336  if(immediate) {
337  /* send as soon as possible */
338  keepalive_status = KEEPALIVE_SEND_IMMEDIATELY;
339  } else if(keepalive_status != KEEPALIVE_SEND_IMMEDIATELY) {
340  /* send based on the tsch_current_ka_timeout */
341  keepalive_status = KEEPALIVE_SCHEDULE_OR_STOP;
342  }
343  process_poll(&tsch_pending_events_process);
344 }
345 /*---------------------------------------------------------------------------*/
346 static void
347 tsch_keepalive_process_pending(void)
348 {
349  if(keepalive_status != KEEPALIVE_SCHEDULING_UNCHANGED) {
350  /* first, save and reset the old status */
351  enum tsch_keepalive_status scheduled_status = keepalive_status;
352  keepalive_status = KEEPALIVE_SCHEDULING_UNCHANGED;
353 
354  if(!tsch_is_coordinator && tsch_is_associated) {
355  switch(scheduled_status) {
356  case KEEPALIVE_SEND_IMMEDIATELY:
357  /* always send, and as soon as possible (now) */
358  keepalive_send(NULL);
359  break;
360 
361  case KEEPALIVE_SCHEDULE_OR_STOP:
362  if(tsch_current_ka_timeout > 0) {
363  /* Pick a delay in the range [tsch_current_ka_timeout*0.9, tsch_current_ka_timeout[ */
364  unsigned long delay;
365  if(tsch_current_ka_timeout >= 10) {
366  delay = (tsch_current_ka_timeout - tsch_current_ka_timeout / 10)
367  + random_rand() % (tsch_current_ka_timeout / 10);
368  } else {
369  delay = tsch_current_ka_timeout - 1;
370  }
371  ctimer_set(&keepalive_timer, delay, keepalive_send, NULL);
372  } else {
373  /* zero timeout set, stop sending keepalives */
374  ctimer_stop(&keepalive_timer);
375  }
376  break;
377 
378  default:
379  break;
380  }
381  } else {
382  /* either coordinator or not associated */
383  ctimer_stop(&keepalive_timer);
384  }
385  }
386 }
387 /*---------------------------------------------------------------------------*/
388 static void
389 eb_input(struct input_packet *current_input)
390 {
391  /* LOG_INFO("EB received\n"); */
392  frame802154_t frame;
393  /* Verify incoming EB (does its ASN match our Rx time?),
394  * and update our join priority. */
395  struct ieee802154_ies eb_ies;
396 
397  if(tsch_packet_parse_eb(current_input->payload, current_input->len,
398  &frame, &eb_ies, NULL, 1)) {
399  /* PAN ID check and authentication done at rx time */
400 
401  /* Got an EB from a different neighbor than our time source, keep enough data
402  * to switch to it in case we lose the link to our time source */
404  linkaddr_t *ts_addr = tsch_queue_get_nbr_address(ts);
405  if(ts_addr == NULL || !linkaddr_cmp((linkaddr_t *)&frame.src_addr, ts_addr)) {
406  linkaddr_copy(&last_eb_nbr_addr, (linkaddr_t *)&frame.src_addr);
407  last_eb_nbr_jp = eb_ies.ie_join_priority;
408  }
409 
410 #if TSCH_AUTOSELECT_TIME_SOURCE
411  if(!tsch_is_coordinator) {
412  /* Maintain EB received counter for every neighbor */
413  struct eb_stat *stat = (struct eb_stat *)nbr_table_get_from_lladdr(eb_stats, (linkaddr_t *)&frame.src_addr);
414  if(stat == NULL) {
415  stat = (struct eb_stat *)nbr_table_add_lladdr(eb_stats, (linkaddr_t *)&frame.src_addr, NBR_TABLE_REASON_MAC, NULL);
416  }
417  if(stat != NULL) {
418  stat->rx_count++;
419  stat->jp = eb_ies.ie_join_priority;
420  best_neighbor_eb_count = MAX(best_neighbor_eb_count, stat->rx_count);
421  }
422  /* Select best time source */
423  struct eb_stat *best_stat = NULL;
424  stat = nbr_table_head(eb_stats);
425  while(stat != NULL) {
426  /* Is neighbor eligible as a time source? */
427  if(stat->rx_count > best_neighbor_eb_count / 2) {
428  if(best_stat == NULL ||
429  stat->jp < best_stat->jp) {
430  best_stat = stat;
431  }
432  }
433  stat = nbr_table_next(eb_stats, stat);
434  }
435  /* Update time source */
436  if(best_stat != NULL) {
437  tsch_queue_update_time_source(nbr_table_get_lladdr(eb_stats, best_stat));
438  tsch_join_priority = best_stat->jp + 1;
439  }
440  }
441 #endif /* TSCH_AUTOSELECT_TIME_SOURCE */
442 
443  /* If this EB is coming from the root, add it to the root list */
444  if(eb_ies.ie_join_priority == 0) {
445  tsch_roots_add_address((linkaddr_t *)&frame.src_addr);
446  }
447 
448  /* Did the EB come from our time source? */
449  if(ts_addr != NULL && linkaddr_cmp((linkaddr_t *)&frame.src_addr, ts_addr)) {
450  /* Check for ASN drift */
451  int32_t asn_diff = TSCH_ASN_DIFF(current_input->rx_asn, eb_ies.ie_asn);
452  if(asn_diff != 0) {
453  /* We disagree with our time source's ASN -- leave the network */
454  LOG_WARN("! ASN drifted by %ld, leaving the network\n", asn_diff);
456  }
457 
458  if(eb_ies.ie_join_priority >= TSCH_MAX_JOIN_PRIORITY) {
459  /* Join priority unacceptable. Leave network. */
460  LOG_WARN("! EB JP too high %u, leaving the network\n",
461  eb_ies.ie_join_priority);
463  } else {
464 #if TSCH_AUTOSELECT_TIME_SOURCE
465  /* Update join priority */
466  if(tsch_join_priority != eb_ies.ie_join_priority + 1) {
467  LOG_INFO("update JP from EB %u -> %u\n",
468  tsch_join_priority, eb_ies.ie_join_priority + 1);
469  tsch_join_priority = eb_ies.ie_join_priority + 1;
470  }
471 #endif /* TSCH_AUTOSELECT_TIME_SOURCE */
472  }
473 
474  /* TSCH hopping sequence */
475  if(eb_ies.ie_channel_hopping_sequence_id != 0) {
476  if(eb_ies.ie_hopping_sequence_len != tsch_hopping_sequence_length.val
477  || memcmp((uint8_t *)tsch_hopping_sequence, eb_ies.ie_hopping_sequence_list, tsch_hopping_sequence_length.val)) {
478  if(eb_ies.ie_hopping_sequence_len <= sizeof(tsch_hopping_sequence)) {
479  memcpy((uint8_t *)tsch_hopping_sequence, eb_ies.ie_hopping_sequence_list,
480  eb_ies.ie_hopping_sequence_len);
481  TSCH_ASN_DIVISOR_INIT(tsch_hopping_sequence_length, eb_ies.ie_hopping_sequence_len);
482 
483  LOG_WARN("Updating TSCH hopping sequence from EB\n");
484  } else {
485  LOG_WARN("TSCH:! parse_eb: hopping sequence too long (%u)\n", eb_ies.ie_hopping_sequence_len);
486  }
487  }
488  }
489  }
490  }
491 }
492 /*---------------------------------------------------------------------------*/
493 /* Process pending input packet(s) */
494 static void
495 tsch_rx_process_pending()
496 {
497  int16_t input_index;
498  /* Loop on accessing (without removing) a pending input packet */
499  while((input_index = ringbufindex_peek_get(&input_ringbuf)) != -1) {
500  struct input_packet *current_input = &input_array[input_index];
501  frame802154_t frame;
502  uint8_t ret = frame802154_parse(current_input->payload, current_input->len, &frame);
503  int is_data = ret && frame.fcf.frame_type == FRAME802154_DATAFRAME;
504  int is_eb = ret
505  && frame.fcf.frame_version == FRAME802154_IEEE802154_2015
506  && frame.fcf.frame_type == FRAME802154_BEACONFRAME;
507 
508  if(is_data) {
509  /* Skip EBs and other control messages */
510  /* Copy to packetbuf for processing */
511  packetbuf_copyfrom(current_input->payload, current_input->len);
512  packetbuf_set_attr(PACKETBUF_ATTR_RSSI, current_input->rssi);
513  packetbuf_set_attr(PACKETBUF_ATTR_CHANNEL, current_input->channel);
514  }
515 
516  if(is_data) {
517  /* Pass to upper layers */
518  packet_input();
519  } else if(is_eb) {
520  eb_input(current_input);
521  }
522 
523  /* Remove input from ringbuf */
524  ringbufindex_get(&input_ringbuf);
525  }
526 }
527 /*---------------------------------------------------------------------------*/
528 /* Pass sent packets to upper layer */
529 static void
530 tsch_tx_process_pending(void)
531 {
532  int16_t dequeued_index;
533  /* Loop on accessing (without removing) a pending input packet */
534  while((dequeued_index = ringbufindex_peek_get(&dequeued_ringbuf)) != -1) {
535  struct tsch_packet *p = dequeued_array[dequeued_index];
536  /* Put packet into packetbuf for packet_sent callback */
537  queuebuf_to_packetbuf(p->qb);
538  LOG_INFO("packet sent to ");
539  LOG_INFO_LLADDR(packetbuf_addr(PACKETBUF_ADDR_RECEIVER));
540  LOG_INFO_(", seqno %u, status %d, tx %d\n",
541  packetbuf_attr(PACKETBUF_ATTR_MAC_SEQNO), p->ret, p->transmissions);
542  /* Call packet_sent callback */
543  mac_call_sent_callback(p->sent, p->ptr, p->ret, p->transmissions);
544  /* Free packet queuebuf */
546  /* Free all unused neighbors */
548  /* Remove dequeued packet from ringbuf */
549  ringbufindex_get(&dequeued_ringbuf);
550  }
551 }
552 /*---------------------------------------------------------------------------*/
553 /* Setup TSCH as a coordinator */
554 static void
555 tsch_start_coordinator(void)
556 {
557  frame802154_set_pan_id(IEEE802154_PANID);
558  /* Initialize hopping sequence as default */
559  memcpy(tsch_hopping_sequence, TSCH_DEFAULT_HOPPING_SEQUENCE, sizeof(TSCH_DEFAULT_HOPPING_SEQUENCE));
560  TSCH_ASN_DIVISOR_INIT(tsch_hopping_sequence_length, sizeof(TSCH_DEFAULT_HOPPING_SEQUENCE));
561 #if TSCH_SCHEDULE_WITH_6TISCH_MINIMAL
563 #endif
564 
565  tsch_is_associated = 1;
566  tsch_join_priority = 0;
567 
568  LOG_INFO("starting as coordinator, PAN ID %x, asn-%x.%lx\n",
569  frame802154_get_pan_id(), tsch_current_asn.ms1b, tsch_current_asn.ls4b);
570 
571  /* Start slot operation */
572  tsch_slot_operation_sync(RTIMER_NOW(), &tsch_current_asn);
573 }
574 /*---------------------------------------------------------------------------*/
575 /* Leave the TSCH network */
576 void
578 {
579  if(tsch_is_associated == 1) {
580  tsch_is_associated = 0;
582  process_poll(&tsch_process);
583  }
584 }
585 /*---------------------------------------------------------------------------*/
586 /* Attempt to associate to a network form an incoming EB */
587 static int
588 tsch_associate(const struct input_packet *input_eb, rtimer_clock_t timestamp)
589 {
590  frame802154_t frame;
591  struct ieee802154_ies ies;
592  uint8_t hdrlen;
593  int i;
594 
595  if(input_eb == NULL || tsch_packet_parse_eb(input_eb->payload, input_eb->len,
596  &frame, &ies, &hdrlen, 0) == 0) {
597  LOG_DBG("! failed to parse packet as EB while scanning (len %u)\n",
598  input_eb->len);
599  return 0;
600  }
601 
602  tsch_current_asn = ies.ie_asn;
603  tsch_join_priority = ies.ie_join_priority + 1;
604 
605 #if TSCH_JOIN_SECURED_ONLY
606  if(frame.fcf.security_enabled == 0) {
607  LOG_ERR("! parse_eb: EB is not secured\n");
608  return 0;
609  }
610 #endif /* TSCH_JOIN_SECURED_ONLY */
611 #if LLSEC802154_ENABLED
612  if(!tsch_security_parse_frame(input_eb->payload, hdrlen,
613  input_eb->len - hdrlen - tsch_security_mic_len(&frame),
614  &frame, (linkaddr_t*)&frame.src_addr, &tsch_current_asn)) {
615  LOG_ERR("! parse_eb: failed to authenticate\n");
616  return 0;
617  }
618 #endif /* LLSEC802154_ENABLED */
619 
620 #if !LLSEC802154_ENABLED
621  if(frame.fcf.security_enabled == 1) {
622  LOG_ERR("! parse_eb: we do not support security, but EB is secured\n");
623  return 0;
624  }
625 #endif /* !LLSEC802154_ENABLED */
626 
627 #if TSCH_JOIN_MY_PANID_ONLY
628  /* Check if the EB comes from the PAN ID we expect */
629  if(frame.src_pid != IEEE802154_PANID) {
630  LOG_ERR("! parse_eb: PAN ID %x != %x\n", frame.src_pid, IEEE802154_PANID);
631  return 0;
632  }
633 #endif /* TSCH_JOIN_MY_PANID_ONLY */
634 
635  /* There was no join priority (or 0xff) in the EB, do not join */
636  if(ies.ie_join_priority == 0xff) {
637  LOG_ERR("! parse_eb: no join priority\n");
638  return 0;
639  }
640 
641  /* TSCH timeslot timing */
642  for(i = 0; i < tsch_ts_elements_count; i++) {
643  if(ies.ie_tsch_timeslot_id == 0) {
644  tsch_timing_us[i] = tsch_default_timing_us[i];
645  } else {
646  tsch_timing_us[i] = ies.ie_tsch_timeslot[i];
647  }
648  tsch_timing[i] = US_TO_RTIMERTICKS(tsch_timing_us[i]);
649  }
650 
651  /* TSCH hopping sequence */
652  if(ies.ie_channel_hopping_sequence_id == 0) {
653  memcpy(tsch_hopping_sequence, TSCH_DEFAULT_HOPPING_SEQUENCE, sizeof(TSCH_DEFAULT_HOPPING_SEQUENCE));
654  TSCH_ASN_DIVISOR_INIT(tsch_hopping_sequence_length, sizeof(TSCH_DEFAULT_HOPPING_SEQUENCE));
655  } else {
656  if(ies.ie_hopping_sequence_len <= sizeof(tsch_hopping_sequence)) {
657  memcpy(tsch_hopping_sequence, ies.ie_hopping_sequence_list, ies.ie_hopping_sequence_len);
658  TSCH_ASN_DIVISOR_INIT(tsch_hopping_sequence_length, ies.ie_hopping_sequence_len);
659  } else {
660  LOG_ERR("! parse_eb: hopping sequence too long (%u)\n", ies.ie_hopping_sequence_len);
661  return 0;
662  }
663  }
664 
665 #if TSCH_CHECK_TIME_AT_ASSOCIATION > 0
666  /* Divide by 4k and multiply again to avoid integer overflow */
667  uint32_t expected_asn = 4096 * TSCH_CLOCK_TO_SLOTS(clock_time() / 4096, tsch_timing_timeslot_length); /* Expected ASN based on our current time*/
668  int32_t asn_threshold = TSCH_CHECK_TIME_AT_ASSOCIATION * 60ul * TSCH_CLOCK_TO_SLOTS(CLOCK_SECOND, tsch_timing_timeslot_length);
669  int32_t asn_diff = (int32_t)tsch_current_asn.ls4b - expected_asn;
670  if(asn_diff > asn_threshold) {
671  LOG_ERR("! EB ASN rejected %lx %lx %ld\n",
672  tsch_current_asn.ls4b, expected_asn, asn_diff);
673  return 0;
674  }
675 #endif
676 
677 #if TSCH_INIT_SCHEDULE_FROM_EB
678  /* Create schedule */
679  if(ies.ie_tsch_slotframe_and_link.num_slotframes == 0) {
680 #if TSCH_SCHEDULE_WITH_6TISCH_MINIMAL
681  LOG_INFO("parse_eb: no schedule, setting up minimal schedule\n");
683 #else
684  LOG_INFO("parse_eb: no schedule\n");
685 #endif
686  } else {
687  /* First, empty current schedule */
689  /* We support only 0 or 1 slotframe in this IE */
690  int num_links = ies.ie_tsch_slotframe_and_link.num_links;
691  if(num_links <= FRAME802154E_IE_MAX_LINKS) {
692  int i;
694  ies.ie_tsch_slotframe_and_link.slotframe_handle,
695  ies.ie_tsch_slotframe_and_link.slotframe_size);
696  for(i = 0; i < num_links; i++) {
698  ies.ie_tsch_slotframe_and_link.links[i].link_options,
699  LINK_TYPE_ADVERTISING, &tsch_broadcast_address,
700  ies.ie_tsch_slotframe_and_link.links[i].timeslot,
701  ies.ie_tsch_slotframe_and_link.links[i].channel_offset, 1);
702  }
703  } else {
704  LOG_ERR("! parse_eb: too many links in schedule (%u)\n", num_links);
705  return 0;
706  }
707  }
708 #endif /* TSCH_INIT_SCHEDULE_FROM_EB */
709 
710  if(tsch_join_priority < TSCH_MAX_JOIN_PRIORITY) {
711  struct tsch_neighbor *n;
712 
713  /* Add coordinator to list of neighbors, lock the entry */
714  n = tsch_queue_add_nbr((linkaddr_t *)&frame.src_addr);
715 
716  if(n != NULL) {
717  tsch_queue_update_time_source((linkaddr_t *)&frame.src_addr);
718 
719  /* Set PANID */
720  frame802154_set_pan_id(frame.src_pid);
721 
722  /* Synchronize on EB */
723  tsch_slot_operation_sync(timestamp - tsch_timing[tsch_ts_tx_offset], &tsch_current_asn);
724 
725  /* Update global flags */
726  tsch_is_associated = 1;
727  tsch_is_pan_secured = frame.fcf.security_enabled;
728  tx_count = 0;
729  rx_count = 0;
730  sync_count = 0;
731  min_drift_seen = 0;
732  max_drift_seen = 0;
733 
734  /* Start sending keep-alives now that tsch_is_associated is set */
736 
737  /* If this EB is coming from the root, add it to the root list */
738  if(ies.ie_join_priority == 0) {
739  tsch_roots_add_address((linkaddr_t *)&frame.src_addr);
740  }
741 
742 #ifdef TSCH_CALLBACK_JOINING_NETWORK
743  TSCH_CALLBACK_JOINING_NETWORK();
744 #endif
745 
746  tsch_association_count++;
747  LOG_INFO("association done (%u), sec %u, PAN ID %x, asn-%x.%lx, jp %u, timeslot id %u, hopping id %u, slotframe len %u with %u links, from ",
748  tsch_association_count,
749  tsch_is_pan_secured,
750  frame.src_pid,
751  tsch_current_asn.ms1b, tsch_current_asn.ls4b, tsch_join_priority,
752  ies.ie_tsch_timeslot_id,
753  ies.ie_channel_hopping_sequence_id,
754  ies.ie_tsch_slotframe_and_link.slotframe_size,
755  ies.ie_tsch_slotframe_and_link.num_links);
756  LOG_INFO_LLADDR((const linkaddr_t *)&frame.src_addr);
757  LOG_INFO_("\n");
758 
759  return 1;
760  }
761  }
762  LOG_ERR("! did not associate.\n");
763  return 0;
764 }
765 /* Processes and protothreads used by TSCH */
766 
767 /*---------------------------------------------------------------------------*/
768 /* Scanning protothread, called by tsch_process:
769  * Listen to different channels, and when receiving an EB,
770  * attempt to associate.
771  */
772 PT_THREAD(tsch_scan(struct pt *pt))
773 {
774  PT_BEGIN(pt);
775 
776  static struct input_packet input_eb;
777  static struct etimer scan_timer;
778  /* Time when we started scanning on current_channel */
779  static clock_time_t current_channel_since;
780 
781  TSCH_ASN_INIT(tsch_current_asn, 0, 0);
782 
783  etimer_set(&scan_timer, CLOCK_SECOND / TSCH_ASSOCIATION_POLL_FREQUENCY);
784  current_channel_since = clock_time();
785 
786  while(!tsch_is_associated && !tsch_is_coordinator) {
787  /* Hop to any channel offset */
788  static uint8_t current_channel = 0;
789 
790  /* We are not coordinator, try to associate */
791  rtimer_clock_t t0;
792  int is_packet_pending = 0;
793  clock_time_t now_time = clock_time();
794 
795  /* Switch to a (new) channel for scanning */
796  if(current_channel == 0 || now_time - current_channel_since > TSCH_CHANNEL_SCAN_DURATION) {
797  /* Pick a channel at random in TSCH_JOIN_HOPPING_SEQUENCE */
798  uint8_t scan_channel = TSCH_JOIN_HOPPING_SEQUENCE[
799  random_rand() % sizeof(TSCH_JOIN_HOPPING_SEQUENCE)];
800 
801  NETSTACK_RADIO.set_value(RADIO_PARAM_CHANNEL, scan_channel);
802  current_channel = scan_channel;
803  LOG_INFO("scanning on channel %u\n", scan_channel);
804 
805  current_channel_since = now_time;
806  }
807 
808  /* Turn radio on and wait for EB */
809  NETSTACK_RADIO.on();
810 
811  is_packet_pending = NETSTACK_RADIO.pending_packet();
812  if(!is_packet_pending && NETSTACK_RADIO.receiving_packet()) {
813  /* If we are currently receiving a packet, wait until end of reception */
814  t0 = RTIMER_NOW();
815  RTIMER_BUSYWAIT_UNTIL_ABS((is_packet_pending = NETSTACK_RADIO.pending_packet()), t0, RTIMER_SECOND / 100);
816  }
817 
818  if(is_packet_pending) {
819  rtimer_clock_t t1;
820  /* Read packet */
821  input_eb.len = NETSTACK_RADIO.read(input_eb.payload, TSCH_PACKET_MAX_LEN);
822 
823  if(input_eb.len > 0) {
824  /* Save packet timestamp */
825  NETSTACK_RADIO.get_object(RADIO_PARAM_LAST_PACKET_TIMESTAMP, &t0, sizeof(rtimer_clock_t));
826  t1 = RTIMER_NOW();
827 
828  /* Parse EB and attempt to associate */
829  LOG_INFO("scan: received packet (%u bytes) on channel %u\n", input_eb.len, current_channel);
830 
831  /* Sanity-check the timestamp */
832  if(ABS(RTIMER_CLOCK_DIFF(t0, t1)) < 2ul * RTIMER_SECOND) {
833  tsch_associate(&input_eb, t0);
834  } else {
835  LOG_WARN("scan: dropping packet, timestamp too far from current time %u %u\n",
836  (unsigned)t0,
837  (unsigned)t1
838  );
839  }
840  }
841  }
842 
843  if(tsch_is_associated) {
844  /* End of association, turn the radio off */
845  NETSTACK_RADIO.off();
846  } else if(!tsch_is_coordinator) {
847  /* Go back to scanning */
848  etimer_reset(&scan_timer);
849  PT_WAIT_UNTIL(pt, etimer_expired(&scan_timer));
850  }
851  }
852 
853  PT_END(pt);
854 }
855 
856 /*---------------------------------------------------------------------------*/
857 /* The main TSCH process */
858 PROCESS_THREAD(tsch_process, ev, data)
859 {
860  static struct pt scan_pt;
861 
862  PROCESS_BEGIN();
863 
864  while(1) {
865 
866  while(!tsch_is_associated) {
867  if(tsch_is_coordinator) {
868  /* We are coordinator, start operating now */
869  tsch_start_coordinator();
870  } else {
871  /* Start scanning, will attempt to join when receiving an EB */
872  PROCESS_PT_SPAWN(&scan_pt, tsch_scan(&scan_pt));
873  }
874  }
875 
876  /* We are part of a TSCH network, start slot operation */
878 
879  /* Yield our main process. Slot operation will re-schedule itself
880  * as long as we are associated */
881  PROCESS_YIELD_UNTIL(!tsch_is_associated);
882 
883  LOG_WARN("leaving the network, stats: tx %lu, rx %lu, sync %lu\n",
884  tx_count, rx_count, sync_count);
885 
886  /* Will need to re-synchronize */
887  tsch_reset();
888  }
889 
890  PROCESS_END();
891 }
892 
893 /*---------------------------------------------------------------------------*/
894 /* A periodic process to send TSCH Enhanced Beacons (EB) */
895 PROCESS_THREAD(tsch_send_eb_process, ev, data)
896 {
897  static struct etimer eb_timer;
898 
899  PROCESS_BEGIN();
900 
901  /* Wait until association */
902  etimer_set(&eb_timer, CLOCK_SECOND / 10);
903  while(!tsch_is_associated) {
905  etimer_reset(&eb_timer);
906  }
907 
908  /* Set an initial delay except for coordinator, which should send an EB asap */
909  if(!tsch_is_coordinator) {
910  etimer_set(&eb_timer, TSCH_EB_PERIOD ? random_rand() % TSCH_EB_PERIOD : 0);
912  }
913 
914  while(1) {
915  unsigned long delay;
916 
917  if(!tsch_is_associated) {
918  LOG_DBG("skip sending EB: not joined a TSCH network\n");
919  } else if(tsch_current_eb_period <= 0) {
920  LOG_DBG("skip sending EB: EB period disabled\n");
921 #ifdef TSCH_RPL_CHECK_DODAG_JOINED
922  } else if(!TSCH_RPL_CHECK_DODAG_JOINED()) {
923  /* Implementation section 6.3 of RFC 8180 */
924  LOG_DBG("skip sending EB: not joined a routing DAG\n");
925 #endif /* TSCH_RPL_CHECK_DODAG_JOINED */
926  } else if(NETSTACK_ROUTING.is_in_leaf_mode()) {
927  /* don't send when in leaf mode */
928  LOG_DBG("skip sending EB: in the leaf mode\n");
929  } else if(tsch_queue_nbr_packet_count(n_eb) != 0) {
930  /* Enqueue EB only if there isn't already one in queue */
931  LOG_DBG("skip sending EB: already queued\n");
932  } else {
933  uint8_t hdr_len = 0;
934  uint8_t tsch_sync_ie_offset;
935  /* Prepare the EB packet and schedule it to be sent */
936  if(tsch_packet_create_eb(&hdr_len, &tsch_sync_ie_offset) > 0) {
937  struct tsch_packet *p;
938  /* Enqueue EB packet, for a single transmission only */
939  if(!(p = tsch_queue_add_packet(&tsch_eb_address, 1, NULL, NULL))) {
940  LOG_ERR("! could not enqueue EB packet\n");
941  } else {
942  LOG_INFO("TSCH: enqueue EB packet %u %u\n",
944  p->tsch_sync_ie_offset = tsch_sync_ie_offset;
945  p->header_len = hdr_len;
946  }
947  }
948  }
949  if(tsch_current_eb_period > 0) {
950  /* Next EB transmission with a random delay
951  * within [tsch_current_eb_period*0.75, tsch_current_eb_period[ */
952  delay = (tsch_current_eb_period - tsch_current_eb_period / 4)
953  + random_rand() % (tsch_current_eb_period / 4);
954  } else {
955  delay = TSCH_EB_PERIOD;
956  }
957  etimer_set(&eb_timer, delay);
959  }
960  PROCESS_END();
961 }
962 
963 /*---------------------------------------------------------------------------*/
964 /* A process that is polled from interrupt and calls tx/rx input
965  * callbacks, outputs pending logs. */
966 PROCESS_THREAD(tsch_pending_events_process, ev, data)
967 {
968  PROCESS_BEGIN();
969  while(1) {
970  PROCESS_YIELD_UNTIL(ev == PROCESS_EVENT_POLL);
971  tsch_rx_process_pending();
972  tsch_tx_process_pending();
974  tsch_keepalive_process_pending();
975 #ifdef TSCH_CALLBACK_SELECT_CHANNELS
976  TSCH_CALLBACK_SELECT_CHANNELS();
977 #endif
978  }
979  PROCESS_END();
980 }
981 
982 /* Functions from the Contiki MAC layer driver interface */
983 
984 /*---------------------------------------------------------------------------*/
985 static void
986 tsch_init(void)
987 {
988  radio_value_t radio_rx_mode;
989  radio_value_t radio_tx_mode;
990  radio_value_t radio_max_payload_len;
991 
992  rtimer_clock_t t;
993 
994  /* Check that the platform provides a TSCH timeslot timing template */
995  if(TSCH_DEFAULT_TIMESLOT_TIMING == NULL) {
996  LOG_ERR("! platform does not provide a timeslot timing template.\n");
997  return;
998  }
999 
1000  /* Check that the radio can correctly report its max supported payload */
1001  if(NETSTACK_RADIO.get_value(RADIO_CONST_MAX_PAYLOAD_LEN, &radio_max_payload_len) != RADIO_RESULT_OK) {
1002  LOG_ERR("! radio does not support getting RADIO_CONST_MAX_PAYLOAD_LEN. Abort init.\n");
1003  return;
1004  }
1005 
1006  /* Radio Rx mode */
1007  if(NETSTACK_RADIO.get_value(RADIO_PARAM_RX_MODE, &radio_rx_mode) != RADIO_RESULT_OK) {
1008  LOG_ERR("! radio does not support getting RADIO_PARAM_RX_MODE. Abort init.\n");
1009  return;
1010  }
1011  /* Disable radio in frame filtering */
1012  radio_rx_mode &= ~RADIO_RX_MODE_ADDRESS_FILTER;
1013  /* Unset autoack */
1014  radio_rx_mode &= ~RADIO_RX_MODE_AUTOACK;
1015  /* Set radio in poll mode */
1016  radio_rx_mode |= RADIO_RX_MODE_POLL_MODE;
1017  if(NETSTACK_RADIO.set_value(RADIO_PARAM_RX_MODE, radio_rx_mode) != RADIO_RESULT_OK) {
1018  LOG_ERR("! radio does not support setting required RADIO_PARAM_RX_MODE. Abort init.\n");
1019  return;
1020  }
1021 
1022  /* Radio Tx mode */
1023  if(NETSTACK_RADIO.get_value(RADIO_PARAM_TX_MODE, &radio_tx_mode) != RADIO_RESULT_OK) {
1024  LOG_ERR("! radio does not support getting RADIO_PARAM_TX_MODE. Abort init.\n");
1025  return;
1026  }
1027  /* Unset CCA */
1028  radio_tx_mode &= ~RADIO_TX_MODE_SEND_ON_CCA;
1029  if(NETSTACK_RADIO.set_value(RADIO_PARAM_TX_MODE, radio_tx_mode) != RADIO_RESULT_OK) {
1030  LOG_ERR("! radio does not support setting required RADIO_PARAM_TX_MODE. Abort init.\n");
1031  return;
1032  }
1033  /* Test setting channel */
1034  if(NETSTACK_RADIO.set_value(RADIO_PARAM_CHANNEL, TSCH_DEFAULT_HOPPING_SEQUENCE[0]) != RADIO_RESULT_OK) {
1035  LOG_ERR("! radio does not support setting channel. Abort init.\n");
1036  return;
1037  }
1038  /* Test getting timestamp */
1039  if(NETSTACK_RADIO.get_object(RADIO_PARAM_LAST_PACKET_TIMESTAMP, &t, sizeof(rtimer_clock_t)) != RADIO_RESULT_OK) {
1040  LOG_ERR("! radio does not support getting last packet timestamp. Abort init.\n");
1041  return;
1042  }
1043  /* Check max hopping sequence length vs default sequence length */
1044  if(TSCH_HOPPING_SEQUENCE_MAX_LEN < sizeof(TSCH_DEFAULT_HOPPING_SEQUENCE)) {
1045  LOG_ERR("! TSCH_HOPPING_SEQUENCE_MAX_LEN < sizeof(TSCH_DEFAULT_HOPPING_SEQUENCE). Abort init.\n");
1046  return;
1047  }
1048 
1049  /* Init TSCH sub-modules */
1050 #if TSCH_AUTOSELECT_TIME_SOURCE
1051  nbr_table_register(eb_stats, NULL);
1052 #endif /* TSCH_AUTOSELECT_TIME_SOURCE */
1053  tsch_reset();
1054  tsch_queue_init();
1056  tsch_log_init();
1057  ringbufindex_init(&input_ringbuf, TSCH_MAX_INCOMING_PACKETS);
1058  ringbufindex_init(&dequeued_ringbuf, TSCH_DEQUEUED_ARRAY_SIZE);
1059 
1060  tsch_packet_seqno = random_rand();
1061  tsch_is_initialized = 1;
1062 
1063 #if TSCH_AUTOSTART
1064  /* Start TSCH operation.
1065  * If TSCH_AUTOSTART is not set, one needs to call NETSTACK_MAC.on() to start TSCH. */
1066  NETSTACK_MAC.on();
1067 #endif /* TSCH_AUTOSTART */
1068 
1069 #if TSCH_WITH_SIXTOP
1070  sixtop_init();
1071 #endif
1072 
1073  tsch_stats_init();
1074  tsch_roots_init();
1075 }
1076 /*---------------------------------------------------------------------------*/
1077 /* Function send for TSCH-MAC, puts the packet in packetbuf in the MAC queue */
1078 static void
1079 send_packet(mac_callback_t sent, void *ptr)
1080 {
1081  int ret = MAC_TX_DEFERRED;
1082  int hdr_len = 0;
1083  const linkaddr_t *addr = packetbuf_addr(PACKETBUF_ADDR_RECEIVER);
1084  uint8_t max_transmissions = 0;
1085 
1086  if(!tsch_is_associated) {
1087  if(!tsch_is_initialized) {
1088  LOG_WARN("! not initialized (see earlier logs), drop outgoing packet\n");
1089  } else {
1090  LOG_WARN("! not associated, drop outgoing packet\n");
1091  }
1092  ret = MAC_TX_ERR;
1093  mac_call_sent_callback(sent, ptr, ret, 1);
1094  return;
1095  }
1096 
1097  /* Ask for ACK if we are sending anything other than broadcast */
1098  if(!linkaddr_cmp(addr, &linkaddr_null)) {
1099  /* PACKETBUF_ATTR_MAC_SEQNO cannot be zero, due to a pecuilarity
1100  in framer-802154.c. */
1101  if(++tsch_packet_seqno == 0) {
1102  tsch_packet_seqno++;
1103  }
1104  packetbuf_set_attr(PACKETBUF_ATTR_MAC_SEQNO, tsch_packet_seqno);
1105  packetbuf_set_attr(PACKETBUF_ATTR_MAC_ACK, 1);
1106  } else {
1107  /* Broadcast packets shall be added to broadcast queue
1108  * The broadcast address in Contiki is linkaddr_null which is equal
1109  * to tsch_eb_address */
1110  addr = &tsch_broadcast_address;
1111  }
1112 
1113  packetbuf_set_attr(PACKETBUF_ATTR_FRAME_TYPE, FRAME802154_DATAFRAME);
1114 
1115 #if LLSEC802154_ENABLED
1116  tsch_security_set_packetbuf_attr(FRAME802154_DATAFRAME);
1117 #endif /* LLSEC802154_ENABLED */
1118 
1119 #if !NETSTACK_CONF_BRIDGE_MODE
1120  /*
1121  * In the Contiki stack, the source address of a frame is set at the RDC
1122  * layer. Since TSCH doesn't use any RDC protocol and bypasses the layer to
1123  * transmit a frame, it should set the source address by itself.
1124  */
1125  packetbuf_set_addr(PACKETBUF_ADDR_SENDER, &linkaddr_node_addr);
1126 #endif
1127 
1128  max_transmissions = packetbuf_attr(PACKETBUF_ATTR_MAX_MAC_TRANSMISSIONS);
1129  if(max_transmissions == 0) {
1130  /* If not set by the application, use the default TSCH value */
1131  max_transmissions = TSCH_MAC_MAX_FRAME_RETRIES + 1;
1132  }
1133 
1134  if((hdr_len = NETSTACK_FRAMER.create()) < 0) {
1135  LOG_ERR("! can't send packet due to framer error\n");
1136  ret = MAC_TX_ERR;
1137  } else {
1138  struct tsch_packet *p;
1139  struct tsch_neighbor *n;
1140  /* Enqueue packet */
1141  p = tsch_queue_add_packet(addr, max_transmissions, sent, ptr);
1142  n = tsch_queue_get_nbr(addr);
1143  if(p == NULL) {
1144  LOG_ERR("! can't send packet to ");
1145  LOG_ERR_LLADDR(addr);
1146  LOG_ERR_(" with seqno %u, queue %u/%u %u/%u\n",
1147  tsch_packet_seqno, tsch_queue_nbr_packet_count(n),
1148  TSCH_QUEUE_NUM_PER_NEIGHBOR, tsch_queue_global_packet_count(),
1149  QUEUEBUF_NUM);
1150  ret = MAC_TX_QUEUE_FULL;
1151  } else {
1152  p->header_len = hdr_len;
1153  LOG_INFO("send packet to ");
1154  LOG_INFO_LLADDR(addr);
1155  LOG_INFO_(" with seqno %u, queue %u/%u %u/%u, len %u %u\n",
1156  tsch_packet_seqno, tsch_queue_nbr_packet_count(n),
1157  TSCH_QUEUE_NUM_PER_NEIGHBOR, tsch_queue_global_packet_count(),
1158  QUEUEBUF_NUM, p->header_len, queuebuf_datalen(p->qb));
1159  }
1160  }
1161  if(ret != MAC_TX_DEFERRED) {
1162  mac_call_sent_callback(sent, ptr, ret, 1);
1163  }
1164 }
1165 /*---------------------------------------------------------------------------*/
1166 static void
1167 packet_input(void)
1168 {
1169  int frame_parsed = 1;
1170 
1171  frame_parsed = NETSTACK_FRAMER.parse();
1172 
1173  if(frame_parsed < 0) {
1174  LOG_ERR("! failed to parse %u\n", packetbuf_datalen());
1175  } else {
1176  int duplicate = 0;
1177 
1178  /* Seqno of 0xffff means no seqno */
1179  if(packetbuf_attr(PACKETBUF_ATTR_MAC_SEQNO) != 0xffff) {
1180  /* Check for duplicates */
1181  duplicate = mac_sequence_is_duplicate();
1182  if(duplicate) {
1183  /* Drop the packet. */
1184  LOG_WARN("! drop dup ll from ");
1185  LOG_WARN_LLADDR(packetbuf_addr(PACKETBUF_ADDR_SENDER));
1186  LOG_WARN_(" seqno %u\n", packetbuf_attr(PACKETBUF_ATTR_MAC_SEQNO));
1187  } else {
1189  }
1190  }
1191 
1192  if(!duplicate) {
1193  LOG_INFO("received from ");
1194  LOG_INFO_LLADDR(packetbuf_addr(PACKETBUF_ADDR_SENDER));
1195  LOG_INFO_(" with seqno %u\n", packetbuf_attr(PACKETBUF_ATTR_MAC_SEQNO));
1196 #if TSCH_WITH_SIXTOP
1197  sixtop_input();
1198 #endif /* TSCH_WITH_SIXTOP */
1199  NETSTACK_NETWORK.input();
1200  }
1201  }
1202 }
1203 /*---------------------------------------------------------------------------*/
1204 static int
1205 turn_on(void)
1206 {
1207  if(tsch_is_initialized == 1 && tsch_is_started == 0) {
1208  tsch_is_started = 1;
1209  /* Process tx/rx callback and log messages whenever polled */
1210  process_start(&tsch_pending_events_process, NULL);
1211  if(TSCH_EB_PERIOD > 0) {
1212  /* periodically send TSCH EBs */
1213  process_start(&tsch_send_eb_process, NULL);
1214  }
1215  /* try to associate to a network or start one if setup as coordinator */
1216  process_start(&tsch_process, NULL);
1217  LOG_INFO("starting as %s\n", tsch_is_coordinator ? "coordinator": "node");
1218  return 1;
1219  }
1220  return 0;
1221 }
1222 /*---------------------------------------------------------------------------*/
1223 static int
1224 turn_off(void)
1225 {
1226  NETSTACK_RADIO.off();
1227  return 1;
1228 }
1229 /*---------------------------------------------------------------------------*/
1230 static int
1231 max_payload(void)
1232 {
1233  int framer_hdrlen;
1234  radio_value_t max_radio_payload_len;
1235  radio_result_t res;
1236 
1237  if(!tsch_is_associated) {
1238  LOG_WARN("Cannot compute max payload size: not associated\n");
1239  return 0;
1240  }
1241 
1242  res = NETSTACK_RADIO.get_value(RADIO_CONST_MAX_PAYLOAD_LEN,
1243  &max_radio_payload_len);
1244 
1245  if(res == RADIO_RESULT_NOT_SUPPORTED) {
1246  LOG_ERR("Failed to retrieve max radio driver payload length\n");
1247  return 0;
1248  }
1249 
1250  /* Set packetbuf security attributes */
1251  tsch_security_set_packetbuf_attr(FRAME802154_DATAFRAME);
1252 
1253  framer_hdrlen = NETSTACK_FRAMER.length();
1254  if(framer_hdrlen < 0) {
1255  return 0;
1256  }
1257 
1258  /* Setup security... before. */
1259  return MIN(max_radio_payload_len, TSCH_PACKET_MAX_LEN)
1260  - framer_hdrlen
1261  - LLSEC802154_PACKETBUF_MIC_LEN();
1262 }
1263 /*---------------------------------------------------------------------------*/
1264 const struct mac_driver tschmac_driver = {
1265  "TSCH",
1266  tsch_init,
1267  send_packet,
1268  packet_input,
1269  turn_on,
1270  turn_off,
1271  max_payload,
1272 };
1273 /*---------------------------------------------------------------------------*/
1274 /** @} */
uint16_t src_pid
Source PAN ID.
Definition: frame802154.h:207
TSCH packet information.
Definition: tsch-types.h:97
#define TSCH_ASN_DIVISOR_INIT(div, val_)
Initialize a struct asn_divisor_t.
Definition: tsch-asn.h:86
The MAC layer transmission could not be performed because of a fatal error.
Definition: mac.h:101
int tsch_queue_global_packet_count(void)
Returns the number of packets currently in all TSCH queues.
Definition: tsch-queue.c:279
struct tsch_neighbor * tsch_queue_get_nbr(const linkaddr_t *addr)
Get a TSCH neighbor.
Definition: tsch-queue.c:110
void process_post_synch(struct process *p, process_event_t ev, process_data_t data)
Post a synchronous event to a process.
Definition: process.c:362
#define PROCESS(name, strname)
Declare a process.
Definition: process.h:307
void ctimer_stop(struct ctimer *c)
Stop a pending callback timer.
Definition: ctimer.c:149
void ringbufindex_init(struct ringbufindex *r, uint8_t size)
Initialize a ring buffer.
Definition: ringbufindex.c:50
void tsch_log_process_pending(void)
Process pending log messages.
The parameter is not supported.
Definition: radio.h:473
int tsch_packet_create_eb(uint8_t *hdr_len, uint8_t *tsch_sync_ie_offset)
Create an EB packet directly in packetbuf.
Definition: tsch-packet.c:220
int(* on)(void)
Turn the MAC layer on.
Definition: mac.h:75
frame802154_fcf_t fcf
Frame control field.
Definition: frame802154.h:204
void packetbuf_clear(void)
Clear and reset the packetbuf.
Definition: packetbuf.c:75
static uip_ds6_addr_t * addr
Pointer to a nbr cache entry.
Definition: uip-nd6.c:107
int ringbufindex_peek_get(const struct ringbufindex *r)
Return the index of the first element which will be removed if calling ringbufindex_get.
Definition: ringbufindex.c:115
int tsch_schedule_init(void)
Module initialization, call only once at init.
The structure of a MAC protocol driver in Contiki.
Definition: mac.h:62
void tsch_set_join_priority(uint8_t jp)
Set the TSCH join priority (JP)
Definition: tsch.c:185
#define PROCESS_YIELD_UNTIL(c)
Yield the currently running process until a condition occurs.
Definition: process.h:178
Header file for the radio API
#define PROCESS_BEGIN()
Define the beginning of a process.
Definition: process.h:120
uint8_t security_enabled
1 bit.
Definition: frame802154.h:154
void tsch_log_init(void)
Initialize log module.
#define PROCESS_END()
Define the end of a process.
Definition: process.h:131
static void send_packet(linkaddr_t *dest)
This function is called by the 6lowpan code to send out a packet.
Definition: sicslowpan.c:1537
int frame802154_parse(uint8_t *data, int len, frame802154_t *pf)
Parses an input frame.
Definition: frame802154.c:500
int mac_sequence_is_duplicate(void)
Tell whether the packetbuf is a duplicate packet.
Definition: mac-sequence.c:72
TSCH neighbor information.
Definition: tsch-types.h:109
802.15.4e slotframe (contains links)
Definition: tsch-types.h:84
void tsch_queue_init(void)
Initialize TSCH queue module.
Definition: tsch-queue.c:536
#define PT_BEGIN(pt)
Declare the start of a protothread inside the C function implementing the protothread.
Definition: pt.h:280
unsigned int tsch_security_parse_frame(const uint8_t *hdr, int hdrlen, int datalen, const frame802154_t *frame, const linkaddr_t *sender, struct tsch_asn_t *asn)
Parse and check a frame protected with encryption and/or MIC.
Channel used for radio communication.
Definition: radio.h:134
struct tsch_neighbor * tsch_queue_get_time_source(void)
Get the TSCH time source (we currently assume there is only one)
Definition: tsch-queue.c:120
#define PT_WAIT_UNTIL(pt, condition)
Block and wait until condition is true.
Definition: pt.h:313
void tsch_set_ka_timeout(uint32_t timeout)
Set the desynchronization timeout after which a node sends a unicasst keep-alive (KA) to its time sou...
Definition: tsch.c:191
The parameter was set/read successfully.
Definition: radio.h:472
uint8_t packetbuf_hdrlen(void)
Get the length of the header in the packetbuf.
Definition: packetbuf.c:161
struct tsch_slotframe * tsch_schedule_add_slotframe(uint16_t handle, uint16_t size)
Creates and adds a new slotframe.
Definition: tsch-schedule.c:73
uint8_t(* is_in_leaf_mode)(void)
Tells whether the protocol is in leaf mode.
Definition: routing.h:190
int radio_value_t
Each radio has a set of parameters that designate the current configuration and state of the radio...
Definition: radio.h:88
uint8_t src_addr[8]
Source address.
Definition: frame802154.h:203
A MAC framer for IEEE 802.15.4
const linkaddr_t linkaddr_null
The null link-layer address.
Radio transmission mode determines if the radio has send on CCA (RADIO_TX_MODE_SEND_ON_CCA) enabled o...
Definition: radio.h:180
#define RTIMER_SECOND
Number of rtimer ticks for 1 second.
Definition: rtimer.h:112
Header file for MAC sequence numbers management
void tsch_queue_free_unused_neighbors(void)
Deallocate all neighbors with empty queue.
Definition: tsch-queue.c:398
void tsch_roots_add_address(const linkaddr_t *root_address)
Add address as a potential RPL root that is a single-hop neighbor in the TSCH network.
Definition: tsch-roots.c:168
uint16_t packetbuf_datalen(void)
Get the length of the data in the packetbuf.
Definition: packetbuf.c:155
linkaddr_t linkaddr_node_addr
The link-layer address of the node.
Definition: linkaddr.c:48
void sixtop_init(void)
Initialize 6top module This initialization function removes all the SFs which has been installed into...
Definition: sixtop.c:261
#define RTIMER_NOW()
Get the current clock time.
Definition: rtimer.h:185
void sixtop_input(void)
Input a packet stored in packetbuf.
Definition: sixtop.c:204
int tsch_queue_nbr_packet_count(const struct tsch_neighbor *n)
Returns the number of packets currently a given neighbor queue (by pointer)
Definition: tsch-queue.c:286
unsigned int tsch_security_mic_len(const frame802154_t *frame)
Return MIC length.
#define CLOCK_SECOND
A second, measured in system clock time.
Definition: clock.h:82
struct tsch_link * tsch_schedule_add_link(struct tsch_slotframe *slotframe, uint8_t link_options, enum link_type link_type, const linkaddr_t *address, uint16_t timeslot, uint16_t channel_offset, uint8_t do_remove)
Adds a link to a slotframe.
For quick modulo operation on ASN.
Definition: tsch-asn.h:54
#define PT_END(pt)
Declare the end of a protothread.
Definition: pt.h:292
linkaddr_t * tsch_queue_get_nbr_address(const struct tsch_neighbor *n)
Get the address of a neighbor.
Definition: tsch-queue.c:135
struct tsch_neighbor * tsch_queue_add_nbr(const linkaddr_t *addr)
Add a TSCH neighbor queue.
Definition: tsch-queue.c:81
Header file for the Packet queue buffer management
void tsch_set_eb_period(uint32_t period)
Set the period at wich TSCH enhanced beacons (EBs) are sent.
Definition: tsch.c:198
uint8_t frame_version
2 bit.
Definition: frame802154.h:162
void process_poll(struct process *p)
Request a process to be polled.
Definition: process.c:371
uint16_t packetbuf_totlen(void)
Get the total length of the header and data in the packetbuf.
Definition: packetbuf.c:167
void tsch_schedule_keepalive(int immediate)
Schedule a keep-alive transmission within [timeout*0.9, timeout[ Can be called from an interrupt...
Definition: tsch.c:334
Radio receiver mode determines if the radio has address filter (RADIO_RX_MODE_ADDRESS_FILTER) and aut...
Definition: radio.h:173
int tsch_queue_update_time_source(const linkaddr_t *new_addr)
Update TSCH time source.
Definition: tsch-queue.c:142
The MAC layer deferred the transmission for a later time.
Definition: mac.h:94
void ctimer_set(struct ctimer *c, clock_time_t t, void(*f)(void *), void *ptr)
Set a callback timer.
Definition: ctimer.c:99
Routing driver header file
Main API declarations for TSCH.
int packetbuf_copyfrom(const void *from, uint16_t len)
Copy from external data into the packetbuf.
Definition: packetbuf.c:84
clock_time_t clock_time(void)
Get the current clock time.
Definition: clock.c:118
#define RTIMER_BUSYWAIT_UNTIL_ABS(cond, t0, max_time)
Busy-wait until a condition.
Definition: rtimer.h:202
int etimer_expired(struct etimer *et)
Check if an event timer has expired.
Definition: etimer.c:213
#define TSCH_ASN_INIT(asn, ms1b_, ls4b_)
Initialize ASN.
Definition: tsch-asn.h:62
void tsch_roots_init(void)
Initialize the list of RPL network roots.
Definition: tsch-roots.c:181
void tsch_security_set_packetbuf_attr(uint8_t frame_type)
Set packetbuf (or eackbuf) attributes depending on a given frame type.
#define RADIO_RX_MODE_ADDRESS_FILTER
Enable address-based frame filtering.
Definition: radio.h:443
uint8_t frame_type
3 bit.
Definition: frame802154.h:153
void tsch_slot_operation_sync(rtimer_clock_t next_slot_start, struct tsch_asn_t *next_slot_asn)
Set global time before starting slot operation, with a rtimer time and an ASN.
Parameters used by the frame802154_create() function.
Definition: frame802154.h:198
void linkaddr_copy(linkaddr_t *dest, const linkaddr_t *src)
Copy a link-layer address.
Definition: linkaddr.c:63
#define PT_THREAD(name_args)
Declaration of a protothread.
Definition: pt.h:265
enum radio_result_e radio_result_t
Radio return values when setting or getting radio parameters.
A timer.
Definition: etimer.h:76
6TiSCH Operation Sublayer (6top) APIs
#define RADIO_TX_MODE_SEND_ON_CCA
Radio TX mode control / retrieval.
Definition: radio.h:466
#define TSCH_ASN_DIFF(asn1, asn2)
Returns the 32-bit diff between asn1 and asn2.
Definition: tsch-asn.h:82
int linkaddr_cmp(const linkaddr_t *addr1, const linkaddr_t *addr2)
Compare two link-layer addresses.
Definition: linkaddr.c:69
void tsch_queue_reset(void)
Reset neighbor queues module.
Definition: tsch-queue.c:380
#define RADIO_RX_MODE_AUTOACK
Enable automatic transmission of ACK frames.
Definition: radio.h:448
void(* send)(mac_callback_t sent_callback, void *ptr)
Send a packet from the packetbuf.
Definition: mac.h:69
int tsch_schedule_remove_all_slotframes(void)
Removes all slotframes, resulting in an empty schedule.
#define RADIO_RX_MODE_POLL_MODE
Enable/disable/get the state of radio driver poll mode operation.
Definition: radio.h:453
int ringbufindex_get(struct ringbufindex *r)
Remove the first element and return its index.
Definition: ringbufindex.c:90
void tsch_disassociate(void)
Leave the TSCH network we are currently in.
Definition: tsch.c:577
void tsch_set_pan_secured(int enable)
Enable/disable security.
Definition: tsch.c:179
void tsch_roots_set_self_to_root(uint8_t is_root)
Set the root status of the local node.
Definition: tsch-roots.c:172
Header file for the Packet buffer (packetbuf) management
Include file for the Contiki low-layer network stack (NETSTACK)
void mac_sequence_register_seqno(void)
Register the sequence number of the packetbuf.
Definition: mac-sequence.c:101
#define PROCESS_PT_SPAWN(pt, thread)
Spawn a protothread from the process.
Definition: process.h:211
int(* max_payload)(void)
Read out estimated max payload size based on payload in packetbuf.
Definition: mac.h:81
void tsch_queue_free_packet(struct tsch_packet *p)
Free a packet.
Definition: tsch-queue.c:314
PROCESS_THREAD(cc2538_rf_process, ev, data)
Implementation of the cc2538 RF driver process.
Definition: cc2538-rf.c:1110
Last packet timestamp, of type rtimer_clock_t.
Definition: radio.h:278
unsigned short random_rand(void)
Generates a new random number using the cc2538 RNG.
Definition: random.c:58
struct tsch_packet * tsch_queue_add_packet(const linkaddr_t *addr, uint8_t max_transmissions, mac_callback_t sent, void *ptr)
Add packet to neighbor queue.
Definition: tsch-queue.c:229
void tsch_adaptive_timesync_reset(void)
Reset the status of the module.
Stores data about an incoming packet.
Definition: tsch-types.h:149
void etimer_reset(struct etimer *et)
Reset an event timer with the same interval as was previously set.
Definition: etimer.c:192
Header file for the logging system
void tsch_slot_operation_start(void)
Start actual slot operation.
int tsch_packet_parse_eb(const uint8_t *buf, int buf_size, frame802154_t *frame, struct ieee802154_ies *ies, uint8_t *hdr_len, int frame_without_mic)
Parse EB.
Definition: tsch-packet.c:387
void etimer_set(struct etimer *et, clock_time_t interval)
Set an event timer.
Definition: etimer.c:177
The ASN is an absolute slot number over 5 bytes.
Definition: tsch-asn.h:48
void tsch_schedule_create_minimal(void)
Create a 6tisch minimal schedule with length TSCH_SCHEDULE_DEFAULT_LENGTH.
#define PROCESS_WAIT_UNTIL(c)
Wait for a condition to occur.
Definition: process.h:192
void tsch_set_coordinator(int enable)
Set the node as PAN coordinator.
Definition: tsch.c:168
void process_start(struct process *p, process_data_t data)
Start a process.
Definition: process.c:99
The MAC layer transmission could not be performed because of an error.
Definition: mac.h:97