mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

hal/lp_ticker_api.h@157:e7ca05fa8600, 2017-11-09 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 09 11:14:10 2017 +0000
Revision:
157:e7ca05fa8600
Parent:
156:ff21514d8981
Child:
160:5571c4ff569f
Release 155 of the mbed library.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1
AnnaBridge 156:ff21514d8981 2 /** \addtogroup hal */
AnnaBridge 156:ff21514d8981 3 /** @{*/
AnnaBridge 156:ff21514d8981 4 /* mbed Microcontroller Library
AnnaBridge 156:ff21514d8981 5 * Copyright (c) 2015 ARM Limited
AnnaBridge 156:ff21514d8981 6 *
AnnaBridge 156:ff21514d8981 7 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 156:ff21514d8981 8 * you may not use this file except in compliance with the License.
AnnaBridge 156:ff21514d8981 9 * You may obtain a copy of the License at
AnnaBridge 156:ff21514d8981 10 *
AnnaBridge 156:ff21514d8981 11 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 156:ff21514d8981 12 *
AnnaBridge 156:ff21514d8981 13 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 156:ff21514d8981 14 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 156:ff21514d8981 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 156:ff21514d8981 16 * See the License for the specific language governing permissions and
AnnaBridge 156:ff21514d8981 17 * limitations under the License.
AnnaBridge 156:ff21514d8981 18 */
AnnaBridge 156:ff21514d8981 19 #ifndef MBED_LPTICKER_API_H
AnnaBridge 156:ff21514d8981 20 #define MBED_LPTICKER_API_H
AnnaBridge 156:ff21514d8981 21
AnnaBridge 156:ff21514d8981 22 #include "device.h"
AnnaBridge 156:ff21514d8981 23
AnnaBridge 156:ff21514d8981 24 #if DEVICE_LOWPOWERTIMER
AnnaBridge 156:ff21514d8981 25
AnnaBridge 156:ff21514d8981 26 #include "hal/ticker_api.h"
AnnaBridge 156:ff21514d8981 27
AnnaBridge 156:ff21514d8981 28 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 29 extern "C" {
AnnaBridge 156:ff21514d8981 30 #endif
AnnaBridge 156:ff21514d8981 31
AnnaBridge 156:ff21514d8981 32 /**
AnnaBridge 156:ff21514d8981 33 * \defgroup hal_LpTicker Low Power Ticker Functions
AnnaBridge 156:ff21514d8981 34 * @{
AnnaBridge 156:ff21514d8981 35 */
AnnaBridge 156:ff21514d8981 36
AnnaBridge 156:ff21514d8981 37 /** Get low power ticker's data
AnnaBridge 156:ff21514d8981 38 *
AnnaBridge 156:ff21514d8981 39 * @return The low power ticker data
AnnaBridge 156:ff21514d8981 40 */
AnnaBridge 156:ff21514d8981 41 const ticker_data_t* get_lp_ticker_data(void);
AnnaBridge 156:ff21514d8981 42
AnnaBridge 156:ff21514d8981 43 /** The wrapper for ticker_irq_handler, to pass lp ticker's data
AnnaBridge 156:ff21514d8981 44 *
AnnaBridge 156:ff21514d8981 45 */
AnnaBridge 156:ff21514d8981 46 void lp_ticker_irq_handler(void);
AnnaBridge 156:ff21514d8981 47
AnnaBridge 156:ff21514d8981 48 /* HAL lp ticker */
AnnaBridge 156:ff21514d8981 49
AnnaBridge 156:ff21514d8981 50 /** Initialize the low power ticker
AnnaBridge 156:ff21514d8981 51 *
AnnaBridge 156:ff21514d8981 52 */
AnnaBridge 156:ff21514d8981 53 void lp_ticker_init(void);
AnnaBridge 156:ff21514d8981 54
AnnaBridge 156:ff21514d8981 55 /** Read the current counter
AnnaBridge 156:ff21514d8981 56 *
AnnaBridge 156:ff21514d8981 57 * @return The current timer's counter value in microseconds
AnnaBridge 156:ff21514d8981 58 */
AnnaBridge 156:ff21514d8981 59 uint32_t lp_ticker_read(void);
AnnaBridge 156:ff21514d8981 60
AnnaBridge 156:ff21514d8981 61 /** Set interrupt for specified timestamp
AnnaBridge 156:ff21514d8981 62 *
AnnaBridge 156:ff21514d8981 63 * @param timestamp The time in microseconds to be set
AnnaBridge 156:ff21514d8981 64 */
AnnaBridge 156:ff21514d8981 65 void lp_ticker_set_interrupt(timestamp_t timestamp);
AnnaBridge 156:ff21514d8981 66
AnnaBridge 156:ff21514d8981 67 /** Disable low power ticker interrupt
AnnaBridge 156:ff21514d8981 68 *
AnnaBridge 156:ff21514d8981 69 */
AnnaBridge 156:ff21514d8981 70 void lp_ticker_disable_interrupt(void);
AnnaBridge 156:ff21514d8981 71
AnnaBridge 156:ff21514d8981 72 /** Clear the low power ticker interrupt
AnnaBridge 156:ff21514d8981 73 *
AnnaBridge 156:ff21514d8981 74 */
AnnaBridge 156:ff21514d8981 75 void lp_ticker_clear_interrupt(void);
AnnaBridge 156:ff21514d8981 76
AnnaBridge 156:ff21514d8981 77 /** Set pending interrupt that should be fired right away.
AnnaBridge 156:ff21514d8981 78 *
AnnaBridge 156:ff21514d8981 79 * The ticker should be initialized prior calling this function.
AnnaBridge 156:ff21514d8981 80 */
AnnaBridge 156:ff21514d8981 81 void lp_ticker_fire_interrupt(void);
AnnaBridge 156:ff21514d8981 82
AnnaBridge 156:ff21514d8981 83 /**@}*/
AnnaBridge 156:ff21514d8981 84
AnnaBridge 156:ff21514d8981 85 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 86 }
AnnaBridge 156:ff21514d8981 87 #endif
AnnaBridge 156:ff21514d8981 88
AnnaBridge 156:ff21514d8981 89 #endif
AnnaBridge 156:ff21514d8981 90
AnnaBridge 156:ff21514d8981 91 #endif
AnnaBridge 156:ff21514d8981 92
AnnaBridge 156:ff21514d8981 93 /** @}*/