Convert lq_etx_float to new plugin system
[olsrd.git] / lib / lq_etx_ff / src / lq_plugin_etx_ff.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2009, the olsr.org team - see HISTORY file
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 #ifndef LQ_PLUGIN_ETX_FF_
43 #define LQ_PLUGIN_ETX_FF_
44
45 #include "olsr_types.h"
46 #include "tc_set.h"
47 #include "link_set.h"
48 #include "lq_packet.h"
49 #include "lq_plugin.h"
50
51 #define PLUGIN_DESCR "Freifunk ETX metric based on the original design of Elektra and Thomas Lopatic"
52 #define PLUGIN_AUTHOR "Henning Rogge"
53
54 #define LQ_ALGORITHM_ETX_FF_NAME "etx_ff"
55
56 /* 16,32,64 and max. 128 */
57 #define LQ_FF_WINDOW 64
58 #define LQ_FF_QUICKSTART_INIT 4
59
60 struct lq_etxff_linkquality {
61   uint8_t valueLq;
62   uint8_t valueNlq;
63 };
64
65 struct lq_etxff_tc_edge {
66   struct tc_entry core;
67   struct lq_etxff_linkquality lq;
68 };
69
70 struct lq_etxff_tc_mpr_addr {
71   struct tc_mpr_addr core;
72   struct lq_etxff_linkquality lq;
73 };
74
75 struct lq_etxff_lq_hello_neighbor {
76   struct lq_hello_neighbor core;
77   struct lq_etxff_linkquality lq;
78 };
79
80 struct lq_etxff_link_entry {
81   struct link_entry core;
82   struct lq_etxff_linkquality lq;
83   uint8_t windowSize, activePtr;
84   uint16_t last_seq_nr;
85   uint16_t missed_seconds;
86   uint16_t received[LQ_FF_WINDOW], lost[LQ_FF_WINDOW];
87 };
88
89 extern struct lq_handler lq_etxff_handler;
90
91 #endif /*LQ_PLUGIN_ETX_FF_ */
92
93 /*
94  * Local Variables:
95  * c-basic-offset: 2
96  * indent-tabs-mode: nil
97  * End:
98  */