[M] Change in coreboot[main]: util/intelp2m: Support Jasper Lake

[Felix Held (Code Review)]

Felix Held has submitted this change. ( https://review.coreboot.org/c/coreboot/+/78093?usp=email )

Change subject: util/intelp2m: Support Jasper Lake
......................................................................

util/intelp2m: Support Jasper Lake

Support generating Jasper Lake GPIO configuration from inteltool logs

Change-Id: I519d27e0c91c8d9159224d9bc1c6e49c83270b7a
Signed-off-by: Jonathon Hall 
Reviewed-on: https://review.coreboot.org/c/coreboot/+/78093
Tested-by: build bot (Jenkins) 
Reviewed-by: Maxim 
---
M util/intelp2m/config/config.go
M util/intelp2m/main.go
M util/intelp2m/parser/parser.go
A util/intelp2m/platforms/jsl/macro.go
A util/intelp2m/platforms/jsl/template.go
5 files changed, 152 insertions(+), 4 deletions(-)

Approvals:
  build bot (Jenkins): Verified
  Maxim: Looks good to me, approved

diff --git a/util/intelp2m/config/config.go b/util/intelp2m/config/config.go
index 4d2a700..7b491b1 100644
--- a/util/intelp2m/config/config.go
+++ b/util/intelp2m/config/config.go
@@ -28,7 +28,8 @@
    LewisburgType uint8  = 1
    ApolloType    uint8  = 2
    CannonType    uint8  = 3
-	AlderType    uint8  = 4
+	AlderType     uint8  = 4
+	JasperType    uint8  = 5
 )

var key uint8 = SunriseType
@@ -38,7 +39,9 @@
    "lbg": LewisburgType,
    "apl": ApolloType,
    "cnl": CannonType,
-	"adl": AlderType}
+	"adl": AlderType,
+	"jsl": JasperType,
+}
 func PlatformSet(name string) int {
    if platformType, valid := platform[name]; valid {
    	key = platformType
diff --git a/util/intelp2m/main.go b/util/intelp2m/main.go
index 3de34dd..b3835ff 100644
--- a/util/intelp2m/main.go
+++ b/util/intelp2m/main.go
@@ -70,7 +70,8 @@
    	"\tlbg - Lewisburg PCH with Xeon SP\n"+
    	"\tapl - Apollo Lake SoC\n"+
    	"\tcnl - CannonLake-LP or Whiskeylake/Coffeelake/Cometlake-U SoC\n"+
-		"\tadl - AlderLake PCH\n")
+		"\tadl - AlderLake PCH\n"+
+		"\tjsl - Jasper Lake SoC\n")

fieldstyle :=  flag.String("fld", "none", "set fields macros style:\n"+
    	"\tcb  - use coreboot style for bit fields macros\n"+
diff --git a/util/intelp2m/parser/parser.go b/util/intelp2m/parser/parser.go
index c6a9388..0e2a64b 100644
--- a/util/intelp2m/parser/parser.go
+++ b/util/intelp2m/parser/parser.go
@@ -12,6 +12,7 @@
    "review.coreboot.org/coreboot.git/util/intelp2m/platforms/apl"
    "review.coreboot.org/coreboot.git/util/intelp2m/platforms/cnl"
    "review.coreboot.org/coreboot.git/util/intelp2m/platforms/adl"
+	"review.coreboot.org/coreboot.git/util/intelp2m/platforms/jsl"
    "review.coreboot.org/coreboot.git/util/intelp2m/config"
 )

@@ -149,7 +150,8 @@
    	config.CannonType    : cnl.PlatformSpecific{
    		InheritanceTemplate : snr.PlatformSpecific{},
    	},
-		config.AlderType    : adl.PlatformSpecific{},
+		config.AlderType     : adl.PlatformSpecific{},
+		config.JasperType    : jsl.PlatformSpecific{},
    }
    parser.platform = platform[config.PlatformGet()]
 }
