Contiki-NG
radio-mode.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2020, Institute of Electronics and Computer Science (EDI)
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 copyright holder nor the names of its
14  * contributors may be used to endorse or promote products derived
15  * from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
20  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
21  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28  * OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 /**
31  * \addtogroup cc13xx-cc26xx-rf
32  * @{
33  *
34  * \defgroup cc13xx-cc26xx-rf-radio-mode Generic radio mode API
35  *
36  * @{
37  *
38  * \file
39  * Header file of the generic radio mode API.
40  * \author
41  * Atis Elsts <atis.elsts@edi.lv>
42  */
43 /*---------------------------------------------------------------------------*/
44 #ifndef RF_RADIO_MODE_H_
45 #define RF_RADIO_MODE_H_
46 /*---------------------------------------------------------------------------*/
47 #include "contiki.h"
48 #include "sys/ctimer.h"
49 /*---------------------------------------------------------------------------*/
50 #include <ti/drivers/rf/RF.h>
51 /*---------------------------------------------------------------------------*/
52 #include <stdbool.h>
53 /*---------------------------------------------------------------------------*/
54 /**
55  * \name Radio mode API
56  *
57  * @{
58  */
59 typedef struct {
60  /* RF driver */
61  RF_Handle rf_handle;
62 
63  /* Are we currently in poll mode? */
64  bool poll_mode;
65 
66  /* RAT Overflow Upkeep */
67  struct {
68  struct ctimer overflow_timer;
69  rtimer_clock_t last_overflow;
70  volatile uint32_t overflow_count;
71  } rat;
72 
73  bool (* rx_is_active)(void);
74 
75 } simplelink_radio_mode_t;
76 
77 extern simplelink_radio_mode_t *radio_mode;
78 /** @} */
79 /*---------------------------------------------------------------------------*/
80 #endif /* RF_RADIO_MODE_H__ */
81 /*---------------------------------------------------------------------------*/
82 /**
83  * @}
84  * @}
85  */
Header file for the callback timer