mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

hal/mbed_lp_ticker_wrapper.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

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