zhang boie / mbed-dev-f30333

hal/lp_ticker_api.h@0:bdf663c61a82, 2022-06-14 (annotated)

Committer:
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4
Date:
Tue Jun 14 09:21:18 2022 +0000
Revision:
0:bdf663c61a82
lib

Who changed what in which revision?

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