begriffs open source - cmsis/blob - CMSIS/DoxyGen/Core_A/src/cmsis_armcc.txt

   1 /**************************************************************************//**
   2  * @file     cmsis_armcc.txt
   3  * @brief    CMSIS compiler specific macros, functions, instructions
   4  * @version  V1.00
   5  * @date     22. Feb 2017
   6  ******************************************************************************/
   7 /* CMSIS compiler control architecture macros */
   8 /**
   9 \defgroup comp_cntrl_gr Compiler Control
  10 \brief Compiler agnostic \#define symbols for generic C/C++ source code
  11 \details
  12 The CMSIS-Core provides the header file \b cmsis_compiler.h with consistent \#define symbols to generate C or C++ source files that should be compiler agnostic.
  13 Each CMSIS compliant compiler should support the functionality described in this section.
  14 @{
  15 */
  16
  17 /**
  18 \def __ARMCC_VERSION
  19 */
  20
  21 /**
  22 \def __ARM_ARCH_7A__
  23 \brief Set to 1 when generating code for ARMv7-A (Cortex-A7)
  24 \details
  25 The \b \#define __ARM_ARCH_7A__ is set to 1 when generating code for the ARMv7-A architecture. This architecture is for example used by the Cortex-A7 processor.
  26 */
  27
  28 /**
  29 \def __ASM
  30 \brief Pass information from the compiler to the assembler.
  31 \details
  32 The \b __ASM keyword can declare or define an embedded assembly function or incorporate inline assembly into a function
  33 (shown in the code example below).
  34
  35 <b>Code Example:</b>
  36 \code
  37 // Reverse bit order of value
  38
  39 __attribute__( ( always_inline ) ) __STATIC_INLINE uint32_t __RBIT(uint32_t value)
  40 {
  41   uint32_t result;
  42
  43    __ASM volatile ("rbit %0, %1" : "=r" (result) : "r" (value) );
  44    return(result);
  45 }
  46 \endcode
  47 */
  48
  49 /**
  50 \def __INLINE
  51 \brief Recommend that function should be inlined by the compiler.
  52 \details
  53 Inline functions offer a trade-off between code size and performance. By default, the compiler decides during optimization whether to
  54 inline code or not. The \b __INLINE attribute gives the compiler an hint to inline this function.
  55 Still, the compiler may decide not to inline the function. As the function is global an callable function is also generated.
  56
  57 <b> Code Example:</b>
  58 \code
  59 const uint32_t led_mask[] = {1U << 4, 1U << 5, 1U << 6, 1U << 7};
  60
  61 //------------------------------------------------------------------------------
  62 // Switch on LEDs
  63 //------------------------------------------------------------------------------
  64 __INLINE static void LED_On (uint32_t led) {
  65
  66   PTD->PCOR   = led_mask[led];
  67 }
  68 \endcode
  69 */
  70
  71 /**
  72 \def __STATIC_INLINE
  73 \brief Define a static function should be inlined by the compiler.
  74 \details
  75 Defines a static function that may be inlined by the compiler. If the compiler generates inline code for
  76 all calls to this functions, no additional function implementation is generated which may further optimize space.
  77
  78 <b> Code Example:</b>
  79 \code
  80 __STATIC_INLINE uint32_t GIC_GetPriority(IRQn_Type IRQn)
  81 {
  82   return((uint32_t)GICDistributor->D_IPRIORITYR[((uint32_t)(int32_t)IRQn)]);
  83 }
  84 \endcode
  85 */
  86
  87 /**
  88 \def __NO_RETURN
  89 \brief Inform the compiler that a function does not return.
  90 \details
  91 Informs the compiler that the function does not return. The compiler can then perform optimizations by
  92 removing code that is never reached.
  93
  94 <b> Code Example:</b>
  95 \code
  96 // OS idle demon (running when no other thread is ready to run).
  97
  98 __NO_RETURN void os_idle_demon (void);
  99 \endcode
 100 */
 101
 102 /**
 103 \def __USED
 104 \brief Inform that a variable shall be retained in executable image.
 105 \details
 106 Definitions tagged with \b __USED in the source code should be not removed by the linker when detected as unused.
 107
 108 <b> Code Example:</b>
 109 \code
 110 // Export following variables for debugging
 111 __USED uint32_t const CMSIS_RTOS_API_Version = osCMSIS;
 112 __USED uint32_t const CMSIS_RTOS_RTX_Version = osCMSIS_RTX;
 113 __USED uint32_t const os_clockrate = OS_TICK;
 114 __USED uint32_t const os_timernum  = 0;
 115 \endcode
 116 **/
 117
 118 /**
 119 \def __WEAK
 120 \brief Export a function or variable weakly to allow overwrites.
 121 \details
 122 Functions defined with \b __WEAK export their symbols weakly. A function defined weak behaves like a normal defined
 123 function unless a non-weak function with the same name is linked into the same image. If both a non-weak
 124 function and a weak defined function exist in the same image, then all calls to the function resolve to the non-weak
 125 function.
 126
 127 Functions declared with \b __WEAK and then defined without \b __WEAK behave as non-weak functions.
 128
 129 <b> Code Example:</b>
 130 \code
 131 __WEAK void SystemInit(void)
 132 {
 133   SystemCoreSetup();
 134   SystemCoreClockSetup();
 135 }
 136 \endcode
 137 */
 138
 139 /**
 140 \def __ALIGNED(x)
 141 \brief Minimum alignment for a variable.
 142 \details
 143 Specifies a minimum alignment for a variable or structure field, measured in bytes.
 144
 145 <b> Code Example:</b>
 146 \code
 147 uint32_t stack_space[0x100] __ALIGNED(8);   // 8-byte alignment required
 148 \endcode
 149 */
 150
 151 /**
 152 \def __PACKED
 153 \brief Request smallest possible alignment.
 154 \details
 155 Specifies that a type must have the smallest possible alignment.
 156
 157 <b> Code Example:</b>
 158 \code
 159 struct foo {
 160   uint8_t  u8;
 161   uint32_t u32[2] __PACKED;
 162 };
 163 \endcode
 164 */
 165
 166 /**
 167 @}
 168 */
 169 /* end group comp_cntrl_gr */
 170
 171 /* ###########################  Core Function Access  ########################### */
 172 /**
 173 \defgroup core_reg_func_gr Core Register Access
 174 \brief Functions to access the Cortex-A core registers
 175 @{
 176 */
 177
 178 /**
 179 \fn __STATIC_INLINE uint32_t __get_FPSCR(void)
 180 \details
 181   Returns the current value of the Floating Point Status/Control register.
 182
 183 \fn __STATIC_INLINE void __set_FPSCR(uint32_t fpscr)
 184 \details
 185   Assigns the given value to the Floating Point Status/Control register.
 186
 187 \fn __STATIC_INLINE uint32_t __get_CPSR(void)
 188 \details
 189         This function returns the content of the CPSR Register.
 190
 191 \fn __STATIC_INLINE void __set_CPSR(uint32_t cpsr)
 192 \details
 193         This function assigns the given value to the CPSR Register.
 194
 195 \fn __STATIC_INLINE __ASM void __set_SP(uint32_t stack)
 196 \details
 197   This function assigns the given value to the current stack pointer.
 198
 199 \fn __STATIC_INLINE __ASM void __set_SP_usr(uint32_t topOfProcStack)
 200 \details
 201   This function assigns the given value to the USR/SYS Stack Pointer (PSP).
 202
 203 \fn __STATIC_INLINE uint32_t __get_FPEXC(void)
 204 \details
 205   This function returns the current value of the Floating Point Exception Control register.
 206
 207 \fn __STATIC_INLINE void __set_FPEXC(uint32_t fpexc)
 208 \details
 209   This function assigns the given value to the Floating Point Exception Control register.
 210
 211 \fn __STATIC_INLINE uint32_t __get_CPACR(void)
 212 \details
 213   This function returns the current value of the Coprocessor Access Control register.
 214
 215 \fn __STATIC_INLINE void __set_CPACR(uint32_t cpacr)
 216 \details
 217   This function assigns the given value to the Coprocessor Access Control register.
 218
 219 \fn __STATIC_INLINE uint32_t __get_CBAR()
 220 \details
 221   This function returns the value of the Configuration Base Address register.
 222
 223 \fn __STATIC_INLINE uint32_t __get_TTBR0()
 224 \details
 225   This function returns the value of the Translation Table Base Register 0.
 226
 227 \fn __STATIC_INLINE void __set_TTBR0(uint32_t ttbr0)
 228 \details
 229   This function assigns the given value to the Translation Table Base Register 0.
 230
 231 \fn __STATIC_INLINE uint32_t __get_DACR()
 232 \details
 233   This function returns the value of the Domain Access Control Register.
 234
 235 \fn __STATIC_INLINE void __set_DACR(uint32_t dacr)
 236 \details
 237   This function assigns the given value to the Domain Access Control Register.
 238
 239 \fn __STATIC_INLINE void __set_SCTLR(uint32_t sctlr)
 240 \details
 241   This function assigns the given value to the System Control Register.
 242
 243 \fn __STATIC_INLINE uint32_t __get_SCTLR()
 244 \details
 245   This function returns the value of the System Control Register.
 246
 247 \fn __STATIC_INLINE void __set_ACTRL(uint32_t actrl)
 248 \details
 249   This function assigns the given value to the Auxiliary Control Register.
 250
 251 \fn __STATIC_INLINE uint32_t __get_ACTRL(void)
 252 \details
 253   This function returns the value of the Auxiliary Control Register.
 254
 255 \fn __STATIC_INLINE uint32_t __get_MPIDR(void)
 256 \details
 257   This function returns the value of the Multiprocessor Affinity Register.
 258
 259 \fn __STATIC_INLINE uint32_t __get_VBAR(void)
 260 \details
 261   This function returns the value of the Vector Base Address Register.
 262
 263 \fn __STATIC_INLINE void __set_VBAR(uint32_t vbar)
 264 \details
 265   This function assigns the given value to the Vector Base Address Register.
 266
 267 \fn __STATIC_INLINE void __set_CNTP_TVAL(uint32_t value)
 268 \details
 269   This function assigns the given value to PL1 Physical Timer Value Register (CNTP_TVAL).
 270
 271 \fn __STATIC_INLINE uint32_t __get_CNTP_TVAL()
 272 \details
 273   This function returns the value of the PL1 Physical Timer Value Register (CNTP_TVAL).
 274
 275 \fn __STATIC_INLINE void __set_CNTP_CTL(uint32_t value)
 276 \details
 277   This function assigns the given value to PL1 Physical Timer Control Register (CNTP_CTL).
 278
 279 \fn __STATIC_INLINE void __set_TLBIALL(uint32_t value)
 280 \details
 281
 282 \fn __STATIC_INLINE void __set_BPIALL(uint32_t value)
 283 \details
 284   Branch Predictor Invalidate All
 285
 286 \fn __STATIC_INLINE void __set_ICIALLU(uint32_t value)
 287 \details
 288   Instruction Cache Invalidate All
 289
 290 \fn __STATIC_INLINE void __set_DCCMVAC(uint32_t value)
 291 \details
 292   Data cache clean
 293
 294 \fn __STATIC_INLINE void __set_DCIMVAC(uint32_t value)
 295 \details
 296   Data cache invalidate
 297
 298 \fn __STATIC_INLINE void __set_DCCIMVAC(uint32_t value)
 299 \details
 300   Data cache clean and invalidate
 301 */
 302 /**
 303 @}
 304 */
 305 /* end group core_reg_func_gr */
 306
 307 /* ##########################  Core Instruction Access  ######################### */
 308 /**
 309 \defgroup CMSIS_Core_InstructionInterface Intrinsic Functions for CPU Instructions
 310 \brief Functions that generate specific Cortex-A CPU Instructions
 311 @{
 312 */
 313
 314 /**
 315 \def __NOP
 316 \details No Operation does nothing. This instruction can be used for code alignment purposes.
 317
 318
 319 \def __WFI
 320 \details Wait For Interrupt is a hint instruction that suspends execution until one of a number of events occurs.
 321
 322 \def __WFE
 323 \details Wait For Event is a hint instruction that permits the processor to enter
 324
 325 \def __SEV
 326 \details Send Event is a hint instruction. It causes an event to be signaled to the CPU.
 327
 328 \def __ISB()
 329 \details Instruction Synchronization Barrier flushes the pipeline in the processor,
 330            so that all instructions following the ISB are fetched from cache or memory,
 331            after the instruction has been completed.
 332
 333 \def __DSB()
 334 \details Acts as a special kind of Data Memory Barrier.
 335            It completes when all explicit memory accesses before this instruction complete.
 336
 337 \def __DMB()
 338 \details Ensures the apparent order of the explicit memory operations before
 339            and after the instruction, without ensuring their completion.
 340
 341
 342 \def __REV
 343 \details Reverses the byte order in integer value.
 344 */
 345
 346 /**
 347 \details Reverses the byte order in two unsigned short values.
 348 */
 349 /* leave definition here */
 350 _STATIC_INLINE __ASM uint32_t __REV16(uint32_t value);
 351
 352 /**
 353 \details Reverses the byte order in a signed short value with sign extension to integer.
 354 */
 355 /* leave definition here */
 356 \fn __STATIC_INLINE __ASM int32_t __REVSH(int32_t value);
 357
 358 /**
 359 \def __ROR
 360 \details Rotate Right (immediate) provides the value of the contents of a register rotated by a variable number of bits.
 361
 362 \def __BKPT(value)
 363 \details Causes the processor to enter Debug state.
 364            Debug tools can use this to investigate system state when the instruction at a particular address is reached.
 365
 366
 367 \fn __STATIC_INLINE uint32_t __RBIT(uint32_t value)
 368 \details
 369         Reverses the bit order of the given value.
 370
 371 \def __CLZ
 372 \details
 373         Counts the number of leading zeros of a data value.
 374 */
 375
 376 /** @}*/
 377 /* end of group CMSIS_Core_InstructionInterface */
 378
 379