Contiki-NG
Loading...
Searching...
No Matches
tx-power.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2018, Texas Instruments Incorporated - http://www.ti.com/
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-cpu
32 * @{
33 *
34 * \defgroup cc13xx-cc26xx-rf-tx-power TX power functioanlity for CC13xx/CC26xx
35 *
36 * @{
37 *
38 * \file
39 * Header file of TX power functionality of CC13xx/CC26xx.
40 * \author
41 * Edvard Pettersen <e.pettersen@ti.com>
42 */
43/*---------------------------------------------------------------------------*/
44#ifndef TX_POWER_H_
45#define TX_POWER_H_
46/*---------------------------------------------------------------------------*/
47#include "contiki.h"
48/*---------------------------------------------------------------------------*/
49#include <ti/drivers/rf/RF.h>
50/*---------------------------------------------------------------------------*/
51#include <stdint.h>
52#include <stddef.h>
53#include <stdbool.h>
54/*---------------------------------------------------------------------------*/
55#define RF_TXPOWER_DBM RF_CONF_TXPOWER_DBM
56#define RF_BLE_TXPOWER_DBM RF_CONF_BLE_TXPOWER_DBM
57#define RF_TXPOWER_BOOST_MODE RF_CONF_TXPOWER_BOOST_MODE
58/*---------------------------------------------------------------------------*/
59typedef RF_TxPowerTable_Entry tx_power_table_t;
60/*---------------------------------------------------------------------------*/
61/**
62 * \name Extern declarations of TX Power Table variables.
63 *
64 * @{
65 */
66
67/* Nestack RF TX power table */
68extern tx_power_table_t *const rf_tx_power_table;
69extern const size_t rf_tx_power_table_size;
70
71/* BLE Beacon RF TX power table */
72extern tx_power_table_t *const ble_tx_power_table;
73extern const size_t ble_tx_power_table_size;
74/** @} */
75/*---------------------------------------------------------------------------*/
76/**
77 * \name TX power table convenience functions.
78 *
79 * @{
80 */
81
82static inline int8_t
83tx_power_min(tx_power_table_t *table)
84{
85 return table[0].power;
86}
87static inline int8_t
88tx_power_max(tx_power_table_t *table, size_t size)
89{
90 return table[size - 1].power;
91}
92static inline bool
93tx_power_in_range(int8_t dbm, tx_power_table_t *table, size_t size)
94{
95 return (dbm >= tx_power_min(table)) &&
96 (dbm <= tx_power_max(table, size));
97}
98/** @} */
99/*---------------------------------------------------------------------------*/
100#endif /* TX_POWER_H_ */
101/*---------------------------------------------------------------------------*/
102/**
103 * @}
104 * @}
105 */