Frazer Legge / mbed-rtos

Official mbed Real Time Operating System based on the RTX implementation of the CMSIS-RTOS API open standard.

Dependents:   Assignment_3__Embedded_Software

Fork of mbed-rtos by mbed official

rtos/RtosTimer.h@120:4dc938e301cc, 2016-08-18 (annotated)

Committer:
Kojto
Date:
Thu Aug 18 14:38:56 2016 +0100
Revision:
120:4dc938e301cc
Parent:
119:19af2d39a542
Child:
123:58563e6cba1e
RTOS rev120



Compatible with the mbed library v124



Changes:

- Fix heap limit checking

- Fix set initial stack pointer K64F + stack pointer size

- Fix stack size for NRF51

- Turn on main thread stack check

- Use new deprecate macros

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 120:4dc938e301cc 47 MBED_DEPRECATED_SINCE("mbed-os-5.1",
Kojto 120:4dc938e301cc 48 "Replaced with RtosTimer(Callback<void()>, os_timer_type)")
Kojto 119:19af2d39a542 49 RtosTimer(void (*func)(void const *argument), os_timer_type type=osTimerPeriodic, void *argument=NULL) {
Kojto 119:19af2d39a542 50 constructor(mbed::Callback<void()>(argument, (void (*)(void *))func), type);
Kojto 119:19af2d39a542 51 }
Kojto 119:19af2d39a542 52
Kojto 119:19af2d39a542 53 /** Create timer.
Kojto 119:19af2d39a542 54 @param func function to be executed by this timer.
Kojto 119:19af2d39a542 55 @param type osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic)
emilmont 8:88a1a9c26ae3 56 */
Kojto 119:19af2d39a542 57 RtosTimer(mbed::Callback<void()> func, os_timer_type type=osTimerPeriodic) {
Kojto 119:19af2d39a542 58 constructor(func, type);
Kojto 119:19af2d39a542 59 }
Kojto 119:19af2d39a542 60
Kojto 119:19af2d39a542 61 /** Create timer.
Kojto 119:19af2d39a542 62 @param obj pointer to the object to call the member function on.
Kojto 119:19af2d39a542 63 @param method member function to be executed by this timer.
Kojto 119:19af2d39a542 64 @param type osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic)
Kojto 119:19af2d39a542 65 */
Kojto 119:19af2d39a542 66 template <typename T, typename M>
Kojto 119:19af2d39a542 67 RtosTimer(T *obj, M method, os_timer_type type=osTimerPeriodic) {
Kojto 119:19af2d39a542 68 constructor(mbed::Callback<void()>(obj, method), type);
Kojto 119:19af2d39a542 69 }
mbed_official 31:015df9e602b6 70
emilmont 8:88a1a9c26ae3 71 /** Stop the timer.
mbed_official 31:015df9e602b6 72 @return status code that indicates the execution status of the function.
emilmont 8:88a1a9c26ae3 73 */
emilmont 8:88a1a9c26ae3 74 osStatus stop(void);
mbed_official 31:015df9e602b6 75
Kojto 119:19af2d39a542 76 /** Start the timer.
emilmont 8:88a1a9c26ae3 77 @param millisec time delay value of the timer.
mbed_official 31:015df9e602b6 78 @return status code that indicates the execution status of the function.
emilmont 8:88a1a9c26ae3 79 */
emilmont 8:88a1a9c26ae3 80 osStatus start(uint32_t millisec);
mbed_official 31:015df9e602b6 81
emilmont 8:88a1a9c26ae3 82 ~RtosTimer();
emilmont 8:88a1a9c26ae3 83
emilmont 8:88a1a9c26ae3 84 private:
Kojto 119:19af2d39a542 85 // Required to share definitions without
Kojto 119:19af2d39a542 86 // delegated constructors
Kojto 119:19af2d39a542 87 void constructor(mbed::Callback<void()> func, os_timer_type type);
Kojto 119:19af2d39a542 88
Kojto 119:19af2d39a542 89 mbed::Callback<void()> _function;
emilmont 8:88a1a9c26ae3 90 osTimerId _timer_id;
emilmont 8:88a1a9c26ae3 91 osTimerDef_t _timer;
mbed_official 112:53ace74b190c 92 #if defined(CMSIS_OS_RTX) && !defined(__MBED_CMSIS_RTOS_CM)
emilmont 8:88a1a9c26ae3 93 uint32_t _timer_data[5];
mbed_official 112:53ace74b190c 94 #else
mbed_official 112:53ace74b190c 95 uint32_t _timer_data[6];
emilmont 8:88a1a9c26ae3 96 #endif
emilmont 8:88a1a9c26ae3 97 };
emilmont 8:88a1a9c26ae3 98
emilmont 8:88a1a9c26ae3 99 }
emilmont 8:88a1a9c26ae3 100
emilmont 8:88a1a9c26ae3 101 #endif