John Karatka / mbed

mbed

Fork of mbed-dev by mbed official

hal/us_ticker_api.h@182:57724642e740, 2018-02-16 (annotated)

Committer:
AnnaBridge
Date:
Fri Feb 16 16:09:33 2018 +0000
Revision:
182:57724642e740
Parent:
181:96ed750bd169 
mbed-dev library. Release version 159.

Who changed what in which revision?

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