PHung Tung / DISCO-F746_WAV_PLAYER

SPKT

Dependencies:   F746_GUI SD_PlayerSkeleton F746_SAI_IO

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

Committer:
phungductung
Date:
Tue Jun 04 21:37:21 2019 +0000
Revision:
0:8ede47d38d10
SPKT

Who changed what in which revision?

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