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@182:a56a73fd2a6f, 2018-03-20 (annotated)

Committer:
AnnaBridge
Date:
Tue Mar 20 16:56:18 2018 +0000
Revision:
182:a56a73fd2a6f
Parent:
168:9672193075cf
Child:
189:f392fc9709a3
mbed-dev library. Release version 160

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