Paul Paterson / mbed-dev

mbed source development branch

Fork of mbed-dev by mbed official

hal/lp_ticker_api.h@149:156823d33999, 2016-10-28 (annotated)

Committer:
<>
Date:
Fri Oct 28 11:17:30 2016 +0100
Revision:
149:156823d33999
Parent:
144:ef7eb2e8f9f7 
This updates the lib to the mbed lib v128



NOTE: This release includes a restructuring of the file and directory locations and thus some

include paths in your code may need updating accordingly.

Who changed what in which revision?

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