Gan likun / mbed1-dev

001

hal/us_ticker_api.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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