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