Added links from test procedures to coverage points.

Author: james-ball-qualcomm

backends/portfolio/templates/coverage_points.adoc.erb

@@ -11,7 +11,7 @@ Coverage Points for `<%= nice_name %>`: ::
 | ID | Name | Description | Links
 
 <% db_obj.cert_coverage_points.each do |cp| -%>
-| <%= cp.id %>
+| <%= defined?(org) ? anchor_for_udb_cert_cov_pt(org, cp.id) : "" %><%= cp.id %>
 | <%= cp.name %>
 | <%= cp.description %>
 a| <% cp.cert_links.each do |link| -%>

backends/portfolio/templates/csr_appendix.adoc.erb

@@ -141,8 +141,8 @@ Reset value: ::
 <%= field.reset_value_pretty(design) %>
 
 <% if defined?(gen_ctp_content) && gen_ctp_content -%>
-<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => field, "use_description_list" => true }) %>
-<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => field, "use_description_list" => true }) %>
+<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => field, "org" => "appendix", "use_description_list" => true }) %>
+<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => field, "org" => "appendix", "use_description_list" => true }) %>
 <% end # if gen_ctp_content -%>
 
 ****
@@ -182,8 +182,8 @@ This CSR may return a value that is different from what is stored in hardware.
 <% end -%>
 
 <% if defined?(gen_ctp_content) && gen_ctp_content -%>
-<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => csr }) %>
-<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => csr }) %>
+<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => csr, "org" => "appendix" }) %>
+<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => csr, "org" => "appendix" }) %>
 <% end # if gen_ctp_content -%>
 
 <% end # do in_scope_csrs -%>

backends/portfolio/templates/ext_appendix.adoc.erb

@@ -123,8 +123,8 @@ This extension has the following parameters (AKA implementation options):
 <% end # unless table -%>
 
 <% if defined?(gen_ctp_content) && gen_ctp_content -%>
-<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => ext }) %>
-<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => ext }) %>
+<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => ext, "org" => "appendix"}) %>
+<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => ext, "org" => "appendix"}) %>
 <% end # if gen_ctp_content -%>
 
 <% end # do ext_req -%>

backends/portfolio/templates/inst_appendix.adoc.erb

@@ -133,8 +133,8 @@ This instruction may result in the following synchronous exceptions:
 <% end -%>
 
 <% if defined?(gen_ctp_content) && gen_ctp_content -%>
-<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => inst }) %>
-<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => inst }) %>
+<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => inst, "org" => "appendix" }) %>
+<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => inst, "org" => "appendix" }) %>
 <% end # if gen_ctp_content -%>
 
 <% end # each in_scope instruction -%>

backends/portfolio/templates/test_procedures.adoc.erb

@@ -16,7 +16,7 @@ Test Procedures for `<%= nice_name %>`: ::
 | *Coverage Points*
 a|
 <% tp.cert_coverage_points.each do |cp| -%>
-* <%= cp.id %>
+* <%= defined?(org) ? link_to_udb_cert_cov_pt(org, cp.id) : cp.id %>
 <% end # each cp -%>
 | *Steps*
 a|

backends/proc_ctp/templates/proc_ctp.adoc.erb

@@ -91,21 +91,21 @@ This document is generated by a database backend so all views of the information
 === Extension Coverage Points
 
 <% proc_cert_model.in_scope_extensions.each do |ext| -%>
-<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => ext }) %>
+<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => ext, "org" => "sep"}) %>
 <% end -%>
 
 === Instruction Coverage Points
 
 <% proc_cert_model.in_scope_instructions(design).each do |inst| -%>
-<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => inst }) %>
+<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => inst, "org" => "sep"}) %>
 <% end -%>
 
 === CSR Coverage Points
 
 <% proc_cert_model.in_scope_csrs(design).each do |csr| -%>
-<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => csr }) %>
+<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => csr, "org" => "sep" }) %>
 <% csr.implemented_fields(design).each do |field| -%>
-<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => field }) %>
+<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => field, "org" => "sep" }) %>
 <% end -%>
 <% end -%>
 
@@ -118,21 +118,21 @@ This document is generated by a database backend so all views of the information
 === Extension Test Procedures
 
 <% proc_cert_model.in_scope_extensions.each do |ext| -%>
