us_ticker_api.h

00001 
00002 /** \addtogroup hal */
00003 /** @{*/
00004 /* mbed Microcontroller Library
00005  * Copyright (c) 2006-2015 ARM Limited
00006  *
00007  * Licensed under the Apache License, Version 2.0 (the "License");
00008  * you may not use this file except in compliance with the License.
00009  * You may obtain a copy of the License at
00010  *
00011  *     http://www.apache.org/licenses/LICENSE-2.0
00012  *
00013  * Unless required by applicable law or agreed to in writing, software
00014  * distributed under the License is distributed on an "AS IS" BASIS,
00015  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00016  * See the License for the specific language governing permissions and
00017  * limitations under the License.
00018  */
00019 #ifndef MBED_US_TICKER_API_H
00020 #define MBED_US_TICKER_API_H
00021 
00022 #include <stdint.h>
00023 #include "hal/ticker_api.h"
00024 
00025 #ifdef __cplusplus
00026 extern "C" {
00027 #endif
00028 
00029 /**
00030  * \defgroup hal_UsTicker Microseconds Ticker Functions
00031  * @{
00032  */
00033 
00034 /** Get ticker's data
00035  *
00036  * @return The low power ticker data
00037  */
00038 const ticker_data_t* get_us_ticker_data(void);
00039 
00040 
00041 /** The wrapper for ticker_irq_handler, to pass us ticker's data
00042  *
00043  */
00044 void us_ticker_irq_handler(void);
00045 
00046 /* HAL us ticker */
00047 
00048 /** Initialize the ticker
00049  *
00050  */
00051 void us_ticker_init(void);
00052 
00053 /** Read the current counter
00054  *
00055  * @return The current timer's counter value in microseconds
00056  */
00057 uint32_t us_ticker_read(void);
00058 
00059 /** Set interrupt for specified timestamp
00060  *
00061  * @param timestamp The time in microseconds to be set
00062  */
00063 void us_ticker_set_interrupt(timestamp_t timestamp);
00064 
00065 /** Disable us ticker interrupt
00066  *
00067  */
00068 void us_ticker_disable_interrupt(void);
00069 
00070 /** Clear us ticker interrupt
00071  *
00072  */
00073 void us_ticker_clear_interrupt(void);
00074 
00075 /**@}*/
00076 
00077 #ifdef __cplusplus
00078 }
00079 #endif
00080 
00081 #endif
00082 
00083 /** @}*/