ELEC2645 (2018/19) / Mbed 2 deprecated el17dg

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.

Dependencies:   mbed

Fork of el17dg by Dmitrijs Griskovs

mbed-rtos/rtos/RtosTimer.h@40:e3bbda7444fa, 2019-05-07 (annotated)

Committer:
Noximilien
Date:
Tue May 07 15:22:35 2019 +0000
Revision:
40:e3bbda7444fa
Parent:
1:5aa2312d3e94 
The Final, Submission Version. I have read and agreed to the academic integrity. SID:201160286

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Noximilien 1:5aa2312d3e94 1 /* mbed Microcontroller Library
Noximilien 1:5aa2312d3e94 2 * Copyright (c) 2006-2012 ARM Limited
Noximilien 1:5aa2312d3e94 3 *
Noximilien 1:5aa2312d3e94 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
Noximilien 1:5aa2312d3e94 5 * of this software and associated documentation files (the "Software"), to deal
Noximilien 1:5aa2312d3e94 6 * in the Software without restriction, including without limitation the rights
Noximilien 1:5aa2312d3e94 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
Noximilien 1:5aa2312d3e94 8 * copies of the Software, and to permit persons to whom the Software is
Noximilien 1:5aa2312d3e94 9 * furnished to do so, subject to the following conditions:
Noximilien 1:5aa2312d3e94 10 *
Noximilien 1:5aa2312d3e94 11 * The above copyright notice and this permission notice shall be included in
Noximilien 1:5aa2312d3e94 12 * all copies or substantial portions of the Software.
Noximilien 1:5aa2312d3e94 13 *
Noximilien 1:5aa2312d3e94 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Noximilien 1:5aa2312d3e94 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Noximilien 1:5aa2312d3e94 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
Noximilien 1:5aa2312d3e94 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
Noximilien 1:5aa2312d3e94 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Noximilien 1:5aa2312d3e94 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
Noximilien 1:5aa2312d3e94 20 * SOFTWARE.
Noximilien 1:5aa2312d3e94 21 */
Noximilien 1:5aa2312d3e94 22 #ifndef RTOS_TIMER_H
Noximilien 1:5aa2312d3e94 23 #define RTOS_TIMER_H
Noximilien 1:5aa2312d3e94 24
Noximilien 1:5aa2312d3e94 25 #include <stdint.h>
Noximilien 1:5aa2312d3e94 26 #include "cmsis_os.h"
Noximilien 1:5aa2312d3e94 27 #include "platform/Callback.h"
Noximilien 1:5aa2312d3e94 28 #include "platform/toolchain.h"
Noximilien 1:5aa2312d3e94 29
Noximilien 1:5aa2312d3e94 30 namespace rtos {
Noximilien 1:5aa2312d3e94 31 /** \addtogroup rtos */
Noximilien 1:5aa2312d3e94 32 /** @{*/
Noximilien 1:5aa2312d3e94 33
Noximilien 1:5aa2312d3e94 34 /** The RtosTimer class allow creating and and controlling of timer functions in the system.
Noximilien 1:5aa2312d3e94 35 A timer function is called when a time period expires whereby both on-shot and
Noximilien 1:5aa2312d3e94 36 periodic timers are possible. A timer can be started, restarted, or stopped.
Noximilien 1:5aa2312d3e94 37
Noximilien 1:5aa2312d3e94 38 Timers are handled in the thread osTimerThread.
Noximilien 1:5aa2312d3e94 39 Callback functions run under control of this thread and may use CMSIS-RTOS API calls.
Noximilien 1:5aa2312d3e94 40 */
Noximilien 1:5aa2312d3e94 41 class RtosTimer {
Noximilien 1:5aa2312d3e94 42 public:
Noximilien 1:5aa2312d3e94 43 /** Create timer.
Noximilien 1:5aa2312d3e94 44 @param func function to be executed by this timer.
Noximilien 1:5aa2312d3e94 45 @param type osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic)
Noximilien 1:5aa2312d3e94 46 @param argument argument to the timer call back function. (default: NULL)
Noximilien 1:5aa2312d3e94 47 @deprecated Replaced with RtosTimer(Callback<void()>, os_timer_type)
Noximilien 1:5aa2312d3e94 48 */
Noximilien 1:5aa2312d3e94 49 MBED_DEPRECATED_SINCE("mbed-os-5.1",
Noximilien 1:5aa2312d3e94 50 "Replaced with RtosTimer(Callback<void()>, os_timer_type)")
Noximilien 1:5aa2312d3e94 51 RtosTimer(void (*func)(void const *argument), os_timer_type type=osTimerPeriodic, void *argument=NULL) {
Noximilien 1:5aa2312d3e94 52 constructor(mbed::callback((void (*)(void *))func, argument), type);
Noximilien 1:5aa2312d3e94 53 }
Noximilien 1:5aa2312d3e94 54
Noximilien 1:5aa2312d3e94 55 /** Create timer.
Noximilien 1:5aa2312d3e94 56 @param func function to be executed by this timer.
Noximilien 1:5aa2312d3e94 57 @param type osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic)
Noximilien 1:5aa2312d3e94 58 */
Noximilien 1:5aa2312d3e94 59 RtosTimer(mbed::Callback<void()> func, os_timer_type type=osTimerPeriodic) {
Noximilien 1:5aa2312d3e94 60 constructor(func, type);
Noximilien 1:5aa2312d3e94 61 }
Noximilien 1:5aa2312d3e94 62
Noximilien 1:5aa2312d3e94 63 /** Create timer.
Noximilien 1:5aa2312d3e94 64 @param obj pointer to the object to call the member function on.
Noximilien 1:5aa2312d3e94 65 @param method member function to be executed by this timer.
Noximilien 1:5aa2312d3e94 66 @param type osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic)
Noximilien 1:5aa2312d3e94 67 @deprecated
Noximilien 1:5aa2312d3e94 68 The RtosTimer constructor does not support cv-qualifiers. Replaced by
Noximilien 1:5aa2312d3e94 69 RtosTimer(callback(obj, method), os_timer_type).
Noximilien 1:5aa2312d3e94 70 */
Noximilien 1:5aa2312d3e94 71 template <typename T, typename M>
Noximilien 1:5aa2312d3e94 72 MBED_DEPRECATED_SINCE("mbed-os-5.1",
Noximilien 1:5aa2312d3e94 73 "The RtosTimer constructor does not support cv-qualifiers. Replaced by "
Noximilien 1:5aa2312d3e94 74 "RtosTimer(callback(obj, method), os_timer_type).")
Noximilien 1:5aa2312d3e94 75 RtosTimer(T *obj, M method, os_timer_type type=osTimerPeriodic) {
Noximilien 1:5aa2312d3e94 76 constructor(mbed::callback(obj, method), type);
Noximilien 1:5aa2312d3e94 77 }
Noximilien 1:5aa2312d3e94 78
Noximilien 1:5aa2312d3e94 79 /** Stop the timer.
Noximilien 1:5aa2312d3e94 80 @return status code that indicates the execution status of the function.
Noximilien 1:5aa2312d3e94 81 */
Noximilien 1:5aa2312d3e94 82 osStatus stop(void);
Noximilien 1:5aa2312d3e94 83
Noximilien 1:5aa2312d3e94 84 /** Start the timer.
Noximilien 1:5aa2312d3e94 85 @param millisec time delay value of the timer.
Noximilien 1:5aa2312d3e94 86 @return status code that indicates the execution status of the function.
Noximilien 1:5aa2312d3e94 87 */
Noximilien 1:5aa2312d3e94 88 osStatus start(uint32_t millisec);
Noximilien 1:5aa2312d3e94 89
Noximilien 1:5aa2312d3e94 90 ~RtosTimer();
Noximilien 1:5aa2312d3e94 91
Noximilien 1:5aa2312d3e94 92 private:
Noximilien 1:5aa2312d3e94 93 // Required to share definitions without
Noximilien 1:5aa2312d3e94 94 // delegated constructors
Noximilien 1:5aa2312d3e94 95 void constructor(mbed::Callback<void()> func, os_timer_type type);
Noximilien 1:5aa2312d3e94 96
Noximilien 1:5aa2312d3e94 97 mbed::Callback<void()> _function;
Noximilien 1:5aa2312d3e94 98 osTimerId _timer_id;
Noximilien 1:5aa2312d3e94 99 osTimerDef_t _timer;
Noximilien 1:5aa2312d3e94 100 #if defined(CMSIS_OS_RTX) && !defined(__MBED_CMSIS_RTOS_CM)
Noximilien 1:5aa2312d3e94 101 uint32_t _timer_data[5];
Noximilien 1:5aa2312d3e94 102 #else
Noximilien 1:5aa2312d3e94 103 uint32_t _timer_data[6];
Noximilien 1:5aa2312d3e94 104 #endif
Noximilien 1:5aa2312d3e94 105 };
Noximilien 1:5aa2312d3e94 106
Noximilien 1:5aa2312d3e94 107 }
Noximilien 1:5aa2312d3e94 108
Noximilien 1:5aa2312d3e94 109 #endif
Noximilien 1:5aa2312d3e94 110
Noximilien 1:5aa2312d3e94 111 /** @}*/