The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.
Dependents: hello SerialTestv11 SerialTestv12 Sierpinski ... more
mbed 2
This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.
hal/ticker_api.h@138:093f2bd7b9eb, 2017-03-14 (annotated)
- Committer:
- <>
- Date:
- Tue Mar 14 16:20:51 2017 +0000
- Revision:
- 138:093f2bd7b9eb
- Parent:
- 128:9bcdf88f62b0
- Child:
- 145:64910690c574
Release 138 of the mbed library
Ports for Upcoming Targets
Fixes and Changes
3716: fix for issue #3715: correction in startup files for ARM and IAR, alignment of system_stm32f429xx.c files https://github.com/ARMmbed/mbed-os/pull/3716
3741: STM32 remove warning in hal_tick_32b.c file https://github.com/ARMmbed/mbed-os/pull/3741
3780: STM32L4 : Fix GPIO G port compatibility https://github.com/ARMmbed/mbed-os/pull/3780
3831: NCS36510: SPISLAVE enabled (Conflict resolved) https://github.com/ARMmbed/mbed-os/pull/3831
3836: Allow to redefine nRF's PSTORAGE_NUM_OF_PAGES outside of the mbed-os https://github.com/ARMmbed/mbed-os/pull/3836
3840: STM32: gpio SPEED - always set High Speed by default https://github.com/ARMmbed/mbed-os/pull/3840
3844: STM32 GPIO: Typo correction. Update comment (GPIO_IP_WITHOUT_BRR) https://github.com/ARMmbed/mbed-os/pull/3844
3850: STM32: change spi error to debug warning https://github.com/ARMmbed/mbed-os/pull/3850
3860: Define GPIO_IP_WITHOUT_BRR for xDot platform https://github.com/ARMmbed/mbed-os/pull/3860
3880: DISCO_F469NI: allow the use of CAN2 instance when CAN1 is not activated https://github.com/ARMmbed/mbed-os/pull/3880
3795: Fix pwm period calc https://github.com/ARMmbed/mbed-os/pull/3795
3828: STM32 CAN API: correct format and type https://github.com/ARMmbed/mbed-os/pull/3828
3842: TARGET_NRF: corrected spi_init() to properly handle re-initialization https://github.com/ARMmbed/mbed-os/pull/3842
3843: STM32L476xG: set APB2 clock to 80MHz (instead of 40MHz) https://github.com/ARMmbed/mbed-os/pull/3843
3879: NUCLEO_F446ZE: Add missing AnalogIn pins on PF_3, PF_5 and PF_10. https://github.com/ARMmbed/mbed-os/pull/3879
3902: Fix heap and stack size for NUCLEO_F746ZG https://github.com/ARMmbed/mbed-os/pull/3902
3829: can_write(): return error code when no tx mailboxes are available https://github.com/ARMmbed/mbed-os/pull/3829
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
<> | 128:9bcdf88f62b0 | 1 | |
<> | 128:9bcdf88f62b0 | 2 | /** \addtogroup hal */ |
<> | 128:9bcdf88f62b0 | 3 | /** @{*/ |
<> | 128:9bcdf88f62b0 | 4 | /* mbed Microcontroller Library |
<> | 128:9bcdf88f62b0 | 5 | * Copyright (c) 2015 ARM Limited |
<> | 128:9bcdf88f62b0 | 6 | * |
<> | 128:9bcdf88f62b0 | 7 | * Licensed under the Apache License, Version 2.0 (the "License"); |
<> | 128:9bcdf88f62b0 | 8 | * you may not use this file except in compliance with the License. |
<> | 128:9bcdf88f62b0 | 9 | * You may obtain a copy of the License at |
<> | 128:9bcdf88f62b0 | 10 | * |
<> | 128:9bcdf88f62b0 | 11 | * http://www.apache.org/licenses/LICENSE-2.0 |
<> | 128:9bcdf88f62b0 | 12 | * |
<> | 128:9bcdf88f62b0 | 13 | * Unless required by applicable law or agreed to in writing, software |
<> | 128:9bcdf88f62b0 | 14 | * distributed under the License is distributed on an "AS IS" BASIS, |
<> | 128:9bcdf88f62b0 | 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
<> | 128:9bcdf88f62b0 | 16 | * See the License for the specific language governing permissions and |
<> | 128:9bcdf88f62b0 | 17 | * limitations under the License. |
<> | 128:9bcdf88f62b0 | 18 | */ |
<> | 128:9bcdf88f62b0 | 19 | #ifndef MBED_TICKER_API_H |
<> | 128:9bcdf88f62b0 | 20 | #define MBED_TICKER_API_H |
<> | 128:9bcdf88f62b0 | 21 | |
<> | 128:9bcdf88f62b0 | 22 | #include <stdint.h> |
<> | 128:9bcdf88f62b0 | 23 | #include "device.h" |
<> | 128:9bcdf88f62b0 | 24 | |
<> | 128:9bcdf88f62b0 | 25 | typedef uint32_t timestamp_t; |
<> | 128:9bcdf88f62b0 | 26 | |
<> | 128:9bcdf88f62b0 | 27 | /** Ticker's event structure |
<> | 128:9bcdf88f62b0 | 28 | */ |
<> | 128:9bcdf88f62b0 | 29 | typedef struct ticker_event_s { |
<> | 128:9bcdf88f62b0 | 30 | timestamp_t timestamp; /**< Event's timestamp */ |
<> | 128:9bcdf88f62b0 | 31 | uint32_t id; /**< TimerEvent object */ |
<> | 128:9bcdf88f62b0 | 32 | struct ticker_event_s *next; /**< Next event in the queue */ |
<> | 128:9bcdf88f62b0 | 33 | } ticker_event_t; |
<> | 128:9bcdf88f62b0 | 34 | |
<> | 128:9bcdf88f62b0 | 35 | typedef void (*ticker_event_handler)(uint32_t id); |
<> | 128:9bcdf88f62b0 | 36 | |
<> | 128:9bcdf88f62b0 | 37 | /** Ticker's interface structure - required API for a ticker |
<> | 128:9bcdf88f62b0 | 38 | */ |
<> | 128:9bcdf88f62b0 | 39 | typedef struct { |
<> | 128:9bcdf88f62b0 | 40 | void (*init)(void); /**< Init function */ |
<> | 128:9bcdf88f62b0 | 41 | uint32_t (*read)(void); /**< Read function */ |
<> | 128:9bcdf88f62b0 | 42 | void (*disable_interrupt)(void); /**< Disable interrupt function */ |
<> | 128:9bcdf88f62b0 | 43 | void (*clear_interrupt)(void); /**< Clear interrupt function */ |
<> | 128:9bcdf88f62b0 | 44 | void (*set_interrupt)(timestamp_t timestamp); /**< Set interrupt function */ |
<> | 128:9bcdf88f62b0 | 45 | } ticker_interface_t; |
<> | 128:9bcdf88f62b0 | 46 | |
<> | 128:9bcdf88f62b0 | 47 | /** Ticker's event queue structure |
<> | 128:9bcdf88f62b0 | 48 | */ |
<> | 128:9bcdf88f62b0 | 49 | typedef struct { |
<> | 128:9bcdf88f62b0 | 50 | ticker_event_handler event_handler; /**< Event handler */ |
<> | 128:9bcdf88f62b0 | 51 | ticker_event_t *head; /**< A pointer to head */ |
<> | 128:9bcdf88f62b0 | 52 | } ticker_event_queue_t; |
<> | 128:9bcdf88f62b0 | 53 | |
<> | 128:9bcdf88f62b0 | 54 | /** Ticker's data structure |
<> | 128:9bcdf88f62b0 | 55 | */ |
<> | 128:9bcdf88f62b0 | 56 | typedef struct { |
<> | 128:9bcdf88f62b0 | 57 | const ticker_interface_t *interface; /**< Ticker's interface */ |
<> | 128:9bcdf88f62b0 | 58 | ticker_event_queue_t *queue; /**< Ticker's event queue */ |
<> | 128:9bcdf88f62b0 | 59 | } ticker_data_t; |
<> | 128:9bcdf88f62b0 | 60 | |
<> | 128:9bcdf88f62b0 | 61 | #ifdef __cplusplus |
<> | 128:9bcdf88f62b0 | 62 | extern "C" { |
<> | 128:9bcdf88f62b0 | 63 | #endif |
<> | 128:9bcdf88f62b0 | 64 | |
<> | 128:9bcdf88f62b0 | 65 | /** |
<> | 128:9bcdf88f62b0 | 66 | * \defgroup hal_ticker Ticker HAL functions |
<> | 128:9bcdf88f62b0 | 67 | * @{ |
<> | 128:9bcdf88f62b0 | 68 | */ |
<> | 128:9bcdf88f62b0 | 69 | |
<> | 128:9bcdf88f62b0 | 70 | /** Initialize a ticker and set the event handler |
<> | 128:9bcdf88f62b0 | 71 | * |
<> | 128:9bcdf88f62b0 | 72 | * @param data The ticker's data |
<> | 128:9bcdf88f62b0 | 73 | * @param handler A handler to be set |
<> | 128:9bcdf88f62b0 | 74 | */ |
<> | 128:9bcdf88f62b0 | 75 | void ticker_set_handler(const ticker_data_t *const data, ticker_event_handler handler); |
<> | 128:9bcdf88f62b0 | 76 | |
<> | 128:9bcdf88f62b0 | 77 | /** IRQ handler that goes through the events to trigger overdue events. |
<> | 128:9bcdf88f62b0 | 78 | * |
<> | 128:9bcdf88f62b0 | 79 | * @param data The ticker's data |
<> | 128:9bcdf88f62b0 | 80 | */ |
<> | 128:9bcdf88f62b0 | 81 | void ticker_irq_handler(const ticker_data_t *const data); |
<> | 128:9bcdf88f62b0 | 82 | |
<> | 128:9bcdf88f62b0 | 83 | /** Remove an event from the queue |
<> | 128:9bcdf88f62b0 | 84 | * |
<> | 128:9bcdf88f62b0 | 85 | * @param data The ticker's data |
<> | 128:9bcdf88f62b0 | 86 | * @param obj The event object to be removed from the queue |
<> | 128:9bcdf88f62b0 | 87 | */ |
<> | 128:9bcdf88f62b0 | 88 | void ticker_remove_event(const ticker_data_t *const data, ticker_event_t *obj); |
<> | 128:9bcdf88f62b0 | 89 | |
<> | 128:9bcdf88f62b0 | 90 | /** Insert an event to the queue |
<> | 128:9bcdf88f62b0 | 91 | * |
<> | 128:9bcdf88f62b0 | 92 | * @param data The ticker's data |
<> | 128:9bcdf88f62b0 | 93 | * @param obj The event object to be inserted to the queue |
<> | 128:9bcdf88f62b0 | 94 | * @param timestamp The event's timestamp |
<> | 128:9bcdf88f62b0 | 95 | * @param id The event object |
<> | 128:9bcdf88f62b0 | 96 | */ |
<> | 128:9bcdf88f62b0 | 97 | void ticker_insert_event(const ticker_data_t *const data, ticker_event_t *obj, timestamp_t timestamp, uint32_t id); |
<> | 128:9bcdf88f62b0 | 98 | |
<> | 128:9bcdf88f62b0 | 99 | /** Read the current ticker's timestamp |
<> | 128:9bcdf88f62b0 | 100 | * |
<> | 128:9bcdf88f62b0 | 101 | * @param data The ticker's data |
<> | 128:9bcdf88f62b0 | 102 | * @return The current timestamp |
<> | 128:9bcdf88f62b0 | 103 | */ |
<> | 128:9bcdf88f62b0 | 104 | timestamp_t ticker_read(const ticker_data_t *const data); |
<> | 128:9bcdf88f62b0 | 105 | |
<> | 128:9bcdf88f62b0 | 106 | /** Read the next event's timestamp |
<> | 128:9bcdf88f62b0 | 107 | * |
<> | 128:9bcdf88f62b0 | 108 | * @param data The ticker's data |
<> | 128:9bcdf88f62b0 | 109 | * @return 1 if timestamp is pending event, 0 if there's no event pending |
<> | 128:9bcdf88f62b0 | 110 | */ |
<> | 128:9bcdf88f62b0 | 111 | int ticker_get_next_timestamp(const ticker_data_t *const data, timestamp_t *timestamp); |
<> | 128:9bcdf88f62b0 | 112 | |
<> | 128:9bcdf88f62b0 | 113 | /**@}*/ |
<> | 128:9bcdf88f62b0 | 114 | |
<> | 128:9bcdf88f62b0 | 115 | #ifdef __cplusplus |
<> | 128:9bcdf88f62b0 | 116 | } |
<> | 128:9bcdf88f62b0 | 117 | #endif |
<> | 128:9bcdf88f62b0 | 118 | |
<> | 128:9bcdf88f62b0 | 119 | #endif |
<> | 128:9bcdf88f62b0 | 120 | |
<> | 128:9bcdf88f62b0 | 121 | /** @}*/ |