BA / SerialCom

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of OmniWheels by Gustav Atmel

mbed-os/hal/lp_ticker_api.h@1:9c5af431a1f1, 2018-05-01 (annotated)

Committer:
gustavatmel
Date:
Tue May 01 15:47:08 2018 +0000
Revision:
1:9c5af431a1f1
sdf

Who changed what in which revision?

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