Initial CMSIS-RTOS v2 API Documentation, Example and Component Viewer Description

[cmsis] / CMSIS / DoxyGen / General / src / introduction.txt

/**************************************************************************************************/
/** 
\mainpage Introduction

The <b>Cortex Microcontroller Software Interface Standard</b> (CMSIS) is a vendor-independent 
hardware abstraction layer for the Cortex&reg;-M processor series and defines generic tool
interfaces.  The CMSIS enables consistent device support and 
simple software interfaces to the processor and the peripherals, simplifying software re-use, 
reducing the learning curve for microcontroller developers, and reducing the time to market for new devices. 
    
The CMSIS is defined in close cooperation with various silicon and software vendors and 
provides a common approach to interface to peripherals, real-time operating systems, 
and middleware components. The CMSIS is intended to enable the combination of software components 
from multiple middleware vendors. 

CMSIS Version 5 supports also the <a class="el" href="http://www.arm.com/products/processors/instruction-set-architectures/armv8-m-architecture.php" target="_blank">ARMv8-M architecture</a> 
including <a class="el" href="http://www.arm.com/products/processors/technologies/trustzone/index.php" target="_blank">TrustZone&reg; for ARMv8-M</a> hardware security extensions.

\anchor CM_Components
The CMSIS components are:
 - <a href="../../Core/html/index.html"><b>CMSIS-CORE</b></a>: API for the Cortex-M processor core and peripherals. It provides at standardized interface for Cortex-M0, Cortex-M3, Cortex-M4, Cortex-M7, SC000, and SC300. 
   Included are also SIMD intrinsic functions for Cortex-M4 and Cortex-M7 SIMD instructions.

 - <a href="../../Driver/html/index.html"><b>CMSIS-Driver</b></a>: defines generic peripheral driver interfaces for middleware making it reusable across supported devices. The API is RTOS independent
    and connects microcontroller peripherals with middleware that implements for example communication stacks, file systems, or graphic user interfaces.

 - <a href="../../DSP/html/index.html"><b>CMSIS-DSP</b></a>: DSP Library Collection with over 60 Functions for various data types: fix-point (fractional q7, q15, q31) and single precision floating-point (32-bit).
   The library is available for all Cortex-M cores. The Cortex-M4 and Cortex-M7 implementations are optimized for the SIMD instruction set.

 - <a href="../../RTOS/html/index.html"><b>CMSIS-RTOS v1</b></a>: Common API for Real-Time Operating Systems along with reference implementation based on RTX.
    It provides a standardized programming interface that is portable to many RTOS and enables software components that can work across multiple RTOS systems.

 - <a href="../../RTOS2/html/index.html"><b>CMSIS-RTOS v2</b></a>: extends CMSIS-RTOS v1 with support for ARMv8-M architecture, dynamic object creation,
    provisions for multi-core systems, and binary compatible interface across ABI compliant compilers.
        
 - <a href="../../Pack/html/index.html"><b>CMSIS-Pack</b></a>: describes with a XML based package description (PDSC) file the user and device relevant parts of a file collection (called software pack) that includes source, header, and library files, documentation, 
    Flash programming algorithms, source code templates, and example projects. Development tools and web infrastructures use the PDSC file to extract device parameters, 
    software components, and evaluation board configurations.

 - <a href="../../SVD/html/index.html"><b>CMSIS-SVD</b></a>: System View Description for Peripherals. Describes the peripherals of a device in an XML file and can be used to create peripheral awareness in 
    debuggers or header files with peripheral register and interrupt definitions.

 - <a href="../../DAP/html/index.html"><b>CMSIS-DAP</b></a>: Debug Access Port. Standardized firmware for a Debug Unit that connects to the CoreSight Debug Access Port. CMSIS-DAP is distributed as separate package and
    well suited for integration on evaluation boards. This component is provided as separate download.

\note Refer to \ref CM_Pack_Content for more information on the content of the Software Pack.

\image html CMSISv4_small.png "CMSIS Structure"
        
\section Motivation Motivation

CMSIS has been created to help the industry in standardization. It enables consistent software layers and device support across a wide range of development tools and microcontrollers.
CMSIS is not a huge software layer that introduces overhead and does not define standard peripherals. The silicon industry can
therefore support the wide variations of Cortex-M processor-based devices with this common standard.

In detail the benefits of the CMSIS are:

 - Overall CMSIS reduces the learning curve, development costs, and time-to-market. Developers can write software quicker through a variety of easy-to-use, standardized software interfaces.
 - Consistent software interfaces improve the software portability and re-usability. Generic software libraries and interfaces provide consistent software framework.
 - Provides interfaces for debug connectivity, debug peripheral views, software delivery, and device support to reduce time-to-market for new microcontroller deployment.
 - Provides a compiler independent layer that allows using different compilers. CMSIS is supported by all mainstream compilers (ARMCC, IAR, and GNU).
 - Enhances program debugging with peripheral information for debuggers and ITM channels for printf-style output and RTOS kernel awareness. 
 - CMSIS is delivered in CMSIS-Pack format which enables fast software delivery, simplifies updates, and enables consistent integration into development tools. 


\section CodingRules Coding Rules

The CMSIS uses the following essential coding rules and conventions:
 - Compliant with ANSI C and C++.
 - Uses ANSI C standard data types defined in \b <stdint.h>.
 - Variables and parameters have a complete data type.
 - Expressions for \em \#define constants are enclosed in parenthesis.
 - Conforms to MISRA 2004. MISRA rule violations are documented.
          
In addition, the CMSIS recommends the following conventions for identifiers:
 - \b CAPITAL names to identify Core Registers, Peripheral Registers, and CPU Instructions.
 - \b CamelCase names to identify function names and interrupt functions.
 - \b Namespace_ prefixes avoid clashes with user identifiers and provide functional groups (i.e. for peripherals, RTOS, or DSP Library).

The CMSIS is documented within the source files with:
 \li Comments that use the C or C++ style. 
 \li Doxygen compliant <b>function comments</b> that provide:
    - brief function overview.
    - detailed description of the function.
    - detailed parameter explanation.
    - detailed information about return values.

Doxygen comment example:
\verbatim
/** 
 * @brief  Enable Interrupt in NVIC Interrupt Controller
 * @param  IRQn  interrupt number that specifies the interrupt
 * @return none.
 * Enable the specified interrupt in the NVIC Interrupt Controller.
 * Other settings of the interrupt such as priority are not affected.
 */
