1 /*
2  * Copyright (c) 2017 - 2023, 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 #ifndef NRF_802154_TX_POWER_H__
36 #define NRF_802154_TX_POWER_H__
37 
38 #include <stdint.h>
39 
40 #include "nrf_802154.h"
41 #include "nrf_802154_types_internal.h"
42 
43 /**@brief Convert tx_power value passed through metadata to raw components in dBms to be applied
44  *        on each stage of the transmit path.
45 
46  * This function also ensures that the values meet the constraints for the given channel.
47  *
48  * @param[in]  channel             The channel to be used for transmission
49  * @param[in]  tx_power            The value passed to the transmit metadata.
50  * @param[out] p_tx_power_split    Pointer to the structure holding TX power split into raw components in dBm.
51  *
52  * @retval  The real achieved total transmission power in dBm.
53  *
54  */
55 int8_t nrf_802154_tx_power_convert_metadata_to_tx_power_split(
56     uint8_t                                 channel,
57     nrf_802154_tx_power_metadata_t          tx_power,
58     nrf_802154_fal_tx_power_split_t * const p_tx_power_split);
59 
60 /**@brief Get the transmit power stored in PIB after applying the power constraints for the current channel and splitting
61  *        into components to be applied on each stage of the transmit path.
62  *
63  * The current channel is acquired from PIB.
64  *
65  * @param[out] p_split_power  Pointer to the structure holding TX power split into components in dBm.
66  *
67  * @retval  The real achieved total transmission power in dBm.
68  *
69  */
70 int8_t nrf_802154_tx_power_split_pib_power_get(
71     nrf_802154_fal_tx_power_split_t * const p_split_power);
72 
73 /**@brief Get the transmit power stored in PIB after applying the power constraints for the given channel and splitting
74  *        into components to be applied on each stage of the transmit path.
75  *
76  * @param[in]  channel        The channel based on which the power should be constrained
77  * @param[out] p_split_power  Pointer to the structure holding TX power split into components in dBm.
78  *
79  * @retval  The real achieved total transmission power in dBm.
80  *
81  */
82 int8_t nrf_802154_tx_power_split_pib_power_for_channel_get(
83     uint8_t                                 channel,
84     nrf_802154_fal_tx_power_split_t * const p_split_power);
85 
86 /**
87  *@}
88  **/
89 
90 #endif // NRF_802154_TX_POWER_H__
91