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@166:5aab5a7997ee, 2018-04-20 (annotated)

Committer:
Anna Bridge
Date:
Fri Apr 20 11:08:29 2018 +0100
Revision:
166:5aab5a7997ee
Parent:
160:5571c4ff569f
Child:
169:a7c7b631e539
Updating mbed 2 version number

Who changed what in which revision?

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