\endverbatim


\section License Licence

The CMSIS is provided free of charge by ARM under Apache 2.0 license. 
View the <a href="LICENSE">Apache 2.0 License</a>.


\section CM_Pack_Content ARM::CMSIS Pack

The <b>ARM::CMSIS</b> Pack contains the following:
|File/Directory    |Content                                                                           |
|:-----------------|:---------------------------------------------------------------------------------|
|\b ARM.CMSIS.pdsc |Package description file                                                          |
|\b CMSIS          |\ref CM_Components "CMSIS components" (see below)                                 |
|\b Device         |ARM reference implementations of Cortex-M devices                                 |

CMSIS Directory
---------------

The directory <b>CMSIS</b> contains the  "CMSIS End User License Agreement" as PDF and RTF, a README text file, the
index.html file for this documentation, and the following sub-directories:

|Directory                 |Content                                                                                                                                  |
|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------|
|\b Documentation          |This documentation                                                                                                                       |
|\b DAP                    |<a href="../../DAP/html/index.html"><b>CMSIS-DAP</b></a> Debug Access Port source code and reference implementations                     |
|\b Driver                 |Header files for the <a href="../../Driver/html/index.html"><b>CMSIS-Driver</b></a> peripheral interface API                             |
|\b DSP_Lib                |<a href="../../DSP/html/index.html"><b>CMSIS-DSP</b></a> software library source code                                                    |
|\b Include                |Include files for <a href="../../Core/html/index.html"><b>CMSIS-CORE</b></a> and <a href="../../DSP/html/index.html"><b>CMSIS-DSP</b></a>|
|\b Lib                    |<a href="../../DSP/html/index.html"><b>CMSIS-DSP</b></a> generated libraries for ARMCC and GCC                                           |
|\b Pack                   |<a href="../../Pack/html/_pack__example.html"><b>CMSIS-Pack</b></a> example                                                              |
|\b RTOS                   |<a href="../../RTOS/html/index.html"><b>CMSIS-RTOS API Version 1</b></a> along with RTX reference implementation                         |
|\b RTOSv2                 |<a href="../../RTOSv1/html/index.html"><b>CMSIS-RTOS Version 2</b></a> along with RTX reference implementation                           |
|\b SVD                    |<a href="../../SVD/html/index.html"><b>CMSIS-SVD</b></a> example                                                                         |
|\b UserCodeTemplates\\ARM |ITM_Retarget.c, CMSIS <a href="../../Core/html/group___i_t_m___debug__gr.html"><b>retarget output</b></a> to ITM Channel 0 template file |
|\b Utilities              |PACK.xsd (<a href="../../Pack/html/_pack__example.html"><b>CMSIS-Pack</b></a> schema file), PackChk.exe (checking tool for software packs), \n CMSIS-SVD.xsd (<a href="../../SVD/html/index.html"><b>CMSIS-SVD</b></a> schema file), SVDConv.exe (conversion tool for SVD files)|

<hr>
*/

