diff options
| author | rihab kouki <rihab.kouki@st.com> | 2020-07-28 11:24:49 +0100 |
|---|---|---|
| committer | rihab kouki <rihab.kouki@st.com> | 2020-07-28 11:24:49 +0100 |
| commit | 96d6da4e252b06dcfdc041e7df23e86161c33007 (patch) | |
| tree | a262f59bb1db7ec7819acae435f5049cbe5e2354 /docs/Pack | |
| parent | 9f95ff5b6ba01db09552b84a0ab79607060a2666 (diff) | |
| download | st-cmsis-core-lowfat-master.tar.gz st-cmsis-core-lowfat-master.tar.bz2 st-cmsis-core-lowfat-master.zip | |
Diffstat (limited to 'docs/Pack')
69 files changed, 966 insertions, 1423 deletions
diff --git a/docs/Pack/html/DebugConnect.png b/docs/Pack/html/DebugConnect.png Binary files differindex 656edd3..a4f8645 100644 --- a/docs/Pack/html/DebugConnect.png +++ b/docs/Pack/html/DebugConnect.png diff --git a/docs/Pack/html/algorithmFunc.html b/docs/Pack/html/algorithmFunc.html index 5a23864..0f4d486 100644 --- a/docs/Pack/html/algorithmFunc.html +++ b/docs/Pack/html/algorithmFunc.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -314,10 +314,11 @@ ProgramPage</h1> <li>1 on failure.</li> </ul> </dd></dl> -<p>The function <b>ProgramPage</b> is used to write code into the Flash memory. It is invoked whenever an attempt is made to download a program to Flash.</p> -<p>The argument <em>adr</em> specifies the start address of the page that is to be programmed.</p> -<p>The argument <em>sz</em> specifies the size of the page that is to be programmed.</p> -<p>The argument <em>buf</em> points to the buffer containing the data to be programmed.</p> +<p>The function <b>ProgramPage</b> is used to write code into the Flash memory. It is invoked to download a program to Flash. As Flash memory is typically organized in blocks or pages, the parameters to the function <b>ProgramPage</b> must not cross alignment boundaries of these flash pages. The page size is specified in the struct FlashDevice with the value <b>Program Page Size</b>.</p> +<p>The argument <em>adr</em> specifies the start address of the page that is to be programmed. It is aligned by the host programming system to a start address of a flash page.</p> +<p>The argument <em>sz</em> specifies the data size in the data buffer. The host programming system ensures that page boundaries are not crossed.</p> +<p>The argument <em>buf</em> points to the data buffer containing the data to be programmed.</p> +<dl class="section note"><dt>Note</dt><dd>The host programming system ensures that the argument <em>adr</em> + <em>sz</em> never crosses any page boundary. The function <b>ProgramPage</b> does therefore not require any provisions for that.</dd></dl> <p><b>Code Example</b> </p> <div class="fragment"><div class="line"><span class="keywordtype">int</span> ProgramPage (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> adr, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> sz, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buf) {</div> <div class="line"> </div> @@ -426,7 +427,7 @@ Verify</h1> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="flashAlgorithm.html">Flash Programming</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/api.png b/docs/Pack/html/api.png Binary files differnew file mode 100644 index 0000000..6264ebc --- /dev/null +++ b/docs/Pack/html/api.png diff --git a/docs/Pack/html/cmsis.css b/docs/Pack/html/cmsis.css index bba1010..586d4d2 100644 --- a/docs/Pack/html/cmsis.css +++ b/docs/Pack/html/cmsis.css @@ -1148,7 +1148,7 @@ dl.section dd { .image { - text-align: center; + text-align: left; } .dotgraph diff --git a/docs/Pack/html/conditions.png b/docs/Pack/html/conditions.png Binary files differnew file mode 100644 index 0000000..fd4d698 --- /dev/null +++ b/docs/Pack/html/conditions.png diff --git a/docs/Pack/html/configWizard.html b/docs/Pack/html/configWizard.html index 7352e6c..c0d6664 100644 --- a/docs/Pack/html/configWizard.html +++ b/docs/Pack/html/configWizard.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -459,7 +459,7 @@ Configuration Wizard Display</div></div> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/coresight_setup.html b/docs/Pack/html/coresight_setup.html index f1a8733..8716086 100644 --- a/docs/Pack/html/coresight_setup.html +++ b/docs/Pack/html/coresight_setup.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -120,7 +120,7 @@ $(document).ready(function(){initNavTree('coresight_setup.html','');}); <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:01 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/cp_Editors.html b/docs/Pack/html/cp_Editors.html index eb62eb2..9426c06 100644 --- a/docs/Pack/html/cp_Editors.html +++ b/docs/Pack/html/cp_Editors.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -122,7 +122,7 @@ $(document).ready(function(){initNavTree('cp_Editors.html','');}); <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="createPackUtil.html">Utilities for Creating Packs</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/cp_Packs.html b/docs/Pack/html/cp_Packs.html index d730a8f..30ab87c 100644 --- a/docs/Pack/html/cp_Packs.html +++ b/docs/Pack/html/cp_Packs.html @@ -3,8 +3,8 @@ <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> -<title>Software Packs Overview</title> -<title>CMSIS-Pack: Software Packs Overview</title> +<title>Overview</title> +<title>CMSIS-Pack: Overview</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="cmsis.css" rel="stylesheet" type="text/css" /> <script type="text/javascript" src="jquery.js"></script> @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -107,10 +107,10 @@ $(document).ready(function(){initNavTree('cp_Packs.html','');}); <div class="header"> <div class="headertitle"> -<div class="title">Software Packs Overview </div> </div> +<div class="title">Overview </div> </div> </div><!--header--> <div class="contents"> -<div class="textblock"><p>The <b>CMSIS-Pack</b> format is used to deliver a Software Pack and is aimed to be scalable for future requirements. It provides a management process and supports a tool independent distribution for:</p> +<div class="textblock"><p>The <b>CMSIS-Pack</b> format is used to deliver a software package and is aimed to be scalable for future requirements. It provides a management process and supports a tool independent distribution for:</p> <ul> <li><a class="el" href="createPack_DFP.html">Device Support</a> for tool chains and software applications to target a specific device:<ul> <li>Information about the processor and it's features.</li> @@ -141,6 +141,171 @@ $(document).ready(function(){initNavTree('cp_Packs.html','');}); </li> <li><a class="el" href="cp_SWComponents.html#cp_CodeTemplates">User Code Templates</a> help to understand the basic concepts of a software component better and to give the user a good starting point for implementing his application.</li> </ul> +<h1><a class="anchor" id="cp_Components"></a> +Software Components</h1> +<p>A software component encapsulates a set of related functions. Software components can contain C/C++ source files, object code, assembler files, header files, or libraries. The interfaces of software components should be defined with <a class="el" href="cp_SWComponents.html#cp_API">API</a>headers" to make them substitutable by other compatible components at design time. In addition, CMSIS software components should contain documentation for the software component. They may provide user code templates that give a starting point for the application developer, and can have optional debug view descriptions for debuggers.</p> +<p>CMSIS software components can also refer to multiple interfaces of other software components. This could be also a hardware abstraction layer for a device peripheral.</p> +<p>Configuration files contain application specific parameters for a software component. These files are typically copied to the user project workspace; all other files are not modified by the user and can remain in a separate location which avoids that a project workspace is polluted by many source files that should be considered as “black-box” elements by the application programmer.</p> +<div class="image"> +<img src="software_component.png" alt="software_component.png"/> +</div> +<p><a class="anchor" id="cp_CompDetails"></a></p> +<h2>Technical Details </h2> +<p>A component lists the files that belong to it and that are relevant for a project. The component itself or each individual file may refer to a <a class="el" href="pdsc_conditions_pg.html#element_condition">condition</a> that must resolve to true; if it is false, the component or file is not applicable in the given context.</p> +<p>Each software component must have the following attributes that are used to identify the component:</p> +<ul> +<li>Component Class (<code>Cclass</code>): A component class which is a top-level component name, for example <b>CMSIS</b>, <b>Device</b>, <b>File</b> <b>System</b> </li> +<li>Component Group (<code>Cgroup</code>): A component group name, for example <b>CMSIS:RTOS</b>, <b>Device:Startup</b>, <b>File</b> <b>System:CORE</b> </li> +<li>Component Version (<code>Cversion</code>): the version number of the software component.</li> +</ul> +<p>Optionally, a software component may have additional attributes:</p> +<ul> +<li>Component Sub-Group (<code>Csub</code>): A component sub-group that is used when multiple compatible implementations of a component are be available. For example <b>CMSIS:RTOS:MyRTOS</b>, <b>Device:Driver</b> <b>USBD:Full-speed</b> </li> +<li>Component Variant (<code>Cvariant</code>): A variant of the software component is typically used when the same implementation has multiple top-level configurations, like debug and release.</li> +<li>Component Vendor (<code>Cvendor</code>): the supplier of the software component.</li> +<li>Cbundle: allows to combine multiple software components into a software bundle. For example if a network stack is used, all interfaces must match to that component.</li> +<li>Instances: allow to deploy multiple instances of a software component. Each instance can have a separate configuration file.</li> +</ul> +<p>The <code>Cclass</code>, <code>Cgroup</code>, <code>Csub</code>, <code>Cvariant</code> and <code>Cversion</code> attributes are used together with the vendor specified by the pack to identify a component. A component vendor must ensure that the combination <code>Cclass</code>, <code>Cgroup</code>, <code>Csub</code> and <code>Cversion</code> is unique and not used by multiple components within the same Pack. Advertise a set of attributes to be used by other software components using the <a class="el" href="element_taxonomy.html">/package/taxonomy element</a>.</p> +<p>For a list of established Cclasses, refer to <a class="el" href="cp_Packs.html#pack_Cclass">Software Component Cclasses</a>.</p> +<p>In case multiple interdependent components (belonging to the same <code>Cclass</code>) form part of a solution, these can be grouped in a so called <a class="el" href="cp_SWComponents.html#cp_Bundles">bundle</a>.</p> +<p>Use the following syntax to reference to software components and APIs:<br/> +<b><Vendor>::<Cclass>:<Cgroup>:<Csub></b></p> +<p><b>Examples:</b> </p> +<ul> +<li><b>::CMSIS:RTOS (API)</b> - the CMSIS-RTOS API.</li> +<li><b>ARM::CMSIS:DSP</b> - the CMSIS-DSP Library.</li> +<li><b>::File System:Drive:NOR</b> - the NOR Flash Drive of a file system.</li> +</ul> +<p>Here is an example for the display of software components in a development tool:</p> +<div class="image"> +<img src="ComponentDisplay.png" alt="ComponentDisplay.png"/> +<div class="caption"> +Display of a software component in development tools</div></div> + <h2>Software Component Files </h2> +<p>Each software component consists of a certain number of files. Each file has at least the following attributes:</p> +<ul> +<li><code>name:</code> File path, file name, and file extension in the format path/name.extension. The file path is relative to the root directory of the Pack.</li> +<li><code>category:</code> Defines the purpose of the file. Select the predefined value as listed in the table <a class="el" href="pdsc_components_pg.html#FileCategoryEnum">File Categories</a>.</li> +</ul> +<p>Optionally, every file may have the following attributes:</p> +<ul> +<li><code>attr:</code> Defines the special use and handling of a file. Select a predefined value as defined in the table <a class="el" href="pdsc_components_pg.html#FileAttributeEnum">File Attributes</a>.</li> +<li><code>condition:</code> Enter the identifier (attribute <em><b>id</b></em>) of a <a class="el" href="pdsc_conditions_pg.html#element_condition">condition</a>. The element is used if the condition resolves to <span class="XML-Token">true</span>.</li> +<li><code>select:</code> Brief description and purpose of the file. The <b><em>select</em></b> attribute is <b>required</b> when <b><em>attr</em></b> is set to <span class="XML-Token">template</span> or <span class="XML-Token">interface</span>. When multiple template files of a component have the same <b><em>select</em></b> string, they are treated as a single selectable template. This way, multiple template or interface files can be bundled.</li> +<li><code>src:</code> Path information. The path is specified relative to the Pack Description File (PDSC).</li> +<li><code>version:</code> File-specific version information. This is used particularly for files copied into the project workspace. Before a file gets copied, a version check avoids unnecessary copy actions. If a file does not have a version, then the component version is used.</li> +</ul> +<h1><a class="anchor" id="cp_Cond"></a> +References to other software components</h1> +<p>Software components can reference other software components (either within the same pack or in other packs) using conditions:</p> +<div class="image"> +<img src="conditions.png" alt="conditions.png"/> +</div> +<p>A condition describes dependencies on:</p> +<ul> +<li>a specific device</li> +<li>a certain processor</li> +<li>tool attributes</li> +<li>the presence of other components (pcak internal or external)</li> +</ul> +<p>Conditions can be used to ensure that specific software components are either present in the system or can prevent that illegal combinations of software components are chosen by the user.</p> +<p>Conditions are used to define <b>AND/OR</b> rules that make components conditional and therefore only available under certain circumstances, for example for specific devices or processors. Conditions are also used to express dependencies between software components.</p> +<p>Each condition has an <b>id</b> that is unique within the scope of a the PDSC file. An id can be referenced in the <code>condition</code> attribute of components, APIs, examples, files and other conditions. All attributes set in a <b>accept</b>, <b>require</b>, or <b>deny</b> element must resolve to true for the element to become true. A condition becomes true when:</p> +<ul> +<li>At least one <b>accept</b> element is true, <em>AND</em> </li> +<li>all <b>require</b> elements are true, <em>AND</em> </li> +<li>no <b>deny</b> element is true.</li> +</ul> +<p>If a condition resolves to false during processing, the respective element will be ignored.</p> +<h1><a class="anchor" id="cp_Requirements"></a> +Requirements</h1> +<p>Packs can require other packs to be available (and can even ask for a specific version of a pack):</p> +<div class="image"> +<img src="requirements.png" alt="requirements.png"/> +</div> +<p>There are three different requirement types:</p> +<ul> +<li>The <code>packages</code> section lists CMSIS Packs that have been used to configure the project. This includes the specification of a version range to ensure compatibility. If no version is provided, the latest installed version is used. If not yet installed, the latest available version will be installed before resolving the configuration.</li> +<li>The <code>compilers</code> section specifies the toolchains that are supported by this example. The required compiler version is specified using the version element. If no compiler is specified, it is assumed that any toolchain will work.</li> +<li>The <code>languages</code> section allows to specify requirements regarding the programming language, for example C99 standard. If no language requirements are set, ANSI C is assumed.</li> +</ul> +<h1><a class="anchor" id="cp_APIDef"></a> +Central API definition</h1> +<p>The CMSIS-Pack system allows a central API definition that shares header file information and documentation of an <a class="el" href="pdsc_apis_pg.html#element_api">API interface</a>.</p> +<div class="image"> +<img src="api.png" alt="api.png"/> +</div> +<p>This single API interface definition ensures consistency when it is used across multiple implementations that consume the interface. The API interface definition can be distributed separately or as part of the software component that consumes this interface.</p> +<p>An example is the <b>CMSIS-Driver</b> pack that contains various hardware interface drivers that all compatible with the CMSIS-Driver APIs (that are published in the CMSIS Pack).</p> +<h1><a class="anchor" id="cp_RTECompH"></a> +Inventory header file: RTE_Components.h</h1> +<p>Frequently, the behavior or features of a software component depend on the presence of other software components in the application. For example, a network stack can interface to Ethernet or serial PPP (UART). Depending on the presence of interface components, the implementation may behave differently.</p> +<p>To simplify application configuration, the file <b>RTE_Components.h</b> is generated before the project build step. It contains the inventory of all selected components. For each selected software component, it contains #define statements that are specified by the component meta data. The following example shows an RTE_Components.h file:</p> +<div class="fragment"><div class="line"><span class="comment">/* </span></div> +<div class="line"><span class="comment"> Auto generated Run-Time-Environment Component Configuration File </span></div> +<div class="line"><span class="comment"> * Do not modify ! *** </span></div> +<div class="line"><span class="comment"> */</span> </div> +<div class="line"></div> +<div class="line"><span class="preprocessor">#ifndef RTE_COMPONENTS_H </span></div> +<div class="line"><span class="preprocessor"></span><span class="preprocessor">#define RTE_COMPONENTS_H </span></div> +<div class="line"><span class="preprocessor"></span></div> +<div class="line"><span class="comment">/* </span></div> +<div class="line"><span class="comment"> Define the Device Header File: </span></div> +<div class="line"><span class="comment"> */</span> </div> +<div class="line"></div> +<div class="line"><span class="preprocessor">#define CMSIS_device_header "stm32f10x.h" </span></div> +<div class="line"><span class="preprocessor"></span></div> +<div class="line"><span class="preprocessor">#define RTE_Network_Interface_ETH_0 </span><span class="comment">/* Network Interface ETH 0 */</span><span class="preprocessor"> </span></div> +<div class="line"><span class="preprocessor"></span><span class="preprocessor">#define RTE_Network_Socket_BSD </span><span class="comment">/* Network Socket BSD */</span><span class="preprocessor"> </span></div> +<div class="line"><span class="preprocessor"></span><span class="preprocessor">#define RTE_Network_Socket_TCP </span><span class="comment">/* Network Socket TCP */</span><span class="preprocessor"> </span></div> +<div class="line"><span class="preprocessor"></span><span class="preprocessor">#define RTE_Network_Socket_UDP </span><span class="comment">/* Network Socket UDP */</span><span class="preprocessor"> </span></div> +<div class="line"><span class="preprocessor"></span></div> +<div class="line"><span class="preprocessor">#endif </span><span class="comment">/* RTE_COMPONENTS_H */</span><span class="preprocessor"></span></div> +</div><!-- fragment --><p>Use this information in other header files to control features that depend on the inclusion to other software components. For example:</p> +<div class="fragment"><div class="line"><span class="preprocessor">#include "RTE_Components.h"</span> </div> +<div class="line"><span class="preprocessor">#ifdef RTE_Network_Interface_ETH_0 // if component is included </span></div> +<div class="line"><span class="preprocessor"></span><span class="preprocessor">#include "Net_Config_ETH_0.h"</span> <span class="comment">// add related configuration file </span></div> +<div class="line"><span class="preprocessor">#endif</span></div> +</div><!-- fragment --><h1><a class="anchor" id="cp_Combine"></a> +Combining software components</h1> +<p>When using software components, you can use the conditions to automatically resolve dependencies on other components. Use this to combine components for a project in a certain way, while combining them differently for another project. In the following example, a network stack transfers data via Ethernet. The network stack requires a MAC and PHY to do this. The selected device from silicon vendor A that contains an on-chip MAC, thus only requiring a PHY to be selected:</p> +<div class="image"> +<img src="internal_mac_example.png" alt="internal_mac_example.png"/> +<div class="caption"> +Example with internal MAC</div></div> +<p> You can copy the project, select a different device from silicon vendor B for example and let the run-time environment manager do the exchange of the components. As the new devices do not have an on-chip MAC, you need to select a different component to fulfill the requirement for the network stack:</p> +<div class="image"> +<img src="external_mac_example.png" alt="external_mac_example.png"/> +<div class="caption"> +Example with external MAC and PHY</div></div> +<p> This reduces the development time drastically, as the developer does not need to care for the correct dependency between software components, but can concentrate on the implementation of his own application code.</p> +<h1><a class="anchor" id="cp_PackSteps"></a> +Steps to Create a Pack</h1> +<p>The following image shows the basic steps that are required to create a Software Pack:</p> +<div class="image"> +<img src="PackCreateSteps.png" alt="PackCreateSteps.png"/> +</div> +<ol type="1"> +<li><b>Produce input:</b> Create the files that will be delivered with the Pack.</li> +<li><b>Organize files:</b> Use directories to separate the content of the Pack.</li> +<li><b>Create PDSC file:</b> The XML based PDSC file can be created using any text editor. Editors that can validate XML code against a schema file help to find bugs early in the Pack development stage.</li> +<li><b>Generate Pack:</b> Any compression tool supporting the ZIP format can be used to create a Pack file. <a class="el" href="packChk.html">packChk.exe</a> is helpful for the validation of the contents of a Pack.</li> +</ol> +<p>The following pages will show how to create a Software Pack from scratch. The page <a class="el" href="cp_SWComponents.html">Pack with Software Components</a> will start with a simple Pack containing only the PDSC file and a single software component and will then explain further elements of a Pack in more detail. The page <a class="el" href="createPack_DFP.html">Pack with Device Support</a> adds information on the additional requirements that a DFP has, while <a class="el" href="createPackBoard.html">Pack with Board Support</a> will elaborate on the content specific to a BSP.</p> +<h1><a class="anchor" id="PackTutorials"></a> +Pack Tutorial</h1> +<p>The <b>ARM::CMSIS</b> Pack contains tutorials that are explained on the following pages. In the <b>\CMSIS\Pack\Tutorials</b> directory the following three ZIP files are available: </p> +<table class="doxtable"> +<tr> +<th>ZIP File </th><th>Documentation </th></tr> +<tr> +<td>Pack_with_Software_Components.zip </td><td><a class="el" href="cp_SWComponents.html">Pack with Software Components</a> </td></tr> +<tr> +<td>Pack_with_Device_Support.zip </td><td><a class="el" href="createPack_DFP.html">Pack with Device Support</a> </td></tr> +<tr> +<td>Pack_with_Board_Support.zip </td><td><a class="el" href="createPackBoard.html">Pack with Board Support</a> </td></tr> +</table> <h1><a class="anchor" id="PackFilenames"></a> Pack Conventions</h1> <p>A <a class="el" href="cp_SWComponents.html">Software Pack</a> is a collection of files located in directories that are archived in a file with the extension *.pack using the standard <a href="http://en.wikipedia.org/wiki/Zip_%28file_format%29" target="_blank">ZIP file format</a>. The Pack Description file (PDSC) with the file extension *.pdsc contains the <a class="el" href="packFormat.html">meta information</a>, describing the content of a pack based on <a href="https://en.wikipedia.org/wiki/XML" target="_blank">XML</a>. The PDSC file must be:</p> @@ -161,7 +326,7 @@ Pack File Name</h2> <p>Where:</p> <ul> <li><b><vendor></b> is the name of the supplier or vendor of the <a class="el" href="cp_SWComponents.html">Software Pack</a>.</li> -<li><b><name></b> is the name of the <a class="el" href="cp_SWComponents.html">Software Pack</a>. All packs that are published by a vendor must have a unique packname.</li> +<li><b><name></b> is the name of the <a class="el" href="cp_SWComponents.html">Software Pack</a>. All packs that are published by a vendor must have a unique pack name.</li> <li><b><release version="X.Y.Z"></b>specifies the <a class="el" href="pdsc_package_pg.html#VersionType">version number</a> of the release for the <a class="el" href="cp_SWComponents.html">Software Pack</a>.</li> <li><b>.pack</b> is the file extension identifying a <a class="el" href="cp_SWComponents.html">Software Pack</a>.</li> </ul> @@ -174,57 +339,55 @@ Pack File Name</h2> <h2><a class="anchor" id="pack_Cclass"></a> Software Component Cclasses</h2> <p>If you add a software component in the PDSC file, you have to specify a component class (CClass), component group (Cgroup), and the component's version number (Cversion). For more information refer to <a class="el" href="cp_SWComponents.html#cp_Components">Software Components</a>.</p> -<p>If applicable, try to map the <b>Cclass</b> of your software component to one of the following predefined or already well established classes:</p> -<ul> -<li>Board Support: Generic interfaces for evaluation and development boards</li> -<li>CMSIS: <em>Cortex Microcontroller Software Interface Standard</em> components</li> -<li>CMSIS Driver: Unified device drivers compliant to the CMSIS-Driver specification</li> -<li>Compiler: Arm Compiler software extensions</li> -<li>Data Exchange: Software components for data exchange</li> -<li>Device: Startup and system setup components</li> -<li>File System*: File drive support and file system</li> -<li>Graphics*: Graphical libraries for user interfaces</li> -<li>Network*: Network stack using Internet protocols</li> -<li>RTOS*: Real-time operating systems</li> -<li>Safety: Components for testing application software against safety standards</li> -<li>Security*: Encryption for secure communication or storage</li> -<li>USB*: Universal Serial Bus stack</li> -<li>Wireless*: Communication stacks such as Bluetooth, WiFi, and ZigBee</li> -</ul> -<p>Classes with a * should always be used together with a <a class="el" href="pdsc_components_pg.html#Component_Bundle">bundle</a> to avoid conflicts with other software components.</p> -<p>If you wish to standardize a new Cclass, please send an inquiry to <a href="#" onclick="location.href='mai'+'lto:'+'cms'+'is'+'@ar'+'m.'+'com'; return false;">cmsis<span style="display: none;">.nosp@m.</span>@arm<span style="display: none;">.nosp@m.</span>.com</a> or raise an issue on the public <a href="https://github.com/ARM-software/CMSIS_5/issues">CMSIS GitHub development repository</a>.</p> -<h1><a class="anchor" id="cp_PackSteps"></a> -Steps to Create a Pack</h1> -<p>The following image shows the basic steps that are required to create a Software Pack:</p> -<div class="image"> -<img src="PackCreateSteps.png" alt="PackCreateSteps.png"/> -</div> -<ol type="1"> -<li><b>Produce input:</b> Create the files that will be delivered with the Pack.</li> -<li><b>Organize files:</b> Use directories to separate the content of the Pack.</li> -<li><b>Create PDSC file:</b> The XML based PDSC file can be created using any text editor. Editors that can validate XML code against a schema file help to find bugs early in the Pack development stage.</li> -<li><b>Generate Pack:</b> Any compression tool supporting the ZIP format can be used to create a Pack file. <a class="el" href="packChk.html">packChk.exe</a> is helpful for the validation of the contents of a Pack.</li> -</ol> -<p>The following pages will show how to create a Software Pack from scratch. The page <a class="el" href="cp_SWComponents.html">Pack with Software Components</a> will start with a simple Pack containing only the PDSC file and a single software component and will then explain further elements of a Pack in more detail. The page <a class="el" href="createPack_DFP.html">Pack with Device Support</a> adds information on the additional requirements that a DFP has, while <a class="el" href="createPackBoard.html">Pack with Board Support</a> will elaborate on the content specific to a BSP.</p> -<h1><a class="anchor" id="PackTutorials"></a> -Pack Tutorial</h1> -<p>The <b>ARM::CMSIS</b> Pack contains tutorials that are explained on the following pages. In the <b>\CMSIS\Pack\Tutorials</b> directory the following three ZIP files are available: </p> +<p>If applicable, try to map the <b>Cclass</b> of your software component to one of the following predefined or already well established classes listed below. These <b>Cclass</b> names are pre-defined in the CMSIS pack using the <a class="el" href="element_taxonomy.html">taxonomy</a> element.</p> <table class="doxtable"> <tr> -<th>ZIP File </th><th>Documentation </th></tr> +<th align="left">Cclass </th><th align="left">Description </th></tr> <tr> -<td>Pack_with_Software_Components.zip </td><td><a class="el" href="cp_SWComponents.html">Pack with Software Components</a> </td></tr> +<td align="left">Audio </td><td align="left">Software components for audio processing </td></tr> <tr> -<td>Pack_with_Device_Support.zip </td><td><a class="el" href="createPack_DFP.html">Pack with Device Support</a> </td></tr> +<td align="left">Board Support </td><td align="left">Generic interfaces for evaluation and development boards </td></tr> <tr> -<td>Pack_with_Board_Support.zip </td><td><a class="el" href="createPackBoard.html">Pack with Board Support</a> </td></tr> +<td align="left">Board Part * </td><td align="left">Drivers that support an external component available on an evaluation board </td></tr> +<tr> +<td align="left">CMSIS </td><td align="left"><em>Cortex Microcontroller Software Interface Standard</em> components </td></tr> +<tr> +<td align="left">CMSIS Driver </td><td align="left">Unified device drivers compliant to the CMSIS-Driver specification </td></tr> +<tr> +<td align="left">Compiler </td><td align="left">Arm Compiler software extensions </td></tr> +<tr> +<td align="left">Data Exchange </td><td align="left">Data exchange components or data formatter, for example JSON </td></tr> +<tr> +<td align="left">Device </td><td align="left">Startup and system setup components </td></tr> +<tr> +<td align="left">Extension Board * </td><td align="left">Drivers that support an extension boards or shield </td></tr> +<tr> +<td align="left">File System* </td><td align="left">File drive support and file system </td></tr> +<tr> +<td align="left">Graphics* </td><td align="left">Graphical libraries for user interfaces </td></tr> +<tr> +<td align="left">IoT Client * </td><td align="left">IoT cloud client connectors </td></tr> +<tr> +<td align="left">IoT Utility * </td><td align="left">IoT specific utilities, i.e. a socket interface </td></tr> +<tr> +<td align="left">Network* </td><td align="left">Network stack using Internet protocols </td></tr> +<tr> +<td align="left">RTOS* </td><td align="left">Real-time operating systems </td></tr> +<tr> +<td align="left">Security* </td><td align="left">Encryption for secure communication or storage </td></tr> +<tr> +<td align="left">USB* </td><td align="left">Universal Serial Bus stack </td></tr> +<tr> +<td align="left">Utility </td><td align="left">Generic software utility components </td></tr> </table> +<p>Classes with a * should always be used together with a <a class="el" href="pdsc_components_pg.html#Component_Bundle">bundle</a> to avoid conflicts with other software components.</p> +<p>If you wish to standardize a new Cclass, please send an inquiry to <a href="#" onclick="location.href='mai'+'lto:'+'cms'+'is'+'@ar'+'m.'+'com'; return false;">cmsis<span style="display: none;">.nosp@m.</span>@arm<span style="display: none;">.nosp@m.</span>.com</a> or raise an issue on the public <a href="https://github.com/ARM-software/CMSIS_5/issues">CMSIS GitHub development repository</a>. </p> </div></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/cp_SWComponents.html b/docs/Pack/html/cp_SWComponents.html index 0783053..5cf2a0a 100644 --- a/docs/Pack/html/cp_SWComponents.html +++ b/docs/Pack/html/cp_SWComponents.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -526,7 +526,7 @@ Display of example projects in development tools</div></div> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/cp_ZIPTool.html b/docs/Pack/html/cp_ZIPTool.html index ea57c45..243fc1f 100644 --- a/docs/Pack/html/cp_ZIPTool.html +++ b/docs/Pack/html/cp_ZIPTool.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -118,7 +118,7 @@ $(document).ready(function(){initNavTree('cp_ZIPTool.html','');}); <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="createPackUtil.html">Utilities for Creating Packs</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/cpdsc_pg.html b/docs/Pack/html/cpdsc_pg.html index d650397..46abb8f 100644 --- a/docs/Pack/html/cpdsc_pg.html +++ b/docs/Pack/html/cpdsc_pg.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -741,7 +741,7 @@ CPDSC top level structure</h1> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:01 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/createPackBoard.html b/docs/Pack/html/createPackBoard.html index c3532ae..33aa415 100644 --- a/docs/Pack/html/createPackBoard.html +++ b/docs/Pack/html/createPackBoard.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -244,7 +244,7 @@ BSP bundle display in development tools</div></div> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/createPackPublish.html b/docs/Pack/html/createPackPublish.html index 4a5207a..466f7fb 100644 --- a/docs/Pack/html/createPackPublish.html +++ b/docs/Pack/html/createPackPublish.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -111,6 +111,22 @@ $(document).ready(function(){initNavTree('createPackPublish.html','');}); </div><!--header--> <div class="contents"> <div class="textblock"><p>There are multiple ways to distribute a software pack:</p> +<h1><a class="anchor" id="cp_prerequisites"></a> +Prerequisites</h1> +<p>Before you start to distribute a software pack, you need to make sure that it does not contain errors. An error- and warning-free run of the <code>gen_pack.bat</code> script from the <a class="el" href="cp_Packs.html#PackTutorials">Pack Tutorial</a> is a good start. but you also need to make sure that the schema has been validated. Pack Installer provides an easy mechanism to check the XML schema:</p> +<ul> +<li>Install the pack using Pack Installer.</li> +<li>Right-click on the pack version number and select <b>Schema Check</b>: <br/> + <div class="image"> +<img src="schema_check.png" alt="schema_check.png"/> +</div> +</li> +<li>The <b>Output</b> window shows the result. If errors are reported, please make sure to fix them before continuing.<br/> + <div class="image"> +<img src="schema_check_output.png" alt="schema_check_output.png"/> +</div> + This is especially important when handing in the pack to be indexed by <a class="el" href="createPackPublish.html#cp_KeilComPack">Arm's pack index service</a>. The pack importer will ignore all PDSC files that do not pass the check against the most recently published PACK.xsd schema file and thus your pack will not be available for download.</li> +</ul> <h1><a class="anchor" id="cp_LocalInstallation"></a> Local Installation</h1> <p>The easiest way to distribute a software pack is attaching it to an email or using other means of electronic distribution (for example using a company internal file server). The installation of a software pack is usually triggered by double-clicking the Pack file. The pack management tool is invoked and the Pack is installed on the local machine. After installation, the Pack will be shown in the list of installed packs (tool dependent). If the PDSC file does not contain a valid <code><url></code> element, a manual installation is required to update a software pack. Otherwise, pack management tools can check for updates on the server or the local machine that is specified by <code><url></code>.</p> @@ -145,8 +161,8 @@ Web installation and update</div></div> </ul> </dd></dl> <h1><a class="anchor" id="cp_KeilComPack"></a> -Publishing on www.keil.com/pack</h1> -<p>Arm maintains a list of available software packs. If you wish to add your packs to that list, send either your vendor.pidx file or your PDSC file to the following email address: <a href="#" onclick="location.href='mai'+'lto:'+'CMS'+'IS'+'@ar'+'m.'+'com'; return false;">CMSIS@arm.com</a>. The PIDX file will be processed and all referenced PDSC files will be validated. The following content will be processed in order to generate the web site (<a href="http://www.keil.com/dd2/pack">www.keil.com/dd2/pack</a>) and index file (<a href="http://www.keil.com/pack/index.pidx">www.keil.com/pack/index.pidx</a>):</p> +Publishing using Arm's Pack Index Service</h1> +<p>Arm maintains a list of available software packs. If you wish to add your packs to that list, send either your vendor.pidx file or your PDSC file to the following email address: <a href="#" onclick="location.href='mai'+'lto:'+'CMS'+'IS'+'@ar'+'m.'+'com'; return false;">CMSIS@arm.com</a>. The PIDX file will be processed and all referenced PDSC files will be validated. The following content will be processed in order to generate the web site (<a href="https://developer.arm.com/embedded/cmsis/cmsis-packs">https://developer.arm.com/embedded/cmsis/cmsis-packs</a>):</p> <ul> <li>Version</li> <li>Release Notes</li> @@ -180,7 +196,7 @@ Moving a pack from one URL to another</h1> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/createPackUtil.html b/docs/Pack/html/createPackUtil.html index 4dde94c..0ce756c 100644 --- a/docs/Pack/html/createPackUtil.html +++ b/docs/Pack/html/createPackUtil.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -122,7 +122,7 @@ $(document).ready(function(){initNavTree('createPackUtil.html','');}); <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/createPack_DFP.html b/docs/Pack/html/createPack_DFP.html index eea9e37..4e0a87c 100644 --- a/docs/Pack/html/createPack_DFP.html +++ b/docs/Pack/html/createPack_DFP.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -524,7 +524,7 @@ Finally, save the PDSC file and regenerate the Pack file using the <a class="el" <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/debug_description.html b/docs/Pack/html/debug_description.html index 7085c9a..0f584a7 100644 --- a/docs/Pack/html/debug_description.html +++ b/docs/Pack/html/debug_description.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -729,9 +729,9 @@ Writing debug access sequences</h1> <p>To override a default sequence or to create a custom (default) sequence, you need to write <a class="el" href="pdsc_family_pg.html#element_sequence">sequence</a> elements. The following sections show how to use the built-in debug access syntax, expressions, and debug access functions to create custom sequences.</p> <h2><a class="anchor" id="DebugSyntaxRules"></a> Debug access syntax rules</h2> -<p>Debug accesses are described in <b>block</b> elements of a debug access sequence (<b>sequence</b> element). The following syntax is used for this purpose:</p> +<p>Debug accesses are described in <b>block</b> elements (within a debug access <b>sequence</b> or <b>control</b> element). The following syntax is used for this purpose:</p> <ul> -<li>The contents of a <b>block</b> element is a series of statements.</li> +<li>One or more statements have to be encapsulated in a <b>block</b> element.</li> <li>Each statement must begin in a new line and is terminated by a <span class="XML-Token">;</span> character.</li> <li>A typical statement consists of variable, followed by a <span class="XML-Token">=</span> character and an expression, where the <span class="XML-Token">=</span> character is an assignment of the <a class="el" href="debug_description.html#ExpressionType">expression</a> result to the variable: <div class="fragment"><div class="line">variable = expression;</div> </div><!-- fragment --></li> @@ -1613,7 +1613,7 @@ Using external tools</h2> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="coresight_setup.html">Debug Setup with CMSIS-Pack</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:01 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/element_dominate.html b/docs/Pack/html/element_dominate.html new file mode 100644 index 0000000..103fb8d --- /dev/null +++ b/docs/Pack/html/element_dominate.html @@ -0,0 +1,152 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<title>/package/dominate element</title> +<title>CMSIS-Pack: /package/dominate element</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="cmsis.css" rel="stylesheet" type="text/css" /> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<script type="text/javascript" src="printComponentTabs.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 46px;"> + <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> + <td style="padding-left: 0.5em;"> + <div id="projectname">CMSIS-Pack +  <span id="projectnumber">Version 1.6.0</span> + </div> + <div id="projectbrief">Delivery Mechanism for Software Packs</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<div id="CMSISnav" class="tabs1"> + <ul class="tablist"> + <script type="text/javascript"> + <!-- + writeComponentTabs.call(this); + //--> + </script> + </ul> +</div> +<!-- Generated by Doxygen 1.8.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and Description</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('element_dominate.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Pages</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="headertitle"> +<div class="title">/package/dominate element </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>The <a class="el" href="element_dominate.html">/package/dominate element</a> specifies that the Pack contains one or more <a class="el" href="pdsc_devices_pg.html#element_devices">device</a>, <a class="el" href="pdsc_apis_pg.html#element_apis">API</a>, or <a class="el" href="pdsc_components_pg.html#element_components">component</a> that overrules other packs that contain identical named <a class="el" href="pdsc_devices_pg.html#element_devices">device</a>, <a class="el" href="pdsc_apis_pg.html#element_apis">API</a>, or <a class="el" href="pdsc_components_pg.html#element_components">component</a>.</p> +<p>This attribute is useful for framing packs that:</p> +<ul> +<li>Contain <em>certified</em> software components which should overrule software components with identical name of other packs.</li> +<li>Contain new device definitions of devices that were previously defined in different packs.</li> +</ul> +<p><b>Example:</b> </p> +<div class="fragment"><div class="line"><package></div> +<div class="line"> ...</div> +<div class="line"> <dominate info=<span class="stringliteral">"CMSIS-Core, RTOS2, RTX5, Event Recorder, C Library certified for Cortex-M3"</span>/></div> +<div class="line"> ...</div> +<div class="line"></package></div> +</div><!-- fragment --><p> </p> +<table class="cmtable" summary="Element: dominate"> +<tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="pdsc_package_pg.html#element_package">package</a> </td><td colspan="3"><a class="el" href="pdsc_package_pg.html#element_package">/package</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>info </td><td>Descriptive text that explains the reason for the overwrite using dominate. </td><td>xs:string </td><td>optional </td></tr> +</table> +<hr/> + </div></div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="packFormat.html">Pack Description (*.pdsc) Format</a></li> + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. + <!-- + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 + --> + </li> + </ul> +</div> +</body> +</html> diff --git a/docs/Pack/html/element_keywords.html b/docs/Pack/html/element_keywords.html index 22c58c3..4f8962e 100644 --- a/docs/Pack/html/element_keywords.html +++ b/docs/Pack/html/element_keywords.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -140,7 +140,7 @@ $(document).ready(function(){initNavTree('element_keywords.html','');}); <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="packFormat.html">Pack Description (*.pdsc) Format</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/element_releases.html b/docs/Pack/html/element_releases.html index 1890844..614818a 100644 --- a/docs/Pack/html/element_releases.html +++ b/docs/Pack/html/element_releases.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -187,7 +187,7 @@ $(document).ready(function(){initNavTree('element_releases.html','');}); <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="packFormat.html">Pack Description (*.pdsc) Format</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/element_repository.html b/docs/Pack/html/element_repository.html index 4e10a26..20ff6e7 100644 --- a/docs/Pack/html/element_repository.html +++ b/docs/Pack/html/element_repository.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -136,7 +136,7 @@ $(document).ready(function(){initNavTree('element_repository.html','');}); <li>Open the URL specified by the <code><repository></code> element in a browser.</li> <li>Create a fork of the repository.</li> <li>Clone the fork on your machine (you may want to checkout the <code>tag</code> specified in the <a class="el" href="element_releases.html"><release></a> element).</li> -<li>Create a branch for you modifications.</li> +<li>Create a branch for your modifications.</li> <li>Develop and test the modifications of your branch and push the branch to GitHub.</li> <li>Create a pull request of your branch into the upstream repository.</li> </ul> @@ -147,7 +147,7 @@ $(document).ready(function(){initNavTree('element_repository.html','');}); <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="packFormat.html">Pack Description (*.pdsc) Format</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/element_requirements_pg.html b/docs/Pack/html/element_requirements_pg.html index 99fbe69..a958a23 100644 --- a/docs/Pack/html/element_requirements_pg.html +++ b/docs/Pack/html/element_requirements_pg.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -250,7 +250,7 @@ $(document).ready(function(){initNavTree('element_requirements_pg.html','');}); <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="packFormat.html">Pack Description (*.pdsc) Format</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/element_taxonomy.html b/docs/Pack/html/element_taxonomy.html index f2b99e2..b450107 100644 --- a/docs/Pack/html/element_taxonomy.html +++ b/docs/Pack/html/element_taxonomy.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -201,25 +201,41 @@ $(document).ready(function(){initNavTree('element_taxonomy.html','');}); <tr> <th>Cclass= </th><th>Description </th></tr> <tr> -<td class="XML-Token">Board Support </td><td>Components providing interfaces for Evaluation and Development Boards </td></tr> +<td class="XML-Token">Audio </td><td>Software components for audio processing </td></tr> +<tr> +<td class="XML-Token">Board Support </td><td>Components providing interfaces for Evaluation and Development Boards </td></tr> +<tr> +<td class="XML-Token">Board Part </td><td>Drivers that support an external component available on an evaluation board </td></tr> +<tr> +<td class="XML-Token">Compiler </td><td>Components implementing compiler specific interfaces (e.g. Retargeting) </td></tr> <tr> <td class="XML-Token">CMSIS </td><td>Components defined by Cortex Microcontroller Software Interface Standard (e.g. <a href="../../Core/html/index.html" class="el">CMSIS-Core(M)</a>, <a href="../../Core_A/html/index.html" class="el">CMSIS-Core(A)</a>, <a href="../../DSP/html/index.html" class="el">CMSIS-DSP</a> and <a href="../../RTOS/html/index.html" class="el">CMSIS-RTOS</a>) </td></tr> <tr> +<td class="XML-Token">CMSIS Driver </td><td>Components implementing unified device drivers compliant to <a href="../../Driver/html/index.html" class="el">CMSIS-Driver</a> (e.g. UART, SPI, USB, etc.) </td></tr> +<tr> <td class="XML-Token">Device </td><td>Components containing device specific implementations of non-standard APIs (e.g. HAL drivers, CMSIS Startup files) </td></tr> <tr> -<td class="XML-Token">CMSIS Driver </td><td>Components implementing unified device drivers compliant to <a href="../../Driver/html/index.html" class="el">CMSIS-Driver</a> (e.g. UART, SPI, USB, etc.) </td></tr> +<td class="XML-Token">Data Exchange </td><td>Components implementing some kind of data exchange or data formatter </td></tr> +<tr> +<td class="XML-Token">Extension Board </td><td>Drivers that support an extension board or shield </td></tr> <tr> <td class="XML-Token">File System </td><td>Components implementing some kind of File Systems (e.g. Flash or RAM based file systems) </td></tr> <tr> <td class="XML-Token">Graphics </td><td>Components implementing some kind of Display and Graphics Software </td></tr> <tr> -<td class="XML-Token">Network </td><td>Components implementing some kind of Network Communications (e.g. TCP/IP Stack) </td></tr> +<td class="XML-Token">IoT Client </td><td>Components implementing some kind of IoT cloud client connector </td></tr> <tr> -<td class="XML-Token">USB </td><td>Components implementing some kind of USB interfaces (e.g. Host and Device interfaces) </td></tr> +<td class="XML-Token">IoT Utility </td><td>IoT specific software utility </td></tr> +<tr> +<td class="XML-Token">Network </td><td>Components implementing some kind of network communications (e.g. TCP/IP Stack) </td></tr> <tr> -<td class="XML-Token">Compiler </td><td>Components implementing Compiler specific interfaces (e.g. Retargeting) </td></tr> +<td class="XML-Token">RTOS </td><td>Components implementing some kind of real-time operating system (e.g. FreeRTOS, Micrium Real Time Kernel) </td></tr> <tr> -<td class="XML-Token">RTOS </td><td>Components implementing some kind of Real-time Operating System (e.g. FreeRTOS, Micrium Real Time Kernel) </td></tr> +<td class="XML-Token">Security </td><td>Components implementing some kind of encryption for secure communication or storage </td></tr> +<tr> +<td class="XML-Token">USB </td><td>Components implementing some kind of USB interfaces (e.g. Host and Device interfaces) </td></tr> +<tr> +<td class="XML-Token">Utility </td><td>Generic software utility components </td></tr> </table> <p> </p> <p><a class="anchor" id="CgroupType"></a><b>Table: Component Groups</b></p> @@ -247,7 +263,11 @@ $(document).ready(function(){initNavTree('element_taxonomy.html','');}); <tr> <td class="XML-Token">DSP </td><td>A component implementing the <a href="../../DSP/html/index.html" class="el">CMSIS-DSP</a> API specification. </td></tr> <tr> +<td class="XML-Token">NN Lib </td><td>A component implementing the <a href="../../NN/html/index.html" class="el">CMSIS-NN</a> API specification. </td></tr> +<tr> <td class="XML-Token">RTOS </td><td>A component implementing the <a href="../../RTOS/html/index.html" class="el">CMSIS-RTOS</a> API specification. </td></tr> +<tr> +<td class="XML-Token">RTOS2 </td><td>A component implementing the <a href="../../RTOS2/html/index.html" class="el">CMSIS-RTOS v2</a> API specification. </td></tr> </table> <p> </p> </div></div><!-- contents --> @@ -256,7 +276,7 @@ $(document).ready(function(){initNavTree('element_taxonomy.html','');}); <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="packFormat.html">Pack Description (*.pdsc) Format</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/external_mac_example.png b/docs/Pack/html/external_mac_example.png Binary files differnew file mode 100644 index 0000000..3cf3c23 --- /dev/null +++ b/docs/Pack/html/external_mac_example.png diff --git a/docs/Pack/html/flashAlgorithm.html b/docs/Pack/html/flashAlgorithm.html index a76a8f8..d454cf6 100644 --- a/docs/Pack/html/flashAlgorithm.html +++ b/docs/Pack/html/flashAlgorithm.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -158,7 +158,9 @@ Creating a new Algorithm</h1> <div class="line">};</div> </div><!-- fragment --></li> </ol> -<dl class="section note"><dt>Note</dt><dd>The <b>Device Name</b> will usually be shown in tools to identify the Flash algorithm. Make sure that this is changed to the correct device name from the DFP.</dd></dl> +<dl class="section note"><dt>Note</dt><dd>The <b>Device Name</b> is usually be shown in tools to identify the Flash algorithm. Make sure that this name reflects the device name.</dd> +<dd> +The <b>Programming Page Size</b> specifies the block size for programming using the function <a class="el" href="algorithmFunc.html#ProgramPage">ProgramPage</a>. For devices with small block sizes it might be better to specify a multiple of the physical block size as this reduces the communication overhead to the target. An optimal block size for fast programming is 1024 bytes, however the system itself does not restrict this size value.</dd></dl> <h1><a class="anchor" id="AddFPA"></a> Adding an Algorithm to a Pack</h1> <p>The generated <b>*.FLM</b> file needs to be added to the <a class="el" href="createPack_DFP.html">Pack with Device Support</a>, so that it is available to the tool user for programming his device. Usually, a directory <b>Flash</b> is created and the algorithm is saved in this directory.</p> @@ -183,7 +185,7 @@ Adding an Algorithm to a Pack</h1> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/index.html b/docs/Pack/html/index.html index 76898c5..f2c4fbe 100644 --- a/docs/Pack/html/index.html +++ b/docs/Pack/html/index.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -117,11 +117,19 @@ $(document).ready(function(){initNavTree('index.html','');}); <li>Device parameters along with startup code and programming algorithms</li> <li>Example projects</li> </ul> -<p>The complete file collection along with the PDSC file is shipped in ZIP-format as a Software Pack. The PDSC file is designed for software development environments and describes the user and device relevant context for the files supplied within such a Software Pack. A Software Pack can be used for multiple purposes (see below).</p> +<p>The complete file collection along with the PDSC file is shipped in ZIP-format (renamed to *.pack). The PDSC file is designed for software development environments and describes the user and device relevant context for the files supplied within such a pack file.</p> +<p>The CMSIS-Pack system solves several problems:</p> +<ul> +<li>It provides meta-data of files that relate to a software component. All files that belong to a software component can be identified and information about the original provider is preserved.</li> +<li>It enables consistent software component upgrade and identifies incompatible configuration files that may be part of the user application.</li> +<li>Software component providers can specify the interfaces and relationship to other software components.</li> +<li>The meta-data of a software component can include dependency information for toolchains, devices, and processors which simplifies the integration into application programs.</li> +</ul> <p>After installing a <a class="el" href="cp_SWComponents.html">Software Pack</a>, all included software components are available to the development tools. <a class="el" href="cp_SWComponents.html#cp_Components">Software components</a> are a collection of source modules, header and configuration files as well as libraries. Packs containing software components can also include <a class="el" href="cp_SWComponents.html#cp_Examples">Example Projects</a> and <a class="el" href="cp_SWComponents.html#cp_CodeTemplates">User Code Templates</a>.</p> <p>The <a class="el" href="pack_revisionHistory.html">Revision History of CMSIS-Pack</a> lists the main changes between versions.</p> <h1><a class="anchor" id="SWPackVariants"></a> Software Pack Use Cases</h1> +<p>A pack can be used for multiple purposes:</p> <div class="image"> <img src="SPVariants_small.png" alt="SPVariants_small.png"/> <div class="caption"> @@ -135,21 +143,21 @@ Software Pack Use Cases</div></div> <li><b>In-house Software Packs:</b> usually contain software components that can be distributed within a company or engineering group.</li> </ul> <dl class="section note"><dt>Note</dt><dd>A Software Pack can address multiple use cases at the same time!</dd></dl> -<p>The following sections give you more details on the basics:</p> +<p>The following sections provide more information:</p> <ul> -<li><a class="el" href="cp_Packs.html">Software Packs Overview</a> explains the steps required for creating a Software Pack in general.</li> -<li><a class="el" href="cp_SWComponents.html">Pack with Software Components</a> gives detailed information on the contents of the PDSC file.</li> -<li><a class="el" href="createPack_DFP.html">Pack with Device Support</a> describes additional requirements of Device Family Packs (DFPs).</li> +<li>In the <a class="el" href="cp_Packs.html">Overview</a>, learn the basics and the required steps for creating a pack.</li> +<li><a class="el" href="cp_SWComponents.html">Pack with Software Components</a> shows how to start a pack from scratch.</li> +<li><a class="el" href="createPack_DFP.html">Pack with Device Support</a> describes how to enable device support in a DFP.</li> <li><a class="el" href="createPackBoard.html">Pack with Board Support</a> covers the creation of Board Support Packs (BSPs).</li> -<li><a class="el" href="pack_Example.html">Pack Example</a> explains the Software Pack example that is part of the CMSIS Pack in more detail.</li> -<li><a class="el" href="createPackPublish.html">Publish a Pack</a> shows the options for publishing a Pack.</li> -<li><a class="el" href="createPackUtil.html">Utilities for Creating Packs</a> caters to programs that are useful during the creation of a Pack.</li> +<li><a class="el" href="pack_Example.html">Pack Example</a> explains the available example pack in more detail.</li> +<li>Learn how to <a class="el" href="createPackPublish.html">Publish a Pack</a>.</li> +<li><a class="el" href="createPackUtil.html">Utilities for Creating Packs</a> are available that are useful during the creation of a pack.</li> <li><a class="el" href="packFormat.html">Pack Description (*.pdsc) Format</a> describes all XML elements that can be used in a PDSC file.</li> <li><a class="el" href="configWizard.html">Configuration Wizard Annotations</a> can be used to create GUI-like elements in development tools for configuration files.</li> -<li><a class="el" href="flashAlgorithm.html">Flash Programming</a> are used to erase or download applications to Flash devices.</li> -<li><a class="el" href="coresight_setup.html">Debug Setup with CMSIS-Pack</a> allow to create tool-agnostic debug and trace configurations</li> +<li><a class="el" href="flashAlgorithm.html">Flash Programming</a> algorithms are used to erase or download applications to Flash devices.</li> +<li><a class="el" href="coresight_setup.html">Debug Setup with CMSIS-Pack</a> allows to create tool-agnostic debug and trace configurations</li> <li><a class="el" href="cpdsc_pg.html">Project Description (*.cpdsc) Format</a> is a environment/tool independent definition of a software project. This helps to create only one set of example projects that can be used by many different tool vendors.</li> -<li><a class="el" href="packIndexFile.html">CMSIS-Pack Index Files</a></li> +<li><a class="el" href="packIndexFile.html">CMSIS-Pack Index Files</a> are used to generate a catalog of available packs.</li> </ul> <hr/> <h2>CMSIS-Pack in ARM::CMSIS Pack </h2> @@ -170,7 +178,7 @@ Software Pack Use Cases</div></div> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:43 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:01 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/internal_mac_example.png b/docs/Pack/html/internal_mac_example.png Binary files differnew file mode 100644 index 0000000..8ffd39e --- /dev/null +++ b/docs/Pack/html/internal_mac_example.png diff --git a/docs/Pack/html/navtree.js b/docs/Pack/html/navtree.js index e7950c2..4c6eae9 100644 --- a/docs/Pack/html/navtree.js +++ b/docs/Pack/html/navtree.js @@ -3,13 +3,19 @@ var NAVTREE = [ "CMSIS-Pack", "index.html", [ [ "Software Pack Use Cases", "index.html#SWPackVariants", null ], [ "Revision History of CMSIS-Pack", "pack_revisionHistory.html", null ], - [ "Software Packs Overview", "cp_Packs.html", [ + [ "Overview", "cp_Packs.html", [ + [ "Software Components", "cp_Packs.html#cp_Components", null ], + [ "References to other software components", "cp_Packs.html#cp_Cond", null ], + [ "Requirements", "cp_Packs.html#cp_Requirements", null ], + [ "Central API definition", "cp_Packs.html#cp_APIDef", null ], + [ "Inventory header file: RTE_Components.h", "cp_Packs.html#cp_RTECompH", null ], + [ "Combining software components", "cp_Packs.html#cp_Combine", null ], + [ "Steps to Create a Pack", "cp_Packs.html#cp_PackSteps", null ], + [ "Pack Tutorial", "cp_Packs.html#PackTutorials", null ], [ "Pack Conventions", "cp_Packs.html#PackFilenames", [ [ "Pack File Name", "cp_Packs.html#pack_filename", null ], [ "Software Component Cclasses", "cp_Packs.html#pack_Cclass", null ] - ] ], - [ "Steps to Create a Pack", "cp_Packs.html#cp_PackSteps", null ], - [ "Pack Tutorial", "cp_Packs.html#PackTutorials", null ] + ] ] ] ], [ "Pack with Software Components", "cp_SWComponents.html", [ [ "Create PDSC File", "cp_SWComponents.html#cp_CreatePDSC", null ], @@ -41,9 +47,10 @@ var NAVTREE = [ "Pack Example", "pack_Example.html", null ], [ "Utilities for Creating Packs", "createPackUtil.html", "createPackUtil" ], [ "Publish a Pack", "createPackPublish.html", [ + [ "Prerequisites", "createPackPublish.html#cp_prerequisites", null ], [ "Local Installation", "createPackPublish.html#cp_LocalInstallation", null ], [ "Web Download", "createPackPublish.html#cp_WebDownload", null ], - [ "Publishing on www.keil.com/pack", "createPackPublish.html#cp_KeilComPack", null ], + [ "Publishing using Arm's Pack Index Service", "createPackPublish.html#cp_KeilComPack", null ], [ "Moving a pack from one URL to another", "createPackPublish.html#cp_PackRehosting", null ] ] ], [ "Pack Description (*.pdsc) Format", "packFormat.html", "packFormat" ], diff --git a/docs/Pack/html/navtreeindex0.js b/docs/Pack/html/navtreeindex0.js index 6b64d6f..cd4b210 100644 --- a/docs/Pack/html/navtreeindex0.js +++ b/docs/Pack/html/navtreeindex0.js @@ -15,11 +15,17 @@ var NAVTREEINDEX0 = "coresight_setup.html":[12], "cp_Editors.html":[7,1], "cp_Packs.html":[2], -"cp_Packs.html#PackFilenames":[2,0], -"cp_Packs.html#PackTutorials":[2,2], -"cp_Packs.html#cp_PackSteps":[2,1], -"cp_Packs.html#pack_Cclass":[2,0,1], -"cp_Packs.html#pack_filename":[2,0,0], +"cp_Packs.html#PackFilenames":[2,8], +"cp_Packs.html#PackTutorials":[2,7], +"cp_Packs.html#cp_APIDef":[2,3], +"cp_Packs.html#cp_Combine":[2,5], +"cp_Packs.html#cp_Components":[2,0], +"cp_Packs.html#cp_Cond":[2,1], +"cp_Packs.html#cp_PackSteps":[2,6], +"cp_Packs.html#cp_RTECompH":[2,4], +"cp_Packs.html#cp_Requirements":[2,2], +"cp_Packs.html#pack_Cclass":[2,8,1], +"cp_Packs.html#pack_filename":[2,8,0], "cp_SWComponents.html":[3], "cp_SWComponents.html#cp_API":[3,8], "cp_SWComponents.html#cp_Bundles":[3,6], @@ -54,10 +60,11 @@ var NAVTREEINDEX0 = "createPackBoard.html#cp_BundleExample":[5,1], "createPackBoard.html#cp_SpecDevBoard":[5,0], "createPackPublish.html":[8], -"createPackPublish.html#cp_KeilComPack":[8,2], -"createPackPublish.html#cp_LocalInstallation":[8,0], -"createPackPublish.html#cp_PackRehosting":[8,3], -"createPackPublish.html#cp_WebDownload":[8,1], +"createPackPublish.html#cp_KeilComPack":[8,3], +"createPackPublish.html#cp_LocalInstallation":[8,1], +"createPackPublish.html#cp_PackRehosting":[8,4], +"createPackPublish.html#cp_WebDownload":[8,2], +"createPackPublish.html#cp_prerequisites":[8,0], "createPackUtil.html":[7], "createPack_DFP.html":[4], "createPack_DFP.html#cp_BasicDFP":[4,0], @@ -96,16 +103,17 @@ var NAVTREEINDEX0 = "debug_description.html#traceStart":[12,0,5,0], "debug_description.html#usage_of_sequences":[12,0,3], "debug_description.html#writing_sequences":[12,0,6], +"element_dominate.html":[9,6], "element_keywords.html":[9,4], -"element_releases.html":[9,6], -"element_releases.html#element_release":[9,6,0], +"element_releases.html":[9,7], +"element_releases.html#element_release":[9,7,0], "element_repository.html":[9,5], -"element_requirements_pg.html":[9,7], -"element_requirements_pg.html#element_compilers":[9,7,1], -"element_requirements_pg.html#element_languages":[9,7,2], -"element_requirements_pg.html#element_packages":[9,7,0], -"element_taxonomy.html":[9,8], -"element_taxonomy.html#element_taxonomyDescription":[9,8,0], +"element_requirements_pg.html":[9,8], +"element_requirements_pg.html#element_compilers":[9,8,1], +"element_requirements_pg.html#element_languages":[9,8,2], +"element_requirements_pg.html#element_packages":[9,8,0], +"element_taxonomy.html":[9,9], +"element_taxonomy.html#element_taxonomyDescription":[9,9,0], "flashAlgorithm.html":[11], "flashAlgorithm.html#AddFPA":[11,1], "flashAlgorithm.html#CreateFPA":[11,0], @@ -124,90 +132,92 @@ var NAVTREEINDEX0 = "pack_Example.html":[6], "pack_revisionHistory.html":[1], "pages.html":[], -"pdsc_apis_pg.html":[9,9], -"pdsc_apis_pg.html#element_api":[9,9,1], -"pdsc_apis_pg.html#element_apis":[9,9,0], -"pdsc_boards_pg.html":[9,12], -"pdsc_boards_pg.html#element_board":[9,12,1], -"pdsc_boards_pg.html#element_board_book":[9,12,7], -"pdsc_boards_pg.html#element_board_compatibleDevice":[9,12,4], -"pdsc_boards_pg.html#element_board_debugInterface":[9,12,6], -"pdsc_boards_pg.html#element_board_feature":[9,12,2], -"pdsc_boards_pg.html#element_board_image":[9,12,5], -"pdsc_boards_pg.html#element_board_mountedDevice":[9,12,3], -"pdsc_boards_pg.html#element_boards":[9,12,0], -"pdsc_components_pg.html":[9,14], -"pdsc_components_pg.html#Component_Bundle":[9,14,0], -"pdsc_components_pg.html#Component_Files":[9,14,1], -"pdsc_components_pg.html#Component_Instances":[9,14,2], -"pdsc_components_pg.html#RTE_Components_h":[9,14,3], -"pdsc_components_pg.html#element_bundle":[9,14,5], -"pdsc_components_pg.html#element_component":[9,14,6], -"pdsc_components_pg.html#element_components":[9,14,4], -"pdsc_components_pg.html#element_file":[9,14,8], -"pdsc_components_pg.html#element_files":[9,14,7], -"pdsc_conditions_pg.html":[9,13], -"pdsc_conditions_pg.html#element_accept":[9,13,2], -"pdsc_conditions_pg.html#element_condition":[9,13,1], -"pdsc_conditions_pg.html#element_conditions":[9,13,0], -"pdsc_conditions_pg.html#element_deny":[9,13,4], -"pdsc_conditions_pg.html#element_require":[9,13,3], -"pdsc_devices_pg.html":[9,11], -"pdsc_devices_pg.html#element_devices":[9,11,0], -"pdsc_examples_pg.html":[9,15], -"pdsc_examples_pg.html#element_example":[9,15,1], -"pdsc_examples_pg.html#element_example_attribute_component":[9,15,6], -"pdsc_examples_pg.html#element_example_attributes":[9,15,5], -"pdsc_examples_pg.html#element_example_board":[9,15,2], -"pdsc_examples_pg.html#element_example_project":[9,15,3], -"pdsc_examples_pg.html#element_example_project_env":[9,15,4], -"pdsc_examples_pg.html#element_examples":[9,15,0], -"pdsc_family_pg.html":[9,11,1], -"pdsc_family_pg.html#DebugSyntaxRules":[9,11,1,23,0], -"pdsc_family_pg.html#ExpressionType":[9,11,1,23,1], -"pdsc_family_pg.html#element_algorithm":[9,11,1,3], -"pdsc_family_pg.html#element_book":[9,11,1,7], -"pdsc_family_pg.html#element_compile":[9,11,1,8], -"pdsc_family_pg.html#element_dbg_datapatch":[9,11,1,25], -"pdsc_family_pg.html#element_debug":[9,11,1,24], -"pdsc_family_pg.html#element_debugconfig":[9,11,1,14], -"pdsc_family_pg.html#element_debugport":[9,11,1,16], -"pdsc_family_pg.html#element_debugvars":[9,11,1,15], -"pdsc_family_pg.html#element_description":[9,11,1,9], -"pdsc_family_pg.html#element_device":[9,11,1,2], -"pdsc_family_pg.html#element_dp_cjtag":[9,11,1,19], -"pdsc_family_pg.html#element_dp_jtag":[9,11,1,17], -"pdsc_family_pg.html#element_dp_swd":[9,11,1,18], -"pdsc_family_pg.html#element_environment":[9,11,1,10], -"pdsc_family_pg.html#element_family":[9,11,1,0], -"pdsc_family_pg.html#element_feature":[9,11,1,11], -"pdsc_family_pg.html#element_flashblock":[9,11,1,5], -"pdsc_family_pg.html#element_flashgap":[9,11,1,6], -"pdsc_family_pg.html#element_flashinfo":[9,11,1,4], -"pdsc_family_pg.html#element_memory":[9,11,1,12], -"pdsc_family_pg.html#element_processor":[9,11,1,13], -"pdsc_family_pg.html#element_seq_block":[9,11,1,23], -"pdsc_family_pg.html#element_seq_control":[9,11,1,22], -"pdsc_family_pg.html#element_sequence":[9,11,1,21], -"pdsc_family_pg.html#element_sequences":[9,11,1,20], -"pdsc_family_pg.html#element_subFamily":[9,11,1,1], -"pdsc_family_pg.html#element_trace":[9,11,1,26], -"pdsc_family_pg.html#element_trace_serialwire":[9,11,1,27], -"pdsc_family_pg.html#element_trace_tracebuffer":[9,11,1,29], -"pdsc_family_pg.html#element_trace_traceport":[9,11,1,28], -"pdsc_family_pg.html#element_variant":[9,11,1,30], -"pdsc_generators_pg.html":[9,10], -"pdsc_generators_pg.html#element_gen_argument":[9,10,7], -"pdsc_generators_pg.html#element_gen_command":[9,10,6], -"pdsc_generators_pg.html#element_gen_eclipse":[9,10,4], -"pdsc_generators_pg.html#element_gen_exe":[9,10,3], -"pdsc_generators_pg.html#element_gen_file":[9,10,10], -"pdsc_generators_pg.html#element_gen_files":[9,10,9], -"pdsc_generators_pg.html#element_gen_project_files":[9,10,8], -"pdsc_generators_pg.html#element_gen_select":[9,10,2], -"pdsc_generators_pg.html#element_gen_web":[9,10,5], -"pdsc_generators_pg.html#element_generator":[9,10,1], -"pdsc_generators_pg.html#element_generators":[9,10,0], +"pdsc_apis_pg.html":[9,10], +"pdsc_apis_pg.html#element_api":[9,10,1], +"pdsc_apis_pg.html#element_apis":[9,10,0], +"pdsc_boards_pg.html":[9,13], +"pdsc_boards_pg.html#element_board":[9,13,1], +"pdsc_boards_pg.html#element_board_book":[9,13,7], +"pdsc_boards_pg.html#element_board_compatibleDevice":[9,13,4], +"pdsc_boards_pg.html#element_board_debugInterface":[9,13,6], +"pdsc_boards_pg.html#element_board_feature":[9,13,2], +"pdsc_boards_pg.html#element_board_image":[9,13,5], +"pdsc_boards_pg.html#element_board_mountedDevice":[9,13,3], +"pdsc_boards_pg.html#element_boards":[9,13,0], +"pdsc_components_pg.html":[9,15], +"pdsc_components_pg.html#Component_Bundle":[9,15,0], +"pdsc_components_pg.html#Component_Files":[9,15,1], +"pdsc_components_pg.html#Component_Instances":[9,15,2], +"pdsc_components_pg.html#Pre_Include_Global_h":[9,15,4], +"pdsc_components_pg.html#Pre_Include_Local_h":[9,15,5], +"pdsc_components_pg.html#RTE_Components_h":[9,15,3], +"pdsc_components_pg.html#element_bundle":[9,15,7], +"pdsc_components_pg.html#element_component":[9,15,8], +"pdsc_components_pg.html#element_components":[9,15,6], +"pdsc_components_pg.html#element_file":[9,15,10], +"pdsc_components_pg.html#element_files":[9,15,9], +"pdsc_conditions_pg.html":[9,14], +"pdsc_conditions_pg.html#element_accept":[9,14,2], +"pdsc_conditions_pg.html#element_condition":[9,14,1], +"pdsc_conditions_pg.html#element_conditions":[9,14,0], +"pdsc_conditions_pg.html#element_deny":[9,14,4], +"pdsc_conditions_pg.html#element_require":[9,14,3], +"pdsc_devices_pg.html":[9,12], +"pdsc_devices_pg.html#element_devices":[9,12,0], +"pdsc_examples_pg.html":[9,16], +"pdsc_examples_pg.html#element_example":[9,16,1], +"pdsc_examples_pg.html#element_example_attribute_component":[9,16,6], +"pdsc_examples_pg.html#element_example_attributes":[9,16,5], +"pdsc_examples_pg.html#element_example_board":[9,16,2], +"pdsc_examples_pg.html#element_example_project":[9,16,3], +"pdsc_examples_pg.html#element_example_project_env":[9,16,4], +"pdsc_examples_pg.html#element_examples":[9,16,0], +"pdsc_family_pg.html":[9,12,1], +"pdsc_family_pg.html#DebugSyntaxRules":[9,12,1,23,0], +"pdsc_family_pg.html#ExpressionType":[9,12,1,23,1], +"pdsc_family_pg.html#element_algorithm":[9,12,1,3], +"pdsc_family_pg.html#element_book":[9,12,1,7], +"pdsc_family_pg.html#element_compile":[9,12,1,8], +"pdsc_family_pg.html#element_dbg_datapatch":[9,12,1,25], +"pdsc_family_pg.html#element_debug":[9,12,1,24], +"pdsc_family_pg.html#element_debugconfig":[9,12,1,14], +"pdsc_family_pg.html#element_debugport":[9,12,1,16], +"pdsc_family_pg.html#element_debugvars":[9,12,1,15], +"pdsc_family_pg.html#element_description":[9,12,1,9], +"pdsc_family_pg.html#element_device":[9,12,1,2], +"pdsc_family_pg.html#element_dp_cjtag":[9,12,1,19], +"pdsc_family_pg.html#element_dp_jtag":[9,12,1,17], +"pdsc_family_pg.html#element_dp_swd":[9,12,1,18], +"pdsc_family_pg.html#element_environment":[9,12,1,10], +"pdsc_family_pg.html#element_family":[9,12,1,0], +"pdsc_family_pg.html#element_feature":[9,12,1,11], +"pdsc_family_pg.html#element_flashblock":[9,12,1,5], +"pdsc_family_pg.html#element_flashgap":[9,12,1,6], +"pdsc_family_pg.html#element_flashinfo":[9,12,1,4], +"pdsc_family_pg.html#element_memory":[9,12,1,12], +"pdsc_family_pg.html#element_processor":[9,12,1,13], +"pdsc_family_pg.html#element_seq_block":[9,12,1,23], +"pdsc_family_pg.html#element_seq_control":[9,12,1,22], +"pdsc_family_pg.html#element_sequence":[9,12,1,21], +"pdsc_family_pg.html#element_sequences":[9,12,1,20], +"pdsc_family_pg.html#element_subFamily":[9,12,1,1], +"pdsc_family_pg.html#element_trace":[9,12,1,26], +"pdsc_family_pg.html#element_trace_serialwire":[9,12,1,27], +"pdsc_family_pg.html#element_trace_tracebuffer":[9,12,1,29], +"pdsc_family_pg.html#element_trace_traceport":[9,12,1,28], +"pdsc_family_pg.html#element_variant":[9,12,1,30], +"pdsc_generators_pg.html":[9,11], +"pdsc_generators_pg.html#element_gen_argument":[9,11,7], +"pdsc_generators_pg.html#element_gen_command":[9,11,6], +"pdsc_generators_pg.html#element_gen_eclipse":[9,11,4], +"pdsc_generators_pg.html#element_gen_exe":[9,11,3], +"pdsc_generators_pg.html#element_gen_file":[9,11,10], +"pdsc_generators_pg.html#element_gen_files":[9,11,9], +"pdsc_generators_pg.html#element_gen_project_files":[9,11,8], +"pdsc_generators_pg.html#element_gen_select":[9,11,2], +"pdsc_generators_pg.html#element_gen_web":[9,11,5], +"pdsc_generators_pg.html#element_generator":[9,11,1], +"pdsc_generators_pg.html#element_generators":[9,11,0], "pdsc_package_pg.html":[9,3], "pdsc_package_pg.html#element_package":[9,3,0], "sdf_pg.html":[14], diff --git a/docs/Pack/html/packChk.html b/docs/Pack/html/packChk.html index 8276775..ff23eea 100644 --- a/docs/Pack/html/packChk.html +++ b/docs/Pack/html/packChk.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -404,7 +404,7 @@ Error and Warning Messages</h1> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="createPackUtil.html">Utilities for Creating Packs</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/packFormat.html b/docs/Pack/html/packFormat.html index 4889917..c5d5c95 100644 --- a/docs/Pack/html/packFormat.html +++ b/docs/Pack/html/packFormat.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -158,6 +158,7 @@ Pack Schema</h1> <li><a class="el" href="pdsc_package_pg.html"><package></a>: describes package related information like vendor, package name, description, version. Is the root element.</li> <li><a class="el" href="element_keywords.html"><keywords></a>: lists keywords to search for packages. Can be used for search engines.</li> <li><a class="el" href="element_repository.html"><repository></a>: specifies the URL and repository type of a public repository where the pack originates from.</li> +<li><a class="el" href="element_dominate.html"><dominate></a>: the pack contains one or more device, API, or component that overrules other packs with identical items.</li> <li><a class="el" href="element_releases.html"><releases></a>: lists release versions with descriptions.</li> <li><a class="el" href="element_requirements_pg.html"><requirements></a>: lists required packs, compiler, programming language standards and their version or version range.</li> <li><a class="el" href="element_taxonomy.html"><taxonomy></a>: lists description elements that define component classes and component group names.</li> @@ -184,7 +185,7 @@ Example of a *.pdsc File</div></div> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/packFormat.js b/docs/Pack/html/packFormat.js index b69e1fd..81bec35 100644 --- a/docs/Pack/html/packFormat.js +++ b/docs/Pack/html/packFormat.js @@ -8,6 +8,7 @@ var packFormat = ] ], [ "/package/keywords element", "element_keywords.html", null ], [ "/package/repository element", "element_repository.html", null ], + [ "/package/dominate element", "element_dominate.html", null ], [ "/package/releases element", "element_releases.html", [ [ "/package/releases/release", "element_releases.html#element_release", null ] ] ], @@ -59,6 +60,8 @@ var packFormat = [ "Component Files", "pdsc_components_pg.html#Component_Files", null ], [ "Component Instances", "pdsc_components_pg.html#Component_Instances", null ], [ "RTE_Components.h", "pdsc_components_pg.html#RTE_Components_h", null ], + [ "Pre_Include_Global_h", "pdsc_components_pg.html#Pre_Include_Global_h", null ], + [ "Pre_Include_Local_h", "pdsc_components_pg.html#Pre_Include_Local_h", null ], [ "/package/components", "pdsc_components_pg.html#element_components", null ], [ "/package/components/bundle", "pdsc_components_pg.html#element_bundle", null ], [ "/package/components/.../component", "pdsc_components_pg.html#element_component", null ], diff --git a/docs/Pack/html/packIndexFile.html b/docs/Pack/html/packIndexFile.html index c46e667..cbcf5ff 100644 --- a/docs/Pack/html/packIndexFile.html +++ b/docs/Pack/html/packIndexFile.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -208,12 +208,10 @@ CMSIS-Pack Index Schema File</h1> </xs:restriction> </xs:simpleType> - <!-- a basic string of letters and numbers plus a dash and underbar, no leading nor trailing spaces and a minimum of 3 characters and a maximum of 32 --> + <!-- some strings are used to construct filenames (e.g. package name). Such names can contain only subset of characters and must not contain neither spaces nor dots. --> <xs:simpleType name="RestrictedString"> <xs:restriction base="xs:string"> - <xs:minLength value="3"/> - <xs:maxLength value="32"/> - <xs:pattern value="[-_A-Za-z0-9]+"/> + <xs:pattern value="[\-_A-Za-z0-9]+"/> <xs:pattern value="\S(.*\S)?"></xs:pattern> </xs:restriction> </xs:simpleType> @@ -274,7 +272,7 @@ CMSIS-Pack Index Schema File</h1> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:43 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:01 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/pack_Example.html b/docs/Pack/html/pack_Example.html index 41274c0..9b7b0fb 100644 --- a/docs/Pack/html/pack_Example.html +++ b/docs/Pack/html/pack_Example.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -225,7 +225,7 @@ $(document).ready(function(){initNavTree('pack_Example.html','');}); <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/pack_revisionHistory.html b/docs/Pack/html/pack_revisionHistory.html index 0169172..24eb356 100644 --- a/docs/Pack/html/pack_revisionHistory.html +++ b/docs/Pack/html/pack_revisionHistory.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -114,6 +114,18 @@ $(document).ready(function(){initNavTree('pack_revisionHistory.html','');}); <tr> <th>Version </th><th>Description </th></tr> <tr> +<td>1.6.0 </td><td>Modifications compared to Version 1.5.0<ul> +<li>added Armv8.1-M MVE processor feature attribute 'Dmve'.</li> +<li>added local and global pre-include section <a class="el" href="pdsc_components_pg.html#Pre_Include_Local_h">Pre_Include_Local_h</a>, <a class="el" href="pdsc_components_pg.html#Pre_Include_Global_h">Pre_Include_Global_h</a>.</li> +<li>added file categories 'preIncludeLocal' and 'preIncludeGlobal' to the <a class="el" href="pdsc_components_pg.html#FileCategoryEnum">FileCategoryEnum</a>.</li> +<li>added file attribute 'path' for file category 'header' to add support for relative include paths.</li> +<li>added to <a class="el" href="pdsc_package_pg.html#element_package">package</a> element the possibility to restrict the usage of the with attributes Dcore, Dname, Dvendor, and Tcompiler.</li> +<li>added <a class="el" href="element_dominate.html">dominate</a> element to overwrites identical <a class="el" href="pdsc_devices_pg.html#element_devices">devices</a>, <a class="el" href="pdsc_apis_pg.html#element_apis">APIs</a>, or <a class="el" href="pdsc_components_pg.html#element_components">components</a>.</li> +<li>added attribute 'condition' to the <a class="el" href="pdsc_apis_pg.html#element_api">api</a> element so that an API can be excluded based on a condition.</li> +<li>added new <a class="el" href="cp_Packs.html#pack_Cclass">Software Component Cclasses</a> : "Audio", "Board Part", "Data Exchange", "Extension Board", "IoT Client", "IoT Utility", "Security", "Utility". </li> +</ul> +</td></tr> +<tr> <td>1.5.0 </td><td>Modifications compared to Version 1.4.9<ul> <li>added <a class="el" href="sdf_pg.html">System Description File (*.SDF) Format</a></li> <li>updates to <a class="el" href="pdsc_family_pg.html#DeviceVendorEnum">Device Vendor</a></li> @@ -121,7 +133,8 @@ $(document).ready(function(){initNavTree('pack_revisionHistory.html','');}); <li>added <a class="el" href="pdsc_family_pg.html#element_flashinfo">flashinfo</a> with children <block> and <gap> to describe flash devices for sequence-based flash download</li> <li>new <a class="el" href="debug_description.html#DebugFunctions">debug access functions</a> and <a class="el" href="debug_description.html#DebugVars">global debug variables</a> for sequence-based flash download</li> <li>added <a class="el" href="element_repository.html">repository</a> element for specifying origin of public repositories</li> -<li>added attributes to <a class="el" href="element_releases.html#element_release">release</a> element specifying repository tag and url for downloading repository content </li> +<li>added attributes to <a class="el" href="element_releases.html#element_release">release</a> element specifying repository tag and url for downloading repository content</li> +<li>added new processor Cortex-M35P </li> </ul> </td></tr> <tr> @@ -265,7 +278,7 @@ $(document).ready(function(){initNavTree('pack_revisionHistory.html','');}); <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="index.html">index</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/pages.html b/docs/Pack/html/pages.html index 638ecab..b8ef15e 100644 --- a/docs/Pack/html/pages.html +++ b/docs/Pack/html/pages.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -112,7 +112,7 @@ $(document).ready(function(){initNavTree('pages.html','');}); <div class="contents"> <div class="textblock">Here is a list of all related documentation pages:</div><div class="directory"> <div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory"> -<tr id="row_0_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="cp_Packs.html" target="_self">Software Packs Overview</a></td><td class="desc"></td></tr> +<tr id="row_0_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="cp_Packs.html" target="_self">Overview</a></td><td class="desc"></td></tr> <tr id="row_1_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="cp_SWComponents.html" target="_self">Pack with Software Components</a></td><td class="desc"></td></tr> <tr id="row_2_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="createPack_DFP.html" target="_self">Pack with Device Support</a></td><td class="desc"></td></tr> <tr id="row_3_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="createPackBoard.html" target="_self">Pack with Board Support</a></td><td class="desc"></td></tr> @@ -126,25 +126,26 @@ $(document).ready(function(){initNavTree('pages.html','');}); <tr id="row_7_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="pdsc_package_pg.html" target="_self">/package element</a></td><td class="desc"></td></tr> <tr id="row_7_1_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="element_keywords.html" target="_self">/package/keywords element</a></td><td class="desc"></td></tr> <tr id="row_7_2_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="element_repository.html" target="_self">/package/repository element</a></td><td class="desc"></td></tr> -<tr id="row_7_3_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="element_releases.html" target="_self">/package/releases element</a></td><td class="desc"></td></tr> -<tr id="row_7_4_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="element_requirements_pg.html" target="_self">/package/requirements</a></td><td class="desc"></td></tr> -<tr id="row_7_5_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="element_taxonomy.html" target="_self">/package/taxonomy element</a></td><td class="desc"></td></tr> -<tr id="row_7_6_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="pdsc_apis_pg.html" target="_self">/package/apis element</a></td><td class="desc"></td></tr> -<tr id="row_7_7_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="pdsc_generators_pg.html" target="_self">/package/generators element</a></td><td class="desc"></td></tr> -<tr id="row_7_8_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_7_8_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('7_8_')"/><a class="el" href="pdsc_devices_pg.html" target="_self">/package/devices element</a></td><td class="desc"></td></tr> -<tr id="row_7_8_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="pdsc_family_pg.html" target="_self">/package/devices/family element</a></td><td class="desc"></td></tr> -<tr id="row_7_9_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="pdsc_boards_pg.html" target="_self">/package/boards element</a></td><td class="desc"></td></tr> -<tr id="row_7_10_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="pdsc_conditions_pg.html" target="_self">/package/conditions element</a></td><td class="desc"></td></tr> -<tr id="row_7_11_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="pdsc_components_pg.html" target="_self">/package/components element</a></td><td class="desc"></td></tr> -<tr id="row_7_12_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="pdsc_examples_pg.html" target="_self">/package/examples element</a></td><td class="desc"></td></tr> -<tr id="row_8_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="configWizard.html" target="_self">Configuration Wizard Annotations</a></td><td class="desc"></td></tr> -<tr id="row_9_" class="even"><td class="entry"><img id="arr_9_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('9_')"/><a class="el" href="flashAlgorithm.html" target="_self">Flash Programming</a></td><td class="desc"></td></tr> -<tr id="row_9_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="algorithmFunc.html" target="_self">Algorithm Functions</a></td><td class="desc">Blank Check </td></tr> -<tr id="row_10_" class="even"><td class="entry"><img id="arr_10_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('10_')"/><a class="el" href="coresight_setup.html" target="_self">Debug Setup with CMSIS-Pack</a></td><td class="desc"></td></tr> -<tr id="row_10_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="debug_description.html" target="_self">Debug Description</a></td><td class="desc"></td></tr> -<tr id="row_11_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="cpdsc_pg.html" target="_self">Project Description (*.cpdsc) Format</a></td><td class="desc"></td></tr> -<tr id="row_12_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="sdf_pg.html" target="_self">System Description File (*.SDF) Format</a></td><td class="desc"></td></tr> -<tr id="row_13_" class="even"><td class="entry"><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="packIndexFile.html" target="_self">CMSIS-Pack Index Files</a></td><td class="desc"></td></tr> +<tr id="row_7_3_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="element_dominate.html" target="_self">/package/dominate element</a></td><td class="desc"></td></tr> +<tr id="row_7_4_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="element_releases.html" target="_self">/package/releases element</a></td><td class="desc"></td></tr> +<tr id="row_7_5_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="element_requirements_pg.html" target="_self">/package/requirements</a></td><td class="desc"></td></tr> +<tr id="row_7_6_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="element_taxonomy.html" target="_self">/package/taxonomy element</a></td><td class="desc"></td></tr> +<tr id="row_7_7_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="pdsc_apis_pg.html" target="_self">/package/apis element</a></td><td class="desc"></td></tr> +<tr id="row_7_8_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="pdsc_generators_pg.html" target="_self">/package/generators element</a></td><td class="desc"></td></tr> +<tr id="row_7_9_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_7_9_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('7_9_')"/><a class="el" href="pdsc_devices_pg.html" target="_self">/package/devices element</a></td><td class="desc"></td></tr> +<tr id="row_7_9_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="pdsc_family_pg.html" target="_self">/package/devices/family element</a></td><td class="desc"></td></tr> +<tr id="row_7_10_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="pdsc_boards_pg.html" target="_self">/package/boards element</a></td><td class="desc"></td></tr> +<tr id="row_7_11_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="pdsc_conditions_pg.html" target="_self">/package/conditions element</a></td><td class="desc"></td></tr> +<tr id="row_7_12_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="pdsc_components_pg.html" target="_self">/package/components element</a></td><td class="desc"></td></tr> +<tr id="row_7_13_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="pdsc_examples_pg.html" target="_self">/package/examples element</a></td><td class="desc"></td></tr> +<tr id="row_8_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="configWizard.html" target="_self">Configuration Wizard Annotations</a></td><td class="desc"></td></tr> +<tr id="row_9_"><td class="entry"><img id="arr_9_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('9_')"/><a class="el" href="flashAlgorithm.html" target="_self">Flash Programming</a></td><td class="desc"></td></tr> +<tr id="row_9_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="algorithmFunc.html" target="_self">Algorithm Functions</a></td><td class="desc">Blank Check </td></tr> +<tr id="row_10_"><td class="entry"><img id="arr_10_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('10_')"/><a class="el" href="coresight_setup.html" target="_self">Debug Setup with CMSIS-Pack</a></td><td class="desc"></td></tr> +<tr id="row_10_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="debug_description.html" target="_self">Debug Description</a></td><td class="desc"></td></tr> +<tr id="row_11_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="cpdsc_pg.html" target="_self">Project Description (*.cpdsc) Format</a></td><td class="desc"></td></tr> +<tr id="row_12_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="sdf_pg.html" target="_self">System Description File (*.SDF) Format</a></td><td class="desc"></td></tr> +<tr id="row_13_"><td class="entry"><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="packIndexFile.html" target="_self">CMSIS-Pack Index Files</a></td><td class="desc"></td></tr> </table> </div><!-- directory --> </div><!-- contents --> @@ -152,7 +153,7 @@ $(document).ready(function(){initNavTree('pages.html','');}); <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:43 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:01 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/pdsc_SequenceNameEnum_pg.html b/docs/Pack/html/pdsc_SequenceNameEnum_pg.html deleted file mode 100644 index 743cb05..0000000 --- a/docs/Pack/html/pdsc_SequenceNameEnum_pg.html +++ /dev/null @@ -1,1092 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> -<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> -<meta http-equiv="X-UA-Compatible" content="IE=9"/> -<title>Debug access sequences</title> -<title>CMSIS-Pack: Debug access sequences</title> -<link href="tabs.css" rel="stylesheet" type="text/css"/> -<link href="cmsis.css" rel="stylesheet" type="text/css" /> -<script type="text/javascript" src="jquery.js"></script> -<script type="text/javascript" src="dynsections.js"></script> -<script type="text/javascript" src="printComponentTabs.js"></script> -<link href="navtree.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="resize.js"></script> -<script type="text/javascript" src="navtree.js"></script> -<script type="text/javascript"> - $(document).ready(initResizable); - $(window).load(resizeHeight); -</script> -<link href="search/search.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="search/search.js"></script> -<script type="text/javascript"> - $(document).ready(function() { searchBox.OnSelectItem(0); }); -</script> -</head> -<body> -<div id="top"><!-- do not remove this div, it is closed by doxygen! --> -<div id="titlearea"> -<table cellspacing="0" cellpadding="0"> - <tbody> - <tr style="height: 46px;"> - <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> - <td style="padding-left: 0.5em;"> - <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.4.9</span> - </div> - <div id="projectbrief">Delivery Mechanism for Software Packs</div> - </td> - </tr> - </tbody> -</table> -</div> -<!-- end header part --> -<div id="CMSISnav" class="tabs1"> - <ul class="tablist"> - <script type="text/javascript"> - <!-- - writeComponentTabs.call(this); - //--> - </script> - </ul> -</div> -<!-- Generated by Doxygen 1.8.6 --> -<script type="text/javascript"> -var searchBox = new SearchBox("searchBox", "search",false,'Search'); -</script> - <div id="navrow1" class="tabs"> - <ul class="tablist"> - <li><a href="index.html"><span>Main Page</span></a></li> - <li class="current"><a href="pages.html"><span>Usage and Description</span></a></li> - <li> - <div id="MSearchBox" class="MSearchBoxInactive"> - <span class="left"> - <img id="MSearchSelect" src="search/mag_sel.png" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - alt=""/> - <input type="text" id="MSearchField" value="Search" accesskey="S" - onfocus="searchBox.OnSearchFieldFocus(true)" - onblur="searchBox.OnSearchFieldFocus(false)" - onkeyup="searchBox.OnSearchFieldChange(event)"/> - </span><span class="right"> - <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> - </span> - </div> - </li> - </ul> - </div> -</div><!-- top --> -<div id="side-nav" class="ui-resizable side-nav-resizable"> - <div id="nav-tree"> - <div id="nav-tree-contents"> - <div id="nav-sync" class="sync"></div> - </div> - </div> - <div id="splitbar" style="-moz-user-select:none;" - class="ui-resizable-handle"> - </div> -</div> -<script type="text/javascript"> -$(document).ready(function(){initNavTree('pdsc_SequenceNameEnum_pg.html','');}); -</script> -<div id="doc-content"> -<!-- window showing the filter options --> -<div id="MSearchSelectWindow" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - onkeydown="return searchBox.OnSearchSelectKey(event)"> -<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Pages</a></div> - -<!-- iframe showing the search results (closed by default) --> -<div id="MSearchResultsWindow"> -<iframe src="javascript:void(0)" frameborder="0" - name="MSearchResults" id="MSearchResults"> -</iframe> -</div> - -<div class="header"> - <div class="headertitle"> -<div class="title">Debug access sequences </div> </div> -</div><!--header--> -<div class="contents"> -<div class="textblock"><p>Debug access sequences define the activities of development tools to connect to a device using the debug channel for debugging, tracing, or flash programming. Several debug access sequences are pre-defined and executed in specific context. Refer to <a class="el" href="pdsc_family_pg.html#element_sequences">sequences</a> for details.</p> -<p>Software development tools should implement <a class="el" href="pdsc_SequenceNameEnum_pg.html#default_sequences">Default debug access sequences</a>. These default sequences can be overwritten by device specific sequences using the <a class="el" href="pdsc_family_pg.html#element_sequence">sequence</a> element in the <a class="el" href="pdsc_family_pg.html#element_sequences">sequences</a> section of the PDSC file. Additionally, a PDSC file can contain user-defined sequences, for example to reuse access sequence fragments:</p> -<ul> -<li><a class="el" href="pdsc_SequenceNameEnum_pg.html#usage_of_sequences">Usage of debug access sequences</a> explains how the sequences are used from a development tool point of view.</li> -<li><a class="el" href="pdsc_SequenceNameEnum_pg.html#default_sequences">Default debug access sequences</a> lists all debug access sequences that are pre-defined by the CMSIS-Pack standard and shows the details of the default debug access sequences.</li> -<li><a class="el" href="pdsc_SequenceNameEnum_pg.html#writing_sequences">Writing debug access sequences</a> explains how to write custom debug access sequences. These can be used to either override default sequences or to define device specific sequences.</li> -</ul> -<h1><a class="anchor" id="usage_of_sequences"></a> -Usage of debug access sequences</h1> -<p>Pre-defined Debug Access Sequences are used in the following context:</p> -<ul> -<li><b>Connect Debugger to Device</b> is executed when debugging or flash programming with the target starts.</li> -<li><b>Reset Device</b> is executed to reset the target.</li> -<li><b>Verify Code</b> is executed to verify the content after flash programming.</li> -<li><b>Disconnect Debugger</b> is executed when debugging or flash programming with the target stops.</li> -</ul> -<p>The following diagrams show how the Debug Access Sequences are executed by a development tool.</p> -<p><b>Connect Debugger to Device</b> is executed when debugging or flash programming with the target starts.</p> -<div class="image"> -<img src="DebugConnect.png" alt="DebugConnect.png"/> -</div> -<p><b>Reset Device</b> is executed to reset the target.</p> -<div class="image"> -<img src="Reset.png" alt="Reset.png"/> -</div> -<p><b>Verify Code</b> is executed to verify the content after flash programming.</p> -<div class="image"> -<img src="CodeVerify.png" alt="CodeVerify.png"/> -</div> -<p><b>Disconnect Debugger</b> is executed when debugging or flash programming with the target stops.</p> -<div class="image"> -<img src="DebugDisconnect.png" alt="DebugDisconnect.png"/> -</div> -<h1><a class="anchor" id="default_sequences"></a> -Default debug access sequences</h1> -<p>Debug access sequences get defined in the <a class="el" href="pdsc_family_pg.html#element_sequence">sequence</a> element. The following table lists the available pre-defined debug access sequences. <a class="el" href="pdsc_SequenceNameEnum_pg.html#default_sequences">Default debug access sequences</a> are executed if they are not overwritten using a <a class="el" href="pdsc_family_pg.html#element_sequence">sequence</a> element. Refer to <a class="el" href="pdsc_SequenceNameEnum_pg.html#usage_of_sequences">Usage of debug access sequences</a> for more information about the execution of these sequences.</p> -<p>For debug access sequences marked in <span class="XML-Token">ItalicRed</span>, no default sequence exists. The usage in a debug description requires a related <a class="el" href="pdsc_family_pg.html#element_sequence">sequence</a> element to be present. The other sequences should be implemented in a development tool. They are executed when no sequence definition exists in the PDSC file.</p> -<dl class="section note"><dt>Note</dt><dd>Default debug access sequences read the System Control Space (SCS) of the processor and assume that the SCS offset is implemented as defined in the ARMv6-M/ARMv7-M/ARMv8-M architecture reference manual.</dd></dl> -<table class="cmtable" summary="Enumeration: SequenceNameEnum"> -<tr> -<th>name= </th><th>Description </th></tr> -<tr> -<td class="XML-Token"><a class="el" href="pdsc_SequenceNameEnum_pg.html#debugPortSetup">DebugPortSetup</a> </td><td>Prepare the target debug port for connection; is executed before acquiring access to the debug port.<br/> - May include for example an SWJ-DP switch sequence as defined in the ARM Debug Interface (ADI) Architecture Specification.<br/> - <b>This sequence must not contain debug port/access port register and target memory accesses other than:</b><ul> -<li><b>Reading the <em>DPIDR</em> debug port register to release an SWD connection from its line reset.</b></li> -<li><b>Writing the <em>TARGETSEL</em> debug port register (SWD protocol v2).</b> </li> -</ul> -</td></tr> -<tr> -<td class="XML-Token"><a class="el" href="pdsc_SequenceNameEnum_pg.html#debugPortStart">DebugPortStart</a> </td><td>Connect to the target debug port and power it up; is executed after DebugPortSetup.<br/> - The parent <b>debugport</b> is default debug port for this sequence.<br/> - <b>This sequence must not contain access port register and target memory accesses.</b> </td></tr> -<tr> -<td class="XML-Token"><a class="el" href="pdsc_SequenceNameEnum_pg.html#debugPortStop">DebugPortStop</a> </td><td>Power down and disconnect from target debug port.<br/> - Executed as last step during target disconnect unless another debugger connection to this port is active. The parent <b>debugport</b> is default debug port for this sequence.<br/> - <b>This sequence must not contain access port register and target memory accesses.</b> </td></tr> -<tr> -<td class="XML-Token">DebugDeviceUnlock </td><td>Check if the device is in a locked state and unlock it. Use <b>query</b> command elements for user confirmation.<br/> - Executed after having powered up the debug port. </td></tr> -<tr> -<td class="XML-Token"><a class="el" href="pdsc_SequenceNameEnum_pg.html#debugCoreStart">DebugCoreStart</a> </td><td>Initialize core debug system.<br/> - Executed after having connected and powered up the default debug port for the connection. </td></tr> -<tr> -<td class="XML-Token"><a class="el" href="pdsc_SequenceNameEnum_pg.html#debugCoreStop">DebugCoreStop</a> </td><td>Uninitialize core debug system.<br/> - Executed as last step during disconnect before powering down any debug ports no longer required for concurrent connections. </td></tr> -<tr> -<td class="XML-Token">DebugCodeMemRemap </td><td>Remap memory to execution location.<br/> - Executed before verifying memory content after flash programming. This is required to replicate a memory remap of a device bootloader (that is not executed during debug connection). </td></tr> -<tr> -<td class="XML-Token"><a class="el" href="pdsc_SequenceNameEnum_pg.html#resetSystem">ResetSystem</a> </td><td>Execute a system-wide reset via software mechanisms. </td></tr> -<tr> -<td class="XML-Token"><a class="el" href="pdsc_SequenceNameEnum_pg.html#resetProcessor">ResetProcessor</a> </td><td>Execute a processor reset via software mechanisms. </td></tr> -<tr> -<td class="XML-Token"><a class="el" href="pdsc_SequenceNameEnum_pg.html#resetHardware">ResetHardware</a> </td><td>Execute a system-wide reset via the dedicated debugger reset line, e.g. nRST. </td></tr> -<tr> -<td class="XML-Token"><a class="el" href="pdsc_SequenceNameEnum_pg.html#resetHardwareAssert">ResetHardwareAssert</a> </td><td>Assert a system-wide reset via the dedicated debugger reset line, e.g. nRST. </td></tr> -<tr> -<td class="XML-Token"><a class="el" href="pdsc_SequenceNameEnum_pg.html#resetHardwareDeassert">ResetHardwareDeassert</a> </td><td>Deassert a system-wide reset via the dedicated debugger reset line, e.g. nRST. </td></tr> -<tr> -<td class="XML-Token"><a class="el" href="pdsc_SequenceNameEnum_pg.html#resetCatchSet">ResetCatchSet</a> </td><td>Executed before a target reset to configure the vector catch to stop code execution after the reset.<br/> - The implementation of <b>ResetCatchSet</b> requires an implementation of <b>ResetCatchClear</b> to free any hardware resources used for stopping the core. </td></tr> -<tr> -<td class="XML-Token"><a class="el" href="pdsc_SequenceNameEnum_pg.html#resetCatchClear">ResetCatchClear</a> </td><td>Executed after a target reset to free hardware resources allocated by <b>ResetCatchSet</b>. </td></tr> -<tr> -<td class="XML-Token">FlashEraseDone </td><td>Executed after erasing flash memory. </td></tr> -<tr> -<td class="XML-Token">FlashProgramDone </td><td>Eexecuted after programming flash memory. </td></tr> -<tr> -<td class="XML-Token">TraceStart </td><td>Enable target trace capture.<br/> - Executed before the debugger powers up and configures standard CoreSight trace components, e.g. after the initial target connection as well as after a system-wide reset. </td></tr> -<tr> -<td class="XML-Token">TraceStop </td><td>Disable target trace capture.<br/> - Executed after the debugger disabled and powered down standard CoreSight trace components. </td></tr> -<tr> -<td class="XML-Token">RecoverySupportStart </td><td>Executed before step or run command to support recovery from a lost target connection, e.g. after a low power mode. </td></tr> -<tr> -<td class="XML-Token">RecoverySupportStop </td><td>Executed after step or run command in context of the <b>RecoverySupportStart</b> sequence. </td></tr> -<tr> -<td class="XML-Token">RecoveryAcknowledge </td><td>Debugger acknowledge after recovering from a lost target connection. Can be executed independently from a <b>RecoverySupportStart</b> sequence. </td></tr> -</table> -<h2>Pre-defined default debug access sequences </h2> -<p>The following sections the show the details of the pre-defined default debug access sequences.</p> -<h2><a class="anchor" id="debugPortSetup"></a> -DebugPortSetup</h2> -<p>Prepare the target debug port for connection.</p> -<div class="fragment"><div class="line"><sequence name=<span class="stringliteral">"DebugPortSetup"</span>></div> -<div class="line"> <block></div> -<div class="line"> __var isSWJ = ((__protocol &amp; 0x00010000) != 0);</div> -<div class="line"> __var protType = __protocol &amp; 0x0000FFFF;</div> -<div class="line"> </block></div> -<div class="line"></div> -<div class="line"> <!-- JTAG Protocol --></div> -<div class="line"> <control <span class="keywordflow">if</span>=<span class="stringliteral">"protType == 1"</span>></div> -<div class="line"> </div> -<div class="line"> <control <span class="keywordflow">if</span>=<span class="stringliteral">"isSWJ"</span>></div> -<div class="line"> </div> -<div class="line"> <block atomic=<span class="stringliteral">"1"</span>></div> -<div class="line"> <span class="comment">// Ensure current debug interface is in reset state</span></div> -<div class="line"> DAP_SWJ_Sequence(51, 0x0007FFFFFFFFFFFF);</div> -<div class="line"> </div> -<div class="line"> <span class="comment">// Execute SWJ-DP Switch Sequence SWD to JTAG (0xE73C)</span></div> -<div class="line"> <span class="comment">// Change if SWJ-DP uses deprecated switch code (0xAEAE)</span></div> -<div class="line"> DAP_SWJ_Sequence(16, 0xE73C);</div> -<div class="line"> </div> -<div class="line"> <span class="comment">// Ensure JTAG interface is reset</span></div> -<div class="line"> DAP_SWJ_Sequence(6, 0x3F);</div> -<div class="line"> </block></div> -<div class="line"> </div> -<div class="line"> </control></div> -<div class="line"> </div> -<div class="line"> <block atomic=<span class="stringliteral">"1"</span>></div> -<div class="line"> <span class="comment">// JTAG "Soft" Reset</span></div> -<div class="line"> DAP_JTAG_Sequence(6, 1, 0x3F);</div> -<div class="line"> DAP_JTAG_Sequence(1, 0, 0x01);</div> -<div class="line"> </block></div> -<div class="line"></div> -<div class="line"> </control></div> -<div class="line"> </div> -<div class="line"> <!-- SWD Protocol --></div> -<div class="line"> <control <span class="keywordflow">if</span>=<span class="stringliteral">"protType == 2"</span>></div> -<div class="line"> </div> -<div class="line"> <control <span class="keywordflow">if</span>=<span class="stringliteral">"isSWJ"</span>></div> -<div class="line"> </div> -<div class="line"> <block atomic=<span class="stringliteral">"1"</span>></div> -<div class="line"> <span class="comment">// Ensure current debug interface is in reset state</span></div> -<div class="line"> DAP_SWJ_Sequence(51, 0x0007FFFFFFFFFFFF);</div> -<div class="line"> </div> -<div class="line"> <span class="comment">// Execute SWJ-DP Switch Sequence JTAG to SWD (0xE79E)</span></div> -<div class="line"> <span class="comment">// Change if SWJ-DP uses deprecated switch code (0xEDB6)</span></div> -<div class="line"> DAP_SWJ_Sequence(16, 0xE79E);</div> -<div class="line"> </div> -<div class="line"> <span class="comment">// Enter SWD Line Reset State</span></div> -<div class="line"> DAP_SWJ_Sequence(51, 0x0007FFFFFFFFFFFF); <span class="comment">// &gt; 50 cycles SWDIO/TMS High</span></div> -<div class="line"> DAP_SWJ_Sequence(3, 0x00); <span class="comment">// At least 2 idle cycles (SWDIO/TMS Low)</span></div> -<div class="line"> </block></div> -<div class="line"> </div> -<div class="line"> </control></div> -<div class="line"> </div> -<div class="line"> <control <span class="keywordflow">if</span>=<span class="stringliteral">"!isSWJ"</span>></div> -<div class="line"> </div> -<div class="line"> <block atomic=<span class="stringliteral">"1"</span>></div> -<div class="line"> <span class="comment">// Enter SWD Line Reset State</span></div> -<div class="line"> DAP_SWJ_Sequence(51, 0x0007FFFFFFFFFFFF); <span class="comment">// &gt; 50 cycles SWDIO/TMS High</span></div> -<div class="line"> DAP_SWJ_Sequence(3, 0x00); <span class="comment">// At least 2 idle cycles (SWDIO/TMS Low)</span></div> -<div class="line"> </block></div> -<div class="line"> </div> -<div class="line"> </control></div> -<div class="line"> </div> -<div class="line"> <block></div> -<div class="line"> <span class="comment">// Read DPIDR to enable SWD interface (SW-DPv1 and SW-DPv2)</span></div> -<div class="line"> ReadDP(0x0);</div> -<div class="line"> </block></div> -<div class="line"></div> -<div class="line"> </control></div> -<div class="line"> </div> -<div class="line"></sequence></div> -</div><!-- fragment --><h2><a class="anchor" id="debugPortStart"></a> -DebugPortStart</h2> -<p>Connect to the target debug port and power it up.</p> -<div class="fragment"><div class="line"><sequence name=<span class="stringliteral">"DebugPortStart"</span>></div> -<div class="line"> </div> -<div class="line"> <block></div> -<div class="line"> __var SW_DP_ABORT = 0x0;</div> -<div class="line"> __var DP_CTRL_STAT = 0x4;</div> -<div class="line"> __var DP_SELECT = 0x8;</div> -<div class="line"> __var powered_down = 0;</div> -<div class="line"></div> -<div class="line"> <span class="comment">// Switch to DP Register Bank 0</span></div> -<div class="line"> WriteDP(DP_SELECT, 0x00000000);</div> -<div class="line"> </div> -<div class="line"> <span class="comment">// Read DP CTRL/STAT Register and check if CSYSPWRUPACK and CDBGPWRUPACK bits are set</span></div> -<div class="line"> powered_down = ((ReadDP(DP_CTRL_STAT) &amp; 0xA0000000) != 0xA0000000);</div> -<div class="line"> </block></div> -<div class="line"> </div> -<div class="line"> <control <span class="keywordflow">if</span>=<span class="stringliteral">"powered_down"</span>></div> -<div class="line"> </div> -<div class="line"> <block></div> -<div class="line"> <span class="comment">// Request Debug/System Power-Up</span></div> -<div class="line"> WriteDP(DP_CTRL_STAT, 0x50000000);</div> -<div class="line"> </block></div> -<div class="line"> </div> -<div class="line"> <!-- Wait <span class="keywordflow">for</span> Power-Up Request to be acknowledged --></div> -<div class="line"> <control <span class="keywordflow">while</span>=<span class="stringliteral">"(ReadDP(DP_CTRL_STAT) &amp; 0xA0000000) != 0xA0000000"</span> timeout=<span class="stringliteral">"1000000"</span>/></div> -<div class="line"> </div> -<div class="line"> <block></div> -<div class="line"> <span class="comment">// Request Debug Reset</span></div> -<div class="line"> WriteDP(DP_CTRL_STAT, 0x54000000);</div> -<div class="line"> </block></div> -<div class="line"> </div> -<div class="line"> <!-- Wait <span class="keywordflow">for</span> Debug Reset to be acknowledged, don<span class="stringliteral">'t issue error on timeout to deal with improperly connected Debug Reset --></span></div> -<div class="line"><span class="stringliteral"> <control while="(ReadDP(DP_CTRL_STAT) &amp; 0xA8000000) != 0xA8000000" timeout="300000"/></span></div> -<div class="line"><span class="stringliteral"> </span></div> -<div class="line"><span class="stringliteral"> <!-- JTAG Specific Part of sequence --></span></div> -<div class="line"><span class="stringliteral"> <control if="__protocol == 1"></span></div> -<div class="line"><span class="stringliteral"> </span></div> -<div class="line"><span class="stringliteral"> <block></span></div> -<div class="line"><span class="stringliteral"> // Init AP Transfer Mode, Transaction Counter, and Lane Mask (Normal Transfer Mode, Include all Byte Lanes)</span></div> -<div class="line"><span class="stringliteral"> // Additionally clear STICKYORUN, STICKYCMP, and STICKYERR bits by writing '</span>1<span class="stringliteral">'</span></div> -<div class="line"><span class="stringliteral"> WriteDP(DP_CTRL_STAT, 0x50000F32);</span></div> -<div class="line"><span class="stringliteral"> </block></span></div> -<div class="line"><span class="stringliteral"> </span></div> -<div class="line"><span class="stringliteral"> </control></span></div> -<div class="line"><span class="stringliteral"> </span></div> -<div class="line"><span class="stringliteral"> <!-- SWD Specific Part of sequence --></span></div> -<div class="line"><span class="stringliteral"> <control if="__protocol == 2"></span></div> -<div class="line"><span class="stringliteral"> </span></div> -<div class="line"><span class="stringliteral"> <block></span></div> -<div class="line"><span class="stringliteral"> // Init AP Transfer Mode, Transaction Counter, and Lane Mask (Normal Transfer Mode, Include all Byte Lanes)</span></div> -<div class="line"><span class="stringliteral"> WriteDP(DP_CTRL_STAT, 0x50000F00);</span></div> -<div class="line"><span class="stringliteral"> </span></div> -<div class="line"><span class="stringliteral"> // Clear WDATAERR, STICKYORUN, STICKYCMP, and STICKYERR bits of CTRL/STAT Register by write to ABORT register</span></div> -<div class="line"><span class="stringliteral"> WriteDP(SW_DP_ABORT, 0x0000001E);</span></div> -<div class="line"><span class="stringliteral"> </block></span></div> -<div class="line"><span class="stringliteral"></span></div> -<div class="line"><span class="stringliteral"> </control></span></div> -<div class="line"><span class="stringliteral"> </span></div> -<div class="line"><span class="stringliteral"> </control></span></div> -<div class="line"><span class="stringliteral"> </span></div> -<div class="line"><span class="stringliteral"></sequence></span></div> -</div><!-- fragment --><h2><a class="anchor" id="debugPortStop"></a> -DebugPortStop</h2> -<p>Power down and disconnect from target debug port.</p> -<div class="fragment"><div class="line"><sequence name=<span class="stringliteral">"DebugPortStop"</span>></div> -<div class="line"></div> -<div class="line"> <block></div> -<div class="line"> __var DP_CTRL_STAT = 0x4;</div> -<div class="line"> __var DP_SELECT = 0x8;</div> -<div class="line"> </div> -<div class="line"> <span class="comment">// Switch to DP Register Bank 0</span></div> -<div class="line"> WriteDP(DP_SELECT, 0x00000000);</div> -<div class="line"> </div> -<div class="line"> <span class="comment">// Power Down Debug port</span></div> -<div class="line"> WriteDP(DP_CTRL_STAT, 0x00000000);</div> -<div class="line"> </block></div> -<div class="line"></div> -<div class="line"></sequence></div> -</div><!-- fragment --><h2><a class="anchor" id="debugCoreStart"></a> -DebugCoreStart</h2> -<p>Initialize core debug system.</p> -<div class="fragment"><div class="line"><sequence name=<span class="stringliteral">"DebugCoreStart"</span>></div> -<div class="line"></div> -<div class="line"> <block></div> -<div class="line"> <span class="comment">// System Control Space (SCS) offset as defined in ARMv6-M/ARMv7-M.</span></div> -<div class="line"> </div> -<div class="line"> __var SCS_Addr = 0xE000E000;</div> -<div class="line"> __var DHCSR_Addr = SCS_Addr + 0xDF0;</div> -<div class="line"></div> -<div class="line"> <span class="comment">// Enable Core Debug via DHCSR</span></div> -<div class="line"> Write32(DHCSR_Addr, 0xA05F0001);</div> -<div class="line"> </block></div> -<div class="line"> </div> -<div class="line"></sequence></div> -</div><!-- fragment --><h2><a class="anchor" id="debugCoreStop"></a> -DebugCoreStop</h2> -<p>Un-initialize core debug system.</p> -<div class="fragment"><div class="line"><sequence name=<span class="stringliteral">"DebugCoreStop"</span>></div> -<div class="line"></div> -<div class="line"> <block></div> -<div class="line"> <span class="comment">// System Control Space (SCS) offset as defined in ARMv6-M/ARMv7-M.</span></div> -<div class="line"> </div> -<div class="line"> __var SCS_Addr = 0xE000E000;</div> -<div class="line"> __var DHCSR_Addr = SCS_Addr + 0xDF0;</div> -<div class="line"> __var DEMCR_Addr = SCS_Addr + 0xDFC;</div> -<div class="line"> </div> -<div class="line"> <span class="comment">// Disable Core Debug via DHCSR</span></div> -<div class="line"> Write32(DHCSR_Addr, 0xA05F0000);</div> -<div class="line"> </div> -<div class="line"> <span class="comment">// Disable DWT and ITM blocks, DebugMonitor handler,</span></div> -<div class="line"> <span class="comment">// halting debug traps, and Reset Vector Catch.</span></div> -<div class="line"> Write32(DEMCR_Addr, 0x00000000);</div> -<div class="line"> </block></div> -<div class="line"> </div> -<div class="line"></sequence></div> -</div><!-- fragment --><h2><a class="anchor" id="resetSystem"></a> -ResetSystem</h2> -<p>Execute a system-wide reset via software mechanisms.</p> -<div class="fragment"><div class="line"><sequence name=<span class="stringliteral">"ResetSystem"</span>></div> -<div class="line"></div> -<div class="line"> <block></div> -<div class="line"> <span class="comment">// System Control Space (SCS) offset as defined in ARMv6-M/ARMv7-M.</span></div> -<div class="line"></div> -<div class="line"> __var SCS_Addr = 0xE000E000;</div> -<div class="line"> __var AIRCR_Addr = SCS_Addr + 0xD0C;</div> -<div class="line"> __var DHCSR_Addr = SCS_Addr + 0xDF0;</div> -<div class="line"> </div> -<div class="line"> <span class="comment">// Execute SYSRESETREQ via AIRCR</span></div> -<div class="line"> Write32(AIRCR_Addr, 0x05FA0004);</div> -<div class="line"> </block></div> -<div class="line"></div> -<div class="line"> <!-- Reset Recovery: Wait <span class="keywordflow">for</span> DHCSR.S_RESET_ST bit to clear on read --></div> -<div class="line"> <control <span class="keywordflow">while</span>=<span class="stringliteral">"(Read32(DHCSR_Addr) &amp; 0x02000000) == 0"</span> timeout=<span class="stringliteral">"500000"</span>/></div> -<div class="line"> </div> -<div class="line"></sequence></div> -</div><!-- fragment --><h2><a class="anchor" id="resetProcessor"></a> -ResetProcessor</h2> -<p>Execute a processor reset via software mechanisms.</p> -<dl class="section note"><dt>Note</dt><dd>This Default Debug Access Sequence is empty for ARMv6-M based processors.</dd></dl> -<div class="fragment"><div class="line"><sequence name=<span class="stringliteral">"ResetProcessor"</span>></div> -<div class="line"></div> -<div class="line"> <block></div> -<div class="line"> <span class="comment">// System Control Space (SCS) offset as defined in ARMv7-M.</span></div> -<div class="line"></div> -<div class="line"> __var SCS_Addr = 0xE000E000;</div> -<div class="line"> __var AIRCR_Addr = SCS_Addr + 0xD0C;</div> -<div class="line"> __var DHCSR_Addr = SCS_Addr + 0xDF0;</div> -<div class="line"> </div> -<div class="line"> <span class="comment">// Execute VECTRESET via AIRCR</span></div> -<div class="line"> Write32(AIRCR_Addr, 0x05FA0001);</div> -<div class="line"> </block></div> -<div class="line"> </div> -<div class="line"> <!-- Reset Recovery: Wait <span class="keywordflow">for</span> DHCSR.S_RESET_ST bit to clear on read --></div> -<div class="line"> <control <span class="keywordflow">while</span>=<span class="stringliteral">"(Read32(DHCSR_Addr) &amp; 0x02000000) == 0"</span> timeout=<span class="stringliteral">"500000"</span>/></div> -<div class="line"></div> -<div class="line"></sequence></div> -</div><!-- fragment --><h2><a class="anchor" id="resetHardware"></a> -ResetHardware</h2> -<p>Execute a system-wide reset via the dedicated debugger reset line nRST.</p> -<div class="fragment"><div class="line"><sequence name=<span class="stringliteral">"ResetHardware"</span>></div> -<div class="line"> </div> -<div class="line"> <block></div> -<div class="line"> __var nReset = 0x80;</div> -<div class="line"> __var canReadPins = 0;</div> -<div class="line"> </div> -<div class="line"> <span class="comment">// Deassert nRESET line</span></div> -<div class="line"> canReadPins = (DAP_SWJ_Pins(0x00, nReset, 0) != 0xFFFFFFFF);</div> -<div class="line"> </block></div> -<div class="line"> </div> -<div class="line"> <!-- Keep reset active <span class="keywordflow">for</span> 50 ms --></div> -<div class="line"> <control <span class="keywordflow">while</span>=<span class="stringliteral">"1"</span> timeout=<span class="stringliteral">"50000"</span>/></div> -<div class="line"></div> -<div class="line"> <control <span class="keywordflow">if</span>=<span class="stringliteral">"canReadPins"</span>></div> -<div class="line"> </div> -<div class="line"> <!-- Assert nRESET line and wait max. 1s <span class="keywordflow">for</span> recovery --></div> -<div class="line"> <control <span class="keywordflow">while</span>=<span class="stringliteral">"(DAP_SWJ_Pins(nReset, nReset, 0) &amp; nReset) == 0"</span> timeout=<span class="stringliteral">"1000000"</span>/></div> -<div class="line"> </div> -<div class="line"> </control></div> -<div class="line"> </div> -<div class="line"> <control <span class="keywordflow">if</span>=<span class="stringliteral">"!canReadPins"</span>></div> -<div class="line"> </div> -<div class="line"> <block></div> -<div class="line"> <span class="comment">// Assert nRESET line</span></div> -<div class="line"> DAP_SWJ_Pins(nReset, nReset, 0);</div> -<div class="line"> </block></div> -<div class="line"> </div> -<div class="line"> <!-- Wait 100ms <span class="keywordflow">for</span> recovery <span class="keywordflow">if</span> nRESET not readable --></div> -<div class="line"> <control <span class="keywordflow">while</span>=<span class="stringliteral">"1"</span> timeout=<span class="stringliteral">"100000"</span>/></div> -<div class="line"> </div> -<div class="line"> </control></div> -<div class="line"> </div> -<div class="line"></sequence></div> -</div><!-- fragment --><h2><a class="anchor" id="resetHardwareAssert"></a> -ResetHardwareAssert</h2> -<p>Assert a system-wide reset line nRST.</p> -<div class="fragment"><div class="line"><sequence name=<span class="stringliteral">"ResetHardwareAssert"</span>></div> -<div class="line"></div> -<div class="line"> <block></div> -<div class="line"> __var nReset = 0x80;</div> -<div class="line"> </div> -<div class="line"> <span class="comment">// Deassert nRESET line to activate the hardware reset</span></div> -<div class="line"> DAP_SWJ_Pins(0, nReset, 0);</div> -<div class="line"> </block></div> -<div class="line"> </div> -<div class="line"></sequence></div> -</div><!-- fragment --><h2><a class="anchor" id="resetHardwareDeassert"></a> -ResetHardwareDeassert</h2> -<p>De-Assert a system-wide reset line nRST.</p> -<div class="fragment"><div class="line"><sequence name=<span class="stringliteral">"ResetHardwareDeassert"</span>></div> -<div class="line"></div> -<div class="line"> <block></div> -<div class="line"> __var nReset = 0x80;</div> -<div class="line"> __var canReadPins = 0;</div> -<div class="line"> </div> -<div class="line"> <span class="comment">// Assert nRESET line and check if nRESET is readable</span></div> -<div class="line"> canReadPins = (DAP_SWJ_Pins(nReset, nReset, 0) != 0xFFFFFFFF);</div> -<div class="line"> </block></div> -<div class="line"></div> -<div class="line"> <!-- Wait max. 1s <span class="keywordflow">for</span> nRESET to recover from reset <span class="keywordflow">if</span> readable--></div> -<div class="line"> <control <span class="keywordflow">if</span>=<span class="stringliteral">"canReadPins"</span> <span class="keywordflow">while</span>=<span class="stringliteral">"(DAP_SWJ_Pins(nReset, nReset, 0) &amp; nReset) == 0"</span> timeout=<span class="stringliteral">"1000000"</span>/></div> -<div class="line"> </div> -<div class="line"> <!-- Wait 100ms <span class="keywordflow">for</span> recovery <span class="keywordflow">if</span> nRESET not readable --></div> -<div class="line"> <control <span class="keywordflow">if</span>=<span class="stringliteral">"!canReadPins"</span> <span class="keywordflow">while</span>=<span class="stringliteral">"1"</span> timeout=<span class="stringliteral">"100000"</span>/></div> -<div class="line"></div> -<div class="line"></sequence></div> -</div><!-- fragment --><h2><a class="anchor" id="resetCatchSet"></a> -ResetCatchSet</h2> -<p>Configure the target to stop code execution after a reset.</p> -<div class="fragment"><div class="line"><sequence name=<span class="stringliteral">"ResetCatchSet"</span>></div> -<div class="line"></div> -<div class="line"> <block></div> -<div class="line"> <span class="comment">// System Control Space (SCS) offset as defined</span></div> -<div class="line"> <span class="comment">// in ARMv6-M/ARMv7-M. Reimplement this sequence</span></div> -<div class="line"> <span class="comment">// if the SCS is located at a different offset.</span></div> -<div class="line"></div> -<div class="line"> __var SCS_Addr = 0xE000E000;</div> -<div class="line"> __var DHCSR_Addr = SCS_Addr + 0xDF0;</div> -<div class="line"> __var DEMCR_Addr = SCS_Addr + 0xDFC;</div> -<div class="line"> __var value = 0;</div> -<div class="line"> </div> -<div class="line"> <span class="comment">// Enable Reset Vector Catch in DEMCR</span></div> -<div class="line"> value = Read32(DEMCR_Addr);</div> -<div class="line"> Write32(DEMCR_Addr, (value | 0x00000001));</div> -<div class="line"></div> -<div class="line"> <span class="comment">// Read DHCSR to clear potentially set DHCSR.S_RESET_ST bit</span></div> -<div class="line"> Read32(DHCSR_Addr);</div> -<div class="line"> </block></div> -<div class="line"></div> -<div class="line"></sequence></div> -</div><!-- fragment --><h2><a class="anchor" id="resetCatchClear"></a> -ResetCatchClear</h2> -<p>Free hardware resources allocated by ResetCatchSet.</p> -<div class="fragment"><div class="line"><sequence name=<span class="stringliteral">"ResetCatchClear"</span>></div> -<div class="line"></div> -<div class="line"> <block></div> -<div class="line"> <span class="comment">// System Control Space (SCS) offset as defined</span></div> -<div class="line"> <span class="comment">// in ARMv6-M/ARMv7-M. Reimplement this sequence</span></div> -<div class="line"> <span class="comment">// if the SCS is located at a different offset.</span></div> -<div class="line"> </div> -<div class="line"> __var SCS_Addr = 0xE000E000;</div> -<div class="line"> __var DEMCR_Addr = SCS_Addr + 0xDFC;</div> -<div class="line"> __var value = 0;</div> -<div class="line"> </div> -<div class="line"> <span class="comment">// Disable Reset Vector Catch in DEMCR</span></div> -<div class="line"> value = Read32(DEMCR_Addr);</div> -<div class="line"> Write32(DEMCR_Addr, (value &amp; (~0x00000001)));</div> -<div class="line"> </block></div> -<div class="line"> </div> -<div class="line"></sequence></div> -</div><!-- fragment --><h1><a class="anchor" id="writing_sequences"></a> -Writing debug access sequences</h1> -<p>To override a default sequence or to create a custom (default) sequence, you need to write <a class="el" href="pdsc_family_pg.html#element_sequence">sequence</a> elements. The following sections show how to use the built-in debug access syntax, expressions, and debug access functions to create custom sequences.</p> -<h2><a class="anchor" id="DebugSyntaxRules"></a> -Debug access syntax rules</h2> -<p>Debug accesses are described in <b>block</b> elements of a debug access sequence (<b>sequence</b> element). The following syntax is used for this purpose:</p> -<ul> -<li>The contents of a <b>block</b> element is a series of statements.</li> -<li>Each statement must begin in a new line and is terminated by a <span class="XML-Token">;</span> character.</li> -<li>A typical statement consists of variable, followed by a <span class="XML-Token">=</span> character and an expression, where the <span class="XML-Token">=</span> character is an assignment of the <a class="el" href="pdsc_SequenceNameEnum_pg.html#ExpressionType">expression</a> result to the variable: <div class="fragment"><div class="line">variable = expression;</div> -</div><!-- fragment --></li> -<li>Alternatively, a statement can be a sole <a class="el" href="pdsc_SequenceNameEnum_pg.html#ExpressionType">expression</a> without storing its result to a variable. <div class="fragment"><div class="line">expression;</div> -</div><!-- fragment --></li> -<li>Comments begin with two slashes (<span class="XML-Token">//</span>) and end with a linebreak: <div class="fragment"><div class="line"><span class="comment">// Whole line is a comment</span></div> -<div class="line">variable = expression; <span class="comment">// Comment appended to statement</span></div> -</div><!-- fragment --></li> -<li>Variables must be defined using the keyword <span class="XML-Token">__var</span>. The definition must include an initalization of the variable: <div class="fragment"><div class="line">__var variable = 0;</div> -</div><!-- fragment --></li> -<li>Variables can be defined only once within a scope. Scopes beging with entering a debug access sequence or a <b>control</b> element. They are extended to child <b>control</b> elements. Variables of a parent scope can be modified. Leaving a scope destroys all variables defined in it.<br/> - <b><em>block</em> elements do not begin a new scope.</b> <div class="fragment"><div class="line"><sequence name=<span class="stringliteral">"MySequence"</span>></div> -<div class="line"> </div> -<div class="line"> <block info=<span class="stringliteral">"Block 1"</span>></div> -<div class="line"> __var condvar = 1;</div> -<div class="line"> __var myvar1 = 5;</div> -<div class="line"> __var myvar2 = 0;</div> -<div class="line"> </block></div> -<div class="line"> </div> -<div class="line"> <control <span class="keywordflow">if</span>=<span class="stringliteral">"condvar"</span>></div> -<div class="line"> <block></div> -<div class="line"> <span class="comment">// __var myvar1 = 2; // Redefinition, not allowed!</span></div> -<div class="line"> __var myvar3 = 2;</div> -<div class="line"> myvar2 = myvar1 + myvar3; <span class="comment">// Assign value (5+2) = 7</span></div> -<div class="line"> </block></div> -<div class="line"> </control></div> -<div class="line"> </div> -<div class="line"> <block info=<span class="stringliteral">"Block 2"</span>></div> -<div class="line"> myvar1 = myvar2 + 1; <span class="comment">// Variable myvar1 holds the value '8' after this statement</span></div> -<div class="line"> <span class="comment">// myvar2 = myvar3; // myvar3 does not exist in this scope, not allowed!</span></div> -<div class="line"> </block></div> -<div class="line"> </div> -<div class="line"></sequence></div> -</div><!-- fragment --></li> -<li>The debug access variables <b>__dp</b>, <b>__ap</b>, and <b>__errorcontrol</b> can be modified within a debug access sequence. An assigned value is held until leaving the sequence. Calling another sequence by the <b>Sequence</b> debug access function will push their values on a sequence execution stack. The values are restored when returning from such a call.</li> -</ul> -<h2><a class="anchor" id="ExpressionType"></a> -Expression rules</h2> -<p>Expressions are used in various places to describe one of the following:</p> -<ul> -<li>A value as assigned in a <a class="el" href="pdsc_SequenceNameEnum_pg.html#DebugSyntaxRules">debug access statement</a>.</li> -<li>A condition to use in the <b>if</b> attribute of a <b>control</b> element.</li> -<li>A condition to use in the <b>while</b> attribute of a <b>control</b> element.</li> -<li>A parameter to a debug access function as described below.</li> -</ul> -<p>An expression may consist of the following:</p> -<ul> -<li>Constant numbers in decimal and hexadecimal representation (prefix <span class="XML-Token">0x</span>).</li> -<li>Arithmetic operators such as <span class="XML-Token">+</span>, <span class="XML-Token">-</span>, <span class="XML-Token">*</span>, <span class="XML-Token">/</span>, and <span class="XML-Token">%</span>.</li> -<li>Bit-arithmetic operators such as <span class="XML-Token">&</span>, <span class="XML-Token">|</span>, <span class="XML-Token">~</span>, <span class="XML-Token">^</span>, <span class="XML-Token">>></span>, and <span class="XML-Token"><<</span>.</li> -<li>Comparison-operators such as <span class="XML-Token">==</span>, <span class="XML-Token">!=</span>, <span class="XML-Token"><</span>, <span class="XML-Token">></span>, <span class="XML-Token"><=</span>, and <span class="XML-Token">>=</span>.</li> -<li>Logic operators such as <span class="XML-Token">!</span>, <span class="XML-Token">&&</span>, <span class="XML-Token">||</span>, and <span class="XML-Token">==</span>.</li> -<li>Conditional expression operations like:<div class="fragment"><div class="line">(x < y) ? a : b </div> -</div><!-- fragment --></li> -<li>Precedence of sub-expressions is indicated by brackets (<span class="XML-Token">(</span>, <span class="XML-Token">)</span>). C-like precedence applies if brackets are omitted.</li> -<li>References to <a class="el" href="pdsc_family_pg.html#DebugVars">debug access variables</a> for evaluating debug settings.</li> -<li>Calls to <a class="el" href="pdsc_SequenceNameEnum_pg.html#DebugFunctions">debug access functions</a>.</li> -</ul> -<dl class="section note"><dt>Note</dt><dd><ul> -<li>All values used in expressions resolve to 64-bit unsigned integer values.</li> -<li>All logic-operations and comparisons resolve to the value <span class="XML-Token">1</span> if true, to <span class="XML-Token">0</span> otherwise.</li> -<li>XML prohibits the use of the characters <span class="XML-Token">&</span>, <span class="XML-Token"><</span>, and <span class="XML-Token">></span>. Use the corresponding XML entity names instead: <span class="XML-Token">&amp;</span>, <span class="XML-Token">&lt;</span>, and <span class="XML-Token">&gt;</span>.</li> -</ul> -</dd></dl> -<p> </p> -<h2><a class="anchor" id="DebugFunctions"></a> -Debug access functions</h2> -<p>Debug access functions can be called in expressions in order to interact with the target device and the user. Parameters to functions can again be expressions.<br/> - By default, a debugger must abort the execution of a debug access sequence if a function call fails. However, this behavior can be controlled from a sequence by the <b>__errorcontrol</b> <a class="el" href="pdsc_family_pg.html#DebugVars">debug access variable</a>.<br/> - <br/> - The following table describes the existing debug access functions, their parameters and the debug access variables which are evaluated for the function call.</p> -<table class="cmtable" summary="ExpressionType: debug access functions"> -<tr> -<th>Function </th><th>Description </th></tr> -<tr> -<td style="white-space: nowrap"><pre>Sequence("name")</pre> </td><td><p class="starttd">Execute a debug access sequence. Calling a sequence by this function causes the modifiable debug access variables <b>__dp</b>, <b>__ap</b>, and <b>__errorcontrol</b> to be pushed on a sequence execution stack. Returning from such a call will restore the state of these variables.<br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>name: Name of the sequence to execute. It must be enclosed by quotes.</li> -</ul> -<p class="endtd"><b>Return Value:</b><br/> - Always returns <span class="XML-Token">0</span>. </p> -</td></tr> -<tr> -<td style="white-space: nowrap"><pre>Read8(addr)</pre> </td><td><p class="starttd">Read an 8-bit value from target memory. <b>A device must support native 8-bit memory accesses for this function to succeed.</b><br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>addr: Memory address to read from.</li> -</ul> -<p><b>Debug Access Variables:</b><br/> -</p> -<ul> -<li>__dp: The debug port to use for this memory access.</li> -<li>__ap: The access port to use for this memory access.</li> -</ul> -<p class="endtd"><b>Return Value:</b><br/> - The 8-bit value as read from target memory. </p> -</td></tr> -<tr> -<td style="white-space: nowrap"><pre>Read16(addr)</pre> </td><td><p class="starttd">Read an 16-bit value from target memory. <b>A device must support native 16-bit memory accesses for this function to succeed.</b><br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>addr: Memory address to read from.</li> -</ul> -<p><b>Debug Access Variables:</b><br/> -</p> -<ul> -<li>__dp: The debug port to use for this memory access.</li> -<li>__ap: The access port to use for this memory access.</li> -</ul> -<p class="endtd"><b>Return Value:</b><br/> - The 16-bit value as read from target memory. </p> -</td></tr> -<tr> -<td style="white-space: nowrap"><pre>Read32(addr)</pre> </td><td><p class="starttd">Read an 32-bit value from target memory. <b>A device must support native 32-bit memory accesses for this function to succeed.</b><br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>addr: Memory address to read from.</li> -</ul> -<p><b>Debug Access Variables:</b><br/> -</p> -<ul> -<li>__dp: The debug port to use for this memory access.</li> -<li>__ap: The access port to use for this memory access.</li> -</ul> -<p><b>Return Value:</b><br/> - The 32-bit value as read from target memory.</p> -<p class="endtd"><b>Code Example:</b><br/> - Refer to <a class="el" href="pdsc_SequenceNameEnum_pg.html#resetSystem">ResetSystem</a> </p> -</td></tr> -<tr> -<td style="white-space: nowrap"><pre>Read64(addr)</pre> </td><td><p class="starttd">Read an 64-bit value from target memory. <b>A device must support native 64-bit memory accesses for this function to succeed.</b><br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>addr: Memory address to read from.</li> -</ul> -<p><b>Debug Access Variables:</b><br/> -</p> -<ul> -<li>__dp: The debug port to use for this memory access.</li> -<li>__ap: The access port to use for this memory access.</li> -</ul> -<p class="endtd"><b>Return Value:</b><br/> - The 64-bit value as read from target memory. </p> -</td></tr> -<tr> -<td style="white-space: nowrap"><pre>ReadAP(addr)</pre> </td><td><p class="starttd">Read a 32-bit value from an access port register.<br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>addr: AP register address to read from. Addresses larger than <span class="XML-Token">0xF</span> automatically cause an AP register bank switch.</li> -</ul> -<p><b>Debug Access Variables:</b><br/> -</p> -<ul> -<li>__dp: The debug port to use for this memory access.</li> -<li>__ap: The access port to use for this memory access.</li> -</ul> -<p class="endtd"><b>Return Value:</b><br/> - The 32-bit value as read from the AP register. </p> -</td></tr> -<tr> -<td style="white-space: nowrap"><pre>ReadDP(addr)</pre> </td><td><p class="starttd">Read a 32-bit value from a debug port register.<br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>addr: DP register address to read from.</li> -</ul> -<p><b>Debug Access Variables:</b><br/> -</p> -<ul> -<li>__dp: The debug port to use for this memory access.</li> -</ul> -<p><b>Return Value:</b><br/> - The 32-bit value as read from the DP register.</p> -<p class="endtd"><b>Code Example:</b><br/> - Refer to <a class="el" href="pdsc_SequenceNameEnum_pg.html#debugPortSetup">DebugPortSetup</a> </p> -</td></tr> -<tr> -<td style="white-space: nowrap"><pre>Write8(addr, val)</pre> </td><td><p class="starttd">Write an 8-bit value to target memory. <b>A device must support native 8-bit memory accesses for this function to succeed.</b><br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>addr: Memory address to write to.</li> -<li>val: Value to write.</li> -</ul> -<p><b>Debug Access Variables:</b><br/> -</p> -<ul> -<li>__dp: The debug port to use for this memory access.</li> -<li>__ap: The access port to use for this memory access.</li> -</ul> -<p class="endtd"><b>Return Value:</b><br/> - Always returns <span class="XML-Token">0</span>. </p> -</td></tr> -<tr> -<td style="white-space: nowrap"><pre>Write16(addr, val)</pre> </td><td><p class="starttd">Write a 16-bit value to target memory. <b>A device must support native 16-bit memory accesses for this function to succeed.</b><br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>addr: Memory address to write to.</li> -<li>val: Value to write.</li> -</ul> -<p><b>Debug Access Variables:</b><br/> -</p> -<ul> -<li>__dp: The debug port to use for this memory access.</li> -<li>__ap: The access port to use for this memory access.</li> -</ul> -<p class="endtd"><b>Return Value:</b><br/> - Always returns <span class="XML-Token">0</span>. </p> -</td></tr> -<tr> -<td style="white-space: nowrap"><pre>Write32(addr, val)</pre> </td><td><p class="starttd">Write a 32-bit value to target memory. <b>A device must support native 32-bit memory accesses for this function to succeed.</b><br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>addr: Memory address to write to.</li> -<li>val: Value to write.</li> -</ul> -<p><b>Debug Access Variables:</b><br/> -</p> -<ul> -<li>__dp: The debug port to use for this memory access.</li> -<li>__ap: The access port to use for this memory access.</li> -</ul> -<p><b>Return Value:</b><br/> - Always returns <span class="XML-Token">0</span>.</p> -<p class="endtd"><b>Code Example:</b><br/> - Refer to <a class="el" href="pdsc_SequenceNameEnum_pg.html#debugCoreStart">DebugCoreStart</a> </p> -</td></tr> -<tr> -<td style="white-space: nowrap"><pre>Write64(addr, val)</pre> </td><td><p class="starttd">Write a 64-bit value to target memory. <b>A device must support native 64-bit memory accesses for this function to succeed.</b><br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>addr: Memory address to write to.</li> -<li>val: Value to write.</li> -</ul> -<p><b>Debug Access Variables:</b><br/> -</p> -<ul> -<li>__dp: The debug port to use for this memory access.</li> -<li>__ap: The access port to use for this memory access.</li> -</ul> -<p class="endtd"><b>Return Value:</b><br/> - Always returns <span class="XML-Token">0</span>. </p> -</td></tr> -<tr> -<td style="white-space: nowrap"><pre>WriteAP(addr, val)</pre> </td><td><p class="starttd">Write a 32-bit value to an access port register. Addresses larger than 0xF automatically cause an AP register bank switch.<br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>addr: Memory address to write to.</li> -<li>val: Value to write.</li> -</ul> -<p><b>Debug Access Variables:</b><br/> -</p> -<ul> -<li>__dp: The debug port to use for this memory access.</li> -<li>__ap: The access port to use for this memory access.</li> -</ul> -<p class="endtd"><b>Return Value:</b><br/> - Always returns <span class="XML-Token">0</span>. </p> -</td></tr> -<tr> -<td style="white-space: nowrap"><pre>WriteDP(addr, val)</pre> </td><td><p class="starttd">Write a 32-bit value to a debug port register.<br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>addr: Memory address to write to.</li> -<li>val: Value to write.</li> -</ul> -<p><b>Debug Access Variables:</b><br/> -</p> -<ul> -<li>__dp: The debug port to use for this memory access.</li> -</ul> -<p><b>Return Value:</b><br/> - Always returns <span class="XML-Token">0</span>.</p> -<p class="endtd"><b>Code Example:</b><br/> - Refer to <a class="el" href="pdsc_SequenceNameEnum_pg.html#debugPortStart">DebugPortStart</a> </p> -</td></tr> -<tr> -<td style="white-space: nowrap"><pre>DAP_Delay(delay)</pre> </td><td><p class="starttd">Debug probe command to wait for a specific delay.<br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>delay: Wait time in microseconds.</li> -</ul> -<p class="endtd"><b>Return Value:</b><br/> - Always returns <span class="XML-Token">0</span>. </p> -</td></tr> -<tr> -<td style="white-space: nowrap"><pre>DAP_WriteABORT(value)</pre> </td><td><p class="starttd">Debug probe command to write an abort request to the CoreSight ABORT register of the target debug port.<br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>value: 32-bit value to write into the CoreSight ABORT register.</li> -</ul> -<p><b>Debug Access Variables:</b><br/> -</p> -<ul> -<li>__dp: The debug port to use for this memory access.</li> -</ul> -<p class="endtd"><b>Return Value:</b><br/> - Always returns <span class="XML-Token">0</span>. </p> -</td></tr> -<tr> -<td style="white-space: nowrap"><pre>DAP_SWJ_Pins(pinout, pinselect, pinwait)</pre> </td><td><p class="starttd">Debug proble command to monitor and control the I/O Pins including the nRESET device reset line.<br/> - <b>I/O Pin Mapping</b> for <b>pinout</b>, <b>pinselect</b>, and <b>pinwait</b>:</p> -<ul> -<li>Bit 0: SWCLK/TCK</li> -<li>Bit 1: SWDIO/TMS</li> -<li>Bit 2: TDI</li> -<li>Bit 3: TDO</li> -<li>Bit 5: nTRST</li> -<li>Bit 7: nRESET</li> -</ul> -<p><br/> - The <b>pinwait</b> time is useful in systems where the nRESET pin is implemented as open-drain output. After nRESET is de-asserted by the debugger, external circuit may still hold the target Device under reset for a time. Using the <b>pinwait</b> time, the debugger may monitor selected I/O Pins and wait until they the expected value appears or a timeout expires.<br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>pinout: Value for selected output pins.</li> -<li>pinselect: Selects which output pins will be modified.</li> -<li>pinwait: Wait timeout for the selected output to stabilize. A debugger must extend this timeout to the closest possible time granularity.<ul> -<li>0 = no wait</li> -<li>1 .. 3000000 = time in microseconds (max 3s)</li> -</ul> -</li> -</ul> -<p class="endtd"><b>Return Value:</b><br/> - The state of the I/O Pins at the end of this operation. If a debugger is not capable of monitoring the I/O Pins, it must return a value of <span class="XML-Token">0xFFFFFFFF</span>. </p> -</td></tr> -<tr> -<td style="white-space: nowrap"><pre>DAP_SWJ_Clock(val)</pre> </td><td><p class="starttd">Debug probe command to set the clock frequency for JTAG and SWD communication mode.<br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>val: Maximum SWD/JTAG Clock (SWCLK/TCK) value in Hz.</li> -</ul> -<p><b>Return Value:</b><br/> - Always returns <span class="XML-Token">0</span>.</p> -<p class="endtd"><b>Code Example:</b><br/> - Refer to <a class="el" href="pdsc_SequenceNameEnum_pg.html#resetHardware">ResetHardware</a> </p> -</td></tr> -<tr> -<td style="white-space: nowrap"><pre>DAP_SWJ_Sequence(cnt, val)</pre> </td><td><p class="starttd">Debug probe command to generate required SWJ sequences, e.g. for SWD/JTAG Reset, SWD<->JTAG switch and Dormant operation.<br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>cnt: Number of bits in sequence: 1..64. Larger sequences need to be implemented by multiple subsequent <b>DAP_SWJ_Sequence</b> calls. Such a sequence of <b>DAP_SWJ_Sequence</b> commands must be encapsulated in an atomic <b>block</b> to ensure correct execution.</li> -<li>val: Sequence generated on SWDIO/TMS (with clock @SWCLK/TCK), LSB transmitted first.</li> -</ul> -<p><b>Return Value:</b><br/> - Always returns <span class="XML-Token">0</span>.</p> -<p class="endtd"><b>Code Example:</b><br/> - Refer to <a class="el" href="pdsc_SequenceNameEnum_pg.html#debugPortSetup">DebugPortSetup</a> </p> -</td></tr> -<tr> -<td style="white-space: nowrap"><pre>DAP_JTAG_Sequence(cnt, tms, tdi)</pre> </td><td><p class="starttd">Debug probe command to generate a JTAG sequence with fixed TMS value and capture TDO.<br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>cnt: Length of the JTAG sequence (number of TCK cycles and TDI bits): 1..64</li> -<li>tms: Fixed TMS value: 0..1</li> -<li>tdi: Data generated on TDI with one bit per TCK cycle, LSB transmitted first.</li> -</ul> -<p class="endtd"><b>Return Value:</b><br/> - Data captured from TDO with one bit per TCK cycle, LSB captured first and padded with <span class="XML-Token">0</span>s. </p> -</td></tr> -<tr> -<td style="white-space: nowrap"><pre>Query(type, "message", default)</pre> </td><td><p class="starttd">Query user input. The sequence execution stalls depending on the used <b>type</b>. If the debugger runs in a batch mode, this function returns the value <b>default</b>.<br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>type: Query type. Can be one of:<ul> -<li><span class="XML-Token">0</span> : <b>Query_Ok</b>, displays an informative message which has to be confirmed by the user. This type allows the result <b>OK</b>.</li> -<li><span class="XML-Token">1</span> : <b>Query_YesNo</b>, displays a query with the allowed results <b>Yes</b> and <b>No</b>.</li> -<li><span class="XML-Token">2</span> : <b>Query_YesNoCancel</b>, displays a query with the allowed results <b>Yes</b>, <b>No</b>, and <b>Cancel</b>.</li> -<li><span class="XML-Token">3</span> : <b>Query_OkCancel</b>, displays a query with the allowed results <b>OK</b> and <b>Cancel</b>.</li> -</ul> -</li> -<li>message: A constant string with the query message to display. It must not be an expression and it must be enclosed by quotes.</li> -<li>default: The default value to return if the debugger runs in batch mode. See <b>Return Values</b> for a list of allowed values.</li> -</ul> -<p><b>Return Value:</b><br/> - The result of the query. The user input maps to the following numbers:</p> -<ul> -<li>Error : <span class="XML-Token">0</span></li> -<li>OK : <span class="XML-Token">1</span></li> -<li>Cancel : <span class="XML-Token">2</span></li> -<li>Yes : <span class="XML-Token">3</span></li> -<li>No : <span class="XML-Token">4</span></li> -</ul> -<p class="endtd"><b>Code Example:</b><br/> - Refer to <a class="el" href="pdsc_SequenceNameEnum_pg.html#debugPortSetup">DebugPortSetup</a> </p> -</td></tr> -<tr> -<td style="white-space: nowrap"><pre>QueryValue("message", default)</pre> </td><td><p class="starttd">Query input value from user. The sequence execution stalls until the user has entered a value or canceled the query. This function returns the <b>default</b> value if the user canceled the query or if the debugger runs in a batch mode.<br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>message: A constant string with the query message to display. It must not be an expression and it must be enclosed by quotes.</li> -<li>default: The default value to return if the user cancels the query or if the debugger runs in batch mode.</li> -</ul> -<p><b>Return Value:</b><br/> - The queried value.</p> -<p class="endtd"></p> -</td></tr> -<tr> -<td style="white-space: nowrap"><pre>Message(type, "format", ...)</pre> </td><td><p class="starttd">Outputs a message to a log window.<br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>type: Message type. Can be one of:<ul> -<li><span class="XML-Token">0</span> : <b>Info</b>, outputs an informative message.</li> -<li><span class="XML-Token">1</span> : <b>Warning</b>, outputs a warning.</li> -<li><span class="XML-Token">2</span> : <b>Error</b>, outputs an error. Sequence execution aborts.</li> -</ul> -</li> -<li>format: A constant string with the message format. It must not be an expression and it must be enclosed by quotes. The string has the following format:<br/> - <div class="fragment"><div class="line">%[flags][width][.precision]specifier</div> -</div><!-- fragment --><ul> -<li>Specifiers:<ul> -<li><span class="XML-Token">%u</span>: 32-bit unsigned decimal integer.</li> -<li><span class="XML-Token">%llu</span>: 64-bit unsigned decimal integer.</li> -<li><span class="XML-Token">%x</span>: 32-bit unsigned hexadecimal integer, lower case letters.</li> -<li><span class="XML-Token">%llx</span>: 64-bit unsigned hexadecimal integer, lower case letters.</li> -<li><span class="XML-Token">%X</span>: 32-bit unsigned hexadecimal integer, upper case letters.</li> -<li><span class="XML-Token">%llX</span>: 64-bit unsigned hexadecimal integer, upper case letters.</li> -<li><span class="XML-Token">%o</span>: 32-bit unsigned octal integer.</li> -<li><span class="XML-Token">%llo</span>: 64-bit unsigned octal integer.</li> -<li><span class="XML-Token">%b</span>: 32-bit unsigned binary integer.</li> -<li><span class="XML-Token">%llb</span>: 64-bit unsigned binary integer.</li> -<li><span class="XML-Token">%f</span>: Single-precision (32-bit) floating point value.</li> -<li><span class="XML-Token">%Lf</span>: Double-precision (64-bit) floating point value.</li> -<li><span class="XML-Token">%s</span>: Constant character string. Must not be an expression.</li> -<li><span class="XML-Token">%%</span>: Print <span class="XML-Token">%</span> character.</li> -</ul> -</li> -<li>Flags:<ul> -<li><span class="XML-Token">0</span>: Pad the displayed value with zeros instead of spaces if padding is required by the <span class="XML-Token">width</span> option.</li> -</ul> -</li> -<li>Width: Minimum number of displayed characters. If <span class="XML-Token">width</span> is less than the number of characters of the value, then the value is padded with spaces to the left.</li> -<li>.Precision:<ul> -<li><b>Integer</b>: Minimum number of displayed digits. Padded with zeros to the left if the value has less digits than specified with <span class="XML-Token">.precision</span>.</li> -<li><b>Floating Point</b>: Number of displayed digits after decimal point. Defaults to <span class="XML-Token">6</span> if not specified.</li> -<li><b>Constant String</b>: Maximum number of displayed characters.</li> -</ul> -</li> -</ul> -</li> -<li>... : Additional function parameters to replace format string specifiers. Each parameter can be a constant string, or an expression that resolves to an unsigned 64-bit integer. A parameter type must match the corresponding specifier type.</li> -</ul> -<p><b>Return Value:</b><br/> - Always returns <span class="XML-Token">0</span>.</p> -<dl class="section note"><dt>Note</dt><dd>For 32-bit specifiers the <b>Message</b> command must print the lower 32 Bit of a 64 Bit debug access variable.</dd></dl> -</td></tr> -<tr> -<td style="white-space: nowrap"><pre>LoadDebugInfo("file")</pre> </td><td><p class="starttd">Loads DWARF debug information from an application executable.<br/> - <br/> - <b>Parameters:</b><br/> -</p> -<ul> -<li>file: A constant string with the path to the executable. The path must be relative to the root folder of the pack and use the format <b>path/name.extension</b>. It must not be an expression and it must be enclosed by quotes.</li> -</ul> -<p><b>Return Value:</b><br/> - Returns <span class="XML-Token">0</span> after successful debug information load.<br/> - Returns <span class="XML-Token">1</span> if debug information load failed.</p> -<p class="endtd"></p> -</td></tr> -</table> -<dl class="section note"><dt>Note</dt><dd><ul> -<li>Target memory access functions must perform a debug access of the size indicated by their name. The target system must support debug accesses of this size.</li> -<li>Results of all functions are casted to 64-bit unsigned integer values.</li> -<li>Some target access functions determine the used debug and access port by the current values of the <b>__dp</b> and <b>__ap</b> debug access variables. If a target access requires a different debug or access port than the default ones, it must change these values. This change is held until finishing the sequence the change has occurred in. </li> -</ul> -</dd></dl> -</div></div><!-- contents --> -</div><!-- doc-content --> -<!-- start footer part --> -<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> - <ul> - <li class="navelem"><a class="el" href="coresight_setup.html">Simplifying debug setup using debug descriptions</a></li> - <li class="footer">Generated on Wed Feb 8 2017 10:21:01 for CMSIS-Pack by ARM Ltd. All rights reserved. - <!-- - <a href="http://www.doxygen.org/index.html"> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 - --> - </li> - </ul> -</div> -</body> -</html> diff --git a/docs/Pack/html/pdsc_apis_pg.html b/docs/Pack/html/pdsc_apis_pg.html index 900631f..94e91b1 100644 --- a/docs/Pack/html/pdsc_apis_pg.html +++ b/docs/Pack/html/pdsc_apis_pg.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -173,6 +173,8 @@ $(document).ready(function(){initNavTree('pdsc_apis_pg.html','');}); <tr> <td>exclusive </td><td>Makes the selection of a component implementing the API exclusive. If set to <span class="XML-Token">0</span>, then multiple components implementing the API can be selected. Default is <span class="XML-Token">1</span>. </td><td>xs:boolean </td><td>optional </td></tr> <tr> +<td>condition </td><td>Enter the identifier (attribute <em><b>id</b></em>) of a <a class="el" href="pdsc_conditions_pg.html#element_condition">condition</a>. The element is used if the condition resolves to <span class="XML-Token">true</span>. If the condition resolves to <span class="XML-Token">false</span>, then the element will be ignored. For example, an API might be specific for a certain toolchain or processor instruction set. </td><td>xs:string </td><td>optional </td></tr> +<tr> <td>Capiversion </td><td>Version of this component. Is a mandatory part of the component ID. The version format is described in <a class="el" href="pdsc_package_pg.html#VersionType">Version Type</a>. </td><td>VersionType </td><td>optional </td></tr> <tr> <th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> @@ -188,7 +190,7 @@ $(document).ready(function(){initNavTree('pdsc_apis_pg.html','');}); <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="packFormat.html">Pack Description (*.pdsc) Format</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/pdsc_boards_pg.html b/docs/Pack/html/pdsc_boards_pg.html index 274f14e..47dd9ad 100644 --- a/docs/Pack/html/pdsc_boards_pg.html +++ b/docs/Pack/html/pdsc_boards_pg.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -495,7 +495,7 @@ $(document).ready(function(){initNavTree('pdsc_boards_pg.html','');}); <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="packFormat.html">Pack Description (*.pdsc) Format</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:01 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/pdsc_components_pg.html b/docs/Pack/html/pdsc_components_pg.html index ac5c62e..a4732e8 100644 --- a/docs/Pack/html/pdsc_components_pg.html +++ b/docs/Pack/html/pdsc_components_pg.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -245,7 +245,15 @@ RTE_Components.h</h1> <div class="line"><span class="preprocessor"></span><span class="preprocessor">#define RTE_Network_Socket_UDP </span><span class="comment">/* Network Socket UDP */</span><span class="preprocessor"></span></div> <div class="line"><span class="preprocessor"></span> </div> <div class="line"><span class="preprocessor">#endif </span><span class="comment">/* RTE_COMPONENTS_H */</span><span class="preprocessor"></span></div> -</div><!-- fragment --><p>The typical usage of the <b>RTE_Components.h</b> file is in header files to control for example the inclusion of files that are related to other components for the same Software Pack.</p> +</div><!-- fragment --><p>The <b>RTE_Components.h</b> file allows to create software that works with any supported device as it gives access to the <b>CMSIS_device_header</b>. The <b>CMSIS_device_header</b> reflects the current selected device and gives you for example access to the processor configuration. Refer to <b>"Device Header File <device.h>"</b> in <a href="../../Core/html/device_h_pg.html"><b>CMSIS-Core(M)</b></a> or <a href="../../Core_A/html/device_h_pg.html"><b>CMSIS-Core(A)</b></a> for more information.</p> +<div class="fragment"><div class="line"><span class="preprocessor">#include CMSIS_device_header </span><span class="comment">/* header file of the selected device in the project */</span><span class="preprocessor"></span></div> +<div class="line"><span class="preprocessor"></span></div> +<div class="line"><span class="preprocessor">#if (defined (__MPU_PRESENT)) && (__MPU_PRESENT == 1)</span></div> +<div class="line"><span class="preprocessor"></span> <span class="comment">// device has MPU, start the related code</span></div> +<div class="line"><span class="preprocessor">#else</span></div> +<div class="line"><span class="preprocessor"></span><span class="preprocessor"> #error "Software Component requires a device with MPU"</span></div> +<div class="line"><span class="preprocessor">#endif</span></div> +</div><!-- fragment --><p>Another typical usage of the <b>RTE_Components.h</b> file is in header files to control for example the inclusion of files that are related to other components for the same Software Pack.</p> <div class="fragment"><div class="line"><span class="preprocessor">#include "RTE_Components.h"</span></div> <div class="line"> </div> <div class="line"><span class="preprocessor">#ifdef RTE_Network_Interface_ETH_0 // generated when software component Network Interface ETH 0 is included</span></div> @@ -253,6 +261,45 @@ RTE_Components.h</h1> <div class="line"><span class="preprocessor">#endif</span></div> </div><!-- fragment --><p> </p> <hr/> +<h1><a class="anchor" id="Pre_Include_Global_h"></a> +Pre_Include_Global_h</h1> +<p>The build environment shall generate a C/C++ header file with the name <b>Pre_Include_Global.h</b> from all selected components and add this file to the command line as a pre-include file for the build of all modules in the project. Note: the file shall be generated into the RTE/<target> subdirectory.</p> +<div class="fragment"><div class="line"><component Cclass=<span class="stringliteral">"Other"</span> Cgroup=<span class="stringliteral">"Alpha"</span> ...></div> +<div class="line"> <Pre_Include_Global_h></div> +<div class="line"> <span class="comment">// enabling global pre include</span></div> +<div class="line"><span class="preprocessor"> #define GLOBAL_Component_Alpha 0x4</span></div> +<div class="line"><span class="preprocessor"></span> </Pre_Include_Global_h></div> +<div class="line"></component></div> +<div class="line"></div> +<div class="line"><component Cclass=<span class="stringliteral">"Other"</span> Cgroup=<span class="stringliteral">"Beta"</span> ...></div> +<div class="line"> <Pre_Include_Global_h></div> +<div class="line"> <span class="comment">// enabling global pre include</span></div> +<div class="line"><span class="preprocessor"> #define GLOBAL_Component_Beta 0x8</span></div> +<div class="line"><span class="preprocessor"></span> </Pre_Include_Global_h></div> +<div class="line"></component></div> +</div><!-- fragment --><p>results in .../RTE/target_1/Pre_Include_Global.h: </p> +<div class="fragment"><div class="line"><span class="comment">// enabling global pre include</span></div> +<div class="line"><span class="preprocessor">#define GLOBAL_Component_Alpha 0x4</span></div> +<div class="line"><span class="preprocessor"></span><span class="comment">// enabling global pre include</span></div> +<div class="line"><span class="preprocessor">#define GLOBAL_Component_Beta 0x8</span></div> +</div><!-- fragment --><p>No need to explicitly include this file as it is automatically added as pre-include into the build for all modules.</p> +<p> </p> +<hr/> +<h1><a class="anchor" id="Pre_Include_Local_h"></a> +Pre_Include_Local_h</h1> +<p>The build environment shall generate a C/C++ header file with the name <b>Pre_Include_<Cclass>_<component>.h</b> from the selected component and add this file to the command line as a pre-include file for the build of all modules of this component. The same is done for each component containing a "Pre_Include_Local_h" element. Note: files shall be generated into the RTE/<target> subdirectory.</p> +<div class="fragment"><div class="line"><component Cclass=<span class="stringliteral">"Other"</span> Cgroup=<span class="stringliteral">"Alpha"</span> ...></div> +<div class="line"> <Pre_Include_Local_h></div> +<div class="line"> <span class="comment">// enabling local pre include</span></div> +<div class="line"><span class="preprocessor"> #define Local_Component_Alpha 1</span></div> +<div class="line"><span class="preprocessor"></span> </Pre_Include_Local_h></div> +<div class="line"></component></div> +</div><!-- fragment --><p>results in .../RTE/target_1/Pre_Include_Other_Alpha.h: </p> +<div class="fragment"><div class="line"><span class="comment">// enabling local pre include</span></div> +<div class="line"><span class="preprocessor">#define Local_Component_Alpha 1</span></div> +</div><!-- fragment --><p>No need to explicitly include this file as it is automatically added as pre-include into the build for all modules of component Other:Alpha.</p> +<p> </p> +<hr/> <h1><a class="anchor" id="element_components"></a> /package/components</h1> <p>Grouping element containing a choice of at least one bundle or component. No more than one element <em>components</em> can exist in a Pack.</p> @@ -349,7 +396,13 @@ RTE_Components.h</h1> <tr> <td>description </td><td>Brief description of the component. </td><td>xs:string </td><td>1..1 </td></tr> <tr> -<td>RTE_Components_h </td><td>Source code that is copied into the file <a class="el" href="pdsc_components_pg.html#RTE_Components_h">RTE_Components.h</a> when the component is included into a software project. </td><td>xs:string </td><td>0..1 </td></tr> +<td>RTE_Components_h </td><td>Source code that is copied into the file <a class="el" href="pdsc_components_pg.html#RTE_Components_h">RTE_Components.h</a> when the component is selected by the run time environment configuration. </td><td>xs:string </td><td>0..1 </td></tr> +<tr> +<td>Pre_Include_Global_h </td><td>Source code that is copied into the file <a class="el" href="pdsc_components_pg.html#Pre_Include_Global_h">Pre_Include_Global_h</a> when the component is selected by the run time environment configuration. </td><td>xs:string </td><td>0..1 </td></tr> +<tr> +<td>Pre_Include_Local_Component_h </td><td>Source code that is copied into the file <a class="el" href="pdsc_components_pg.html#Pre_Include_Local_h">Pre_Include_Local_h</a> <Cclass>_<Component_name>.h when the component is selected by the run time environment configuration. </td><td>xs:string </td><td><p class="starttd">0..1 </p> +<p class="endtd"></p> +</td></tr> <tr> <td><a class="el" href="pdsc_components_pg.html#element_files">files</a> </td><td>Grouping element for all files that are part of this component. </td><td>group </td><td>1 </td></tr> </table> @@ -451,9 +504,11 @@ RTE_Components.h</h1> <tr> <td>name </td><td>File path, file name, and file extension in the format <b>path/name.extension</b>. The file path is relative to the root directory of the Pack. </td><td>xs:string </td><td>required </td></tr> <tr> -<td>category </td><td>Defines the purpose of the file. Select the predefined value as listed in the table <a class="el" href="pdsc_components_pg.html#FileCategoryEnum">File Categories</a>. </td><td>FileCategoryEnum </td><td>required </td></tr> +<td>path </td><td>for <b>category="header"</b> the path attribute explicitly can be used to specify the include path to be added to the commandline of the build tools, specifying an imcomplete path. This way the include file requires the specification of the subdirectory (e.g. #include "sub_dir/includeFile.h") which can act as acting as namespace for header files which otherwise have the same name. </td><td>xs:string </td><td>optional </td></tr> <tr> -<td>attr </td><td>Defines the special use and handling of a file. Select a predefined value as defined in the table <a class="el" href="pdsc_components_pg.html#FileAttributeEnum">File Attributes</a>. </td><td>FileAttributeEnum </td><td>optional </td></tr> +<td>category </td><td>Defines the purpose of the file. Select the predefined value as listed in the table <a class="el" href="pdsc_components_pg.html#FileCategoryEnum">File Categories</a>. </td><td><a class="el" href="pdsc_components_pg.html#FileCategoryEnum">FileCategoryEnum</a> </td><td>required </td></tr> +<tr> +<td>attr </td><td>Defines the special use and handling of a file. Select a predefined value as defined in the table <a class="el" href="pdsc_components_pg.html#FileAttributeEnum">File Attributes</a>. </td><td><a class="el" href="pdsc_components_pg.html#FileAttributeEnum">FileAttributeEnum</a> </td><td>optional </td></tr> <tr> <td>condition </td><td>Enter the identifier (attribute <em><b>id</b></em>) of a <a class="el" href="pdsc_conditions_pg.html#element_condition">condition</a>. The element is used if the condition resolves to <span class="XML-Token">true</span>. If the condition resolves to <span class="XML-Token">false</span>, then the element will be ignored. For example, a library might be specific for a certain toolchain or processor instruction set. </td><td>xs:string </td><td>optional </td></tr> <tr> @@ -472,7 +527,7 @@ RTE_Components.h</h1> <tr> <th>attr= </th><th>Description </th></tr> <tr> -<td class="XML-Token">config </td><td>The file is a configuration file of the component. It is expected that only configuration options are modified. The file is managed as part of the component, as a project-specific file typically copied into the component section of the project. </td></tr> +<td class="XML-Token">config </td><td>The file is a configuration file of the component. It is expected that only configuration options are modified. The file is managed as part of the component, as a project-specific file typically copied into the component section of the project.s </td></tr> <tr> <td class="XML-Token">template </td><td><p class="starttd">The file is used as a source code template file. It is expected to be edited and extended by the software developer. The file can be copied into a user section of the project. </p> <p class="endtd"></p> @@ -496,9 +551,9 @@ RTE_Components.h</h1> <tr> <td class="XML-Token">doc </td><td>Documentation </td></tr> <tr> -<td class="XML-Token">header </td><td>Header file used in the component. Sets an include file path. </td></tr> +<td class="XML-Token">header </td><td>Header file used in the component. Sets an include file path and adds the file name attribute to the list of files to be added to a module using the <b>#include</b> statement. Note: specify only those files as header files that form part of the API of the component, required to use the component </td></tr> <tr> -<td class="XML-Token">include </td><td>Sets an include file path. </td></tr> +<td class="XML-Token">include </td><td>Sets an include file path. Note: ensure that the name attribute specifies a directory and ends with a '/'. </td></tr> <tr> <td class="XML-Token">library </td><td>Library file </td></tr> <tr> @@ -518,6 +573,10 @@ RTE_Components.h</h1> <tr> <td class="XML-Token">image </td><td>Files of image type are marked for special processing into a File System Image embedded into the application. This category requires the <em>attr</em> being set to <em>template</em>. </td></tr> <tr> +<td class="XML-Token">preIncludeGlobal </td><td>The specified file is added as a pre-include file to the compiler command line for all modules of the whole <b>project</b> (globally). </td></tr> +<tr> +<td class="XML-Token">preIncludeLocal </td><td>The specified file is added as a pre-include file to the compiler command line for all modules of the <b>component</b> (locally). </td></tr> +<tr> <td class="XML-Token">other </td><td>Other file types not covered in the list above </td></tr> </table> <p> </p> @@ -528,7 +587,7 @@ RTE_Components.h</h1> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="packFormat.html">Pack Description (*.pdsc) Format</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:01 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/pdsc_conditions_pg.html b/docs/Pack/html/pdsc_conditions_pg.html index c89587c..90e79c1 100644 --- a/docs/Pack/html/pdsc_conditions_pg.html +++ b/docs/Pack/html/pdsc_conditions_pg.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -218,16 +218,16 @@ $(document).ready(function(){initNavTree('pdsc_conditions_pg.html','');}); <tr> <th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> <tr> -<td>Dfamily<b>*</b> </td><td>Specifies the device family name (for example: STM32F2 Series). </td><td>xs:string </td><td>optional </td></tr> -<tr> -<td>DsubFamily<b>*</b> </td><td>Specifies the device sub-family name (for example: STM32F205 Series). </td><td>xs:string </td><td>optional </td></tr> +<td>Dvendor </td><td>Specifies the silicon vendor of the device. Use predefined values as listed in the table <a class="el" href="pdsc_family_pg.html#DeviceVendorEnum">Device Vendor</a>. </td><td>DeviceVendorEnum </td><td>optional </td></tr> <tr> -<td>Dvariant<b>*</b> </td><td>Specifies the variant name of a device (for example: Step A). </td><td>xs:string </td><td>optional </td></tr> +<td>Dfamily<b>*</b> </td><td><b>DEPRECATED**</b> Specifies the device family name (for example: STM32F2 Series). </td><td>xs:string </td><td>optional </td></tr> <tr> -<td>Dvendor </td><td>Specifies the silicon vendor of the device. Use predefined values as listed in the table <a class="el" href="pdsc_family_pg.html#DeviceVendorEnum">Device Vendor</a>. </td><td>DeviceVendorEnum </td><td>optional </td></tr> +<td>DsubFamily<b>*</b> </td><td><b>DEPRECATED**</b>Specifies the device sub-family name (for example: STM32F205 Series). </td><td>xs:string </td><td>optional </td></tr> <tr> <td>Dname<b>*</b> </td><td>Specifies the name of the device. </td><td>xs:string </td><td>optional </td></tr> <tr> +<td>Dvariant<b>*</b> </td><td><b>DEPRECATED**</b>Specifies the variant name of a device (for example: Step A). </td><td>xs:string </td><td>optional </td></tr> +<tr> <td>Pname </td><td>Specifies the processor instance in case of multi processor devices. This allows to describe distinct conditions for a specific processor. </td><td>xs:string </td><td>optional </td></tr> <tr> <td>Dcore </td><td>Specifies a processor core. Use predefined values as listed in the table <a class="el" href="pdsc_family_pg.html#DcoreEnum">Device Cores</a>. </td><td>DcoreEnum </td><td>optional </td></tr> @@ -289,6 +289,11 @@ $(document).ready(function(){initNavTree('pdsc_conditions_pg.html','');}); <li>'?' matches any single character</li> <li>[abc] matches any character in the set (a,b,c)</li> </ul> +<p><b>**)</b> These attributes must not be used in conditions because</p> +<ul> +<li>'Dfamily' and 'DsubFamily' turn out to be volatile.</li> +<li>conditions shall only filter for selectable devices. 'Dvariant'effectively is just an alias for 'Dname'. Once a <variant> tag exists, the <device> tag no longer represents a selectable device.</li> +</ul> <p> </p> <p><a class="anchor" id="CompilerEnumType"></a><b>Table: Compiler Types</b></p> <p>The tale list values representing a C/C++ compiler toolchains from a specific tool vendor. The tokens can be used in the elements:</p> @@ -321,7 +326,7 @@ $(document).ready(function(){initNavTree('pdsc_conditions_pg.html','');}); <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="packFormat.html">Pack Description (*.pdsc) Format</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/pdsc_devices_pg.html b/docs/Pack/html/pdsc_devices_pg.html index 19ddc5e..02a7ab7 100644 --- a/docs/Pack/html/pdsc_devices_pg.html +++ b/docs/Pack/html/pdsc_devices_pg.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -240,7 +240,7 @@ $(document).ready(function(){initNavTree('pdsc_devices_pg.html','');}); <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="packFormat.html">Pack Description (*.pdsc) Format</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/pdsc_examples_pg.html b/docs/Pack/html/pdsc_examples_pg.html index 2d4cc6a..4ee2c73 100644 --- a/docs/Pack/html/pdsc_examples_pg.html +++ b/docs/Pack/html/pdsc_examples_pg.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -324,7 +324,7 @@ $(document).ready(function(){initNavTree('pdsc_examples_pg.html','');}); <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="packFormat.html">Pack Description (*.pdsc) Format</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:01 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/pdsc_family_pg.html b/docs/Pack/html/pdsc_family_pg.html index c06e92f..1485d16 100644 --- a/docs/Pack/html/pdsc_family_pg.html +++ b/docs/Pack/html/pdsc_family_pg.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -845,6 +845,40 @@ $(document).ready(function(){initNavTree('pdsc_family_pg.html','');}); <td>Touch</td><td>Number of Touch Channels</td><td>N/A</td><td>Capacitive Touch Inputs</td><td><feature type="Touch" n="10" name="Capacitive Touch Inputs"/></td><td>10 x Capacitive Touch Inputs </td></tr> <tr> <td>Other</td><td>Number of Features</td><td>N/A</td><td>Other Feature</td><td><feature type="Other" n="2" name="My other Interface"/></td><td>2 x My other Interface </td></tr> +<tr> +<td>GPU</td><td>IP Name</td><td>Number of Shaders</td><td>GPU</td><td><feature type="GPU" n="Mali G71" m="1024"/></td><td>Mali G71 GPU with 1024 Shaders </td></tr> +<tr> +<td>AI</td><td>N/A</td><td>N/A</td><td>AI</td><td><feature type="AI"/></td><td>AI accelerator </td></tr> +<tr> +<td>FPGA</td><td>Number of Logic Elements</td><td>N/A</td><td>FPGA Array</td><td><feature type="FPGA" n="100000"/></td><td>FPGA with 100000 Logic Elements </td></tr> +<tr> +<td>Application</td><td>Automotive, Industrial, Medical, MilAero</td><td>Standard Name</td><td>N/A</td><td><feature type="Application" n="Automotive" m="ISO 26262"/></td><td>Automotive ISO 26262 Applications </td></tr> +<tr> +<td>IrDA</td><td>Standard Version</td><td>Data Rate in Bit/s</td><td>Infrared</td><td><feature type="IrDA" n="" m="1000000"/></td><td>IrDA 1 Mbit/s </td></tr> +<tr> +<td>HDMI</td><td>Standard Version</td><td>N/A</td><td>HDMI</td><td><feature type="HDMI" n="1.3"/></td><td>HDMI 1.3 </td></tr> +<tr> +<td>MIPI</td><td>Standard Version</td><td>Data Rate in Bit/s</td><td>MIPI</td><td><feature type="MIPI" n="CSI" m="5000000000"/></td><td>MIPI CSI 5 Gbit/s </td></tr> +<tr> +<td>PCIe</td><td>Standard Version</td><td>Maximum Data Rate in Bit/s</td><td>PCIe</td><td><feature type="PCIe" n="3.0" m="3000000000"/></td><td>PCIe 3.0 3 GT/s </td></tr> +<tr> +<td>Bluetooth</td><td>Standard Version</td><td>Maximum Data Rate in Bit/s</td><td>Bluetooth</td><td><feature type="Bluetooth" n="4.2" name="Bluetooth Low Energy"/></td><td>Bluetooth Low Energy 4.2 </td></tr> +<tr> +<td>ZigBee</td><td>Application Profile</td><td>Data Rate in Bit/s</td><td>ZigBee</td><td><feature type="Zigbee" n="Home Automation 2.1"/></td><td>ZigBee Home Automation 1.2 </td></tr> +<tr> +<td>802.15.4</td><td>Standard Version</td><td>N/A</td><td>802.15.4</td><td><feature type="802.15.4" n="802.15.4d"/></td><td>802.15.4d </td></tr> +<tr> +<td>WiFi</td><td>Standard Version</td><td>Maximum Data Rate in Bit/s</td><td>WiFi</td><td><feature type="WiFi" n="802.11ac"/></td><td>802.11ac WiFi </td></tr> +<tr> +<td>LoRa</td><td>Standard Version</td><td>Maximum Data Rate in Bit/s</td><td>LoRa</td><td><feature type="LoRa"/></td><td>LoRa </td></tr> +<tr> +<td>LTE Cat-M</td><td>Standard Version</td><td>Maximum Data Rate in Bit/s</td><td>LTE Cat-M</td><td><feature type="LTE-M" n="M1" m="1000000"/></td><td>LTE-M M1 1 Mbit/s </td></tr> +<tr> +<td>NB-IoT</td><td>Standard Version</td><td>Maximum Data Rate in Bit/s</td><td>NB IoT</td><td><feature type="NB-IoT" n="NB1" m="250000"/></td><td>NB-IoT NB1 250 kbit/s </td></tr> +<tr> +<td>NFC</td><td>Standard Version</td><td>Maximum Data Rate in Bit/s</td><td>NFC</td><td><feature type="NFC" n="ISO 18092"/></td><td>NFC ISO 18092 </td></tr> +<tr> +<td>WirelessOther</td><td>Standard Version</td><td>Maximum Data Rate in Bit/s</td><td>Other Wireless Connectivity</td><td><feature type="WirelessOther" n="MyStandard" m="1000000"/></td><td>MyStandard 1 Mbit/s Wireless Connectivity </td></tr> </table> <p> </p> <hr/> @@ -1001,7 +1035,9 @@ $(document).ready(function(){initNavTree('pdsc_family_pg.html','');}); <tr> <td>Dtz </td><td>Specifies whether an Armv8-M based device implements TrustZone. Use predefined values as listed in the table <a class="el" href="pdsc_family_pg.html#DtzEnum">Device TZ</a>. </td><td>DtzEnum </td><td>required for ARMv8-M based devices </td></tr> <tr> -<td>Ddsp </td><td>Specifies whether a device supports the DSP instructions set. Use predefined values as listed in the table <a class="el" href="pdsc_family_pg.html#DdspEnum">Device DSP</a>. </td><td>DdspEnum </td><td>required </td></tr> +<td>Ddsp </td><td>Specifies whether a device supports the DSP instructions set. Use predefined values as listed in the table <a class="el" href="pdsc_family_pg.html#DdspEnum">Device DSP</a>. </td><td><a class="el" href="pdsc_family_pg.html#DdspEnum">DdspEnum</a> DdspEnum </td><td>required </td></tr> +<tr> +<td>Dmve </td><td>Specifies whether a device supports the M-Profile Vector instruction set extension. Use predefined values as listed in the table <a class="el" href="pdsc_family_pg.html#DmveEnum">Device MVE</a>. </td><td><a class="el" href="pdsc_family_pg.html#DmveEnum">DmveEnum</a> DmveEnum </td><td>required for ARMv8.1-M based devices </td></tr> <tr> <td>Dendian </td><td>Specifies the endianess of the processor. Use predefined values as listed in the table <a class="el" href="pdsc_family_pg.html#DendianEnum">Endinaness</a>. </td><td>DendianEnum </td><td>required </td></tr> <tr> @@ -1036,13 +1072,15 @@ $(document).ready(function(){initNavTree('pdsc_family_pg.html','');}); <tr> <td class="XML-Token">Analog Devices:1 </td><td>Analog Devices </td><td><a href="http://www.analog.com">http://www.analog.com</a> </td></tr> <tr> +<td class="XML-Token">APEXMIC:153 </td><td>Apex Microeletronics Co., Ltd. </td><td><a href="http://www.apexmic.com">http://www.apexmic.com</a> </td></tr> +<tr> <td class="XML-Token">ARM:82 </td><td>ARM Ltd. </td><td><a href="http://www.arm.com">http://www.arm.com</a> </td></tr> <tr> <td class="XML-Token">ArteryTek:143 </td><td>ArteryTek </td><td><a href="http://www.arterytek.com">http://www.arterytek.com</a> </td></tr> <tr> <td class="XML-Token">Atmel:3 </td><td>Atmel Corporation (now Microchip) </td><td><a href="http://www.microchip.com">http://www.microchip.com</a> </td></tr> <tr> -<td class="XML-Token">Autochips:150 </td><td>Autochips Inc. </td><td><a href="http://www.autochips.com/en/index.php">http://www.autochips.com/en/index.php</a> </td></tr> +<td class="XML-Token">Autochips:150 </td><td>Autochips Inc. </td><td><a href="http://www.autochips.com/index_en.aspx">http://www.autochips.com/index_en.aspx</a> </td></tr> <tr> <td class="XML-Token">CSR:118 </td><td>CSR </td><td><a href="http://www.csr.com">http://www.csr.com</a> </td></tr> <tr> @@ -1058,6 +1096,8 @@ $(document).ready(function(){initNavTree('pdsc_family_pg.html','');}); <tr> <td class="XML-Token">GigaDevice:123 </td><td>GigaDevice </td><td><a href="http://www.gigadevice.com">http://www.gigadevice.com</a> </td></tr> <tr> +<td class="XML-Token">Goodix:155 </td><td>Goodix </td><td><a href="https://www.goodix.com">https://www.goodix.com</a> </td></tr> +<tr> <td class="XML-Token">HDSC:145 </td><td>HUADA Semiconductor </td><td><a href="http://www.hdsc.com.cn">http://www.hdsc.com.cn</a> </td></tr> <tr> <td class="XML-Token">Hilscher:88 </td><td>Hilscher Gesellschaft für Systemautomation mbH </td><td><a href="http://www.hilscher.com">http://www.hilscher.com</a> </td></tr> @@ -1114,6 +1154,8 @@ $(document).ready(function(){initNavTree('pdsc_family_pg.html','');}); <tr> <td class="XML-Token">Sinowealth:149 </td><td>Sino Wealth Electronic Ltd. </td><td><a href="http://www.sinowealth.com">http://www.sinowealth.com</a> </td></tr> <tr> +<td class="XML-Token">SmartChip:156 </td><td>SmartChip </td><td></td></tr> +<tr> <td class="XML-Token">Spansion:100 </td><td>Spansion (previously Fujitsu) </td><td><a href="http://www.spansion.com">http://www.spansion.com</a> </td></tr> <tr> <td class="XML-Token">STMicroelectronics:13 </td><td>STMicroelectronics </td><td><a href="http://www.st.com">http://www.st.com</a> </td></tr> @@ -1126,11 +1168,15 @@ $(document).ready(function(){initNavTree('pdsc_family_pg.html','');}); <tr> <td class="XML-Token">Triad Semiconductor:104 </td><td>Triad Semiconductor </td><td><a href="http://www.triadsemi.com">http://www.triadsemi.com</a> </td></tr> <tr> +<td class="XML-Token">Unisoc:152 </td><td>Unisoc Communications, Inc. </td><td><a href="http://www.unisoc.com">http://www.unisoc.com</a> </td></tr> +<tr> <td class="XML-Token">Vorago:137 </td><td>Vorago Technologies </td><td><a href="http://www.voragotech.com">http://www.voragotech.com</a> </td></tr> <tr> +<td class="XML-Token">Weltrend:148 </td><td>Weltrend </td><td><a href="http://www.weltrend.com.tw">http://www.weltrend.com.tw</a> </td></tr> +<tr> <td class="XML-Token">WIZnet:122 </td><td>WIZnet </td><td><a href="http://www.wiznet.co.kr">http://www.wiznet.co.kr</a> </td></tr> <tr> -<td class="XML-Token">Xinnova:135 </td><td>Xinnova Technology </td><td><a href="http://www.xinnovatech.com/en">http://www.xinnovatech.com/en</a> </td></tr> +<td class="XML-Token">Xinnova:135 </td><td>Xinnova Technology </td><td>(n/a) </td></tr> <tr> <td class="XML-Token">Zilog:89 </td><td>Zilog </td><td><a href="http://zilog.com/">http://zilog.com/</a> </td></tr> </table> @@ -1182,6 +1228,8 @@ $(document).ready(function(){initNavTree('pdsc_family_pg.html','');}); <tr> <td class="XML-Token">Cortex-M33 </td><td><a href="http://developer.arm.com/products/processors/cortex-m/cortex-m33" target="_blank">Arm Cortex-M33</a> processor based device </td></tr> <tr> +<td class="XML-Token">Cortex-M35P </td><td><a href="http://developer.arm.com/products/processors/cortex-m/cortex-m35p" target="_blank">Arm Cortex-M35P</a> processor based device </td></tr> +<tr> <td class="XML-Token">SC000 </td><td>SecurCore <a href="http://developer.arm.com/products/processors/cortex-m/sc000-processor" target="_blank">SC000</a> based on technology of Cortex-M0. </td></tr> <tr> <td class="XML-Token">SC300 </td><td>SecurCore <a href="http://developer.arm.com/products/processors/cortex-m/sc300-processor" target="_blank">SC300</a> based on technology of Cortex-M3. </td></tr> @@ -1316,6 +1364,25 @@ $(document).ready(function(){initNavTree('pdsc_family_pg.html','');}); <td class="XML-Token">NO_DSP </td><td>No DSP instructions supported </td></tr> </table> <p> </p> +<p><a class="anchor" id="DmveEnum"></a><b>Table: Device implements M-Profile Vector Extension Instructions</b></p> +<p>The table shows predefined values that identify whether a CPU implements MVE instructions (MVE). The values can be used in the elements:</p> +<ul> +<li><a class="el" href="pdsc_conditions_pg.html#element_accept">/package/conditions/condition/accept</a></li> +<li><a class="el" href="pdsc_conditions_pg.html#element_require">/package/conditions/condition/require</a></li> +<li><a class="el" href="pdsc_conditions_pg.html#element_deny">/package/conditions/condition/deny</a></li> +<li><a class="el" href="pdsc_family_pg.html#element_processor">/package/devices/family/.../processor</a></li> +</ul> +<table class="cmtable" summary="Enumeration: DmveEnum"> +<tr> +<th>Dmve= </th><th>Description </th></tr> +<tr> +<td class="XML-Token">NO_MVE </td><td>No MVE instructions supported </td></tr> +<tr> +<td class="XML-Token">MVE </td><td>Integer MVE instructions supported </td></tr> +<tr> +<td class="XML-Token">FP_MVE </td><td>Floating point and Integer MVE instructions supported </td></tr> +</table> +<p> </p> <p><a class="anchor" id="DendianEnum"></a><b>Table: Endianness</b></p> <p>The table lists values representing the endianness of a device. The values can be used in the elements:</p> <ul> @@ -2211,7 +2278,9 @@ $(document).ready(function(){initNavTree('pdsc_family_pg.html','');}); <tr> <th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> <tr> -<td>Dvariant </td><td>Name of the device variant. Only alphabetical characters, decimal digits, '-' and '_' are allowed </td><td>RestrictedStringDname </td><td>required </td></tr> +<td>Dvariant </td><td><b>May get replaced by 'Dname' in the future</b>. Name of the device on the variant level. This effectively overwrites the device name specified on the device level. Once a device section contains a variant section, only the variant elements describe a 'selectable' device which can be selected in the tools. The Dname of the device level effectively becomes a group name like the Dfamily and DsubFamily attributes. Only alphabetical characters, decimal digits, '-' and '_' are allowed </td><td>RestrictedStringDname </td><td>required </td></tr> +<tr> +<td>Dname </td><td><b>future</b>. Name of the device on the variant level. Only alphabetical characters, decimal digits, '-' and '_' are allowed </td><td>RestrictedStringDname </td><td>required </td></tr> <tr> <th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> <tr> @@ -2251,7 +2320,7 @@ $(document).ready(function(){initNavTree('pdsc_family_pg.html','');}); <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="packFormat.html">Pack Description (*.pdsc) Format</a></li><li class="navelem"><a class="el" href="pdsc_devices_pg.html">/package/devices element</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:01 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/pdsc_generators_pg.html b/docs/Pack/html/pdsc_generators_pg.html index 1832180..4dc8508 100644 --- a/docs/Pack/html/pdsc_generators_pg.html +++ b/docs/Pack/html/pdsc_generators_pg.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -542,7 +542,7 @@ $(document).ready(function(){initNavTree('pdsc_generators_pg.html','');}); <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="packFormat.html">Pack Description (*.pdsc) Format</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:01 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/pdsc_package_pg.html b/docs/Pack/html/pdsc_package_pg.html index 6e0df64..a3bab08 100644 --- a/docs/Pack/html/pdsc_package_pg.html +++ b/docs/Pack/html/pdsc_package_pg.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -160,6 +160,14 @@ $(document).ready(function(){initNavTree('pdsc_package_pg.html','');}); <tr> <td>xs:noNamespaceSchemaLocation </td><td>Path and file name of the PACK.xsd Schema. For example, <span class="XML-Token">"PACK.xsd"</span>. </td><td>xs:string </td><td>required </td></tr> <tr> +<td>Dcore </td><td>Pack only used for a specific processor core. Use predefined values as listed in the table <a class="el" href="pdsc_family_pg.html#DcoreEnum">Device Cores</a>. Note: do not apply for packs that define a device </td><td>DcoreEnum </td><td>optional </td></tr> +<tr> +<td>Dvendor </td><td>Pack only used for a specific silicon vendor of the device. Use predefined values as listed in the table <a class="el" href="pdsc_family_pg.html#DeviceVendorEnum">Device Vendor</a>. Note: do not apply for packs that define a device </td><td>DeviceVendorEnum </td><td>optional </td></tr> +<tr> +<td>Dname<b>*</b> </td><td>Pack only used for a specific name of the device. Note: do not apply for packs that define a device </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>Tcompiler </td><td>Pack only used for a specific compiler toolchain (ARMCC, GCC, IAR, Tasking, ...). Use predefined values as listed in table <a class="el" href="pdsc_conditions_pg.html#CompilerEnumType">Compiler Types</a>. </td><td>CompilerEnumType </td><td>optional </td></tr> +<tr> <th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> <tr> <td>name </td><td>Name of the <a class="el" href="cp_SWComponents.html">Software Pack</a>. Could be displayed by an installer. </td><td>xs:string </td><td>1..1 </td></tr> @@ -174,6 +182,8 @@ $(document).ready(function(){initNavTree('pdsc_package_pg.html','');}); <tr> <td>license </td><td>Path to a license document. </td><td>xs:string </td><td>0..1 </td></tr> <tr> +<td><a class="el" href="element_dominate.html">dominate</a> </td><td>dominate </td><td>A pack that has <a class="el" href="element_dominate.html">dominate</a> attribute overrules other packs that provide devices, APIs, or software components with the same name. </td><td><em>empty</em> </td></tr> +<tr> <td><a class="el" href="element_requirements_pg.html#element_requirements">requirements</a> </td><td>Specifies other CMSIS-Packs, programming languages and compiler as well as their respective version or version range required by the components in this pack. </td><td>RequirementsType </td><td>0..1 </td></tr> <tr> <td>create </td><td>Use only when creating CMSIS software projects. Refer to <a class="el" href="cpdsc_pg.html">Project Description (*.cpdsc) Format</a> for details. </td><td>CreateType </td><td>0..1 </td></tr> @@ -202,6 +212,12 @@ $(document).ready(function(){initNavTree('pdsc_package_pg.html','');}); <tr> <td><a class="el" href="pdsc_components_pg.html#element_components">components</a> </td><td>Lists the software components that are included in the Pack. </td><td>group </td><td>0..1 </td></tr> </table> +<p><b>*)</b> Wild-cards can be used to match names with the following definitions:</p> +<ul> +<li>'*' matches any substring</li> +<li>'?' matches any single character</li> +<li>[abc] matches any character in the set (a,b,c)</li> +</ul> <p> </p> <p><a class="anchor" id="VersionType"></a><b>Version Type</b></p> <p>CMSIS-Pack version specification is inspired by the <a href="http://semver.org" target="_blank">Semantic Versioning 2.0.0</a>. Under this scheme, version numbers and the way they are incremented convey a meaning about the underlying content quality and the significance of changes from one version to the next. A version consists of 3 mandatory and 2 optional sections:</p> @@ -259,7 +275,7 @@ $(document).ready(function(){initNavTree('pdsc_package_pg.html','');}); <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="packFormat.html">Pack Description (*.pdsc) Format</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:42 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:00 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/requirements.png b/docs/Pack/html/requirements.png Binary files differnew file mode 100644 index 0000000..d7f233f --- /dev/null +++ b/docs/Pack/html/requirements.png diff --git a/docs/Pack/html/schema_check.png b/docs/Pack/html/schema_check.png Binary files differnew file mode 100644 index 0000000..3ddbb1c --- /dev/null +++ b/docs/Pack/html/schema_check.png diff --git a/docs/Pack/html/schema_check_output.png b/docs/Pack/html/schema_check_output.png Binary files differnew file mode 100644 index 0000000..ad6599f --- /dev/null +++ b/docs/Pack/html/schema_check_output.png diff --git a/docs/Pack/html/sdf_pg.html b/docs/Pack/html/sdf_pg.html index d4d118a..a6d6140 100644 --- a/docs/Pack/html/sdf_pg.html +++ b/docs/Pack/html/sdf_pg.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Pack -  <span id="projectnumber">Version 1.5.0</span> +  <span id="projectnumber">Version 1.6.0</span> </div> <div id="projectbrief">Delivery Mechanism for Software Packs</div> </td> @@ -711,7 +711,7 @@ SDF top level structure</h1> <p>Depending on the context, a device type can be one of the following types:</p> <ol type="1"> <li>A core device, where the type is usually specified as "Cortex-xx" (such as Cortex-A72,Cortex-M0+, Cortex-R5). It can also be a vendor-specific core type, or an older JTAG ARM core. Current cores are: <br/> - "Cortex-A5", "Cortex-A7", "Cortex-A8", "Cortex-A9", "Cortex-A12", "Cortex-A15", "Cortex-A17", "Cortex-A32", "Cortex-A35", "Cortex-A53", "Cortex-A57", "Cortex-A72", "Cortex-A73", "Cortex-M0", "Cortex-M0+", "Cortex-M0+_JTAG-AP", "Cortex-M1", "Cortex-M23", "Cortex-M3", "Cortex-M33", "Cortex-M3_JTAG-AP", "Cortex-M4", "Cortex-M7", "Cortex-R4", "Cortex-R5", "Cortex-R7", "Cortex-R8", "Cortex-R52", "SC000", "SC100D", "SC200D", "SC300", "ThunderX", "ThunderX-r2", "ARMV8MBL", "ARMV8MML", "88FR101", "88FR111", "88FR331", "88SV581x-v7_PJ4", "88SV581x-v7_PJ4_TZ", "ARM1136JF-S", "ARM1136JF-S_JTAG-AP", "ARM1156T2F-S", "ARM1156T2F-S_JTAG-AP", "ARM1176JZF-S", "ARM1176JZF-S_JTAG-AP", "ARM11MPCore", "ARM11MPCore_JTAG-AP", "ARM710T", "ARM720T", "ARM720T_r4", "ARM740T", "ARM7EJ-S", "ARM7EJ-S_JTAG-AP", "ARM7TDMI", "ARM7TDMI_JTAG-AP", "ARM7TDMI_r4", "ARM7TDMI_r4_JTAG-AP", "ARM920T", "ARM922T", "ARM925T", "ARM926EJ-S", "ARM926EJ-S_JTAG-AP", "ARM940T", "ARM946E-S", "ARM946E-S_JTAG-AP", "ARM966E-S", "ARM966E-S_JTAG-AP", "ARM968E-S", "ARM968E-S_JTAG-AP", "ARM968E-Srd", "ARM996HS", "ARM9E-S", "ARM9EJ-S", "ARM9EJ-S_JTAG-AP", "ARM9TDMI", "V7A-Generic", "V8-Generic", "V8M-Generic", "V8R-Generic", "V8_1-Generic", "V8_2-Generic".</li> + "Cortex-A5", "Cortex-A7", "Cortex-A8", "Cortex-A9", "Cortex-A12", "Cortex-A15", "Cortex-A17", "Cortex-A32", "Cortex-A35", "Cortex-A53", "Cortex-A57", "Cortex-A72", "Cortex-A73", "Cortex-M0", "Cortex-M0+", "Cortex-M0+_JTAG-AP", "Cortex-M1", "Cortex-M23", "Cortex-M3", "Cortex-M33", "Cortex-M35P", "Cortex-M3_JTAG-AP", "Cortex-M4", "Cortex-M7", "Cortex-R4", "Cortex-R5", "Cortex-R7", "Cortex-R8", "Cortex-R52", "SC000", "SC100D", "SC200D", "SC300", "ThunderX", "ThunderX-r2", "ARMV8MBL", "ARMV8MML", "88FR101", "88FR111", "88FR331", "88SV581x-v7_PJ4", "88SV581x-v7_PJ4_TZ", "ARM1136JF-S", "ARM1136JF-S_JTAG-AP", "ARM1156T2F-S", "ARM1156T2F-S_JTAG-AP", "ARM1176JZF-S", "ARM1176JZF-S_JTAG-AP", "ARM11MPCore", "ARM11MPCore_JTAG-AP", "ARM710T", "ARM720T", "ARM720T_r4", "ARM740T", "ARM7EJ-S", "ARM7EJ-S_JTAG-AP", "ARM7TDMI", "ARM7TDMI_JTAG-AP", "ARM7TDMI_r4", "ARM7TDMI_r4_JTAG-AP", "ARM920T", "ARM922T", "ARM925T", "ARM926EJ-S", "ARM926EJ-S_JTAG-AP", "ARM940T", "ARM946E-S", "ARM946E-S_JTAG-AP", "ARM966E-S", "ARM966E-S_JTAG-AP", "ARM968E-S", "ARM968E-S_JTAG-AP", "ARM968E-Srd", "ARM996HS", "ARM9E-S", "ARM9EJ-S", "ARM9EJ-S_JTAG-AP", "ARM9TDMI", "V7A-Generic", "V8-Generic", "V8M-Generic", "V8R-Generic", "V8_1-Generic", "V8_2-Generic".</li> <li>An Access Port (AP) type such as "CSAUTHAP", "CSJTAGAP" or "CSMEMAP".</li> <li>A CoreSight device type that can be one of "CSCTI", "CSETM", "CSITM", "CSMTB", "CSPMU", "CSPTM", "CSTFunnel", "CSTMC", "CSTPIU","CSSTM", "CSSWO", "CSELA", "CSATBReplicator", "CSGPR", "CSETB", "CSDWT", "CSETB", "CSTSGEN", "CSHTM", "CSFPB"</li> <li>A JTAG device, which is directly on the scanchain (e.g. ARM11).</li> @@ -975,7 +975,7 @@ SDF top level structure</h1> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:43 for CMSIS-Pack by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:21:01 for CMSIS-Pack Version 1.6.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 diff --git a/docs/Pack/html/search/all_4.js b/docs/Pack/html/search/all_4.js index a7d98d6..3905264 100644 --- a/docs/Pack/html/search/all_4.js +++ b/docs/Pack/html/search/all_4.js @@ -1,11 +1,4 @@ var searchData= [ - ['pack_20with_20software_20components',['Pack with Software Components',['../cp_SWComponents.html',1,'']]], - ['project_20description_20_28_2a_2ecpdsc_29_20format',['Project Description (*.cpdsc) Format',['../cpdsc_pg.html',1,'']]], - ['pack_20with_20device_20support',['Pack with Device Support',['../createPack_DFP.html',1,'']]], - ['pack_20with_20board_20support',['Pack with Board Support',['../createPackBoard.html',1,'']]], - ['publish_20a_20pack',['Publish a Pack',['../createPackPublish.html',1,'']]], - ['pack_20example',['Pack Example',['../pack_Example.html',1,'']]], - ['packchk_2eexe',['packChk.exe',['../packChk.html',1,'createPackUtil']]], - ['pack_20description_20_28_2a_2epdsc_29_20format',['Pack Description (*.pdsc) Format',['../packFormat.html',1,'']]] + ['overview',['Overview',['../cp_Packs.html',1,'']]] ]; diff --git a/docs/Pack/html/search/all_5.js b/docs/Pack/html/search/all_5.js index 3e18830..a7d98d6 100644 --- a/docs/Pack/html/search/all_5.js +++ b/docs/Pack/html/search/all_5.js @@ -1,4 +1,11 @@ var searchData= [ - ['revision_20history_20of_20cmsis_2dpack',['Revision History of CMSIS-Pack',['../pack_revisionHistory.html',1,'index']]] + ['pack_20with_20software_20components',['Pack with Software Components',['../cp_SWComponents.html',1,'']]], + ['project_20description_20_28_2a_2ecpdsc_29_20format',['Project Description (*.cpdsc) Format',['../cpdsc_pg.html',1,'']]], + ['pack_20with_20device_20support',['Pack with Device Support',['../createPack_DFP.html',1,'']]], + ['pack_20with_20board_20support',['Pack with Board Support',['../createPackBoard.html',1,'']]], + ['publish_20a_20pack',['Publish a Pack',['../createPackPublish.html',1,'']]], + ['pack_20example',['Pack Example',['../pack_Example.html',1,'']]], + ['packchk_2eexe',['packChk.exe',['../packChk.html',1,'createPackUtil']]], + ['pack_20description_20_28_2a_2epdsc_29_20format',['Pack Description (*.pdsc) Format',['../packFormat.html',1,'']]] ]; diff --git a/docs/Pack/html/search/all_6.js b/docs/Pack/html/search/all_6.js index 14fed29..3e18830 100644 --- a/docs/Pack/html/search/all_6.js +++ b/docs/Pack/html/search/all_6.js @@ -1,5 +1,4 @@ var searchData= [ - ['software_20packs_20overview',['Software Packs Overview',['../cp_Packs.html',1,'']]], - ['system_20description_20file_20_28_2a_2esdf_29_20format',['System Description File (*.SDF) Format',['../sdf_pg.html',1,'']]] + ['revision_20history_20of_20cmsis_2dpack',['Revision History of CMSIS-Pack',['../pack_revisionHistory.html',1,'index']]] ]; diff --git a/docs/Pack/html/search/all_7.js b/docs/Pack/html/search/all_7.js index dd07669..a34ea53 100644 --- a/docs/Pack/html/search/all_7.js +++ b/docs/Pack/html/search/all_7.js @@ -1,4 +1,4 @@ var searchData= [ - ['utilities_20for_20creating_20packs',['Utilities for Creating Packs',['../createPackUtil.html',1,'']]] + ['system_20description_20file_20_28_2a_2esdf_29_20format',['System Description File (*.SDF) Format',['../sdf_pg.html',1,'']]] ]; diff --git a/docs/Pack/html/search/all_8.js b/docs/Pack/html/search/all_8.js index 4bda4c3..dd07669 100644 --- a/docs/Pack/html/search/all_8.js +++ b/docs/Pack/html/search/all_8.js @@ -1,4 +1,4 @@ var searchData= [ - ['xml_20editors',['XML Editors',['../cp_Editors.html',1,'createPackUtil']]] + ['utilities_20for_20creating_20packs',['Utilities for Creating Packs',['../createPackUtil.html',1,'']]] ]; diff --git a/docs/Pack/html/search/all_9.js b/docs/Pack/html/search/all_9.js index 01cd4b4..4bda4c3 100644 --- a/docs/Pack/html/search/all_9.js +++ b/docs/Pack/html/search/all_9.js @@ -1,4 +1,4 @@ var searchData= [ - ['zip_20compression_20tools',['ZIP Compression Tools',['../cp_ZIPTool.html',1,'createPackUtil']]] + ['xml_20editors',['XML Editors',['../cp_Editors.html',1,'createPackUtil']]] ]; diff --git a/docs/Pack/html/search/all_a.html b/docs/Pack/html/search/all_a.html new file mode 100644 index 0000000..eab6553 --- /dev/null +++ b/docs/Pack/html/search/all_a.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html><head><title></title> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta name="generator" content="Doxygen 1.8.6"> +<link rel="stylesheet" type="text/css" href="search.css"/> +<script type="text/javascript" src="all_a.js"></script> +<script type="text/javascript" src="search.js"></script> +</head> +<body class="SRPage"> +<div id="SRIndex"> +<div class="SRStatus" id="Loading">Loading...</div> +<div id="SRResults"></div> +<script type="text/javascript"><!-- +createResults(); +--></script> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +<script type="text/javascript"><!-- +document.getElementById("Loading").style.display="none"; +document.getElementById("NoMatches").style.display="none"; +var searchResults = new SearchResults("searchResults"); +searchResults.Search(); +--></script> +</div> +</body> +</html> diff --git a/docs/Pack/html/search/all_a.js b/docs/Pack/html/search/all_a.js new file mode 100644 index 0000000..01cd4b4 --- /dev/null +++ b/docs/Pack/html/search/all_a.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['zip_20compression_20tools',['ZIP Compression Tools',['../cp_ZIPTool.html',1,'createPackUtil']]] +]; diff --git a/docs/Pack/html/search/pages_4.js b/docs/Pack/html/search/pages_4.js index a7d98d6..3905264 100644 --- a/docs/Pack/html/search/pages_4.js +++ b/docs/Pack/html/search/pages_4.js @@ -1,11 +1,4 @@ var searchData= [ - ['pack_20with_20software_20components',['Pack with Software Components',['../cp_SWComponents.html',1,'']]], - ['project_20description_20_28_2a_2ecpdsc_29_20format',['Project Description (*.cpdsc) Format',['../cpdsc_pg.html',1,'']]], - ['pack_20with_20device_20support',['Pack with Device Support',['../createPack_DFP.html',1,'']]], - ['pack_20with_20board_20support',['Pack with Board Support',['../createPackBoard.html',1,'']]], - ['publish_20a_20pack',['Publish a Pack',['../createPackPublish.html',1,'']]], - ['pack_20example',['Pack Example',['../pack_Example.html',1,'']]], - ['packchk_2eexe',['packChk.exe',['../packChk.html',1,'createPackUtil']]], - ['pack_20description_20_28_2a_2epdsc_29_20format',['Pack Description (*.pdsc) Format',['../packFormat.html',1,'']]] + ['overview',['Overview',['../cp_Packs.html',1,'']]] ]; diff --git a/docs/Pack/html/search/pages_5.js b/docs/Pack/html/search/pages_5.js index 3e18830..a7d98d6 100644 --- a/docs/Pack/html/search/pages_5.js +++ b/docs/Pack/html/search/pages_5.js @@ -1,4 +1,11 @@ var searchData= [ - ['revision_20history_20of_20cmsis_2dpack',['Revision History of CMSIS-Pack',['../pack_revisionHistory.html',1,'index']]] + ['pack_20with_20software_20components',['Pack with Software Components',['../cp_SWComponents.html',1,'']]], + ['project_20description_20_28_2a_2ecpdsc_29_20format',['Project Description (*.cpdsc) Format',['../cpdsc_pg.html',1,'']]], + ['pack_20with_20device_20support',['Pack with Device Support',['../createPack_DFP.html',1,'']]], + ['pack_20with_20board_20support',['Pack with Board Support',['../createPackBoard.html',1,'']]], + ['publish_20a_20pack',['Publish a Pack',['../createPackPublish.html',1,'']]], + ['pack_20example',['Pack Example',['../pack_Example.html',1,'']]], + ['packchk_2eexe',['packChk.exe',['../packChk.html',1,'createPackUtil']]], + ['pack_20description_20_28_2a_2epdsc_29_20format',['Pack Description (*.pdsc) Format',['../packFormat.html',1,'']]] ]; diff --git a/docs/Pack/html/search/pages_6.js b/docs/Pack/html/search/pages_6.js index 14fed29..3e18830 100644 --- a/docs/Pack/html/search/pages_6.js +++ b/docs/Pack/html/search/pages_6.js @@ -1,5 +1,4 @@ var searchData= [ - ['software_20packs_20overview',['Software Packs Overview',['../cp_Packs.html',1,'']]], - ['system_20description_20file_20_28_2a_2esdf_29_20format',['System Description File (*.SDF) Format',['../sdf_pg.html',1,'']]] + ['revision_20history_20of_20cmsis_2dpack',['Revision History of CMSIS-Pack',['../pack_revisionHistory.html',1,'index']]] ]; diff --git a/docs/Pack/html/search/pages_7.js b/docs/Pack/html/search/pages_7.js index dd07669..a34ea53 100644 --- a/docs/Pack/html/search/pages_7.js +++ b/docs/Pack/html/search/pages_7.js @@ -1,4 +1,4 @@ var searchData= [ - ['utilities_20for_20creating_20packs',['Utilities for Creating Packs',['../createPackUtil.html',1,'']]] + ['system_20description_20file_20_28_2a_2esdf_29_20format',['System Description File (*.SDF) Format',['../sdf_pg.html',1,'']]] ]; diff --git a/docs/Pack/html/search/pages_8.js b/docs/Pack/html/search/pages_8.js index 4bda4c3..dd07669 100644 --- a/docs/Pack/html/search/pages_8.js +++ b/docs/Pack/html/search/pages_8.js @@ -1,4 +1,4 @@ var searchData= [ - ['xml_20editors',['XML Editors',['../cp_Editors.html',1,'createPackUtil']]] + ['utilities_20for_20creating_20packs',['Utilities for Creating Packs',['../createPackUtil.html',1,'']]] ]; diff --git a/docs/Pack/html/search/pages_9.js b/docs/Pack/html/search/pages_9.js index 01cd4b4..4bda4c3 100644 --- a/docs/Pack/html/search/pages_9.js +++ b/docs/Pack/html/search/pages_9.js @@ -1,4 +1,4 @@ var searchData= [ - ['zip_20compression_20tools',['ZIP Compression Tools',['../cp_ZIPTool.html',1,'createPackUtil']]] + ['xml_20editors',['XML Editors',['../cp_Editors.html',1,'createPackUtil']]] ]; diff --git a/docs/Pack/html/search/pages_a.html b/docs/Pack/html/search/pages_a.html new file mode 100644 index 0000000..1c097e5 --- /dev/null +++ b/docs/Pack/html/search/pages_a.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html><head><title></title> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta name="generator" content="Doxygen 1.8.6"> +<link rel="stylesheet" type="text/css" href="search.css"/> +<script type="text/javascript" src="pages_a.js"></script> +<script type="text/javascript" src="search.js"></script> +</head> +<body class="SRPage"> +<div id="SRIndex"> +<div class="SRStatus" id="Loading">Loading...</div> +<div id="SRResults"></div> +<script type="text/javascript"><!-- +createResults(); +--></script> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +<script type="text/javascript"><!-- +document.getElementById("Loading").style.display="none"; +document.getElementById("NoMatches").style.display="none"; +var searchResults = new SearchResults("searchResults"); +searchResults.Search(); +--></script> +</div> +</body> +</html> diff --git a/docs/Pack/html/search/pages_a.js b/docs/Pack/html/search/pages_a.js new file mode 100644 index 0000000..01cd4b4 --- /dev/null +++ b/docs/Pack/html/search/pages_a.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['zip_20compression_20tools',['ZIP Compression Tools',['../cp_ZIPTool.html',1,'createPackUtil']]] +]; diff --git a/docs/Pack/html/search/search.css b/docs/Pack/html/search/search.css index 1746d13..4d7612f 100644 --- a/docs/Pack/html/search/search.css +++ b/docs/Pack/html/search/search.css @@ -4,22 +4,16 @@ float: left; } -#searchli { - float: right; - display: block; - width: 170px; - height: 24px; -} - #MSearchBox { white-space : nowrap; position: absolute; float: none; display: inline; - margin-top: 3px; + margin-top: 8px; right: 0px; width: 170px; z-index: 102; + background-color: white; } #MSearchBox .left @@ -54,7 +48,7 @@ height:19px; background:url('search_m.png') repeat-x; border:none; - width:116px; + width:111px; margin-left:20px; padding-left:4px; color: #909090; @@ -224,6 +218,10 @@ a.SRScope:focus, a.SRScope:active { text-decoration: underline; } +span.SRScope { + padding-left: 4px; +} + .SRPage .SRStatus { padding: 2px 5px; font-size: 8pt; @@ -238,3 +236,36 @@ DIV.searchresults { margin-left: 10px; margin-right: 10px; } + +/*---------------- External search page results */ + +.searchresult { + background-color: #F0F3F8; +} + +.pages b { + color: white; + padding: 5px 5px 3px 5px; + background-image: url("../tab_a.png"); + background-repeat: repeat-x; + text-shadow: 0 1px 1px #000000; +} + +.pages { + line-height: 17px; + margin-left: 4px; + text-decoration: none; +} + +.hl { + font-weight: bold; +} + +#searchresults { + margin-bottom: 20px; +} + +.searchpages { + margin-top: 10px; +} + diff --git a/docs/Pack/html/search/search.js b/docs/Pack/html/search/search.js index 2fe3a78..a2a2009 100644 --- a/docs/Pack/html/search/search.js +++ b/docs/Pack/html/search/search.js @@ -7,8 +7,8 @@ var indexSectionsWithContent = { - 0: "acdfprsuxz", - 1: "acdfprsuxz" + 0: "acdfoprsuxz", + 1: "acdfoprsuxz" }; var indexSectionNames = diff --git a/docs/Pack/html/software_component.png b/docs/Pack/html/software_component.png Binary files differnew file mode 100644 index 0000000..f20ac78 --- /dev/null +++ b/docs/Pack/html/software_component.png |
