origen_doc_helpers 0.3.0 → 0.4.0

data/program/_func.rb

@@ -1,12 +0,0 @@
-# Functional test of the Vreg
-Flow.create do
-  # This test verifies that the following things work:
-  #
-  # * The vreg can be disabled
-  # * The trim register can be written to and read from
-  func :vreg_functional, vdd: :min, bin: 101
-
-  func :vreg_functional, vdd: :max, bin: 101, continue: true
-
-  import "hvst"
-end

data/program/_hvst.rb

@@ -1,12 +0,0 @@
-# HVST
-Flow.create do
-  # Check if this device has already had the Vreg HVST
-  func :rd_vreg_hvst_passcode, bin: 50, vdd: :nom, id: :vreg_hvst_done
-
-  # Apply HVST to the vreg module
-  func :vreg_hvst, bin: 101, hv: 10.V, vdd: :max, unless_passed: :vreg_hvst_done
-
-  # Program a passcode to the device to record that the HVST
-  # has been applied
-  func :pgm_vreg_hvst_passcode, bin: 51, vdd: :nom, unless_passed: :vreg_hvst_done
-end

data/program/_para.rb

@@ -1,26 +0,0 @@
-# Parametric flow
-#
-# Blah blah, this is marked down:
-#
-# * blah
-# * blah
-Flow.create do
-  # Measure the output of the vreg under no load, this is a simple
-  # test to catch any gross defects that prevent the vreg from working
-  #
-  # Blah blah, this is marked down:
-  #
-  # * blah
-  # * blah
-  pp "No load tests" do
-    para :vreg_meas, bin: 105, lo: 1.12, hi: 1.34
-
-    para :vreg_meas, bin: 105, cz: true, if_enable: "vreg_cz"
-  end
-
-  # Measure the output of the vreg under the given load, this is approximately
-  # equivalent to 1.5x the maximum load anticipated in a customer application.
-  para :vreg_meas, vdd: :min, bin: 105, load: 5.mA, lo: 1.10, hi: 1.34
-
-  para :vreg_meas, vdd: :max, bin: 105, load: 5.mA, lo: 1.12, hi: 1.34
-end

data/program/probe_1.rb

@@ -1,7 +0,0 @@
-Flow.create do
-  log "Vreg test module"
-
-  import "func"
-
-  import "para"
-end

data/templates/web/examples.md.erb

@@ -1,20 +0,0 @@
-% render "layouts/basic.html", :tab => :examples do
-
-# Examples
-
-The available helpers are split by engineering function below, click the
-helper of interest to see a live example of it and the application code
-that should be used to generate it.
-
-### General
-
-* [Searchable Documents](<%= path "/examples/searchable/intro" %>)
-* [Register Descriptions](<%= path "/examples/register" %>)
-* [Yammer Comments](<%= path "/examples/yammer" %>)
-* [Disqus Comments](<%= path "/examples/disqus" %>)
-
-### Test Engineering
-
-* [Test Flow](<%= path "/examples/test/flow" %>)
-
-% end

data/templates/web/examples/test/flow.md.erb

@@ -1,35 +0,0 @@
-% render "../../layouts/examples.html" do
-
-# Test Flow
-
-Documentation of an Origen-generated test program can be created as follows (requires a
-documentation interface to be setup):
-
-~~~eruby
-<%= "%" %> prog = OrigenTesters::Doc.generate_program_model("program/probe_1.rb", :target => "default")
-
-<%= "<" + "%= render \"doc_helpers/test/flow.md\", :heading => \"Probe 1\", :program => prog, :flow => :probe_1_flow %" + ">" %>
-~~~
-
-The test flow helper takes the following required options:
-
-* **heading** - The page heading, generally the name of the flow
-* **program** - Supply a pre-generated program model
-* **flow(s)** - The name of the flow(s) to document, supply multiple in an array
-
-Additionally these options are available to customize the output:
-
-* **link_to_pattern_docs** - Set this to <code>true</code> to generate links to documentation of the patterns
-  in place of the pattern name. Pattern docs should be placed in <code>templates/web/patterns</code> and the
-  files should be called \<pattern_name\>.md
-* **context** - Supply an execution context to document only the test where the context is true. For example to
-  document the tests that will run when job is "P1"is set
-  supply <code>{ :job => "P1" }</code>
-
-Here is a live example:
-
-% prog = OrigenTesters::Doc.generate_program_model("program/probe_1.rb", :target => "debug")
-
-<%= render "templates/shared/test/flow.md", :heading => "Probe 1", :program => prog, :flow => :probe_1_flow %>
-
-% end