R L / mbed-src

mbed library sources

Fork of mbed-src by mbed official

hal/us_ticker_api.h@636:21ce76d41a4f, 2016-02-21 (annotated)

Committer:
rllamado
Date:
Sun Feb 21 07:27:08 2016 +0000
Revision:
636:21ce76d41a4f
Parent:
525:c320967f86b9 
something

Who changed what in which revision?

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