Knight KE / Mbed OS Game_Master

游戏王对战板，目前code还是空的

mbed-os/hal/ticker_api.h@0:9b3d4731edbb, 2018-06-21 (annotated)

Committer:
WFKnight
Date:
Thu Jun 21 13:51:43 2018 +0000
Revision:
0:9b3d4731edbb
UART, RTOS, LED

Who changed what in which revision?

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