Damian Gabino / picoGW_mcu

MCU driver/HAL for the Picocell Gateway concentrator board. The firmware implements either a USB CDC protocol or a UART protocol to bridge commands coming from host to the SX1308 SPI interface.

src/mbed-dev/hal/sleep_api.h@0:c76361bd82e8, 2018-04-11 (annotated)

Committer:
dgabino
Date:
Wed Apr 11 14:42:47 2018 +0000
Revision:
0:c76361bd82e8
Initial commit

Who changed what in which revision?

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