begriffs open source - cmsis/blob - CMSIS/DoxyGen/Core/src/Overview.txt

   1 /** \mainpage Overview
   2
   3 CMSIS-Core (Cortex-M) implements the basic run-time system for a Cortex-M device and gives the user access to the processor core and the device peripherals.
   4 In detail it defines:
   5  - <b>Hardware Abstraction Layer (HAL)</b> for Cortex-M processor registers with standardized  definitions for the SysTick, NVIC, System Control Block registers, MPU registers, FPU registers, and core access functions.
   6  - <b>System exception names</b> to interface to system exceptions without having compatibility issues.
   7  - <b>Methods to organize header files</b> that makes it easy to learn new Cortex-M microcontroller products and improve software portability. This includes naming conventions for device-specific interrupts.
   8  - <b>Methods for system initialization</b> to be used by each MCU vendor. For example, the standardized SystemInit() function is essential for configuring the clock system of the device.
   9  - <b>Intrinsic functions</b> used to generate CPU instructions that are not supported by standard C functions.
  10  - A variable to determine the <b>system clock frequency</b> which simplifies the setup the SysTick timer.
  11
  12
  13 The following sections provide details about the CMSIS-Core (Cortex-M):
  14  - \ref using_pg describes the project setup and shows a simple program example.
  15 \if ARMv8M
  16  - \ref using_TrustZone_pg "Using TrustZone&reg; for Armv8-M" describes how to use the security extensions available in the Armv8-M architecture.
  17 \endif
  18  - \ref templates_pg describes the files of the CMSIS-Core (Cortex-M) in detail and explains how to adapt template files provided by Arm to silicon vendor devices.
  19  - \ref coreMISRA_Exceptions_pg describes the violations to the MISRA standard.
  20  - <a href="Modules.html">\b Reference </a> describe the features and functions of the \ref device_h_pg in detail.
  21  - <a href="Annotated.html">\b Data \b Structures </a> describe the data structures of the \ref device_h_pg in detail.
  22
  23 <hr>
  24
  25 CMSIS-Core (Cortex-M) in ARM::CMSIS Pack
  26 -----------------------------
  27
  28 Files relevant to CMSIS-Core (Cortex-M) are present in the following <b>ARM::CMSIS</b> directories:
  29 |File/Folder                   |Content                                                                 |
  30 |------------------------------|------------------------------------------------------------------------|
  31 |\b CMSIS\\Documentation\\Core | This documentation                                                     |
  32 |\b CMSIS\\Core\\Include       | CMSIS-Core (Cortex-M) header files (for example core_cm3.h, core_cmInstr.h, etc.) |
  33 |\b Device                     | \ref using_ARM_pg "Arm reference implementations" of Cortex-M devices  |
  34 |\b Device\\\_Template_Vendor  | \ref templates_pg for extension by silicon vendors                     |
  35
  36 <hr>
  37
  38 \section ref_v6-v8M Processor Support
  39
  40 CMSIS supports the complete range of <a href="http://www.arm.com/products/processors/cortex-m/index.php" target="_blank"><b>Cortex-M processors</b></a> (with exception of Cortex-M1) and the <a href="http://www.arm.com/products/processors/instruction-set-architectures/armv8-m-architecture.php" target="_blank"><b>Armv8-M architecture</b></a> including security extensions.
  41
  42 \subsection ref_man_sec Cortex-M Reference Manuals
  43
  44 The Cortex-M Device Generic User Guides contain the programmers model and detailed information about the core peripherals and are available for:
  45
  46 - <a href="http://infocenter.arm.com/help/topic/com.arm.doc.dui0497a/DUI0497A_cortex_m0_r0p0_generic_ug.pdf" target="_blank"><b>Cortex-M0 Devices Generic User Guide</b></a> (Armv6-M architecture)
  47 - <a href="http://infocenter.arm.com/help/topic/com.arm.doc.dui0662b/DUI0662B_cortex_m0p_r0p1_dgug.pdf" target="_blank"><b>Cortex-M0+ Devices Generic User Guide</b></a> (Armv6-M architecture)
  48 - <a href="http://infocenter.arm.com/help/topic/com.arm.doc.dui0552a/DUI0552A_cortex_m3_dgug.pdf" target="_blank"><b>Cortex-M3 Devices Generic User Guide</b></a> (Armv7-M architecture)
  49 - <a href="http://infocenter.arm.com/help/topic/com.arm.doc.dui0553a/DUI0553A_cortex_m4_dgug.pdf" target="_blank"><b>Cortex-M4 Devices Generic User Guide</b></a> (ARMv7-M architecture)
  50 - <a href="http://infocenter.arm.com/help/topic/com.arm.doc.dui0646a/DUI0646A_cortex_m7_dgug.pdf" target="_blank"><b>Cortex-M7 Devices Generic User Guide</b></a> (Armv7-M architecture)
  51
  52 \if ARMv8M
  53
  54 The \b Cortex-M23 and \b Cortex-M33 are described with Technical Reference Manuals that are available here:
  55 - <a href="http://infocenter.arm.com/help/topic/com.arm.doc.ddi0550c/cortex_m23_r1p0_technical_reference_manual_DDI0550C_en.pdf" target="_blank"><b>Cortex-M23 Technical Reference Manual</b></a> (Armv8-M baseline architecture)
  56 - <a href="http://infocenter.arm.com/help/topic/com.arm.doc.100230_0002_00_en/cortex_m33_trm_100230_0002_00_en.pdf" target="_blank"><b>Cortex-M33 Technical Reference Manual</b></a> (Armv8-M mainline architecture)
  57 \endif
  58
  59 \if ARMv8M \subsection ARMv8M Armv8-M Architecture
  60
  61 Armv8-M introduces two profiles \b baseline (for power and area constrained applications) and \b mainline (full-featured with optional SIMD, floating-point, and co-processor extensions).
  62 Both Armv8-M profiles are supported by CMSIS.
  63
  64 The Armv8-M Architecture is described in the <a href="http://developer.arm.com/products/architecture/m-profile/docs/ddi0553/latest/armv8-m-architecture-reference-manual" target="_blank"><b>Armv8-M Architecture Reference Manual</b></a>.
  65
  66 \endif
  67
  68 <hr>
  69
  70 \section tested_tools_sec Tested and Verified Toolchains
  71
  72 The \ref templates_pg supplied by Arm have been tested and verified with the following toolchains:
  73  - Arm: Arm Compiler 5.06 update 6 (not for Cortex-M23, Cortex-M33, Armv8-M)
  74  - Arm: Arm Compiler 6.9
  75  - Arm: Arm Compiler 6.6.2 (not for Cortex-M0, Cortex-M23, Cortex-M33, Armv8-M)
  76  - GNU: GNU Tools for Arm Embedded 6.3.1 20170620
  77  - IAR: IAR ANSI C/C++ Compiler for Arm 8.20.1.14183
  78
  79 <hr>
  80 */
  81 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
  82 /**
  83
  84 \page core_revisionHistory Revision History of CMSIS-Core (Cortex-M)
  85
  86 <table class="cmtable" summary="Revision History">
  87     <tr>
  88       <th>Version</th>
  89       <th>Description</th>
  90     </tr>
  91     <tr>
  92       <td>V5.2.0</td>
  93       <td>
  94         Added: Cortex-M35P support.\n
  95       </td>
  96     </tr>
  97     <tr>
  98       <td>V5.1.2</td>
  99       <td>
 100         Removed using get/set built-ins FPSCR in GCC >= 7.2 due to shortcomings.\n
 101         Added __NO_RETURN to __NVIC_SystemReset() to silence compiler warnings.\n
 102         Added support for Cortex-M1 (beta). \n
 103         Removed usage of register keyword. \n
 104         Added defines for EXC_RETURN, FNC_RETURN and integrity signature values. \n
 105         Enhanced MPUv7 API with defines for memory access attributes.\n
 106       </td>
 107     </tr>
 108     <tr>
 109       <td>V5.1.1</td>
 110       <td>
 111         Aligned MSPLIM and PSPLIM access functions along supported compilers.\n
 112       </td>
 113     </tr>
 114     <tr>
 115       <td>V5.1.0</td>
 116       <td>
 117         Added MPU Functions for ARMv8-M for Cortex-M23/M33.\n
 118         Moved __SSAT and __USAT intrinsics to CMSIS-Core.\n
 119         Aligned __REV, __REV16 and __REVSH intrinsics along supported compilers.\n
 120       </td>
 121     </tr>
 122     <tr>
 123       <td>V5.0.2</td>
 124       <td>
 125         Added macros  \ref \__UNALIGNED_UINT16_READ,  \ref \__UNALIGNED_UINT16_WRITE.\n
 126         Added macros  \ref \__UNALIGNED_UINT32_READ,  \ref \__UNALIGNED_UINT32_WRITE.\n
 127         Deprecated macro  \ref \__UNALIGNED_UINT32.\n
 128         Changed \ref version_control_gr macros to be core agnostic. \n
 129         Added \ref mpu_functions for Cortex-M0+/M3/M4/M7.
 130       </td>
 131     </tr>
 132     <tr>
 133       <td>V5.0.1</td>
 134       <td>
 135         Added: macro \ref \__PACKED_STRUCT. \n
 136         Added: uVisor support. \n
 137       </td>
 138     </tr>
 139     <tr>
 140       <td>V5.00</td>
 141       <td>
 142         Added: Cortex-M23, Cortex-M33 support.\n
 143         Added: macro __SAU_PRESENT with __SAU_REGION_PRESENT. \n
 144         Replaced: macro __SAU_PRESENT with __SAU_REGION_PRESENT. \n
 145         Reworked: SAU register and functions. \n
 146         Added: macro \ref \__ALIGNED. \n
 147         Updated: function \ref SCB_EnableICache. \n
 148         Added: cmsis_compiler.h with compiler specific CMSIS macros, functions, instructions. \n
 149         Added: macro \ref \__PACKED. \n
 150         Updated: compiler specific include files. \n
 151         Updated: core dependant include files. \n
 152         Removed: deprecated files core_cmfunc.h, core_cminstr.h, core_cmsimd.h.
 153       </td>
 154     </tr>
 155     <tr>
 156       <td>V5.00<br>Beta 6</td>
 157       <td>
 158         Added: SCB_CFSR register bit definitions. \n
 159         Added: function \ref NVIC_GetEnableIRQ. \n
 160         Updated: core instruction macros \ref \__NOP, \ref \__WFI, \ref \__WFE, \ref \__SEV for toolchain GCC.
 161       </td>
 162     </tr>
 163     <tr>
 164       <td>V5.00<br>Beta 5</td>
 165       <td>
 166         Moved: DSP libraries from CMSIS/DSP/Lib to CMSIS/Lib. \n
 167         Added: DSP libraries build projects to CMSIS pack.
 168       </td>
 169     </tr>
 170     <tr>
 171       <td>V5.00<br>Beta 4</td>
 172       <td>
 173         Updated: ARMv8M device files. \n
 174         Corrected: ARMv8MBL interrupts. \n
 175         Reworked: NVIC functions.
 176       </td>
 177     </tr>
 178     <tr>
 179       <td>V5.00<br>Beta 2</td>
 180       <td>
 181         Changed: ARMv8M SAU regions to 8. \n
 182         Changed: moved function \ref TZ_SAU_Setup to file partition_&lt;device&gt;.h. \n
 183         Changed: license under Apache-2.0. \n
 184         Added: check if macro is defined before use. \n
 185         Corrected: function \ref SCB_DisableDCache. \n
 186         Corrected: macros \ref \_VAL2FLD, \ref \_FLD2VAL. \n
 187         Added: NVIC function virtualization with macros \ref CMSIS_NVIC_VIRTUAL and \ref CMSIS_VECTAB_VIRTUAL.
 188       </td>
 189     </tr>
 190     <tr>
 191       <td>V5.00<br>Beta 1</td>
 192       <td>
 193         Renamed: cmsis_armcc_V6.h to cmsis_armclang.h.\n
 194         Renamed: core\_*.h to lower case.\n
 195         Added: function \ref SCB_GetFPUType to all CMSIS cores.\n
 196         Added: ARMv8-M support.
 197       </td>
 198     </tr>
 199     <tr>
 200       <td>V4.30</td>
 201       <td>
 202         Corrected: DoxyGen function parameter comments.\n
 203         Corrected: IAR toolchain: removed for \ref NVIC_SystemReset the attribute(noreturn).\n
 204         Corrected: GCC toolchain: suppressed irrelevant compiler warnings.\n
 205         Added: Support files for Arm Compiler v6 (cmsis_armcc_v6.h).
 206       </td>
 207     </tr>
 208     <tr>
 209       <td>V4.20</td>
 210       <td>
 211         Corrected: MISRA-C:2004 violations. \n
 212         Corrected: predefined macro for TI CCS Compiler. \n
 213         Corrected: function \ref __SHADD16 in arm_math.h. \n
 214         Updated: cache functions for Cortex-M7. \n
 215         Added: macros \ref _VAL2FLD, \ref _FLD2VAL to core\_*.h. \n
 216         Updated: functions \ref __QASX, \ref __QSAX, \ref __SHASX, \ref __SHSAX. \n
 217      Corrected: potential bug in function \ref __SHADD16.
 218     </td>
 219     </tr>
 220     <tr>
 221       <td>V4.10</td>
 222       <td>
 223         Corrected: MISRA-C:2004 violations. \n
 224         Corrected: intrinsic functions \ref __DSB, \ref __DMB, \ref __ISB. \n
 225         Corrected: register definitions for ITCMCR register. \n
 226         Corrected: register definitions for \ref CONTROL_Type register. \n
 227         Added: functions \ref SCB_GetFPUType, \ref SCB_InvalidateDCache_by_Addr to core_cm7.h. \n
 228         Added: register definitions for \ref APSR_Type, \ref IPSR_Type, \ref xPSR_Type register. \n
 229         Added: \ref __set_BASEPRI_MAX function to core_cmFunc.h. \n
 230         Added: intrinsic functions \ref __RBIT, \ref __CLZ  for Cortex-M0/CortexM0+. \n
 231       </td>
 232     </tr>
 233     <tr>
 234       <td>V4.00</td>
 235       <td>
 236         Added: Cortex-M7 support.\n
 237         Added: intrinsic functions for \ref __RRX, \ref __LDRBT, \ref __LDRHT, \ref __LDRT, \ref __STRBT, \ref __STRHT, and \ref __STRT  \n
 238       </td>
 239     </tr>
 240     <tr>
 241       <td>V3.40</td>
 242       <td>Corrected: C++ include guard settings.\n</td>
 243     </tr>
 244     <tr>
 245       <td>V3.30</td>
 246       <td>
 247         Added: COSMIC tool chain support.\n
 248         Corrected: GCC __SMLALDX instruction intrinsic for Cortex-M4.\n
 249         Corrected: GCC __SMLALD instruction intrinsic for Cortex-M4.\n
 250         Corrected: GCC/CLang warnings.\n
 251       </td>
 252     </tr>
 253     <tr>
 254       <td>V3.20</td>
 255       <td>
 256         Added: \ref __BKPT instruction intrinsic.\n
 257         Added: \ref __SMMLA instruction intrinsic for Cortex-M4.\n
 258         Corrected: \ref ITM_SendChar.\n
 259         Corrected: \ref __enable_irq, \ref __disable_irq and inline assembly for GCC Compiler.\n
 260         Corrected: \ref NVIC_GetPriority and VTOR_TBLOFF for Cortex-M0/M0+, SC000. \n
 261         Corrected: rework of in-line assembly functions to remove potential compiler warnings.\n
 262       </td>
 263     </tr>
 264     <tr>
 265       <td>V3.01</td>
 266       <td>Added support for Cortex-M0+ processor.\n</td>
 267     </tr>
 268     <tr>
 269       <td>V3.00</td>
 270       <td>
 271         Added support for GNU GCC ARM Embedded Compiler. \n
 272         Added function \ref __ROR.\n
 273         Added \ref regMap_pg for TPIU, DWT. \n
 274         Added support for \ref core_config_sect "SC000 and SC300 processors".\n
 275         Corrected \ref ITM_SendChar function. \n
 276         Corrected the functions \ref __STREXB, \ref __STREXH, \ref __STREXW for the GNU GCC compiler section. \n
 277         Documentation restructured.
 278       </td>
 279     </tr>
 280     <tr>
 281       <td>V2.10</td>
 282       <td>
 283         Updated documentation.\n
 284         Updated CMSIS core include files.\n
 285         Changed CMSIS/Device folder structure.\n
 286         Added support for Cortex-M0, Cortex-M4 w/o FPU to CMSIS DSP library.\n
 287         Reworked CMSIS DSP library examples.
 288       </td>
 289     </tr>
 290     <tr>
 291       <td>V2.00</td>
 292       <td>Added support for Cortex-M4 processor.</td>
 293     </tr>
 294     <tr>
 295       <td>V1.30</td>
 296       <td>
 297         Reworked Startup Concept.\n
 298         Added additional Debug Functionality.\n
 299         Changed folder structure.\n
 300         Added doxygen comments.\n
 301         Added definitions for bit.
 302       </td>
 303     </tr>
 304     <tr>
 305       <td>V1.01</td>
 306       <td>Added support for Cortex-M0 processor.</td>
 307     </tr>
 308     <tr>
 309       <td>V1.01</td>
 310       <td>Added intrinsic functions for \ref __LDREXB, \ref __LDREXH, \ref __LDREXW, \ref __STREXB, \ref __STREXH, \ref __STREXW, and \ref __CLREX</td>
 311     </tr>
 312     <tr>
 313       <td>V1.00</td>
 314       <td>Initial Release for Cortex-M3 processor.</td>
 315     </tr>
 316 </table>
 317
 318 */
 319
 320