Christopher Haster / mbed-hal

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   target-freescale

Fork of mbed-hal by Morpheus

api/CThunk.h@0:9c59db1fbc9e, 2016-03-23 (annotated)

Committer:
screamer
Date:
Wed Mar 23 21:36:09 2016 +0000
Revision:
0:9c59db1fbc9e
Initial revision

Who changed what in which revision?

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