Dylan Saada / Mbed 2 deprecated telemetre2

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

USBHost/mbed-rtos/rtos/RtosTimer.h@0:6ce9c65992e5, 2015-04-15 (annotated)

Committer:
dylancachan
Date:
Wed Apr 15 06:23:18 2015 +0000
Revision:
0:6ce9c65992e5
telemetre

Who changed what in which revision?

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