modtronix H / mbed_nz32sc151

mbed library for NZ32-SC151

hal/lp_ticker_api.h@17:639ed60ce759, 2016-08-19 (annotated)

Committer:
modtronix-com
Date:
Fri Aug 19 15:46:42 2016 +1000
Revision:
17:639ed60ce759
Parent:
1:71204b8406f2 
Added tag v1.1 for changeset 076cbe3e55be

Who changed what in which revision?

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