Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/hal/ticker_api.h@0:e4c5e6ec922e, 2020-05-25 (annotated)

Committer:
mohamedmoawya
Date:
Mon May 25 19:06:11 2020 +0000
Revision:
0:e4c5e6ec922e
snake game tteest

Who changed what in which revision?

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