Nathan Yonkee / Mbed 2 deprecated Nucleo_sinewave_output_copy

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

mbed-os/hal/ticker_api.h@9:d58e77ebd769, 2018-03-02 (annotated)

Committer:
Nathan Yonkee
Date:
Fri Mar 02 07:12:37 2018 -0700
Revision:
9:d58e77ebd769
add mbed-os library

Who changed what in which revision?

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