LowPowerTicker.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2015 ARM Limited
00003  * SPDX-License-Identifier: Apache-2.0
00004  *
00005  * Licensed under the Apache License, Version 2.0 (the "License");
00006  * you may not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  *     http://www.apache.org/licenses/LICENSE-2.0
00010  *
00011  * Unless required by applicable law or agreed to in writing, software
00012  * distributed under the License is distributed on an "AS IS" BASIS,
00013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  * See the License for the specific language governing permissions and
00015  * limitations under the License.
00016  */
00017 #ifndef MBED_LOWPOWERTICKER_H
00018 #define MBED_LOWPOWERTICKER_H
00019 
00020 #include "platform/platform.h"
00021 #include "drivers/Ticker.h"
00022 #include "platform/NonCopyable.h"
00023 
00024 #if defined (DEVICE_LPTICKER) || defined(DOXYGEN_ONLY)
00025 
00026 #include "hal/lp_ticker_api.h"
00027 
00028 namespace mbed {
00029 /** \defgroup drivers-public-api-ticker Ticker
00030  * \ingroup drivers-public-api
00031  */
00032 
00033 /**
00034  * \defgroup drivers_LowPowerTicker LowPowerTicker class
00035  * \ingroup drivers-public-api-ticker
00036  * @{
00037  */
00038 
00039 /** Low Power Ticker
00040  *
00041  * @note Synchronization level: Interrupt safe
00042  */
00043 class LowPowerTicker : public Ticker, private NonCopyable<LowPowerTicker> {
00044 
00045 public:
00046     LowPowerTicker() : Ticker(get_lp_ticker_data())
00047     {
00048     }
00049 
00050     virtual ~LowPowerTicker()
00051     {
00052     }
00053 };
00054 
00055 /** @}*/
00056 
00057 } // namespace mbed
00058 
00059 #endif
00060 
00061 #endif