initial

Dependencies:   mbed

Committer:
yihui
Date:
Mon Jan 11 02:32:24 2016 +0000
Revision:
0:638edba3adf6
initial

Who changed what in which revision?

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