Greg Steiert / maxim_dev

Maxim mbed development library

Dependents:   sensomed

hal/us_ticker_api.h@0:0e018d759a2a, 2016-11-08 (annotated)

Committer:
switches
Date:
Tue Nov 08 18:27:11 2016 +0000
Revision:
0:0e018d759a2a
Initial commit

Who changed what in which revision?

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