| #!/usr/bin/env bash |
| |
| # |
| # Copyright (c) 2020 Project CHIP Authors |
| # |
| # Licensed under the Apache License, Version 2.0 (the "License"); |
| # you may not use this file except in compliance with the License. |
| # You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, software |
| # distributed under the License is distributed on an "AS IS" BASIS, |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| # See the License for the specific language governing permissions and |
| # limitations under the License. |
| # |
| |
| # Build script for GN EFR32 examples GitHub workflow. |
| |
| set -e |
| |
| if [[ -z "${MATTER_ROOT}" ]]; then |
| echo "Using default path for Matter root" |
| CHIP_ROOT="$(dirname "$0")/../.." |
| else |
| echo "Using ENV path for Matter root" |
| CHIP_ROOT="$MATTER_ROOT" |
| fi |
| |
| if [[ -z "${PW_ENVIRONMENT_ROOT}" ]]; then |
| echo "Using the bootstrapped pigweed ENV in Matter root" |
| PW_PATH="$CHIP_ROOT/.environment/cipd/packages/pigweed" |
| else |
| echo "Using provided $PW_ENVIRONMENT_ROOT as Pigweed ENV root" |
| PW_PATH="$PW_ENVIRONMENT_ROOT/cipd/packages/pigweed" |
| fi |
| |
| USE_WIFI=false |
| USE_DOCKER=false |
| GN_PATH="$PW_PATH/gn" |
| USE_BOOTLOADER=false |
| DOTFILE=".gn" |
| VERBOSE_MODE=false |
| |
| SILABS_THREAD_TARGET=\""../silabs:ot-efr32-cert"\" |
| USAGE="./scripts/examples/gn_silabs_example.sh <AppRootFolder> <outputFolder> <silabs_board_name> [<Build options>]" |
| |
| PROTOCOL_DIR_SUFFIX="thread" |
| NCP_DIR_SUFFIX="" |
| |
| if [ "$#" == "0" ]; then |
| echo "Build script for EFR32 Matter apps |
| Format: |
| $USAGE |
| |
| <AppRootFolder> |
| Root Location of the app e.g: examples/lighting-app/silabs/ |
| |
| <outputFolder> |
| Desired location for the output files |
| |
| <silabs_board_name> |
| Identifier of the board for which this app is built |
| Currently Supported : |
| BRD4186A |
| BRD4187A |
| BRD4186C |
| BRD4187C |
| BRD2601B |
| BRD2703A |
| BRD2704A |
| BRD4316A |
| BRD4317A |
| BRD4318A |
| BRD4319A |
| |
| |
| <Build options> - optional noteworthy build options for EFR32 |
| chip_build_libshell |
| Enable libshell support. (Default false) |
| chip_logging |
| Current value (Default true) |
| chip_openthread_ftd |
| Use openthread Full Thread Device, else, use Minimal Thread Device. (Default true) |
| efr32_sdk_root |
| Location for an alternate or modified efr32 SDK |
| enable_heap_monitoring |
| Monitor & log memory usage at runtime. (Default false) |
| enable_openthread_cli |
| Enables openthread cli without matter shell. (Default true) |
| kvs_max_entries |
| Set the maxium Kvs entries that can be store in NVM (Default 75) |
| Thresholds: 30 <= kvs_max_entries <= 255 |
| show_qr_code |
| Enables QR code on LCD for devices with an LCD |
| chip_enable_icd_server |
| Configure has a Intermitently connected device. (Default false) |
| Must also set chip_openthread_ftd=false |
| enable_synchronized_sed |
| Enable Synchronized Sleepy end device. (Default false) |
| Must also set chip_enable_icd_server=true chip_openthread_ftd=false |
| --icd can be used to configure both arguments |
| use_SiWx917 |
| Build wifi example with extension board SiWx917. (Default false) |
| use_pw_rpc |
| Use to build the example with pigweed RPC |
| ota_periodic_query_timeout_sec |
| Periodic query timeout variable for OTA in seconds |
| slc_gen_path |
| Allow users to define a path where slc generates board files. (requires --slc_generate or --slc_reuse_files) |
| (default: /third_party/silabs/slc_gen/<board>/) |
| sl_pre_gen_path |
| Allow users to define a path to pre-generated board files |
| (default: third_party/silabs/matter_support/board-support/<family>/<board>/) |
| sl_matter_version |
| Use provided software version at build time |
| sl_matter_version_str |
| Set a Matter sotfware version string for the Silabs examples |
| Used and formatted by default in this script. |
| sl_hardware_version |
| Use provided hardware version at build time |
| siwx917_commissionable_data |
| Build with the commissionable data given in DeviceConfig.h (only for SiWx917) |
| si91x_alarm_based_wakeup |
| Enable the Alarm Based Wakeup for 917 SoC when sleep is enabled (Default false) |
| si91x_alarm_periodic_time |
| Periodic time at which the 917 SoC should wakeup (Default: 30sec) |
| wifi_ncp_module |
| Build SiWx917_ncp example for NCP module board (Default false) |
| Presets |
| --icd |
| enable ICD features, set thread mtd |
| For minimum consumption, add --low-power |
| --low-power |
| disables all power consuming features for the most power efficient build |
| This flag is to be used with --icd |
| --wifi <SiWx917> |
| build wifi example variant for given expansion board |
| --additional_data_advertising |
| enable Addition data advertissing and rotating device ID |
| --use_ot_lib |
| use the silabs openthread library |
| --use_chip_lwip_lib |
| use the chip lwip library |
| --release |
| Remove all logs and debugs features (including the LCD). Yield the smallest image size possible |
| --docker |
| Change GSDK root for docker builds |
| --uart_log |
| Forward Logs to Uart instead of RTT |
| --slc_generate |
| Generate files with SLC for current board and options Requires an SLC-CLI installation or running in Docker. |
| --slc_reuse_files |
| Use generated files without running slc again. |
| --verbose |
| Add additional logs. |
| --bootloader |
| Add bootloader to the generated image. |
| |
| |
| " |
| elif [ "$#" -lt "2" ]; then |
| echo "Invalid number of arguments |
| Format: |
| $USAGE" |
| else |
| ROOT=$1 |
| OUTDIR=$2 |
| |
| if [ "$#" -gt "2" ]; then |
| SILABS_BOARD=$3 |
| shift |
| fi |
| |
| shift |
| shift |
| while [ $# -gt 0 ]; do |
| case $1 in |
| --clean) |
| DIR_CLEAN=true |
| shift |
| ;; |
| --wifi) |
| if [ -z "$2" ]; then |
| echo "--wifi requires SiWx917" |
| exit 1 |
| fi |
| |
| if [ "$2" = "SiWx917" ]; then |
| optArgs+="use_SiWx917=true " |
| else |
| echo "Wifi usage: --wifi SiWx917" |
| exit 1 |
| fi |
| |
| NCP_DIR_SUFFIX="/"$2 |
| USE_WIFI=true |
| optArgs+="chip_device_platform =\"efr32\" chip_crypto_keystore=\"psa\" " |
| shift |
| shift |
| ;; |
| --icd) |
| optArgs+="chip_enable_icd_server=true chip_openthread_ftd=false sl_enable_test_event_trigger=true " |
| shift |
| ;; |
| --low-power) |
| optArgs+="chip_build_libshell=false enable_openthread_cli=false show_qr_code=false disable_lcd=true " |
| shift |
| ;; |
| --chip_enable_wifi_ipv4) |
| optArgs="chip_enable_wifi_ipv4=true chip_inet_config_enable_ipv4=true " |
| shift |
| ;; |
| --additional_data_advertising) |
| optArgs+="chip_enable_additional_data_advertising=true chip_enable_rotating_device_id=true " |
| shift |
| ;; |
| --use_ot_lib) |
| optArgs+="use_silabs_thread_lib=true chip_openthread_target=$SILABS_THREAD_TARGET openthread_external_platform=\"""\" " |
| shift |
| ;; |
| --use_ot_coap_lib) |
| optArgs+="use_silabs_thread_lib=true chip_openthread_target=$SILABS_THREAD_TARGET openthread_external_platform=\"""\" use_thread_coap_lib=true " |
| shift |
| ;; |
| --use_chip_lwip_lib) |
| optArgs+="lwip_root=\""//third_party/connectedhomeip/third_party/lwip"\" " |
| shift |
| ;; |
| --release) |
| optArgs+="is_debug=false disable_lcd=true chip_build_libshell=false enable_openthread_cli=false use_external_flash=false chip_logging=false silabs_log_enabled=false sl_uart_log_output=false " |
| shift |
| ;; |
| --bootloader) |
| USE_BOOTLOADER=true |
| shift |
| ;; |
| --docker) |
| optArgs+="efr32_sdk_root=\"$GSDK_ROOT\" " |
| optArgs+="wifi_sdk_root=\"$WIFI_SDK_ROOT\" " |
| USE_DOCKER=true |
| shift |
| ;; |
| --uart_log) |
| optArgs+="sl_uart_log_output=true " |
| shift |
| ;; |
| |
| --slc_generate) |
| optArgs+="slc_generate=true " |
| shift |
| ;; |
| --use_pw_rpc) |
| optArgs+="import(\"//with_pw_rpc.gni\") " |
| shift |
| ;; |
| --slc_reuse_files) |
| optArgs+="slc_reuse_files=true " |
| shift |
| ;; |
| --verbose) |
| optArgs+="sl_verbose_mode=true chip_detail_logging=true " |
| VERBOSE_MODE=true |
| shift |
| ;; |
| --gn_path) |
| if [ -z "$2" ]; then |
| echo "--gn_path requires a path to GN" |
| exit 1 |
| else |
| GN_PATH="$2" |
| fi |
| shift |
| shift |
| ;; |
| *) |
| if [[ "$1" == *use_SiWx917=true* ]]; then |
| USE_WIFI=true |
| # NCP Mode so base MCU is an EFR32 |
| optArgs+="chip_device_platform =\"efr32\" " |
| fi |
| optArgs+=$1" " |
| shift |
| ;; |
| esac |
| done |
| |
| if [ -z "$SILABS_BOARD" ]; then |
| echo "SILABS_BOARD not defined" |
| exit 1 |
| fi |
| |
| # 917 exception. TODO find a more generic way |
| WIFI_SOC_BOARDS=("BRD4338A" "BRD2605A" "BRD4343A" "BRD4342A" "BRD2708A" "BRD2911A") |
| if [[ " ${WIFI_SOC_BOARDS[@]} " =~ " ${SILABS_BOARD} " ]]; then |
| echo "Compiling for 917 WiFi SOC" |
| USE_WIFI=true |
| fi |
| |
| # After a completed local install (.install-packages-done), run the Silabs package install step to check for updates. Docker never runs it (SDK is in the image). |
| if [ -f "$CHIP_ROOT/scripts/setup/silabs/.install-packages-done" ]; then # INSTALL_EVERYTHING |
| INSTALL_EVERYTHING=true |
| else |
| INSTALL_EVERYTHING=false |
| fi # INSTALL_EVERYTHING |
| |
| # First-time local install: INSTALL_EVERYTHING is false until .install-packages-done (see above); respect opt-out. No prompt in Docker. |
| if [ "$USE_DOCKER" != true ] && [ "$INSTALL_EVERYTHING" != true ] && [ ! -f "$CHIP_ROOT/scripts/setup/silabs/.do-not-install-packages" ]; then # first-time install prompt |
| cat <<'EOF' |
| !!!!!!!!! FIRST TIME INSTALL !!!!!!!!! |
| Do you agree to install SILICON LABS PACKAGES MANAGER? |
| |
| This will take around 8GB of spaces which will include but not limited to : |
| SLT (silabs packages manager), zap, arm-gcc, |
| |
| Most of the files will be located under ~/.silabs, |
| some symbolic link will be created and it will replace simplicity_sdk submodule |
| This is required for the build to succeed. |
| EOF |
| |
| while true; do |
| read -p "Do you want to proceed? [Y/n]: " yn |
| case $yn in |
| "" | [Yy]*) |
| INSTALL_EVERYTHING=true |
| python3 -m pip install -q -r "$CHIP_ROOT/integrations/docker/images/stage-2/chip-build-efr32/requirements.txt" >/dev/null 2>&1 || true |
| break |
| ;; # Case for yes/Y (Enter accepts default) |
| [Nn]*) |
| echo "You won't be asked again, cannot proceed with build. Exiting..." |
| touch "$CHIP_ROOT/scripts/setup/silabs/.do-not-install-packages" |
| exit 1 |
| break |
| ;; # Case for no/N |
| *) echo "Invalid response. Please answer yes or no." ;; # Case for invalid input |
| esac |
| done |
| fi # first-time install prompt |
| |
| # Local Silabs package install when agreed (INSTALL_EVERYTHING). Never under Docker. |
| if [ "$INSTALL_EVERYTHING" == true ] && [ "$USE_DOCKER" != true ]; then # run install-packages |
| python3 -m pip install -q -r "$CHIP_ROOT/integrations/docker/images/stage-2/chip-build-efr32/requirements.txt" |
| python3 "$CHIP_ROOT/scripts/setup/silabs/install-packages.py" || exit 1 |
| fi # run install-packages |
| |
| # Zap generation requires activation |
| source "$CHIP_ROOT/scripts/activate.sh" |
| |
| if [ "$USE_WIFI" == true ]; then |
| DOTFILE="$ROOT/build_for_wifi_gnfile.gn" |
| PROTOCOL_DIR_SUFFIX="wifi" |
| else |
| DOTFILE="$ROOT/openthread.gn" |
| fi |
| |
| PYTHON_PATH="$(which python3)" |
| BUILD_DIR=$OUTDIR/$PROTOCOL_DIR_SUFFIX/$SILABS_BOARD$NCP_DIR_SUFFIX |
| echo BUILD_DIR="$BUILD_DIR" |
| |
| if [ "$DIR_CLEAN" == true ]; then |
| rm -rf "$BUILD_DIR" |
| fi |
| |
| if [ "$USE_DOCKER" == true ] && [ "$USE_WIFI" == false ]; then |
| echo "Switching OpenThread ROOT" |
| optArgs+="openthread_root=\"$GSDK_ROOT/openthread_stack/util/third_party/openthread\" " |
| fi |
| |
| if [ "$VERBOSE_MODE" == false ]; then |
| optArgs+="chip_detail_logging=false " |
| fi |
| |
| "$GN_PATH" gen --check --script-executable="$PYTHON_PATH" --fail-on-unused-args --add-export-compile-commands=* --root="$ROOT" --dotfile="$DOTFILE" --args="silabs_board=\"$SILABS_BOARD\" $optArgs" "$BUILD_DIR" |
| |
| ninja -C "$BUILD_DIR"/ |
| |
| #print stats |
| arm-none-eabi-size -A "$BUILD_DIR"/*.out |
| |
| if [ "$VERBOSE_MODE" == true ]; then |
| echo "================= Warning!!!!! ================" |
| echo "Verbose mode is enabled. BAUDRATE FOR UART LOGS IS SET TO 921600" |
| echo "Use Simplicity Studio or commander with the following command to set the baudrate:" |
| echo "commander vcom config --baudrate 921600 --handshake rtscts" |
| echo "===============================================" |
| fi |
| |
| # add bootloader to generated image |
| if [ "$USE_BOOTLOADER" == true ]; then |
| |
| binName="" |
| InternalBootloaderBoards=("BRD4337A" "BRD2704A" "BRD2703A" "BRD4319A") |
| bootloaderPath="" |
| commanderPath="" |
| # find the matter root folder |
| if [ -z "$MATTER_ROOT" ]; then |
| MATTER_ROOT="$CHIP_ROOT" |
| fi |
| |
| # set commander path |
| if [ -z "$COMMANDER_PATH" ]; then |
| commanderPath="commander" |
| else |
| commanderPath="$COMMANDER_PATH" |
| fi |
| |
| # search bootloader directory for the respective bootloaders for the input board |
| bootloaderFiles=("$(find "$MATTER_ROOT/third_party/silabs/matter_support/board-support/efr32/bootloader_binaries/" -maxdepth 1 -name "*$SILABS_BOARD*" | tr '\n' ' ')") |
| |
| if [ "${#bootloaderFiles[@]}" -gt 1 ]; then |
| for i in "${!bootloaderFiles[@]}"; do |
| # if a variant of the bootloader that uses external flash exists, use that one. |
| if [[ "${bootloaderFiles[$i]}" =~ .*"spiflash".* ]]; then |
| bootloaderPath="${bootloaderFiles[$i]}" |
| break |
| fi |
| done |
| elif [ "${#bootloaderFiles[@]}" -eq 0 ]; then |
| echo "A bootloader for the $SILABS_BOARD currently doesn't exist!" |
| else |
| bootloaderPath="${bootloaderFiles[0]}" |
| fi |
| echo "$bootloaderPath" |
| binName="$(find "$BUILD_DIR" -type f -name "*.s37")" |
| echo "$binName" |
| "$commanderPath" convert "$binName" "$bootloaderPath" -o "$binName" |
| fi |
| fi |
