Gan likun / mbed-dev11

hal/lp_ticker_api.h@0:06036f8bee2d, 2022-10-24 (annotated)

Committer:
ganlikun
Date:
Mon Oct 24 15:19:39 2022 +0000
Revision:
0:06036f8bee2d
11

Who changed what in which revision?

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