PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

api/CThunk.h@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

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