cross_origen 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/config/application.rb +78 -0
- data/config/commands.rb +47 -0
- data/config/development.rb +17 -0
- data/config/environment.rb +35 -0
- data/config/users.rb +18 -0
- data/config/version.rb +8 -0
- data/lib/cross_origen/design_sync.rb +54 -0
- data/lib/cross_origen/headers.rb +21 -0
- data/lib/cross_origen/ip_xact.rb +243 -0
- data/lib/cross_origen/origen_format.rb +541 -0
- data/lib/cross_origen/ralf.rb +15 -0
- data/lib/cross_origen/test/dut.rb +51 -0
- data/lib/cross_origen/xml_doc.rb +252 -0
- data/lib/cross_origen.rb +108 -0
- data/templates/headers/default.h.erb +18 -0
- data/templates/ralf/_register.ralf.erb +21 -0
- data/templates/ralf/default.ralf.erb +37 -0
- data/templates/test/default.ralf.erb +1 -0
- data/templates/test/headers_default.h.erb +1 -0
- data/templates/test/ip_xact.xml.erb +1 -0
- data/templates/web/_history.md +547 -0
- data/templates/web/example.md.erb +73 -0
- data/templates/web/examples/ip_xact_export.md.erb +25 -0
- data/templates/web/examples/origen_export.md.erb +96 -0
- data/templates/web/examples/ralf_export.md.erb +18 -0
- data/templates/web/examples.md.erb +13 -0
- data/templates/web/index.md.erb +104 -0
- data/templates/web/layouts/_basic.html.erb +13 -0
- data/templates/web/layouts/_doc.html.erb +61 -0
- data/templates/web/partials/_navbar.html.erb +23 -0
- data/templates/web/release_notes.md.erb +5 -0
- metadata +117 -0
@@ -0,0 +1,547 @@
|
|
1
|
+
<a class="anchor release_tag" name="v0_0_0_dev31"></a>
|
2
|
+
<h2><a href="#v0_0_0_dev31">Tag: v0.0.0.dev31</a></h2>
|
3
|
+
|
4
|
+
##### Branch: 'Trunk'
|
5
|
+
|
6
|
+
##### by Melody Caron on 22-Jul-2014 09:46AM
|
7
|
+
|
8
|
+
|
9
|
+
Fixed xml tag issue where arguments were passed as Symbols, not Strings. This messed up
|
10
|
+
the xml tag format.
|
11
|
+
|
12
|
+
Bad syntax:
|
13
|
+
~~~ruby
|
14
|
+
xml.tag!('ip-name', try(:ip\_name, :pdm\_part\_name) || owner.class.to\_s.split('::').last)
|
15
|
+
# Shows up in xml as
|
16
|
+
# <ip-name:cisocregs/>
|
17
|
+
~~~
|
18
|
+
Good syntax:
|
19
|
+
~~~ruby
|
20
|
+
xml.tag!('ip-name', "#{try(:ip\_name, :pdm\_part\_name) ||
|
21
|
+
owner.class.to\_s.split('::').last}")
|
22
|
+
# Shows up in xml as
|
23
|
+
# <ip-name>cisocregs</ip-name>
|
24
|
+
~~~
|
25
|
+
|
26
|
+
Changes made to sidsc.rb only.
|
27
|
+
|
28
|
+
<a class="anchor release_tag" name="v0_0_0_dev30"></a>
|
29
|
+
<h2><a href="#v0_0_0_dev30">Tag: v0.0.0.dev30</a></h2>
|
30
|
+
|
31
|
+
##### Branch: 'Trunk'
|
32
|
+
|
33
|
+
##### by Stephen McGinty on 17-Jul-2014 05:47AM
|
34
|
+
|
35
|
+
|
36
|
+
SIDSC export updates:
|
37
|
+
|
38
|
+
* Single and double quotes in bits and register descriptions are now automatically escaped
|
39
|
+
and therefore preserved correctly in the XML output
|
40
|
+
* < and > will now render verbatim and will not be converted to an escaped version
|
41
|
+
|
42
|
+
IP\_XACT export updates:
|
43
|
+
|
44
|
+
* Changed the overall structure from MemoryMaps = Domains and AddressBlocks = Sub Blocks to
|
45
|
+
MemoryMaps = The Owner and AddressBlocks = Domains. The net effect of this is that sub-blocks
|
46
|
+
are flattened out with the address blocks, need to pilot further with verification to see
|
47
|
+
if there are any problems from register naming contention from that.
|
48
|
+
* Simplified how bit paths are generated by leveraging the latest Origen path API
|
49
|
+
* Removed the HDL path attribute from AddressBlocks, doesn't make sense now that they represent
|
50
|
+
domains rather than an RTL hierarchy
|
51
|
+
|
52
|
+
<a class="anchor release_tag" name="v0_0_0_dev29"></a>
|
53
|
+
<h2><a href="#v0_0_0_dev29">Tag: v0.0.0.dev29</a></h2>
|
54
|
+
|
55
|
+
##### Branch: 'Trunk'
|
56
|
+
|
57
|
+
##### by Melody Caron on 10-Jul-2014 15:04PM
|
58
|
+
|
59
|
+
|
60
|
+
Updated SIDSC register documentation to comprehend italics in register description.
|
61
|
+
|
62
|
+
~~~text
|
63
|
+
Syntax: *blah blah blah*
|
64
|
+
Translates to: <i>blah blah blah</i>
|
65
|
+
~~~
|
66
|
+
|
67
|
+
<a class="anchor release_tag" name="v0_0_0_dev28"></a>
|
68
|
+
<h2><a href="#v0_0_0_dev28">Tag: v0.0.0.dev28</a></h2>
|
69
|
+
|
70
|
+
##### Branch: 'Trunk'
|
71
|
+
|
72
|
+
##### by Christopher Hume on 10-Jul-2014 09:37AM
|
73
|
+
|
74
|
+
|
75
|
+
Updated SIDSC register documentation format to allow for unique register and bitField IDs.
|
76
|
+
|
77
|
+
This allows the same register and bit names to occur in different register sub-blocks.
|
78
|
+
For example, if a module has multiple instances of a single register block, the ID names
|
79
|
+
will be unique when pulled into SSDS (a requirement for successful documentation
|
80
|
+
assembly).
|
81
|
+
|
82
|
+
Example:
|
83
|
+
|
84
|
+
A model instantiates multiple instances of "CoreRegs":
|
85
|
+
|
86
|
+
~~~ruby
|
87
|
+
|
88
|
+
options[:num\_blks].times do |i|
|
89
|
+
sub\_block "core#{i}", :class\_name => 'CoreRegs', base: 0x1500 + (i * 0x100)
|
90
|
+
end
|
91
|
+
|
92
|
+
~~~
|
93
|
+
|
94
|
+
Where a register "core\_cfg0" is declared within CoreRegs:
|
95
|
+
|
96
|
+
~~~ruby
|
97
|
+
|
98
|
+
reg :core\_cfg0, 0x0000, size: 8 do
|
99
|
+
bits 7..4, :satime
|
100
|
+
bits 3..0, :readt
|
101
|
+
end
|
102
|
+
|
103
|
+
~~~
|
104
|
+
|
105
|
+
SIDSC conversion now attaches the component name (:component\_name, :name, or
|
106
|
+
:pdm\_part\_name) to the register and bitField ID attributes.
|
107
|
+
|
108
|
+
For core0:
|
109
|
+
|
110
|
+
~~~xml
|
111
|
+
|
112
|
+
<register id="sidsc\_core0\_CORE\_CFG0">
|
113
|
+
<bitField id="core0\_SATIME">
|
114
|
+
<bitField id="core0\_READT">
|
115
|
+
|
116
|
+
~~~
|
117
|
+
|
118
|
+
And core1:
|
119
|
+
|
120
|
+
~~~xml
|
121
|
+
|
122
|
+
<register id="sidsc\_core1\_CORE\_CFG0">
|
123
|
+
<bitField id="core1\_SATIME">
|
124
|
+
<bitField id="core1\_READT">
|
125
|
+
|
126
|
+
~~~
|
127
|
+
|
128
|
+
<a class="anchor release_tag" name="v0_0_0_dev27"></a>
|
129
|
+
<h2><a href="#v0_0_0_dev27">Tag: v0.0.0.dev27</a></h2>
|
130
|
+
|
131
|
+
##### Branch: 'Trunk'
|
132
|
+
|
133
|
+
##### by Stephen Traynor on 10-Jul-2014 09:02AM
|
134
|
+
|
135
|
+
|
136
|
+
Expanded capability to consume register data written in Automotive TCU Excel format, that
|
137
|
+
is
|
138
|
+
insensitive to the ordering of the bits/bitgroups.
|
139
|
+
|
140
|
+
<a class="anchor release_tag" name="v0_0_0_dev26"></a>
|
141
|
+
<h2><a href="#v0_0_0_dev26">Tag: v0.0.0.dev26</a></h2>
|
142
|
+
|
143
|
+
##### Branch: 'Trunk'
|
144
|
+
|
145
|
+
##### by Stephen McGinty on 03-Jul-2014 03:17AM
|
146
|
+
|
147
|
+
|
148
|
+
IP\_XACT export updates:
|
149
|
+
|
150
|
+
* Filled in the name field in the bit field attributes, this will just generate a name based on the
|
151
|
+
value like: 'val\_0x0', 'val\_0x5'
|
152
|
+
* Fixed some vendor extensions that were permanently enabled, now they will only be output when
|
153
|
+
format: :uvm is passed to the to\_ip\_xact method
|
154
|
+
* Made the bit field values conditional but enabled by default, they can be disabled by passing
|
155
|
+
:include\_bit\_field\_values => false to the to\_ip\_xact method
|
156
|
+
|
157
|
+
<a class="anchor release_tag" name="v0_0_0_dev25"></a>
|
158
|
+
<h2><a href="#v0_0_0_dev25">Tag: v0.0.0.dev25</a></h2>
|
159
|
+
|
160
|
+
##### Branch: 'Trunk'
|
161
|
+
|
162
|
+
##### by Stephen McGinty on 02-Jul-2014 07:51AM
|
163
|
+
|
164
|
+
|
165
|
+
THe IP-XACT exporter will now use the bit.access attribute to fill in the corresponding
|
166
|
+
field.
|
167
|
+
|
168
|
+
<a class="anchor release_tag" name="v0_0_0_dev24"></a>
|
169
|
+
<h2><a href="#v0_0_0_dev24">Tag: v0.0.0.dev24</a></h2>
|
170
|
+
|
171
|
+
##### Branch: 'Trunk'
|
172
|
+
|
173
|
+
##### by Stephen McGinty on 01-Jul-2014 05:30AM
|
174
|
+
|
175
|
+
|
176
|
+
Updates to the IP XACT exporter which now understands the Origen sub-block model and
|
177
|
+
conventions.
|
178
|
+
|
179
|
+
Also added initial vendor extensions to support UVM - currently working with NVM
|
180
|
+
verification to further develop this exporter and enable the Origen -> UVM flow.
|
181
|
+
|
182
|
+
<a class="anchor release_tag" name="v0_0_0_dev23"></a>
|
183
|
+
<h2><a href="#v0_0_0_dev23">Tag: v0.0.0.dev23</a></h2>
|
184
|
+
|
185
|
+
##### Branch: 'Trunk'
|
186
|
+
|
187
|
+
##### by William Forfang on 12-Jun-2014 09:14AM
|
188
|
+
|
189
|
+
|
190
|
+
Fixed the 'types' attribute extractor in pin\_tool.rb. This allows the in-console BGA
|
191
|
+
plotting widget to distinguish between package types. The SOC package type is located at
|
192
|
+
the following XML path:
|
193
|
+
|
194
|
+
/packages-supported/package/packageInformation/packageType/packageAcronym
|
195
|
+
|
196
|
+
If no packageAcronym exists in the XML, the default value of the .types attribute is set
|
197
|
+
to 'BGA\_default'.
|
198
|
+
|
199
|
+
~~~ruby
|
200
|
+
> $dut.package = :t4240
|
201
|
+
=> :t4240
|
202
|
+
> $dut.package.types
|
203
|
+
=> ["BGA\_default"]
|
204
|
+
> $dut.package.plot\_help
|
205
|
+
~~~
|
206
|
+
|
207
|
+
|
208
|
+
<a class="anchor release_tag" name="v0_0_0_dev22"></a>
|
209
|
+
<h2><a href="#v0_0_0_dev22">Tag: v0.0.0.dev22</a></h2>
|
210
|
+
|
211
|
+
##### Branch: 'Trunk'
|
212
|
+
|
213
|
+
##### by William Forfang on 12-Jun-2014 08:40AM
|
214
|
+
|
215
|
+
|
216
|
+
Added 'types' attribute to package extracted by pin\_tool.rb. Defaults to 'BGA\_default' if
|
217
|
+
no type is listed in the XML.
|
218
|
+
|
219
|
+
<a class="anchor release_tag" name="v0_0_0_dev21"></a>
|
220
|
+
<h2><a href="#v0_0_0_dev21">Tag: v0.0.0.dev21</a></h2>
|
221
|
+
|
222
|
+
##### Branch: 'Trunk'
|
223
|
+
|
224
|
+
##### by Stephen Traynor on 28-May-2014 14:37PM
|
225
|
+
|
226
|
+
|
227
|
+
Removed unnecssary line displaying :path symbol to the log in the rs\_file method in
|
228
|
+
lib/rosetta\_stone.rb
|
229
|
+
|
230
|
+
<a class="anchor release_tag" name="v0_0_0_dev20"></a>
|
231
|
+
<h2><a href="#v0_0_0_dev20">Tag: v0.0.0.dev20</a></h2>
|
232
|
+
|
233
|
+
##### Branch: 'Trunk'
|
234
|
+
|
235
|
+
##### by Stephen Traynor on 28-May-2014 11:20AM
|
236
|
+
|
237
|
+
|
238
|
+
Corrected method to import the ruby gems spreadsheet module
|
239
|
+
|
240
|
+
<a class="anchor release_tag" name="v0_0_0_dev19"></a>
|
241
|
+
<h2><a href="#v0_0_0_dev19">Tag: v0.0.0.dev19</a></h2>
|
242
|
+
|
243
|
+
##### Branch: 'Trunk'
|
244
|
+
|
245
|
+
##### by Stephen Traynor on 28-May-2014 10:05AM
|
246
|
+
|
247
|
+
|
248
|
+
adding missing files from initial release
|
249
|
+
|
250
|
+
<a class="anchor release_tag" name="v0_0_0_dev18"></a>
|
251
|
+
<h2><a href="#v0_0_0_dev18">Tag: v0.0.0.dev18</a></h2>
|
252
|
+
|
253
|
+
##### Branch: 'Trunk'
|
254
|
+
|
255
|
+
##### by Stephen Traynor on 28-May-2014 09:47AM
|
256
|
+
|
257
|
+
|
258
|
+
Included method to read TCU registers defined in excel
|
259
|
+
|
260
|
+
<a class="anchor release_tag" name="v0_0_0_dev17"></a>
|
261
|
+
<h2><a href="#v0_0_0_dev17">Tag: v0.0.0.dev17</a></h2>
|
262
|
+
|
263
|
+
##### Branch: 'Trunk'
|
264
|
+
|
265
|
+
##### by Stephen McGinty on 28-May-2014 03:40AM
|
266
|
+
|
267
|
+
|
268
|
+
Minor update to make SIDSC export work when the component name is a symbol
|
269
|
+
|
270
|
+
<a class="anchor release_tag" name="v0_0_0_dev16"></a>
|
271
|
+
<h2><a href="#v0_0_0_dev16">Tag: v0.0.0.dev16</a></h2>
|
272
|
+
|
273
|
+
##### Branch: 'Trunk'
|
274
|
+
|
275
|
+
##### by Stephen McGinty on 27-May-2014 08:58AM
|
276
|
+
|
277
|
+
|
278
|
+
Fix encoding issue when importing from docato on windows
|
279
|
+
|
280
|
+
<a class="anchor release_tag" name="v0_0_0_dev15"></a>
|
281
|
+
<h2><a href="#v0_0_0_dev15">Tag: v0.0.0.dev15</a></h2>
|
282
|
+
|
283
|
+
##### Branch: 'Trunk'
|
284
|
+
|
285
|
+
##### by Stephen McGinty on 23-May-2014 05:45AM
|
286
|
+
|
287
|
+
|
288
|
+
Some debug of the RALF export format.
|
289
|
+
|
290
|
+
Added ability to import from Design Sync - now support local path, Docato or Design Sync.
|
291
|
+
See plugin homepage for an example of how to use it.
|
292
|
+
|
293
|
+
<a class="anchor release_tag" name="v0_0_0_dev14"></a>
|
294
|
+
<h2><a href="#v0_0_0_dev14">Tag: v0.0.0.dev14</a></h2>
|
295
|
+
|
296
|
+
##### Branch: 'Trunk'
|
297
|
+
|
298
|
+
##### by Stephen McGinty on 01-May-2014 13:06PM
|
299
|
+
|
300
|
+
|
301
|
+
Added support for register export to IP-XACT and RALF (Synopsis) formats
|
302
|
+
|
303
|
+
<a class="anchor release_tag" name="v0_0_0_dev13"></a>
|
304
|
+
<h2><a href="#v0_0_0_dev13">Tag: v0.0.0.dev13</a></h2>
|
305
|
+
|
306
|
+
##### Branch: 'Trunk'
|
307
|
+
|
308
|
+
##### by Stephen McGinty on 16-Apr-2014 08:22AM
|
309
|
+
|
310
|
+
|
311
|
+
Enabled enforced lint/style checking and fixed existing offenses.
|
312
|
+
|
313
|
+
Some tweaks to the generated SIDSC output.
|
314
|
+
|
315
|
+
<a class="anchor release_tag" name="v0_0_0_dev12"></a>
|
316
|
+
<h2><a href="#v0_0_0_dev12">Tag: v0.0.0.dev12</a></h2>
|
317
|
+
|
318
|
+
##### Branch: 'Trunk'
|
319
|
+
|
320
|
+
##### by Chris Hume on 25-Mar-2014 22:48PM
|
321
|
+
|
322
|
+
|
323
|
+
Updated to support new Register API features and format/syntax updates:
|
324
|
+
|
325
|
+
Added support for "write-one-to-clear" access (bitFieldAccess).
|
326
|
+
|
327
|
+
Implemented automated documentation of unused/empty bit positions via empty\_bits (new
|
328
|
+
Register API function). Any unused/empty bits in a register definition will be
|
329
|
+
auto-filled with reserved bits. Adjacent unused/empty bits are compressed into a single
|
330
|
+
bit field. Multiple sequences of unused bits within a register will yield uniquely named
|
331
|
+
reserved locations. Empty bit fields currently default to Read-Only Zero access. A future
|
332
|
+
update may add support for Read-Only One access to be defined on a per-register basis.
|
333
|
+
|
334
|
+
Syntax changes of note:
|
335
|
+
* registerNameFull has been changed from all caps to simple capitilization
|
336
|
+
* addressBlock id has been changed from using :ip\_name or :pdm\_part\_name to
|
337
|
+
:component\_name, :name, or :pdm\_part\_name. Use of the same id name for memoryMap and
|
338
|
+
addressBlock resulted in a naming collision error in oXygen.
|
339
|
+
|
340
|
+
Note that some unused fields have been removed: bitNumbers, bitFieldRadix
|
341
|
+
|
342
|
+
If you are using the to\_sidsc method and encounter any syntax or nomenclature issues,
|
343
|
+
please contact Chris Hume at r20984@freescale.com/chris.hume@freescale.com. To the best
|
344
|
+
of my knowledge, the TFS FMU design team is the only team leveraging SIDSC formatted XML
|
345
|
+
for documentation generation. I only have access to our register maps and .ditamaps for
|
346
|
+
validation cases. Examples from other teams would be welcome.
|
347
|
+
|
348
|
+
<a class="anchor release_tag" name="v0_0_0_dev11"></a>
|
349
|
+
<h2><a href="#v0_0_0_dev11">Tag: v0.0.0.dev11</a></h2>
|
350
|
+
|
351
|
+
##### Branch: 'Trunk'
|
352
|
+
|
353
|
+
##### by Stephen McGinty on 21-Mar-2014 07:51AM
|
354
|
+
|
355
|
+
|
356
|
+
Updated the Pin Tool importer to include the busref attribute for the various
|
357
|
+
configurations
|
358
|
+
of a given pin. This is available via the pin.group method.
|
359
|
+
|
360
|
+
<a class="anchor release_tag" name="v0_0_0_dev10"></a>
|
361
|
+
<h2><a href="#v0_0_0_dev10">Tag: v0.0.0.dev10</a></h2>
|
362
|
+
|
363
|
+
##### Branch: 'Trunk'
|
364
|
+
|
365
|
+
##### by Stephen McGinty on 13-Mar-2014 12:31PM
|
366
|
+
|
367
|
+
|
368
|
+
Added Docato workspace synchronizer. This is a wrapping of a 3rd party tool
|
369
|
+
to upload local documentation to docato.
|
370
|
+
|
371
|
+
Will fully document in due course, but basically:
|
372
|
+
|
373
|
+
~~~ruby
|
374
|
+
include CrossOrigen
|
375
|
+
|
376
|
+
def generate\_block\_guide
|
377
|
+
my\_method\_to\_generate\_xml
|
378
|
+
rs\_docato.sync(:local\_dir => "#{Origen.root}/output/block\_guide", :docato\_dir => "/my/docato/path")
|
379
|
+
end
|
380
|
+
~~~
|
381
|
+
|
382
|
+
A method is also provided to automatically return a path to the current user's
|
383
|
+
sandbox on docato:
|
384
|
+
|
385
|
+
~~~ruby
|
386
|
+
include CrossOrigen
|
387
|
+
|
388
|
+
def generate\_block\_guide
|
389
|
+
my\_method\_to\_generate\_xml
|
390
|
+
rs\_docato.sync(:local\_dir => "#{Origen.root}/output/block\_guide", :docato\_dir => rs\_docato.sandbox)
|
391
|
+
end
|
392
|
+
~~~
|
393
|
+
|
394
|
+
<a class="anchor release_tag" name="v0_0_0_dev9"></a>
|
395
|
+
<h2><a href="#v0_0_0_dev9">Tag: v0.0.0.dev9</a></h2>
|
396
|
+
|
397
|
+
##### Branch: 'Trunk'
|
398
|
+
|
399
|
+
##### by Stephen McGinty on 07-Mar-2014 11:21AM
|
400
|
+
|
401
|
+
|
402
|
+
Removed all references to Origen pin\_api v3, and set min Origen version to the latest where
|
403
|
+
that is now the default.
|
404
|
+
|
405
|
+
Removed http Linux hacks in docato.rb, that is now fixed in latest Origen.
|
406
|
+
|
407
|
+
<a class="anchor release_tag" name="v0_0_0_dev8"></a>
|
408
|
+
<h2><a href="#v0_0_0_dev8">Tag: v0.0.0.dev8</a></h2>
|
409
|
+
|
410
|
+
##### Branch: 'Trunk'
|
411
|
+
|
412
|
+
##### by Stephen McGinty on 20-Feb-2014 11:41AM
|
413
|
+
|
414
|
+
|
415
|
+
Initial release of Pin Tool import.
|
416
|
+
|
417
|
+
Docato import now works on both Windows and Linux and can be used in production.
|
418
|
+
|
419
|
+
<a class="anchor release_tag" name="v0_0_0_dev7"></a>
|
420
|
+
<h2><a href="#v0_0_0_dev7">Tag: v0.0.0.dev7</a></h2>
|
421
|
+
|
422
|
+
##### Branch: 'Trunk'
|
423
|
+
|
424
|
+
##### by Melody Caron on 19-Feb-2014 09:37AM
|
425
|
+
|
426
|
+
|
427
|
+
Added TPC VER2PAT file -> Origen pin definition importer.
|
428
|
+
|
429
|
+
<a class="anchor release_tag" name="v0_0_0_dev6"></a>
|
430
|
+
<h2><a href="#v0_0_0_dev6">Tag: v0.0.0.dev6</a></h2>
|
431
|
+
|
432
|
+
##### Branch: 'Trunk'
|
433
|
+
|
434
|
+
##### by Stephen McGinty on 10-Feb-2014 03:36AM
|
435
|
+
|
436
|
+
|
437
|
+
Replaced all occurrences of <strong> with <b> in SIDSC content generated from markdown.
|
438
|
+
|
439
|
+
Removed the base\_address attribute handling in SIDCS import/export since it clashes with
|
440
|
+
Origen's existing handling of it - need a real life use case based on SIDCS to work out how
|
441
|
+
to handle this.
|
442
|
+
|
443
|
+
Internally renamed the SSDS class as Docato, since it is really concerned with talking to
|
444
|
+
the Docato revision control system rather than the more general SSDS.
|
445
|
+
|
446
|
+
<a class="anchor release_tag" name="v0_0_0_dev5"></a>
|
447
|
+
<h2><a href="#v0_0_0_dev5">Tag: v0.0.0.dev5</a></h2>
|
448
|
+
|
449
|
+
##### Branch: 'Trunk'
|
450
|
+
|
451
|
+
##### by Chris Hume on 07-Feb-2014 14:56PM
|
452
|
+
|
453
|
+
|
454
|
+
Fixed several minor formatting issues with to\_sidsc method. Barring one exception, (noted
|
455
|
+
below), Origen register content is converted to SIDSC-compliant XML documentation via the
|
456
|
+
to\_sidsc method.
|
457
|
+
|
458
|
+
Exception: markdown-style bolded text, ex: **this is to be bold**, is incorrectly
|
459
|
+
bookended with <strong><strong/>. This will be corrected to <b><b/> in the next release.
|
460
|
+
|
461
|
+
<a class="anchor release_tag" name="v0_0_0_dev4"></a>
|
462
|
+
<h2><a href="#v0_0_0_dev4">Tag: v0.0.0.dev4</a></h2>
|
463
|
+
|
464
|
+
##### Branch: 'Trunk'
|
465
|
+
|
466
|
+
##### by Stephen McGinty on 27-Jan-2014 07:25AM
|
467
|
+
|
468
|
+
|
469
|
+
Some initial work on a pin tool and datasheet importer.
|
470
|
+
|
471
|
+
<a class="anchor release_tag" name="v0_0_0_dev3"></a>
|
472
|
+
<h2><a href="#v0_0_0_dev3">Tag: v0.0.0.dev3</a></h2>
|
473
|
+
|
474
|
+
##### Branch: 'Trunk'
|
475
|
+
|
476
|
+
##### by Stephen McGinty on 13-Jan-2014 16:54PM
|
477
|
+
|
478
|
+
|
479
|
+
Added direct import from SSDS. This currently only works on Windows until the Linux Ruby
|
480
|
+
installation is updated and will not be documented on the main page until then, but here
|
481
|
+
is an example:
|
482
|
+
|
483
|
+
~~~ruby
|
484
|
+
# Instead of supplying a path to a local file an SSDS ID and version can be supplied instead
|
485
|
+
rs\_import(:ssds\_id => , version: 60)
|
486
|
+
~~~
|
487
|
+
|
488
|
+
Origen will fetch and cache the corresponding XML file in a similar way to how imports are handled.
|
489
|
+
|
490
|
+
Also added an initial module to generate C headers, this adds a to\_header method which will
|
491
|
+
currently generate a default header format for the modules registers:
|
492
|
+
|
493
|
+
~~~ruby
|
494
|
+
$dut.pmc.to\_header
|
495
|
+
~~~
|
496
|
+
|
497
|
+
<a class="anchor release_tag" name="v0_0_0_dev2"></a>
|
498
|
+
<h2><a href="#v0_0_0_dev2">Tag: v0.0.0.dev2</a></h2>
|
499
|
+
|
500
|
+
##### Branch: 'Trunk'
|
501
|
+
|
502
|
+
##### by Stephen McGinty on 13-Dec-2013 05:21AM
|
503
|
+
|
504
|
+
|
505
|
+
Updated to latest doc helpers version in development environment to fix a couple of
|
506
|
+
register display bugs.
|
507
|
+
|
508
|
+
<a class="anchor release_tag" name="v0_0_0_dev1"></a>
|
509
|
+
<h2><a href="#v0_0_0_dev1">Tag: v0.0.0.dev1</a></h2>
|
510
|
+
|
511
|
+
##### Branch: 'Trunk'
|
512
|
+
|
513
|
+
##### by Stephen McGinty on 12-Dec-2013 11:30AM
|
514
|
+
|
515
|
+
|
516
|
+
Added SIDSC (SSDS) export capability.
|
517
|
+
|
518
|
+
Initial public API is now defined and described at:
|
519
|
+
http://origen.freescale.net/rosetta\_stone/
|
520
|
+
|
521
|
+
## Tag: v0.0.0.dev0
|
522
|
+
|
523
|
+
##### Branch: 'Trunk'
|
524
|
+
|
525
|
+
##### by Stephen McGinty on 05-Dec-2013 11:15AM
|
526
|
+
|
527
|
+
|
528
|
+
This is an initial tag of a new Origen plugin to provide import/export APIs to
|
529
|
+
interface with other Freescale tools.
|
530
|
+
|
531
|
+
For example the import APIs will allow register, pin and spec data that is
|
532
|
+
mastered somewhere else to be automatically imported and instantiated for use
|
533
|
+
within an Origen environment.
|
534
|
+
|
535
|
+
The export APIs will support the case where Origen is being used to master this
|
536
|
+
type of data as is currently being piloted by the NVM design team.
|
537
|
+
|
538
|
+
Many formats may ultimately be supported but initially the goal is to support
|
539
|
+
SIDSC (SSDS) and API-Factory.
|
540
|
+
|
541
|
+
This initial release fully supports importing SIDSC register data and has a
|
542
|
+
passing test case which imports registers for the ATX uC module from SSDS.
|
543
|
+
|
544
|
+
The public facing API is still in development and will be documented in due
|
545
|
+
course.
|
546
|
+
|
547
|
+
|
@@ -0,0 +1,73 @@
|
|
1
|
+
% render "layouts/basic.html" do
|
2
|
+
|
3
|
+
%# HTML tags can be embedded in mark down files if you want to do specific custom
|
4
|
+
%# formatting like this, but in most cases that is not required.
|
5
|
+
<h1><%= Origen.config.name %> <span style="font-size: 14px">(<%= Origen.app.version %>)</span></h1>
|
6
|
+
|
7
|
+
Welcome to your application's documentation...
|
8
|
+
|
9
|
+
Here are some pointers to get you started with writing Origen documents:
|
10
|
+
|
11
|
+
### Markdown
|
12
|
+
|
13
|
+
Most of your documents (such as this one you are reading) will be written in Markdown. This
|
14
|
+
allows you to create good looking and well formatted web-based documents easily and without
|
15
|
+
having to know anything about HTML.
|
16
|
+
|
17
|
+
Origen uses the Kramdown library to process the Markdown, this has a good quick reference
|
18
|
+
guide on the Markdown syntax here: [Markdown Quick Reference](http://kramdown.rubyforge.org/quickref.html)
|
19
|
+
|
20
|
+
### Links
|
21
|
+
|
22
|
+
Links can be added to your documents easily, like this one for example:
|
23
|
+
|
24
|
+
* [Freescale](http://www.freescale.com)
|
25
|
+
|
26
|
+
For linking to other pages within your own documents it is recommended that you use the
|
27
|
+
'path' helper to generate the url. By doing this Origen should generate links that work
|
28
|
+
correctly for both serving documents locally when developing and when deploying to a remote
|
29
|
+
web server. Here is an example:
|
30
|
+
|
31
|
+
* [Docs](<%= path "/docs/environment/introduction" %>)
|
32
|
+
|
33
|
+
### Code Examples
|
34
|
+
|
35
|
+
In the course of writing documentation you will probably want to show code examples
|
36
|
+
from time to time. Generic code snippets can be easily formatted with a mono-spaced
|
37
|
+
font like this:
|
38
|
+
|
39
|
+
~~~
|
40
|
+
origen t debug
|
41
|
+
origen g list/production.list
|
42
|
+
~~~
|
43
|
+
|
44
|
+
If you are showing examples of Ruby then they can be easily syntax-highlighted for
|
45
|
+
better presentation:
|
46
|
+
|
47
|
+
~~~ruby
|
48
|
+
# Cool, this is easy
|
49
|
+
def some_ruby
|
50
|
+
@blah = Blah.new
|
51
|
+
end
|
52
|
+
~~~
|
53
|
+
|
54
|
+
Origen uses the Coderay library for syntax highlighting and therefore should in theory
|
55
|
+
be able to highlight all languages listed here: [CodeRay Syntax Highlighting](http://coderay.rubychan.de/)
|
56
|
+
|
57
|
+
### Custom HTML
|
58
|
+
|
59
|
+
You may occasionally wish to have low level control of your documentation's HTML, this
|
60
|
+
can be done by simply embedding the HTML directly alongside the Markdown.
|
61
|
+
|
62
|
+
Origen already uses the [Twitter Bootstrap](http://twitter.github.io/bootstrap/index.html)
|
63
|
+
framework to generate these documents, so you already have full access to the features
|
64
|
+
provided by that framework.
|
65
|
+
|
66
|
+
For example here is how to insert a [Bootstrap alert](http://twitter.github.io/bootstrap/components.html#alerts):
|
67
|
+
|
68
|
+
<div class="alert">
|
69
|
+
<button type="button" class="close" data-dismiss="alert">×</button>
|
70
|
+
<strong>Warning!</strong> This example was just copied directly from the bootstrap documentation!
|
71
|
+
</div>
|
72
|
+
|
73
|
+
% end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
% render "layouts/basic.html", tab: :examples do
|
2
|
+
|
3
|
+
## IP-XACT Export
|
4
|
+
|
5
|
+
This page shows IP-XACT formatted XML that has been generated from an Origen
|
6
|
+
representation of a module.
|
7
|
+
|
8
|
+
The exporter has the following options:
|
9
|
+
|
10
|
+
* **:format** - nil by default, can be set to :uvm to include the associated vendor
|
11
|
+
extentions
|
12
|
+
* **:include_bit_field_values** - true by default, when false the bit field values
|
13
|
+
fields will not be output
|
14
|
+
|
15
|
+
The code to generate this page was simply:
|
16
|
+
|
17
|
+
~~~eruby
|
18
|
+
<%= "<" + "%= $dut.to_ip_xact format: :uvm %" + ">" %>
|
19
|
+
~~~
|
20
|
+
|
21
|
+
~~~xml
|
22
|
+
<%= $dut.to_ip_xact format: :uvm %>
|
23
|
+
~~~
|
24
|
+
|
25
|
+
% end
|