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@136:ef9c61f8c49f, 2017-02-14 (annotated)
- Committer:
- Kojto
- Date:
- Tue Feb 14 11:24:20 2017 +0000
- Revision:
- 136:ef9c61f8c49f
- Parent:
- 128:9bcdf88f62b0
- Child:
- 145:64910690c574
Release 136 of the mbed library
Ports for Upcoming Targets
Fixes and Changes
3432: Target STM USBHOST support https://github.com/ARMmbed/mbed-os/pull/3432
3181: NUCLEO_F207ZG extending PeripheralPins.c: all available alternate functions can be used now https://github.com/ARMmbed/mbed-os/pull/3181
3626: NUCLEO_F412ZG : Add USB Device +Host https://github.com/ARMmbed/mbed-os/pull/3626
3628: Fix warnings https://github.com/ARMmbed/mbed-os/pull/3628
3629: STM32: L0 LL layer https://github.com/ARMmbed/mbed-os/pull/3629
3632: IDE Export support for platform VK_RZ_A1H https://github.com/ARMmbed/mbed-os/pull/3632
3642: Missing IRQ pin fix for platform VK_RZ_A1H https://github.com/ARMmbed/mbed-os/pull/3642
3664: Fix ncs36510 sleep definitions https://github.com/ARMmbed/mbed-os/pull/3664
3655: [STM32F4] Modify folder structure https://github.com/ARMmbed/mbed-os/pull/3655
3657: [STM32L4] Modify folder structure https://github.com/ARMmbed/mbed-os/pull/3657
3658: [STM32F3] Modify folder structure https://github.com/ARMmbed/mbed-os/pull/3658
3685: STM32: I2C: reset state machine https://github.com/ARMmbed/mbed-os/pull/3685
3692: uVisor: Standardize available legacy heap and stack https://github.com/ARMmbed/mbed-os/pull/3692
3621: Fix for #2884, LPC824: export to LPCXpresso, target running with wron https://github.com/ARMmbed/mbed-os/pull/3621
3649: [STM32F7] Modify folder structure https://github.com/ARMmbed/mbed-os/pull/3649
3695: Enforce device_name is valid in targets.json https://github.com/ARMmbed/mbed-os/pull/3695
3723: NCS36510: spi_format function bug fix https://github.com/ARMmbed/mbed-os/pull/3723
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 | /** @}*/ |