36372 mbed / Mbed 2 deprecated SP14P1_skeleton

skeleton for lab1

Dependencies:   AvailableMemory mbed-rtos mbed

Fork of helloaabbc by 32314 mbed

mbed-rtos/rtos/RtosTimer.h@1:55e99f6e2aa5, 2014-04-04 (annotated)

Committer:
mbed36372
Date:
Fri Apr 04 21:31:22 2014 +0000
Revision:
1:55e99f6e2aa5
Parent:
0:1c8f2727e9f5 
SP14_lab1

Who changed what in which revision?

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