1 /*
2 * Copyright (c) 2019 - 2020, Nordic Semiconductor ASA
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 are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * 3. Neither the name of the copyright holder nor the names of its
16 * contributors may be used to endorse or promote products derived from this
17 * software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #ifndef NRF_VREQCTRL_H__
33 #define NRF_VREQCTRL_H__
34
35 #include <nrfx.h>
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 /**
42 * @defgroup nrf_vreqctrl_hal VREQCTRL HAL
43 * @{
44 * @ingroup nrf_power
45 * @brief Hardware access layer for managing the VREQCTRL peripheral.
46 */
47
48 /**
49 * @brief Function for requesting high voltage on RADIO, to increase its output power by 3 dBm.
50 *
51 * @param[in] p_reg Pointer to the structure of registers of the peripheral.
52 * @param[in] enable True if high voltage on RADIO is to be enabled, false otherwise.
53 */
54 NRF_STATIC_INLINE void nrf_vreqctrl_radio_high_voltage_set(NRF_VREQCTRL_Type * p_reg, bool enable);
55
56 /**
57 * @brief Function for checking if high voltage on RADIO is ready.
58 *
59 * @param[in] p_reg Pointer to the structure of registers of the peripheral.
60 *
61 * @retval true The high voltage is ready.
62 * @retval false The high voltage is not ready.
63 */
64 NRF_STATIC_INLINE bool nrf_vreqctrl_radio_high_voltage_check(NRF_VREQCTRL_Type const * p_reg);
65
66 #ifndef NRF_DECLARE_ONLY
67
nrf_vreqctrl_radio_high_voltage_set(NRF_VREQCTRL_Type * p_reg,bool enable)68 NRF_STATIC_INLINE void nrf_vreqctrl_radio_high_voltage_set(NRF_VREQCTRL_Type * p_reg, bool enable)
69 {
70 p_reg->VREGRADIO.VREQH =
71 (enable ? VREQCTRL_VREGRADIO_VREQH_VREQH_Enabled : VREQCTRL_VREGRADIO_VREQH_VREQH_Disabled);
72 }
73
nrf_vreqctrl_radio_high_voltage_check(NRF_VREQCTRL_Type const * p_reg)74 NRF_STATIC_INLINE bool nrf_vreqctrl_radio_high_voltage_check(NRF_VREQCTRL_Type const * p_reg)
75 {
76 return (bool)(p_reg->VREGRADIO.VREQHREADY & VREQCTRL_VREGRADIO_VREQHREADY_READY_Msk);
77 }
78
79 #endif // NRF_DECLARE_ONLY
80
81 /** @} */
82
83 #ifdef __cplusplus
84 }
85 #endif
86
87 #endif // NRF_VREQCTRL_H__
88