Gan likun / mbed-dev

00

platform/CThunk.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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