Contiki-NG
orchestra.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015, Swedish Institute of Computer Science.
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  */
30 
31 /**
32  * \file
33  * Orchestra header file
34  *
35  * \author Simon Duquennoy <simonduq@sics.se>
36  */
37 
38 #ifndef __ORCHESTRA_H__
39 #define __ORCHESTRA_H__
40 
41 #include "net/mac/tsch/tsch.h"
42 #include "orchestra-conf.h"
43 
44 /* The structure of an Orchestra rule */
45 struct orchestra_rule {
46  void (* init)(uint16_t slotframe_handle);
47  void (* new_time_source)(const struct tsch_neighbor *old, const struct tsch_neighbor *new);
48  int (* select_packet)(uint16_t *slotframe, uint16_t *timeslot, uint16_t *channel_offset);
49  void (* child_added)(const linkaddr_t *addr);
50  void (* child_removed)(const linkaddr_t *addr);
51  const char *name;
52 };
53 
54 struct orchestra_rule eb_per_time_source;
55 struct orchestra_rule unicast_per_neighbor_rpl_storing;
56 struct orchestra_rule unicast_per_neighbor_rpl_ns;
57 struct orchestra_rule default_common;
58 
59 extern linkaddr_t orchestra_parent_linkaddr;
60 extern int orchestra_parent_knows_us;
61 
62 /* Call from application to start Orchestra */
63 void orchestra_init(void);
64 /* Callbacks requied for Orchestra to operate */
65 /* Set with #define TSCH_CALLBACK_PACKET_READY orchestra_callback_packet_ready */
66 int orchestra_callback_packet_ready(void);
67 /* Set with #define TSCH_CALLBACK_NEW_TIME_SOURCE orchestra_callback_new_time_source */
68 void orchestra_callback_new_time_source(const struct tsch_neighbor *old, const struct tsch_neighbor *new);
69 /* Set with #define NETSTACK_CONF_ROUTING_NEIGHBOR_ADDED_CALLBACK orchestra_callback_child_added */
70 void orchestra_callback_child_added(const linkaddr_t *addr);
71 /* Set with #define NETSTACK_CONF_ROUTING_NEIGHBOR_REMOVED_CALLBACK orchestra_callback_child_removed */
72 void orchestra_callback_child_removed(const linkaddr_t *addr);
73 
74 #endif /* __ORCHESTRA_H__ */
static uip_ds6_addr_t * addr
Pointer to a nbr cache entry.
Definition: uip-nd6.c:107
TSCH neighbor information.
Definition: tsch-types.h:109
Orchestra configuration
Main API declarations for TSCH.