Kev Mann / mbed-dev-OS5_10_4

RTC auf true

platform/CThunk.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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