2015-09-21 20:01:01 +00:00
|
|
|
/*
|
|
|
|
|
* Copyright (c) 2015, SICS Swedish ICT.
|
|
|
|
|
* All rights reserved.
|
|
|
|
|
*
|
|
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
|
* modification, are permitted provided that the following conditions
|
|
|
|
|
* are met:
|
|
|
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
* notice, this list of conditions and the following disclaimer.
|
|
|
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
|
|
|
* documentation and/or other materials provided with the distribution.
|
|
|
|
|
* 3. Neither the name of the Institute nor the names of its contributors
|
|
|
|
|
* may be used to endorse or promote products derived from this software
|
|
|
|
|
* without specific prior written permission.
|
|
|
|
|
*
|
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
|
|
|
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
|
* SUCH DAMAGE.
|
|
|
|
|
*
|
|
|
|
|
* This file is part of the Contiki operating system.
|
|
|
|
|
*
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef __TSCH_SLOT_OPERATION_H__
|
|
|
|
|
#define __TSCH_SLOT_OPERATION_H__
|
|
|
|
|
|
|
|
|
|
/********** Includes **********/
|
|
|
|
|
|
|
|
|
|
#include "contiki.h"
|
|
|
|
|
#include "lib/ringbufindex.h"
|
|
|
|
|
#include "net/mac/tsch/tsch-packet.h"
|
|
|
|
|
#include "net/mac/tsch/tsch-private.h"
|
|
|
|
|
|
|
|
|
|
/******** Configuration *******/
|
|
|
|
|
|
|
|
|
|
/* Size of the ring buffer storing dequeued outgoing packets (only an array of pointers).
|
|
|
|
|
* Must be power of two, and greater or equal to QUEUEBUF_NUM */
|
|
|
|
|
#ifdef TSCH_CONF_DEQUEUED_ARRAY_SIZE
|
|
|
|
|
#define TSCH_DEQUEUED_ARRAY_SIZE TSCH_CONF_DEQUEUED_ARRAY_SIZE
|
|
|
|
|
#else
|
2015-11-20 23:08:00 +00:00
|
|
|
/* By default, round QUEUEBUF_CONF_NUM to next power of two
|
|
|
|
|
* (in the range [4;256]) */
|
|
|
|
|
#if QUEUEBUF_CONF_NUM <= 4
|
|
|
|
|
#define TSCH_DEQUEUED_ARRAY_SIZE 4
|
|
|
|
|
#elif QUEUEBUF_CONF_NUM <= 8
|
|
|
|
|
#define TSCH_DEQUEUED_ARRAY_SIZE 8
|
|
|
|
|
#elif QUEUEBUF_CONF_NUM <= 16
|
2015-09-21 20:01:01 +00:00
|
|
|
#define TSCH_DEQUEUED_ARRAY_SIZE 16
|
2015-11-20 23:08:00 +00:00
|
|
|
#elif QUEUEBUF_CONF_NUM <= 32
|
|
|
|
|
#define TSCH_DEQUEUED_ARRAY_SIZE 32
|
|
|
|
|
#elif QUEUEBUF_CONF_NUM <= 64
|
|
|
|
|
#define TSCH_DEQUEUED_ARRAY_SIZE 64
|
|
|
|
|
#elif QUEUEBUF_CONF_NUM <= 128
|
|
|
|
|
#define TSCH_DEQUEUED_ARRAY_SIZE 128
|
|
|
|
|
#else
|
|
|
|
|
#define TSCH_DEQUEUED_ARRAY_SIZE 256
|
|
|
|
|
#endif
|
2015-09-21 20:01:01 +00:00
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
/* Size of the ring buffer storing incoming packets.
|
|
|
|
|
* Must be power of two */
|
|
|
|
|
#ifdef TSCH_CONF_MAX_INCOMING_PACKETS
|
|
|
|
|
#define TSCH_MAX_INCOMING_PACKETS TSCH_CONF_MAX_INCOMING_PACKETS
|
|
|
|
|
#else
|
|
|
|
|
#define TSCH_MAX_INCOMING_PACKETS 4
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
/*********** Callbacks *********/
|
|
|
|
|
|
|
|
|
|
/* Called by TSCH form interrupt after receiving a frame, enabled upper-layer to decide
|
|
|
|
|
* whether to ACK or NACK */
|
|
|
|
|
#ifdef TSCH_CALLBACK_DO_NACK
|
|
|
|
|
int TSCH_CALLBACK_DO_NACK(struct tsch_link *link, linkaddr_t *src, linkaddr_t *dst);
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
/************ Types ***********/
|
|
|
|
|
|
|
|
|
|
/* Stores data about an incoming packet */
|
|
|
|
|
struct input_packet {
|
|
|
|
|
uint8_t payload[TSCH_PACKET_MAX_LEN]; /* Packet payload */
|
|
|
|
|
struct asn_t rx_asn; /* ASN when the packet was received */
|
|
|
|
|
int len; /* Packet len */
|
2016-06-23 16:35:16 +00:00
|
|
|
int16_t rssi; /* RSSI for this packet */
|
|
|
|
|
uint8_t channel; /* Channel we received the packet on */
|
2015-09-21 20:01:01 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/***** External Variables *****/
|
|
|
|
|
|
|
|
|
|
/* A ringbuf storing outgoing packets after they were dequeued.
|
|
|
|
|
* Will be processed layer by tsch_tx_process_pending */
|
|
|
|
|
extern struct ringbufindex dequeued_ringbuf;
|
|
|
|
|
extern struct tsch_packet *dequeued_array[TSCH_DEQUEUED_ARRAY_SIZE];
|
|
|
|
|
/* A ringbuf storing incoming packets.
|
|
|
|
|
* Will be processed layer by tsch_rx_process_pending */
|
|
|
|
|
extern struct ringbufindex input_ringbuf;
|
|
|
|
|
extern struct input_packet input_array[TSCH_MAX_INCOMING_PACKETS];
|
|
|
|
|
|
|
|
|
|
/********** Functions *********/
|
|
|
|
|
|
|
|
|
|
/* Returns a 802.15.4 channel from an ASN and channel offset */
|
|
|
|
|
uint8_t tsch_calculate_channel(struct asn_t *asn, uint8_t channel_offset);
|
|
|
|
|
/* Is TSCH locked? */
|
|
|
|
|
int tsch_is_locked(void);
|
|
|
|
|
/* Lock TSCH (no link operation) */
|
|
|
|
|
int tsch_get_lock(void);
|
|
|
|
|
/* Release TSCH lock */
|
|
|
|
|
void tsch_release_lock(void);
|
|
|
|
|
/* Set global time before starting slot operation,
|
|
|
|
|
* with a rtimer time and an ASN */
|
|
|
|
|
void tsch_slot_operation_sync(rtimer_clock_t next_slot_start,
|
|
|
|
|
struct asn_t *next_slot_asn);
|
|
|
|
|
/* Start actual slot operation */
|
|
|
|
|
void tsch_slot_operation_start(void);
|
|
|
|
|
|
|
|
|
|
#endif /* __TSCH_SLOT_OPERATION_H__ */
|
