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>
This commit is contained in:
Maxim Polyakov
2020-04-26 22:12:01 +03:00
committed by Felix Held
parent 8079c5c1c2
commit 82ec61e9d7
19 changed files with 2728 additions and 0 deletions

View File

@@ -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("),")
}

View File

@@ -0,0 +1,20 @@
package fields
import "../config"
import "../platforms/common"
import "./fsp"
import "./cb"
import "./raw"
// InterfaceSet - set the interface for decoding configuration
// registers DW0 and DW1.
func InterfaceGet() common.Fields {
var fldstylemap = map[uint8]common.Fields{
config.NoFlds : cb.FieldMacros{}, // analyze fields using cb macros
config.CbFlds : cb.FieldMacros{},
config.FspFlds : fsp.FieldMacros{},
config.RawFlds : raw.FieldMacros{},
}
return fldstylemap[config.FldStyleGet()]
}

View File

@@ -0,0 +1,171 @@
package fsp
import "../../platforms/common"
type FieldMacros struct {}
// field - data structure for creating a new bitfield macro object
// configmap : map to select the current configuration
// value : the key value in the configmap
// override : overrides the function to generate the current bitfield macro
type field struct {
configmap map[uint8]string
value uint8
override func(configuration map[uint8]string, value uint8)
}
// generate - wrapper for generating bitfield macros string
// fileds : field structure
func generate(fileds ...*field) {
macro := common.GetMacro()
for _, field := range fileds {
if field.override != nil {
// override if necessary
field.override(field.configmap, field.value)
continue
}
fieldmacro, valid := field.configmap[field.value]
if valid {
macro.Add(fieldmacro).Add(", ")
} else {
macro.Add("INVALID, ")
}
}
}
// DecodeDW0 - decode value of DW0 register
func (FieldMacros) DecodeDW0() {
macro := common.GetMacro()
dw0 := macro.Register(common.PAD_CFG_DW0)
ownershipStatus := func() uint8 {
if macro.IsOwnershipDriver() { return 1 }
return 0
}
generate(
&field {
configmap : map[uint8]string{
0: "GpioPadModeGpio",
1: "GpioPadModeNative1",
2: "GpioPadModeNative2",
3: "GpioPadModeNative3",
4: "GpioPadModeNative4",
5: "GpioPadModeNative5",
},
value : dw0.GetPadMode(),
},
&field {
configmap : map[uint8]string {
0: "GpioHostOwnAcpi",
1: "GpioHostOwnGpio",
},
value : ownershipStatus(),
},
&field {
configmap : map[uint8]string {
0: "GpioDirInOut",
1: "GpioDirIn",
2: "GpioDirOut",
3: "GpioDirNone",
1 << 4 | 0: "GpioDirInInvOut",
1 << 4 | 1: "GpioDirInInv",
},
value : dw0.GetRxInvert() << 4 | dw0.GetRXLevelEdgeConfiguration(),
},
&field {
configmap : map[uint8]string {
0: "GpioOutLow",
1: "GpioOutHigh",
},
value : dw0.GetGPIOTXState(),
},
&field {
configmap : map[uint8]string {
1 << 0: "GpioIntNmi",
1 << 1: "GpioIntSmi",
1 << 2: "GpioIntSci",
1 << 3: "GpioIntApic",
},
override : func(configmap map[uint8]string, value uint8) {
mask := dw0.GetGPIOInputRouteIOxAPIC() << 3 |
dw0.GetGPIOInputRouteSCI() << 2 |
dw0.GetGPIOInputRouteSMI() << 1 |
dw0.GetGPIOInputRouteNMI()
if mask == 0 {
macro.Add("GpioIntDis | ")
return
}
for bit, fieldmacro := range configmap {
if mask & bit != 0 {
macro.Add(fieldmacro).Add(" | ")
}
}
},
},
&field {
configmap : map[uint8]string {
0: "GpioIntLevel",
1: "GpioIntEdge",
2: "GpioIntLvlEdgDis",
3: "GpioIntBothEdge",
},
value : dw0.GetResetConfig(),
},
&field {
configmap : map[uint8]string {
0: "GpioResetPwrGood",
1: "GpioResetDeep",
2: "GpioResetNormal",
3: "GpioResetResume",
},
value : dw0.GetResetConfig(),
},
)
}
// DecodeDW1 - decode value of DW1 register
func (FieldMacros) DecodeDW1() {
macro := common.GetMacro()
dw1 := macro.Register(common.PAD_CFG_DW1)
generate(
&field {
override : func(configmap map[uint8]string, value uint8) {
if dw1.GetPadTol() != 0 {
macro.Add("GpioTolerance1v8 | ")
}
},
},
&field {
configmap : map[uint8]string {
0x0: "GpioTermNone",
0x2: "GpioTermWpd5K",
0x4: "GpioTermWpd20K",
0x9: "GpioTermWpu1K",
0xa: "GpioTermWpu5K",
0xb: "GpioTermWpu2K",
0xc: "GpioTermWpu20K",
0xd: "GpioTermWpu1K2K",
0xf: "GpioTermNative",
},
value : dw1.GetTermination(),
},
)
}
// GenerateString - generates the entire string of bitfield macros.
func (bitfields FieldMacros) GenerateString() {
macro := common.GetMacro()
macro.Add("{ GPIO_SKL_H_").Id().Add(", { ")
bitfields.DecodeDW0()
bitfields.DecodeDW1()
macro.Add(" GpioPadConfigLock } },") // TODO: configure GpioPadConfigLock
}

View File

@@ -0,0 +1,28 @@
package raw
import "fmt"
import "../../platforms/common"
type FieldMacros struct {}
func (FieldMacros) DecodeDW0() {
macro := common.GetMacro()
// Do not decode, print as is.
macro.Add(fmt.Sprintf("0x%0.8x", macro.Register(common.PAD_CFG_DW0).ValueGet()))
}
func (FieldMacros) DecodeDW1() {
macro := common.GetMacro()
// Do not decode, print as is.
macro.Add(fmt.Sprintf("0x%0.8x", macro.Register(common.PAD_CFG_DW1).ValueGet()))
}
// 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("),")
}