Kev Mann / mbed-dev-OS5_10_4

RTC auf true

drivers/TimerEvent.h@0:38ceb79fef03, 2018-11-28 (annotated)

Committer:
kevman
Date:
Wed Nov 28 15:10:15 2018 +0000
Revision:
0:38ceb79fef03
RTC modified

Who changed what in which revision?

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