Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

hal/lp_ticker_api.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

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