Umar Naeem / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by Umar Naeem

hal/us_ticker_api.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Child:
144:ef7eb2e8f9f7
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

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