coreboot-kgpe-d16/util/coreboot-configurator/src/README.md
Sean Rhodes 9c89e3ada2 util: Add coreboot-configurator
A simple GUI to change settings in coreboot's CBFS, via the nvramtool utility.

Test on the StarBook Mk IV running coreboot 4.15 with:
* Ubuntu 20.04
* Ubuntu 21.10
* MX Linux 21
* elementary OS 6
* Manjaro 21

Signed-off-by: Sean Rhodes <sean@starlabs.systems>
Change-Id: I491922bf55ed87c2339897099634a38f8d055876
Reviewed-on: https://review.coreboot.org/c/coreboot/+/59256
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Martin Roth <martinroth@google.com>
2022-01-27 16:16:23 +00:00

1 KiB

Categories alt text

CMOS values should be added to [categories.yaml](src/application/categories.yaml].

This allows coreboot-configurator to display them in a relavant tab, with a nice name and help text. Without this, they will still be visible in the Raw tab.

An example entry is below:

processor:
  displayName: Processor
  me_state:
    displayName: Intel Management Engine
    type: bool
    help: Enable or disable the Intel Management Engine

To explain the options:

**tabgroup**:				<- This is the reference to the tab group
  displayName: **Hello World**		<- This is the name of the group that the user
					   will see
  **setting_1**:			<- This is the value that should match the CMOS
					   option.
    displayName: **Hi World**		<- This is the name of the option that the user
					   will see.
    type: **bool**			<- Valid type are: bool (checkbox) and enum
					<- (dropdown).
    help: **Greet the World**		<- Help text that is displayed when hovering on the
					   option.