EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

hal/us_ticker_api.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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