Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/drivers/TimerEvent.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

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