Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/hal/ticker_api.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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