text: /**
   * Copyright (c) 2016 - 2018, Nordic Semiconductor ASA
   *
   * All rights reserved.
   *
   * Redistribution and use in source and binary forms, with or without modification,
   * are permitted provided that the following conditions are met:
   *
   * 1. Redistributions of source code must retain the above copyright notice, this
   *    list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form, except as embedded into a Nordic
   *    Semiconductor ASA integrated circuit in a product or a software update for
   *    such product, must reproduce the above copyright notice, this list of
   *    conditions and the following disclaimer in the documentation and/or other
   *    materials provided with the distribution.
   *
   * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
   *    contributors may be used to endorse or promote products derived from this
   *    software without specific prior written permission.
   *
   * 4. This software, with or without modification, must only be used with a
   *    Nordic Semiconductor ASA integrated circuit.
   *
   * 5. Any software provided in binary form under this license must not be reverse
   *    engineered, decompiled, modified and/or disassembled.
   *
   * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
   * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
   * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   *
   */
  /**
   * @defgroup nrf_pwr_mgmt Power management
   * @ingroup app_common
   * @{
   * @brief This module handles power management features.
   *
   */
  #ifndef NRF_PWR_MGMT_H__
  #define NRF_PWR_MGMT_H__
  
  #include <stdbool.h>
  #include <stdint.h>
  #include <sdk_errors.h>
  #include "nrf_section_iter.h"
  
  /**@brief Power management shutdown types. */
  typedef enum
  {
      NRF_PWR_MGMT_SHUTDOWN_GOTO_SYSOFF,
      //!< Go to System OFF.
  
      NRF_PWR_MGMT_SHUTDOWN_STAY_IN_SYSOFF,
      //!< Go to System OFF and stay there.
      /**<
       * Useful when battery level is dangerously low, for example.
       */
  
      NRF_PWR_MGMT_SHUTDOWN_GOTO_DFU,
      //!< Go to DFU mode.
  
      NRF_PWR_MGMT_SHUTDOWN_RESET,
      //!< Reset chip.
  
      NRF_PWR_MGMT_SHUTDOWN_CONTINUE
      //!< Continue shutdown.
      /**<
       * This should be used by modules that block the shutdown process, when they become ready for
       * shutdown.
       */
  } nrf_pwr_mgmt_shutdown_t;
  
  /**@brief Shutdown event types. */
  typedef enum
  {
      NRF_PWR_MGMT_EVT_PREPARE_WAKEUP = NRF_PWR_MGMT_SHUTDOWN_GOTO_SYSOFF,
      //!< Application will prepare the wakeup mechanism.
  
      NRF_PWR_MGMT_EVT_PREPARE_SYSOFF = NRF_PWR_MGMT_SHUTDOWN_STAY_IN_SYSOFF,
      //!< Application will prepare to stay in System OFF state.
  
      NRF_PWR_MGMT_EVT_PREPARE_DFU    = NRF_PWR_MGMT_SHUTDOWN_GOTO_DFU,
      //!< Application will prepare to enter DFU mode.
  
      NRF_PWR_MGMT_EVT_PREPARE_RESET  = NRF_PWR_MGMT_SHUTDOWN_RESET,
      //!< Application will prepare to chip reset.
  } nrf_pwr_mgmt_evt_t;
  
  /**@brief Shutdown callback.
   * @param[in] event   Type of shutdown process.
   *
   * @retval    true    System OFF / Enter DFU preparation successful. Process will be continued.
   * @retval    false   System OFF / Enter DFU preparation failed. @ref NRF_PWR_MGMT_SHUTDOWN_CONTINUE
   *                    should be used to continue the shutdown process.
   */
  typedef bool (*nrf_pwr_mgmt_shutdown_handler_t)(nrf_pwr_mgmt_evt_t event);
  
  /**@brief   Macro for registering a shutdown handler. Modules that want to get events
   *          from this module must register the handler using this macro.
   *
   * @details This macro places the handler in a section named "pwr_mgmt_data".
   *
   * @param[in]   _handler    Event handler (@ref nrf_pwr_mgmt_shutdown_handler_t).
   * @param[in]   _priority   Priority of the given handler.
   */
  #define NRF_PWR_MGMT_HANDLER_REGISTER(_handler, _priority)                               \
      STATIC_ASSERT(_priority < NRF_PWR_MGMT_CONFIG_HANDLER_PRIORITY_COUNT);               \
      /*lint -esym(528,*_handler_function) -esym(529,*_handler_function) : Symbol not referenced. */         \
      NRF_SECTION_SET_ITEM_REGISTER(pwr_mgmt_data, _priority,                              \
                                    static nrf_pwr_mgmt_shutdown_handler_t const CONCAT_2(_handler, _handler_function)) = (_handler)
  
  /**@brief   Function for initializing power management.
   *
   * @warning Depending on configuration, this function sets SEVONPEND in System Control Block (SCB).
   *          This operation is unsafe with the SoftDevice from interrupt priority higher than SVC.
   *
   * @retval NRF_SUCCESS
   */
  ret_code_t nrf_pwr_mgmt_init(void);
  
  /**@brief Function for running power management. Should run in the main loop.
   */
  void nrf_pwr_mgmt_run(void);
  
  /**@brief Function for indicating activity.
   *
   * @details Call this function whenever doing something that constitutes "activity".
   *          For example, whenever sending data, call this function to indicate that the application
   *          is active and should not disconnect any ongoing communication links.
   */
  void nrf_pwr_mgmt_feed(void);
  
  /**@brief Function for shutting down the system.
   *
   * @param[in] shutdown_type     Type of operation.
   *
   * @details All callbacks will be executed prior to shutdown.
   */
  void nrf_pwr_mgmt_shutdown(nrf_pwr_mgmt_shutdown_t shutdown_type);
  
  #endif // NRF_PWR_MGMT_H__
  /** @} */
  