diff options
| author | Ali Labbene <ali.labbene@st.com> | 2019-12-11 08:59:21 +0100 |
|---|---|---|
| committer | Ali Labbene <ali.labbene@st.com> | 2019-12-16 16:35:24 +0100 |
| commit | 9f95ff5b6ba01db09552b84a0ab79607060a2666 (patch) | |
| tree | 8a6e0dda832555c692307869aed49d07ee7facfe /docs/Pack/html/packIndexFile.html | |
| parent | 76177aa280494bb36d7a0bcbda1078d4db717020 (diff) | |
| download | st-cmsis-core-lowfat-9f95ff5b6ba01db09552b84a0ab79607060a2666.tar.gz st-cmsis-core-lowfat-9f95ff5b6ba01db09552b84a0ab79607060a2666.tar.bz2 st-cmsis-core-lowfat-9f95ff5b6ba01db09552b84a0ab79607060a2666.zip | |
Official ARM version: v5.4.0
Add CMSIS V5.4.0, please refer to index.html available under \docs folder.
Note: content of \CMSIS\Core\Include has been copied under \Include to keep the same structure
used in existing projects, and thus avoid projects mass update
Note: the following components have been removed from ARM original delivery (as not used in ST packages)
- CMSIS_EW2018.pdf
- .gitattributes
- .gitignore
- \Device
- \CMSIS
- \CoreValidation
- \DAP
- \Documentation
- \DoxyGen
- \Driver
- \Pack
- \RTOS\CMSIS_RTOS_Tutorial.pdf
- \RTOS\RTX
- \RTOS\Template
- \RTOS2\RTX
- \Utilities
- All ARM/GCC projects files are deleted from \DSP, \RTOS and \RTOS2
Change-Id: Ia026c3f0f0d016627a4fb5a9032852c33d24b4d3
Diffstat (limited to 'docs/Pack/html/packIndexFile.html')
| -rw-r--r-- | docs/Pack/html/packIndexFile.html | 286 |
1 files changed, 286 insertions, 0 deletions
diff --git a/docs/Pack/html/packIndexFile.html b/docs/Pack/html/packIndexFile.html new file mode 100644 index 0000000..c46e667 --- /dev/null +++ b/docs/Pack/html/packIndexFile.html @@ -0,0 +1,286 @@ +<!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>CMSIS-Pack Index Files</title> +<title>CMSIS-Pack: CMSIS-Pack Index Files</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.5.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('packIndexFile.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">CMSIS-Pack Index Files </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>CMSIS-Pack is designed as a web-based distribution network. Each provider of a CMSIS-Pack (also referred to as <em>vendor</em>) is responsible for hosting, maintaining and publishing unique versions of a CMSIS-Pack.</p> +<p>A CMSIS-Pack is uniquely identified by <vendor>.<pack name>.<version>.pack. All published versions of a pack and the PDSC file need to be available in the same web folder specified by <url>. Multiple different packs may be located in the same web folder.</p> +<h1><a class="anchor" id="pidxFile"></a> +Package Index File (pidx)</h1> +<p>The package index file lists all CMSIS-Packs hosted and maintained by a vendor. The file is hosted by the vendor and has the name <vendor>.pidx. The <vendor> tag needs to match the file name. The file also contains the <url> to it's origin, as well as a <timestamp> of it's last update.</p> +<p>It is the vendor's obligation to update this file whenever:</p> +<ul> +<li>a new pack is added.</li> +<li>a new version of a pack is added.</li> +<li>a pack is deprecated.</li> +<li>a replacement for a pack becomes available.</li> +</ul> +<p><b>Example</b> MyVendor.pidx: </p> +<div class="fragment"><div class="line"><?xml version=<span class="stringliteral">"1.0"</span> encoding=<span class="stringliteral">"UTF-8"</span> ?></div> +<div class="line"></div> +<div class="line"><index schemaVersion=<span class="stringliteral">"1.0.0"</span> xs:noNamespaceSchemaLocation=<span class="stringliteral">"PackIndex.xsd"</span> xmlns:xs=<span class="stringliteral">"http://www.w3.org/2001/XMLSchema-instance"</span>></div> +<div class="line"> <vendor>MyVendor</vendor></div> +<div class="line"> <url>http:<span class="comment">//www.MyVendor.com/pack/</url></span></div> +<div class="line"> <timestamp>2017-01-25T15:00:10.7300074+00:00</timestamp></div> +<div class="line"> <pindex></div> +<div class="line"> <pdsc url=<span class="stringliteral">"http://www.MyVendor.com/pack/mypack/"</span> vendor=<span class="stringliteral">"MyVendor"</span> name=<span class="stringliteral">"MyPack"</span> version=<span class="stringliteral">"1.1.0"</span>/></div> +<div class="line"> ...</div> +<div class="line"> </pindex></div> +<div class="line"></index></div> +</div><!-- fragment --><p>Each individual pack is referenced by the attributes:</p> +<ul> +<li><code>url</code> = web folder where the PDSC and packs reside.</li> +<li><code>vendor</code> = vendor of the pack.</li> +<li><code>name</code> = the name of the pack.</li> +<li><code>version</code> = the version number of the latest available release for the pack.</li> +</ul> +<p>The package index file for the CMSIS-Pack compliant packs, hosted on www.keil.com can be found here: <a href="http://www.keil.com/pack/Keil.pidx">www.keil.com/pack/Keil.pidx</a></p> +<p>The benefit of a single package index file is, that this file only needs to be exchanged once and can be polled for updates and additions of packs by a vendor. To add a vendor's packs to the public list maintained on www.keil.com, send an email to <a href="#" onclick="location.href='mai'+'lto:'+'CMS'+'IS'+'@ar'+'m.'+'com'; return false;">CMSIS@arm.com</a> attaching a version of the <vendor>.pidx file.</p> +<h1><a class="anchor" id="vidxFile"></a> +Vendor Index File (vidx)</h1> +<p>A vendor index file lists package index files from different vendors. This information can be used to compile a list of known packs.</p> +<p><b>Example</b> MyVendor.vidx: </p> +<div class="fragment"><div class="line"><?xml version=<span class="stringliteral">"1.0"</span> encoding=<span class="stringliteral">"UTF-8"</span> ?></div> +<div class="line"></div> +<div class="line"><index schemaVersion=<span class="stringliteral">"1.0"</span> xmlns:xs=<span class="stringliteral">"http://www.w3.org/2001/XMLSchema-instance"</span> xs:noNamespaceSchemaLocation=<span class="stringliteral">"PackIndex.xsd"</span>></div> +<div class="line"> <vendor>MyVendor</vendor></div> +<div class="line"> <url>www.MyVendor.com/pack</url></div> +<div class="line"> <timestamp>2017-01-08T10:30:00</timestamp></div> +<div class="line"> <vindex></div> +<div class="line"> <pidx url=<span class="stringliteral">"http://www.othervendor.com/MyPacks/"</span> vendor=<span class="stringliteral">"OtherVendor"</span> /></div> +<div class="line"> ...</div> +<div class="line"> </vindex></div> +<div class="line"> <!-- the section below is only intended <span class="keywordflow">for</span> the transition until all vendors use the <vendor>.pidx file</div> +<div class="line"> <pindex></div> +<div class="line"> <pdsc url=<span class="stringliteral">"http://www.othervendor2.com/packs/"</span> vendor=<span class="stringliteral">"OtherVendor2"</span> name=<span class="stringliteral">"MyPack"</span> version=<span class="stringliteral">"2.3.0"</span>/></div> +<div class="line"> ...</div> +<div class="line"> </pindex></div> +<div class="line"></index></div> +</div><!-- fragment --><p>The latest index file of CMSIS-Packs belonging to vendor="ARM" and vendor="Keil" that are hosted on www.keil.com/pack is maintained here: <a href="http://www.keil.com/pack/Keil.pidx">www.keil.com/pack/Keil.pidx</a></p> +<p>ARM also maintains a flat list of all CMSIS-Pack compliant packs reported to ARM here: <a href="http://www.keil.com/pack/index.pidx">www.keil.com/pack/index.pidx</a></p> +<p>The vendor index file containing references to the package index files (or optionally PDSC files) used for compiling this summary index file are listed in the Keil.vidx file and can be downloaded from here: <a href="http://www.keil.com/pack/Keil.vidx">www.keil.com/pack/Keil.vidx</a></p> +<p>Based on these publicly available index files, everyone is equally positioned to create an index of available packs and their latest versions.</p> +<h1><a class="anchor" id="packIndexSchema"></a> +CMSIS-Pack Index Schema File</h1> +<pre class="fragment"><?xml version="1.0" encoding="UTF-8"?> +<!-- + + Copyright (c) 2013-2017 ARM Limited. All rights reserved. + + SPDX-License-Identifier: Apache-2.0 + + Licensed under the Apache License, Version 2.0 (the License); you may + not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an AS IS BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + $Date: 23. Januar 2017 + $Revision: 1.1.0 + + $Project: Schema File for Package Index File Format Specification + + Package Index file naming convention <vendor>.pidx + Vendor Index file naming convention <vendor>.vidx + SchemaVersion=1.1.0 +--> + +<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="qualified" version="1.1.0"> + + <!-- semantic versioning (semver.org) <major>.<minor>.<patch>-<quality> --> + <xs:simpleType name="SemanticVersionType"> + <xs:restriction base="xs:string"> + <!-- <major> . <minor> . <patch> - <quality> + <build meta info> --> + <xs:pattern value="(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-(0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(\.(0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*)?(\+[0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*)?"/> + </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 --> + <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="\S(.*\S)?"></xs:pattern> + </xs:restriction> + </xs:simpleType> + + <!-- Vendor index file Description Type --> + <xs:complexType name="VidxType"> + <xs:attribute name="url" type="xs:anyURI" use="required"/> + <xs:attribute name="vendor" type="RestrictedString" use="required"/> + <xs:attribute name="date" type="xs:date" use="optional"/> + </xs:complexType> + + <!-- Package Description Type --> + <xs:complexType name="PdscType"> + <xs:attribute name="url" type="xs:anyURI" use="required"/> + <xs:attribute name="vendor" type="RestrictedString" use="required"/> + <xs:attribute name="name" type="RestrictedString" use="required"/> + <xs:attribute name="version" type="SemanticVersionType" use="required"/> + <xs:attribute name="date" type="xs:date" use="optional"/> + <xs:attribute name="deprecated" type="xs:date" use="optional"/> + <xs:attribute name="replacement" type="RestrictedString" use="optional"/> + <xs:attribute name="size" type="xs:unsignedInt" use="optional"/> + </xs:complexType> + + <!-- Package Description file Type --> + <xs:complexType name="PindexType"> + <xs:sequence> + <xs:element name="pdsc" type="PdscType" maxOccurs="unbounded"/> + </xs:sequence> + </xs:complexType> + + <!-- Vendor vendor's package index file tag --> + <xs:complexType name="VindexType"> + <xs:sequence> + <xs:element name="pidx" type="VidxType" maxOccurs="unbounded"/> + </xs:sequence> + </xs:complexType> + + <!-- Index description root point (Vendor Index file, Package Index file --> + <xs:element name="index" nillable="true"> + <xs:complexType> + <xs:sequence> + <xs:element name="vendor" type="RestrictedString"/> + <xs:element name="url" type="xs:anyURI"/> + <xs:element name="timestamp" type="xs:dateTime" minOccurs="0"/> + <xs:choice minOccurs="1" maxOccurs="2"> + <!-- index/list of packs --> + <xs:element name="pindex" type="PindexType"/> + <!-- index/list of vendor index files --> + <xs:element name="vindex" type="VindexType"/> + </xs:choice> + </xs:sequence> + <xs:attribute name="schemaVersion" type="SemanticVersionType" use="required"/> + </xs:complexType> + </xs:element> +</xs:schema> +</pre> </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:43 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> |