Joseph Boettcher / mbed-rtos

sdf

Dependencies:   mbed-rtos

Fork of mbed-rtos by mbed official

rtos/RtosTimer.h@119:19af2d39a542, 2016-08-10 (annotated)

Committer:
Kojto
Date:
Wed Aug 10 16:09:20 2016 +0100
Revision:
119:19af2d39a542
Parent:
112:53ace74b190c
Child:
120:4dc938e301cc
RTOS rev119



Compatible with the mbed library v123



Changes:

- new targets: NRF52 and NUC472

- mbed singleton mutex addition

- main thread with timers fix

- Thread - mutex addition for synchronization

- Semaphore - default count argument set to 0

- RTOSTimer - add new ctor with Callback

Who changed what in which revision?

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