RtosTimer.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2012 ARM Limited
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy
00005  * of this software and associated documentation files (the "Software"), to deal
00006  * in the Software without restriction, including without limitation the rights
00007  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00008  * copies of the Software, and to permit persons to whom the Software is
00009  * furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included in
00012  * all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00017  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00018  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00019  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
00020  * SOFTWARE.
00021  */
00022 #ifndef RTOS_TIMER_H
00023 #define RTOS_TIMER_H
00024 
00025 #include <stdint.h>
00026 #include "cmsis_os.h"
00027 #include "Callback.h"
00028 #include "toolchain.h"
00029 
00030 namespace rtos {
00031 
00032 /** The RtosTimer class allow creating and and controlling of timer functions in the system.
00033  A timer function is called when a time period expires whereby both on-shot and
00034  periodic timers are possible. A timer can be started, restarted, or stopped.
00035 
00036  Timers are handled in the thread osTimerThread.
00037  Callback functions run under control of this thread and may use CMSIS-RTOS API calls.
00038 */
00039 class RtosTimer {
00040 public:
00041     /** Create timer.
00042       @param   func      function to be executed by this timer.
00043       @param   type      osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic)
00044       @param   argument  argument to the timer call back function. (default: NULL)
00045       @deprecated Replaced with RtosTimer(Callback<void()>, os_timer_type)
00046      */
00047     MBED_DEPRECATED_SINCE("mbed-os-5.1",
00048         "Replaced with RtosTimer(Callback<void()>, os_timer_type)")
00049     RtosTimer(void (*func)(void const *argument), os_timer_type type=osTimerPeriodic, void *argument=NULL) {
00050         constructor(mbed::callback(argument, (void (*)(void *))func), type);
00051     }
00052     
00053     /** Create timer.
00054       @param   func      function to be executed by this timer.
00055       @param   type      osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic)
00056     */
00057     RtosTimer(mbed::Callback<void()> func, os_timer_type type=osTimerPeriodic) {
00058         constructor(func, type);
00059     }
00060     
00061     /** Create timer.
00062       @param   obj       pointer to the object to call the member function on.
00063       @param   method    member function to be executed by this timer.
00064       @param   type      osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic)
00065       @deprecated
00066           The RtosTimer constructor does not support cv-qualifiers. Replaced by
00067           RtosTimer(callback(obj, method), os_timer_type).
00068     */
00069     template <typename T, typename M>
00070     MBED_DEPRECATED_SINCE("mbed-os-5.1",
00071         "The RtosTimer constructor does not support cv-qualifiers. Replaced by "
00072         "RtosTimer(callback(obj, method), os_timer_type).")
00073     RtosTimer(T *obj, M method, os_timer_type type=osTimerPeriodic) {
00074         constructor(mbed::callback(obj, method), type);
00075     }
00076 
00077     /** Stop the timer.
00078       @return  status code that indicates the execution status of the function.
00079     */
00080     osStatus stop(void);
00081 
00082     /** Start the timer.
00083       @param   millisec  time delay value of the timer.
00084       @return  status code that indicates the execution status of the function.
00085     */
00086     osStatus start(uint32_t millisec);
00087 
00088     ~RtosTimer();
00089 
00090 private:
00091     // Required to share definitions without
00092     // delegated constructors
00093     void constructor(mbed::Callback<void()> func, os_timer_type type);
00094     
00095     mbed::Callback<void()> _function;
00096     osTimerId _timer_id;
00097     osTimerDef_t _timer;
00098 #if defined(CMSIS_OS_RTX) && !defined(__MBED_CMSIS_RTOS_CM)
00099     uint32_t _timer_data[5];
00100 #else
00101     uint32_t _timer_data[6];
00102 #endif
00103 };
00104 
00105 }
00106 
00107 #endif