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@157:e7ca05fa8600, 2017-11-09 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 09 11:14:10 2017 +0000
Revision:
157:e7ca05fa8600
Parent:
156:ff21514d8981
Child:
158:1c57384330a6
Release 155 of the mbed library.

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