1 /*
2 * Copyright (c) 2019 - 2024, 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 the copyright holder 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 #ifndef NRF_VREQCTRL_H__
35 #define NRF_VREQCTRL_H__
36
37 #include <nrfx.h>
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43 /**
44 * @defgroup nrf_vreqctrl_hal VREQCTRL HAL
45 * @{
46 * @ingroup nrf_power
47 * @brief Hardware access layer for managing the VREQCTRL peripheral.
48 */
49
50 /**
51 * @brief Function for requesting high voltage on RADIO, to increase its output power by 3 dBm.
52 *
53 * @param[in] p_reg Pointer to the structure of registers of the peripheral.
54 * @param[in] enable True if high voltage on RADIO is to be enabled, false otherwise.
55 */
56 NRF_STATIC_INLINE void nrf_vreqctrl_radio_high_voltage_set(NRF_VREQCTRL_Type * p_reg, bool enable);
57
58 /**
59 * @brief Function for checking if high voltage on RADIO is ready.
60 *
61 * @param[in] p_reg Pointer to the structure of registers of the peripheral.
62 *
63 * @retval true The high voltage is ready.
64 * @retval false The high voltage is not ready.
65 */
66 NRF_STATIC_INLINE bool nrf_vreqctrl_radio_high_voltage_check(NRF_VREQCTRL_Type const * p_reg);
67
68 #ifndef NRF_DECLARE_ONLY
69
nrf_vreqctrl_radio_high_voltage_set(NRF_VREQCTRL_Type * p_reg,bool enable)70 NRF_STATIC_INLINE void nrf_vreqctrl_radio_high_voltage_set(NRF_VREQCTRL_Type * p_reg, bool enable)
71 {
72 p_reg->VREGRADIO.VREQH =
73 (enable ? VREQCTRL_VREGRADIO_VREQH_VREQH_Enabled : VREQCTRL_VREGRADIO_VREQH_VREQH_Disabled);
74 }
75
nrf_vreqctrl_radio_high_voltage_check(NRF_VREQCTRL_Type const * p_reg)76 NRF_STATIC_INLINE bool nrf_vreqctrl_radio_high_voltage_check(NRF_VREQCTRL_Type const * p_reg)
77 {
78 return (bool)(p_reg->VREGRADIO.VREQHREADY & VREQCTRL_VREGRADIO_VREQHREADY_READY_Msk);
79 }
80
81 #endif // NRF_DECLARE_ONLY
82
83 /** @} */
84
85 #ifdef __cplusplus
86 }
87 #endif
88
89 #endif // NRF_VREQCTRL_H__
90
