46630de4b7
This fixes the following MyST Parser warnings: - Non-consecutive header level increase - Document headings start at H2, not H1 The header levels (the number of "#" characters before a heading) are intended to form a logical hierarchy of each section and subsection in a document. A subsection typically should have a header level one more than its parent section. Most of these warnings are caused by extra "#" characters, which were simply removed, or sections missing a "#" character to make it fall under its parent section. Notable changes: getting_started/kconfig.md: Changed the header level of the "Keywords" section from 2 to 3 to fall under "Kconfig Language" (level 2), and increased the level of each keyword from 3 to 4 to remain under "Keywords". This also fixes the warnings of "H3 to H5" increases, since the Usage/Example/Notes/Restrictions sections for each keyword had a level of 5. soc/intel/cse_fw_update/cse_fw_update.md: Changed the first line to a top level header acting as the title of the document. Without this soc/intel/index.md displays all the level 2 headers in this document instead of a single link to cse_fw_update.md. Change-Id: Ia1f8b52e39b7b6524bef89a95365541235b5b1b9 Signed-off-by: Nicholas Chin <nic.c3.14@gmail.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/83382 Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de> Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Elyes Haouas <ehaouas@noos.fr>
211 lines
5.3 KiB
Markdown
211 lines
5.3 KiB
Markdown
Intel Pad to Macro (intelp2m) converter
|
|
=======================================
|
|
|
|
This utility allows one to convert the configuration DW0/1 register
|
|
values from an inteltool dump to coreboot macros.
|
|
|
|
```bash
|
|
cd util/intelp2m
|
|
make
|
|
./intelp2m -h
|
|
./intelp2m -file /path/to/inteltool.log
|
|
```
|
|
|
|
## Platforms
|
|
|
|
It is possible to use templates for parsing inteltool.log files.
|
|
To specify such a pattern, use the option `-t <template number>`.
|
|
|
|
```text
|
|
-t
|
|
template type number
|
|
0 - inteltool.log (default)
|
|
1 - gpio.h
|
|
2 - your template
|
|
```
|
|
|
|
For example, using template type 1, you can parse gpio.h from an
|
|
existing board in the coreboot project.
|
|
|
|
```bash
|
|
./intelp2m -t 1 -file coreboot/src/mainboard/yourboard/gpio.h
|
|
```
|
|
|
|
You can also add a template to 'parser/template.go' for your file type
|
|
with the configuration of the pads.
|
|
|
|
platform type is set using the -p option (Sunrise by default):
|
|
|
|
```text
|
|
-p string
|
|
set up a platform
|
|
snr - Sunrise PCH with Skylake/Kaby Lake CPU
|
|
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")
|
|
```
|
|
|
|
```bash
|
|
./intelp2m -p <platform> -file path/to/inteltool.log
|
|
```
|
|
|
|
## Packages
|
|
|
|
![][pckgs]
|
|
|
|
[pckgs]: gopackages.png
|
|
|
|
## Bit fields in macros
|
|
|
|
Use the `-fld=cb` option to only generate a sequence of bit fields in
|
|
a new macro:
|
|
|
|
```bash
|
|
./intelp2m -fld cb -p apl -file ../apollo-inteltool.log
|
|
```
|
|
|
|
```c
|
|
_PAD_CFG_STRUCT(GPIO_37, PAD_FUNC(NF1) | PAD_TRIG(OFF) | PAD_TRIG(OFF), \
|
|
PAD_PULL(DN_20K)), /* LPSS_UART0_TXD */
|
|
```
|
|
|
|
## Raw DW0, DW1 register value
|
|
|
|
To generate the gpio.c with raw PAD_CFG_DW0 and PAD_CFG_DW1 register
|
|
values you need to use the -fld=raw option:
|
|
|
|
```bash
|
|
./intelp2m -fld raw -file /path/to/inteltool.log
|
|
```
|
|
|
|
```c
|
|
_PAD_CFG_STRUCT(GPP_A10, 0x44000500, 0x00000000),
|
|
```
|
|
|
|
```bash
|
|
./intelp2m -iiii -fld raw -file /path/to/inteltool.log
|
|
```
|
|
|
|
```c
|
|
/* GPP_A10 - CLKOUT_LPC1 */
|
|
/* DW0: 0x44000500, DW1: 0x00000000 */
|
|
/* DW0: 0x04000100 - IGNORED */
|
|
/* PAD_CFG_NF(GPP_A10, NONE, DEEP, NF1), */
|
|
_PAD_CFG_STRUCT(GPP_A10, 0x44000500, 0x00000000),
|
|
```
|
|
|
|
## Macro Check
|
|
|
|
After generating the macro, the utility checks all used
|
|
fields of the configuration registers. If some field has been
|
|
ignored, the utility generates field macros. To not check
|
|
macros, use the -n option:
|
|
|
|
```bash
|
|
./intelp2m -n -file /path/to/inteltool.log
|
|
```
|
|
|
|
In this case, some fields of the configuration registers
|
|
DW0 will be ignored.
|
|
|
|
```c
|
|
PAD_CFG_NF_IOSSTATE_IOSTERM(GPIO_38, UP_20K, DEEP, NF1, HIZCRx1, DISPUPD),
|
|
PAD_CFG_NF_IOSSTATE_IOSTERM(GPIO_39, UP_20K, DEEP, NF1, TxLASTRxE, DISPUPD),
|
|
```
|
|
|
|
## Information level
|
|
|
|
The utility can generate additional information about the bit
|
|
fields of the DW0 and DW1 configuration registers. Using the
|
|
options -i, -ii, -iii, -iiii you can set the info level from
|
|
1 to 4:
|
|
|
|
```bash
|
|
./intelp2m -i -file /path/to/inteltool.log
|
|
```
|
|
|
|
```c
|
|
_PAD_CFG_STRUCT(GPIO_39, PAD_FUNC(NF1) | PAD_RESET(DEEP) | PAD_TRIG(OFF),\
|
|
PAD_PULL(UP_20K) | PAD_IOSTERM(DISPUPD)), /* LPSS_UART0_TXD */
|
|
```
|
|
|
|
```bash
|
|
./intelp2m -ii -file /path/to/inteltool.log
|
|
./intelp2m -iii -file /path/to/inteltool.log
|
|
./intelp2m -iiii -file /path/to/inteltool.log
|
|
```
|
|
|
|
```c
|
|
/* GPIO_39 - LPSS_UART0_TXD */
|
|
/* DW0: 0x44000400, DW1: 0x00003100 */ --> (ii)
|
|
/* DW0 : PAD_TRIG(OFF) - IGNORED */ --> (iii)
|
|
/* PAD_CFG_NF_IOSSTATE_IOSTERM(GPIO_39, UP_20K, DEEP, NF1, TxLASTRxE,
|
|
DISPUPD), */ --> (iiii)
|
|
_PAD_CFG_STRUCT(GPIO_39, PAD_FUNC(NF1) | PAD_RESET(DEEP) | PAD_TRIG(OFF),
|
|
PAD_PULL(UP_20K) | PAD_IOSTERM(DISPUPD)),
|
|
```
|
|
|
|
If the -n switch was used and macros was generated without checking:
|
|
```c
|
|
/* GPIO_39 - LPSS_UART0_TXD */ --> (i)
|
|
/* DW0: 0x44000400, DW1: 0x00003100 */ --> (ii)
|
|
/* DW0: PAD_TRIG(OFF) - IGNORED */ --> (iii)
|
|
/* _PAD_CFG_STRUCT(GPIO_39, PAD_FUNC(NF1) | PAD_RESET(DEEP) |
|
|
PAD_TRIG(OFF), PAD_PULL(UP_20K) | PAD_IOSTERM(DISPUPD)), */ --> (iiii)
|
|
PAD_CFG_NF_IOSSTATE_IOSTERM(GPIO_39, UP_20K, DEEP, NF1, TxLASTRxE, \
|
|
DISPUPD),
|
|
```
|
|
|
|
## Ignoring Fields
|
|
|
|
Utilities can generate the _PAD_CFG_STRUCT macro and exclude fields
|
|
from it that are not in the corresponding PAD_CFG_*() macro:
|
|
|
|
```bash
|
|
./intelp2m -iiii -fld cb -ign -file /path/to/inteltool.log
|
|
```
|
|
|
|
```c
|
|
/* GPIO_39 - LPSS_UART0_TXD */
|
|
/* DW0: 0x44000400, DW1: 0x00003100 */
|
|
/* DW0: PAD_TRIG(OFF) - IGNORED */
|
|
/* PAD_CFG_NF_IOSSTATE_IOSTERM(GPIO_39, UP_20K, DEEP, NF1,
|
|
TxLASTRxE, DISPUPD), */
|
|
_PAD_CFG_STRUCT(GPIO_39, PAD_FUNC(NF1) | PAD_RESET(DEEP), \
|
|
PAD_PULL(UP_20K) | PAD_IOSTERM(DISPUPD)),
|
|
```
|
|
|
|
## FSP-style macro
|
|
|
|
The utility allows one to generate macros that include fsp/edk2-platform
|
|
style bitfields:
|
|
|
|
```bash
|
|
./intelp2m -i -fld fsp -p lbg -file ../crb-inteltool.log
|
|
```
|
|
|
|
```c
|
|
{ GPIO_SKL_H_GPP_A12, { GpioPadModeGpio, GpioHostOwnAcpi, GpioDirInInvOut,
|
|
GpioOutLow, GpioIntSci | GpioIntLvlEdgDis, GpioResetNormal, GpioTermNone,
|
|
GpioPadConfigLock }, /* GPIO */
|
|
```
|
|
|
|
```bash
|
|
./intelp2m -iiii -fld fsp -p lbg -file ../crb-inteltool.log
|
|
```
|
|
|
|
```c
|
|
/* GPP_A12 - GPIO */
|
|
/* DW0: 0x80880102, DW1: 0x00000000 */
|
|
/* PAD_CFG_GPI_SCI(GPP_A12, NONE, PLTRST, LEVEL, INVERT), */
|
|
{ GPIO_SKL_H_GPP_A12, { GpioPadModeGpio, GpioHostOwnAcpi, GpioDirInInvOut,
|
|
GpioOutLow, GpioIntSci | GpioIntLvlEdgDis, GpioResetNormal, GpioTermNone,
|
|
GpioPadConfigLock },
|
|
```
|
|
|
|
## Supported Chipsets
|
|
|
|
Sunrise PCH, Lewisburg PCH, Apollo Lake SoC, CannonLake-LP SoCs
|