mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

platform/CThunk.h@187:0387e8f68319, 2018-09-06 (annotated)

Committer:
AnnaBridge
Date:
Thu Sep 06 13:40:20 2018 +0100
Revision:
187:0387e8f68319
Parent:
181:57724642e740
Child:
189:f392fc9709a3
mbed-dev library. Release version 163

Who changed what in which revision?

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