Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/hal/lp_ticker_api.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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