-<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => ext }) %>
+<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => ext, "org" => "sep" }) %>
 <% end -%>
 
 === Instruction Test Procedures
 
 <% proc_cert_model.in_scope_instructions(design).each do |inst| -%>
-<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => inst }) %>
+<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => inst, "org" => "sep" }) %>
 <% end -%>
 
 === CSR Test Procedures
 
 <% proc_cert_model.in_scope_csrs(design).each do |csr| -%>
-<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => csr }) %>
+<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => csr, "org" => "sep" }) %>
 <% csr.implemented_fields(design).each do |field| -%>
-<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => field }) %>
+<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => field, "org" => "sep" }) %>
 <% end -%>
 <% end -%>
 
@@ -145,25 +145,25 @@ This document is generated by a database backend so all views of the information
 === Extension Coverage Points & Test Procedures
 
 <% proc_cert_model.in_scope_extensions.each do |ext| -%>
-<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => ext }) %>
-<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => ext }) %>
+<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => ext, "org" => "combo"}) %>
+<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => ext, "org" => "combo"}) %>
 <% end -%>
 
 === Instruction Coverage Points & Test Procedures
 
 <% proc_cert_model.in_scope_instructions(design).each do |inst| -%>
-<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => inst }) %>
-<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => inst }) %>
+<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => inst, "org" => "combo"}) %>
+<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => inst, "org" => "combo"}) %>
 <% end -%>
 
 === CSR Coverage Points & Test Procedures
 
 <% proc_cert_model.in_scope_csrs(design).each do |csr| -%>
-<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => csr }) %>
-<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => csr }) %>
+<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => csr, "org" => "combo"}) %>
+<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => csr, "org" => "combo"}) %>
 <% csr.implemented_fields(design).each do |field| -%>
-<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => field, "use_description_list" => true }) %>
-<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => field, "use_description_list" => true }) %>
+<%= portfolio_design.include_erb("coverage_points.adoc.erb", { "db_obj" => field, "use_description_list" => true, "org" => "combo"}) %>
+<%= portfolio_design.include_erb("test_procedures.adoc.erb", { "db_obj" => field, "use_description_list" => true, "org" => "combo"}) %>
 <% end -%>
 <% end -%>
 

lib/backend_helpers.rb

@@ -10,9 +10,9 @@ class String
   # Should be called on all RISC-V extension, instruction, CSR, and CSR field names.
   # Parameters never have periods in their names so they don't need to be sanitized.
   #
-  # @param name [String] Some RISC-V name which might have periods in it
-  # @return [String] New String with periods replaced with underscores
-  def sanitize = String.new(self).gsub(".", "_")
+  # @param name [String] Some RISC-V name which might have periods in it or ampersand
+  # @return [String] New String with periods replaced with underscores and ampersands replaced with "_and_"
+  def sanitize = String.new(self).gsub(".", "_").gsub("&", "_and_")
 end
 
 # This module is included in the Design class so its methods are available to be called directly
@@ -94,6 +94,14 @@ def link_into_idl_inst_code(inst_name, loc_name)
   end
   # TODO: Add csr and csr_field support
 
+  # @return [String] A hyperlink to a UDB certification coverage point (separate chapters for cov pts and test procs)
+  # @param org [String] Organization of coverage points and test procedures (sep=separate chapters, combo=combined chapters, appendix=appendix)
+  # @param id [String] ID of the coverage point
+  def link_to_udb_cert_cov_pt(org, id)
+    raise ArgumentError, "Unknown org value of '#{org}' for ID '#{id}'" unless org == "sep" || org == "combo" || org == "appendix"
+    "%%UDB_CERT_COV_PT_LINK%#{org};#{id.sanitize};#{id}%%"
+  end
+
   ###########
   # ANCHORS #
   ###########
@@ -137,14 +145,23 @@ def anchor_for_udb_doc_idl_func(name)
     "[#udb:doc:func:#{name.sanitize}]"
   end
 
-  # @return [String] A anchor inside IDL instruction code
+  # @return [String] An anchor inside IDL instruction code
   # @param func_name [String] Name of the instruction
   # @param func_name [String] Name of the location within the instruction code
   def anchor_inside_idl_inst_code(inst_name, loc_name)
     "[#idl:code:inst:#{inst_name.sanitize}:#{loc_name.sanitize}]"
   end
   # TODO: Add csr and csr_field support
 
