Jhon Plantikow / I2C_EEPROM

I2C_EEPROM

ticker_api.h@0:ac8863619623, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:23:16 2015 +0000
Revision:
0:ac8863619623
I2C

Who changed what in which revision?

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