spinal cord / PokittoLib_

PokittoLib is the library needed for programming the Pokitto DIY game console (www.pokitto.com)

mbed-pokitto/hal/sleep_api.h@5:ea7377f3d1af, 2017-10-11 (annotated)

Committer:
Pokitto
Date:
Wed Oct 11 20:35:27 2017 +0000
Revision:
5:ea7377f3d1af
Fixed PokittoLib. Includes a working custom mbed-src

Who changed what in which revision?

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