554 lines
39 KiB
HTML
554 lines
39 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>/package/generators element</title>
|
|
<title>CMSIS-Pack: /package/generators 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.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_generators_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">/package/generators element </div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><p>The element <a class="el" href="pdsc_generators_pg.html#element_generator">/package/generators/generator</a> specifies a tool or utility that is used to generate and/or configure software (source code, header files, configuration files, etc.) in the context of a project. For this purpose, a generator package description file (GPDSC) needs to be created (see <a class="el" href="pdsc_generators_pg.html#pdsc_generators_gpdsc"><gpdsc></a>). The GPDSC file details the selected device, components, project files and conditions, as well as information about the generator and how it can be launched again for iterative development cycles. A GPDSC file follows the same schema as a static PACK. However, the files generated by the utility are not installed and managed centrally in the PACK folder, but locally within the project folder.</p>
|
|
<p>A generator can be associated with a component by it's name. Selecting the component will automatically include the files provided by the generator in the project. If the specified GPDSC file is not present, the generator command is executed by the environment to generate the files and GPDSC. In this way project specific configurations can be made, files being generated and included and maintained as part of the project.</p>
|
|
<p><a class="anchor" id="pdsc_generators_gen_sec"></a><b>Example</b> Generator Section </p>
|
|
<div class="fragment"><div class="line"><generators></div>
|
|
<div class="line"> <generator <span class="keywordtype">id</span> = <span class="stringliteral">"MyGen"</span>></div>
|
|
<div class="line"> <gpdsc name =<span class="stringliteral">"$P/RTE/MyGen/myGen.gpdsc"</span>/></div>
|
|
<div class="line"> <exe></div>
|
|
<div class="line"> <command host = <span class="stringliteral">"win"</span>>MyGen.bat</command></div>
|
|
<div class="line"> <command host = <span class="stringliteral">"linux"</span>>MyGen.script</command></div>
|
|
<div class="line"> <argument>$P/RTE/MyGen/myGen.gpdsc</argument></div>
|
|
<div class="line"> <argument host=<span class="stringliteral">"linux"</span> <span class="keywordflow">switch</span>=<span class="stringliteral">"--device="</span>>#D</argument></div>
|
|
<div class="line"> <argument host=<span class="stringliteral">"win"</span> <span class="keywordflow">switch</span>=<span class="stringliteral">"/device="</span>>#D</argument></div>
|
|
<div class="line"> </exe></div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <eclipse plugin=<span class="stringliteral">"com.mygen.plugin"</span> <span class="keyword">class</span>=<span class="stringliteral">"com.mygen.plugin.generator.launcher"</span> method=<span class="stringliteral">"launch"</span> ></div>
|
|
<div class="line"> <argument>#D</argument></div>
|
|
<div class="line"> <argument>$P/RTE/MyGen/myGen.gpdsc</argument></div>
|
|
<div class="line"> </eclipse></div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <web url=<span class="stringliteral">"http://mygen.com/mygen"</span>></div>
|
|
<div class="line"> <argument <span class="keywordflow">switch</span>=<span class="stringliteral">"device"</span>>#D</argument></div>
|
|
<div class="line"> <argument <span class="keywordflow">switch</span>=<span class="stringliteral">"gpdsc"</span>>$P/RTE/MyGen/myGen.gpdsc</argument></div>
|
|
<div class="line"> </web></div>
|
|
<div class="line"> </generator></div>
|
|
<div class="line"></generators></div>
|
|
</div><!-- fragment --><p><a class="anchor" id="pdsc_generators_gpdsc"></a><b>Example</b> Generator Package Description File (gpdsc) </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"><<span class="keyword">package </span>xmlns:xs="http:<span class="comment">//www.w3.org/2001/XMLSchema-instance" schemaVersion="1.0" xs:noNamespaceSchemaLocation="PACK.xsd"></span></div>
|
|
<div class="line"> <vendor>Keil</vendor></div>
|
|
<div class="line"> <name>FrameworkCubeMX</name></div>
|
|
<div class="line"> <description>STM32CubeMX generated pack description</description></div>
|
|
<div class="line"> <url>project-path</url></div>
|
|
<div class="line"> <releases></div>
|
|
<div class="line"> <release version="1.0.0"></div>
|
|
<div class="line"> - Generated: 08/11/2016 09:20:21</div>
|
|
<div class="line"> </release></div>
|
|
<div class="line"> </releases></div>
|
|
<div class="line"> <generators></div>
|
|
<div class="line"> <generator id="STM32CubeMX" Gvendor="STMicroelectronics" Gtool="STM32CubeMX" Gversion="4.10.0"></div>
|
|
<div class="line"> <description>STM32CubeMX Environment</description></div>
|
|
<div class="line"> <select Dname="STM32F746NGHx" Dvendor="STMicroelectronics:13"/></div>
|
|
<div class="line"> <exe></div>
|
|
<div class="line"> <command host = "win">$SMDK/CubeMX/STM32CubeMXLauncher.exe</command></div>
|
|
<div class="line"> <command host = "linux">$SMDK/CubeMX/STM32CubeMXLauncher</command></div>
|
|
<div class="line"> <argument>$P/RTE/MyGen/myGen.gpdsc</argument></div>
|
|
<div class="line"> <argument>#D.ioc</argument></div>
|
|
<div class="line"> </exe></div>
|
|
<div class="line"> <workingDir>$PRTE/Device/STM32F746NGHx</workingDir></div>
|
|
<div class="line"> <project_files></div>
|
|
<div class="line"> <file category="source" name="STCubeGenerated/Src/main.c" /></div>
|
|
<div class="line"> <file category="header" name="STCubeGenerated/Inc/stm32f7xx_it.h"/></div>
|
|
<div class="line"> <file category="source" name="STCubeGenerated/Src/stm32f7xx_it.c"/></div>
|
|
<div class="line"> </project_files></div>
|
|
<div class="line"> </generator></div>
|
|
<div class="line"> </generators></div>
|
|
<div class="line"> <taxonomy></div>
|
|
<div class="line"> <description Cclass="Device" Cgroup="STM32Cube Framework" generator="STM32CubeMX">STM32Cube Framework</description></div>
|
|
<div class="line"> </taxonomy></div>
|
|
<div class="line"> <conditions></div>
|
|
<div class="line"> <condition id="STCubeMX"></div>
|
|
<div class="line"> <description>Condition to include CMSIS core and Device Startup components</description></div>
|
|
<div class="line"> <require Dvendor="STMicroelectronics:13" Dname="STM32F7*"/></div>
|
|
<div class="line"> <require Cclass="CMSIS" Cgroup="CORE" Csub=""/></div>
|
|
<div class="line"> <require Cclass="Device" Cgroup="Startup"/></div>
|
|
<div class="line"> <require Cclass="Device" Cgroup="STM32Cube HAL" Csub="Common"/></div>
|
|
<div class="line"> <require Cclass="Device" Cgroup="STM32Cube HAL" Csub="GPIO"/></div>
|
|
<div class="line"> </condition></div>
|
|
<div class="line"> </conditions></div>
|
|
<div class="line"> <components></div>
|
|
<div class="line"> <component generator="STM32CubeMX" Cvendor="Keil" Cclass="Device" Cgroup="STM32Cube Framework" Csub="STM32CubeMX" Cversion="1.0.0" condition="STCubeMX"></div>
|
|
<div class="line"> <description>Configuration via STM32CubeMX</description></div>
|
|
<div class="line"> <RTE_Components_h></div>
|
|
<div class="line"> #define RTE_DEVICE_FRAMEWORK_CUBE_MX</div>
|
|
<div class="line"> </RTE_Components_h></div>
|
|
<div class="line"> <files></div>
|
|
<div class="line"> <file category="header" name="MX_Device.h"/></div>
|
|
<div class="line"> <file category="header" name="STCubeGenerated/Inc/stm32f7xx_hal_conf.h"/></div>
|
|
<div class="line"> <file category="source" name="STCubeGenerated/Src/stm32f7xx_hal_msp.c"/></div>
|
|
<div class="line"> </files></div>
|
|
<div class="line"> </component></div>
|
|
<div class="line"> </components></div>
|
|
<div class="line"></package></div>
|
|
</div><!-- fragment --> <p> </p>
|
|
<hr/>
|
|
<h1><a class="anchor" id="element_generators"></a>
|
|
/package/generators</h1>
|
|
<p>Grouping element for <b>generators</b>. Only one such group can exist in a PACK.</p>
|
|
<table class="cmtable" summary="Element: Generator">
|
|
<tr>
|
|
<th>Parent </th><th colspan="3">Chain </th></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_package_pg.html">package</a> </td><td colspan="3"><a class="el" href="pdsc_package_pg.html">/package</a> </td></tr>
|
|
<tr>
|
|
<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_generators_pg.html#element_generator">generator</a> </td><td>Description of the generator and the related files </td><td><a class="el" href="pdsc_generators_pg.html#element_generator">GeneratorType</a> </td><td>1..* </td></tr>
|
|
</table>
|
|
<p>The following variables can be used in the elements <code><command></code>, <code><workingDir></code>, <code><argument></code>, <code><gpdsc></code>:</p>
|
|
<table class="cmtable" summary="Supported Variables within Generator">
|
|
<tr>
|
|
<th>Variable </th><th>Description </th></tr>
|
|
<tr>
|
|
<td>$P </td><td>PATH to current project </td></tr>
|
|
<tr>
|
|
<td>#P </td><td>PATH and name of the current project </td></tr>
|
|
<tr>
|
|
<td>$S </td><td>PATH to PACK folder containing the Device description used by the current project </td></tr>
|
|
<tr>
|
|
<td>$D </td><td>Name of the device configured in the current project </td></tr>
|
|
</table>
|
|
<p> </p>
|
|
<hr/>
|
|
<h1><a class="anchor" id="element_generator"></a>
|
|
/package/generators/generator</h1>
|
|
<p>The generator section is used to provide the details about the tool that has been used to create the GPDSC file. At least one generator element must exist.</p>
|
|
<table class="cmtable" summary="Element: Generator">
|
|
<tr>
|
|
<th>Parent </th><th colspan="3">Chain </th></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_generators_pg.html#element_generators">generators</a> </td><td colspan="3"><a class="el" href="pdsc_generators_pg.html#element_generators">/package/generators</a> </td></tr>
|
|
<tr>
|
|
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
|
|
<tr>
|
|
<td>id </td><td>Identifier of the generator tool. Can be used by other elements to determine the generator. </td><td>xs:string </td><td>required </td></tr>
|
|
<tr>
|
|
<td>Gvendor </td><td>Vendor name of the generator tool. </td><td>xs:string </td><td>optional </td></tr>
|
|
<tr>
|
|
<td>Gtool </td><td>Plain text name of the generator. </td><td>xs:string </td><td>optional </td></tr>
|
|
<tr>
|
|
<td>Gversion </td><td>Version of the generator tool. </td><td>xs:string </td><td>optional </td></tr>
|
|
<tr>
|
|
<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
|
|
<tr>
|
|
<td>description </td><td>Briefly describes the generator tool. </td><td>xs:string </td><td>0..1 </td></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_generators_pg.html#element_gen_select">select</a> </td><td>Complex type specifying the configured device. A device is uniquely identified by vendor, name or variant and processor name in case of devices with multiple processors. </td><td>GeneratorSelectType </td><td>0..1 </td></tr>
|
|
<tr>
|
|
<td>workingDir </td><td>Directory to be set as current directory before launching the <code><command></code>. This is either an absolute or relative path to PDSC or GPDSC file. If not specified, the current directory is the directory of the project configured by the environment. </td><td>xs:string </td><td>0..1 </td></tr>
|
|
<tr>
|
|
<td>command </td><td><span class="XML-Token">Deprecated; use exe, web and/or eclipse</span>. Invocation command for the generator tool. </td><td>xs:string </td><td>0..1 </td></tr>
|
|
<tr>
|
|
<td>arguments </td><td><span class="XML-Token">Deprecated; use argument tags under exe, web and/or eclipse</span>. </td><td>GeneratorCommandArgumentsType </td><td>0..1 </td></tr>
|
|
<tr>
|
|
<td>gpdsc </td><td>Path and name of the GPDSC that the generator creates and updates. The path is either absolute or relative to the working directory. If no explicit gpdsc file is provided, then a gpdsc file named after the project with extension gpdsc in the working directory is assumed (<code><project></code>.gpdsc). </td><td>xs:string </td><td>0..1 </td></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_generators_pg.html#element_gen_exe">exe</a> </td><td>Section to specify a binary/executable to generate the GPDSC file. </td><td>xs:string </td><td>0..1 </td></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_generators_pg.html#element_gen_eclipse">eclipse</a> </td><td>Section to specify an Eclipse plug-in to generate the GPDSC file. </td><td>xs:string </td><td>0..1 </td></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_generators_pg.html#element_gen_web">web</a> </td><td>Section to specify a web page to generate the GPDSC file. </td><td>xs:string </td><td>0..1 </td></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_generators_pg.html#element_gen_project_files">project_files</a> </td><td>Grouping element for all project files generated by the tool. </td><td>group </td><td>0..1 </td></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_components_pg.html#element_files">files</a> </td><td>Grouping element for generator tool files. </td><td>group </td><td>0..1 </td></tr>
|
|
<tr>
|
|
<td>extensions </td><td>Generator vendor specific section ignored by other tools </td><td>N/A </td><td>0..1 </td></tr>
|
|
</table>
|
|
<p> </p>
|
|
<hr/>
|
|
<h1><a class="anchor" id="element_gen_select"></a>
|
|
/package/generators/generator/select</h1>
|
|
<p>This element contains information about the vendor and device the GPDSC file has been generated for. Only one such element can exist in <code><generators></code>.</p>
|
|
<p><b>Example:</b> </p>
|
|
<div class="fragment"><div class="line"><generators></div>
|
|
<div class="line"> <generator <span class="keywordtype">id</span>=<span class="stringliteral">"STM32CubeMX"</span> Gvendor=<span class="stringliteral">"STMicroelectronics"</span> Gtool=<span class="stringliteral">"STM32CubeMX"</span> Gversion=<span class="stringliteral">"4.10.0"</span>></div>
|
|
<div class="line"> <select Dname=<span class="stringliteral">"STM32F746NGHx"</span> Dvendor=<span class="stringliteral">"STMicroelectronics:13"</span>/></div>
|
|
<div class="line"> </generator></div>
|
|
<div class="line"></generators></div>
|
|
</div><!-- fragment --> <p> </p>
|
|
<table class="cmtable" summary="Element: Generator Select">
|
|
<tr>
|
|
<th>Parent </th><th colspan="3">Chain </th></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_generators_pg.html#element_generator">generator</a> </td><td colspan="3"><a class="el" href="pdsc_generators_pg.html#element_generator">/package/generators/generator</a> </td></tr>
|
|
<tr>
|
|
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
|
|
<tr>
|
|
<td>Dvendor </td><td>Vendor name of the targeted 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>required </td></tr>
|
|
<tr>
|
|
<td>Dname </td><td>Name of the targeted device. If no Dvariant is specified this tag is required </td><td>xs:string </td><td>optional </td></tr>
|
|
<tr>
|
|
<td>Dvariant </td><td>Name of the targeted device variant. If a variant is specified, the device name will be ignored and the variant rules. If no Dname is specified, this tag is required. </td><td>xs:string </td><td>optional </td></tr>
|
|
<tr>
|
|
<td>Pname </td><td>Name of the targeted processor of a device with multiple processors. For devices with multiple processors this tag is required. </td><td>xs:string </td><td>optional </td></tr>
|
|
</table>
|
|
<p> </p>
|
|
<hr/>
|
|
<h1><a class="anchor" id="element_gen_exe"></a>
|
|
/package/generators/generator/exe</h1>
|
|
<p>This element contains information about the generation binary/executable.</p>
|
|
<p><b>Example:</b> </p>
|
|
<div class="fragment"><div class="line"><exe></div>
|
|
<div class="line"> <command host = <span class="stringliteral">"win"</span>>MyGen.bat</command></div>
|
|
<div class="line"> <command host = <span class="stringliteral">"linux"</span>>MyGen.script</command></div>
|
|
<div class="line"> <argument>$P/RTE/MyGen/myGen.gpdsc</argument></div>
|
|
<div class="line"> <argument host=<span class="stringliteral">"linux"</span> <span class="keywordflow">switch</span>=<span class="stringliteral">"--device="</span>>#D</argument></div>
|
|
<div class="line"> <argument host=<span class="stringliteral">"win"</span> <span class="keywordflow">switch</span>=<span class="stringliteral">"/device="</span>>#D</argument></div>
|
|
<div class="line"></exe></div>
|
|
</div><!-- fragment --> <p> </p>
|
|
<table class="cmtable" summary="Element: Exe">
|
|
<tr>
|
|
<th>Parent </th><th colspan="3">Chain </th></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_generators_pg.html#element_generator">generator</a> </td><td colspan="3"><a class="el" href="pdsc_generators_pg.html#element_generator">/package/generators/generator</a> </td></tr>
|
|
<tr>
|
|
<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_generators_pg.html#element_gen_command">command</a> </td><td>Invocation command for the generator tool. Command line options should be passed via <code><arguments></code>. </td><td><a class="el" href="pdsc_generators_pg.html#element_gen_command">GeneratorCommandType</a> </td><td>1..4 </td></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_generators_pg.html#element_gen_argument">argument</a> </td><td>Arguments passed along with the <code><command></code> of the format <code><argument</code> <code>switch="-data">myFileName</argument></code>. Path information for files can be specified absolute or relative to the location (path) of the GPDSC file. </td><td><a class="el" href="pdsc_generators_pg.html#element_gen_argument">GeneratorCommandArgumentType</a> </td><td>1..* </td></tr>
|
|
</table>
|
|
<p> </p>
|
|
<hr/>
|
|
<h1><a class="anchor" id="element_gen_eclipse"></a>
|
|
/package/generators/generator/eclipse</h1>
|
|
<p>This element contains information about the Eclipse based generation tool.</p>
|
|
<p><b>Example:</b> </p>
|
|
<div class="fragment"><div class="line"><eclipse plugin=<span class="stringliteral">"com.mygen.plugin"</span> <span class="keyword">class</span>=<span class="stringliteral">"com.mygen.plugin.generator.launcher"</span> method=<span class="stringliteral">"launch"</span> ></div>
|
|
<div class="line"> <argument>#D</argument></div>
|
|
<div class="line"> <argument>$P/RTE/MyGen/myGen.gpdsc</argument></div>
|
|
<div class="line"></eclipse></div>
|
|
</div><!-- fragment --> <p> </p>
|
|
<table class="cmtable" summary="Element: Eclipse">
|
|
<tr>
|
|
<th>Parent </th><th colspan="3">Chain </th></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_generators_pg.html#element_generator">generator</a> </td><td colspan="3"><a class="el" href="pdsc_generators_pg.html#element_generator">/package/generators/generator</a> </td></tr>
|
|
<tr>
|
|
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
|
|
<tr>
|
|
<td>plugin </td><td>Name of the plugin. </td><td>xs:string </td><td>required </td></tr>
|
|
<tr>
|
|
<td>class </td><td>Plugin's class name. </td><td>xs:string </td><td>required </td></tr>
|
|
<tr>
|
|
<td>method </td><td>Method used to launch the plugin. </td><td>xs:string </td><td>required </td></tr>
|
|
<tr>
|
|
<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_generators_pg.html#element_gen_argument">argument</a> </td><td>Arguments passed to the plugin. </td><td><a class="el" href="pdsc_generators_pg.html#element_gen_argument">GeneratorCommandArgumentType</a> </td><td>1..* </td></tr>
|
|
</table>
|
|
<p> </p>
|
|
<hr/>
|
|
<h1><a class="anchor" id="element_gen_web"></a>
|
|
/package/generators/generator/web</h1>
|
|
<p>This element contains information about the web generation application.</p>
|
|
<p><b>Example:</b> </p>
|
|
<div class="fragment"><div class="line"><web url=<span class="stringliteral">"http://mygen.com/mygen"</span>></div>
|
|
<div class="line"> <argument <span class="keywordflow">switch</span>=<span class="stringliteral">"device"</span>>#D</argument></div>
|
|
<div class="line"> <argument <span class="keywordflow">switch</span>=<span class="stringliteral">"gpdsc"</span>>$P/RTE/MyGen/myGen.gpdsc</argument></div>
|
|
<div class="line"></web></div>
|
|
</div><!-- fragment --> <p> </p>
|
|
<table class="cmtable" summary="Element: Web">
|
|
<tr>
|
|
<th>Parent </th><th colspan="3">Chain </th></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_generators_pg.html#element_generator">generator</a> </td><td colspan="3"><a class="el" href="pdsc_generators_pg.html#element_generator">/package/generators/generator</a> </td></tr>
|
|
<tr>
|
|
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
|
|
<tr>
|
|
<td>url </td><td>Specifies the URL of the web service. </td><td>URL </td><td>required </td></tr>
|
|
<tr>
|
|
<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_generators_pg.html#element_gen_argument">argument</a> </td><td>Arguments passed along to the web service. </td><td><a class="el" href="pdsc_generators_pg.html#element_gen_argument">GeneratorCommandArgumentType</a> </td><td>0..* </td></tr>
|
|
</table>
|
|
<p> </p>
|
|
<hr/>
|
|
<h1><a class="anchor" id="element_gen_command"></a>
|
|
/package/generators/generator/.../command</h1>
|
|
<p>This element describes a single command line for launching the generator. Arguments should be passed along with an <a class="el" href="pdsc_generators_pg.html#element_gen_argument">argument</a>.</p>
|
|
<p><b>Example</b> </p>
|
|
<div class="fragment"><div class="line"><exe></div>
|
|
<div class="line"> <command host = <span class="stringliteral">"win"</span>>MyGen.bat</command></div>
|
|
<div class="line"> <command host = <span class="stringliteral">"linux"</span>>MyGen.script</command></div>
|
|
<div class="line"> <argument>$P/RTE/MyGen/myGen.gpdsc</argument></div>
|
|
<div class="line"> <argument host=<span class="stringliteral">"linux"</span> <span class="keywordflow">switch</span>=<span class="stringliteral">"--device="</span>>#D</argument></div>
|
|
<div class="line"> <argument host=<span class="stringliteral">"win"</span> <span class="keywordflow">switch</span>=<span class="stringliteral">"/device="</span>>#D</argument></div>
|
|
<div class="line"></exe></div>
|
|
</div><!-- fragment --><p> </p>
|
|
<table class="cmtable" summary="Element: Generator Command Argument">
|
|
<tr>
|
|
<th>Parent </th><th colspan="3">Element Chain </th></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_generators_pg.html#element_gen_exe">exe</a> </td><td colspan="3"><a class="el" href="pdsc_generators_pg.html#element_gen_exe">/package/generators/generator/exe</a> </td></tr>
|
|
<tr>
|
|
<th>Current </th><th>Description </th><th colspan="2">Type </th></tr>
|
|
<tr>
|
|
<td>command </td><td>generator command line </td><td colspan="2">xs:string </td></tr>
|
|
<tr>
|
|
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
|
|
<tr>
|
|
<td>host </td><td>Specifies the host operating system. Possible values are <code>all</code>, <code>win</code>, <code>linux</code>, <code>mac</code>, <code>other</code>. Only available with element <a class="el" href="pdsc_generators_pg.html#element_gen_exe">exe</a>. </td><td>xs:string </td><td>optional </td></tr>
|
|
</table>
|
|
<p> </p>
|
|
<hr/>
|
|
<h1><a class="anchor" id="element_gen_argument"></a>
|
|
/package/generators/generator/.../argument</h1>
|
|
<p>This element describes one or multiple arguments passed along with the parent element.</p>
|
|
<p><b>Example</b> </p>
|
|
<div class="fragment"><div class="line"><generators></div>
|
|
<div class="line"> <generator <span class="keywordtype">id</span> = <span class="stringliteral">"MyGen"</span>></div>
|
|
<div class="line"> <gpdsc name =<span class="stringliteral">"$P/RTE/MyGen/myGen.gpdsc"</span>/></div>
|
|
<div class="line"> <exe></div>
|
|
<div class="line"> <command host = <span class="stringliteral">"win"</span>>MyGen.bat</command></div>
|
|
<div class="line"> <command host = <span class="stringliteral">"linux"</span>>MyGen.script</command></div>
|
|
<div class="line"> <argument>$P/RTE/MyGen/myGen.gpdsc</argument></div>
|
|
<div class="line"> <argument host=<span class="stringliteral">"linux"</span> <span class="keywordflow">switch</span>=<span class="stringliteral">"--device="</span>>#D</argument></div>
|
|
<div class="line"> <argument host=<span class="stringliteral">"win"</span> <span class="keywordflow">switch</span>=<span class="stringliteral">"/device="</span>>#D</argument></div>
|
|
<div class="line"> </exe></div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <eclipse plugin=<span class="stringliteral">"com.mygen.plugin"</span> <span class="keyword">class</span>=<span class="stringliteral">"com.mygen.plugin.generator.launcher"</span> method=<span class="stringliteral">"launch"</span> ></div>
|
|
<div class="line"> <argument>#D</argument></div>
|
|
<div class="line"> <argument>$P/RTE/MyGen/myGen.gpdsc</argument></div>
|
|
<div class="line"> </eclipse ></div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <web url=<span class="stringliteral">"http://mygen.com/mygen"</span>></div>
|
|
<div class="line"> <argument <span class="keywordflow">switch</span>=<span class="stringliteral">"device"</span>>#D</argument></div>
|
|
<div class="line"> <argument <span class="keywordflow">switch</span>=<span class="stringliteral">"gpdsc"</span>>$P/RTE/MyGen/myGen.gpdsc</argument></div>
|
|
<div class="line"> </web></div>
|
|
<div class="line"> </generator></div>
|
|
<div class="line"></generators></div>
|
|
</div><!-- fragment --><p> </p>
|
|
<table class="cmtable" summary="Element: Generator Command Argument">
|
|
<tr>
|
|
<th>Parent </th><th colspan="3">Element Chain </th></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_generators_pg.html#element_gen_exe">exe</a>, <a class="el" href="pdsc_generators_pg.html#element_gen_eclipse">eclipse</a>, <a class="el" href="pdsc_generators_pg.html#element_gen_web">web</a> </td><td colspan="3"><a class="el" href="pdsc_generators_pg.html#element_gen_exe">/package/generators/generator/exe</a>, <a class="el" href="pdsc_generators_pg.html#element_gen_eclipse">/package/generators/generator/eclipse</a>, <a class="el" href="pdsc_generators_pg.html#element_gen_web">/package/generators/generator/web</a> </td></tr>
|
|
<tr>
|
|
<th>Current </th><th>Description </th><th colspan="2">Type </th></tr>
|
|
<tr>
|
|
<td>argument </td><td>value of argument without command line switch </td><td colspan="2">xs:string </td></tr>
|
|
<tr>
|
|
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
|
|
<tr>
|
|
<td>host </td><td>Specifies the host operating system. Possible values are <code>all</code>, <code>win</code>, <code>linux</code>, <code>mac</code>, <code>other</code>. Only available with element <a class="el" href="pdsc_generators_pg.html#element_gen_command">command</a>. </td><td>xs:string </td><td>optional </td></tr>
|
|
<tr>
|
|
<td>switch </td><td>Specifies the command line switch separated from the argument value. Not available with element <a class="el" href="pdsc_generators_pg.html#element_gen_eclipse">eclipse</a>. </td><td>xs:string </td><td>optional </td></tr>
|
|
</table>
|
|
<p> </p>
|
|
<hr/>
|
|
<h1><a class="anchor" id="element_gen_project_files"></a>
|
|
/package/generators/generator/project_files</h1>
|
|
<p>The group <b>project_files</b> specifies all files that are required for the project setup. Only one such group can exist.</p>
|
|
<p><b>Example</b> </p>
|
|
<div class="fragment"><div class="line"><generators></div>
|
|
<div class="line"> <generator <span class="keywordtype">id</span>=<span class="stringliteral">"STM32CubeMX"</span> Gvendor=<span class="stringliteral">"STMicroelectronics"</span> Gtool=<span class="stringliteral">"STM32CubeMX"</span> Gversion=<span class="stringliteral">"4.10.0"</span>></div>
|
|
<div class="line"> <description>STM32CubeMX Environment</description></div>
|
|
<div class="line"> <select Dname=<span class="stringliteral">"STM32F746NGHx"</span> Dvendor=<span class="stringliteral">"STMicroelectronics:13"</span>/></div>
|
|
<div class="line"> <command>$SMDK/CubeMX/STM32CubeMXLauncher</command></div>
|
|
<div class="line"> <workingDir>$PRTE/Device/STM32F746NGHx</workingDir></div>
|
|
<div class="line"> <project_files></div>
|
|
<div class="line"> <file category=<span class="stringliteral">"source"</span> name=<span class="stringliteral">"STCubeGenerated/Src/main.c"</span> /></div>
|
|
<div class="line"> <file category=<span class="stringliteral">"header"</span> name=<span class="stringliteral">"STCubeGenerated/Inc/stm32f7xx_it.h"</span>/></div>
|
|
<div class="line"> <file category=<span class="stringliteral">"source"</span> name=<span class="stringliteral">"STCubeGenerated/Src/stm32f7xx_it.c"</span>/></div>
|
|
<div class="line"> </project_files></div>
|
|
<div class="line"> </generator></div>
|
|
<div class="line"></generators></div>
|
|
</div><!-- fragment --><p> </p>
|
|
<table class="cmtable" summary="Element: Project Files">
|
|
<tr>
|
|
<th>Parent </th><th colspan="3">Element Chain </th></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_generators_pg.html#element_generator">generator</a> </td><td colspan="3"><a class="el" href="pdsc_generators_pg.html#element_generator">/package/generators/generator</a> </td></tr>
|
|
<tr>
|
|
<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_components_pg.html#element_file">file</a> </td><td>Frame for files created by the generator and used in a project. </td><td>group </td><td>0..1 </td></tr>
|
|
</table>
|
|
<p> </p>
|
|
<hr/>
|
|
<h1><a class="anchor" id="element_gen_files"></a>
|
|
/package/generators/generator/files</h1>
|
|
<p>The group <b>files</b> specifies files that are required by the generator tool. Only one such group can exist.</p>
|
|
<p><b>Example</b> </p>
|
|
<div class="fragment"><div class="line"><generators></div>
|
|
<div class="line"> <generator <span class="keywordtype">id</span>=<span class="stringliteral">"MyGenerator"</span>></div>
|
|
<div class="line"> <files></div>
|
|
<div class="line"> ...</div>
|
|
<div class="line"> <files></div>
|
|
<div class="line"> </generator></div>
|
|
<div class="line"></generators></div>
|
|
</div><!-- fragment --><p> </p>
|
|
<table class="cmtable" summary="Element: Generator Files">
|
|
<tr>
|
|
<th>Parent </th><th colspan="3">Element Chain </th></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_generators_pg.html#element_generator">generator</a> </td><td colspan="3"><a class="el" href="pdsc_generators_pg.html#element_generator">/package/generators/generator</a> </td></tr>
|
|
<tr>
|
|
<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_generators_pg.html#element_gen_file">file</a> </td><td>Frame for files used by the generator. </td><td>group </td><td>0..1 </td></tr>
|
|
</table>
|
|
<p> </p>
|
|
<hr/>
|
|
<h1><a class="anchor" id="element_gen_file"></a>
|
|
/package/generators/generator/files/file</h1>
|
|
<p>This element contains information about files used by a generator.</p>
|
|
<p><b>Example</b> </p>
|
|
<div class="fragment"><div class="line"><generators></div>
|
|
<div class="line"> <generator <span class="keywordtype">id</span>=<span class="stringliteral">"MyGenerator"</span>></div>
|
|
<div class="line"> <files></div>
|
|
<div class="line"> <file category=<span class="stringliteral">"generator"</span> name=<span class="stringliteral">"Main.c"</span>/></div>
|
|
<div class="line"> <file category=<span class="stringliteral">"you_name_it"</span> name=<span class="stringliteral">"database/connection.odbc"</span> version=<span class="stringliteral">"1.2.3"</span>/></div>
|
|
<div class="line"> ...</div>
|
|
<div class="line"> <files></div>
|
|
<div class="line"> </generator></div>
|
|
<div class="line"></generators></div>
|
|
</div><!-- fragment --><p> </p>
|
|
<table class="cmtable" summary="Element: Generator File">
|
|
<tr>
|
|
<th>Parent </th><th colspan="3">Element Chain </th></tr>
|
|
<tr>
|
|
<td><a class="el" href="pdsc_generators_pg.html#element_gen_files">files</a> </td><td colspan="3"><a class="el" href="pdsc_generators_pg.html#element_gen_files">/package/generators/generator/files</a> </td></tr>
|
|
<tr>
|
|
<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
|
|
<tr>
|
|
<td>condition </td><td>Reference using the name of the respective condition specified in the conditions section of this package (<a class="el" href="pdsc_conditions_pg.html#element_conditions">/package/conditions</a>). If the condition resolves to <span class="XML-Token">false</span>, then the element will be ignored and treated as if not present. </td><td>xs:string </td><td>optional </td></tr>
|
|
<tr>
|
|
<td>category </td><td>Describes the file type (for example: <span class="XML-Token">doc</span>, <span class="XML-Token">header</span>, <span class="XML-Token">library</span>). You can use predefined values as listed in the table <a class="el" href="pdsc_components_pg.html#FileCategoryEnum">File Categories</a>, however, this is not mandatory. </td><td>xs:string </td><td>required </td></tr>
|
|
<tr>
|
|
<td>name </td><td>Can consist of the path (relative to the PACK base directory) and the file name with extension. </td><td>xs:string </td><td>required </td></tr>
|
|
<tr>
|
|
<td>version </td><td>File-specific version information. 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>
|
|
</table>
|
|
<p> </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="navelem"><a class="el" href="packFormat.html">Pack Description (*.PDSC) Format</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>
|