PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

hal/ticker_api.h@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

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