Aravind Vadali / mbed-src-AV

mbed.h library with any bug fixes AV finds.

Dependents:   micromouse4_encoder_testing PID_Test Lab1_Test WorkingPID ... more

hal/ticker_api.h@1:ebce2ad32f95, 2015-11-02 (annotated)

Committer:
aravindsv
Date:
Mon Nov 02 03:07:12 2015 +0000
Revision:
1:ebce2ad32f95
Parent:
0:ba7650f404af 
Changed the RCC timeout value to 500 ms, so total code startup time before program starts running is ~1s. Hopefully no side-effects from lower startup timeouts

Who changed what in which revision?

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