John Karatka / mbed

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-dev by mbed official

drivers/TimerEvent.h@167:e84263d55307, 2017-06-21 (annotated)

Committer:
AnnaBridge
Date:
Wed Jun 21 17:46:44 2017 +0100
Revision:
167:e84263d55307
Parent:
149:156823d33999
Child:
168:9672193075cf
This updates the lib to the mbed lib v 145

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"
<> 149:156823d33999 21
<> 149:156823d33999 22 namespace mbed {
<> 149:156823d33999 23 /** \addtogroup drivers */
<> 149:156823d33999 24
<> 149:156823d33999 25 /** Base abstraction for timer interrupts
<> 149:156823d33999 26 *
AnnaBridge 167:e84263d55307 27 * @note Synchronization level: Interrupt safe
AnnaBridge 167:e84263d55307 28 * @ingroup drivers
<> 149:156823d33999 29 */
<> 149:156823d33999 30 class TimerEvent {
<> 149:156823d33999 31 public:
<> 149:156823d33999 32 TimerEvent();
<> 149:156823d33999 33 TimerEvent(const ticker_data_t *data);
<> 149:156823d33999 34
<> 149:156823d33999 35 /** The handler registered with the underlying timer interrupt
AnnaBridge 167:e84263d55307 36 *
AnnaBridge 167:e84263d55307 37 * @param id Timer Event ID
<> 149:156823d33999 38 */
<> 149:156823d33999 39 static void irq(uint32_t id);
<> 149:156823d33999 40
<> 149:156823d33999 41 /** Destruction removes it...
<> 149:156823d33999 42 */
<> 149:156823d33999 43 virtual ~TimerEvent();
<> 149:156823d33999 44
<> 149:156823d33999 45 protected:
<> 149:156823d33999 46 // The handler called to service the timer event of the derived class
<> 149:156823d33999 47 virtual void handler() = 0;
<> 149:156823d33999 48
AnnaBridge 167:e84263d55307 49 // insert relative timestamp in to linked list
<> 149:156823d33999 50 void insert(timestamp_t timestamp);
<> 149:156823d33999 51
AnnaBridge 167:e84263d55307 52 // insert absolute timestamp into linked list
AnnaBridge 167:e84263d55307 53 void insert_absolute(us_timestamp_t timestamp);
AnnaBridge 167:e84263d55307 54
<> 149:156823d33999 55 // remove from linked list, if in it
<> 149:156823d33999 56 void remove();
<> 149:156823d33999 57
<> 149:156823d33999 58 ticker_event_t event;
<> 149:156823d33999 59
<> 149:156823d33999 60 const ticker_data_t *_ticker_data;
<> 149:156823d33999 61 };
<> 149:156823d33999 62
<> 149:156823d33999 63 } // namespace mbed
<> 149:156823d33999 64
<> 149:156823d33999 65 #endif