summaryrefslogtreecommitdiff
path: root/CMSIS/Documentation/Pack/html/pdsc_generators_pg.html
blob: 18f9a173b2495d879216e31f188c2d6790df0798 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
<!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);
</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>
<link href="stylsheetf" rel="stylesheet" type="text/css" />
</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
   &#160;<span id="projectnumber">Version 1.4.1</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.2 -->
<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&#160;Page</span></a></li>
      <li class="current"><a href="pages.html"><span>Usage&#160;and&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</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">&lt;gpdsc&gt;</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">&lt;generators&gt;</div>
<div class="line">  &lt;generator <span class="keywordtype">id</span>=<span class="stringliteral">&quot;STM32CubeMX&quot;</span> Gvendor=<span class="stringliteral">&quot;STMicroelectronics&quot;</span> Gtool=<span class="stringliteral">&quot;STM32CubeMX&quot;</span> Gversion=<span class="stringliteral">&quot;4.10.0&quot;</span>&gt;</div>
<div class="line">    &lt;description&gt;STM32CubeMX Environment&lt;/description&gt;</div>
<div class="line">    &lt;select Dname=<span class="stringliteral">&quot;STM32F746NGHx&quot;</span> Dvendor=<span class="stringliteral">&quot;STMicroelectronics:13&quot;</span>/&gt;</div>
<div class="line">    &lt;command&gt;$SMDK/CubeMX/STM32CubeMXLauncher&lt;/command&gt;</div>
<div class="line">    &lt;workingDir&gt;$PRTE/Device/STM32F746NGHx&lt;/workingDir&gt;</div>
<div class="line">    &lt;project_files&gt;</div>
<div class="line">      &lt;file category=<span class="stringliteral">&quot;source&quot;</span> name=<span class="stringliteral">&quot;STCubeGenerated/Src/main.c&quot;</span> /&gt;</div>
<div class="line">      &lt;file category=<span class="stringliteral">&quot;header&quot;</span> name=<span class="stringliteral">&quot;STCubeGenerated/Inc/stm32f7xx_it.h&quot;</span>/&gt;</div>
<div class="line">      &lt;file category=<span class="stringliteral">&quot;source&quot;</span> name=<span class="stringliteral">&quot;STCubeGenerated/Src/stm32f7xx_it.c&quot;</span>/&gt;</div>
<div class="line">    &lt;/project_files&gt;</div>
<div class="line">  &lt;/generator&gt;</div>
<div class="line">&lt;/generators&gt;</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">&lt;?xml version=<span class="stringliteral">&quot;1.0&quot;</span> encoding=<span class="stringliteral">&quot;UTF-8&quot;</span> standalone=<span class="stringliteral">&quot;no&quot;</span>?&gt;</div>
<div class="line">&lt;!-- ******************************************************************************</div>
<div class="line">   File Name   : FrameworkCubeMX.gpdsc</div>
<div class="line">   Date        : 02/09/2015 14:27:06</div>
<div class="line">   Description : Generator PDSC File generated by STM32CubeMX (DO NOT EDIT!)</div>
<div class="line">                                                                                --&gt;</div>
<div class="line"></div>
<div class="line">&lt;<span class="keyword">package </span>xmlns:xs=&quot;http:<span class="comment">//www.w3.org/2001/XMLSchema-instance&quot; schemaVersion=&quot;1.0&quot; xs:noNamespaceSchemaLocation=&quot;PACK.xsd&quot;&gt;</span></div>
<div class="line">  &lt;vendor&gt;Keil&lt;/vendor&gt;</div>
<div class="line">  &lt;name&gt;FrameworkCubeMX&lt;/name&gt;</div>
<div class="line">  &lt;description&gt;STM32CubeMX generated pack description&lt;/description&gt;</div>
<div class="line">  &lt;url&gt;project-path&lt;/url&gt;</div>
<div class="line">  &lt;releases&gt;</div>
<div class="line">    &lt;release version=&quot;1.0.0&quot;&gt;</div>
<div class="line">     - Generated: 02/09/2015 14:27:06</div>
<div class="line">    &lt;/release&gt;</div>
<div class="line">  &lt;/releases&gt;</div>
<div class="line">  &lt;generators&gt;</div>
<div class="line">    &lt;generator id=&quot;STM32CubeMX&quot; Gvendor=&quot;STMicroelectronics&quot; Gtool=&quot;STM32CubeMX&quot; Gversion=&quot;4.10.0&quot;&gt;</div>
<div class="line">      &lt;description&gt;STM32CubeMX Environment&lt;/description&gt;</div>
<div class="line">      &lt;select Dname=&quot;STM32F746NGHx&quot; Dvendor=&quot;STMicroelectronics:13&quot;/&gt;</div>
<div class="line">      &lt;command&gt;$SMDK/CubeMX/STM32CubeMXLauncher&lt;/command&gt;</div>
<div class="line">      &lt;workingDir&gt;$PRTE/Device/STM32F746NGHx&lt;/workingDir&gt;</div>
<div class="line">      &lt;project_files&gt;</div>
<div class="line">        &lt;file category=&quot;source&quot; name=&quot;STCubeGenerated/Src/main.c&quot; /&gt;</div>
<div class="line">        &lt;file category=&quot;header&quot; name=&quot;STCubeGenerated/Inc/stm32f7xx_it.h&quot;/&gt;</div>
<div class="line">        &lt;file category=&quot;source&quot; name=&quot;STCubeGenerated/Src/stm32f7xx_it.c&quot;/&gt;</div>
<div class="line">      &lt;/project_files&gt;</div>
<div class="line">    &lt;/generator&gt;</div>
<div class="line">  &lt;/generators&gt;</div>
<div class="line">  &lt;taxonomy&gt;</div>
<div class="line">    &lt;description Cclass=&quot;Device&quot; Cgroup=&quot;STM32Cube Framework&quot; generator=&quot;STM32CubeMX&quot;&gt;STM32Cube Framework&lt;/description&gt;</div>
<div class="line">  &lt;/taxonomy&gt;</div>
<div class="line">  &lt;conditions&gt;</div>
<div class="line">    &lt;condition id=&quot;STCubeMX&quot;&gt;</div>
<div class="line">      &lt;description&gt;Condition to include CMSIS core and Device Startup components&lt;/description&gt;</div>
<div class="line">      &lt;require Dvendor=&quot;STMicroelectronics:13&quot; Dname=&quot;STM32F7*&quot;/&gt;</div>
<div class="line">      &lt;require Cclass=&quot;CMSIS&quot;  Cgroup=&quot;CORE&quot;          Csub=&quot;&quot;/&gt;</div>
<div class="line">      &lt;require Cclass=&quot;Device&quot; Cgroup=&quot;Startup&quot;/&gt;</div>
<div class="line">      &lt;require Cclass=&quot;Device&quot; Cgroup=&quot;STM32Cube HAL&quot; Csub=&quot;Common&quot;/&gt;</div>
<div class="line">      &lt;require Cclass=&quot;Device&quot; Cgroup=&quot;STM32Cube HAL&quot; Csub=&quot;GPIO&quot;/&gt;</div>
<div class="line">    &lt;/condition&gt;</div>
<div class="line">  &lt;/conditions&gt;</div>
<div class="line">  &lt;components&gt;</div>
<div class="line">    &lt;component generator=&quot;STM32CubeMX&quot; Cvendor=&quot;Keil&quot; Cclass=&quot;Device&quot; Cgroup=&quot;STM32Cube Framework&quot; Csub=&quot;STM32CubeMX&quot; Cversion=&quot;1.0.0&quot; condition=&quot;STCubeMX&quot;&gt;</div>
<div class="line">      &lt;description&gt;Configuration via STM32CubeMX&lt;/description&gt;</div>
<div class="line">      &lt;RTE_Components_h&gt;</div>
<div class="line">        #define RTE_DEVICE_FRAMEWORK_CUBE_MX</div>
<div class="line">      &lt;/RTE_Components_h&gt;</div>
<div class="line">      &lt;files&gt;</div>
<div class="line">        &lt;file category=&quot;header&quot; name=&quot;MX_Device.h&quot;/&gt;</div>
<div class="line">        &lt;file category=&quot;header&quot; name=&quot;STCubeGenerated/Inc/stm32f7xx_hal_conf.h&quot;/&gt;</div>
<div class="line">        &lt;file category=&quot;source&quot; name=&quot;STCubeGenerated/Src/stm32f7xx_hal_msp.c&quot;/&gt;</div>
<div class="line">      &lt;/files&gt;</div>
<div class="line">    &lt;/component&gt;</div>
<div class="line">  &lt;/components&gt;</div>
<div class="line">&lt;/package&gt;</div>
</div><!-- fragment --> <p>&#160;</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>&lt;command&gt;</code>, <code>&lt;workingDir&gt;</code>, <code>&lt;argument&gt;</code>, <code>&lt;gpdsc&gt;</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>&#160;</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&#160;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>&lt;command&gt;</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>Invocation command for the generator tool (for an example see <a class="el" href="pdsc_generators_pg.html#pdsc_generators_gen_sec">top of the page</a>). Command line options should be passed via <code>arguments</code>.  </td><td>xs:string </td><td>0..1  </td></tr>
<tr>
<td><a class="el" href="pdsc_generators_pg.html#element_gen_arguments">arguments</a> </td><td>Section for command line arguments of the format <code>&lt;argument</code> <code>switch="-data"&gt;myFileName&lt;/argument&gt;</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_arguments">GeneratorCommandArgumentsType</a> </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 a gpdsc file named after the project with extension gpdsc in the working directory is assumed (<code>&lt;project&gt;</code>.gpdsc).  </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>&#160;</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>&lt;generators&gt;</code>.</p>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line">&lt;generators&gt;</div>
<div class="line">  &lt;generator <span class="keywordtype">id</span>=<span class="stringliteral">&quot;STM32CubeMX&quot;</span> Gvendor=<span class="stringliteral">&quot;STMicroelectronics&quot;</span> Gtool=<span class="stringliteral">&quot;STM32CubeMX&quot;</span> Gversion=<span class="stringliteral">&quot;4.10.0&quot;</span>&gt;</div>
<div class="line">    &lt;select Dname=<span class="stringliteral">&quot;STM32F746NGHx&quot;</span> Dvendor=<span class="stringliteral">&quot;STMicroelectronics:13&quot;</span>/&gt;</div>
<div class="line">  &lt;/generator&gt;</div>
<div class="line">&lt;/generators&gt;</div>
</div><!-- fragment --> <p>&#160;</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>&#160;</p>
<hr/>
<h1><a class="anchor" id="element_gen_arguments"></a>
/package/generators/generator/arguments</h1>
<p>This element contains information about the <b>arguments</b> passed along the <code>&lt;command&gt;</code> string.</p>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line">&lt;generators&gt;</div>
<div class="line">  &lt;generator <span class="keywordtype">id</span>=<span class="stringliteral">&quot;DAVE3&quot;</span>&gt;</div>
<div class="line">    ...</div>
<div class="line">    &lt;command&gt;%DAVE3%/eclipse/DAVE-3.1.6.exe&lt;/command&gt;</div>
<div class="line">    &lt;arguments&gt;</div>
<div class="line">      ...</div>
<div class="line">    &lt;/arguments&gt;</div>
<div class="line">  &lt;/generator&gt;</div>
<div class="line">&lt;/generators&gt;</div>
</div><!-- fragment --> <p>&#160;</p>
<table  class="cmtable" summary="Element: Arguments">
<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&#160;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 with the <code>&lt;command&gt;</code>. </td><td><a class="el" href="pdsc_generators_pg.html#element_gen_argument">GeneratorCommandArgumentType</a> </td><td>required  </td></tr>
</table>
<p>&#160;</p>
<hr/>
<h1><a class="anchor" id="element_gen_argument"></a>
/package/generators/generator/arguments/argument</h1>
<p>This element describes a single command line argument passed along with <code>&lt;command&gt;</code> for launching the generator. The argument is split up in a switch value pair. The switch is passed as an attribute and the value as the element value. Both <code>switch</code> and <code>element</code> values are of type xs:string.</p>
<p><b>Example</b> </p>
<div class="fragment"><div class="line">&lt;generators&gt;</div>
<div class="line">  &lt;generator <span class="keywordtype">id</span>=<span class="stringliteral">&quot;STM32CubeMX&quot;</span>&gt;</div>
<div class="line">    &lt;arguments&gt;</div>
<div class="line">      &lt;argument <span class="keywordflow">switch</span>=<span class="stringliteral">&quot;-data&quot;</span>&gt;$PRTE/Device/STM32F746NGHx&lt;/argument&gt;</div>
<div class="line">      ...</div>
<div class="line">    &lt;/arguments&gt;</div>
<div class="line">    ...</div>
<div class="line">  &lt;/generator&gt;</div>
<div class="line">&lt;/generators&gt;</div>
</div><!-- fragment --><p>&#160;</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_arguments">arguments</a> </td><td colspan="3"><a class="el" href="pdsc_generators_pg.html#element_gen_arguments">/package/generators/generator/arguments</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>switch </td><td>Specifies the command line switch separated from the argument value. </td><td>xs:string </td><td>optional  </td></tr>
</table>
<p>&#160;</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">&lt;generators&gt;</div>
<div class="line">  &lt;generator <span class="keywordtype">id</span>=<span class="stringliteral">&quot;STM32CubeMX&quot;</span> Gvendor=<span class="stringliteral">&quot;STMicroelectronics&quot;</span> Gtool=<span class="stringliteral">&quot;STM32CubeMX&quot;</span> Gversion=<span class="stringliteral">&quot;4.10.0&quot;</span>&gt;</div>
<div class="line">    &lt;description&gt;STM32CubeMX Environment&lt;/description&gt;</div>
<div class="line">    &lt;select Dname=<span class="stringliteral">&quot;STM32F746NGHx&quot;</span> Dvendor=<span class="stringliteral">&quot;STMicroelectronics:13&quot;</span>/&gt;</div>
<div class="line">    &lt;command&gt;$SMDK/CubeMX/STM32CubeMXLauncher&lt;/command&gt;</div>
<div class="line">    &lt;workingDir&gt;$PRTE/Device/STM32F746NGHx&lt;/workingDir&gt;</div>
<div class="line">    &lt;project_files&gt;</div>
<div class="line">      &lt;file category=<span class="stringliteral">&quot;source&quot;</span> name=<span class="stringliteral">&quot;STCubeGenerated/Src/main.c&quot;</span> /&gt;</div>
<div class="line">      &lt;file category=<span class="stringliteral">&quot;header&quot;</span> name=<span class="stringliteral">&quot;STCubeGenerated/Inc/stm32f7xx_it.h&quot;</span>/&gt;</div>
<div class="line">      &lt;file category=<span class="stringliteral">&quot;source&quot;</span> name=<span class="stringliteral">&quot;STCubeGenerated/Src/stm32f7xx_it.c&quot;</span>/&gt;</div>
<div class="line">    &lt;/project_files&gt;</div>
<div class="line">  &lt;/generator&gt;</div>
<div class="line">&lt;/generators&gt;</div>
</div><!-- fragment --><p>&#160;</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&#160;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>&#160;</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">&lt;generators&gt;</div>
<div class="line">  &lt;generator <span class="keywordtype">id</span>=<span class="stringliteral">&quot;MyGenerator&quot;</span>&gt;</div>
<div class="line">    &lt;files&gt;</div>
<div class="line">      ...</div>
<div class="line">    &lt;files&gt;</div>
<div class="line">  &lt;/generator&gt;</div>
<div class="line">&lt;/generators&gt;</div>
</div><!-- fragment --><p>&#160;</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&#160;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>&#160;</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">&lt;generators&gt;</div>
<div class="line">  &lt;generator <span class="keywordtype">id</span>=<span class="stringliteral">&quot;MyGenerator&quot;</span>&gt;</div>
<div class="line">    &lt;files&gt;</div>
<div class="line">      &lt;file category=<span class="stringliteral">&quot;generator&quot;</span> name=<span class="stringliteral">&quot;Main.c&quot;</span>/&gt;</div>
<div class="line">      &lt;file category=<span class="stringliteral">&quot;you_name_it&quot;</span> name=<span class="stringliteral">&quot;database/connection.odbc&quot;</span> version=<span class="stringliteral">&quot;1.2.3&quot;</span>/&gt;</div>
<div class="line">      ...</div>
<div class="line">    &lt;files&gt;</div>
<div class="line">  &lt;/generator&gt;</div>
<div class="line">&lt;/generators&gt;</div>
</div><!-- fragment --><p>&#160;</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>&#160;</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="_pack_format.html">Pack Description (*.PDSC) Format</a></li>
    <li class="footer">Generated on Tue Oct 27 2015 14:35: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.2 
	-->
	</li>
  </ul>
</div>
</body>
</html>