Marco Zecchini / Mbed OS Example_RTOS

Rtos API example

mbed-os/events/equeue/equeue_platform.h@0:9fca2b23d0ba, 2019-02-23 (annotated)

Committer:
marcozecchini
Date:
Sat Feb 23 12:13:36 2019 +0000
Revision:
0:9fca2b23d0ba
final commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
marcozecchini 0:9fca2b23d0ba 1
marcozecchini 0:9fca2b23d0ba 2 /** \addtogroup events */
marcozecchini 0:9fca2b23d0ba 3 /** @{*/
marcozecchini 0:9fca2b23d0ba 4 /*
marcozecchini 0:9fca2b23d0ba 5 * System specific implementation
marcozecchini 0:9fca2b23d0ba 6 *
marcozecchini 0:9fca2b23d0ba 7 * Copyright (c) 2016 Christopher Haster
marcozecchini 0:9fca2b23d0ba 8 *
marcozecchini 0:9fca2b23d0ba 9 * Licensed under the Apache License, Version 2.0 (the "License");
marcozecchini 0:9fca2b23d0ba 10 * you may not use this file except in compliance with the License.
marcozecchini 0:9fca2b23d0ba 11 * You may obtain a copy of the License at
marcozecchini 0:9fca2b23d0ba 12 *
marcozecchini 0:9fca2b23d0ba 13 * http://www.apache.org/licenses/LICENSE-2.0
marcozecchini 0:9fca2b23d0ba 14 *
marcozecchini 0:9fca2b23d0ba 15 * Unless required by applicable law or agreed to in writing, software
marcozecchini 0:9fca2b23d0ba 16 * distributed under the License is distributed on an "AS IS" BASIS,
marcozecchini 0:9fca2b23d0ba 17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
marcozecchini 0:9fca2b23d0ba 18 * See the License for the specific language governing permissions and
marcozecchini 0:9fca2b23d0ba 19 * limitations under the License.
marcozecchini 0:9fca2b23d0ba 20 */
marcozecchini 0:9fca2b23d0ba 21 #ifndef EQUEUE_PLATFORM_H
marcozecchini 0:9fca2b23d0ba 22 #define EQUEUE_PLATFORM_H
marcozecchini 0:9fca2b23d0ba 23
marcozecchini 0:9fca2b23d0ba 24 #ifdef __cplusplus
marcozecchini 0:9fca2b23d0ba 25 extern "C" {
marcozecchini 0:9fca2b23d0ba 26 #endif
marcozecchini 0:9fca2b23d0ba 27
marcozecchini 0:9fca2b23d0ba 28 #include <stdbool.h>
marcozecchini 0:9fca2b23d0ba 29
marcozecchini 0:9fca2b23d0ba 30 // Currently supported platforms
marcozecchini 0:9fca2b23d0ba 31 //
marcozecchini 0:9fca2b23d0ba 32 // Uncomment to select a supported platform or reimplement this file
marcozecchini 0:9fca2b23d0ba 33 // for a specific target.
marcozecchini 0:9fca2b23d0ba 34 //#define EQUEUE_PLATFORM_POSIX
marcozecchini 0:9fca2b23d0ba 35 //#define EQUEUE_PLATFORM_MBED
marcozecchini 0:9fca2b23d0ba 36
marcozecchini 0:9fca2b23d0ba 37 // Try to infer a platform if none was manually selected
marcozecchini 0:9fca2b23d0ba 38 #if !defined(EQUEUE_PLATFORM_POSIX) \
marcozecchini 0:9fca2b23d0ba 39 && !defined(EQUEUE_PLATFORM_MBED)
marcozecchini 0:9fca2b23d0ba 40 #if defined(__unix__)
marcozecchini 0:9fca2b23d0ba 41 #define EQUEUE_PLATFORM_POSIX
marcozecchini 0:9fca2b23d0ba 42 #elif defined(__MBED__)
marcozecchini 0:9fca2b23d0ba 43 #define EQUEUE_PLATFORM_MBED
marcozecchini 0:9fca2b23d0ba 44 #else
marcozecchini 0:9fca2b23d0ba 45 #warning "Unknown platform! Please update equeue_platform.h"
marcozecchini 0:9fca2b23d0ba 46 #endif
marcozecchini 0:9fca2b23d0ba 47 #endif
marcozecchini 0:9fca2b23d0ba 48
marcozecchini 0:9fca2b23d0ba 49 // Platform includes
marcozecchini 0:9fca2b23d0ba 50 #if defined(EQUEUE_PLATFORM_POSIX)
marcozecchini 0:9fca2b23d0ba 51 #include <pthread.h>
marcozecchini 0:9fca2b23d0ba 52 #elif defined(EQUEUE_PLATFORM_MBED)
marcozecchini 0:9fca2b23d0ba 53 #include "cmsis_os2.h"
marcozecchini 0:9fca2b23d0ba 54 #include "mbed_rtos_storage.h"
marcozecchini 0:9fca2b23d0ba 55 #endif
marcozecchini 0:9fca2b23d0ba 56
marcozecchini 0:9fca2b23d0ba 57
marcozecchini 0:9fca2b23d0ba 58 // Platform millisecond counter
marcozecchini 0:9fca2b23d0ba 59 //
marcozecchini 0:9fca2b23d0ba 60 // Return a tick that represents the number of milliseconds that have passed
marcozecchini 0:9fca2b23d0ba 61 // since an arbitrary point in time. The granularity does not need to be at
marcozecchini 0:9fca2b23d0ba 62 // the millisecond level, however the accuracy of the equeue library is
marcozecchini 0:9fca2b23d0ba 63 // limited by the accuracy of this tick.
marcozecchini 0:9fca2b23d0ba 64 //
marcozecchini 0:9fca2b23d0ba 65 // Must intentionally overflow to 0 after 2^32-1
marcozecchini 0:9fca2b23d0ba 66 unsigned equeue_tick(void);
marcozecchini 0:9fca2b23d0ba 67
marcozecchini 0:9fca2b23d0ba 68
marcozecchini 0:9fca2b23d0ba 69 // Platform mutex type
marcozecchini 0:9fca2b23d0ba 70 //
marcozecchini 0:9fca2b23d0ba 71 // The equeue library requires at minimum a non-recursive mutex that is
marcozecchini 0:9fca2b23d0ba 72 // safe in interrupt contexts. The mutex section is help for a bounded
marcozecchini 0:9fca2b23d0ba 73 // amount of time, so simply disabling interrupts is acceptable
marcozecchini 0:9fca2b23d0ba 74 //
marcozecchini 0:9fca2b23d0ba 75 // If irq safety is not required, a regular blocking mutex can be used.
marcozecchini 0:9fca2b23d0ba 76 #if defined(EQUEUE_PLATFORM_POSIX)
marcozecchini 0:9fca2b23d0ba 77 typedef pthread_mutex_t equeue_mutex_t;
marcozecchini 0:9fca2b23d0ba 78 #elif defined(EQUEUE_PLATFORM_WINDOWS)
marcozecchini 0:9fca2b23d0ba 79 typedef CRITICAL_SECTION equeue_mutex_t;
marcozecchini 0:9fca2b23d0ba 80 #elif defined(EQUEUE_PLATFORM_MBED)
marcozecchini 0:9fca2b23d0ba 81 typedef unsigned equeue_mutex_t;
marcozecchini 0:9fca2b23d0ba 82 #elif defined(EQUEUE_PLATFORM_FREERTOS)
marcozecchini 0:9fca2b23d0ba 83 typedef UBaseType_t equeue_mutex_t;
marcozecchini 0:9fca2b23d0ba 84 #endif
marcozecchini 0:9fca2b23d0ba 85
marcozecchini 0:9fca2b23d0ba 86 // Platform mutex operations
marcozecchini 0:9fca2b23d0ba 87 //
marcozecchini 0:9fca2b23d0ba 88 // The equeue_mutex_create and equeue_mutex_destroy manage the lifetime
marcozecchini 0:9fca2b23d0ba 89 // of the mutex. On error, equeue_mutex_create should return a negative
marcozecchini 0:9fca2b23d0ba 90 // error code.
marcozecchini 0:9fca2b23d0ba 91 //
marcozecchini 0:9fca2b23d0ba 92 // The equeue_mutex_lock and equeue_mutex_unlock lock and unlock the
marcozecchini 0:9fca2b23d0ba 93 // underlying mutex.
marcozecchini 0:9fca2b23d0ba 94 int equeue_mutex_create(equeue_mutex_t *mutex);
marcozecchini 0:9fca2b23d0ba 95 void equeue_mutex_destroy(equeue_mutex_t *mutex);
marcozecchini 0:9fca2b23d0ba 96 void equeue_mutex_lock(equeue_mutex_t *mutex);
marcozecchini 0:9fca2b23d0ba 97 void equeue_mutex_unlock(equeue_mutex_t *mutex);
marcozecchini 0:9fca2b23d0ba 98
marcozecchini 0:9fca2b23d0ba 99
marcozecchini 0:9fca2b23d0ba 100 // Platform semaphore type
marcozecchini 0:9fca2b23d0ba 101 //
marcozecchini 0:9fca2b23d0ba 102 // The equeue library requires a binary semaphore type that can be safely
marcozecchini 0:9fca2b23d0ba 103 // signaled from interrupt contexts and from inside a equeue_mutex section.
marcozecchini 0:9fca2b23d0ba 104 //
marcozecchini 0:9fca2b23d0ba 105 // The equeue_signal_wait is relied upon by the equeue library to sleep the
marcozecchini 0:9fca2b23d0ba 106 // processor between events. Spurious wakeups have no negative-effects.
marcozecchini 0:9fca2b23d0ba 107 //
marcozecchini 0:9fca2b23d0ba 108 // A counting semaphore will also work, however may cause the event queue
marcozecchini 0:9fca2b23d0ba 109 // dispatch loop to run unnecessarily. For that matter, equeue_signal_wait
marcozecchini 0:9fca2b23d0ba 110 // may even be implemented as a single return statement.
marcozecchini 0:9fca2b23d0ba 111 #if defined(EQUEUE_PLATFORM_POSIX)
marcozecchini 0:9fca2b23d0ba 112 typedef struct equeue_sema {
marcozecchini 0:9fca2b23d0ba 113 pthread_mutex_t mutex;
marcozecchini 0:9fca2b23d0ba 114 pthread_cond_t cond;
marcozecchini 0:9fca2b23d0ba 115 bool signal;
marcozecchini 0:9fca2b23d0ba 116 } equeue_sema_t;
marcozecchini 0:9fca2b23d0ba 117 #elif defined(EQUEUE_PLATFORM_MBED) && defined(MBED_CONF_RTOS_PRESENT)
marcozecchini 0:9fca2b23d0ba 118 typedef struct equeue_sema {
marcozecchini 0:9fca2b23d0ba 119 osEventFlagsId_t id;
marcozecchini 0:9fca2b23d0ba 120 mbed_rtos_storage_event_flags_t mem;
marcozecchini 0:9fca2b23d0ba 121 } equeue_sema_t;
marcozecchini 0:9fca2b23d0ba 122 #elif defined(EQUEUE_PLATFORM_MBED)
marcozecchini 0:9fca2b23d0ba 123 typedef volatile int equeue_sema_t;
marcozecchini 0:9fca2b23d0ba 124 #endif
marcozecchini 0:9fca2b23d0ba 125
marcozecchini 0:9fca2b23d0ba 126 // Platform semaphore operations
marcozecchini 0:9fca2b23d0ba 127 //
marcozecchini 0:9fca2b23d0ba 128 // The equeue_sema_create and equeue_sema_destroy manage the lifetime
marcozecchini 0:9fca2b23d0ba 129 // of the semaphore. On error, equeue_sema_create should return a negative
marcozecchini 0:9fca2b23d0ba 130 // error code.
marcozecchini 0:9fca2b23d0ba 131 //
marcozecchini 0:9fca2b23d0ba 132 // The equeue_sema_signal marks a semaphore as signalled such that the next
marcozecchini 0:9fca2b23d0ba 133 // equeue_sema_wait will return true.
marcozecchini 0:9fca2b23d0ba 134 //
marcozecchini 0:9fca2b23d0ba 135 // The equeue_sema_wait waits for a semaphore to be signalled or returns
marcozecchini 0:9fca2b23d0ba 136 // immediately if equeue_sema_signal had been called since the last
marcozecchini 0:9fca2b23d0ba 137 // equeue_sema_wait. The equeue_sema_wait returns true if it detected that
marcozecchini 0:9fca2b23d0ba 138 // equeue_sema_signal had been called. If ms is negative, equeue_sema_wait
marcozecchini 0:9fca2b23d0ba 139 // will wait for a signal indefinitely.
marcozecchini 0:9fca2b23d0ba 140 int equeue_sema_create(equeue_sema_t *sema);
marcozecchini 0:9fca2b23d0ba 141 void equeue_sema_destroy(equeue_sema_t *sema);
marcozecchini 0:9fca2b23d0ba 142 void equeue_sema_signal(equeue_sema_t *sema);
marcozecchini 0:9fca2b23d0ba 143 bool equeue_sema_wait(equeue_sema_t *sema, int ms);
marcozecchini 0:9fca2b23d0ba 144
marcozecchini 0:9fca2b23d0ba 145
marcozecchini 0:9fca2b23d0ba 146 #ifdef __cplusplus
marcozecchini 0:9fca2b23d0ba 147 }
marcozecchini 0:9fca2b23d0ba 148 #endif
marcozecchini 0:9fca2b23d0ba 149
marcozecchini 0:9fca2b23d0ba 150 #endif
marcozecchini 0:9fca2b23d0ba 151
marcozecchini 0:9fca2b23d0ba 152 /** @}*/