takashi kadono / Mbed OS Nucleo446_SSD1331

Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466

Dependencies:   ssd1331

mbed-os/rtos/RtosTimer.h@0:8fdf9a60065b, 2018-10-10 (annotated)

Committer:
kadonotakashi
Date:
Wed Oct 10 00:33:53 2018 +0000
Revision:
0:8fdf9a60065b
how to make mbed librry

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kadonotakashi 0:8fdf9a60065b 1 /* mbed Microcontroller Library
kadonotakashi 0:8fdf9a60065b 2 * Copyright (c) 2006-2012 ARM Limited
kadonotakashi 0:8fdf9a60065b 3 *
kadonotakashi 0:8fdf9a60065b 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
kadonotakashi 0:8fdf9a60065b 5 * of this software and associated documentation files (the "Software"), to deal
kadonotakashi 0:8fdf9a60065b 6 * in the Software without restriction, including without limitation the rights
kadonotakashi 0:8fdf9a60065b 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
kadonotakashi 0:8fdf9a60065b 8 * copies of the Software, and to permit persons to whom the Software is
kadonotakashi 0:8fdf9a60065b 9 * furnished to do so, subject to the following conditions:
kadonotakashi 0:8fdf9a60065b 10 *
kadonotakashi 0:8fdf9a60065b 11 * The above copyright notice and this permission notice shall be included in
kadonotakashi 0:8fdf9a60065b 12 * all copies or substantial portions of the Software.
kadonotakashi 0:8fdf9a60065b 13 *
kadonotakashi 0:8fdf9a60065b 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
kadonotakashi 0:8fdf9a60065b 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
kadonotakashi 0:8fdf9a60065b 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
kadonotakashi 0:8fdf9a60065b 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
kadonotakashi 0:8fdf9a60065b 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
kadonotakashi 0:8fdf9a60065b 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
kadonotakashi 0:8fdf9a60065b 20 * SOFTWARE.
kadonotakashi 0:8fdf9a60065b 21 */
kadonotakashi 0:8fdf9a60065b 22 #ifndef RTOS_TIMER_H
kadonotakashi 0:8fdf9a60065b 23 #define RTOS_TIMER_H
kadonotakashi 0:8fdf9a60065b 24
kadonotakashi 0:8fdf9a60065b 25 #include <stdint.h>
kadonotakashi 0:8fdf9a60065b 26 #include "cmsis_os2.h"
kadonotakashi 0:8fdf9a60065b 27 #include "mbed_rtos_storage.h"
kadonotakashi 0:8fdf9a60065b 28 #include "platform/Callback.h"
kadonotakashi 0:8fdf9a60065b 29 #include "platform/NonCopyable.h"
kadonotakashi 0:8fdf9a60065b 30 #include "platform/mbed_toolchain.h"
kadonotakashi 0:8fdf9a60065b 31 #include "mbed_rtos1_types.h"
kadonotakashi 0:8fdf9a60065b 32
kadonotakashi 0:8fdf9a60065b 33 namespace rtos {
kadonotakashi 0:8fdf9a60065b 34 /** \addtogroup rtos */
kadonotakashi 0:8fdf9a60065b 35 /** @{*/
kadonotakashi 0:8fdf9a60065b 36 /**
kadonotakashi 0:8fdf9a60065b 37 * \defgroup rtos_RtosTimer RtosTimer class
kadonotakashi 0:8fdf9a60065b 38 * @{
kadonotakashi 0:8fdf9a60065b 39 */
kadonotakashi 0:8fdf9a60065b 40
kadonotakashi 0:8fdf9a60065b 41 /** The RtosTimer class allow creating and and controlling of timer functions in the system.
kadonotakashi 0:8fdf9a60065b 42 A timer function is called when a time period expires whereby both on-shot and
kadonotakashi 0:8fdf9a60065b 43 periodic timers are possible. A timer can be started, restarted, or stopped.
kadonotakashi 0:8fdf9a60065b 44
kadonotakashi 0:8fdf9a60065b 45 Timers are handled in the thread osTimerThread.
kadonotakashi 0:8fdf9a60065b 46 Callback functions run under control of this thread and may use CMSIS-RTOS API calls.
kadonotakashi 0:8fdf9a60065b 47
kadonotakashi 0:8fdf9a60065b 48 @deprecated
kadonotakashi 0:8fdf9a60065b 49 The RtosTimer has been superseded by the EventQueue. The RtosTimer and EventQueue duplicate
kadonotakashi 0:8fdf9a60065b 50 the functionality of timing events outside of interrupt context, however the EventQueue
kadonotakashi 0:8fdf9a60065b 51 has additional features to handle deferring other events to multiple contexts.
kadonotakashi 0:8fdf9a60065b 52
kadonotakashi 0:8fdf9a60065b 53 For an example, the following code shows a simple use of the RtosTimer:
kadonotakashi 0:8fdf9a60065b 54 @code
kadonotakashi 0:8fdf9a60065b 55 DigitalOut led(LED1);
kadonotakashi 0:8fdf9a60065b 56 void blink() {
kadonotakashi 0:8fdf9a60065b 57 led = !led;
kadonotakashi 0:8fdf9a60065b 58 }
kadonotakashi 0:8fdf9a60065b 59
kadonotakashi 0:8fdf9a60065b 60 RtosTimer timer(&blink);
kadonotakashi 0:8fdf9a60065b 61 int main() {
kadonotakashi 0:8fdf9a60065b 62 timer.start(1000); // call blink every 1s
kadonotakashi 0:8fdf9a60065b 63 wait_ms(5000);
kadonotakashi 0:8fdf9a60065b 64 timer.stop(); // stop after 5s
kadonotakashi 0:8fdf9a60065b 65 }
kadonotakashi 0:8fdf9a60065b 66 @endcode
kadonotakashi 0:8fdf9a60065b 67
kadonotakashi 0:8fdf9a60065b 68 This is the above example rewritten to use the EventQueue:
kadonotakashi 0:8fdf9a60065b 69 @code
kadonotakashi 0:8fdf9a60065b 70 DigitalOut led(LED1);
kadonotakashi 0:8fdf9a60065b 71 void blink() {
kadonotakashi 0:8fdf9a60065b 72 led = !led;
kadonotakashi 0:8fdf9a60065b 73 }
kadonotakashi 0:8fdf9a60065b 74
kadonotakashi 0:8fdf9a60065b 75 EventQueue queue(4*EVENTS_EVENT_SIZE);
kadonotakashi 0:8fdf9a60065b 76 int main() {
kadonotakashi 0:8fdf9a60065b 77 int blink_id = queue.call_every(1000, &blink); // call blink every 1s
kadonotakashi 0:8fdf9a60065b 78 queue.dispatch(5000);
kadonotakashi 0:8fdf9a60065b 79 queue.cancel(blink_id); // stop after 5s
kadonotakashi 0:8fdf9a60065b 80 }
kadonotakashi 0:8fdf9a60065b 81 @endcode
kadonotakashi 0:8fdf9a60065b 82
kadonotakashi 0:8fdf9a60065b 83 @note
kadonotakashi 0:8fdf9a60065b 84 Memory considerations: The timer control structures will be created on current thread's stack, both for the mbed OS
kadonotakashi 0:8fdf9a60065b 85 and underlying RTOS objects (static or dynamic RTOS memory pools are not being used).
kadonotakashi 0:8fdf9a60065b 86 */
kadonotakashi 0:8fdf9a60065b 87 class RtosTimer : private mbed::NonCopyable<RtosTimer> {
kadonotakashi 0:8fdf9a60065b 88 public:
kadonotakashi 0:8fdf9a60065b 89 /** Create timer.
kadonotakashi 0:8fdf9a60065b 90 @param func function to be executed by this timer.
kadonotakashi 0:8fdf9a60065b 91 @param type osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic)
kadonotakashi 0:8fdf9a60065b 92 @param argument argument to the timer call back function. (default: NULL)
kadonotakashi 0:8fdf9a60065b 93 @deprecated Replaced with RtosTimer(Callback<void()>, os_timer_type)
kadonotakashi 0:8fdf9a60065b 94 @deprecated
kadonotakashi 0:8fdf9a60065b 95 The RtosTimer has been superseded by the EventQueue. See RtosTimer.h for more details
kadonotakashi 0:8fdf9a60065b 96
kadonotakashi 0:8fdf9a60065b 97 @note You cannot call this function from ISR context.
kadonotakashi 0:8fdf9a60065b 98 */
kadonotakashi 0:8fdf9a60065b 99 MBED_DEPRECATED_SINCE("mbed-os-5.1",
kadonotakashi 0:8fdf9a60065b 100 "Replaced with RtosTimer(Callback<void()>, os_timer_type)")
kadonotakashi 0:8fdf9a60065b 101 MBED_DEPRECATED_SINCE("mbed-os-5.2",
kadonotakashi 0:8fdf9a60065b 102 "The RtosTimer has been superseded by the EventQueue. See RtosTimer.h for more details")
kadonotakashi 0:8fdf9a60065b 103 RtosTimer(void (*func)(void const *argument), os_timer_type type=osTimerPeriodic, void *argument=NULL) {
kadonotakashi 0:8fdf9a60065b 104 constructor(mbed::callback((void (*)(void *))func, argument), type);
kadonotakashi 0:8fdf9a60065b 105 }
kadonotakashi 0:8fdf9a60065b 106
kadonotakashi 0:8fdf9a60065b 107 /** Create timer.
kadonotakashi 0:8fdf9a60065b 108 @param func function to be executed by this timer.
kadonotakashi 0:8fdf9a60065b 109 @param type osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic)
kadonotakashi 0:8fdf9a60065b 110 @deprecated
kadonotakashi 0:8fdf9a60065b 111 The RtosTimer has been superseded by the EventQueue. See RtosTimer.h for more details
kadonotakashi 0:8fdf9a60065b 112
kadonotakashi 0:8fdf9a60065b 113 @note You cannot call this function from ISR context.
kadonotakashi 0:8fdf9a60065b 114 */
kadonotakashi 0:8fdf9a60065b 115 MBED_DEPRECATED_SINCE("mbed-os-5.2",
kadonotakashi 0:8fdf9a60065b 116 "The RtosTimer has been superseded by the EventQueue. See RtosTimer.h for more details")
kadonotakashi 0:8fdf9a60065b 117 RtosTimer(mbed::Callback<void()> func, os_timer_type type=osTimerPeriodic) {
kadonotakashi 0:8fdf9a60065b 118 constructor(func, type);
kadonotakashi 0:8fdf9a60065b 119 }
kadonotakashi 0:8fdf9a60065b 120
kadonotakashi 0:8fdf9a60065b 121 /** Create timer.
kadonotakashi 0:8fdf9a60065b 122 @param obj pointer to the object to call the member function on.
kadonotakashi 0:8fdf9a60065b 123 @param method member function to be executed by this timer.
kadonotakashi 0:8fdf9a60065b 124 @param type osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic)
kadonotakashi 0:8fdf9a60065b 125 @deprecated
kadonotakashi 0:8fdf9a60065b 126 The RtosTimer constructor does not support cv-qualifiers. Replaced by
kadonotakashi 0:8fdf9a60065b 127 RtosTimer(callback(obj, method), os_timer_type).
kadonotakashi 0:8fdf9a60065b 128 @deprecated
kadonotakashi 0:8fdf9a60065b 129 The RtosTimer has been superseded by the EventQueue. See RtosTimer.h for more details
kadonotakashi 0:8fdf9a60065b 130
kadonotakashi 0:8fdf9a60065b 131 @note You cannot call this function from ISR context.
kadonotakashi 0:8fdf9a60065b 132 */
kadonotakashi 0:8fdf9a60065b 133 template <typename T, typename M>
kadonotakashi 0:8fdf9a60065b 134 MBED_DEPRECATED_SINCE("mbed-os-5.1",
kadonotakashi 0:8fdf9a60065b 135 "The RtosTimer constructor does not support cv-qualifiers. Replaced by "
kadonotakashi 0:8fdf9a60065b 136 "RtosTimer(callback(obj, method), os_timer_type).")
kadonotakashi 0:8fdf9a60065b 137 MBED_DEPRECATED_SINCE("mbed-os-5.2",
kadonotakashi 0:8fdf9a60065b 138 "The RtosTimer has been superseded by the EventQueue. See RtosTimer.h for more details")
kadonotakashi 0:8fdf9a60065b 139 RtosTimer(T *obj, M method, os_timer_type type=osTimerPeriodic) {
kadonotakashi 0:8fdf9a60065b 140 constructor(mbed::callback(obj, method), type);
kadonotakashi 0:8fdf9a60065b 141 }
kadonotakashi 0:8fdf9a60065b 142
kadonotakashi 0:8fdf9a60065b 143 /** Stop the timer.
kadonotakashi 0:8fdf9a60065b 144 @return status code that indicates the execution status of the function:
kadonotakashi 0:8fdf9a60065b 145 @a osOK the timer has been stopped.
kadonotakashi 0:8fdf9a60065b 146 @a osErrorISR @a stop cannot be called from interrupt service routines.
kadonotakashi 0:8fdf9a60065b 147 @a osErrorParameter internal error.
kadonotakashi 0:8fdf9a60065b 148 @a osErrorResource the timer is not running.
kadonotakashi 0:8fdf9a60065b 149
kadonotakashi 0:8fdf9a60065b 150 @note You cannot call this function from ISR context.
kadonotakashi 0:8fdf9a60065b 151 */
kadonotakashi 0:8fdf9a60065b 152 osStatus stop(void);
kadonotakashi 0:8fdf9a60065b 153
kadonotakashi 0:8fdf9a60065b 154 /** Start or restart the timer.
kadonotakashi 0:8fdf9a60065b 155 @param millisec non-zero value of the timer.
kadonotakashi 0:8fdf9a60065b 156 @return status code that indicates the execution status of the function:
kadonotakashi 0:8fdf9a60065b 157 @a osOK the timer has been started or restarted.
kadonotakashi 0:8fdf9a60065b 158 @a osErrorISR @a start cannot be called from interrupt service routines.
kadonotakashi 0:8fdf9a60065b 159 @a osErrorParameter internal error or incorrect parameter value.
kadonotakashi 0:8fdf9a60065b 160 @a osErrorResource internal error (the timer is in an invalid timer state).
kadonotakashi 0:8fdf9a60065b 161
kadonotakashi 0:8fdf9a60065b 162 @note You cannot call this function from ISR context.
kadonotakashi 0:8fdf9a60065b 163 */
kadonotakashi 0:8fdf9a60065b 164 osStatus start(uint32_t millisec);
kadonotakashi 0:8fdf9a60065b 165
kadonotakashi 0:8fdf9a60065b 166 /** RtosTimer destructor
kadonotakashi 0:8fdf9a60065b 167 *
kadonotakashi 0:8fdf9a60065b 168 * @note You cannot call this function from ISR context.
kadonotakashi 0:8fdf9a60065b 169 */
kadonotakashi 0:8fdf9a60065b 170 ~RtosTimer();
kadonotakashi 0:8fdf9a60065b 171
kadonotakashi 0:8fdf9a60065b 172 private:
kadonotakashi 0:8fdf9a60065b 173 // Required to share definitions without
kadonotakashi 0:8fdf9a60065b 174 // delegated constructors
kadonotakashi 0:8fdf9a60065b 175 void constructor(mbed::Callback<void()> func, os_timer_type type);
kadonotakashi 0:8fdf9a60065b 176
kadonotakashi 0:8fdf9a60065b 177 osTimerId_t _id;
kadonotakashi 0:8fdf9a60065b 178 mbed_rtos_storage_timer_t _obj_mem;
kadonotakashi 0:8fdf9a60065b 179 mbed::Callback<void()> _function;
kadonotakashi 0:8fdf9a60065b 180 };
kadonotakashi 0:8fdf9a60065b 181 /** @}*/
kadonotakashi 0:8fdf9a60065b 182 /** @}*/
kadonotakashi 0:8fdf9a60065b 183
kadonotakashi 0:8fdf9a60065b 184 }
kadonotakashi 0:8fdf9a60065b 185
kadonotakashi 0:8fdf9a60065b 186 #endif
kadonotakashi 0:8fdf9a60065b 187
kadonotakashi 0:8fdf9a60065b 188