/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
/**
\page cm_revisionHistory Revision History 


The following table shows the overall high-level history of the various CMSIS releases.
In addition, each CMSIS component has its own release history:

- <a href="../../Core/html/core_revision_history.html"><b>CORE Revision History</b></a>
- <a href="../../DAP/html/rev_hist_dap.html"><b>DAP Revision History</b></a>
- <a href="../../Driver/html/driver_revision_history.html"><b>Driver Revision History</b></a>
- <a href="../../DSP/html/_change_log_pg.html"><b>DSP Revision History (Change Log)</b></a>
- <a href="../../Pack/html/pack_revision_history.html"><b>Pack Revision History</b></a>
- <a href="../../RTOS/html/rtos_revision_history.html"><b>RTOS v1 Revision History</b></a>
- <a href="../../RTOS2/html/rtos_revision_history.html"><b>RTOS v2 Revision History</b></a>
- <a href="../../RTX/html/rtx_revision_history.html"><b>RTX Revision History</b></a>
- <a href="../../SVD/html/svd_revision_history.html"><b>SVD Revision History</b></a>



<table class="cmtable" summary="Revision History">
    <tr>
      <th>Version</th>
      <th>Description</th>
    </tr>
    <tr>
      <td>5.0.0</td>
      <td>
        Added <a href="http://www.arm.com/products/processors/instruction-set-architectures/armv8-m-architecture.php" target="_blank"><b>ARMv8-M architecture</b></a> support.
        - CMSIS-CORE 5.0.0
                    - CMSIS-RTOS 2.0.0
        - CMSIS-PACK 1.4.4 introducing CPDSC project description
      </td>
    </tr>
    <tr>
      <td>4.5.0</td>
      <td>
        Maintenance release that is fixing defects. See component's revision history for more details.
        See component's revision history for more details.
        - CMSIS-CORE 4.30.0
        - CMSIS-DAP 1.1.0 (unchanged)
        - CMSIS-Driver 2.04.0
        - CMSIS-DSP 1.4.7
        - CMSIS-PACK 1.4.1
        - CMSIS-RTOS RTX 4.80.0
        - CMSIS-SVD 1.3.1 
      </td>
    </tr>
    <tr>
      <td>4.4.0</td>
      <td>
        Feature release adding CMSIS-DAP (see extended End User Licence Agreement) and CMSIS-Driver for CAN.
        See component's revision history for more details.
        - CMSIS-CORE 4.20.0
        - CMSIS-DAP 1.1.0
        - CMSIS-Driver 2.03.0
        - CMSIS-DSP 1.4.5  (unchanged)
        - CMSIS-RTOS RTX 4.79.0
        - CMSIS-PACK 1.4.0
        - CMSIS-SVD 1.3.0
      </td>
    </tr>
    <tr>
      <td>4.3.0</td>
      <td>
        Maintenance release adding SAI CMSIS-Driver and fixing defects. See component's revision history for more details.
        - CMSIS-CORE 4.10.0
        - CMSIS-Driver 2.02.0
        - CMSIS-DSP 1.4.5
        - CMSIS-RTOS RTX 4.78.0
        - CMSIS-PACK 1.3.3
        - CMSIS-SVD (unchanged)
      </td>
    </tr>
    <tr>
      <td>4.2</td>
      <td>Introducing processor support for Cortex-M7.
      </td>
    </tr>
    <tr>
      <td>4.1</td>
      <td>Enhancements in CMSIS-Pack and CMSIS-Driver.\n
      Added: PackChk validation utility\n
      Removed support for GNU: Sourcery G++ Lite Edition for ARM</td>
    </tr>
    <tr>
      <td>4.0</td>
      <td>First release in CMSIS-Pack format.\n Added specifications for CMSIS-Pack, CMSIS-Driver</td>
    </tr>
    <tr>
      <td>3.30</td>
      <td>Maintenance release with enhancements in each component</td>
    </tr>
    <tr>
      <td>3.20</td>
      <td>Maintenance release with enhancements in each component</td>
    </tr>
    <tr>
      <td>3.01</td>
      <td>Added support for Cortex-M0+ processors</td>
    </tr>
    <tr>
      <td>3.00</td>
      <td>Added support for SC000 and SC300 processors\n
      Added support for GNU GCC Compiler\n
      Added CMSIS-RTOS API</td>
    </tr>
    <tr>
      <td>2.10</td>
      <td>Added CMSIS-DSP Library</td>
    </tr>
    <tr>
      <td>2.0</td>
      <td>Added support for Cortex-M4 processor</td>
    </tr>
    <tr>
      <td>1.30</td>
      <td>Reworked CMSIS startup concept</td>
    </tr>
    <tr>
      <td>1.01</td>
      <td>Added support for Cortex-M0 processor</td>
    </tr>
    <tr>
      <td>1.00</td>
      <td>Initial release of CMSIS-CORE for Cortex-M3 processor</td>
    </tr>
</table>

*/