mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

drivers/TimerEvent.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
182:a56a73fd2a6f 
mbed library release version 165

Who changed what in which revision?

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