util/intelp2m: Add Intel Pad to Macro utility

This patch adds a new utility for converting a pad configuration from
the inteltool dump to the PAD_CFG_*() macros [1] for coreboot and GPIO
config data structures for FSP/sdk2-platforms/slimbootloader [2,3].
Mirror: https://github.com/maxpoliak/pch-pads-parser.git

[1] src/soc/intel/common/block/include/intelblocks/gpio_defs.h
[2] https://slimbootloader.github.io/tools/index.html#gpio-tool
[3] 3rdparty/fsp/CometLakeFspBinPkg/CometLake1/Include/GpioSampleDef.h

Change-Id: If3e3b523c4f63dc2f91e9ccd16934e3a1b6e21fa
Signed-off-by: Maxim Polyakov <max.senia.poliak@gmail.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/35643
Reviewed-by: Andrey Petrov <andrey.petrov@gmail.com>
Reviewed-by: Angel Pons <th3fanbus@gmail.com>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>

1 files changed, 171 insertions, 0 deletions

diff --git a/util/intelp2m/fields/cb/cb.go b/util/intelp2m/fields/cb/cb.go
new file mode 100644
index 0000000000..61f59c4f3e
--- /dev/null
+++ b/util/intelp2m/fields/cb/cb.go
@@ -0,0 +1,171 @@
+package cb
+
+import "../../config"
+import "../../platforms/common"
+
+type FieldMacros struct {}
+
+// field - data structure for creating a new bitfield macro object
+// PAD_FUNC(NF3)
+// prefix       : PAD_FUNC
+// name         : NF3; this value will be overridden if the configurator is used
+// unhide       : conditions for hiding macros
+// configurator : method for determining the current configuration of the bit field
+type field struct {
+	prefix       string
+	name         string
+	unhide       bool
+	configurator func()
+}
+
+// generate - wrapper for generating bitfield macros string
+// fileds : field structure
+func generate(fileds ...*field) {
+	macro := common.GetMacro()
+	var allhidden bool = true
+	for _, field := range fileds {
+		if field.unhide {
+			allhidden = false
+			macro.Or()
+			if field.prefix != "" {
+				macro.Add(field.prefix).Add("(")
+			}
+			if field.name != "" {
+				macro.Add(field.name)
+			} else if field.configurator != nil {
+				field.configurator()
+			}
+			if field.prefix != "" {
+				macro.Add(")")
+			}
+		}
+	}
+	if allhidden { macro.Add("0") }
+}
+
+// DecodeDW0 - decode value of DW0 register
+func (FieldMacros) DecodeDW0() {
+	macro := common.GetMacro()
+	dw0 := macro.Register(common.PAD_CFG_DW0)
+	generate(
+		&field {
+			prefix : "PAD_FUNC",
+			unhide : config.InfoLevelGet() <= 3 || dw0.GetPadMode() != 0,
+			configurator : func() { macro.Padfn() },
+		},
+
+		&field {
+			prefix : "PAD_RESET",
+			unhide : dw0.GetResetConfig() != 0,
+			configurator : func() { macro.Rstsrc() },
+		},
+
+		&field {
+			prefix : "PAD_TRIG",
+			unhide : dw0.GetRXLevelEdgeConfiguration() != 0,
+			configurator : func() { macro.Trig() },
+		},
+
+		&field {
+			prefix : "PAD_IRQ_ROUTE",
+			name   : "IOAPIC",
+			unhide : dw0.GetGPIOInputRouteIOxAPIC() != 0,
+		},
+
+		&field {
+			prefix : "PAD_IRQ_ROUTE",
+			name   : "SCI",
+			unhide : dw0.GetGPIOInputRouteSCI() != 0,
+		},
+
+		&field {
+			prefix : "PAD_IRQ_ROUTE",
+			name   : "SMI",
+			unhide : dw0.GetGPIOInputRouteSMI() != 0,
+		},
+
+		&field {
+			prefix : "PAD_IRQ_ROUTE",
+			name   : "NMI",
+			unhide : dw0.GetGPIOInputRouteNMI() != 0,
+		},
+
+		&field {
+			prefix : "PAD_RX_POL",
+			unhide : dw0.GetRxInvert() != 0,
+			configurator : func() { macro.Invert() },
+		},
+
+		&field {
+			prefix : "PAD_BUF",
+			unhide : dw0.GetGPIORxTxDisableStatus() != 0,
+			configurator : func() { macro.Bufdis() },
+		},
+
+		&field {
+			name   : "(1 << 29)",
+			unhide : dw0.GetRXPadStateSelect() != 0,
+		},
+
+		&field {
+			name   : "(1 << 28)",
+			unhide : dw0.GetRXRawOverrideStatus() != 0,
+		},
+
+		&field {
+			name   : "(1 << 1)",
+			unhide : dw0.GetGPIORXState() != 0,
+		},
+
+		&field {
+			name   : "1",
+			unhide : dw0.GetGPIOTXState() != 0,
+		},
+	)
+}
+
+// DecodeDW1 - decode value of DW1 register
+func (FieldMacros) DecodeDW1() {
+	macro := common.GetMacro()
+	dw1 := macro.Register(common.PAD_CFG_DW1)
+	generate(
+		&field {
+			name   : "PAD_CFG1_TOL_1V8",
+			unhide : dw1.GetPadTol() != 0,
+		},
+
+		&field {
+			prefix : "PAD_PULL",
+			unhide : dw1.GetTermination() != 0,
+			configurator : func() { macro.Pull() },
+		},
+
+		&field {
+			prefix : "PAD_IOSSTATE",
+			unhide : dw1.GetIOStandbyState() != 0,
+			configurator : func() { macro.IOSstate() },
+		},
+
+		&field {
+			prefix : "PAD_IOSTERM",
+			unhide : dw1.GetIOStandbyTermination() != 0,
+			configurator : func() { macro.IOTerm() },
+		},
+
+		&field {
+			prefix : "PAD_CFG_OWN_GPIO",
+			unhide : macro.IsOwnershipDriver(),
+			configurator : func() { macro.Own() },
+		},
+	)
+}
+
+// GenerateString - generates the entire string of bitfield macros.
+func (bitfields FieldMacros) GenerateString() {
+	macro := common.GetMacro()
+	macro.Add("_PAD_CFG_STRUCT(").Id().Add(", ")
+	bitfields.DecodeDW0()
+	macro.Add(", ")
+	bitfields.DecodeDW1()
+	macro.Add("),")
+}