Jhon Plantikow / Dataloger

Dataloger

ticker_api.h@0:666850d06c9f, 2015-08-20 (annotated)

Committer:
jhon309
Date:
Thu Aug 20 00:37:14 2015 +0000
Revision:
0:666850d06c9f
ok

Who changed what in which revision?

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