diff options
author | Nicholas Chin <nic.c3.14@gmail.com> | 2024-07-08 20:03:50 -0600 |
---|---|---|
committer | Elyes Haouas <ehaouas@noos.fr> | 2024-07-09 21:10:15 +0000 |
commit | 46630de4b7a653dbcfd1d10037c73993b258992c (patch) | |
tree | 7d7e36d121fdabc9761bfc0d3a48db9d2b23cc97 /Documentation/util/intelp2m | |
parent | 18c79fe67ba3e884cebc117b35979dc9c22fac06 (diff) |
Documentation: Fix header levels
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>
Diffstat (limited to 'Documentation/util/intelp2m')
-rw-r--r-- | Documentation/util/intelp2m/index.md | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/Documentation/util/intelp2m/index.md b/Documentation/util/intelp2m/index.md index 6873c1b1ea..98b9c009d6 100644 --- a/Documentation/util/intelp2m/index.md +++ b/Documentation/util/intelp2m/index.md @@ -11,7 +11,7 @@ make ./intelp2m -file /path/to/inteltool.log ``` -### Platforms +## Platforms It is possible to use templates for parsing inteltool.log files. To specify such a pattern, use the option `-t <template number>`. @@ -51,13 +51,13 @@ platform type is set using the -p option (Sunrise by default): ./intelp2m -p <platform> -file path/to/inteltool.log ``` -### Packages +## Packages ![][pckgs] [pckgs]: gopackages.png -### Bit fields in macros +## Bit fields in macros Use the `-fld=cb` option to only generate a sequence of bit fields in a new macro: @@ -71,7 +71,7 @@ _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 +## 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: @@ -96,7 +96,7 @@ _PAD_CFG_STRUCT(GPP_A10, 0x44000500, 0x00000000), _PAD_CFG_STRUCT(GPP_A10, 0x44000500, 0x00000000), ``` -### Macro Check +## Macro Check After generating the macro, the utility checks all used fields of the configuration registers. If some field has been @@ -115,7 +115,7 @@ 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 +## Information level The utility can generate additional information about the bit fields of the DW0 and DW1 configuration registers. Using the @@ -158,7 +158,7 @@ PAD_CFG_NF_IOSSTATE_IOSTERM(GPIO_39, UP_20K, DEEP, NF1, TxLASTRxE, \ DISPUPD), ``` -### Ignoring Fields +## Ignoring Fields Utilities can generate the _PAD_CFG_STRUCT macro and exclude fields from it that are not in the corresponding PAD_CFG_*() macro: @@ -177,7 +177,7 @@ _PAD_CFG_STRUCT(GPIO_39, PAD_FUNC(NF1) | PAD_RESET(DEEP), \ PAD_PULL(UP_20K) | PAD_IOSTERM(DISPUPD)), ``` -### FSP-style macro +## FSP-style macro The utility allows one to generate macros that include fsp/edk2-platform style bitfields: @@ -205,6 +205,6 @@ style bitfields: GpioPadConfigLock }, ``` -### Supported Chipsets +## Supported Chipsets Sunrise PCH, Lewisburg PCH, Apollo Lake SoC, CannonLake-LP SoCs |