guiguitant théo / greenhouse1

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.

Dependencies:   mbed

lorawan-SP/mbed/hal/ticker_api.h@0:3fc4a1072bca, 2019-03-28 (annotated)

Committer:
guiguitt
Date:
Thu Mar 28 09:26:33 2019 +0000
Revision:
0:3fc4a1072bca
programme LoRaWan

Who changed what in which revision?

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