Skip to content

Latest commit

 

History

History
117 lines (91 loc) · 4.8 KB

adding-new-platforms.md

File metadata and controls

117 lines (91 loc) · 4.8 KB

Adding new platforms

Depending on what type of platform you're adding, the instructions here will vary.

Generating config variables

To simplify filling in variables in config, you can use scripts/get-robot-variables.sh on the target device. Remember to fill in the hardware slots (such as WiFi) with the peripherals to be used during tests. It is assumed that this script is executed on the Ubuntu OS. You can use these automatically generated variables as another input to the cases described below.

Also, if there already is a Dasharo FW binary for the platform, you might want to extract the .config from the binary and try to run it through our config parser to get at least some flags automatically.

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

  • 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:
    *** Settings ***
Resource    default.robot

  • Add the platform configuration to `variables.robot:

    • Create a new configuration of RTE, if you are using one, e.g.:

      &{RTE11}=                   ip=192.168.10.174
...                         platform=apu4    platform_vendor=PC Engines

    • Add the RTE to the list:

      @{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:

      @{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 -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

      ==============================================================================
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
*** Settings ***
Resource    include/pcengines.robot
  • Add variant-specific settings for your platform - in this case, only the SMBIOS product name field:
*** Variables ***
${DMIDECODE_PRODUCT_NAME}=      apu4