Martin Cottrell / mbed-dev-bin

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   microbit-dal

Fork of mbed-dev-bin by Lancaster University

ticker_api.h@4:5d949669b10e, 2017-01-13 (annotated)

Committer:
Asimov
Date:
Fri Jan 13 20:58:56 2017 +0000
Revision:
4:5d949669b10e
Parent:
0:e1a608bb55e8 
No real changes?  DemoMicroBit_PCA9685

Who changed what in which revision?

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