Jhon Plantikow / Dataloger

Dataloger

us_ticker_api.h@0:666850d06c9f, 2015-08-20 (annotated)

Committer:
jhon309
Date:
Thu Aug 20 00:37:14 2015 +0000
Revision:
0:666850d06c9f
ok

Who changed what in which revision?

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