Paul Paterson / mbed-dev

mbed source development branch

Fork of mbed-dev by mbed official

hal/us_ticker_api.h@144:ef7eb2e8f9f7, 2016-09-02 (annotated)

Committer:
<>
Date:
Fri Sep 02 15:07:44 2016 +0100
Revision:
144:ef7eb2e8f9f7
Parent:
0:9b334a45a8ff
Child:
149:156823d33999
This updates the lib to the mbed lib v125

Who changed what in which revision?

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