Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/drivers/TimerEvent.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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