Daiki Kato / mbed-os-lychee

mbed-os for GR-LYCHEE

Dependents:   mbed-os-example-blinky-gr-lychee GR-Boads_Camera_sample GR-Boards_Audio_Recoder GR-Boads_Camera_DisplayApp ... more

hal/ticker_api.h@0:f782d9c66c49, 2018-02-02 (annotated)

Committer:
dkato
Date:
Fri Feb 02 05:42:23 2018 +0000
Revision:
0:f782d9c66c49
mbed-os for GR-LYCHEE

Who changed what in which revision?

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