+  # @return [String] An anchor for a UDB certification coverage point (separate chapters for cov pts and test procs)
+  # @param org [String] Organization of coverage points and test procedures (sep=separate chapters, combo=combined chapters, appendix=appendix)
+  # @param id [String] ID of the coverage point
+  # Have to use [[anchor]] instead of [#anchor] since only the former works when in a table cell.
+  def anchor_for_udb_cert_cov_pt(org, id)
+    raise ArgumentError, "Unknown org value of '#{org}' for ID '#{id}'" unless org == "sep" || org == "combo" || org == "appendix"
+    "[[udb:cert:cov_pt:#{org}:#{id.sanitize}]]"
+  end
+
   private
     #@ param s [String]
     def check_no_periods(s)
@@ -208,6 +225,14 @@ def resolve_links(path_or_str)
         else
           raise "Unhandled link type of '#{type}' for '#{name}' with link_text '#{link_text}'"
         end
+      end.gsub(/%%UDB_CERT_COV_PT_LINK%([^;%]+)\s*;\s*([^;%]+)\s*;\s*([^%]+)%%/) do
+        org = Regexp.last_match[1] # sep or combo
+        id = Regexp.last_match[2]
+        link_text = Regexp.last_match[3]
+
+        raise "Unhandled link org of '#{org}' for ID '#{id}' with link_text '#{link_text}'" unless org == "sep" || org == "combo" || org == "appendix"
+
+        "<<udb:cert:cov_pt:#{org}:#{id},#{link_text}>>"
       end
     end
   end

lib/test/test_backend_helpers.rb

@@ -59,6 +59,14 @@ def test_idl_code
     assert_equal("%%IDL_CODE_LINK%inst;fo_o.ba_r;fo.o.ba.r%%", link_into_idl_inst_code("fo.o","ba.r"))
     assert_equal("[#idl:code:inst:fo_o:ba_r]", anchor_inside_idl_inst_code("fo.o","ba.r"))
   end
+
+  def test_cert_cov_pt
+    assert_equal("%%UDB_CERT_COV_PT_LINK%sep;foo_and_bar;foo&bar%%", link_to_udb_cert_cov_pt("sep", "foo&bar"))
+    assert_equal("[[udb:cert:cov_pt:sep:foo]]", anchor_for_udb_cert_cov_pt("sep", "foo"))
+    assert_equal("%%UDB_CERT_COV_PT_LINK%combo;fo_o;fo.o%%", link_to_udb_cert_cov_pt("combo", "fo.o"))
+    assert_equal("[[udb:cert:cov_pt:combo:fo_o]]", anchor_for_udb_cert_cov_pt("combo", "fo.o"))
+    assert_raises(ArgumentError) { link_to_udb_cert_cov_pt("bad-org-value","abc") }
+  end
 end
 
 class TestAsciidocUtils < Minitest::Test
@@ -96,6 +104,13 @@ def test_resolve_links_idl_code
     assert_equal("<<idl:code:inst:foo:bar,zort>>", AsciidocUtils.resolve_links("%%IDL_CODE_LINK%inst;foo.bar;zort%%"))
     assert_equal("<<idl:code:inst:foo:bar,foo.bar>>", AsciidocUtils.resolve_links(link_into_idl_inst_code("foo","bar")))
   end
+
+  def test_resolve_links_cert_cov_pt
+    assert_equal("<<udb:cert:cov_pt:sep:foo,bar>>", AsciidocUtils.resolve_links("%%UDB_CERT_COV_PT_LINK%sep;foo;bar%%"))
+    assert_equal("<<udb:cert:cov_pt:sep:foo,foo>>", AsciidocUtils.resolve_links(link_to_udb_cert_cov_pt("sep", "foo")))
+    assert_equal("<<udb:cert:cov_pt:combo:foo,bar>>", AsciidocUtils.resolve_links("%%UDB_CERT_COV_PT_LINK%combo;foo;bar%%"))
+    assert_equal("<<udb:cert:cov_pt:combo:foo,foo>>", AsciidocUtils.resolve_links(link_to_udb_cert_cov_pt("combo", "foo")))
+  end
 end
 
 class TestAntoraUtils < Minitest::Test