Egor Rumjantsev / mbed

The official mbed C/C SDK provides the software platform and libraries to build your applications.

Fork of mbed by mbed official

CThunk.h@99:7f6c6de930c0, 2015-05-03 (annotated)

Committer:
Mikchel
Date:
Sun May 03 16:04:42 2015 +0000
Revision:
99:7f6c6de930c0
Parent:
98:8ab26030e058 
12

Who changed what in which revision?

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