diff --git a/docs/unified/hardkernel/overview.md b/docs/unified/hardkernel/overview.md deleted file mode 100644 index 3cd6fcad8e..0000000000 --- a/docs/unified/hardkernel/overview.md +++ /dev/null @@ -1,6 +0,0 @@ -# Overview - -=== "Hardkernel ODROID H4+" - - [Releases](../../variants/hardkernel_odroid_h4_plus/releases.md) - - [Hardware Configuration Matrix](../../variants/hardkernel_odroid_h4_plus/hardware-matrix.md) - - [Test Matrix](./test-matrix.md#hardkernel-odroid-h4-plus) diff --git a/docs/unified/hardkernel/recovery.md b/docs/unified/hardkernel/recovery.md deleted file mode 100644 index 3d64f87143..0000000000 --- a/docs/unified/hardkernel/recovery.md +++ /dev/null @@ -1,69 +0,0 @@ -# Recovery - -## Intro - -The following documentation describes the process of recovering hardware from -the brick state using an [RTE](../../transparent-validation/rte/introduction.md) -and Dasharo open-source firmware. - -=== "V1000-series" - - ## Prerequisites - - * [Prepared RTE](../../transparent-validation/rte/v1.1.0/quick-start-guide.md) - * 6x female-female wire cables - - ## Connections - - To prepare the stand for flashing follow the steps described in - the [Generic test stand setup](../../unified-test-documentation/generic-testing-stand-setup.md#detailed-description-of-the-process) - - ## Firmware flashing - - To flash firmware follow the steps described below: - - 1. Login to RTE via `ssh` or `minicom`. - 2. Turn on the platform by connecting the power supply. - 3. Wait at least 5 seconds. - 4. Turn off the platform by using the power button. - 5. Wait at least 3 seconds. - 6. Set the proper state of the SPI by using the following commands on RTE: - - ```bash - # set SPI Vcc to 3.3V - echo 1 > /sys/class/gpio/gpio405/value - # SPI Vcc on - echo 1 > /sys/class/gpio/gpio406/value - # SPI lines ON - echo 1 > /sys/class/gpio/gpio404/value - ``` - - 7. Wait at least 2 seconds. - 8. Disconnect the power supply from the platform. - 9. Wait at least 2 seconds. - 10. Check if the flash chip is connected properly - - ```bash - flashrom -p linux_spi:dev=/dev/spidev1.0,spispeed=16000 - ``` - - 11. Flash the platform by using the following command: - - ```bash - flashrom -p linux_spi:dev=/dev/spidev1.0,spispeed=16000 -w [path_to_binary] - ``` - - > Flashing with flashrom takes about 1 minute. - - 12. Change back the state of the SPI by using the following commands: - - ```bash - echo 0 > /sys/class/gpio/gpio404/value - echo 0 > /sys/class/gpio/gpio405/value - echo 0 > /sys/class/gpio/gpio406/value - ``` - - 12. Turn on the platform by connecting the power supply. - - The first boot of the platform after proceeding with the above procedure can - take much longer than normal. diff --git a/docs/unified/hardkernel/test-matrix.md b/docs/unified/hardkernel/test-matrix.md deleted file mode 100644 index 58cbd0460c..0000000000 --- a/docs/unified/hardkernel/test-matrix.md +++ /dev/null @@ -1,145 +0,0 @@ -# Test matrix - -## About - -The test matrix is used to determine the scope of tests which the DUT is -subjected from before the release of the new binary compatible with -Hardkernel devices. - -=== "Hardkernel ODROID H4+" - ## Module: Dasharo compatibility - - | No. | Supported test suite | Test suite ID | Supported test cases | - |:---:|:--------------------------------------|:-------------:|:-------------------------------------| - | 1. | [Custom boot order][CBO] | CBO | CBO001.002 | - | 2. | [Custom Boot Keys][CBK] | CBK | All | - | 3. | [Custom logo][CLG] | CLG | All | - | 4. | [USB HID and MSC Support][USB] | USB | USB001.0001, USB001.002, USB002.001, USB002.002| - | 5. | [Custom network boot entries][CNB] | CNB | CNB001.002 | - | 6. | [UEFI compatible interface][EFI] | EFI | EFI001.001 | - | 7. | [UEFI Shell][USH] | USH | All | - | 8. | [NVMe support][NVM] | NVM | NVM001.001, NVM001.002 | - | 9. | [Network boot][PXE] | PXE | All | - | 10. | [Display ports][DSP] | DSP | DSP002.001, DSP003.001 | - | 11. | [Audio subsystem][AUD] | AUD | AUD007.001, AUD008.001 | - | 12. | [Sleep mode][SUSP] | SUSP | SUSP001.001, SUSP002.001, SUSP003.001, SUSP005.001| - | 13. | [SMBIOS verification][DMI] | DMI | All | - | 14. | [eMMC support][MMC] | MMC | All | - | 15. | [SATA support][SATA] | | All | - | 16. | [Sign of life][SOL] | SOL | All | - | 17. | [Persistent Boot Splash][LCM] | LCM | All | - | 18. | [Debian Stable and Ubuntu LTS support][LBT] | LBT | LBT003.001, LBT003.002, LBT004.001, LBT004.002| - | 19. | [Power state after power fail][PSF] | PSF | All | - | 20. | [Dasharo Tools Suite][DTS] | DTS | DTS001.001, DTS002.001, DTS003.001, DTS004.001, DTS005.001, DTS006.001 | - | 21. | [Reset to defaults][RTD] | RTD | RTD001.001, RTD002.001, RTD003.001, RTD004.001, RTD006.001 | - | 22. | [Ethernet interface][NET] | NET | All | - | 23. | [Dasharo Configuration Utility][NET] | DCU | DCU001.001, DCU002.001, DCU003.001 | - | 24. | [ESP scanning][ESP] | ESP | All | - | 25. | [Network Boot Utilities][NBT] | NBT | All | - | 26. | [USB detection][UDT] | UDT | All | - | 27. | [USB booting][UBT] | UBT | All | - | 28. | [Setup Menu information][SET] | SET | All | - | 29. | [Ubuntu booting performance test][BUB]| BUB | All | - | 30. | [CPU status][CPU] | CPU | CPU001.001, CPU002.001, CPU003.001, CPU004.001| - | 31. | [Auto boot time-out][BMM] | BMM | All | - - [CBO]: . - [CBK]: ../../unified-test-documentation/dasharo-compatibility/303-custom-boot-menu-key.md - [CLG]: ../../unified-test-documentation/dasharo-compatibility/304-custom-logo.md - [USB]: ../../unified-test-documentation/dasharo-compatibility/306-usb-hid-and-msc-support.md - [CNB]: ../../unified-test-documentation/dasharo-compatibility/30A-custom-network-boot-entries.md - [EFI]: ../../unified-test-documentation/dasharo-compatibility/30M-uefi-compatible-interface.md - [USH]: ../../unified-test-documentation/dasharo-compatibility/30P-uefi-shell.md - [NVM]: . - [PXE]: ../../unified-test-documentation/dasharo-compatibility/315-network-boot.md - [DSP]: ../../unified-test-documentation/dasharo-compatibility/31E-display-ports-and-lcd.md - [AUD]: ../../unified-test-documentation/dasharo-compatibility/31F-audio-subsystem.md - [SUSP]: . - [DMI]: ../../unified-test-documentation/dasharo-compatibility/31L-smbios.md - [MMC]: . - [SATA]: . - [SOL]: . - [LCM]: . - [LBT]: ../../unified-test-documentation/dasharo-compatibility/308-debian-stable-and-ubuntu-lts-support.md - [PSF]: . - [DTS]: ../../unified-test-documentation/dasharo-compatibility/326-dasharo-tools-suite.md - [RTD]: . - [NET]: . - [DCU]: . - [ESP]: . - [NBT]: ../../unified-test-documentation/dasharo-compatibility/315b-netboot-utilities.md - [UDT]: ../../unified-test-documentation/dasharo-compatibility/31O-usb-detect.md - [UBT]: ../../unified-test-documentation/dasharo-compatibility/31N-usb-boot.md - [SET]: . - [BUB]: . - [CPU]: ../../unified-test-documentation/dasharo-compatibility/31T-cpu-status.md - [BMM]: . - - - - - - diff --git a/docs/unified/hardkernel/building-manual.md b/docs/variants/hardkernel_odroid_h4/building-manual.md similarity index 73% rename from docs/unified/hardkernel/building-manual.md rename to docs/variants/hardkernel_odroid_h4/building-manual.md index 66d09aca81..8bfcf72ff5 100644 --- a/docs/unified/hardkernel/building-manual.md +++ b/docs/variants/hardkernel_odroid_h4/building-manual.md @@ -20,16 +20,20 @@ To build Dasharo firmware image, first clone the coreboot repository: ``` then follow the steps below: -=== "Odroid H4+" +=== "Odroid H4" + + 1. To build a specific version checkout to the version's tag. + Skip this step otherwise. - 1. Checkout to the device's branch: ```bash cd coreboot - git checkout hardkernel_odroid_h4/release + git checkout hardkernel_odroid_h4_ ``` + For example - To build a specific version replace `hardkernel_odroid_h4/release` with - `hardkernel_odroid_h4_v0.9.x` where `x` is the version number. + ```bash + git checkout hardkernel_odroid_h4_v0.9.0-rc2 + ``` 2. Checkout submodules: @@ -43,4 +47,4 @@ then follow the steps below: ``` The resulting coreboot image will be placed in the coreboot directory as - `hardkernel_odroid_h4.rom`. + `hardkernel_odroid_h4_.rom`. diff --git a/docs/unified/hardkernel/firmware-update.md b/docs/variants/hardkernel_odroid_h4/firmware-update.md similarity index 91% rename from docs/unified/hardkernel/firmware-update.md rename to docs/variants/hardkernel_odroid_h4/firmware-update.md index 56094c7afb..fc7bec87b5 100644 --- a/docs/unified/hardkernel/firmware-update.md +++ b/docs/variants/hardkernel_odroid_h4/firmware-update.md @@ -34,10 +34,8 @@ medium lock and Secure Boot: The settings of all the above options can be restored after a firmware update. -=== "ODROID H4+" +## Updating Dasharo - ## Updating Dasharo - - ```bash - flashrom -p internal -w hardkernel_odroid_h4_v.rom --fmap -i bios - ``` +```bash +flashrom -p internal -w hardkernel_odroid_h4_v.rom --fmap -i bios +``` diff --git a/docs/variants/hardkernel_odroid_h4_plus/hardware-matrix.md b/docs/variants/hardkernel_odroid_h4/hardware-matrix.md similarity index 95% rename from docs/variants/hardkernel_odroid_h4_plus/hardware-matrix.md rename to docs/variants/hardkernel_odroid_h4/hardware-matrix.md index f593035b10..44cdf35a5d 100644 --- a/docs/variants/hardkernel_odroid_h4_plus/hardware-matrix.md +++ b/docs/variants/hardkernel_odroid_h4/hardware-matrix.md @@ -3,9 +3,9 @@ ## Introduction This document describes the hardware configuration used for validation of -Dasharo on the Hardkernel ODROID H4+. +Dasharo on the Hardkernel ODROID H4. -## MinnowBoard Turbot Quad Core +## Hardkernel ODROID H4+ | Component | Description | |--------------------------------|---------------------------------------------| diff --git a/docs/unified/hardkernel/initial-deployment.md b/docs/variants/hardkernel_odroid_h4/initial-deployment.md similarity index 73% rename from docs/unified/hardkernel/initial-deployment.md rename to docs/variants/hardkernel_odroid_h4/initial-deployment.md index ac5917586d..e9e57eeb1f 100644 --- a/docs/unified/hardkernel/initial-deployment.md +++ b/docs/variants/hardkernel_odroid_h4/initial-deployment.md @@ -24,13 +24,11 @@ your own backup should be the last resort. ## Flashing Dasharo -=== "ODROID H4+" +To flash Dasharo on the platform, execute the following command - replace `[path]` +with the path to the Dasharo image you want to flash, e.g. `hardkernel_odroid_h4_v0.9.0.rom`. - To flash Dasharo on the platform, execute the following command - replace `[path]` - with the path to the Dasharo image you want to flash, e.g. `hardkernel_odroid_h4_v0.9.0.rom`. - - ```bash - sudo flashrom -p internal -w [path] --ifd -i bios - ``` +```bash +sudo flashrom -p internal -w [path] --ifd -i bios +``` - After successful operation reboot the platform. +After successful operation reboot the platform. diff --git a/docs/variants/hardkernel_odroid_h4/overview.md b/docs/variants/hardkernel_odroid_h4/overview.md new file mode 100644 index 0000000000..34d4efed1e --- /dev/null +++ b/docs/variants/hardkernel_odroid_h4/overview.md @@ -0,0 +1,6 @@ +# Overview + +=== "Hardkernel ODROID H4" + - [Releases](../../variants/hardkernel_odroid_h4/releases.md) + - [Hardware Configuration Matrix](../../variants/hardkernel_odroid_h4/hardware-matrix.md) + - [Test Matrix](./test-matrix.md#hardkernel-odroid-h4) diff --git a/docs/variants/hardkernel_odroid_h4/recovery.md b/docs/variants/hardkernel_odroid_h4/recovery.md new file mode 100644 index 0000000000..e277fec33b --- /dev/null +++ b/docs/variants/hardkernel_odroid_h4/recovery.md @@ -0,0 +1,67 @@ +# Recovery + +## Intro + +The following documentation describes the process of recovering hardware from +the brick state using an [RTE](../../transparent-validation/rte/introduction.md) +and Dasharo open-source firmware. + +## Prerequisites + +* [Prepared RTE](../../transparent-validation/rte/v1.1.0/quick-start-guide.md) +* 6x female-female wire cables + +## Connections + +To prepare the stand for flashing follow the steps described in +the [Generic test stand setup](../../unified-test-documentation/generic-testing-stand-setup.md#detailed-description-of-the-process) + +## Firmware flashing + +To flash firmware follow the steps described below: + +1. Login to RTE via `ssh` or `minicom`. +2. Turn on the platform by connecting the power supply. +3. Wait at least 5 seconds. +4. Turn off the platform by using the power button. +5. Wait at least 3 seconds. +6. Set the proper state of the SPI by using the following commands on RTE: + + ```bash + # set SPI Vcc to 3.3V + echo 1 > /sys/class/gpio/gpio405/value + # SPI Vcc on + echo 1 > /sys/class/gpio/gpio406/value + # SPI lines ON + echo 1 > /sys/class/gpio/gpio404/value + ``` + +7. Wait at least 2 seconds. +8. Disconnect the power supply from the platform. +9. Wait at least 2 seconds. +10. Check if the flash chip is connected properly + + ```bash + flashrom -p linux_spi:dev=/dev/spidev1.0,spispeed=16000 + ``` + +11. Flash the platform by using the following command: + + ```bash + flashrom -p linux_spi:dev=/dev/spidev1.0,spispeed=16000 -w [path_to_binary] + ``` + + > Flashing with flashrom takes about 1 minute. + +12. Change back the state of the SPI by using the following commands: + + ```bash + echo 0 > /sys/class/gpio/gpio404/value + echo 0 > /sys/class/gpio/gpio405/value + echo 0 > /sys/class/gpio/gpio406/value + ``` + +13. Turn on the platform by connecting the power supply. + +The first boot of the platform after proceeding with the above procedure can +take much longer than normal. diff --git a/docs/variants/hardkernel_odroid_h4_plus/releases.md b/docs/variants/hardkernel_odroid_h4/releases.md similarity index 81% rename from docs/variants/hardkernel_odroid_h4_plus/releases.md rename to docs/variants/hardkernel_odroid_h4/releases.md index 20f85f2938..99e1424d0e 100644 --- a/docs/variants/hardkernel_odroid_h4_plus/releases.md +++ b/docs/variants/hardkernel_odroid_h4/releases.md @@ -1,14 +1,14 @@ # Dasharo compatible with Hardkernel ODROID H4+ Following Release Notes describe status of Open Source Firmware development for -Hardkernel ODROID H4+ +Hardkernel ODROID H4 For details about our release process please read [Dasharo Standard Release Process](../../dev-proc/standard-release-process.md).
-[Subscribe to Hardkernel ODROID H4+ Dasharo Release Newsletter] +[Subscribe to Hardkernel ODROID H4 Dasharo Release Newsletter] [newsletter]{ .md-button .md-button--primary .center }
diff --git a/docs/variants/hardkernel_odroid_h4/test-matrix.md b/docs/variants/hardkernel_odroid_h4/test-matrix.md new file mode 100644 index 0000000000..831d8db0b1 --- /dev/null +++ b/docs/variants/hardkernel_odroid_h4/test-matrix.md @@ -0,0 +1,144 @@ +# Test matrix + +## About + +The test matrix is used to determine the scope of tests which the DUT is +subjected from before the release of the new binary compatible with +Hardkernel devices. + +## Module: Dasharo compatibility + +| No. | Supported test suite | Test suite ID | Supported test cases | +|:---:|:--------------------------------------|:-------------:|:-------------------------------------| +| 1. | [Custom boot order][CBO] | CBO | CBO001.002 | +| 2. | [Custom Boot Keys][CBK] | CBK | All | +| 3. | [Custom logo][CLG] | CLG | All | +| 4. | [USB HID and MSC Support][USB] | USB | USB001.0001, USB001.002, USB002.001, USB002.002| +| 5. | [Custom network boot entries][CNB] | CNB | CNB001.002 | +| 6. | [UEFI compatible interface][EFI] | EFI | EFI001.001 | +| 7. | [UEFI Shell][USH] | USH | All | +| 8. | [NVMe support][NVM] | NVM | NVM001.001, NVM001.002 | +| 9. | [Network boot][PXE] | PXE | All | +| 10. | [Display ports][DSP] | DSP | DSP002.001, DSP003.001 | +| 11. | [Audio subsystem][AUD] | AUD | AUD007.001, AUD008.001 | +| 12. | [Sleep mode][SUSP] | SUSP | SUSP001.001, SUSP002.001, SUSP003.001, SUSP005.001| +| 13. | [SMBIOS verification][DMI] | DMI | All | +| 14. | [eMMC support][MMC] | MMC | All | +| 15. | [SATA support][SATA] | | All | +| 16. | [Sign of life][SOL] | SOL | All | +| 17. | [Persistent Boot Splash][LCM] | LCM | All | +| 18. | [Debian Stable and Ubuntu LTS support][LBT] | LBT | LBT003.001, LBT003.002, LBT004.001, LBT004.002| +| 19. | [Power state after power fail][PSF] | PSF | All | +| 20. | [Dasharo Tools Suite][DTS] | DTS | DTS001.001, DTS002.001, DTS003.001, DTS004.001, DTS005.001, DTS006.001 | +| 21. | [Reset to defaults][RTD] | RTD | RTD001.001, RTD002.001, RTD003.001, RTD004.001, RTD006.001 | +| 22. | [Ethernet interface][NET] | NET | All | +| 23. | [Dasharo Configuration Utility][NET] | DCU | DCU001.001, DCU002.001, DCU003.001 | +| 24. | [ESP scanning][ESP] | ESP | All | +| 25. | [Network Boot Utilities][NBT] | NBT | All | +| 26. | [USB detection][UDT] | UDT | All | +| 27. | [USB booting][UBT] | UBT | All | +| 28. | [Setup Menu information][SET] | SET | All | +| 29. | [Ubuntu booting performance test][BUB]| BUB | All | +| 30. | [CPU status][CPU] | CPU | CPU001.001, CPU002.001, CPU003.001, CPU004.001| +| 31. | [Auto boot time-out][BMM] | BMM | All | + +[CBO]: . +[CBK]: ../../unified-test-documentation/dasharo-compatibility/303-custom-boot-menu-key.md +[CLG]: ../../unified-test-documentation/dasharo-compatibility/304-custom-logo.md +[USB]: ../../unified-test-documentation/dasharo-compatibility/306-usb-hid-and-msc-support.md +[CNB]: ../../unified-test-documentation/dasharo-compatibility/30A-custom-network-boot-entries.md +[EFI]: ../../unified-test-documentation/dasharo-compatibility/30M-uefi-compatible-interface.md +[USH]: ../../unified-test-documentation/dasharo-compatibility/30P-uefi-shell.md +[NVM]: . +[PXE]: ../../unified-test-documentation/dasharo-compatibility/315-network-boot.md +[DSP]: ../../unified-test-documentation/dasharo-compatibility/31E-display-ports-and-lcd.md +[AUD]: ../../unified-test-documentation/dasharo-compatibility/31F-audio-subsystem.md +[SUSP]: . +[DMI]: ../../unified-test-documentation/dasharo-compatibility/31L-smbios.md +[MMC]: . +[SATA]: . +[SOL]: . +[LCM]: . +[LBT]: ../../unified-test-documentation/dasharo-compatibility/308-debian-stable-and-ubuntu-lts-support.md +[PSF]: . +[DTS]: ../../unified-test-documentation/dasharo-compatibility/326-dasharo-tools-suite.md +[RTD]: . +[NET]: . +[DCU]: . +[ESP]: . +[NBT]: ../../unified-test-documentation/dasharo-compatibility/315b-netboot-utilities.md +[UDT]: ../../unified-test-documentation/dasharo-compatibility/31O-usb-detect.md +[UBT]: ../../unified-test-documentation/dasharo-compatibility/31N-usb-boot.md +[SET]: . +[BUB]: . +[CPU]: ../../unified-test-documentation/dasharo-compatibility/31T-cpu-status.md +[BMM]: . + + + + + + diff --git a/mkdocs.yml b/mkdocs.yml index 86b3b28493..98aaf7766e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -350,16 +350,15 @@ nav: - 'FAQ': variants/pc_engines/faq.md - 'Announcement': variants/pc_engines/post-eol-fw-announcement.md - 'Firmware write protection': variants/pc_engines/bios-lock.md - - 'Hardkernel': - - 'Overview': unified/hardkernel/overview.md - - 'Building manual': unified/hardkernel/building-manual.md - - 'Initial deployment': unified/hardkernel/initial-deployment.md - - 'Firmware update': unified/hardkernel/firmware-update.md - - 'Recovery': unified/hardkernel/recovery.md - - 'Test matrix': unified/hardkernel/test-matrix.md - - 'Hardkernel ODROID H4+': - - 'Releases': variants/hardkernel_odroid_h4_plus/releases.md - - 'Hardware Configuration Matrix': variants/hardkernel_odroid_h4_plus/hardware-matrix.md + - 'Hardkernel ODROID H4': + - 'Overview': variants/hardkernel_odroid_h4/overview.md + - 'Releases': variants/hardkernel_odroid_h4/releases.md + - 'Building manual': variants/hardkernel_odroid_h4/building-manual.md + - 'Initial deployment': variants/hardkernel_odroid_h4/initial-deployment.md + - 'Firmware update': variants/hardkernel_odroid_h4/firmware-update.md + - 'Recovery': variants/hardkernel_odroid_h4/recovery.md + - 'Hardware Configuration Matrix': variants/hardkernel_odroid_h4/hardware-matrix.md + - 'Test matrix': variants/hardkernel_odroid_h4/test-matrix.md # - 'Development Environment': # - 'Nix': dev-env/nix-dev-env.md - 'Guides':