238 lines
14 KiB
HTML
238 lines
14 KiB
HTML
|
<!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>Pack Example</title>
|
||
|
|
<title>CMSIS-Pack: Pack Example</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('pack_Example.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">Pack Example </div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<div class="textblock"><p>The <b>ARM::CMSIS</b> Pack contains an example of a Software Pack that contains device support, board support and software components. This Pack can be used as a reference for user generated Software Packs. It is available in the directory \CMSIS\Pack\Example. It contains a <a class="el" href="pack_Example.html#PE_PDSC">PDSC example file</a> and all sub-directories containing the files referenced in the PDSC. <br/>
|
||
|
|
The example is a <a class="el" href="createPack_DFP.html">DFP</a> for NXP's LPC1800 series of microcontrollers. It also contains <a class="el" href="createPackBoard.html">BSP</a> information and software components, mainly peripheral drivers. Some of the drivers adhere to the <a href="../../Driver/html/index.html" class="el" target="_blank">CMSIS-Driver</a> standard. This is the layout of the sub-directories: </p>
|
||
|
|
<table class="doxtable">
|
||
|
|
<tr>
|
||
|
|
<th>Directory </th><th>Content </th><th>Section in PDSC </th></tr>
|
||
|
|
<tr>
|
||
|
|
<td><b>Boards</b> </td><td>CMSIS-RTOS Blinky uVision project running on the MCB1800 development board </td><td><a class="el" href="pdsc_examples_pg.html"><examples></a> </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><a class="el" href="pack_Example.html#PE_CMSIS_Driver">CMSIS_Driver</a></td><td><a href="../../Driver/html/index.html"><b>CMSIS-Driver</b></a> compliant peripheral drivers</td><td><a class="el" href="pdsc_components_pg.html#element_component"><component></a> </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><a class="el" href="pack_Example.html#PE_Device">Device</a> </td><td><a href="../../Core/html/index.html"><b>CMSIS-CORE</b></a> files for LPC1800 series </td><td><a class="el" href="pdsc_family_pg.html#element_device"><device></a> </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><a class="el" href="pack_Example.html#PE_Documents">Documents</a> </td><td>Documentation for devices and boards </td><td><a class="el" href="pdsc_family_pg.html#element_book"><book></a> </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><b>Flash</b> </td><td><a class="el" href="flashAlgorithm.html">Flash Programming Algorithms</a> and a sub-directory called <b>LPC18xx43xx_IAP</b> containing a uVision project for IAP (In-Application Programming) support</td><td><a class="el" href="pdsc_family_pg.html#element_algorithm"><algorithm></a> </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><b>Images</b> </td><td>Images of the MCB1800 development board </td><td><a class="el" href="pdsc_boards_pg.html"><board></a> </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><b>SVD</b> </td><td><a href="../../SVD/html/index.html"><b>SVD</b></a> file for LPC1800 series </td><td><a class="el" href="pdsc_family_pg.html#element_debug"><debug></a> </td></tr>
|
||
|
|
</table>
|
||
|
|
<p><a class="anchor" id="PE_PDSC"></a></p>
|
||
|
|
<h2>PDSC Example File </h2>
|
||
|
|
<p>The PDSC file that is included in the example Pack is called <b>Keil.LPC1800_DFP.pdsc.txt</b>. The extension <code>txt</code> has been added to hide the file from development tools as it is not intended for installation. The file contains the following top level elements: </p>
|
||
|
|
<table class="doxtable">
|
||
|
|
<tr>
|
||
|
|
<th>XML Element </th><th>Purpose </th></tr>
|
||
|
|
<tr>
|
||
|
|
<td><a class="el" href="pdsc_package_pg.html"><package></a> </td><td>Publish Pack information like vendor, name, version, etc. </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><a class="el" href="pdsc_devices_pg.html"><devices></a> </td><td>Define four sub-families with 16 devices in total. </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><a class="el" href="pdsc_boards_pg.html"><boards></a> </td><td>Show MCB1800 development board information. </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><a class="el" href="pdsc_conditions_pg.html"><conditions></a> </td><td>Declare required conditions for software components. </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><a class="el" href="pdsc_components_pg.html"><components></a> </td><td>Include startup/system files, HAL drivers, and CMSIS-Driver 2.0 compliant peripheral drivers. </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><a class="el" href="pdsc_examples_pg.html"><examples></a> </td><td>Contain a CMSIS-RTOS Blinky example project for uVision running on the MCB1800 development board. </td></tr>
|
||
|
|
</table>
|
||
|
|
<p><a class="anchor" id="PE_CMSIS_Driver"></a></p>
|
||
|
|
<h2>Directory CMSIS_Driver </h2>
|
||
|
|
<p>The <b>CMSIS_Driver</b> directory contains the following <a href="../../Driver/html/index.html" class="el" target="_blank">CMSIS-Driver</a> compliant peripheral drivers. These drivers are supporting the NXP LPC1800 series: </p>
|
||
|
|
<table class="doxtable">
|
||
|
|
<tr>
|
||
|
|
<th>Driver </th><th>File </th><th>Software Component </th></tr>
|
||
|
|
<tr>
|
||
|
|
<td><a href="../../Driver/html/group__eth__interface__gr.html" class="el" target="_blank">Ethernet</a> </td><td>EMAC_LPC18xx.c </td><td><b>::CMSIS-Driver:Ethernet MAC</b> </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><a href="../../Driver/html/group__spi__interface__gr.html" class="el" target="_blank">SPI</a> </td><td>SSP_LPC18xx.c </td><td><b>::CMSIS-Driver:SPI</b> </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><a href="../../Driver/html/group__i2c__interface__gr.html" class="el" target="_blank">I2C</a> </td><td>I2C_LPC18xx.c </td><td><b>::CMSIS-Driver:I2C</b> </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><a href="../../Driver/html/group__mci__interface__gr.html" class="el" target="_blank">MCI</a> </td><td>MCI_LPC18xx.c </td><td><b>::CMSIS-Driver:MCI</b> </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><a href="../../Driver/html/group__usart__interface__gr.html" class="el" target="_blank">USART</a> </td><td>USART_LPC18xx.c </td><td><b>::CMSIS-Driver:USART</b> </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><a href="../../Driver/html/group__usbd__interface__gr.html" class="el" target="_blank">USB Device</a> </td><td>USBD_LPC18xx.c </td><td><b>::CMSIS-Driver:USB Device:USB0/1</b> </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><a href="../../Driver/html/group__usbh__interface__gr.html" class="el" target="_blank">USB Host</a> </td><td>USBH_LPC18xx.c </td><td><b>::CMSIS-Driver:USB Host:USB0/1</b> </td></tr>
|
||
|
|
</table>
|
||
|
|
<p>The following HAL drivers are required for the implementation of the <b>CMSIS-Driver</b> compliant peripheral drivers: </p>
|
||
|
|
<table class="doxtable">
|
||
|
|
<tr>
|
||
|
|
<th>Driver </th><th>File </th><th>Software Component </th></tr>
|
||
|
|
<tr>
|
||
|
|
<td>General purpose DMA driver </td><td>GPDMA_LPC18xx.c </td><td><b>::Device:GPDMA</b> </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td>General purpose IO driver </td><td>GPIO_LPC18xx.c </td><td><b>::Device:GPIO</b> </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td>System control unit driver </td><td>SCU_LPC18xx.c </td><td><b>::Device:SCU</b> </td></tr>
|
||
|
|
</table>
|
||
|
|
<p><a class="anchor" id="PE_Device"></a></p>
|
||
|
|
<h2>Directory Device </h2>
|
||
|
|
<p>The <b>Device</b> directory has two sub-directories: <b>Include</b> and <b>Source</b>. </p>
|
||
|
|
<table class="doxtable">
|
||
|
|
<tr>
|
||
|
|
<th>File </th><th>Purpose </th><th>Software Component </th></tr>
|
||
|
|
<tr>
|
||
|
|
<td>Include\LPC18xx.h </td><td>LPC1800 series header file </td><td><b>::CMSIS:CORE</b> </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td>Include\system_LPC18xx.h </td><td>LPC1800 series system header file </td><td><b>::CMSIS:Startup</b> </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td>Source\system_LPC18xx.c </td><td>LPC1800 series system source file </td><td><b>::CMSIS:Startup</b> </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td>Source\ARM\startup_LPC18xx.s </td><td>LPC1800 series startup assembler file for ARMCC</td><td><b>::CMSIS:Startup</b> </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td>Source\GCC\startup_LPC18xx.S </td><td>LPC1800 series startup assembler file for GCC </td><td><b>::CMSIS:Startup</b> </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td>Source\IAR\startup_LPC18xx.s </td><td>LPC1800 series startup assembler file for IAR </td><td><b>::CMSIS:Startup</b> </td></tr>
|
||
|
|
</table>
|
||
|
|
<p><a class="anchor" id="PE_Documents"></a></p>
|
||
|
|
<h2>Directory Documents </h2>
|
||
|
|
<p>This directory incorporates the following documents: </p>
|
||
|
|
<table class="doxtable">
|
||
|
|
<tr>
|
||
|
|
<th>File </th><th>Purpose </th><th>Section in PDSC </th></tr>
|
||
|
|
<tr>
|
||
|
|
<td><b>dui0552a_cortex_m3_dgug.pdf</b> </td><td>Cortex-M3 Generic User Guide</td><td><a class="el" href="pdsc_family_pg.html#element_book"><book></a> element of the device <a class="el" href="pdsc_family_pg.html#element_family"><family></a> element </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><b>ES_LPC18X0.pdf</b> </td><td>LPC1800 Errata sheet </td><td><a class="el" href="pdsc_family_pg.html#element_book"><book></a> element of the <a class="el" href="pdsc_family_pg.html#element_device"><device></a> section </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><b>LPC1850_30_20_10.pdf</b> </td><td>LPC1800 Data sheet </td><td><a class="el" href="pdsc_family_pg.html#element_book"><book></a> element of the <a class="el" href="pdsc_family_pg.html#element_device"><device></a> section </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><b>mcb1800.chm</b> </td><td>MCB1800/4300 User's Guide </td><td><a class="el" href="pdsc_boards_pg.html#element_board_book"><book></a> element of the <a class="el" href="pdsc_boards_pg.html"><boards></a> section </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><b>MCB1800v1-3-schematics.chm</b> </td><td>MCB1800 schematics </td><td><a class="el" href="pdsc_boards_pg.html#element_board_book"><book></a> element of the <a class="el" href="pdsc_boards_pg.html"><boards></a> section </td></tr>
|
||
|
|
<tr>
|
||
|
|
<td><b>UM10430.pdf</b> </td><td>User manual for LPC1800 </td><td><a class="el" href="pdsc_family_pg.html#element_book"><book></a> element of the <a class="el" href="pdsc_family_pg.html#element_device"><device></a> section </td></tr>
|
||
|
|
</table>
|
||
|
|
<dl class="section note"><dt>Note</dt><dd>Some of these documents are only placeholders for copyright reasons. </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="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>
|