Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

targets/TARGET_ONSEMI/TARGET_NCS36510/sleep.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elessair 0:f269e3021894 1 /**
elessair 0:f269e3021894 2 *******************************************************************************
elessair 0:f269e3021894 3 * @file sleep.c
elessair 0:f269e3021894 4 * @brief Implementation of a sleep functionality
elessair 0:f269e3021894 5 * @internal
elessair 0:f269e3021894 6 * @author ON Semiconductor
elessair 0:f269e3021894 7 * $Rev: $
elessair 0:f269e3021894 8 * $Date: $
elessair 0:f269e3021894 9 ******************************************************************************
elessair 0:f269e3021894 10 * Copyright 2016 Semiconductor Components Industries LLC (d/b/a “ON Semiconductor”).
elessair 0:f269e3021894 11 * All rights reserved. This software and/or documentation is licensed by ON Semiconductor
elessair 0:f269e3021894 12 * under limited terms and conditions. The terms and conditions pertaining to the software
elessair 0:f269e3021894 13 * and/or documentation are available at http://www.onsemi.com/site/pdf/ONSEMI_T&C.pdf
elessair 0:f269e3021894 14 * (“ON Semiconductor Standard Terms and Conditions of Sale, Section 8 Software”) and
elessair 0:f269e3021894 15 * if applicable the software license agreement. Do not use this software and/or
elessair 0:f269e3021894 16 * documentation unless you have carefully read and you agree to the limited terms and
elessair 0:f269e3021894 17 * conditions. By using this software and/or documentation, you agree to the limited
elessair 0:f269e3021894 18 * terms and conditions.
elessair 0:f269e3021894 19 *
elessair 0:f269e3021894 20 * THIS SOFTWARE IS PROVIDED "AS IS". NO WARRANTIES, WHETHER EXPRESS, IMPLIED
elessair 0:f269e3021894 21 * OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
elessair 0:f269e3021894 22 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
elessair 0:f269e3021894 23 * ON SEMICONDUCTOR SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL,
elessair 0:f269e3021894 24 * INCIDENTAL, OR CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
elessair 0:f269e3021894 25 * @endinternal
elessair 0:f269e3021894 26 *
elessair 0:f269e3021894 27 * @ingroup sleep
elessair 0:f269e3021894 28 *
elessair 0:f269e3021894 29 * @details
elessair 0:f269e3021894 30 * Sleep implementation TBD - Dummy function is fine for first release
elessair 0:f269e3021894 31 *
elessair 0:f269e3021894 32 */
elessair 0:f269e3021894 33
elessair 0:f269e3021894 34 #ifndef SLEEP_H_
elessair 0:f269e3021894 35 #define SLEEP_H_
elessair 0:f269e3021894 36
elessair 0:f269e3021894 37 /* Orion specific includes */
elessair 0:f269e3021894 38 #include "types.h"
elessair 0:f269e3021894 39 #include "memory_map.h"
elessair 0:f269e3021894 40 #include "gpio_map.h"
elessair 0:f269e3021894 41 #include "pad_map.h"
elessair 0:f269e3021894 42 #include "crossbar.h"
elessair 0:f269e3021894 43 #include "clock.h"
elessair 0:f269e3021894 44
elessair 0:f269e3021894 45 #define SLEEP_TYPE_NONE 0
elessair 0:f269e3021894 46 #define SLEEP_TYPE_SLEEP 1
elessair 0:f269e3021894 47 #define SLEEP_TYPE_DEEPSLEEP 2
elessair 0:f269e3021894 48 #define SLEEP_TYPE_COMA 3
elessair 0:f269e3021894 49
elessair 0:f269e3021894 50 #define SLEEP_TYPE_DEFAULT SLEEP_TYPE_DEEPSLEEP
elessair 0:f269e3021894 51
elessair 0:f269e3021894 52 #define SLEEP_DURATION_SLEEP_MIN 10 /* msec */
elessair 0:f269e3021894 53 #define SLEEP_DURATION_SLEEP_MAX 200 /* msec */
elessair 0:f269e3021894 54 #define SLEEP_DURATION_DEEPSLEEP_MAX 500 /* msec */
elessair 0:f269e3021894 55 #define SLEEP_DURATION_COMA_MAX 1000000000 /* TODO 1000 sec */
elessair 0:f269e3021894 56
elessair 0:f269e3021894 57 void coma(void);
elessair 0:f269e3021894 58
elessair 0:f269e3021894 59 #endif // SLEEP_H_