| Kévin Redon | 69b92d9 | 2019-01-24 16:39:20 +0100 | [diff] [blame] | 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 _HPL_SLEEP_H_INCLUDED |
| 35 | #define _HPL_SLEEP_H_INCLUDED |
| 36 | |
| 37 | /** |
| 38 | * \addtogroup HPL Sleep |
| 39 | * |
| 40 | * \section hpl_sleep_rev Revision History |
| 41 | * - v1.0.0 Initial Release |
| 42 | * |
| 43 | *@{ |
| 44 | */ |
| 45 | |
| 46 | #ifndef _UNIT_TEST_ |
| 47 | #include <compiler.h> |
| 48 | #endif |
| 49 | |
| 50 | #ifdef __cplusplus |
| 51 | extern "C" { |
| 52 | #endif |
| 53 | |
| 54 | /** |
| 55 | * \name HPL functions |
| 56 | */ |
| 57 | //@{ |
| 58 | /** |
| 59 | * \brief Set the sleep mode for the device |
| 60 | * |
| 61 | * This function sets the sleep mode for the device. |
| 62 | * For an overview of which systems are disabled in sleep for the different |
| 63 | * sleep modes see datasheet. |
| 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 |
| 69 | * \retval 0 The operation completed successfully, sleep mode is set |
| 70 | */ |
| 71 | int32_t _set_sleep_mode(const uint8_t mode); |
| 72 | |
| 73 | /** |
| 74 | * \brief Reset MCU |
| 75 | */ |
| 76 | void _reset_mcu(void); |
| 77 | |
| 78 | /** |
| 79 | * \brief Put MCU to sleep |
| 80 | */ |
| 81 | void _go_to_sleep(void); |
| 82 | //@} |
| 83 | |
| 84 | #ifdef __cplusplus |
| 85 | } |
| 86 | #endif |
| 87 | /**@}*/ |
| 88 | #endif /* _HPL_SLEEP_H_INCLUDED */ |