1 /* 2 * Copyright (c) 2018, 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_REGULATORS_H__ 33 #define NRF_REGULATORS_H__ 34 35 #include <nrfx.h> 36 37 #ifdef __cplusplus 38 extern "C" { 39 #endif 40 41 /** 42 * @defgroup nrf_regulators_hal REGULATORS HAL 43 * @{ 44 * @ingroup nrf_power 45 * @brief Hardware access layer for managing the REGULATORS peripheral. 46 */ 47 48 /** 49 * @brief Function for enabling or disabling DCDC converter. 50 * 51 * @param[in] p_reg Pointer to the peripheral registers structure. 52 * @param[in] enable Set true to enable or false to disable DCDC converter. 53 */ 54 __STATIC_INLINE void nrf_regulators_dcdcen_set(NRF_REGULATORS_Type * p_reg, bool enable); 55 56 /** 57 * @brief Function for putting CPU in system OFF mode. 58 * 59 * This function puts the CPU into system off mode. 60 * The only way to wake up the CPU is by reset. 61 * 62 * @note This function never returns. 63 * 64 * @param[in] p_reg Pointer to the peripheral registers structure. 65 */ 66 __STATIC_INLINE void nrf_regulators_system_off(NRF_REGULATORS_Type * p_reg); 67 68 #ifndef SUPPRESS_INLINE_IMPLEMENTATION 69 70 __STATIC_INLINE void nrf_regulators_dcdcen_set(NRF_REGULATORS_Type * p_reg, bool enable) 71 { 72 p_reg->DCDCEN = (enable ? REGULATORS_DCDCEN_DCDCEN_Msk : 0); 73 } 74 75 __STATIC_INLINE void nrf_regulators_system_off(NRF_REGULATORS_Type * p_reg) 76 { 77 p_reg->SYSTEMOFF = REGULATORS_SYSTEMOFF_SYSTEMOFF_Msk; 78 __DSB(); 79 80 /* Solution for simulated System OFF in debug mode */ 81 while (true) 82 { 83 __WFE(); 84 } 85 } 86 87 #endif // SUPPRESS_INLINE_IMPLEMENTATION 88 89 /** @} */ 90 91 #ifdef __cplusplus 92 } 93 #endif 94 95 #endif // NRF_REGULATORS_H__ 96