[coreboot-gerrit] [S] Change in coreboot[main]: util/intelp2m/parser/template: Add unit test

[David Hendricks (Code Review)]

David Hendricks has submitted this change. ( https://review.coreboot.org/c/coreboot/+/67135?usp=email )

(

18 is the latest approved patch-set.
No files were changed between the latest approved patch-set and the submitted one.
 )Change subject: util/intelp2m/parser/template: Add unit test
......................................................................

util/intelp2m/parser/template: Add unit test

Change-Id: I1612a7d18bf53479cbe53ca0ba761b67e795c16b
Signed-off-by: Maxim Polyakov 
Reviewed-on: https://review.coreboot.org/c/coreboot/+/67135
Reviewed-by: Alicja Michalska 
Reviewed-by: David Hendricks 
Tested-by: build bot (Jenkins) 
---
M util/intelp2m/parser/parser.go
M util/intelp2m/parser/template.go
A util/intelp2m/parser/template_test.go
3 files changed, 43 insertions(+), 3 deletions(-)

Approvals:
  Alicja Michalska: Looks good to me, but someone else must approve
  David Hendricks: Looks good to me, approved
  build bot (Jenkins): Verified

diff --git a/util/intelp2m/parser/parser.go b/util/intelp2m/parser/parser.go
index fd3191d..f6ed047 100644
--- a/util/intelp2m/parser/parser.go
+++ b/util/intelp2m/parser/parser.go
@@ -117,7 +117,7 @@
    var function, id string
    var dw0, dw1 uint32
    var template = map[int]template{
-		config.TempInteltool: useInteltoolLogTemplate,
+		config.TempInteltool: UseInteltoolLogTemplate,
    	config.TempGpioh    : useGpioHTemplate,
    	config.TempSpec     : useYourTemplate,
    }
diff --git a/util/intelp2m/parser/template.go b/util/intelp2m/parser/template.go
index 3248152..fc67e73 100644
--- a/util/intelp2m/parser/template.go
+++ b/util/intelp2m/parser/template.go
@@ -6,6 +6,8 @@
    "unicode"
 )

+const INTSEL_MASK uint32 = 0xffffff00
+
 type template func(string, *string, *string, *uint32, *uint32) int

// extractPadFuncFromComment
@@ -38,7 +40,7 @@
 // *dw1      : DW1 register value
 // return
 //   error status
-func useInteltoolLogTemplate(line string, function *string,
+func UseInteltoolLogTemplate(line string, function *string,
    id *string, dw0 *uint32, dw1 *uint32) int {

var val uint64
@@ -57,7 +59,7 @@
    		*function += "/" + fields[i]
    	}
    	// clear RO Interrupt Select (INTSEL)
-		*dw1 &= 0xffffff00
+		*dw1 &= INTSEL_MASK
    }
    return 0
 }
diff --git a/util/intelp2m/parser/template_test.go b/util/intelp2m/parser/template_test.go
new file mode 100644
index 0000000..98ccb3f
--- /dev/null
+++ b/util/intelp2m/parser/template_test.go
@@ -0,0 +1,38 @@
+package parser_test
+
+import (
+	"fmt"
+	"testing"
+
+	"review.coreboot.org/coreboot.git/util/intelp2m/parser"
+)
+
+func TestTemp(t *testing.T) {
+	t.Run("TEMPLATE/INTELTOOL-LINE", func(t *testing.T) {
+		const (
+			ref_fn  string = "SLP_S0#"
+			ref_id  string = "GPP_B12"
+			ref_dw0 uint32 = 0x44000600
+			ref_dw1 uint32 = 0x0000003c
+		)
+		var (
+			fn, id   string
+			dw0, dw1 uint32
+		)
+		line := fmt.Sprintf("0x0520: 0x%08x%08x %s %s", ref_dw1, ref_dw0, ref_id, ref_fn)
+		_ = parser.UseInteltoolLogTemplate(line, &fn, &id, &dw0, &dw1)
+		if fn != ref_fn {
+			t.Errorf("function from '%s':\nExpects:  '%s'\nActually: '%s'\n\n",
+				line, ref_fn, fn)
+		} else if id != ref_id {
+			t.Errorf("id from '%s':\nExpects:  '%s'\nActually: '%s'\n\n",
+				line, ref_id, id)
+		} else if dw0 != ref_dw0 {
+			t.Errorf("dw0 from '%s':\nExpects:  '0x%08x'\nActually: '0x%08x'\n\n",
+				line, ref_dw0, dw0)
+		} else if dw1 != (ref_dw1 & parser.INTSEL_MASK) {
+			t.Errorf("dw1 from '%s':\nExpects:  '0x%08x'\nActually: '0x%08x'\n\n",
+				line, (ref_dw1 & parser.INTSEL_MASK), dw1)
+		}
+	})
+}