Contiki-NG
tsch-slot-operation.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  * TSCH slot operation implementation, running from interrupt.
36  * \author
37  * Simon Duquennoy <simonduq@sics.se>
38  * Beshr Al Nahas <beshr@sics.se>
39  * Atis Elsts <atis.elsts@bristol.ac.uk>
40  *
41  */
42 
43 /**
44  * \addtogroup tsch
45  * @{
46 */
47 
48 #include "dev/radio.h"
49 #include "contiki.h"
50 #include "net/netstack.h"
51 #include "net/packetbuf.h"
52 #include "net/queuebuf.h"
54 #include "net/mac/tsch/tsch.h"
55 #include "sys/critical.h"
56 
57 #include "sys/log.h"
58 /* TSCH debug macros, i.e. to set LEDs or GPIOs on various TSCH
59  * timeslot events */
60 #ifndef TSCH_DEBUG_INIT
61 #define TSCH_DEBUG_INIT()
62 #endif
63 #ifndef TSCH_DEBUG_INTERRUPT
64 #define TSCH_DEBUG_INTERRUPT()
65 #endif
66 #ifndef TSCH_DEBUG_RX_EVENT
67 #define TSCH_DEBUG_RX_EVENT()
68 #endif
69 #ifndef TSCH_DEBUG_TX_EVENT
70 #define TSCH_DEBUG_TX_EVENT()
71 #endif
72 #ifndef TSCH_DEBUG_SLOT_START
73 #define TSCH_DEBUG_SLOT_START()
74 #endif
75 #ifndef TSCH_DEBUG_SLOT_END
76 #define TSCH_DEBUG_SLOT_END()
77 #endif
78 
79 /* Check if TSCH_MAX_INCOMING_PACKETS is power of two */
80 #if (TSCH_MAX_INCOMING_PACKETS & (TSCH_MAX_INCOMING_PACKETS - 1)) != 0
81 #error TSCH_MAX_INCOMING_PACKETS must be power of two
82 #endif
83 
84 /* Check if TSCH_DEQUEUED_ARRAY_SIZE is power of two and greater or equal to QUEUEBUF_NUM */
85 #if TSCH_DEQUEUED_ARRAY_SIZE < QUEUEBUF_NUM
86 #error TSCH_DEQUEUED_ARRAY_SIZE must be greater or equal to QUEUEBUF_NUM
87 #endif
88 #if (TSCH_DEQUEUED_ARRAY_SIZE & (TSCH_DEQUEUED_ARRAY_SIZE - 1)) != 0
89 #error TSCH_DEQUEUED_ARRAY_SIZE must be power of two
90 #endif
91 
92 /* Truncate received drift correction information to maximum half
93  * of the guard time (one fourth of TSCH_DEFAULT_TS_RX_WAIT) */
94 #define SYNC_IE_BOUND ((int32_t)US_TO_RTIMERTICKS(tsch_timing_us[tsch_ts_rx_wait] / 4))
95 
96 /* By default: check that rtimer runs at >=32kHz and use a guard time of 10us */
97 #if RTIMER_SECOND < (32 * 1024)
98 #error "TSCH: RTIMER_SECOND < (32 * 1024)"
99 #endif
100 #if CONTIKI_TARGET_COOJA
101 /* Use 0 usec guard time for Cooja Mote with a 1 MHz Rtimer*/
102 #define RTIMER_GUARD 0u
103 #elif RTIMER_SECOND >= 200000
104 #define RTIMER_GUARD (RTIMER_SECOND / 100000)
105 #else
106 #define RTIMER_GUARD 2u
107 #endif
108 
109 enum tsch_radio_state_on_cmd {
110  TSCH_RADIO_CMD_ON_START_OF_TIMESLOT,
111  TSCH_RADIO_CMD_ON_WITHIN_TIMESLOT,
112  TSCH_RADIO_CMD_ON_FORCE,
113 };
114 
115 enum tsch_radio_state_off_cmd {
116  TSCH_RADIO_CMD_OFF_END_OF_TIMESLOT,
117  TSCH_RADIO_CMD_OFF_WITHIN_TIMESLOT,
118  TSCH_RADIO_CMD_OFF_FORCE,
119 };
120 
121 /* A ringbuf storing outgoing packets after they were dequeued.
122  * Will be processed layer by tsch_tx_process_pending */
123 struct ringbufindex dequeued_ringbuf;
124 struct tsch_packet *dequeued_array[TSCH_DEQUEUED_ARRAY_SIZE];
125 /* A ringbuf storing incoming packets.
126  * Will be processed layer by tsch_rx_process_pending */
127 struct ringbufindex input_ringbuf;
128 struct input_packet input_array[TSCH_MAX_INCOMING_PACKETS];
129 
130 /* Updates and reads of the next two variables must be atomic (i.e. both together) */
131 /* Last time we received Sync-IE (ACK or data packet from a time source) */
132 static struct tsch_asn_t last_sync_asn;
133 clock_time_t tsch_last_sync_time; /* Same info, in clock_time_t units */
134 
135 /* A global lock for manipulating data structures safely from outside of interrupt */
136 static volatile int tsch_locked = 0;
137 /* As long as this is set, skip all slot operation */
138 static volatile int tsch_lock_requested = 0;
139 
140 /* Last estimated drift in RTIMER ticks
141  * (Sky: 1 tick = 30.517578125 usec exactly) */
142 static int32_t drift_correction = 0;
143 /* Is drift correction used? (Can be true even if drift_correction == 0) */
144 static uint8_t is_drift_correction_used;
145 
146 /* The neighbor last used as our time source */
148 
149 /* Used from tsch_slot_operation and sub-protothreads */
150 static rtimer_clock_t volatile current_slot_start;
151 
152 /* Are we currently inside a slot? */
153 static volatile int tsch_in_slot_operation = 0;
154 
155 /* If we are inside a slot, this tells the current channel */
156 uint8_t tsch_current_channel;
157 
158 /* Info about the link, packet and neighbor of
159  * the current (or next) slot */
160 struct tsch_link *current_link = NULL;
161 /* A backup link with Rx flag, overlapping with current_link.
162  * If the current link is Tx-only and the Tx queue
163  * is empty while executing the link, fallback to the backup link. */
164 static struct tsch_link *backup_link = NULL;
165 static struct tsch_packet *current_packet = NULL;
166 static struct tsch_neighbor *current_neighbor = NULL;
167 
168 /* Indicates whether an extra link is needed to handle the current burst */
169 static int burst_link_scheduled = 0;
170 /* Counts the length of the current burst */
171 int tsch_current_burst_count = 0;
172 
173 /* Protothread for association */
174 PT_THREAD(tsch_scan(struct pt *pt));
175 /* Protothread for slot operation, called from rtimer interrupt
176  * and scheduled from tsch_schedule_slot_operation */
177 static PT_THREAD(tsch_slot_operation(struct rtimer *t, void *ptr));
178 static struct pt slot_operation_pt;
179 /* Sub-protothreads of tsch_slot_operation */
180 static PT_THREAD(tsch_tx_slot(struct pt *pt, struct rtimer *t));
181 static PT_THREAD(tsch_rx_slot(struct pt *pt, struct rtimer *t));
182 
183 /*---------------------------------------------------------------------------*/
184 /* TSCH locking system. TSCH is locked during slot operations */
185 
186 /* Is TSCH locked? */
187 int
189 {
190  return tsch_locked;
191 }
192 
193 /* Lock TSCH (no slot operation) */
194 int
196 {
197  if(!tsch_locked) {
198  rtimer_clock_t busy_wait_time;
199  int busy_wait = 0; /* Flag used for logging purposes */
200  /* Make sure no new slot operation will start */
201  tsch_lock_requested = 1;
202  /* Wait for the end of current slot operation. */
203  if(tsch_in_slot_operation) {
204  busy_wait = 1;
205  busy_wait_time = RTIMER_NOW();
206  while(tsch_in_slot_operation) {
208  }
209  busy_wait_time = RTIMER_NOW() - busy_wait_time;
210  }
211  if(!tsch_locked) {
212  /* Take the lock if it is free */
213  tsch_locked = 1;
214  tsch_lock_requested = 0;
215  if(busy_wait) {
216  /* Issue a log whenever we had to busy wait until getting the lock */
217  TSCH_LOG_ADD(tsch_log_message,
218  snprintf(log->message, sizeof(log->message),
219  "!get lock delay %u", (unsigned)busy_wait_time);
220  );
221  }
222  return 1;
223  }
224  }
225  TSCH_LOG_ADD(tsch_log_message,
226  snprintf(log->message, sizeof(log->message),
227  "!failed to lock");
228  );
229  return 0;
230 }
231 
232 /* Release TSCH lock */
233 void
235 {
236  tsch_locked = 0;
237 }
238 
239 /*---------------------------------------------------------------------------*/
240 /* Channel hopping utility functions */
241 
242 /* Return channel from ASN and channel offset */
243 uint8_t
244 tsch_calculate_channel(struct tsch_asn_t *asn, uint8_t channel_offset)
245 {
246  uint16_t index_of_0 = TSCH_ASN_MOD(*asn, tsch_hopping_sequence_length);
247  uint16_t index_of_offset = (index_of_0 + channel_offset) % tsch_hopping_sequence_length.val;
248  return tsch_hopping_sequence[index_of_offset];
249 }
250 
251 /*---------------------------------------------------------------------------*/
252 /* Timing utility functions */
253 
254 /* Checks if the current time has passed a ref time + offset. Assumes
255  * a single overflow and ref time prior to now. */
256 static uint8_t
257 check_timer_miss(rtimer_clock_t ref_time, rtimer_clock_t offset, rtimer_clock_t now)
258 {
259  rtimer_clock_t target = ref_time + offset;
260  int now_has_overflowed = now < ref_time;
261  int target_has_overflowed = target < ref_time;
262 
263  if(now_has_overflowed == target_has_overflowed) {
264  /* Both or none have overflowed, just compare now to the target */
265  return target <= now;
266  } else {
267  /* Either now or target of overflowed.
268  * If it is now, then it has passed the target.
269  * If it is target, then we haven't reached it yet.
270  * */
271  return now_has_overflowed;
272  }
273 }
274 /*---------------------------------------------------------------------------*/
275 /* Schedule a wakeup at a specified offset from a reference time.
276  * Provides basic protection against missed deadlines and timer overflows
277  * A return value of zero signals a missed deadline: no rtimer was scheduled. */
278 static uint8_t
279 tsch_schedule_slot_operation(struct rtimer *tm, rtimer_clock_t ref_time, rtimer_clock_t offset, const char *str)
280 {
281  rtimer_clock_t now = RTIMER_NOW();
282  int r;
283  /* Subtract RTIMER_GUARD before checking for deadline miss
284  * because we can not schedule rtimer less than RTIMER_GUARD in the future */
285  int missed = check_timer_miss(ref_time, offset - RTIMER_GUARD, now);
286 
287  if(missed) {
288  TSCH_LOG_ADD(tsch_log_message,
289  snprintf(log->message, sizeof(log->message),
290  "!dl-miss %s %d %d",
291  str, (int)(now-ref_time), (int)offset);
292  );
293  } else {
294  r = rtimer_set(tm, ref_time + offset, 1, (void (*)(struct rtimer *, void *))tsch_slot_operation, NULL);
295  if(r == RTIMER_OK) {
296  return 1;
297  }
298  }
299 
300  /* block until the time to schedule comes */
301  RTIMER_BUSYWAIT_UNTIL_ABS(0, ref_time, offset);
302  return 0;
303 }
304 /*---------------------------------------------------------------------------*/
305 /* Schedule slot operation conditionally, and YIELD if success only.
306  * Always attempt to schedule RTIMER_GUARD before the target to make sure to wake up
307  * ahead of time and then busy wait to exactly hit the target. */
308 #define TSCH_SCHEDULE_AND_YIELD(pt, tm, ref_time, offset, str) \
309  do { \
310  if(tsch_schedule_slot_operation(tm, ref_time, offset - RTIMER_GUARD, str)) { \
311  PT_YIELD(pt); \
312  RTIMER_BUSYWAIT_UNTIL_ABS(0, ref_time, offset); \
313  } \
314  } while(0);
315 /*---------------------------------------------------------------------------*/
316 /* Get EB, broadcast or unicast packet to be sent, and target neighbor. */
317 static struct tsch_packet *
318 get_packet_and_neighbor_for_link(struct tsch_link *link, struct tsch_neighbor **target_neighbor)
319 {
320  struct tsch_packet *p = NULL;
321  struct tsch_neighbor *n = NULL;
322 
323  /* Is this a Tx link? */
324  if(link->link_options & LINK_OPTION_TX) {
325  /* is it for advertisement of EB? */
326  if(link->link_type == LINK_TYPE_ADVERTISING || link->link_type == LINK_TYPE_ADVERTISING_ONLY) {
327  /* fetch EB packets */
328  n = n_eb;
329  p = tsch_queue_get_packet_for_nbr(n, link);
330  }
331  if(link->link_type != LINK_TYPE_ADVERTISING_ONLY) {
332  /* NORMAL link or no EB to send, pick a data packet */
333  if(p == NULL) {
334  /* Get neighbor queue associated to the link and get packet from it */
335  n = tsch_queue_get_nbr(&link->addr);
336  p = tsch_queue_get_packet_for_nbr(n, link);
337  /* if it is a broadcast slot and there were no broadcast packets, pick any unicast packet */
338  if(p == NULL && n == n_broadcast) {
340  }
341  }
342  }
343  }
344  /* return nbr (by reference) */
345  if(target_neighbor != NULL) {
346  *target_neighbor = n;
347  }
348 
349  return p;
350 }
351 /*---------------------------------------------------------------------------*/
352 uint64_t
354 {
355  uint64_t uptime_asn;
356  uint64_t uptime_ticks;
357  int_master_status_t status;
358 
359  if(!tsch_is_associated) {
360  /* not associated, network uptime is not known */
361  return (uint64_t)-1;
362  }
363 
364  status = critical_enter();
365 
366  uptime_asn = last_sync_asn.ls4b + ((uint64_t)last_sync_asn.ms1b << 32);
367  /* first calculate the at the uptime at the last sync in rtimer ticks */
368  uptime_ticks = uptime_asn * tsch_timing[tsch_ts_timeslot_length];
369  /* then convert to clock ticks (assume that CLOCK_SECOND divides RTIMER_ARCH_SECOND) */
370  uptime_ticks /= (RTIMER_ARCH_SECOND / CLOCK_SECOND);
371  /* then add the ticks passed since the last timesync */
372  uptime_ticks += (clock_time() - tsch_last_sync_time);
373 
374  critical_exit(status);
375 
376  return uptime_ticks;
377 }
378 /*---------------------------------------------------------------------------*/
379 /**
380  * This function turns on the radio. Its semantics is dependent on
381  * the value of TSCH_RADIO_ON_DURING_TIMESLOT constant:
382  * - if enabled, the radio is turned on at the start of the slot
383  * - if disabled, the radio is turned on within the slot,
384  * directly before the packet Rx guard time and ACK Rx guard time.
385  */
386 static void
387 tsch_radio_on(enum tsch_radio_state_on_cmd command)
388 {
389  int do_it = 0;
390  switch(command) {
391  case TSCH_RADIO_CMD_ON_START_OF_TIMESLOT:
392  if(TSCH_RADIO_ON_DURING_TIMESLOT) {
393  do_it = 1;
394  }
395  break;
396  case TSCH_RADIO_CMD_ON_WITHIN_TIMESLOT:
397  if(!TSCH_RADIO_ON_DURING_TIMESLOT) {
398  do_it = 1;
399  }
400  break;
401  case TSCH_RADIO_CMD_ON_FORCE:
402  do_it = 1;
403  break;
404  }
405  if(do_it) {
406  NETSTACK_RADIO.on();
407  }
408 }
409 /*---------------------------------------------------------------------------*/
410 /**
411  * This function turns off the radio. In the same way as for tsch_radio_on(),
412  * it depends on the value of TSCH_RADIO_ON_DURING_TIMESLOT constant:
413  * - if enabled, the radio is turned off at the end of the slot
414  * - if disabled, the radio is turned off within the slot,
415  * directly after Tx'ing or Rx'ing a packet or Tx'ing an ACK.
416  */
417 static void
418 tsch_radio_off(enum tsch_radio_state_off_cmd command)
419 {
420  int do_it = 0;
421  switch(command) {
422  case TSCH_RADIO_CMD_OFF_END_OF_TIMESLOT:
423  if(TSCH_RADIO_ON_DURING_TIMESLOT) {
424  do_it = 1;
425  }
426  break;
427  case TSCH_RADIO_CMD_OFF_WITHIN_TIMESLOT:
428  if(!TSCH_RADIO_ON_DURING_TIMESLOT) {
429  do_it = 1;
430  }
431  break;
432  case TSCH_RADIO_CMD_OFF_FORCE:
433  do_it = 1;
434  break;
435  }
436  if(do_it) {
437  NETSTACK_RADIO.off();
438  }
439 }
440 /*---------------------------------------------------------------------------*/
441 static
442 PT_THREAD(tsch_tx_slot(struct pt *pt, struct rtimer *t))
443 {
444  /**
445  * TX slot:
446  * 1. Copy packet to radio buffer
447  * 2. Perform CCA if enabled
448  * 3. Sleep until it is time to transmit
449  * 4. Wait for ACK if it is a unicast packet
450  * 5. Extract drift if we received an E-ACK from a time source neighbor
451  * 6. Update CSMA parameters according to TX status
452  * 7. Schedule mac_call_sent_callback
453  **/
454 
455  /* tx status */
456  static uint8_t mac_tx_status;
457  /* is the packet in its neighbor's queue? */
458  uint8_t in_queue;
459  static int dequeued_index;
460  static int packet_ready = 1;
461 
462  PT_BEGIN(pt);
463 
464  TSCH_DEBUG_TX_EVENT();
465 
466  /* First check if we have space to store a newly dequeued packet (in case of
467  * successful Tx or Drop) */
468  dequeued_index = ringbufindex_peek_put(&dequeued_ringbuf);
469  if(dequeued_index != -1) {
470  if(current_packet == NULL || current_packet->qb == NULL) {
471  mac_tx_status = MAC_TX_ERR_FATAL;
472  } else {
473  /* packet payload */
474  static void *packet;
475 #if LLSEC802154_ENABLED
476  /* encrypted payload */
477  static uint8_t encrypted_packet[TSCH_PACKET_MAX_LEN];
478 #endif /* LLSEC802154_ENABLED */
479  /* packet payload length */
480  static uint8_t packet_len;
481  /* packet seqno */
482  static uint8_t seqno;
483  /* is this a broadcast packet? (wait for ack?) */
484  static uint8_t is_broadcast;
485  static rtimer_clock_t tx_start_time;
486  /* Did we set the frame pending bit to request an extra burst link? */
487  static int burst_link_requested;
488 
489 #if TSCH_CCA_ENABLED
490  static uint8_t cca_status;
491 #endif /* TSCH_CCA_ENABLED */
492 
493  /* get payload */
494  packet = queuebuf_dataptr(current_packet->qb);
495  packet_len = queuebuf_datalen(current_packet->qb);
496  /* is this a broadcast packet? (wait for ack?) */
497  is_broadcast = current_neighbor->is_broadcast;
498  /* Unicast. More packets in queue for the neighbor? */
499  burst_link_requested = 0;
500  if(!is_broadcast
501  && tsch_current_burst_count + 1 < TSCH_BURST_MAX_LEN
502  && tsch_queue_packet_count(&current_neighbor->addr) > 1) {
503  burst_link_requested = 1;
504  tsch_packet_set_frame_pending(packet, packet_len);
505  }
506  /* read seqno from payload */
507  seqno = ((uint8_t *)(packet))[2];
508  /* if this is an EB, then update its Sync-IE */
509  if(current_neighbor == n_eb) {
510  packet_ready = tsch_packet_update_eb(packet, packet_len, current_packet->tsch_sync_ie_offset);
511  } else {
512  packet_ready = 1;
513  }
514 
515 #if LLSEC802154_ENABLED
516  if(tsch_is_pan_secured) {
517  /* If we are going to encrypt, we need to generate the output in a separate buffer and keep
518  * the original untouched. This is to allow for future retransmissions. */
519  int with_encryption = queuebuf_attr(current_packet->qb, PACKETBUF_ATTR_SECURITY_LEVEL) & 0x4;
520  packet_len += tsch_security_secure_frame(packet, with_encryption ? encrypted_packet : packet, current_packet->header_len,
521  packet_len - current_packet->header_len, &tsch_current_asn);
522  if(with_encryption) {
523  packet = encrypted_packet;
524  }
525  }
526 #endif /* LLSEC802154_ENABLED */
527 
528  /* prepare packet to send: copy to radio buffer */
529  if(packet_ready && NETSTACK_RADIO.prepare(packet, packet_len) == 0) { /* 0 means success */
530  static rtimer_clock_t tx_duration;
531 
532 #if TSCH_CCA_ENABLED
533  cca_status = 1;
534  /* delay before CCA */
535  TSCH_SCHEDULE_AND_YIELD(pt, t, current_slot_start, tsch_timing[tsch_ts_cca_offset], "cca");
536  TSCH_DEBUG_TX_EVENT();
537  tsch_radio_on(TSCH_RADIO_CMD_ON_WITHIN_TIMESLOT);
538  /* CCA */
539  RTIMER_BUSYWAIT_UNTIL_ABS(!(cca_status &= NETSTACK_RADIO.channel_clear()),
540  current_slot_start, tsch_timing[tsch_ts_cca_offset] + tsch_timing[tsch_ts_cca]);
541  TSCH_DEBUG_TX_EVENT();
542  /* there is not enough time to turn radio off */
543  /* NETSTACK_RADIO.off(); */
544  if(cca_status == 0) {
545  mac_tx_status = MAC_TX_COLLISION;
546  } else
547 #endif /* TSCH_CCA_ENABLED */
548  {
549  /* delay before TX */
550  TSCH_SCHEDULE_AND_YIELD(pt, t, current_slot_start, tsch_timing[tsch_ts_tx_offset] - RADIO_DELAY_BEFORE_TX, "TxBeforeTx");
551  TSCH_DEBUG_TX_EVENT();
552  /* send packet already in radio tx buffer */
553  mac_tx_status = NETSTACK_RADIO.transmit(packet_len);
554  tx_count++;
555  /* Save tx timestamp */
556  tx_start_time = current_slot_start + tsch_timing[tsch_ts_tx_offset];
557  /* calculate TX duration based on sent packet len */
558  tx_duration = TSCH_PACKET_DURATION(packet_len);
559  /* limit tx_time to its max value */
560  tx_duration = MIN(tx_duration, tsch_timing[tsch_ts_max_tx]);
561  /* turn tadio off -- will turn on again to wait for ACK if needed */
562  tsch_radio_off(TSCH_RADIO_CMD_OFF_WITHIN_TIMESLOT);
563 
564  if(mac_tx_status == RADIO_TX_OK) {
565  if(!is_broadcast) {
566  uint8_t ackbuf[TSCH_PACKET_MAX_LEN];
567  int ack_len;
568  rtimer_clock_t ack_start_time;
569  int is_time_source;
570  struct ieee802154_ies ack_ies;
571  uint8_t ack_hdrlen;
572  frame802154_t frame;
573 
574 #if TSCH_HW_FRAME_FILTERING
575  radio_value_t radio_rx_mode;
576  /* Entering promiscuous mode so that the radio accepts the enhanced ACK */
577  NETSTACK_RADIO.get_value(RADIO_PARAM_RX_MODE, &radio_rx_mode);
578  NETSTACK_RADIO.set_value(RADIO_PARAM_RX_MODE, radio_rx_mode & (~RADIO_RX_MODE_ADDRESS_FILTER));
579 #endif /* TSCH_HW_FRAME_FILTERING */
580  /* Unicast: wait for ack after tx: sleep until ack time */
581  TSCH_SCHEDULE_AND_YIELD(pt, t, current_slot_start,
582  tsch_timing[tsch_ts_tx_offset] + tx_duration + tsch_timing[tsch_ts_rx_ack_delay] - RADIO_DELAY_BEFORE_RX, "TxBeforeAck");
583  TSCH_DEBUG_TX_EVENT();
584  tsch_radio_on(TSCH_RADIO_CMD_ON_WITHIN_TIMESLOT);
585  /* Wait for ACK to come */
586  RTIMER_BUSYWAIT_UNTIL_ABS(NETSTACK_RADIO.receiving_packet(),
587  tx_start_time, tx_duration + tsch_timing[tsch_ts_rx_ack_delay] + tsch_timing[tsch_ts_ack_wait] + RADIO_DELAY_BEFORE_DETECT);
588  TSCH_DEBUG_TX_EVENT();
589 
590  ack_start_time = RTIMER_NOW() - RADIO_DELAY_BEFORE_DETECT;
591 
592  /* Wait for ACK to finish */
593  RTIMER_BUSYWAIT_UNTIL_ABS(!NETSTACK_RADIO.receiving_packet(),
594  ack_start_time, tsch_timing[tsch_ts_max_ack]);
595  TSCH_DEBUG_TX_EVENT();
596  tsch_radio_off(TSCH_RADIO_CMD_OFF_WITHIN_TIMESLOT);
597 
598 #if TSCH_HW_FRAME_FILTERING
599  /* Leaving promiscuous mode */
600  NETSTACK_RADIO.get_value(RADIO_PARAM_RX_MODE, &radio_rx_mode);
601  NETSTACK_RADIO.set_value(RADIO_PARAM_RX_MODE, radio_rx_mode | RADIO_RX_MODE_ADDRESS_FILTER);
602 #endif /* TSCH_HW_FRAME_FILTERING */
603 
604  /* Read ack frame */
605  ack_len = NETSTACK_RADIO.read((void *)ackbuf, sizeof(ackbuf));
606 
607  is_time_source = 0;
608  /* The radio driver should return 0 if no valid packets are in the rx buffer */
609  if(ack_len > 0) {
610  is_time_source = current_neighbor != NULL && current_neighbor->is_time_source;
611  if(tsch_packet_parse_eack(ackbuf, ack_len, seqno,
612  &frame, &ack_ies, &ack_hdrlen) == 0) {
613  ack_len = 0;
614  }
615 
616 #if LLSEC802154_ENABLED
617  if(ack_len != 0) {
618  if(!tsch_security_parse_frame(ackbuf, ack_hdrlen, ack_len - ack_hdrlen - tsch_security_mic_len(&frame),
619  &frame, &current_neighbor->addr, &tsch_current_asn)) {
620  TSCH_LOG_ADD(tsch_log_message,
621  snprintf(log->message, sizeof(log->message),
622  "!failed to authenticate ACK"));
623  ack_len = 0;
624  }
625  } else {
626  TSCH_LOG_ADD(tsch_log_message,
627  snprintf(log->message, sizeof(log->message),
628  "!failed to parse ACK"));
629  }
630 #endif /* LLSEC802154_ENABLED */
631  }
632 
633  if(ack_len != 0) {
634  if(is_time_source) {
635  int32_t eack_time_correction = US_TO_RTIMERTICKS(ack_ies.ie_time_correction);
636  int32_t since_last_timesync = TSCH_ASN_DIFF(tsch_current_asn, last_sync_asn);
637  if(eack_time_correction > SYNC_IE_BOUND) {
638  drift_correction = SYNC_IE_BOUND;
639  } else if(eack_time_correction < -SYNC_IE_BOUND) {
640  drift_correction = -SYNC_IE_BOUND;
641  } else {
642  drift_correction = eack_time_correction;
643  }
644  if(drift_correction != eack_time_correction) {
645  TSCH_LOG_ADD(tsch_log_message,
646  snprintf(log->message, sizeof(log->message),
647  "!truncated dr %d %d", (int)eack_time_correction, (int)drift_correction);
648  );
649  }
650  tsch_stats_on_time_synchronization(eack_time_correction);
651  is_drift_correction_used = 1;
652  tsch_timesync_update(current_neighbor, since_last_timesync, drift_correction);
653  /* Keep track of sync time */
654  last_sync_asn = tsch_current_asn;
655  tsch_last_sync_time = clock_time();
657  }
658  mac_tx_status = MAC_TX_OK;
659 
660  /* We requested an extra slot and got an ack. This means
661  the extra slot will be scheduled at the received */
662  if(burst_link_requested) {
663  burst_link_scheduled = 1;
664  }
665  } else {
666  mac_tx_status = MAC_TX_NOACK;
667  }
668  } else {
669  mac_tx_status = MAC_TX_OK;
670  }
671  } else {
672  mac_tx_status = MAC_TX_ERR;
673  }
674  }
675  } else {
676  mac_tx_status = MAC_TX_ERR;
677  }
678  }
679 
680  tsch_radio_off(TSCH_RADIO_CMD_OFF_END_OF_TIMESLOT);
681 
682  current_packet->transmissions++;
683  current_packet->ret = mac_tx_status;
684 
685  /* Post TX: Update neighbor queue state */
686  in_queue = tsch_queue_packet_sent(current_neighbor, current_packet, current_link, mac_tx_status);
687 
688  /* The packet was dequeued, add it to dequeued_ringbuf for later processing */
689  if(in_queue == 0) {
690  dequeued_array[dequeued_index] = current_packet;
691  ringbufindex_put(&dequeued_ringbuf);
692  }
693 
694  /* If this is an unicast packet to timesource, update stats */
695  if(current_neighbor != NULL && current_neighbor->is_time_source) {
696  tsch_stats_tx_packet(current_neighbor, mac_tx_status, tsch_current_channel);
697  }
698 
699  /* Log every tx attempt */
700  TSCH_LOG_ADD(tsch_log_tx,
701  log->tx.mac_tx_status = mac_tx_status;
702  log->tx.num_tx = current_packet->transmissions;
703  log->tx.datalen = queuebuf_datalen(current_packet->qb);
704  log->tx.drift = drift_correction;
705  log->tx.drift_used = is_drift_correction_used;
706  log->tx.is_data = ((((uint8_t *)(queuebuf_dataptr(current_packet->qb)))[0]) & 7) == FRAME802154_DATAFRAME;
707 #if LLSEC802154_ENABLED
708  log->tx.sec_level = queuebuf_attr(current_packet->qb, PACKETBUF_ATTR_SECURITY_LEVEL);
709 #else /* LLSEC802154_ENABLED */
710  log->tx.sec_level = 0;
711 #endif /* LLSEC802154_ENABLED */
712  linkaddr_copy(&log->tx.dest, queuebuf_addr(current_packet->qb, PACKETBUF_ADDR_RECEIVER));
713  log->tx.seqno = queuebuf_attr(current_packet->qb, PACKETBUF_ATTR_MAC_SEQNO);
714  );
715 
716  /* Poll process for later processing of packet sent events and logs */
717  process_poll(&tsch_pending_events_process);
718  }
719 
720  TSCH_DEBUG_TX_EVENT();
721 
722  PT_END(pt);
723 }
724 /*---------------------------------------------------------------------------*/
725 static
726 PT_THREAD(tsch_rx_slot(struct pt *pt, struct rtimer *t))
727 {
728  /**
729  * RX slot:
730  * 1. Check if it is used for TIME_KEEPING
731  * 2. Sleep and wake up just before expected RX time (with a guard time: TS_LONG_GT)
732  * 3. Check for radio activity for the guard time: TS_LONG_GT
733  * 4. Prepare and send ACK if needed
734  * 5. Drift calculated in the ACK callback registered with the radio driver. Use it if receiving from a time source neighbor.
735  **/
736 
737  struct tsch_neighbor *n;
738  static linkaddr_t source_address;
739  static linkaddr_t destination_address;
740  static int16_t input_index;
741  static int input_queue_drop = 0;
742 
743  PT_BEGIN(pt);
744 
745  TSCH_DEBUG_RX_EVENT();
746 
747  input_index = ringbufindex_peek_put(&input_ringbuf);
748  if(input_index == -1) {
749  input_queue_drop++;
750  } else {
751  static struct input_packet *current_input;
752  /* Estimated drift based on RX time */
753  static int32_t estimated_drift;
754  /* Rx timestamps */
755  static rtimer_clock_t rx_start_time;
756  static rtimer_clock_t expected_rx_time;
757  static rtimer_clock_t packet_duration;
758  uint8_t packet_seen;
759 
760  expected_rx_time = current_slot_start + tsch_timing[tsch_ts_tx_offset];
761  /* Default start time: expected Rx time */
762  rx_start_time = expected_rx_time;
763 
764  current_input = &input_array[input_index];
765 
766  /* Wait before starting to listen */
767  TSCH_SCHEDULE_AND_YIELD(pt, t, current_slot_start, tsch_timing[tsch_ts_rx_offset] - RADIO_DELAY_BEFORE_RX, "RxBeforeListen");
768  TSCH_DEBUG_RX_EVENT();
769 
770  /* Start radio for at least guard time */
771  tsch_radio_on(TSCH_RADIO_CMD_ON_WITHIN_TIMESLOT);
772  packet_seen = NETSTACK_RADIO.receiving_packet() || NETSTACK_RADIO.pending_packet();
773  if(!packet_seen) {
774  /* Check if receiving within guard time */
775  RTIMER_BUSYWAIT_UNTIL_ABS((packet_seen = NETSTACK_RADIO.receiving_packet()),
776  current_slot_start, tsch_timing[tsch_ts_rx_offset] + tsch_timing[tsch_ts_rx_wait] + RADIO_DELAY_BEFORE_DETECT);
777  }
778  if(!packet_seen) {
779  /* no packets on air */
780  tsch_radio_off(TSCH_RADIO_CMD_OFF_FORCE);
781  } else {
782  TSCH_DEBUG_RX_EVENT();
783  /* Save packet timestamp */
784  rx_start_time = RTIMER_NOW() - RADIO_DELAY_BEFORE_DETECT;
785 
786  /* Wait until packet is received, turn radio off */
787  RTIMER_BUSYWAIT_UNTIL_ABS(!NETSTACK_RADIO.receiving_packet(),
788  current_slot_start, tsch_timing[tsch_ts_rx_offset] + tsch_timing[tsch_ts_rx_wait] + tsch_timing[tsch_ts_max_tx]);
789  TSCH_DEBUG_RX_EVENT();
790  tsch_radio_off(TSCH_RADIO_CMD_OFF_WITHIN_TIMESLOT);
791 
792  if(NETSTACK_RADIO.pending_packet()) {
793  static int frame_valid;
794  static int header_len;
795  static frame802154_t frame;
796  radio_value_t radio_last_rssi;
797  radio_value_t radio_last_lqi;
798 
799  /* Read packet */
800  current_input->len = NETSTACK_RADIO.read((void *)current_input->payload, TSCH_PACKET_MAX_LEN);
801  NETSTACK_RADIO.get_value(RADIO_PARAM_LAST_RSSI, &radio_last_rssi);
802  current_input->rx_asn = tsch_current_asn;
803  current_input->rssi = (signed)radio_last_rssi;
804  current_input->channel = tsch_current_channel;
805  header_len = frame802154_parse((uint8_t *)current_input->payload, current_input->len, &frame);
806  frame_valid = header_len > 0 &&
807  frame802154_check_dest_panid(&frame) &&
808  frame802154_extract_linkaddr(&frame, &source_address, &destination_address);
809 
810 #if TSCH_RESYNC_WITH_SFD_TIMESTAMPS
811  /* At the end of the reception, get an more accurate estimate of SFD arrival time */
812  NETSTACK_RADIO.get_object(RADIO_PARAM_LAST_PACKET_TIMESTAMP, &rx_start_time, sizeof(rtimer_clock_t));
813 #endif
814 
815  packet_duration = TSCH_PACKET_DURATION(current_input->len);
816  /* limit packet_duration to its max value */
817  packet_duration = MIN(packet_duration, tsch_timing[tsch_ts_max_tx]);
818 
819  if(!frame_valid) {
820  TSCH_LOG_ADD(tsch_log_message,
821  snprintf(log->message, sizeof(log->message),
822  "!failed to parse frame %u %u", header_len, current_input->len));
823  }
824 
825  if(frame_valid) {
826  if(frame.fcf.frame_type != FRAME802154_DATAFRAME
827  && frame.fcf.frame_type != FRAME802154_BEACONFRAME) {
828  TSCH_LOG_ADD(tsch_log_message,
829  snprintf(log->message, sizeof(log->message),
830  "!discarding frame with type %u, len %u", frame.fcf.frame_type, current_input->len));
831  frame_valid = 0;
832  }
833  }
834 
835 #if LLSEC802154_ENABLED
836  /* Decrypt and verify incoming frame */
837  if(frame_valid) {
839  current_input->payload, header_len, current_input->len - header_len - tsch_security_mic_len(&frame),
840  &frame, &source_address, &tsch_current_asn)) {
841  current_input->len -= tsch_security_mic_len(&frame);
842  } else {
843  TSCH_LOG_ADD(tsch_log_message,
844  snprintf(log->message, sizeof(log->message),
845  "!failed to authenticate frame %u", current_input->len));
846  frame_valid = 0;
847  }
848  }
849 #endif /* LLSEC802154_ENABLED */
850 
851  if(frame_valid) {
852  /* Check that frome is for us or broadcast, AND that it is not from
853  * ourselves. This is for consistency with CSMA and to avoid adding
854  * ourselves to neighbor tables in case frames are being replayed. */
855  if((linkaddr_cmp(&destination_address, &linkaddr_node_addr)
856  || linkaddr_cmp(&destination_address, &linkaddr_null))
857  && !linkaddr_cmp(&source_address, &linkaddr_node_addr)) {
858  int do_nack = 0;
859  rx_count++;
860  estimated_drift = RTIMER_CLOCK_DIFF(expected_rx_time, rx_start_time);
861  tsch_stats_on_time_synchronization(estimated_drift);
862 
863 #if TSCH_TIMESYNC_REMOVE_JITTER
864  /* remove jitter due to measurement errors */
865  if(ABS(estimated_drift) <= TSCH_TIMESYNC_MEASUREMENT_ERROR) {
866  estimated_drift = 0;
867  } else if(estimated_drift > 0) {
868  estimated_drift -= TSCH_TIMESYNC_MEASUREMENT_ERROR;
869  } else {
870  estimated_drift += TSCH_TIMESYNC_MEASUREMENT_ERROR;
871  }
872 #endif
873 
874 #ifdef TSCH_CALLBACK_DO_NACK
875  if(frame.fcf.ack_required) {
876  do_nack = TSCH_CALLBACK_DO_NACK(current_link,
877  &source_address, &destination_address);
878  }
879 #endif
880 
881  if(frame.fcf.ack_required) {
882  static uint8_t ack_buf[TSCH_PACKET_MAX_LEN];
883  static int ack_len;
884 
885  /* Build ACK frame */
886  ack_len = tsch_packet_create_eack(ack_buf, sizeof(ack_buf),
887  &source_address, frame.seq, (int16_t)RTIMERTICKS_TO_US(estimated_drift), do_nack);
888 
889  if(ack_len > 0) {
890 #if LLSEC802154_ENABLED
891  if(tsch_is_pan_secured) {
892  /* Secure ACK frame. There is only header and header IEs, therefore data len == 0. */
893  ack_len += tsch_security_secure_frame(ack_buf, ack_buf, ack_len, 0, &tsch_current_asn);
894  }
895 #endif /* LLSEC802154_ENABLED */
896 
897  /* Copy to radio buffer */
898  NETSTACK_RADIO.prepare((const void *)ack_buf, ack_len);
899 
900  /* Wait for time to ACK and transmit ACK */
901  TSCH_SCHEDULE_AND_YIELD(pt, t, rx_start_time,
902  packet_duration + tsch_timing[tsch_ts_tx_ack_delay] - RADIO_DELAY_BEFORE_TX, "RxBeforeAck");
903  TSCH_DEBUG_RX_EVENT();
904  NETSTACK_RADIO.transmit(ack_len);
905  tsch_radio_off(TSCH_RADIO_CMD_OFF_WITHIN_TIMESLOT);
906 
907  /* Schedule a burst link iff the frame pending bit was set */
908  burst_link_scheduled = tsch_packet_get_frame_pending(current_input->payload, current_input->len);
909  }
910  }
911 
912  /* If the sender is a time source, proceed to clock drift compensation */
913  n = tsch_queue_get_nbr(&source_address);
914  if(n != NULL && n->is_time_source) {
915  int32_t since_last_timesync = TSCH_ASN_DIFF(tsch_current_asn, last_sync_asn);
916  /* Keep track of last sync time */
917  last_sync_asn = tsch_current_asn;
918  tsch_last_sync_time = clock_time();
919  /* Save estimated drift */
920  drift_correction = -estimated_drift;
921  is_drift_correction_used = 1;
922  sync_count++;
923  tsch_timesync_update(n, since_last_timesync, -estimated_drift);
925  }
926 
927  /* Add current input to ringbuf */
928  ringbufindex_put(&input_ringbuf);
929 
930  /* If the neighbor is known, update its stats */
931  if(n != NULL) {
932  NETSTACK_RADIO.get_value(RADIO_PARAM_LAST_LINK_QUALITY, &radio_last_lqi);
933  tsch_stats_rx_packet(n, current_input->rssi, radio_last_lqi, tsch_current_channel);
934  }
935 
936  /* Log every reception */
937  TSCH_LOG_ADD(tsch_log_rx,
938  linkaddr_copy(&log->rx.src, (linkaddr_t *)&frame.src_addr);
939  log->rx.is_unicast = frame.fcf.ack_required;
940  log->rx.datalen = current_input->len;
941  log->rx.drift = drift_correction;
942  log->rx.drift_used = is_drift_correction_used;
943  log->rx.is_data = frame.fcf.frame_type == FRAME802154_DATAFRAME;
944  log->rx.sec_level = frame.aux_hdr.security_control.security_level;
945  log->rx.estimated_drift = estimated_drift;
946  log->rx.seqno = frame.seq;
947  );
948  }
949 
950  /* Poll process for processing of pending input and logs */
951  process_poll(&tsch_pending_events_process);
952  }
953  }
954 
955  tsch_radio_off(TSCH_RADIO_CMD_OFF_END_OF_TIMESLOT);
956  }
957 
958  if(input_queue_drop != 0) {
959  TSCH_LOG_ADD(tsch_log_message,
960  snprintf(log->message, sizeof(log->message),
961  "!queue full skipped %u", input_queue_drop);
962  );
963  input_queue_drop = 0;
964  }
965  }
966 
967  TSCH_DEBUG_RX_EVENT();
968 
969  PT_END(pt);
970 }
971 /*---------------------------------------------------------------------------*/
972 /* Protothread for slot operation, called from rtimer interrupt
973  * and scheduled from tsch_schedule_slot_operation */
974 static
975 PT_THREAD(tsch_slot_operation(struct rtimer *t, void *ptr))
976 {
977  TSCH_DEBUG_INTERRUPT();
978  PT_BEGIN(&slot_operation_pt);
979 
980  /* Loop over all active slots */
981  while(tsch_is_associated) {
982 
983  if(current_link == NULL || tsch_lock_requested) { /* Skip slot operation if there is no link
984  or if there is a pending request for getting the lock */
985  /* Issue a log whenever skipping a slot */
986  TSCH_LOG_ADD(tsch_log_message,
987  snprintf(log->message, sizeof(log->message),
988  "!skipped slot %u %u %u",
989  tsch_locked,
990  tsch_lock_requested,
991  current_link == NULL);
992  );
993 
994  } else {
995  int is_active_slot;
996  TSCH_DEBUG_SLOT_START();
997  tsch_in_slot_operation = 1;
998  /* Measure on-air noise level while TSCH is idle */
999  tsch_stats_sample_rssi();
1000  /* Reset drift correction */
1001  drift_correction = 0;
1002  is_drift_correction_used = 0;
1003  /* Get a packet ready to be sent */
1004  current_packet = get_packet_and_neighbor_for_link(current_link, &current_neighbor);
1005  /* There is no packet to send, and this link does not have Rx flag. Instead of doing
1006  * nothing, switch to the backup link (has Rx flag) if any. */
1007  if(current_packet == NULL && !(current_link->link_options & LINK_OPTION_RX) && backup_link != NULL) {
1008  current_link = backup_link;
1009  current_packet = get_packet_and_neighbor_for_link(current_link, &current_neighbor);
1010  }
1011  is_active_slot = current_packet != NULL || (current_link->link_options & LINK_OPTION_RX);
1012  if(is_active_slot) {
1013  /* If we are in a burst, we stick to current channel instead of
1014  * doing channel hopping, as per IEEE 802.15.4-2015 */
1015  if(burst_link_scheduled) {
1016  /* Reset burst_link_scheduled flag. Will be set again if burst continue. */
1017  burst_link_scheduled = 0;
1018  } else {
1019  /* Hop channel */
1020  tsch_current_channel = tsch_calculate_channel(&tsch_current_asn, current_link->channel_offset);
1021  }
1022  NETSTACK_RADIO.set_value(RADIO_PARAM_CHANNEL, tsch_current_channel);
1023  /* Turn the radio on already here if configured so; necessary for radios with slow startup */
1024  tsch_radio_on(TSCH_RADIO_CMD_ON_START_OF_TIMESLOT);
1025  /* Decide whether it is a TX/RX/IDLE or OFF slot */
1026  /* Actual slot operation */
1027  if(current_packet != NULL) {
1028  /* We have something to transmit, do the following:
1029  * 1. send
1030  * 2. update_backoff_state(current_neighbor)
1031  * 3. post tx callback
1032  **/
1033  static struct pt slot_tx_pt;
1034  PT_SPAWN(&slot_operation_pt, &slot_tx_pt, tsch_tx_slot(&slot_tx_pt, t));
1035  } else {
1036  /* Listen */
1037  static struct pt slot_rx_pt;
1038  PT_SPAWN(&slot_operation_pt, &slot_rx_pt, tsch_rx_slot(&slot_rx_pt, t));
1039  }
1040  } else {
1041  /* Make sure to end the burst in cast, for some reason, we were
1042  * in a burst but now without any more packet to send. */
1043  burst_link_scheduled = 0;
1044  }
1045  TSCH_DEBUG_SLOT_END();
1046  }
1047 
1048  /* End of slot operation, schedule next slot or resynchronize */
1049 
1050  if(tsch_is_coordinator) {
1051  /* Update the `last_sync_*` variables to avoid large errors
1052  * in the application-level time synchronization */
1053  last_sync_asn = tsch_current_asn;
1054  tsch_last_sync_time = clock_time();
1055  }
1056 
1057  /* Do we need to resynchronize? i.e., wait for EB again */
1058  if(!tsch_is_coordinator && (TSCH_ASN_DIFF(tsch_current_asn, last_sync_asn) >
1059  (100 * TSCH_CLOCK_TO_SLOTS(TSCH_DESYNC_THRESHOLD / 100, tsch_timing[tsch_ts_timeslot_length])))) {
1060  TSCH_LOG_ADD(tsch_log_message,
1061  snprintf(log->message, sizeof(log->message),
1062  "! leaving the network, last sync %u",
1063  (unsigned)TSCH_ASN_DIFF(tsch_current_asn, last_sync_asn));
1064  );
1065  last_timesource_neighbor = NULL;
1067  } else {
1068  /* backup of drift correction for printing debug messages */
1069  /* int32_t drift_correction_backup = drift_correction; */
1070  uint16_t timeslot_diff = 0;
1071  rtimer_clock_t prev_slot_start;
1072  /* Time to next wake up */
1073  rtimer_clock_t time_to_next_active_slot;
1074  /* Schedule next wakeup skipping slots if missed deadline */
1075  do {
1076  if(current_link != NULL
1077  && current_link->link_options & LINK_OPTION_TX
1078  && current_link->link_options & LINK_OPTION_SHARED) {
1079  /* Decrement the backoff window for all neighbors able to transmit over
1080  * this Tx, Shared link. */
1081  tsch_queue_update_all_backoff_windows(&current_link->addr);
1082  }
1083 
1084  /* A burst link was scheduled. Replay the current link at the
1085  next time offset */
1086  if(burst_link_scheduled && current_link != NULL) {
1087  timeslot_diff = 1;
1088  backup_link = NULL;
1089  /* Keep track of the number of repetitions */
1090  tsch_current_burst_count++;
1091  } else {
1092  /* Get next active link */
1093  current_link = tsch_schedule_get_next_active_link(&tsch_current_asn, &timeslot_diff, &backup_link);
1094  if(current_link == NULL) {
1095  /* There is no next link. Fall back to default
1096  * behavior: wake up at the next slot. */
1097  timeslot_diff = 1;
1098  } else {
1099  /* Reset burst index now that the link was scheduled from
1100  normal schedule (as opposed to from ongoing burst) */
1101  tsch_current_burst_count = 0;
1102  }
1103  }
1104 
1105  /* Update ASN */
1106  TSCH_ASN_INC(tsch_current_asn, timeslot_diff);
1107  /* Time to next wake up */
1108  time_to_next_active_slot = timeslot_diff * tsch_timing[tsch_ts_timeslot_length] + drift_correction;
1109  time_to_next_active_slot += tsch_timesync_adaptive_compensate(time_to_next_active_slot);
1110  drift_correction = 0;
1111  is_drift_correction_used = 0;
1112  /* Update current slot start */
1113  prev_slot_start = current_slot_start;
1114  current_slot_start += time_to_next_active_slot;
1115  } while(!tsch_schedule_slot_operation(t, prev_slot_start, time_to_next_active_slot, "main"));
1116  }
1117 
1118  tsch_in_slot_operation = 0;
1119  PT_YIELD(&slot_operation_pt);
1120  }
1121 
1122  PT_END(&slot_operation_pt);
1123 }
1124 /*---------------------------------------------------------------------------*/
1125 /* Set global time before starting slot operation,
1126  * with a rtimer time and an ASN */
1127 void
1129 {
1130  static struct rtimer slot_operation_timer;
1131  rtimer_clock_t time_to_next_active_slot;
1132  rtimer_clock_t prev_slot_start;
1133  TSCH_DEBUG_INIT();
1134  do {
1135  uint16_t timeslot_diff;
1136  /* Get next active link */
1137  current_link = tsch_schedule_get_next_active_link(&tsch_current_asn, &timeslot_diff, &backup_link);
1138  if(current_link == NULL) {
1139  /* There is no next link. Fall back to default
1140  * behavior: wake up at the next slot. */
1141  timeslot_diff = 1;
1142  }
1143  /* Update ASN */
1144  TSCH_ASN_INC(tsch_current_asn, timeslot_diff);
1145  /* Time to next wake up */
1146  time_to_next_active_slot = timeslot_diff * tsch_timing[tsch_ts_timeslot_length];
1147  /* Update current slot start */
1148  prev_slot_start = current_slot_start;
1149  current_slot_start += time_to_next_active_slot;
1150  } while(!tsch_schedule_slot_operation(&slot_operation_timer, prev_slot_start, time_to_next_active_slot, "assoc"));
1151 }
1152 /*---------------------------------------------------------------------------*/
1153 /* Start actual slot operation */
1154 void
1155 tsch_slot_operation_sync(rtimer_clock_t next_slot_start,
1156  struct tsch_asn_t *next_slot_asn)
1157 {
1158  int_master_status_t status;
1159 
1160  current_slot_start = next_slot_start;
1161  tsch_current_asn = *next_slot_asn;
1162  status = critical_enter();
1163  last_sync_asn = tsch_current_asn;
1164  tsch_last_sync_time = clock_time();
1165  critical_exit(status);
1166  current_link = NULL;
1167 }
1168 /*---------------------------------------------------------------------------*/
1169 /** @} */
TSCH packet information.
Definition: tsch-types.h:97
#define TSCH_LOG_ADD(log_type, init_code)
Use this macro to add a log to the queue (will be printed out later, after leaving interrupt context)...
Definition: tsch-log.h:140
frame802154_scf_t security_control
Security control bitfield.
Definition: frame802154.h:188
struct tsch_neighbor * tsch_queue_get_nbr(const linkaddr_t *addr)
Get a TSCH neighbor.
Definition: tsch-queue.c:108
static void tsch_radio_off(enum tsch_radio_state_off_cmd command)
This function turns off the radio.
int rtimer_set(struct rtimer *rtimer, rtimer_clock_t time, rtimer_clock_t duration, rtimer_callback_t func, void *ptr)
Post a real-time task.
Definition: rtimer.c:67
frame802154_fcf_t fcf
Frame control field.
Definition: frame802154.h:204
Representation of a real-time task.
Definition: rtimer.h:111
struct tsch_neighbor * last_timesource_neighbor
The neighbor last used as our time source.
The MAC layer transmission could not be performed because of a fatal error.
Definition: mac.h:101
int tsch_get_lock(void)
Takes the TSCH lock.
Header file for the radio API
uint8_t security_level
3 bit.
Definition: frame802154.h:168
static void critical_exit(int_master_status_t status)
Exit a critical section and restore the master interrupt.
Definition: critical.h:81
void tsch_release_lock(void)
Releases the TSCH lock.
int frame802154_parse(uint8_t *data, int len, frame802154_t *pf)
Parses an input frame.
Definition: frame802154.c:500
TSCH neighbor information.
Definition: tsch-types.h:109
void tsch_queue_update_all_backoff_windows(const linkaddr_t *dest_addr)
Decrement backoff window for the queue(s) able to Tx to a given address.
Definition: tsch-queue.c:503
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.
#define PT_BEGIN(pt)
Declare the start of a protothread inside the C function implementing the protothread.
Definition: pt.h:114
void tsch_timesync_update(struct tsch_neighbor *n, uint16_t time_delta_asn, int32_t drift_correction)
Updates timesync information for a given neighbor.
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
void tsch_schedule_keepalive(void)
Schedule a keep-alive transmission within [timeout*0.9, timeout[.
Definition: tsch.c:331
A MAC framer for IEEE 802.15.4
const linkaddr_t linkaddr_null
The null link-layer address.
#define PT_SPAWN(pt, child, thread)
Spawn a child protothread and wait until it exits.
Definition: pt.h:205
int tsch_packet_update_eb(uint8_t *buf, int buf_size, uint8_t tsch_sync_ie_offset)
Update ASN in EB packet.
Definition: tsch-packet.c:391
linkaddr_t linkaddr_node_addr
The link-layer address of the node.
Definition: linkaddr.c:48
uint8_t tsch_calculate_channel(struct tsch_asn_t *asn, uint8_t channel_offset)
Returns a 802.15.4 channel from an ASN and channel offset.
static int_master_status_t critical_enter()
Enter a critical section.
Definition: critical.h:65
#define RTIMER_NOW()
Get the current clock time.
Definition: rtimer.h:160
int32_t tsch_timesync_adaptive_compensate(rtimer_clock_t delta_ticks)
Computes time compensation for a given point in the future.
unsigned int tsch_security_mic_len(const frame802154_t *frame)
Return MIC length.
INT_MASTER_STATUS_DATATYPE int_master_status_t
Master interrupt state representation data type.
Definition: int-master.h:62
#define CLOCK_SECOND
A second, measured in system clock time.
Definition: clock.h:82
#define PT_END(pt)
Declare the end of a protothread.
Definition: pt.h:126
Header file for the Packet queue buffer management
The MAC layer did not get an acknowledgement for the packet.
Definition: mac.h:91
void process_poll(struct process *p)
Request a process to be polled.
Definition: process.c:371
struct tsch_link * tsch_schedule_get_next_active_link(struct tsch_asn_t *asn, uint16_t *time_offset, struct tsch_link **backup_link)
Returns the next active link after a given ASN, and a backup link (for the same ASN, with Rx flag)
The MAC layer transmission was OK.
Definition: mac.h:87
#define TSCH_ASN_MOD(asn, div)
Returns the result (16 bits) of a modulo operation on ASN, with divisor being a struct asn_divisor_t...
Definition: tsch-asn.h:93
#define PT_YIELD(pt)
Yield from the current protothread.
Definition: pt.h:289
int tsch_packet_parse_eack(const uint8_t *buf, int buf_size, uint8_t seqno, frame802154_t *frame, struct ieee802154_ies *ies, uint8_t *hdr_len)
Parse enhanced ACK packet.
Definition: tsch-packet.c:162
Main API declarations for TSCH.
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:193
struct tsch_packet * tsch_queue_get_packet_for_nbr(const struct tsch_neighbor *n, struct tsch_link *link)
Returns the first packet that can be sent from a queue on a given link.
Definition: tsch-queue.c:410
#define RADIO_RX_MODE_ADDRESS_FILTER
The radio reception mode controls address filtering and automatic transmission of acknowledgements in...
Definition: radio.h:231
int tsch_is_locked(void)
Checks if the TSCH lock is set.
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.
The MAC layer deferred the transmission for a later time.
Definition: mac.h:94
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:99
uint64_t tsch_get_network_uptime_ticks(void)
Get the time, in clock ticks, since the TSCH network was started.
void tsch_packet_set_frame_pending(uint8_t *buf, int buf_size)
Set frame pending bit in a packet (whose header was already build)
Definition: tsch-packet.c:467
int tsch_queue_packet_sent(struct tsch_neighbor *n, struct tsch_packet *p, struct tsch_link *link, uint8_t mac_tx_status)
Updates neighbor queue state after a transmission.
Definition: tsch-queue.c:322
#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
static void tsch_radio_on(enum tsch_radio_state_on_cmd command)
This function turns on the radio.
int tsch_queue_packet_count(const linkaddr_t *addr)
Returns the number of packets currently a given neighbor queue.
Definition: tsch-queue.c:280
#define TSCH_ASN_INC(asn, inc)
Increment an ASN by inc (32 bits)
Definition: tsch-asn.h:68
uint8_t seq
Sequence number.
Definition: frame802154.h:205
int tsch_packet_get_frame_pending(uint8_t *buf, int buf_size)
Get frame pending bit from a packet.
Definition: tsch-packet.c:474
int ringbufindex_peek_put(const struct ringbufindex *r)
Check if there is space to put an element.
Definition: ringbufindex.c:78
void tsch_disassociate(void)
Leave the TSCH network we are currently in.
Definition: tsch.c:534
Header file for the Packet buffer (packetbuf) management
Include file for the Contiki low-layer network stack (NETSTACK)
void watchdog_periodic(void)
Writes the WDT clear sequence.
Definition: watchdog.c:85
struct tsch_packet * tsch_queue_get_unicast_packet_for_any(struct tsch_neighbor **n, struct tsch_link *link)
Gets the head packet of any neighbor queue with zero backoff counter.
Definition: tsch-queue.c:449
unsigned int tsch_security_secure_frame(uint8_t *hdr, uint8_t *outbuf, int hdrlen, int datalen, struct tsch_asn_t *asn)
Protect a frame with encryption and/or MIC.
Stores data about an incoming packet.
Definition: tsch-types.h:152
Header file for the logging system
uint8_t ack_required
1 bit.
Definition: frame802154.h:156
int ringbufindex_put(struct ringbufindex *r)
Put one element to the ring buffer.
Definition: ringbufindex.c:58
void tsch_slot_operation_start(void)
Start actual slot operation.
The ASN is an absolute slot number over 5 bytes.
Definition: tsch-asn.h:48
frame802154_aux_hdr_t aux_hdr
Aux security header.
Definition: frame802154.h:208
int tsch_packet_create_eack(uint8_t *buf, uint16_t buf_len, const linkaddr_t *dest_addr, uint8_t seqno, int16_t drift, int nack)
Construct Enhanced ACK packet.
Definition: tsch-packet.c:93