mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

hal/us_ticker_api.h@147:a97add6d7e64, 2017-07-19 (annotated)

Committer:
Kojto
Date:
Wed Jul 19 16:46:19 2017 +0100
Revision:
147:a97add6d7e64
Parent:
128:9bcdf88f62b0
Child:
152:235179ab3f27
Release 147 of the mbed library.

Who changed what in which revision?

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