Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/CThunk.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

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