diff --git a/util/intelp2m/platforms/jsl/macro.go b/util/intelp2m/platforms/jsl/macro.go
new file mode 100644
index 0000000..89cf2f0
--- /dev/null
+++ b/util/intelp2m/platforms/jsl/macro.go
@@ -0,0 +1,119 @@
+package jsl
+
+import (
+	"strings"
+	"fmt"
+
+	"review.coreboot.org/coreboot.git/util/intelp2m/platforms/common"
+	"review.coreboot.org/coreboot.git/util/intelp2m/platforms/snr"
+	"review.coreboot.org/coreboot.git/util/intelp2m/platforms/cnl"
+	"review.coreboot.org/coreboot.git/util/intelp2m/config"
+	"review.coreboot.org/coreboot.git/util/intelp2m/fields"
+)
+
+const (
+	PAD_CFG_DW0_RO_FIELDS = (0x1 << 27) | (0x1 << 18) | (0x3f << 11) | (0x3f << 2) | (0x1 << 1)
+	PAD_CFG_DW1_RO_FIELDS = 0xdfffc3ff
+)
+
+const (
+	PAD_CFG_DW0 = common.PAD_CFG_DW0
+	PAD_CFG_DW1 = common.PAD_CFG_DW1
+	MAX_DW_NUM  = common.MAX_DW_NUM
+)
+
+type InheritanceMacro interface {
+	Pull()
+	GpiMacroAdd()
+	GpoMacroAdd()
+	NativeFunctionMacroAdd()
+	NoConnMacroAdd()
+}
+
+type PlatformSpecific struct {
+	InheritanceMacro
+}
+
+// RemmapRstSrc - remmap Pad Reset Source Config
+func (PlatformSpecific) RemmapRstSrc() {
+	macro := common.GetMacro()
+	if config.TemplateGet() != config.TempInteltool {
+		// Use reset source remapping only if the input file is inteltool.log dump
+		return
+	}
+	if strings.Contains(macro.PadIdGet(), "GPP_F") ||
+			strings.Contains(macro.PadIdGet(), "GPP_B") ||
+			strings.Contains(macro.PadIdGet(), "GPP_A") ||
+			strings.Contains(macro.PadIdGet(), "GPP_S") ||
+			strings.Contains(macro.PadIdGet(), "GPP_R") {
+		// See reset map for the Jasper Lake Community 0:
+		// https://github.com/coreboot/coreboot/blob/master/src/soc/intel/jasperlake/gp...
+		// remmap is not required because it is the same as common.
+		return
+	}
+
+	dw0 := macro.Register(PAD_CFG_DW0)
+	var remapping = map[uint8]uint32{
+		0: common.RST_RSMRST << common.PadRstCfgShift,
+		1: common.RST_DEEP   << common.PadRstCfgShift,
+		2: common.RST_PLTRST << common.PadRstCfgShift,
+	}
+	resetsrc, valid := remapping[dw0.GetResetConfig()]
+	if valid {
+		// dw0.SetResetConfig(resetsrc)
+		ResetConfigFieldVal := (dw0.ValueGet() & 0x3fffffff) | remapping[dw0.GetResetConfig()]
+		dw0.ValueSet(ResetConfigFieldVal)
+	} else {
+		fmt.Println("Invalid Pad Reset Config [ 0x", resetsrc ," ] for ", macro.PadIdGet())
+	}
+	dw0.CntrMaskFieldsClear(common.PadRstCfgMask)
+}
+
+// Adds The Pad Termination (TERM) parameter from PAD_CFG_DW1 to the macro
+// as a new argument
+func (platform PlatformSpecific) Pull() {
+	platform.InheritanceMacro.Pull()
+}
+
+// Adds PAD_CFG_GPI macro with arguments
+func (platform PlatformSpecific) GpiMacroAdd() {
+	platform.InheritanceMacro.GpiMacroAdd()
+}
+
+// Adds PAD_CFG_GPO macro with arguments
+func (platform PlatformSpecific) GpoMacroAdd() {
+	platform.InheritanceMacro.GpoMacroAdd()
+}
+
+// Adds PAD_CFG_NF macro with arguments
+func (platform PlatformSpecific) NativeFunctionMacroAdd() {
+	platform.InheritanceMacro.NativeFunctionMacroAdd()
+}
+
+// Adds PAD_NC macro
+func (platform PlatformSpecific) NoConnMacroAdd() {
+	platform.InheritanceMacro.NoConnMacroAdd()
+}
+
+// GenMacro - generate pad macro
+// dw0 : DW0 config register value
+// dw1 : DW1 config register value
+// return: string of macro
+//         error
+func (PlatformSpecific) GenMacro(id string, dw0 uint32, dw1 uint32, ownership uint8) string {
+	macro := common.GetInstanceMacro(
+		PlatformSpecific{
+			InheritanceMacro: cnl.PlatformSpecific{
+				InheritanceMacro: snr.PlatformSpecific{},
+			},
+		},
+		fields.InterfaceGet(),
+	)
+	macro.Clear()
+	macro.Register(PAD_CFG_DW0).CntrMaskFieldsClear(common.AllFields)
+	macro.Register(PAD_CFG_DW1).CntrMaskFieldsClear(common.AllFields)
+	macro.PadIdSet(id).SetPadOwnership(ownership)
+	macro.Register(PAD_CFG_DW0).ValueSet(dw0).ReadOnlyFieldsSet(PAD_CFG_DW0_RO_FIELDS)
+	macro.Register(PAD_CFG_DW1).ValueSet(dw1).ReadOnlyFieldsSet(PAD_CFG_DW1_RO_FIELDS)
+	return macro.Generate()
+}
diff --git a/util/intelp2m/platforms/jsl/template.go b/util/intelp2m/platforms/jsl/template.go
new file mode 100644
index 0000000..203b27e
--- /dev/null
+++ b/util/intelp2m/platforms/jsl/template.go
@@ -0,0 +1,23 @@
+package jsl
+
+import "review.coreboot.org/coreboot.git/util/intelp2m/platforms/common"
+
+// GroupNameExtract - This function extracts the group ID, if it exists in a row
+// line      : string from the configuration file
+// return
+//     bool   : true if the string contains a group identifier
+//     string : group identifier
+func (PlatformSpecific) GroupNameExtract(line string) (bool, string) {
+	return common.KeywordsCheck(line,
+		"GPP_A", "GPP_B", "GPP_C", "GPP_D", "GPP_E", "GPP_F", "GPP_G",
+		"GPP_H", "GPP_R", "GPP_S", "GPP_T", "GPD", "HVMOS", "VGPIO5")
+
+}
+
+// KeywordCheck - This function is used to filter parsed lines of the configuration file and
+//                returns true if the keyword is contained in the line.
+// line      : string from the configuration file
+func (PlatformSpecific) KeywordCheck(line string) bool {
+	isIncluded, _ := common.KeywordsCheck(line, "GPP_", "GPD", "VGPIO")
+	return isIncluded
+}