Steven Wray / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

hal/ticker_api.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Child:
144:ef7eb2e8f9f7
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 0:9b334a45a8ff 1 /* mbed Microcontroller Library
bogdanm 0:9b334a45a8ff 2 * Copyright (c) 2015 ARM Limited
bogdanm 0:9b334a45a8ff 3 *
bogdanm 0:9b334a45a8ff 4 * Licensed under the Apache License, Version 2.0 (the "License");
bogdanm 0:9b334a45a8ff 5 * you may not use this file except in compliance with the License.
bogdanm 0:9b334a45a8ff 6 * You may obtain a copy of the License at
bogdanm 0:9b334a45a8ff 7 *
bogdanm 0:9b334a45a8ff 8 * http://www.apache.org/licenses/LICENSE-2.0
bogdanm 0:9b334a45a8ff 9 *
bogdanm 0:9b334a45a8ff 10 * Unless required by applicable law or agreed to in writing, software
bogdanm 0:9b334a45a8ff 11 * distributed under the License is distributed on an "AS IS" BASIS,
bogdanm 0:9b334a45a8ff 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
bogdanm 0:9b334a45a8ff 13 * See the License for the specific language governing permissions and
bogdanm 0:9b334a45a8ff 14 * limitations under the License.
bogdanm 0:9b334a45a8ff 15 */
bogdanm 0:9b334a45a8ff 16 #ifndef MBED_TICKER_API_H
bogdanm 0:9b334a45a8ff 17 #define MBED_TICKER_API_H
bogdanm 0:9b334a45a8ff 18
bogdanm 0:9b334a45a8ff 19 #include "device.h"
bogdanm 0:9b334a45a8ff 20
bogdanm 0:9b334a45a8ff 21 typedef uint32_t timestamp_t;
bogdanm 0:9b334a45a8ff 22
bogdanm 0:9b334a45a8ff 23 /** Ticker's event structure
bogdanm 0:9b334a45a8ff 24 */
bogdanm 0:9b334a45a8ff 25 typedef struct ticker_event_s {
bogdanm 0:9b334a45a8ff 26 timestamp_t timestamp; /**< Event's timestamp */
bogdanm 0:9b334a45a8ff 27 uint32_t id; /**< TimerEvent object */
bogdanm 0:9b334a45a8ff 28 struct ticker_event_s *next; /**< Next event in the queue */
bogdanm 0:9b334a45a8ff 29 } ticker_event_t;
bogdanm 0:9b334a45a8ff 30
bogdanm 0:9b334a45a8ff 31 typedef void (*ticker_event_handler)(uint32_t id);
bogdanm 0:9b334a45a8ff 32
bogdanm 0:9b334a45a8ff 33 /** Ticker's interface structure - required API for a ticker
bogdanm 0:9b334a45a8ff 34 */
bogdanm 0:9b334a45a8ff 35 typedef struct {
bogdanm 0:9b334a45a8ff 36 void (*init)(void); /**< Init function */
bogdanm 0:9b334a45a8ff 37 uint32_t (*read)(void); /**< Read function */
bogdanm 0:9b334a45a8ff 38 void (*disable_interrupt)(void); /**< Disable interrupt function */
bogdanm 0:9b334a45a8ff 39 void (*clear_interrupt)(void); /**< Clear interrupt function */
bogdanm 0:9b334a45a8ff 40 void (*set_interrupt)(timestamp_t timestamp); /**< Set interrupt function */
bogdanm 0:9b334a45a8ff 41 } ticker_interface_t;
bogdanm 0:9b334a45a8ff 42
bogdanm 0:9b334a45a8ff 43 /** Tickers events queue structure
bogdanm 0:9b334a45a8ff 44 */
bogdanm 0:9b334a45a8ff 45 typedef struct {
bogdanm 0:9b334a45a8ff 46 ticker_event_handler event_handler; /**< Event handler */
bogdanm 0:9b334a45a8ff 47 ticker_event_t *head; /**< A pointer to head */
bogdanm 0:9b334a45a8ff 48 } ticker_event_queue_t;
bogdanm 0:9b334a45a8ff 49
bogdanm 0:9b334a45a8ff 50 /** Tickers data structure
bogdanm 0:9b334a45a8ff 51 */
bogdanm 0:9b334a45a8ff 52 typedef struct {
bogdanm 0:9b334a45a8ff 53 const ticker_interface_t *interface; /**< Ticker's interface */
bogdanm 0:9b334a45a8ff 54 ticker_event_queue_t *queue; /**< Ticker's events queue */
bogdanm 0:9b334a45a8ff 55 } ticker_data_t;
bogdanm 0:9b334a45a8ff 56
bogdanm 0:9b334a45a8ff 57 #ifdef __cplusplus
bogdanm 0:9b334a45a8ff 58 extern "C" {
bogdanm 0:9b334a45a8ff 59 #endif
bogdanm 0:9b334a45a8ff 60
bogdanm 0:9b334a45a8ff 61 /** Initialize a ticker and sets the event handler
bogdanm 0:9b334a45a8ff 62 *
bogdanm 0:9b334a45a8ff 63 * @param data The ticker's data
bogdanm 0:9b334a45a8ff 64 * @param handler A handler to be set
bogdanm 0:9b334a45a8ff 65 */
bogdanm 0:9b334a45a8ff 66 void ticker_set_handler(const ticker_data_t *const data, ticker_event_handler handler);
bogdanm 0:9b334a45a8ff 67
bogdanm 0:9b334a45a8ff 68 /** Irq handler which goes through the events to trigger events in the past.
bogdanm 0:9b334a45a8ff 69 *
bogdanm 0:9b334a45a8ff 70 * @param data The ticker's data
bogdanm 0:9b334a45a8ff 71 */
bogdanm 0:9b334a45a8ff 72 void ticker_irq_handler(const ticker_data_t *const data);
bogdanm 0:9b334a45a8ff 73
bogdanm 0:9b334a45a8ff 74 /** Remove an event from the queue
bogdanm 0:9b334a45a8ff 75 *
bogdanm 0:9b334a45a8ff 76 * @param data The ticker's data
bogdanm 0:9b334a45a8ff 77 * @param obj The event's queue to be removed
bogdanm 0:9b334a45a8ff 78 */
bogdanm 0:9b334a45a8ff 79 void ticker_remove_event(const ticker_data_t *const data, ticker_event_t *obj);
bogdanm 0:9b334a45a8ff 80
bogdanm 0:9b334a45a8ff 81 /** Insert an event from the queue
bogdanm 0:9b334a45a8ff 82 *
bogdanm 0:9b334a45a8ff 83 * @param data The ticker's data
bogdanm 0:9b334a45a8ff 84 * @param obj The event's queue to be removed
bogdanm 0:9b334a45a8ff 85 * @param timestamp The event's timestamp
bogdanm 0:9b334a45a8ff 86 * @param id The event object
bogdanm 0:9b334a45a8ff 87 */
bogdanm 0:9b334a45a8ff 88 void ticker_insert_event(const ticker_data_t *const data, ticker_event_t *obj, timestamp_t timestamp, uint32_t id);
bogdanm 0:9b334a45a8ff 89
bogdanm 0:9b334a45a8ff 90 /** Read the current ticker's timestamp
bogdanm 0:9b334a45a8ff 91 *
bogdanm 0:9b334a45a8ff 92 * @param data The ticker's data
bogdanm 0:9b334a45a8ff 93 * @return The current timestamp
bogdanm 0:9b334a45a8ff 94 */
bogdanm 0:9b334a45a8ff 95 timestamp_t ticker_read(const ticker_data_t *const data);
bogdanm 0:9b334a45a8ff 96
bogdanm 0:9b334a45a8ff 97 /** Read the next event's timestamp
bogdanm 0:9b334a45a8ff 98 *
bogdanm 0:9b334a45a8ff 99 * @param data The ticker's data
bogdanm 0:9b334a45a8ff 100 * @return 1 if timestamp is pending event, 0 if there's no event pending
bogdanm 0:9b334a45a8ff 101 */
bogdanm 0:9b334a45a8ff 102 int ticker_get_next_timestamp(const ticker_data_t *const data, timestamp_t *timestamp);
bogdanm 0:9b334a45a8ff 103
bogdanm 0:9b334a45a8ff 104 #ifdef __cplusplus
bogdanm 0:9b334a45a8ff 105 }
bogdanm 0:9b334a45a8ff 106 #endif
bogdanm 0:9b334a45a8ff 107
bogdanm 0:9b334a45a8ff 108 #endif