mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

platform/DeepSleepLock.h

Committer:
AnnaBridge
Date:
2017-10-02
Revision:
174:b96e65c34a4d
Child:
175:af195413fb11

File content as of revision 174:b96e65c34a4d:

/* mbed Microcontroller Library
 * Copyright (c) 2017 ARM Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#ifndef MBED_DEEPSLEEPLOCK_H
#define MBED_DEEPSLEEPLOCK_H

#include "platform/mbed_sleep.h"

namespace mbed {


/** RAII object for disabling, then restoring the deep sleep mode
  * Usage:
  * @code
  *
  * void f() {
  *     // some code here
  *     {
  *         DeepSleepLock lock;
  *         // Code in this block will run with the deep sleep mode locked
  *     }
  *     // deep sleep mode will be restored to their previous state
  * }
  * @endcode
  */
class DeepSleepLock {
public:
    DeepSleepLock()
    {
        sleep_manager_lock_deep_sleep();
    }

    ~DeepSleepLock()
    {
        sleep_manager_unlock_deep_sleep();
    }

    /** Mark the start of a locked deep sleep section
     */
    void lock()
    {
        sleep_manager_lock_deep_sleep();
    }

    /** Mark the end of a locked deep sleep section
     */
    void unlock()
    {
        sleep_manager_unlock_deep_sleep();
    }
};

}

#endif