1 /** 2 * \file 3 * 4 * \brief Sleep related functionality declaration. 5 * 6 * Copyright (c) 2014-2018 Microchip Technology Inc. and its subsidiaries. 7 * 8 * \asf_license_start 9 * 10 * \page License 11 * 12 * Subject to your compliance with these terms, you may use Microchip 13 * software and any derivatives exclusively with Microchip products. 14 * It is your responsibility to comply with third party license terms applicable 15 * to your use of third party software (including open source software) that 16 * may accompany Microchip software. 17 * 18 * THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, 19 * WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, 20 * INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, 21 * AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT WILL MICROCHIP BE 22 * LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, INCIDENTAL OR CONSEQUENTIAL 23 * LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND WHATSOEVER RELATED TO THE 24 * SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS BEEN ADVISED OF THE 25 * POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE FULLEST EXTENT 26 * ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN ANY WAY 27 * RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY, 28 * THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE. 29 * 30 * \asf_license_stop 31 * 32 */ 33 34 #ifndef _HAL_SLEEP_H_INCLUDED 35 #define _HAL_SLEEP_H_INCLUDED 36 37 #include <hpl_sleep.h> 38 39 #ifdef __cplusplus 40 extern "C" { 41 #endif 42 43 /** 44 * \addtogroup doc_driver_hal_helper_sleep 45 * 46 *@{ 47 */ 48 49 /** 50 * \brief Set the sleep mode of the device and put the MCU to sleep 51 * 52 * For an overview of which systems are disabled in sleep for the different 53 * sleep modes, see the data sheet. 54 * 55 * \param[in] mode Sleep mode to use 56 * 57 * \return The status of a sleep request 58 * \retval -1 The requested sleep mode was invalid or not available 59 * \retval 0 The operation completed successfully, returned after leaving the 60 * sleep 61 */ 62 int sleep(const uint8_t mode); 63 64 /** 65 * \brief Retrieve the current driver version 66 * 67 * \return Current driver version. 68 */ 69 uint32_t sleep_get_version(void); 70 /**@}*/ 71 #ifdef __cplusplus 72 } 73 #endif 74 #endif /* _HAL_SLEEP_H_INCLUDED */ 75