util/intelp2m: Add support for Alder Lake macro generation

Add support for Alder Lake as a separate parsing profile, copying the
existing 'Cannon' profile and adjusting for differences in reset mapping
and GPIO macro generation.

TEST=Generate GPIO macros for MSI PRO Z690-A

Change-Id: I5871394bcb0636c2c803607ffb129441aa934417
Signed-off-by: Michał Kopeć <michal.kopec@3mdeb.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/63403
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Maxim Polyakov <max.senia.poliak@gmail.com>

6 files changed, 150 insertions, 2 deletions

diff --git a/util/intelp2m/config/config.go b/util/intelp2m/config/config.go
index 16fb4d6e01..4d2a700c54 100644
--- a/util/intelp2m/config/config.go
+++ b/util/intelp2m/config/config.go
@@ -28,6 +28,7 @@ const (
 	LewisburgType uint8  = 1
 	ApolloType    uint8  = 2
 	CannonType    uint8  = 3
+	AlderType    uint8  = 4
 )
 
 var key uint8 = SunriseType
@@ -36,7 +37,8 @@ var platform = map[string]uint8{
 	"snr": SunriseType,
 	"lbg": LewisburgType,
 	"apl": ApolloType,
-	"cnl": CannonType}
+	"cnl": CannonType,
+	"adl": AlderType}
 func PlatformSet(name string) int {
 	if platformType, valid := platform[name]; valid {
 		key = platformType
@@ -62,6 +64,9 @@ func IsPlatformLewisburg() bool {
 func IsPlatformCannonLake() bool {
 	return IsPlatform(CannonType)
 }
+func IsPlatformAlderLakeH() bool {
+	return IsPlatform(AlderType)
+}
 
 var InputRegDumpFile *os.File = nil
 var OutputGenFile *os.File = nil
diff --git a/util/intelp2m/description.md b/util/intelp2m/description.md
index 1aaee40ca0..9064817972 100644
--- a/util/intelp2m/description.md
+++ b/util/intelp2m/description.md
@@ -36,6 +36,7 @@ platform type is set using the -p option (Sunrise by default):
 		lbg - Lewisburg PCH with Xeon SP CPU
 		apl - Apollo Lake SoC
 		cnl - CannonLake-LP or Whiskeylake/Coffeelake/Cometlake-U SoC
+		adl - AlderLake PCH
 	(default "snr")
 
 (shell)$ ./intelp2m -p <platform> -file path/to/inteltool.log
diff --git a/util/intelp2m/main.go b/util/intelp2m/main.go
index fdfc34f8c4..225d36943f 100644
--- a/util/intelp2m/main.go
+++ b/util/intelp2m/main.go
@@ -68,7 +68,8 @@ func main() {
 		"\tsnr - Sunrise PCH or Skylake/Kaby Lake SoC\n"+
 		"\tlbg - Lewisburg PCH with Xeon SP\n"+
 		"\tapl - Apollo Lake SoC\n"+
-		"\tcnl - CannonLake-LP or Whiskeylake/Coffeelake/Cometlake-U SoC\n")
+		"\tcnl - CannonLake-LP or Whiskeylake/Coffeelake/Cometlake-U SoC\n"+
+		"\tadl - AlderLake PCH\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 bfcdff8859..34c961cdea 100644
--- a/util/intelp2m/parser/parser.go
+++ b/util/intelp2m/parser/parser.go
@@ -10,6 +10,7 @@ import (
 	"../platforms/lbg"
 	"../platforms/apl"
 	"../platforms/cnl"
+	"../platforms/adl"
 	"../config"
 )
 
@@ -147,6 +148,7 @@ func (parser *ParserData) PlatformSpecificInterfaceSet() {
 		config.CannonType    : cnl.PlatformSpecific{
 			InheritanceTemplate : snr.PlatformSpecific{},
 		},
+		config.AlderType    : adl.PlatformSpecific{},
 	}
 	parser.platform = platform[config.PlatformGet()]
 }
diff --git a/util/intelp2m/platforms/adl/macro.go b/util/intelp2m/platforms/adl/macro.go
new file mode 100644
index 0000000000..9ef4cd5200
--- /dev/null
+++ b/util/intelp2m/platforms/adl/macro.go
@@ -0,0 +1,115 @@
+package adl
+
+import (
+	"strings"
+	"fmt"
+	"../common"
+	"../../config"
+	"../../fields"
+	"../snr"
+	"../cnl"
+)
+
+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 Alderlake GPD Group in the Community 2:
+		// https://github.com/coreboot/coreboot/blob/master/src/soc/intel/alderlake/gpio.c#L21
+		// 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,
+		3: common.RST_PWROK  << 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/adl/template.go b/util/intelp2m/platforms/adl/template.go
new file mode 100644
index 0000000000..491aa3c93a
--- /dev/null
+++ b/util/intelp2m/platforms/adl/template.go
@@ -0,0 +1,24 @@
+package adl
+
+import "../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_I", "GPP_J", "GPP_K", "GPP_R", "GPP_S", "GPP_T",
+		"GPD", "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
+}