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@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
188:bcfe06ba3d64 
mbed library release version 165

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