1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
RIOT/drivers/include/periph/pm.h
2020-10-22 11:29:27 +02:00

60 lines
1.1 KiB
C

/*
* Copyright (C) 2016 Kaspar Schleiser <kaspar@schleiser.de>
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup drivers_periph_pm Power Management
* @ingroup drivers_periph
* @brief The kernels power management interface
*
* @attention This interface *must* be implemented for every platform in RIOT.
*
* @{
*
* @file
* @brief Power management interface
*
* @author Kaspar Schleiser <kaspar@schleiser.de>
*/
#ifndef PERIPH_PM_H
#define PERIPH_PM_H
#include "periph_cpu.h"
#ifdef MODULE_PM_LAYERED
#include "pm_layered.h"
#endif
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Reboot MCU
*/
void pm_reboot(void);
/**
* @brief Turn off MCU completely
*/
void pm_off(void);
/**
* @brief Switches the MCU to the lowest possible power mode
*
* This function will be called by the idle thread.
*/
void pm_set_lowest(void);
#ifdef __cplusplus
}
#endif
#endif /* PERIPH_PM_H */
/** @} */