mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

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

hal/ticker_api.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
<> 149:156823d33999 1
<> 149:156823d33999 2 /** \addtogroup hal */
<> 149:156823d33999 3 /** @{*/
<> 144:ef7eb2e8f9f7 4 /* mbed Microcontroller Library
<> 144:ef7eb2e8f9f7 5 * Copyright (c) 2015 ARM Limited
AnnaBridge 189:f392fc9709a3 6 * SPDX-License-Identifier: Apache-2.0
<> 144:ef7eb2e8f9f7 7 *
<> 144:ef7eb2e8f9f7 8 * Licensed under the Apache License, Version 2.0 (the "License");
<> 144:ef7eb2e8f9f7 9 * you may not use this file except in compliance with the License.
<> 144:ef7eb2e8f9f7 10 * You may obtain a copy of the License at
<> 144:ef7eb2e8f9f7 11 *
<> 144:ef7eb2e8f9f7 12 * http://www.apache.org/licenses/LICENSE-2.0
<> 144:ef7eb2e8f9f7 13 *
<> 144:ef7eb2e8f9f7 14 * Unless required by applicable law or agreed to in writing, software
<> 144:ef7eb2e8f9f7 15 * distributed under the License is distributed on an "AS IS" BASIS,
<> 144:ef7eb2e8f9f7 16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<> 144:ef7eb2e8f9f7 17 * See the License for the specific language governing permissions and
<> 144:ef7eb2e8f9f7 18 * limitations under the License.
<> 144:ef7eb2e8f9f7 19 */
<> 144:ef7eb2e8f9f7 20 #ifndef MBED_TICKER_API_H
<> 144:ef7eb2e8f9f7 21 #define MBED_TICKER_API_H
<> 144:ef7eb2e8f9f7 22
<> 144:ef7eb2e8f9f7 23 #include <stdint.h>
AnnaBridge 167:e84263d55307 24 #include <stdbool.h>
<> 144:ef7eb2e8f9f7 25 #include "device.h"
<> 144:ef7eb2e8f9f7 26
AnnaBridge 167:e84263d55307 27 /**
AnnaBridge 167:e84263d55307 28 * Legacy format representing a timestamp in us.
AnnaBridge 167:e84263d55307 29 * Given it is modeled as a 32 bit integer, this type can represent timestamp
AnnaBridge 167:e84263d55307 30 * up to 4294 seconds (71 minutes).
AnnaBridge 167:e84263d55307 31 * Prefer using us_timestamp_t which store timestamp as 64 bits integer.
AnnaBridge 167:e84263d55307 32 */
<> 144:ef7eb2e8f9f7 33 typedef uint32_t timestamp_t;
<> 144:ef7eb2e8f9f7 34
AnnaBridge 167:e84263d55307 35 /**
AnnaBridge 167:e84263d55307 36 * A us timestamp stored in a 64 bit integer.
AnnaBridge 167:e84263d55307 37 * Can store timestamp up to 584810 years.
AnnaBridge 167:e84263d55307 38 */
AnnaBridge 167:e84263d55307 39 typedef uint64_t us_timestamp_t;
AnnaBridge 167:e84263d55307 40
<> 144:ef7eb2e8f9f7 41 /** Ticker's event structure
<> 144:ef7eb2e8f9f7 42 */
<> 144:ef7eb2e8f9f7 43 typedef struct ticker_event_s {
AnnaBridge 167:e84263d55307 44 us_timestamp_t timestamp; /**< Event's timestamp */
<> 144:ef7eb2e8f9f7 45 uint32_t id; /**< TimerEvent object */
<> 144:ef7eb2e8f9f7 46 struct ticker_event_s *next; /**< Next event in the queue */
<> 144:ef7eb2e8f9f7 47 } ticker_event_t;
<> 144:ef7eb2e8f9f7 48
<> 144:ef7eb2e8f9f7 49 typedef void (*ticker_event_handler)(uint32_t id);
<> 144:ef7eb2e8f9f7 50
Anna Bridge 180:96ed750bd169 51 /** Information about the ticker implementation
Anna Bridge 180:96ed750bd169 52 */
Anna Bridge 180:96ed750bd169 53 typedef struct {
Anna Bridge 180:96ed750bd169 54 uint32_t frequency; /**< Frequency in Hz this ticker runs at */
Anna Bridge 180:96ed750bd169 55 uint32_t bits; /**< Number of bits this ticker supports */
Anna Bridge 180:96ed750bd169 56 } ticker_info_t;
Anna Bridge 180:96ed750bd169 57
Anna Bridge 180:96ed750bd169 58
<> 144:ef7eb2e8f9f7 59 /** Ticker's interface structure - required API for a ticker
<> 144:ef7eb2e8f9f7 60 */
<> 144:ef7eb2e8f9f7 61 typedef struct {
<> 144:ef7eb2e8f9f7 62 void (*init)(void); /**< Init function */
<> 144:ef7eb2e8f9f7 63 uint32_t (*read)(void); /**< Read function */
<> 144:ef7eb2e8f9f7 64 void (*disable_interrupt)(void); /**< Disable interrupt function */
<> 144:ef7eb2e8f9f7 65 void (*clear_interrupt)(void); /**< Clear interrupt function */
<> 144:ef7eb2e8f9f7 66 void (*set_interrupt)(timestamp_t timestamp); /**< Set interrupt function */
AnnaBridge 174:b96e65c34a4d 67 void (*fire_interrupt)(void); /**< Fire interrupt right-away */
AnnaBridge 188:bcfe06ba3d64 68 void (*free)(void); /**< Disable function */
Anna Bridge 180:96ed750bd169 69 const ticker_info_t *(*get_info)(void); /**< Return info about this ticker's implementation */
<> 144:ef7eb2e8f9f7 70 } ticker_interface_t;
<> 144:ef7eb2e8f9f7 71
<> 144:ef7eb2e8f9f7 72 /** Ticker's event queue structure
<> 144:ef7eb2e8f9f7 73 */
<> 144:ef7eb2e8f9f7 74 typedef struct {
<> 144:ef7eb2e8f9f7 75 ticker_event_handler event_handler; /**< Event handler */
<> 144:ef7eb2e8f9f7 76 ticker_event_t *head; /**< A pointer to head */
Anna Bridge 180:96ed750bd169 77 uint32_t frequency; /**< Frequency of the timer in Hz */
Anna Bridge 180:96ed750bd169 78 uint32_t bitmask; /**< Mask to be applied to time values read */
Anna Bridge 180:96ed750bd169 79 uint32_t max_delta; /**< Largest delta in ticks that can be used when scheduling */
Anna Bridge 180:96ed750bd169 80 uint64_t max_delta_us; /**< Largest delta in us that can be used when scheduling */
Anna Bridge 180:96ed750bd169 81 uint32_t tick_last_read; /**< Last tick read */
Anna Bridge 180:96ed750bd169 82 uint64_t tick_remainder; /**< Ticks that have not been added to base_time */
AnnaBridge 167:e84263d55307 83 us_timestamp_t present_time; /**< Store the timestamp used for present time */
AnnaBridge 167:e84263d55307 84 bool initialized; /**< Indicate if the instance is initialized */
AnnaBridge 187:0387e8f68319 85 bool dispatching; /**< The function ticker_irq_handler is dispatching */
AnnaBridge 188:bcfe06ba3d64 86 bool suspended; /**< Indicate if the instance is suspended */
AnnaBridge 187:0387e8f68319 87 uint8_t frequency_shifts; /**< If frequency is a value of 2^n, this is n, otherwise 0 */
<> 144:ef7eb2e8f9f7 88 } ticker_event_queue_t;
<> 144:ef7eb2e8f9f7 89
<> 144:ef7eb2e8f9f7 90 /** Ticker's data structure
<> 144:ef7eb2e8f9f7 91 */
<> 144:ef7eb2e8f9f7 92 typedef struct {
<> 144:ef7eb2e8f9f7 93 const ticker_interface_t *interface; /**< Ticker's interface */
<> 144:ef7eb2e8f9f7 94 ticker_event_queue_t *queue; /**< Ticker's event queue */
<> 144:ef7eb2e8f9f7 95 } ticker_data_t;
<> 144:ef7eb2e8f9f7 96
<> 144:ef7eb2e8f9f7 97 #ifdef __cplusplus
<> 144:ef7eb2e8f9f7 98 extern "C" {
<> 144:ef7eb2e8f9f7 99 #endif
<> 144:ef7eb2e8f9f7 100
<> 144:ef7eb2e8f9f7 101 /**
<> 144:ef7eb2e8f9f7 102 * \defgroup hal_ticker Ticker HAL functions
<> 144:ef7eb2e8f9f7 103 * @{
<> 144:ef7eb2e8f9f7 104 */
<> 144:ef7eb2e8f9f7 105
<> 144:ef7eb2e8f9f7 106 /** Initialize a ticker and set the event handler
<> 144:ef7eb2e8f9f7 107 *
AnnaBridge 167:e84263d55307 108 * @param ticker The ticker object.
<> 144:ef7eb2e8f9f7 109 * @param handler A handler to be set
<> 144:ef7eb2e8f9f7 110 */
AnnaBridge 167:e84263d55307 111 void ticker_set_handler(const ticker_data_t *const ticker, ticker_event_handler handler);
<> 144:ef7eb2e8f9f7 112
<> 144:ef7eb2e8f9f7 113 /** IRQ handler that goes through the events to trigger overdue events.
<> 144:ef7eb2e8f9f7 114 *
AnnaBridge 167:e84263d55307 115 * @param ticker The ticker object.
<> 144:ef7eb2e8f9f7 116 */
AnnaBridge 167:e84263d55307 117 void ticker_irq_handler(const ticker_data_t *const ticker);
<> 144:ef7eb2e8f9f7 118
<> 144:ef7eb2e8f9f7 119 /** Remove an event from the queue
<> 144:ef7eb2e8f9f7 120 *
AnnaBridge 167:e84263d55307 121 * @param ticker The ticker object.
<> 144:ef7eb2e8f9f7 122 * @param obj The event object to be removed from the queue
<> 144:ef7eb2e8f9f7 123 */
AnnaBridge 167:e84263d55307 124 void ticker_remove_event(const ticker_data_t *const ticker, ticker_event_t *obj);
<> 144:ef7eb2e8f9f7 125
<> 144:ef7eb2e8f9f7 126 /** Insert an event to the queue
<> 144:ef7eb2e8f9f7 127 *
AnnaBridge 167:e84263d55307 128 * The event will be executed in timestamp - ticker_read().
AnnaBridge 167:e84263d55307 129 *
AnnaBridge 167:e84263d55307 130 * @warning This function does not consider timestamp in the past. If an event
AnnaBridge 167:e84263d55307 131 * is inserted with a timestamp less than the current timestamp then the event
AnnaBridge 167:e84263d55307 132 * will be executed in timestamp - ticker_read() us.
AnnaBridge 167:e84263d55307 133 * The internal counter wrap very quickly it is hard to decide weither an
AnnaBridge 167:e84263d55307 134 * event is in the past or in 1 hour.
AnnaBridge 167:e84263d55307 135 *
AnnaBridge 167:e84263d55307 136 * @note prefer the use of ticker_insert_event_us which allows registration of
AnnaBridge 167:e84263d55307 137 * absolute timestamp.
AnnaBridge 167:e84263d55307 138 *
AnnaBridge 167:e84263d55307 139 * @param ticker The ticker object.
<> 144:ef7eb2e8f9f7 140 * @param obj The event object to be inserted to the queue
<> 144:ef7eb2e8f9f7 141 * @param timestamp The event's timestamp
<> 144:ef7eb2e8f9f7 142 * @param id The event object
<> 144:ef7eb2e8f9f7 143 */
AnnaBridge 167:e84263d55307 144 void ticker_insert_event(const ticker_data_t *const ticker, ticker_event_t *obj, timestamp_t timestamp, uint32_t id);
<> 144:ef7eb2e8f9f7 145
AnnaBridge 167:e84263d55307 146 /** Insert an event to the queue
AnnaBridge 167:e84263d55307 147 *
AnnaBridge 167:e84263d55307 148 * The event will be executed in timestamp - ticker_read_us() us.
AnnaBridge 167:e84263d55307 149 *
AnnaBridge 176:447f873cad2f 150 * @note If an event is inserted with a timestamp less than the current
AnnaBridge 176:447f873cad2f 151 * timestamp then the event will be scheduled immediately resulting in
AnnaBridge 176:447f873cad2f 152 * an instant call to event handler.
<> 144:ef7eb2e8f9f7 153 *
AnnaBridge 167:e84263d55307 154 * @param ticker The ticker object.
AnnaBridge 167:e84263d55307 155 * @param obj The event object to be inserted to the queue
AnnaBridge 167:e84263d55307 156 * @param timestamp The event's timestamp
AnnaBridge 167:e84263d55307 157 * @param id The event object
AnnaBridge 167:e84263d55307 158 */
AnnaBridge 167:e84263d55307 159 void ticker_insert_event_us(const ticker_data_t *const ticker, ticker_event_t *obj, us_timestamp_t timestamp, uint32_t id);
AnnaBridge 167:e84263d55307 160
AnnaBridge 167:e84263d55307 161 /** Read the current (relative) ticker's timestamp
AnnaBridge 167:e84263d55307 162 *
AnnaBridge 167:e84263d55307 163 * @warning Return a relative timestamp because the counter wrap every 4294
AnnaBridge 167:e84263d55307 164 * seconds.
AnnaBridge 167:e84263d55307 165 *
AnnaBridge 167:e84263d55307 166 * @param ticker The ticker object.
<> 144:ef7eb2e8f9f7 167 * @return The current timestamp
<> 144:ef7eb2e8f9f7 168 */
AnnaBridge 167:e84263d55307 169 timestamp_t ticker_read(const ticker_data_t *const ticker);
AnnaBridge 167:e84263d55307 170
AnnaBridge 167:e84263d55307 171 /** Read the current (absolute) ticker's timestamp
AnnaBridge 167:e84263d55307 172 *
AnnaBridge 167:e84263d55307 173 * @warning Return an absolute timestamp counting from the initialization of the
AnnaBridge 167:e84263d55307 174 * ticker.
AnnaBridge 167:e84263d55307 175 *
AnnaBridge 167:e84263d55307 176 * @param ticker The ticker object.
AnnaBridge 167:e84263d55307 177 * @return The current timestamp
AnnaBridge 167:e84263d55307 178 */
AnnaBridge 167:e84263d55307 179 us_timestamp_t ticker_read_us(const ticker_data_t *const ticker);
<> 144:ef7eb2e8f9f7 180
<> 144:ef7eb2e8f9f7 181 /** Read the next event's timestamp
<> 144:ef7eb2e8f9f7 182 *
AnnaBridge 167:e84263d55307 183 * @param ticker The ticker object.
AnnaBridge 167:e84263d55307 184 * @param timestamp The timestamp object.
<> 144:ef7eb2e8f9f7 185 * @return 1 if timestamp is pending event, 0 if there's no event pending
<> 144:ef7eb2e8f9f7 186 */
AnnaBridge 167:e84263d55307 187 int ticker_get_next_timestamp(const ticker_data_t *const ticker, timestamp_t *timestamp);
<> 144:ef7eb2e8f9f7 188
AnnaBridge 188:bcfe06ba3d64 189 /** Suspend this ticker
AnnaBridge 188:bcfe06ba3d64 190 *
AnnaBridge 188:bcfe06ba3d64 191 * When suspended reads will always return the same time and no
AnnaBridge 188:bcfe06ba3d64 192 * events will be dispatched. When suspended the common layer
AnnaBridge 188:bcfe06ba3d64 193 * will only ever call the interface function clear_interrupt()
AnnaBridge 188:bcfe06ba3d64 194 * and that is only if ticker_irq_handler is called.
AnnaBridge 188:bcfe06ba3d64 195 *
AnnaBridge 188:bcfe06ba3d64 196 *
AnnaBridge 188:bcfe06ba3d64 197 * @param ticker The ticker object.
AnnaBridge 188:bcfe06ba3d64 198 */
AnnaBridge 188:bcfe06ba3d64 199 void ticker_suspend(const ticker_data_t *const ticker);
AnnaBridge 188:bcfe06ba3d64 200
AnnaBridge 188:bcfe06ba3d64 201 /** Resume this ticker
AnnaBridge 188:bcfe06ba3d64 202 *
AnnaBridge 188:bcfe06ba3d64 203 * When resumed the ticker will ignore any time that has passed
AnnaBridge 188:bcfe06ba3d64 204 * and continue counting up where it left off.
AnnaBridge 188:bcfe06ba3d64 205 *
AnnaBridge 188:bcfe06ba3d64 206 * @param ticker The ticker object.
AnnaBridge 188:bcfe06ba3d64 207 */
AnnaBridge 188:bcfe06ba3d64 208 void ticker_resume(const ticker_data_t *const ticker);
AnnaBridge 188:bcfe06ba3d64 209
Anna Bridge 180:96ed750bd169 210 /* Private functions
Anna Bridge 180:96ed750bd169 211 *
Anna Bridge 180:96ed750bd169 212 * @cond PRIVATE
Anna Bridge 180:96ed750bd169 213 *
Anna Bridge 180:96ed750bd169 214 */
Anna Bridge 180:96ed750bd169 215
Anna Bridge 180:96ed750bd169 216 int _ticker_match_interval_passed(timestamp_t prev_tick, timestamp_t cur_tick, timestamp_t match_tick);
Anna Bridge 180:96ed750bd169 217
Anna Bridge 180:96ed750bd169 218 /*
Anna Bridge 180:96ed750bd169 219 * @endcond PRIVATE
Anna Bridge 180:96ed750bd169 220 *
Anna Bridge 180:96ed750bd169 221 */
Anna Bridge 180:96ed750bd169 222
<> 144:ef7eb2e8f9f7 223 /**@}*/
<> 144:ef7eb2e8f9f7 224
<> 144:ef7eb2e8f9f7 225 #ifdef __cplusplus
<> 144:ef7eb2e8f9f7 226 }
<> 144:ef7eb2e8f9f7 227 #endif
<> 144:ef7eb2e8f9f7 228
<> 144:ef7eb2e8f9f7 229 #endif
<> 149:156823d33999 230
<> 149:156823d33999 231 /** @}*/