-
-
Notifications
You must be signed in to change notification settings - Fork 3
PC Engines #211
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
PC Engines #211
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
29b0c6b
platform-configs/include/pcengines.robot: add initial pcengines lib
mkopec dbf433c
platform-configs/pcengines-apu4.robot: add initial apu4 config
mkopec af6a158
README.md: alphabetize DUT list
mkopec d41603c
variables.robot: update apu4 config
mkopec 43c4a0a
README.md: add apu4 to DUT list
mkopec 7433462
platform-configs/include/pcengines.robot: enable UEFI Shell tests
mkopec 2c373c2
platform-configs/include/pcengines.robot: remove redundant definitions
mkopec d20d909
platform-configs/include/pcengines.robot: adjust test scope
mkopec 1f546cb
platform-configs/include/pcengines.robot: remove unsupported tests
mkopec 212a3c8
README.md: split some docs to a subdirectory
mkopec 436d72e
docs/adding-new-platforms.md: add file
mkopec c618260
platform-configs/include/pcengines.robot: remove unsupported tests
mkopec 8b29f60
platform-configs/include/pcengines.robot: add back USB write tests
mkopec 7eca2e0
docs/adding-new-platforms.md: improve readability
mkopec 2e8e541
variables.robot: remove unused firmware_type var
mkopec 07eb70c
variables.robot: remove unused pcb_rev var
mkopec 965b700
variables.robot: remove unused board-revision and env vars
mkopec 9af359c
docs/adding-new-platforms.md: use boot menu key as example
mkopec File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| # Adding new platforms | ||
|
|
||
| Depending on what type of platform you're adding, the instructions here will | ||
| vary. | ||
|
|
||
| - If no similar board is yet supported, follow the steps in | ||
| [Adding a brand new platform](#adding-a-brand-new-platform) | ||
| - If the board is a variant of another, similar, already supported board, follow | ||
| the steps in | ||
| [Adding new variant of an existing platform](#adding-new-variant-of-an-existing-platform) | ||
|
|
||
| ## Adding a brand new platform | ||
|
|
||
| - Create a new file for your mainboard in `platform-configs/`. For most | ||
| platforms this file will be called `[platform-vendor]-[platform-model].robot`. | ||
| - Copy the contents of `include/default.robot` to your platform config | ||
pietrushnic marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - Modify the file for your platform: | ||
| + Modify the settings appropriately for your mainboard | ||
| + Remove any unmodified lines - they will be sourced from `default.robot` | ||
| + Add the following at the top of your platform config - this will ensure | ||
| defaults are used for unspecified options: | ||
|
|
||
| ```robot | ||
| *** Settings *** | ||
| Resource default.robot | ||
| ``` | ||
|
|
||
| - Add the platform configuration to `variables.robot: | ||
| + Create a new configuration of RTE, if you are using one, e.g.: | ||
|
|
||
| ```robot | ||
| &{RTE11}= ip=192.168.10.174 cpuid=02c000426621f7ea | ||
| ... platform=apu4 platform_vendor=PC Engines | ||
| ``` | ||
|
|
||
| + Add the RTE to the list: | ||
|
|
||
| ```robot | ||
| @{RTE_LIST}= &{RTE05} | ||
| ... &{RTE06} &{RTE07} &{RTE08} &{RTE09} &{RTE10} | ||
| ... &{RTE11} | ||
| ``` | ||
|
|
||
| + Do the same for any modules installed in the platform | ||
| + Create a new CONFIG containing the RTE and modules used for testing, and | ||
| append it to the list: | ||
|
|
||
| ```robot | ||
| @{CONFIG04}= &{RTE11} &{SSD06} &{CARD06} &{USB03} | ||
| ... &{MODULE06} &{ADAPTER01} &{MODULE10} | ||
|
|
||
| @{CONFIG_LIST}= @{CONFIG01} @{CONFIG02} @{CONFIG03} @{CONFIG04} | ||
| ``` | ||
|
|
||
| + Run a simple test to verify the config is working correctly - for example | ||
| custom boot menu key: | ||
|
|
||
| ```robot | ||
| robot -v snipeit:no -L TRACE -v rte_ip:192.168.10.174 -v device_ip:0.0.0.0 -v config:pcengines-apu4 dasharo-compatibility/custom-boot-menu-key.robot | ||
| ``` | ||
|
|
||
| If everything went right, the output may look something like this | ||
|
|
||
| ```bash | ||
| ============================================================================== | ||
| Custom-Boot-Menu-Key | ||
| ============================================================================== | ||
| CBK001.001 Custom boot menu key :: Check whether the DUT is config... | PASS | | ||
| ------------------------------------------------------------------------------ | ||
| CBK002.001 Custom setup menu key :: Check whether the DUT is confi... | PASS | | ||
| ------------------------------------------------------------------------------ | ||
| Custom-Boot-Menu-Key | PASS | | ||
| 2 tests, 2 passed, 0 failed | ||
| ============================================================================== | ||
| Output: /home/michal/Development/Dasharo/osfv/output.xml | ||
| Log: /home/michal/Development/Dasharo/osfv/log.html | ||
| Report: /home/michal/Development/Dasharo/osfv/report.html | ||
| ``` | ||
|
|
||
| ## Adding new variant of an existing platform | ||
|
|
||
| Some boards come in multiple variants, where the majority of properties and | ||
| features can be shared. For these cases, we have shared "base" configs in | ||
| `platform-configs/include/`. This way we don't need to copy-paste entire config | ||
| files, making maintenance easier. In this example we'll be adding a new PC | ||
| Engines apu variant, using an existing pcengines base config: | ||
|
|
||
| - Create a config file in `platform-configs` for your platform | ||
| - Add the following to your platform config | ||
|
|
||
| ```robot | ||
| *** Settings *** | ||
| Resource include/pcengines.robot | ||
| ``` | ||
|
|
||
| - Add variant-specific settings for your platform - in this case, only the | ||
| SMBIOS product name field: | ||
|
|
||
| ```robot | ||
| *** Variables *** | ||
| ${DMIDECODE_PRODUCT_NAME}= apu4 | ||
| ``` | ||
|
|
||
| - Proceed with adding the platform to `variables.robot` as per | ||
| [Adding a brand new platform](#adding-a-brand-new-platform). | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.