Greg Steiert / pegasus_dev

Development mbed library for MAX32630FTHR

Dependents:   blinky_max32630fthr

hal/lp_ticker_api.h@0:5c4d7b2438d3, 2016-11-11 (annotated)

Committer:
switches
Date:
Fri Nov 11 20:59:50 2016 +0000
Revision:
0:5c4d7b2438d3
Initial commit

Who changed what in which revision?

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