mbed official / mbed

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.

drivers/TimerEvent.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
163:e59c8e839560 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1 /* mbed Microcontroller Library
AnnaBridge 156:ff21514d8981 2 * Copyright (c) 2006-2013 ARM Limited
AnnaBridge 172:65be27845400 3 * SPDX-License-Identifier: Apache-2.0
AnnaBridge 156:ff21514d8981 4 *
AnnaBridge 156:ff21514d8981 5 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 156:ff21514d8981 6 * you may not use this file except in compliance with the License.
AnnaBridge 156:ff21514d8981 7 * You may obtain a copy of the License at
AnnaBridge 156:ff21514d8981 8 *
AnnaBridge 156:ff21514d8981 9 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 156:ff21514d8981 10 *
AnnaBridge 156:ff21514d8981 11 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 156:ff21514d8981 12 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 156:ff21514d8981 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 156:ff21514d8981 14 * See the License for the specific language governing permissions and
AnnaBridge 156:ff21514d8981 15 * limitations under the License.
AnnaBridge 156:ff21514d8981 16 */
AnnaBridge 156:ff21514d8981 17 #ifndef MBED_TIMEREVENT_H
AnnaBridge 156:ff21514d8981 18 #define MBED_TIMEREVENT_H
AnnaBridge 156:ff21514d8981 19
AnnaBridge 156:ff21514d8981 20 #include "hal/ticker_api.h"
AnnaBridge 156:ff21514d8981 21 #include "hal/us_ticker_api.h"
AnnaBridge 156:ff21514d8981 22 #include "platform/NonCopyable.h"
AnnaBridge 156:ff21514d8981 23
AnnaBridge 156:ff21514d8981 24 namespace mbed {
AnnaBridge 156:ff21514d8981 25 /** \addtogroup drivers */
AnnaBridge 156:ff21514d8981 26
AnnaBridge 156:ff21514d8981 27 /** Base abstraction for timer interrupts
AnnaBridge 156:ff21514d8981 28 *
AnnaBridge 156:ff21514d8981 29 * @note Synchronization level: Interrupt safe
AnnaBridge 156:ff21514d8981 30 * @ingroup drivers
AnnaBridge 156:ff21514d8981 31 */
AnnaBridge 156:ff21514d8981 32 class TimerEvent : private NonCopyable<TimerEvent> {
AnnaBridge 156:ff21514d8981 33 public:
AnnaBridge 156:ff21514d8981 34 TimerEvent();
AnnaBridge 156:ff21514d8981 35 TimerEvent(const ticker_data_t *data);
AnnaBridge 156:ff21514d8981 36
AnnaBridge 156:ff21514d8981 37 /** The handler registered with the underlying timer interrupt
AnnaBridge 156:ff21514d8981 38 *
AnnaBridge 156:ff21514d8981 39 * @param id Timer Event ID
AnnaBridge 156:ff21514d8981 40 */
AnnaBridge 156:ff21514d8981 41 static void irq(uint32_t id);
AnnaBridge 156:ff21514d8981 42
AnnaBridge 156:ff21514d8981 43 /** Destruction removes it...
AnnaBridge 156:ff21514d8981 44 */
AnnaBridge 156:ff21514d8981 45 virtual ~TimerEvent();
AnnaBridge 156:ff21514d8981 46
AnnaBridge 172:65be27845400 47 #if !defined(DOXYGEN_ONLY)
AnnaBridge 156:ff21514d8981 48 protected:
AnnaBridge 156:ff21514d8981 49 // The handler called to service the timer event of the derived class
AnnaBridge 156:ff21514d8981 50 virtual void handler() = 0;
AnnaBridge 156:ff21514d8981 51
AnnaBridge 163:e59c8e839560 52 /** Set relative timestamp of the internal event.
AnnaBridge 163:e59c8e839560 53 * @param timestamp event's us timestamp
AnnaBridge 163:e59c8e839560 54 *
AnnaBridge 163:e59c8e839560 55 * @warning
AnnaBridge 163:e59c8e839560 56 * Do not insert more than one timestamp.
AnnaBridge 163:e59c8e839560 57 * The same @a event object is used for every @a insert/insert_absolute call.
AnnaBridge 163:e59c8e839560 58 *
AnnaBridge 163:e59c8e839560 59 * @warning
AnnaBridge 163:e59c8e839560 60 * Ticker's present timestamp is used for reference. For timestamps
AnnaBridge 163:e59c8e839560 61 * from the past the event is scheduled after ticker's overflow.
AnnaBridge 163:e59c8e839560 62 * For reference @see convert_timestamp
AnnaBridge 163:e59c8e839560 63 */
AnnaBridge 156:ff21514d8981 64 void insert(timestamp_t timestamp);
AnnaBridge 156:ff21514d8981 65
AnnaBridge 163:e59c8e839560 66 /** Set absolute timestamp of the internal event.
AnnaBridge 163:e59c8e839560 67 * @param timestamp event's us timestamp
AnnaBridge 163:e59c8e839560 68 *
AnnaBridge 163:e59c8e839560 69 * @warning
AnnaBridge 163:e59c8e839560 70 * Do not insert more than one timestamp.
AnnaBridge 163:e59c8e839560 71 * The same @a event object is used for every @a insert/insert_absolute call.
AnnaBridge 163:e59c8e839560 72 */
AnnaBridge 156:ff21514d8981 73 void insert_absolute(us_timestamp_t timestamp);
AnnaBridge 156:ff21514d8981 74
AnnaBridge 163:e59c8e839560 75 /** Remove timestamp.
AnnaBridge 163:e59c8e839560 76 */
AnnaBridge 156:ff21514d8981 77 void remove();
AnnaBridge 156:ff21514d8981 78
AnnaBridge 156:ff21514d8981 79 ticker_event_t event;
AnnaBridge 156:ff21514d8981 80
AnnaBridge 156:ff21514d8981 81 const ticker_data_t *_ticker_data;
AnnaBridge 172:65be27845400 82 #endif
AnnaBridge 156:ff21514d8981 83 };
AnnaBridge 156:ff21514d8981 84
AnnaBridge 156:ff21514d8981 85 } // namespace mbed
AnnaBridge 156:ff21514d8981 86
AnnaBridge 156:ff21514d8981 87 #endif