xref: /btstack/chipset/cinnamon/hopping.h (revision 2c4f9bbb6d93b3f1a90ed62ac67e4cd019f0736a)
1 /*******************************************************************************
2  *
3  *      queue
4  *
5  *      Copyright (c) 2018, Raccon BLE Sniffer
6  *      All rights reserved.
7  *
8  *      Redistribution and use in source and binary forms, with or without
9  *      modification, are permitted provided that the following conditions are
10  *      met:
11  *      
12  *      * Redistributions of source code must retain the above copyright
13  *        notice, this list of conditions and the following disclaimer.
14  *      * Redistributions in binary form must reproduce the above
15  *        copyright notice, this list of conditions and the following disclaimer
16  *        in the documentation and/or other materials provided with the
17  *        distribution.
18  *      * Neither the name of "btlejack2" nor the names of its
19  *        contributors may be used to endorse or promote products derived from
20  *        this software without specific prior written permission.
21  *      
22  *      THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  *      "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  *      LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25  *      A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26  *      OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27  *      SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28  *      LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  *      DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  *      THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  *      (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32  *      OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  *
34  *******************************************************************************/
35 
36 #include <stdint.h>
37 
38 
39 typedef struct {
40     uint8_t chMap[5];
41     uint8_t hopIncrement;
42     uint8_t chRemap[37];
43     uint8_t chCnt;
44     // csa1
45     uint8_t currentCh;
46     // csa2
47     uint16_t channelIdentifier;
48 } hopping_t;
49 
50 
51 /**
52  * @brief init hopping instance
53  */
54 void hopping_init( hopping_t *c );
55 
56 /*
57  * @brief set list of used channels
58  * @param channel_map
59  */
60 void hopping_set_channel_map( hopping_t *c, const uint8_t *chm);
61 
62 // Channel Selection Algorithm #1
63 
64 /*
65  * @brief set hop increment
66  */
67 void hopping_csa1_set_hop_increment( hopping_t *c, uint8_t hopIncrement );
68 
69 /**
70  * @brief get next channel
71  */
72 uint8_t hopping_csa1_get_next_channel( hopping_t *c );
73 
74 // Channel Selection Algorithm #2
75 
76 /*
77  * @brief init csa 2 algorithm
78  */
79 void hopping_csa2_set_access_address( hopping_t *c, uint32_t accessAddress );
80 
81 /**
82  * @brief get next channel
83  */
84 uint8_t hopping_csa2_get_channel_for_counter( hopping_t *c, uint16_t counter );
85 
86