[M] Change in coreboot[main]: util/intelp2m: Add support for TigerLake-H SoC

[Felix Held (Code Review)]

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

Change subject: util/intelp2m: Add support for TigerLake-H SoC
......................................................................

util/intelp2m: Add support for TigerLake-H SoC

Add support for TigerLake Halo SoC, based on CNL profile.

Test: Convert GPIO dump from inteltool into coreboot macros for
out-of-tree TGL board.

Change-Id: I26eff225c2045edfe5836283be7b4c63f6b405e8
Signed-off-by: Alicja Michalska 
Reviewed-on: https://review.coreboot.org/c/coreboot/+/81587
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/tgl/macro.go
A util/intelp2m/platforms/tgl/template.go
5 files changed, 149 insertions(+), 2 deletions(-)

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

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

var key uint8 = SunriseType
@@ -39,6 +40,7 @@
    "lbg": LewisburgType,
    "apl": ApolloType,
    "cnl": CannonType,
+	"tgl": TigerType,
    "adl": AlderType,
    "jsl": JasperType,
 }
@@ -67,6 +69,9 @@
 func IsPlatformCannonLake() bool {
    return IsPlatform(CannonType)
 }
+func IsPlatformTigerLake() bool {
+	return IsPlatform(TigerType)
+}
 func IsPlatformAlderLakeH() bool {
    return IsPlatform(AlderType)
 }
diff --git a/util/intelp2m/main.go b/util/intelp2m/main.go
index b3835ff..64db9fee 100644
--- a/util/intelp2m/main.go
+++ b/util/intelp2m/main.go
@@ -70,6 +70,7 @@
    	"\tlbg - Lewisburg PCH with Xeon SP\n"+
    	"\tapl - Apollo Lake SoC\n"+
    	"\tcnl - CannonLake-LP or Whiskeylake/Coffeelake/Cometlake-U SoC\n"+
+		"\ttgl - TigerLake-H SoC\n"+
    	"\tadl - AlderLake PCH\n"+
    	"\tjsl - Jasper Lake SoC\n")

diff --git a/util/intelp2m/parser/parser.go b/util/intelp2m/parser/parser.go
index 0e2a64b..a6fa315 100644
--- a/util/intelp2m/parser/parser.go
+++ b/util/intelp2m/parser/parser.go
@@ -11,6 +11,7 @@
    "review.coreboot.org/coreboot.git/util/intelp2m/platforms/lbg"
    "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/tgl"
    "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"
@@ -150,6 +151,7 @@
    	config.CannonType    : cnl.PlatformSpecific{
    		InheritanceTemplate : snr.PlatformSpecific{},
    	},
+		config.TigerType     : tgl.PlatformSpecific{},
    	config.AlderType     : adl.PlatformSpecific{},
    	config.JasperType    : jsl.PlatformSpecific{},
    }
diff --git a/util/intelp2m/platforms/tgl/macro.go b/util/intelp2m/platforms/tgl/macro.go
new file mode 100644
index 0000000..3b436ee
--- /dev/null
+++ b/util/intelp2m/platforms/tgl/macro.go
@@ -0,0 +1,115 @@
+package tgl
+
+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 << 24) | (0x3 << 21) | (0xf << 16) | 0xfc
+	PAD_CFG_DW1_RO_FIELDS = 0xfdffc3ff
+)
+
+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(), "GPD") {
+		// See reset map for the TigerLake Community 2:
+		// https://github.com/coreboot/coreboot/blob/master/src/soc/intel/tigerlake/gpi...
+		// 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/tgl/template.go b/util/intelp2m/platforms/tgl/template.go
new file mode 100644
index 0000000..f98272a
--- /dev/null
+++ b/util/intelp2m/platforms/tgl/template.go
@@ -0,0 +1,24 @@
+package tgl
+
+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_R", "GPP_B", "GPP_D", "GPP_C", "GPP_S", "GPP_G",
+		"GPD", "GPP_E", "GPP_F", "GPP_H", "GPP_J", "GPP_K", "GPP_I",
+		"VGPIO_USB", "VGPIO_PCIE")
+
+}
+
+// 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
+}