tool/mbed/mbed-sdk/libraries/rtos/rtos/RtosTimer.h

   1 /* mbed Microcontroller Library
   2  * Copyright (c) 2006-2012 ARM Limited
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a copy
   5  * of this software and associated documentation files (the "Software"), to deal
   6  * in the Software without restriction, including without limitation the rights
   7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8  * copies of the Software, and to permit persons to whom the Software is
   9  * furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  20  * SOFTWARE.
  21  */
  22 #ifndef RTOS_TIMER_H
  23 #define RTOS_TIMER_H
  24
  25 #include <stdint.h>
  26 #include "cmsis_os.h"
  27
  28 namespace rtos {
  29
  30 /** The RtosTimer class allow creating and and controlling of timer functions in the system.
  31  A timer function is called when a time period expires whereby both on-shot and
  32  periodic timers are possible. A timer can be started, restarted, or stopped.
  33
  34  Timers are handled in the thread osTimerThread.
  35  Callback functions run under control of this thread and may use CMSIS-RTOS API calls.
  36 */
  37 class RtosTimer {
  38 public:
  39     /** Create and Start timer.
  40       @param   task      name of the timer call back function.
  41       @param   type      osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic)
  42       @param   argument  argument to the timer call back function. (default: NULL)
  43     */
  44     RtosTimer(void (*task)(void const *argument),
  45           os_timer_type type=osTimerPeriodic,
  46           void *argument=NULL);
  47
  48     /** Stop the timer.
  49       @return  status code that indicates the execution status of the function.
  50     */
  51     osStatus stop(void);
  52
  53     /** start a timer.
  54       @param   millisec  time delay value of the timer.
  55       @return  status code that indicates the execution status of the function.
  56     */
  57     osStatus start(uint32_t millisec);
  58
  59     ~RtosTimer();
  60
  61 private:
  62     osTimerId _timer_id;
  63     osTimerDef_t _timer;
  64 #ifdef CMSIS_OS_RTX
  65     uint32_t _timer_data[5];
  66 #endif
  67 };
  68
  69 }
  70
  71 #endif