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