Knight KE / Mbed OS Game_Master

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.

mbed-os/events/equeue/equeue_platform.h@0:9b3d4731edbb, 2018-06-21 (annotated)

Committer:
WFKnight
Date:
Thu Jun 21 13:51:43 2018 +0000
Revision:
0:9b3d4731edbb
UART, RTOS, LED

Who changed what in which revision?

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