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@157:e7ca05fa8600, 2017-11-09 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 09 11:14:10 2017 +0000
Revision:
157:e7ca05fa8600
Parent:
156:ff21514d8981
Child:
163:e59c8e839560
Release 155 of the mbed library.

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 156:ff21514d8981 3 *
AnnaBridge 156:ff21514d8981 4 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 156:ff21514d8981 5 * you may not use this file except in compliance with the License.
AnnaBridge 156:ff21514d8981 6 * You may obtain a copy of the License at
AnnaBridge 156:ff21514d8981 7 *
AnnaBridge 156:ff21514d8981 8 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 156:ff21514d8981 9 *
AnnaBridge 156:ff21514d8981 10 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 156:ff21514d8981 11 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 156:ff21514d8981 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 156:ff21514d8981 13 * See the License for the specific language governing permissions and
AnnaBridge 156:ff21514d8981 14 * limitations under the License.
AnnaBridge 156:ff21514d8981 15 */
AnnaBridge 156:ff21514d8981 16 #ifndef MBED_TIMEREVENT_H
AnnaBridge 156:ff21514d8981 17 #define MBED_TIMEREVENT_H
AnnaBridge 156:ff21514d8981 18
AnnaBridge 156:ff21514d8981 19 #include "hal/ticker_api.h"
AnnaBridge 156:ff21514d8981 20 #include "hal/us_ticker_api.h"
AnnaBridge 156:ff21514d8981 21 #include "platform/NonCopyable.h"
AnnaBridge 156:ff21514d8981 22
AnnaBridge 156:ff21514d8981 23 namespace mbed {
AnnaBridge 156:ff21514d8981 24 /** \addtogroup drivers */
AnnaBridge 156:ff21514d8981 25
AnnaBridge 156:ff21514d8981 26 /** Base abstraction for timer interrupts
AnnaBridge 156:ff21514d8981 27 *
AnnaBridge 156:ff21514d8981 28 * @note Synchronization level: Interrupt safe
AnnaBridge 156:ff21514d8981 29 * @ingroup drivers
AnnaBridge 156:ff21514d8981 30 */
AnnaBridge 156:ff21514d8981 31 class TimerEvent : private NonCopyable<TimerEvent> {
AnnaBridge 156:ff21514d8981 32 public:
AnnaBridge 156:ff21514d8981 33 TimerEvent();
AnnaBridge 156:ff21514d8981 34 TimerEvent(const ticker_data_t *data);
AnnaBridge 156:ff21514d8981 35
AnnaBridge 156:ff21514d8981 36 /** The handler registered with the underlying timer interrupt
AnnaBridge 156:ff21514d8981 37 *
AnnaBridge 156:ff21514d8981 38 * @param id Timer Event ID
AnnaBridge 156:ff21514d8981 39 */
AnnaBridge 156:ff21514d8981 40 static void irq(uint32_t id);
AnnaBridge 156:ff21514d8981 41
AnnaBridge 156:ff21514d8981 42 /** Destruction removes it...
AnnaBridge 156:ff21514d8981 43 */
AnnaBridge 156:ff21514d8981 44 virtual ~TimerEvent();
AnnaBridge 156:ff21514d8981 45
AnnaBridge 156:ff21514d8981 46 protected:
AnnaBridge 156:ff21514d8981 47 // The handler called to service the timer event of the derived class
AnnaBridge 156:ff21514d8981 48 virtual void handler() = 0;
AnnaBridge 156:ff21514d8981 49
AnnaBridge 156:ff21514d8981 50 // insert relative timestamp in to linked list
AnnaBridge 156:ff21514d8981 51 void insert(timestamp_t timestamp);
AnnaBridge 156:ff21514d8981 52
AnnaBridge 156:ff21514d8981 53 // insert absolute timestamp into linked list
AnnaBridge 156:ff21514d8981 54 void insert_absolute(us_timestamp_t timestamp);
AnnaBridge 156:ff21514d8981 55
AnnaBridge 156:ff21514d8981 56 // remove from linked list, if in it
AnnaBridge 156:ff21514d8981 57 void remove();
AnnaBridge 156:ff21514d8981 58
AnnaBridge 156:ff21514d8981 59 ticker_event_t event;
AnnaBridge 156:ff21514d8981 60
AnnaBridge 156:ff21514d8981 61 const ticker_data_t *_ticker_data;
AnnaBridge 156:ff21514d8981 62 };
AnnaBridge 156:ff21514d8981 63
AnnaBridge 156:ff21514d8981 64 } // namespace mbed
AnnaBridge 156:ff21514d8981 65
AnnaBridge 156:ff21514d8981 66 #endif