Jhon Plantikow / mbed

.

Dependents:   RTC

lp_ticker_api.h@0:88e313c910d0, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:20:09 2015 +0000
Revision:
0:88e313c910d0
RTC Example

Who changed what in which revision?

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