Juan Salazar / mbed

test

Dependents:   robotic_fish_7

lp_ticker_api.h@0:44931ff4a3ed, 2020-01-14 (annotated)

Committer:
juansal12
Date:
Tue Jan 14 19:14:29 2020 +0000
Revision:
0:44931ff4a3ed
Sofi 7 code;

Who changed what in which revision?

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