Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

hal/us_ticker_api.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

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