Vladimir Vana / mbed

pro vyuku PSS v Jecne

CThunk.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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