Gan likun / mbed1-dev

001

drivers/TimerEvent.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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