Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

drivers/TimerEvent.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

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