Vladimir Vana / mbed

pro vyuku PSS v Jecne

ticker_api.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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