Toyomasa Watarai / Mbed OS armcc_info

Describes predefine macros for mbed online compiler (armcc)

mbed/platform/CThunk.h@6:40e873bbc5f7, 2017-03-16 (annotated)

Committer:
MACRUM
Date:
Thu Mar 16 21:58:09 2017 +0900
Revision:
6:40e873bbc5f7
Add licence header info

Who changed what in which revision?

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