1 /** 2 * \file 3 * 4 * \brief Sleep related functionality declaration. 5 * 6 * Copyright (C) 2014 Atmel Corporation. All rights reserved. 7 * 8 * \asf_license_start 9 * 10 * \page License 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions are met: 14 * 15 * 1. Redistributions of source code must retain the above copyright notice, 16 * this list of conditions and the following disclaimer. 17 * 18 * 2. Redistributions in binary form must reproduce the above copyright notice, 19 * this list of conditions and the following disclaimer in the documentation 20 * and/or other materials provided with the distribution. 21 * 22 * 3. The name of Atmel may not be used to endorse or promote products derived 23 * from this software without specific prior written permission. 24 * 25 * 4. This software may only be redistributed and used in connection with an 26 * Atmel microcontroller product. 27 * 28 * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED 29 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 30 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE 31 * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR 32 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 36 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 37 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 38 * POSSIBILITY OF SUCH DAMAGE. 39 * 40 * \asf_license_stop 41 * 42 */ 43 44 #ifndef _HPL_SLEEP_H_INCLUDED 45 #define _HPL_SLEEP_H_INCLUDED 46 47 /** 48 * \addtogroup HPL Sleep 49 * 50 * \section hpl_sleep_rev Revision History 51 * - v1.0.0 Initial Release 52 * 53 *@{ 54 */ 55 56 #ifndef _UNIT_TEST_ 57 #include <compiler.h> 58 #endif 59 60 #ifdef __cplusplus 61 extern "C" { 62 #endif 63 64 /** 65 * \name HPL functions 66 */ 67 //@{ 68 /** 69 * \brief Set the sleep mode for the device 70 * 71 * This function sets the sleep mode for the device. 72 * For an overview of which systems are disabled in sleep for the different 73 * sleep modes see datasheet. 74 * 75 * \param[in] mode Sleep mode to use 76 * 77 * \return the status of a sleep request 78 * \retval -1 The requested sleep mode was invalid 79 * \retval 0 The operation completed successfully, sleep mode is set 80 */ 81 int32_t _set_sleep_mode(const uint8_t mode); 82 83 /** 84 * \brief Reset MCU 85 */ 86 void _reset_mcu(void); 87 88 /** 89 * \brief Put MCU to sleep 90 */ 91 void _go_to_sleep(void); 92 //@} 93 94 #ifdef __cplusplus 95 } 96 #endif 97 /**@}*/ 98 #endif /* _HPL_SLEEP_H_INCLUDED */ 99
