mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

platform/CThunk.h@170:e95d10626187, 2018-09-06 (annotated)

Committer:
AnnaBridge
Date:
Thu Sep 06 13:39:34 2018 +0100
Revision:
170:e95d10626187
Parent:
161:aa5281ff4a02
Child:
172:65be27845400
mbed library. Release version 163

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1
AnnaBridge 156:ff21514d8981 2 /** \addtogroup platform */
AnnaBridge 156:ff21514d8981 3 /** @{*/
AnnaBridge 158:1c57384330a6 4 /**
AnnaBridge 158:1c57384330a6 5 * \defgroup platform_CThunk CThunk class
AnnaBridge 158:1c57384330a6 6 * @{
AnnaBridge 158:1c57384330a6 7 */
AnnaBridge 156:ff21514d8981 8 /* General C++ Object Thunking class
AnnaBridge 156:ff21514d8981 9 *
AnnaBridge 156:ff21514d8981 10 * - allows direct callbacks to non-static C++ class functions
AnnaBridge 156:ff21514d8981 11 * - keeps track for the corresponding class instance
AnnaBridge 156:ff21514d8981 12 * - supports an optional context parameter for the called function
AnnaBridge 156:ff21514d8981 13 * - ideally suited for class object receiving interrupts (NVIC_SetVector)
AnnaBridge 156:ff21514d8981 14 *
AnnaBridge 156:ff21514d8981 15 * Copyright (c) 2014-2015 ARM Limited
AnnaBridge 156:ff21514d8981 16 *
AnnaBridge 156:ff21514d8981 17 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 156:ff21514d8981 18 * you may not use this file except in compliance with the License.
AnnaBridge 156:ff21514d8981 19 * You may obtain a copy of the License at
AnnaBridge 156:ff21514d8981 20 *
AnnaBridge 156:ff21514d8981 21 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 156:ff21514d8981 22 *
AnnaBridge 156:ff21514d8981 23 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 156:ff21514d8981 24 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 156:ff21514d8981 25 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 156:ff21514d8981 26 * See the License for the specific language governing permissions and
AnnaBridge 156:ff21514d8981 27 * limitations under the License.
AnnaBridge 156:ff21514d8981 28 */
AnnaBridge 156:ff21514d8981 29
AnnaBridge 156:ff21514d8981 30 /* General C++ Object Thunking class
AnnaBridge 156:ff21514d8981 31 *
AnnaBridge 156:ff21514d8981 32 * - allows direct callbacks to non-static C++ class functions
AnnaBridge 156:ff21514d8981 33 * - keeps track for the corresponding class instance
AnnaBridge 156:ff21514d8981 34 * - supports an optional context parameter for the called function
AnnaBridge 156:ff21514d8981 35 * - ideally suited for class object receiving interrupts (NVIC_SetVector)
AnnaBridge 156:ff21514d8981 36 */
AnnaBridge 156:ff21514d8981 37
AnnaBridge 156:ff21514d8981 38 #ifndef __CTHUNK_H__
AnnaBridge 156:ff21514d8981 39 #define __CTHUNK_H__
AnnaBridge 156:ff21514d8981 40
AnnaBridge 156:ff21514d8981 41 #define CTHUNK_ADDRESS 1
AnnaBridge 156:ff21514d8981 42 #define CTHUNK_VARIABLES volatile uint32_t code[2]
AnnaBridge 156:ff21514d8981 43
AnnaBridge 156:ff21514d8981 44 #if (defined(__CORTEX_M3) || defined(__CORTEX_M4) || defined(__CORTEX_M7) || defined(__CORTEX_A9) \
AnnaBridge 161:aa5281ff4a02 45 || defined(__CORTEX_M33))
AnnaBridge 156:ff21514d8981 46 /**
AnnaBridge 156:ff21514d8981 47 * CTHUNK disassembly for Cortex-M3/M4/M7/A9 (thumb2):
AnnaBridge 156:ff21514d8981 48 * * adr r0, #4
AnnaBridge 156:ff21514d8981 49 * * ldm r0, {r0, r1, r2, pc}
AnnaBridge 156:ff21514d8981 50 *
AnnaBridge 156:ff21514d8981 51 * This instruction loads the arguments for the static thunking function to r0-r2, and
AnnaBridge 156:ff21514d8981 52 * branches to that function by loading its address into PC.
AnnaBridge 156:ff21514d8981 53 *
AnnaBridge 156:ff21514d8981 54 * This is safe for both regular calling and interrupt calling, since it only touches scratch registers
AnnaBridge 156:ff21514d8981 55 * which should be saved by the caller, and are automatically saved as part of the IRQ context switch.
AnnaBridge 156:ff21514d8981 56 */
AnnaBridge 156:ff21514d8981 57 #define CTHUNK_ASSIGMENT do { \
AnnaBridge 156:ff21514d8981 58 m_thunk.code[0] = 0xE890A001; \
AnnaBridge 156:ff21514d8981 59 m_thunk.code[1] = 0x00008007; \
AnnaBridge 156:ff21514d8981 60 } while (0)
AnnaBridge 156:ff21514d8981 61
AnnaBridge 161:aa5281ff4a02 62 #elif (defined(__CORTEX_M0PLUS) || defined(__CORTEX_M0) || defined(__CORTEX_M23))
AnnaBridge 156:ff21514d8981 63 /*
AnnaBridge 156:ff21514d8981 64 * CTHUNK disassembly for Cortex M0/M0+ (thumb):
AnnaBridge 156:ff21514d8981 65 * * adr r0, #4
AnnaBridge 156:ff21514d8981 66 * * ldm r0, {r0, r1, r2, r3}
AnnaBridge 156:ff21514d8981 67 * * bx r3
AnnaBridge 156:ff21514d8981 68 */
AnnaBridge 156:ff21514d8981 69 #define CTHUNK_ASSIGMENT do { \
AnnaBridge 156:ff21514d8981 70 m_thunk.code[0] = 0xC80FA001; \
AnnaBridge 156:ff21514d8981 71 m_thunk.code[1] = 0x00004718; \
AnnaBridge 156:ff21514d8981 72 } while (0)
AnnaBridge 156:ff21514d8981 73
AnnaBridge 156:ff21514d8981 74 #else
AnnaBridge 156:ff21514d8981 75 #error "Target is not currently suported."
AnnaBridge 156:ff21514d8981 76 #endif
AnnaBridge 156:ff21514d8981 77
AnnaBridge 156:ff21514d8981 78 /* IRQ/Exception compatible thunk entry function */
AnnaBridge 156:ff21514d8981 79 typedef void (*CThunkEntry)(void);
AnnaBridge 156:ff21514d8981 80
AnnaBridge 156:ff21514d8981 81 /**
AnnaBridge 156:ff21514d8981 82 * Class for created a pointer with data bound to it
AnnaBridge 156:ff21514d8981 83 *
AnnaBridge 156:ff21514d8981 84 * @note Synchronization level: Not protected
AnnaBridge 156:ff21514d8981 85 */
AnnaBridge 156:ff21514d8981 86 template<class T>
AnnaBridge 170:e95d10626187 87 class CThunk {
AnnaBridge 170:e95d10626187 88 public:
AnnaBridge 170:e95d10626187 89 typedef void (T::*CCallbackSimple)(void);
AnnaBridge 170:e95d10626187 90 typedef void (T::*CCallback)(void *context);
AnnaBridge 170:e95d10626187 91
AnnaBridge 170:e95d10626187 92 inline CThunk(T *instance)
AnnaBridge 170:e95d10626187 93 {
AnnaBridge 170:e95d10626187 94 init(instance, NULL, NULL);
AnnaBridge 170:e95d10626187 95 }
AnnaBridge 156:ff21514d8981 96
AnnaBridge 170:e95d10626187 97 inline CThunk(T *instance, CCallback callback)
AnnaBridge 170:e95d10626187 98 {
AnnaBridge 170:e95d10626187 99 init(instance, callback, NULL);
AnnaBridge 170:e95d10626187 100 }
AnnaBridge 156:ff21514d8981 101
AnnaBridge 170:e95d10626187 102 ~CThunk()
AnnaBridge 170:e95d10626187 103 {
AnnaBridge 156:ff21514d8981 104
AnnaBridge 170:e95d10626187 105 }
AnnaBridge 156:ff21514d8981 106
AnnaBridge 170:e95d10626187 107 inline CThunk(T *instance, CCallbackSimple callback)
AnnaBridge 170:e95d10626187 108 {
AnnaBridge 170:e95d10626187 109 init(instance, (CCallback)callback, NULL);
AnnaBridge 170:e95d10626187 110 }
AnnaBridge 156:ff21514d8981 111
AnnaBridge 170:e95d10626187 112 inline CThunk(T &instance, CCallback callback)
AnnaBridge 170:e95d10626187 113 {
AnnaBridge 170:e95d10626187 114 init(instance, callback, NULL);
AnnaBridge 170:e95d10626187 115 }
AnnaBridge 156:ff21514d8981 116
AnnaBridge 170:e95d10626187 117 inline CThunk(T &instance, CCallbackSimple callback)
AnnaBridge 170:e95d10626187 118 {
AnnaBridge 170:e95d10626187 119 init(instance, (CCallback)callback, NULL);
AnnaBridge 170:e95d10626187 120 }
AnnaBridge 156:ff21514d8981 121
AnnaBridge 170:e95d10626187 122 inline CThunk(T &instance, CCallback callback, void *context)
AnnaBridge 170:e95d10626187 123 {
AnnaBridge 170:e95d10626187 124 init(instance, callback, context);
AnnaBridge 170:e95d10626187 125 }
AnnaBridge 156:ff21514d8981 126
AnnaBridge 170:e95d10626187 127 inline void callback(CCallback callback)
AnnaBridge 170:e95d10626187 128 {
AnnaBridge 170:e95d10626187 129 m_callback = callback;
AnnaBridge 170:e95d10626187 130 }
AnnaBridge 170:e95d10626187 131
AnnaBridge 170:e95d10626187 132 inline void callback(CCallbackSimple callback)
AnnaBridge 170:e95d10626187 133 {
AnnaBridge 170:e95d10626187 134 m_callback = (CCallback)callback;
AnnaBridge 170:e95d10626187 135 }
AnnaBridge 156:ff21514d8981 136
AnnaBridge 170:e95d10626187 137 inline void context(void *context)
AnnaBridge 170:e95d10626187 138 {
AnnaBridge 170:e95d10626187 139 m_thunk.context = (uint32_t)context;
AnnaBridge 170:e95d10626187 140 }
AnnaBridge 156:ff21514d8981 141
AnnaBridge 170:e95d10626187 142 inline void context(uint32_t context)
AnnaBridge 170:e95d10626187 143 {
AnnaBridge 170:e95d10626187 144 m_thunk.context = context;
AnnaBridge 170:e95d10626187 145 }
AnnaBridge 156:ff21514d8981 146
AnnaBridge 170:e95d10626187 147 inline uint32_t entry(void)
AnnaBridge 170:e95d10626187 148 {
AnnaBridge 170:e95d10626187 149 return (((uint32_t)&m_thunk) | CTHUNK_ADDRESS);
AnnaBridge 170:e95d10626187 150 }
AnnaBridge 156:ff21514d8981 151
AnnaBridge 170:e95d10626187 152 /* get thunk entry point for connecting rhunk to an IRQ table */
AnnaBridge 170:e95d10626187 153 inline operator CThunkEntry(void)
AnnaBridge 170:e95d10626187 154 {
AnnaBridge 170:e95d10626187 155 return (CThunkEntry)entry();
AnnaBridge 170:e95d10626187 156 }
AnnaBridge 156:ff21514d8981 157
AnnaBridge 170:e95d10626187 158 /* get thunk entry point for connecting rhunk to an IRQ table */
AnnaBridge 170:e95d10626187 159 inline operator uint32_t(void)
AnnaBridge 170:e95d10626187 160 {
AnnaBridge 170:e95d10626187 161 return entry();
AnnaBridge 170:e95d10626187 162 }
AnnaBridge 156:ff21514d8981 163
AnnaBridge 170:e95d10626187 164 /* simple test function */
AnnaBridge 170:e95d10626187 165 inline void call(void)
AnnaBridge 170:e95d10626187 166 {
AnnaBridge 170:e95d10626187 167 (((CThunkEntry)(entry()))());
AnnaBridge 170:e95d10626187 168 }
AnnaBridge 156:ff21514d8981 169
AnnaBridge 170:e95d10626187 170 private:
AnnaBridge 170:e95d10626187 171 T *m_instance;
AnnaBridge 170:e95d10626187 172 volatile CCallback m_callback;
AnnaBridge 156:ff21514d8981 173
AnnaBridge 156:ff21514d8981 174 // TODO: this needs proper fix, to refactor toolchain header file and all its use
AnnaBridge 156:ff21514d8981 175 // PACKED there is not defined properly for IAR
AnnaBridge 156:ff21514d8981 176 #if defined (__ICCARM__)
AnnaBridge 170:e95d10626187 177 typedef __packed struct {
AnnaBridge 170:e95d10626187 178 CTHUNK_VARIABLES;
AnnaBridge 170:e95d10626187 179 volatile uint32_t instance;
AnnaBridge 170:e95d10626187 180 volatile uint32_t context;
AnnaBridge 170:e95d10626187 181 volatile uint32_t callback;
AnnaBridge 170:e95d10626187 182 volatile uint32_t trampoline;
AnnaBridge 170:e95d10626187 183 } CThunkTrampoline;
AnnaBridge 156:ff21514d8981 184 #else
AnnaBridge 170:e95d10626187 185 typedef struct {
AnnaBridge 170:e95d10626187 186 CTHUNK_VARIABLES;
AnnaBridge 170:e95d10626187 187 volatile uint32_t instance;
AnnaBridge 170:e95d10626187 188 volatile uint32_t context;
AnnaBridge 170:e95d10626187 189 volatile uint32_t callback;
AnnaBridge 170:e95d10626187 190 volatile uint32_t trampoline;
AnnaBridge 170:e95d10626187 191 } __attribute__((__packed__)) CThunkTrampoline;
AnnaBridge 156:ff21514d8981 192 #endif
AnnaBridge 156:ff21514d8981 193
AnnaBridge 170:e95d10626187 194 static void trampoline(T *instance, void *context, CCallback *callback)
AnnaBridge 170:e95d10626187 195 {
AnnaBridge 170:e95d10626187 196 if (instance && *callback) {
AnnaBridge 170:e95d10626187 197 (static_cast<T *>(instance)->**callback)(context);
AnnaBridge 156:ff21514d8981 198 }
AnnaBridge 170:e95d10626187 199 }
AnnaBridge 156:ff21514d8981 200
AnnaBridge 170:e95d10626187 201 volatile CThunkTrampoline m_thunk;
AnnaBridge 156:ff21514d8981 202
AnnaBridge 170:e95d10626187 203 inline void init(T *instance, CCallback callback, void *context)
AnnaBridge 170:e95d10626187 204 {
AnnaBridge 170:e95d10626187 205 /* remember callback - need to add this level of redirection
AnnaBridge 170:e95d10626187 206 as pointer size for member functions differs between platforms */
AnnaBridge 170:e95d10626187 207 m_callback = callback;
AnnaBridge 156:ff21514d8981 208
AnnaBridge 170:e95d10626187 209 /* populate thunking trampoline */
AnnaBridge 170:e95d10626187 210 CTHUNK_ASSIGMENT;
AnnaBridge 170:e95d10626187 211 m_thunk.context = (uint32_t)context;
AnnaBridge 170:e95d10626187 212 m_thunk.instance = (uint32_t)instance;
AnnaBridge 170:e95d10626187 213 m_thunk.callback = (uint32_t)&m_callback;
AnnaBridge 170:e95d10626187 214 m_thunk.trampoline = (uint32_t)&trampoline;
AnnaBridge 156:ff21514d8981 215
AnnaBridge 156:ff21514d8981 216 #if defined(__CORTEX_A9)
AnnaBridge 170:e95d10626187 217 /* Data cache clean */
AnnaBridge 170:e95d10626187 218 /* Cache control */
AnnaBridge 170:e95d10626187 219 {
AnnaBridge 170:e95d10626187 220 uint32_t start_addr = (uint32_t)&m_thunk & 0xFFFFFFE0;
AnnaBridge 170:e95d10626187 221 uint32_t end_addr = (uint32_t)&m_thunk + sizeof(m_thunk);
AnnaBridge 170:e95d10626187 222 uint32_t addr;
Anna Bridge 160:5571c4ff569f 223
AnnaBridge 170:e95d10626187 224 /* Data cache clean and invalid */
AnnaBridge 170:e95d10626187 225 for (addr = start_addr; addr < end_addr; addr += 0x20) {
AnnaBridge 170:e95d10626187 226 L1C_CleanInvalidateDCacheMVA((void *)addr);
AnnaBridge 156:ff21514d8981 227 }
AnnaBridge 170:e95d10626187 228 /* Instruction cache invalid */
AnnaBridge 170:e95d10626187 229 L1C_InvalidateICacheAll();
AnnaBridge 170:e95d10626187 230 MMU_InvalidateTLB();
AnnaBridge 170:e95d10626187 231 L1C_InvalidateBTAC();
AnnaBridge 170:e95d10626187 232 }
AnnaBridge 156:ff21514d8981 233 #endif
AnnaBridge 156:ff21514d8981 234 #if defined(__CORTEX_M7)
AnnaBridge 170:e95d10626187 235 /* Data cache clean and invalid */
AnnaBridge 170:e95d10626187 236 SCB_CleanInvalidateDCache();
AnnaBridge 156:ff21514d8981 237
AnnaBridge 170:e95d10626187 238 /* Instruction cache invalid */
AnnaBridge 170:e95d10626187 239 SCB_InvalidateICache();
AnnaBridge 156:ff21514d8981 240 #endif
AnnaBridge 170:e95d10626187 241 __ISB();
AnnaBridge 170:e95d10626187 242 __DSB();
AnnaBridge 170:e95d10626187 243 }
AnnaBridge 156:ff21514d8981 244 };
AnnaBridge 156:ff21514d8981 245
AnnaBridge 158:1c57384330a6 246 /**@}*/
AnnaBridge 158:1c57384330a6 247
AnnaBridge 158:1c57384330a6 248 /**@}*/
AnnaBridge 158:1c57384330a6 249
AnnaBridge 156:ff21514d8981 250 #endif/*__CTHUNK_H__*/
AnnaBridge 156:ff21514d8981 251