1 /*
2  * Copyright (c) 2017, Nordic Semiconductor ASA
3  * All rights reserved.
4  *
5  * SPDX-License-Identifier: BSD-3-Clause
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright notice, this
11  *    list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
18  *    contributors may be used to endorse or promote products derived from this
19  *    software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  */
34 
35 /**
36  * @brief This module defines the nRF 802.15.4 Frontend Module abstraction layer.
37  *
38  */
39 
40 #ifndef NRF_802154_FAL_H_
41 #define NRF_802154_FAL_H_
42 
43 #include <stdint.h>
44 #include "protocol/mpsl_fem_protocol_api.h"
45 
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49 
50 /** @brief Represents components of tx_power to be applied for stages on transmit path. */
51 typedef struct
52 {
53     /** TX power to be applied to the RADIO peripheral. */
54     int8_t                      radio_tx_power;
55 
56     /** PA power control to be applied to Front-End Module. */
57     mpsl_fem_pa_power_control_t fem_pa_power_control;
58 } nrf_802154_fal_tx_power_split_t;
59 
60 /** @brief Splits transmit power value into components to be applied on each stage on transmit path.
61  *
62  * @note If the exact value of @p power cannot be achieved this function attempts to use less
63  * power to not exceed constraint.
64  *
65  * @param[in]  channel          802.15.4 channel.
66  * @param[in]  power            TX power in dBm requested for transmission on air.
67  * @param[out] p_tx_power_split Components of tx_power to be applied for stages on transmit path.
68  *
69  * @return Actually achieved power in dBm.
70  */
71 int8_t nrf_802154_fal_tx_power_split(const uint8_t                           channel,
72                                      const int8_t                            power,
73                                      nrf_802154_fal_tx_power_split_t * const p_tx_power_split);
74 
75 #ifdef __cplusplus
76 }
77 #endif
78 
79 #endif /* NRF_802154_FAL_H_ */
80