Skip to content

Commit

Permalink
Merge pull request #701 from Dasharo/replace-coreboot_customizer
Browse files Browse the repository at this point in the history
replace coreboot_customizer to Dasharo Configuration Utility
  • Loading branch information
filipleple authored Nov 10, 2023
2 parents 2b32ea2 + 49f5f40 commit b60ff23
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 21 deletions.
16 changes: 8 additions & 8 deletions docs/guides/image-customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Sometimes it is necessary to customize the image by changing the logo
displayed on boot or to set a unique UUID or Serial Number for SMBIOS.
[coreboot_customizer](https://github.com/Dasharo/meta-dts/blob/3da0807f10b46f496e23fff97c61ed49861cb475/meta-dts-distro/recipes-dts/dts/dts/coreboot_customizer)
[Dasharo Configuration Utility](https://github.com/Dasharo/dcu)
is a simple script that help with these tasks.

## Prerequisites
Expand All @@ -29,7 +29,7 @@ fails, the script will exit with an error.
## Usage

```txt
Usage: coreboot_customizer OPTIONS coreboot.rom
Usage: dcu OPTIONS coreboot.rom
coreboot.rom - Dasharo coreboot file to modify
Expand All @@ -39,16 +39,16 @@ Usage: coreboot_customizer OPTIONS coreboot.rom
-l | --logo <LOGO> - Custom logo in BMP/PNG/JPG/SVG format to be displayed on boot
Examples:
./coreboot_customizer -u 96bcfa1a-42b4-6717-a44c-d8bbc18cbea4 -s D07229051 -l ~/logo.svg coreboot.rom
./dcu -u 96bcfa1a-42b4-6717-a44c-d8bbc18cbea4 -s D07229051 -l ~/logo.svg coreboot.rom
./coreboot_customizer -u `dmidecode -s system-uuid` -s `dmidecode -s baseboard-serial-number` coreboot.rom
./dcu -u `dmidecode -s system-uuid` -s `dmidecode -s baseboard-serial-number` coreboot.rom
Above command will obtain the current SMBIOS UUID and Serial Number
from the system and patch the coreboot binary.
```

`coreboot_customizer` can be used as a standalone script (paired with
cbfstool) and is also available in [Dasharo Tools
Suite](../dasharo-tools-suite/overview.md).
`dcu` can be used as a standalone script (paired with
cbfstool) and is also available in
[Dasharo Tools Suite](../dasharo-tools-suite/overview.md).

The script will save the UUID and Serial Number to the COREBOOT region and the
logo to BOOTSPLASH region.
Expand Down Expand Up @@ -93,7 +93,7 @@ TOOLLDFLAGS=-static make -C util/cbfstool
strip --strip-unneeded util/cbfstool/cbfstool
```

Copy the `util/cbfstool/cbfstool` to the directory where `coreboot_customizer`
Copy the `util/cbfstool/cbfstool` to the directory where `dcu`
is saved. Alternatively you make install `cbfstool` to your system:
`TOOLLDFLAGS=-static sudo make -C util/cbfstool install`.

Expand Down
6 changes: 3 additions & 3 deletions docs/guides/logo-customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ replacing the logo.

## Procedure

Use the [coreboot_customizer](image-customization.md) to put custom logo into
Dasahro coreboot image.
Use the [Dasharo Configuration Utility](image-customization.md)
to put custom logo into a Dasharo coreboot image.

```bash
./coreboot_customizer -l <logo_file> <dasharo_image>
./dcu -l <logo_file> <dasharo_image>
```
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

**Test description**

The coreboot_customizer tool is a part of the Dasharo Tools Suite.
The Dasharo Configuration Utility tool is a part of the Dasharo Tools Suite.
This test case verifies that the UUID encoded in the DMI table of an
image can be changed using our coreboot_customizer utility.
image can be changed using our utility.

**Test configuration data**

Expand All @@ -16,11 +16,11 @@ image can be changed using our coreboot_customizer utility.

1. Proceed with the
[Generic test setup: firmware](../generic-test-setup.md#firmware).
1. Download [coreboot_customizer](https://github.com/Dasharo/meta-dts/blob/main/meta-dts-distro/recipes-dts/dts/dts/coreboot_customizer)
1. Download [Dasharo Configuration Utility](https://github.com/Dasharo/dcu)

**Test steps**

1. Run `./coreboot_customizer -u 96bcfa1a-42b4-6717-a44c-d8bbc18cbea4
1. Run `./dcu -u 96bcfa1a-42b4-6717-a44c-d8bbc18cbea4
coreboot.rom`
1. Flash the `coreboot.rom` file onto the platform.
1. Power on the DUT.
Expand All @@ -37,7 +37,7 @@ as we had set it.
**Test description**

This test case verifies that the serial number encoded in the DMI table of an
image can be changed using our coreboot_customizer utility.
image can be changed using our utility.

**Test configuration data**

Expand All @@ -47,11 +47,11 @@ image can be changed using our coreboot_customizer utility.

1. Proceed with the
[Generic test setup: firmware](../generic-test-setup.md#firmware).
1. Download [coreboot_customizer](https://github.com/Dasharo/meta-dts/blob/main/meta-dts-distro/recipes-dts/dts/dts/coreboot_customizer)
1. Download [Dasharo Configuration Utility](https://github.com/Dasharo/dcu)

**Test steps**

1. Run `./coreboot_customizer -s D01234567 coreboot.rom`
1. Run `./dcu -s D01234567 coreboot.rom`
1. Flash the `coreboot.rom` file onto the platform.
1. Power on the DUT.
1. Examine the DMI tables with `dmidecode`.
Expand All @@ -66,7 +66,7 @@ The serial number of the platform should be `D01234567`, just as we had set it.
**Test description**

This test case verifies that the bootsplash logo of an image can be changed
using our coreboot_customizer utility.
using our utility.

**Test configuration data**

Expand All @@ -76,11 +76,11 @@ using our coreboot_customizer utility.

1. Proceed with the
[Generic test setup: firmware](../generic-test-setup.md#firmware).
1. Download [coreboot_customizer](https://github.com/Dasharo/meta-dts/blob/main/meta-dts-distro/recipes-dts/dts/dts/coreboot_customizer)
1. Download [Dasharo Configuration Utility](https://github.com/Dasharo/dcu)

**Test steps**

1. Run `./coreboot_customizer -l ./logo.svg`
1. Run `./dcu -l ./logo.svg`
1. Flash the `coreboot.rom` file onto the platform.
1. Power on the DUT.
1. Verify the bootsplash logo.
Expand Down

0 comments on commit b60ff23

Please sign in to comment.