Dream team / mbed-rtos

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

Fork of mbed-rtos by mbed official

rtos/RtosTimer.h@111:de54bc598ef1, 2016-04-29 (annotated)

Committer:
acarter2
Date:
Fri Apr 29 14:04:02 2016 +0000
Revision:
111:de54bc598ef1
current code 2;

Who changed what in which revision?

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