mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

hal/mbed_lp_ticker_wrapper.h@188:bcfe06ba3d64, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:46:34 2018 +0000
Revision:
188:bcfe06ba3d64
Child:
189:f392fc9709a3
mbed-dev library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 188:bcfe06ba3d64 1
AnnaBridge 188:bcfe06ba3d64 2 /** \addtogroup hal */
AnnaBridge 188:bcfe06ba3d64 3 /** @{*/
AnnaBridge 188:bcfe06ba3d64 4 /* mbed Microcontroller Library
AnnaBridge 188:bcfe06ba3d64 5 * Copyright (c) 2018 ARM Limited
AnnaBridge 188:bcfe06ba3d64 6 *
AnnaBridge 188:bcfe06ba3d64 7 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 188:bcfe06ba3d64 8 * you may not use this file except in compliance with the License.
AnnaBridge 188:bcfe06ba3d64 9 * You may obtain a copy of the License at
AnnaBridge 188:bcfe06ba3d64 10 *
AnnaBridge 188:bcfe06ba3d64 11 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 188:bcfe06ba3d64 12 *
AnnaBridge 188:bcfe06ba3d64 13 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 188:bcfe06ba3d64 14 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 188:bcfe06ba3d64 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 188:bcfe06ba3d64 16 * See the License for the specific language governing permissions and
AnnaBridge 188:bcfe06ba3d64 17 * limitations under the License.
AnnaBridge 188:bcfe06ba3d64 18 */
AnnaBridge 188:bcfe06ba3d64 19 #ifndef MBED_LP_TICKER_WRAPPER_H
AnnaBridge 188:bcfe06ba3d64 20 #define MBED_LP_TICKER_WRAPPER_H
AnnaBridge 188:bcfe06ba3d64 21
AnnaBridge 188:bcfe06ba3d64 22 #include "device.h"
AnnaBridge 188:bcfe06ba3d64 23
AnnaBridge 188:bcfe06ba3d64 24 #if DEVICE_LPTICKER
AnnaBridge 188:bcfe06ba3d64 25
AnnaBridge 188:bcfe06ba3d64 26 #include "hal/ticker_api.h"
AnnaBridge 188:bcfe06ba3d64 27 #include <stdbool.h>
AnnaBridge 188:bcfe06ba3d64 28
AnnaBridge 188:bcfe06ba3d64 29 #ifdef __cplusplus
AnnaBridge 188:bcfe06ba3d64 30 extern "C" {
AnnaBridge 188:bcfe06ba3d64 31 #endif
AnnaBridge 188:bcfe06ba3d64 32
AnnaBridge 188:bcfe06ba3d64 33 typedef void (*ticker_irq_handler_type)(const ticker_data_t *const);
AnnaBridge 188:bcfe06ba3d64 34
AnnaBridge 188:bcfe06ba3d64 35 /**
AnnaBridge 188:bcfe06ba3d64 36 * Interrupt handler for the wrapped lp ticker
AnnaBridge 188:bcfe06ba3d64 37 *
AnnaBridge 188:bcfe06ba3d64 38 * @param handler the function which would normally be called by the
AnnaBridge 188:bcfe06ba3d64 39 * lp ticker handler when it is not wrapped
AnnaBridge 188:bcfe06ba3d64 40 */
AnnaBridge 188:bcfe06ba3d64 41 void lp_ticker_wrapper_irq_handler(ticker_irq_handler_type handler);
AnnaBridge 188:bcfe06ba3d64 42
AnnaBridge 188:bcfe06ba3d64 43 /**
AnnaBridge 188:bcfe06ba3d64 44 * Get wrapped lp ticker data
AnnaBridge 188:bcfe06ba3d64 45 *
AnnaBridge 188:bcfe06ba3d64 46 * @param data hardware low power ticker object
AnnaBridge 188:bcfe06ba3d64 47 * @return wrapped low power ticker object
AnnaBridge 188:bcfe06ba3d64 48 */
AnnaBridge 188:bcfe06ba3d64 49 const ticker_data_t *get_lp_ticker_wrapper_data(const ticker_data_t *data);
AnnaBridge 188:bcfe06ba3d64 50
AnnaBridge 188:bcfe06ba3d64 51 /**
AnnaBridge 188:bcfe06ba3d64 52 * Suspend the wrapper layer code
AnnaBridge 188:bcfe06ba3d64 53 *
AnnaBridge 188:bcfe06ba3d64 54 * Pass through all interrupts to the low power ticker and stop using
AnnaBridge 188:bcfe06ba3d64 55 * the microsecond ticker.
AnnaBridge 188:bcfe06ba3d64 56 *
AnnaBridge 188:bcfe06ba3d64 57 * @warning: Make sure to suspend the LP ticker first (call ticker_suspend()),
AnnaBridge 188:bcfe06ba3d64 58 * otherwise the behavior is undefined.
AnnaBridge 188:bcfe06ba3d64 59 */
AnnaBridge 188:bcfe06ba3d64 60 void lp_ticker_wrapper_suspend(void);
AnnaBridge 188:bcfe06ba3d64 61
AnnaBridge 188:bcfe06ba3d64 62 /**
AnnaBridge 188:bcfe06ba3d64 63 * Resume the wrapper layer code
AnnaBridge 188:bcfe06ba3d64 64 *
AnnaBridge 188:bcfe06ba3d64 65 * Resume operation of the wrapper layer. Interrupts will be filtered
AnnaBridge 188:bcfe06ba3d64 66 * as normal and the microsecond timer will be used for interrupts scheduled
AnnaBridge 188:bcfe06ba3d64 67 * too quickly back-to-back.
AnnaBridge 188:bcfe06ba3d64 68 */
AnnaBridge 188:bcfe06ba3d64 69 void lp_ticker_wrapper_resume(void);
AnnaBridge 188:bcfe06ba3d64 70
AnnaBridge 188:bcfe06ba3d64 71 /**@}*/
AnnaBridge 188:bcfe06ba3d64 72
AnnaBridge 188:bcfe06ba3d64 73 #ifdef __cplusplus
AnnaBridge 188:bcfe06ba3d64 74 }
AnnaBridge 188:bcfe06ba3d64 75 #endif
AnnaBridge 188:bcfe06ba3d64 76
AnnaBridge 188:bcfe06ba3d64 77 #endif
AnnaBridge 188:bcfe06ba3d64 78
AnnaBridge 188:bcfe06ba3d64 79 #endif
AnnaBridge 188:bcfe06ba3d64 80
AnnaBridge 188:bcfe06ba3d64 81 /** @}*/