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@160:5571c4ff569f, 2018-01-17 (annotated)

Committer:
Anna Bridge
Date:
Wed Jan 17 16:13:02 2018 +0000
Revision:
160:5571c4ff569f
Parent:
156:ff21514d8981
Child:
169:a7c7b631e539
mbed library. Release version 158

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
Anna Bridge 160:5571c4ff569f 37 typedef void (*ticker_irq_handler_type)(const ticker_data_t *const);
Anna Bridge 160:5571c4ff569f 38
Anna Bridge 160:5571c4ff569f 39 /** Set low power ticker IRQ handler
Anna Bridge 160:5571c4ff569f 40 *
Anna Bridge 160:5571c4ff569f 41 * @param ticker_irq_handler IRQ handler to be connected
Anna Bridge 160:5571c4ff569f 42 *
Anna Bridge 160:5571c4ff569f 43 * @return previous ticker IRQ handler
Anna Bridge 160:5571c4ff569f 44 *
Anna Bridge 160:5571c4ff569f 45 * @note by default IRQ handler is set to ticker_irq_handler()
Anna Bridge 160:5571c4ff569f 46 * @note this function is primarily for testing purposes and it's not required part of HAL implementation
Anna Bridge 160:5571c4ff569f 47 *
Anna Bridge 160:5571c4ff569f 48 */
Anna Bridge 160:5571c4ff569f 49 ticker_irq_handler_type set_lp_ticker_irq_handler(ticker_irq_handler_type ticker_irq_handler);
Anna Bridge 160:5571c4ff569f 50
AnnaBridge 156:ff21514d8981 51 /** Get low power ticker's data
AnnaBridge 156:ff21514d8981 52 *
AnnaBridge 156:ff21514d8981 53 * @return The low power ticker data
AnnaBridge 156:ff21514d8981 54 */
AnnaBridge 156:ff21514d8981 55 const ticker_data_t* get_lp_ticker_data(void);
AnnaBridge 156:ff21514d8981 56
AnnaBridge 156:ff21514d8981 57 /** The wrapper for ticker_irq_handler, to pass lp ticker's data
AnnaBridge 156:ff21514d8981 58 *
AnnaBridge 156:ff21514d8981 59 */
AnnaBridge 156:ff21514d8981 60 void lp_ticker_irq_handler(void);
AnnaBridge 156:ff21514d8981 61
AnnaBridge 156:ff21514d8981 62 /* HAL lp ticker */
AnnaBridge 156:ff21514d8981 63
AnnaBridge 156:ff21514d8981 64 /** Initialize the low power ticker
AnnaBridge 156:ff21514d8981 65 *
AnnaBridge 156:ff21514d8981 66 */
AnnaBridge 156:ff21514d8981 67 void lp_ticker_init(void);
AnnaBridge 156:ff21514d8981 68
AnnaBridge 156:ff21514d8981 69 /** Read the current counter
AnnaBridge 156:ff21514d8981 70 *
AnnaBridge 156:ff21514d8981 71 * @return The current timer's counter value in microseconds
AnnaBridge 156:ff21514d8981 72 */
AnnaBridge 156:ff21514d8981 73 uint32_t lp_ticker_read(void);
AnnaBridge 156:ff21514d8981 74
AnnaBridge 156:ff21514d8981 75 /** Set interrupt for specified timestamp
AnnaBridge 156:ff21514d8981 76 *
AnnaBridge 156:ff21514d8981 77 * @param timestamp The time in microseconds to be set
AnnaBridge 156:ff21514d8981 78 */
AnnaBridge 156:ff21514d8981 79 void lp_ticker_set_interrupt(timestamp_t timestamp);
AnnaBridge 156:ff21514d8981 80
AnnaBridge 156:ff21514d8981 81 /** Disable low power ticker interrupt
AnnaBridge 156:ff21514d8981 82 *
AnnaBridge 156:ff21514d8981 83 */
AnnaBridge 156:ff21514d8981 84 void lp_ticker_disable_interrupt(void);
AnnaBridge 156:ff21514d8981 85
AnnaBridge 156:ff21514d8981 86 /** Clear the low power ticker interrupt
AnnaBridge 156:ff21514d8981 87 *
AnnaBridge 156:ff21514d8981 88 */
AnnaBridge 156:ff21514d8981 89 void lp_ticker_clear_interrupt(void);
AnnaBridge 156:ff21514d8981 90
AnnaBridge 156:ff21514d8981 91 /** Set pending interrupt that should be fired right away.
AnnaBridge 156:ff21514d8981 92 *
AnnaBridge 156:ff21514d8981 93 * The ticker should be initialized prior calling this function.
AnnaBridge 156:ff21514d8981 94 */
AnnaBridge 156:ff21514d8981 95 void lp_ticker_fire_interrupt(void);
AnnaBridge 156:ff21514d8981 96
Anna Bridge 160:5571c4ff569f 97 /** Get frequency and counter bits of this ticker.
Anna Bridge 160:5571c4ff569f 98 *
Anna Bridge 160:5571c4ff569f 99 */
Anna Bridge 160:5571c4ff569f 100 const ticker_info_t* lp_ticker_get_info(void);
Anna Bridge 160:5571c4ff569f 101
AnnaBridge 156:ff21514d8981 102 /**@}*/
AnnaBridge 156:ff21514d8981 103
AnnaBridge 156:ff21514d8981 104 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 105 }
AnnaBridge 156:ff21514d8981 106 #endif
AnnaBridge 156:ff21514d8981 107
AnnaBridge 156:ff21514d8981 108 #endif
AnnaBridge 156:ff21514d8981 109
AnnaBridge 156:ff21514d8981 110 #endif
AnnaBridge 156:ff21514d8981 111
AnnaBridge 156:ff21514d8981 112 /** @}*/