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 _HAL_SLEEP_H_INCLUDED 45 #define _HAL_SLEEP_H_INCLUDED 46 47 #include <hpl_sleep.h> 48 49 #ifdef __cplusplus 50 extern "C" { 51 #endif 52 53 /** 54 * \addtogroup doc_driver_hal_helper_sleep 55 * 56 *@{ 57 */ 58 59 /** 60 * \brief Set the sleep mode of the device and put the MCU to sleep 61 * 62 * For an overview of which systems are disabled in sleep for the different 63 * sleep modes, see the data sheet. 64 * 65 * \param[in] mode Sleep mode to use 66 * 67 * \return The status of a sleep request 68 * \retval -1 The requested sleep mode was invalid or not available 69 * \retval 0 The operation completed successfully, returned after leaving the 70 * sleep 71 */ 72 int sleep(const uint8_t mode); 73 74 /** 75 * \brief Retrieve the current driver version 76 * 77 * \return Current driver version. 78 */ 79 uint32_t sleep_get_version(void); 80 /**@}*/ 81 #ifdef __cplusplus 82 } 83 #endif 84 #endif /* _HAL_SLEEP_H_INCLUDED */ 85
