KEN OGAMI / mbed-dev-bin

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-dev-bin by Lancaster University

us_ticker_api.h@0:e1a608bb55e8, 2016-04-07 (annotated)

Committer:
jamesadevine
Date:
Thu Apr 07 18:33:58 2016 +0100
Revision:
0:e1a608bb55e8
Added binary version of mbed

Who changed what in which revision?

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