Juan Salazar / sofi7

test

Dependents:   robotic_fish_6

lp_ticker_api.h@0:c792b17d9f78, 2021-12-03 (annotated)

Committer:
juansal12
Date:
Fri Dec 03 23:00:34 2021 +0000
Revision:
0:c792b17d9f78
uploaded sofi code ;

Who changed what in which revision?

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