Kev Mann / mbed-dev-OS5_10_4

RTC auf true

hal/ticker_api.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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