Jhon Plantikow / I2C_EEPROM

I2C_EEPROM

sleep_api.h@0:ac8863619623, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:23:16 2015 +0000
Revision:
0:ac8863619623
I2C

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jhon309 0:ac8863619623 1 /* mbed Microcontroller Library
jhon309 0:ac8863619623 2 * Copyright (c) 2006-2013 ARM Limited
jhon309 0:ac8863619623 3 *
jhon309 0:ac8863619623 4 * Licensed under the Apache License, Version 2.0 (the "License");
jhon309 0:ac8863619623 5 * you may not use this file except in compliance with the License.
jhon309 0:ac8863619623 6 * You may obtain a copy of the License at
jhon309 0:ac8863619623 7 *
jhon309 0:ac8863619623 8 * http://www.apache.org/licenses/LICENSE-2.0
jhon309 0:ac8863619623 9 *
jhon309 0:ac8863619623 10 * Unless required by applicable law or agreed to in writing, software
jhon309 0:ac8863619623 11 * distributed under the License is distributed on an "AS IS" BASIS,
jhon309 0:ac8863619623 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
jhon309 0:ac8863619623 13 * See the License for the specific language governing permissions and
jhon309 0:ac8863619623 14 * limitations under the License.
jhon309 0:ac8863619623 15 */
jhon309 0:ac8863619623 16 #ifndef MBED_SLEEP_API_H
jhon309 0:ac8863619623 17 #define MBED_SLEEP_API_H
jhon309 0:ac8863619623 18
jhon309 0:ac8863619623 19 #include "device.h"
jhon309 0:ac8863619623 20
jhon309 0:ac8863619623 21 #if DEVICE_SLEEP
jhon309 0:ac8863619623 22
jhon309 0:ac8863619623 23 #ifdef __cplusplus
jhon309 0:ac8863619623 24 extern "C" {
jhon309 0:ac8863619623 25 #endif
jhon309 0:ac8863619623 26
jhon309 0:ac8863619623 27 /** Send the microcontroller to sleep
jhon309 0:ac8863619623 28 *
jhon309 0:ac8863619623 29 * The processor is setup ready for sleep, and sent to sleep using __WFI(). In this mode, the
jhon309 0:ac8863619623 30 * system clock to the core is stopped until a reset or an interrupt occurs. This eliminates
jhon309 0:ac8863619623 31 * dynamic power used by the processor, memory systems and buses. The processor, peripheral and
jhon309 0:ac8863619623 32 * memory state are maintained, and the peripherals continue to work and can generate interrupts.
jhon309 0:ac8863619623 33 *
jhon309 0:ac8863619623 34 * The processor can be woken up by any internal peripheral interrupt or external pin interrupt.
jhon309 0:ac8863619623 35 *
jhon309 0:ac8863619623 36 * @note
jhon309 0:ac8863619623 37 * The mbed interface semihosting is disconnected as part of going to sleep, and can not be restored.
jhon309 0:ac8863619623 38 * Flash re-programming and the USB serial port will remain active, but the mbed program will no longer be
jhon309 0:ac8863619623 39 * able to access the LocalFileSystem
jhon309 0:ac8863619623 40 */
jhon309 0:ac8863619623 41 void sleep(void);
jhon309 0:ac8863619623 42
jhon309 0:ac8863619623 43 /** Send the microcontroller to deep sleep
jhon309 0:ac8863619623 44 *
jhon309 0:ac8863619623 45 * This processor is setup ready for deep sleep, and sent to sleep using __WFI(). This mode
jhon309 0:ac8863619623 46 * has the same sleep features as sleep plus it powers down peripherals and clocks. All state
jhon309 0:ac8863619623 47 * is still maintained.
jhon309 0:ac8863619623 48 *
jhon309 0:ac8863619623 49 * The processor can only be woken up by an external interrupt on a pin or a watchdog timer.
jhon309 0:ac8863619623 50 *
jhon309 0:ac8863619623 51 * @note
jhon309 0:ac8863619623 52 * The mbed interface semihosting is disconnected as part of going to sleep, and can not be restored.
jhon309 0:ac8863619623 53 * Flash re-programming and the USB serial port will remain active, but the mbed program will no longer be
jhon309 0:ac8863619623 54 * able to access the LocalFileSystem
jhon309 0:ac8863619623 55 */
jhon309 0:ac8863619623 56 void deepsleep(void);
jhon309 0:ac8863619623 57
jhon309 0:ac8863619623 58 #ifdef __cplusplus
jhon309 0:ac8863619623 59 }
jhon309 0:ac8863619623 60 #endif
jhon309 0:ac8863619623 61
jhon309 0:ac8863619623 62 #endif
jhon309 0:ac8863619623 63
jhon309 0:ac8863619623 64 #endif