Damian Gabino / picoGW_mcu

MCU driver/HAL for the Picocell Gateway concentrator board. The firmware implements either a USB CDC protocol or a UART protocol to bridge commands coming from host to the SX1308 SPI interface.

src/mbed-dev/api/SingletonPtr.h@0:c76361bd82e8, 2018-04-11 (annotated)

Committer:
dgabino
Date:
Wed Apr 11 14:42:47 2018 +0000
Revision:
0:c76361bd82e8
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dgabino 0:c76361bd82e8 1 /* mbed Microcontroller Library
dgabino 0:c76361bd82e8 2 * Copyright (c) 2006-2013 ARM Limited
dgabino 0:c76361bd82e8 3 *
dgabino 0:c76361bd82e8 4 * Licensed under the Apache License, Version 2.0 (the "License");
dgabino 0:c76361bd82e8 5 * you may not use this file except in compliance with the License.
dgabino 0:c76361bd82e8 6 * You may obtain a copy of the License at
dgabino 0:c76361bd82e8 7 *
dgabino 0:c76361bd82e8 8 * http://www.apache.org/licenses/LICENSE-2.0
dgabino 0:c76361bd82e8 9 *
dgabino 0:c76361bd82e8 10 * Unless required by applicable law or agreed to in writing, software
dgabino 0:c76361bd82e8 11 * distributed under the License is distributed on an "AS IS" BASIS,
dgabino 0:c76361bd82e8 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
dgabino 0:c76361bd82e8 13 * See the License for the specific language governing permissions and
dgabino 0:c76361bd82e8 14 * limitations under the License.
dgabino 0:c76361bd82e8 15 */
dgabino 0:c76361bd82e8 16 #ifndef SINGLETONPTR_H
dgabino 0:c76361bd82e8 17 #define SINGLETONPTR_H
dgabino 0:c76361bd82e8 18
dgabino 0:c76361bd82e8 19 #include <stdint.h>
dgabino 0:c76361bd82e8 20 #include <new>
dgabino 0:c76361bd82e8 21 #include "mbed_assert.h"
dgabino 0:c76361bd82e8 22 #ifdef MBED_CONF_RTOS_PRESENT
dgabino 0:c76361bd82e8 23 #include "cmsis_os.h"
dgabino 0:c76361bd82e8 24 #endif
dgabino 0:c76361bd82e8 25
dgabino 0:c76361bd82e8 26 #ifdef MBED_CONF_RTOS_PRESENT
dgabino 0:c76361bd82e8 27 extern osMutexId singleton_mutex_id;
dgabino 0:c76361bd82e8 28 #endif
dgabino 0:c76361bd82e8 29
dgabino 0:c76361bd82e8 30 /** Lock the singleton mutex
dgabino 0:c76361bd82e8 31 *
dgabino 0:c76361bd82e8 32 * This function is typically used to provide
dgabino 0:c76361bd82e8 33 * exclusive access when initializing a
dgabino 0:c76361bd82e8 34 * global object.
dgabino 0:c76361bd82e8 35 */
dgabino 0:c76361bd82e8 36 inline static void singleton_lock(void)
dgabino 0:c76361bd82e8 37 {
dgabino 0:c76361bd82e8 38 #ifdef MBED_CONF_RTOS_PRESENT
dgabino 0:c76361bd82e8 39 osMutexWait(singleton_mutex_id, osWaitForever);
dgabino 0:c76361bd82e8 40 #endif
dgabino 0:c76361bd82e8 41 }
dgabino 0:c76361bd82e8 42
dgabino 0:c76361bd82e8 43 /** Unlock the singleton mutex
dgabino 0:c76361bd82e8 44 *
dgabino 0:c76361bd82e8 45 * This function is typically used to provide
dgabino 0:c76361bd82e8 46 * exclusive access when initializing a
dgabino 0:c76361bd82e8 47 * global object.
dgabino 0:c76361bd82e8 48 */
dgabino 0:c76361bd82e8 49 inline static void singleton_unlock(void)
dgabino 0:c76361bd82e8 50 {
dgabino 0:c76361bd82e8 51 #ifdef MBED_CONF_RTOS_PRESENT
dgabino 0:c76361bd82e8 52 osMutexRelease (singleton_mutex_id);
dgabino 0:c76361bd82e8 53 #endif
dgabino 0:c76361bd82e8 54 }
dgabino 0:c76361bd82e8 55
dgabino 0:c76361bd82e8 56 /** Utility class for creating an using a singleton
dgabino 0:c76361bd82e8 57 *
dgabino 0:c76361bd82e8 58 * @Note Synchronization level: Thread safe
dgabino 0:c76361bd82e8 59 *
dgabino 0:c76361bd82e8 60 * @Note: This class must only be used in a static context -
dgabino 0:c76361bd82e8 61 * this class must never be allocated or created on the
dgabino 0:c76361bd82e8 62 * stack.
dgabino 0:c76361bd82e8 63 *
dgabino 0:c76361bd82e8 64 * @Note: This class is lazily initialized on first use.
dgabino 0:c76361bd82e8 65 * This class is a POD type so if it is not used it will
dgabino 0:c76361bd82e8 66 * be garbage collected.
dgabino 0:c76361bd82e8 67 */
dgabino 0:c76361bd82e8 68 template <class T>
dgabino 0:c76361bd82e8 69 struct SingletonPtr {
dgabino 0:c76361bd82e8 70
dgabino 0:c76361bd82e8 71 /** Get a pointer to the underlying singleton
dgabino 0:c76361bd82e8 72 *
dgabino 0:c76361bd82e8 73 * @returns
dgabino 0:c76361bd82e8 74 * A pointer to the singleton
dgabino 0:c76361bd82e8 75 */
dgabino 0:c76361bd82e8 76 T* get() {
dgabino 0:c76361bd82e8 77 if (NULL == _ptr) {
dgabino 0:c76361bd82e8 78 singleton_lock();
dgabino 0:c76361bd82e8 79 if (NULL == _ptr) {
dgabino 0:c76361bd82e8 80 _ptr = new (_data) T();
dgabino 0:c76361bd82e8 81 }
dgabino 0:c76361bd82e8 82 singleton_unlock();
dgabino 0:c76361bd82e8 83 }
dgabino 0:c76361bd82e8 84 // _ptr was not zero initialized or was
dgabino 0:c76361bd82e8 85 // corrupted if this assert is hit
dgabino 0:c76361bd82e8 86 MBED_ASSERT(_ptr == (T *)&_data);
dgabino 0:c76361bd82e8 87 return _ptr;
dgabino 0:c76361bd82e8 88 }
dgabino 0:c76361bd82e8 89
dgabino 0:c76361bd82e8 90 /** Get a pointer to the underlying singleton
dgabino 0:c76361bd82e8 91 *
dgabino 0:c76361bd82e8 92 * @returns
dgabino 0:c76361bd82e8 93 * A pointer to the singleton
dgabino 0:c76361bd82e8 94 */
dgabino 0:c76361bd82e8 95 T* operator->() {
dgabino 0:c76361bd82e8 96 return get();
dgabino 0:c76361bd82e8 97 }
dgabino 0:c76361bd82e8 98
dgabino 0:c76361bd82e8 99 // This is zero initialized when in global scope
dgabino 0:c76361bd82e8 100 T *_ptr;
dgabino 0:c76361bd82e8 101 // Force data to be 4 byte aligned
dgabino 0:c76361bd82e8 102 uint32_t _data[(sizeof(T) + sizeof(uint32_t) - 1) / sizeof(uint32_t)];
dgabino 0:c76361bd82e8 103 };
dgabino 0:c76361bd82e8 104
dgabino 0:c76361bd82e8 105 #endif