Add: test script for validating Qualcomm HWRNG functionality

Runner/suites/Kernel/FunctionalArea/baseport/qcom_hwrng/README_qcom_hwrng.md

@@ -0,0 +1,92 @@
+Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+SPDX-License-Identifier: BSD-3-Clause-Clear
+
+# Qualcomm Hardware Random Number Generator (QRNG) Script
+# Overview
+
+The qcom_hwrng test script validates Qualcomm Hardware Random Number Generator (HWRNG) basic functionality. This test ensures that the HWRNG kernel driver is correctly integrated and functional.
+
+## Features
+
+- Driver Validation: Confirms the presence and correct configuration of the qcom_hwrng kernel driver.
+- Dependency Check: Verifies the availability of required tools like rngtest before execution.
+- Automated Result Logging: Outputs test results to a .res file for automated result collection.
+- Remote Execution Ready: Supports remote deployment and execution via scp and ssh.
+
+## Prerequisites
+
+Ensure the following components are present in the target:
+
+- `rngtest` (Binary Available in /usr/bin) - this test app can be compiled from https://github.com/cernekee/rng-tools/
+
+## Directory Structure
+```
+Runner/
+├── suites/
+│   ├── Kernel/
+│   │   ├── FunctionalArea/
+│   │   │   ├── baseport/
+│   │   │   │   ├── qcom_hwrng/
+│   │   │   │   │   ├── run.sh
+```
+## Usage
+
+1. Copy repo to Target Device: Use scp to transfer the scripts from the host to the target device. The scripts should be copied to the /var directory on the target device.
+
+2. Verify Transfer: Ensure that the repo have been successfully copied to the /var directory on the target device.
+
+3. Run Scripts: Navigate to the /var directory on the target device and execute the scripts as needed.
+
+---
+Quick Example
+```
+git clone <this-repo>
+cd <this-repo>
+scp -r common Runner user@target_device_ip:/<user-defined-location>
+ssh user@target_device_ip 
+cd /<user-defined-location>/Runner && ./run-test.sh qcom_hwrng
+
+Sample output:
+sh-5.2# ./run-test.sh qcom_hwrng
+[Executing test case: qcom_hwrng] 1970-01-01 00:17:53 -
+[INFO] 1970-01-01 00:17:53 - -----------------------------------------------------------------------------------------
+[INFO] 1970-01-01 00:17:53 - -------------------Starting qcom_hwrng Testcase----------------------------
+[INFO] 1970-01-01 00:17:53 - === Test Initialization ===
+[INFO] 1970-01-01 00:17:53 - Checking if dependency binary is available
+[INFO] 1970-01-01 00:17:53 - qcom_hwrng successfully set as the current RNG source.
+[INFO] 1970-01-01 00:17:53 - Running rngtest with 20000032 bytes of entropy from /dev/random...
+rngtest 6.15
+Copyright (c) 2004 by Henrique de Moraes Holschuh
+This is free software; see the source for copying conditions.  There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+rngtest: starting FIPS tests...
+rngtest: bits received from input: 20000032
+rngtest: FIPS 140-2 successes: 999
+rngtest: FIPS 140-2 failures: 1
+rngtest: FIPS 140-2(2001-10-10) Monobit: 0
+rngtest: FIPS 140-2(2001-10-10) Poker: 0
+rngtest: FIPS 140-2(2001-10-10) Runs: 0
+rngtest: FIPS 140-2(2001-10-10) Long run: 1
+rngtest: FIPS 140-2(2001-10-10) Continuous run: 0
+rngtest: input channel speed: (min=3.682; avg=5.473; max=7.173)Mibits/s
+rngtest: FIPS tests speed: (min=84.771; avg=138.269; max=155.069)Mibits/s
+rngtest: Program run time: 3623356 microseconds
+[INFO] 1970-01-01 00:17:56 - rngtest: FIPS 140-2 failures = 1
+[PASS] 1970-01-01 00:17:56 - qcom_hwrng : Test Passed (1 failures)
+[PASS] 1970-01-01 00:17:56 - qcom_hwrng passed
+
+[INFO] 1970-01-01 00:17:57 - ========== Test Summary ==========
+PASSED:
+qcom_hwrng
+
+FAILED:
+ None
+[INFO] 1970-01-01 00:17:57 - ==================================
+```
+4. Results will be available in the `/<user-defined-location>/Runner/suites/Kernel/FunctionalArea/baseport/qcom_hwrng/` directory.
+
+## Notes
+
+- The script sets qcom_hwrng as the primary hwrng.
+- It validates Qualcomm Hardware Random Number Generator (HWRNG) basic functionality.
+- If any critical tool is missing, the script exits with an error message.

Runner/suites/Kernel/FunctionalArea/baseport/qcom_hwrng/run.sh

@@ -0,0 +1,102 @@
+#!/bin/sh
+
+# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+# SPDX-License-Identifier: BSD-3-Clause-Clear
+
+# Robustly find and source init_env
+SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
+INIT_ENV=""
+SEARCH="$SCRIPT_DIR"
+while [ "$SEARCH" != "/" ]; do
+    if [ -f "$SEARCH/init_env" ]; then
+        INIT_ENV="$SEARCH/init_env"
+        break
+    fi
+    SEARCH=$(dirname "$SEARCH")
+done
+
+if [ -z "$INIT_ENV" ]; then
+    echo "[ERROR] Could not find init_env (starting at $SCRIPT_DIR)" >&2
+    exit 1
+fi
+
+# Only source if not already loaded (idempotent)
+if [ -z "$__INIT_ENV_LOADED" ]; then
+    # shellcheck disable=SC1090
+    . "$INIT_ENV"
+fi
+
+# Always source functestlib.sh, using $TOOLS exported by init_env
+# shellcheck disable=SC1090,SC1091
+. "$TOOLS/functestlib.sh"
+
+TESTNAME="qcom_hwrng"
+test_path=$(find_test_case_by_name "$TESTNAME")
+cd "$test_path" || exit 1
+res_file="./$TESTNAME.res"
+
+log_info "-----------------------------------------------------------------------------------------"
+log_info "-------------------Starting $TESTNAME Testcase----------------------------"
+log_info "=== Test Initialization ==="
+
+log_info "Checking if dependency binary is available"
+check_dependencies rngtest dd
+
+# Set the hardware RNG source to Qualcomm's RNG
+RNG_PATH="/sys/class/misc/hw_random/rng_current"
+if [ -e "$RNG_PATH" ]; then
+    echo qcom_hwrng > "$RNG_PATH"
+else
+    log_fail "$TESTNAME : RNG path $RNG_PATH does not exist"
+    echo "$TESTNAME FAIL" > "$res_file"
+    exit 1
+fi
+
+# Verify that qcom_hwrng was successfully set
+current_rng=$(cat "$RNG_PATH")
+if [ "$current_rng" != "qcom_hwrng" ]; then
+    log_fail "$TESTNAME : Failed to set qcom_hwrng as the current RNG source"
+    echo "$TESTNAME FAIL" > "$res_file"
+    exit 1
+else
+    log_info "qcom_hwrng successfully set as the current RNG source."
+fi
+
+TMP_OUT="./qcom_hwrng_output.txt"
+ENTROPY_B=20000032
+RNG_SOURCE="/dev/random"
+
+log_info "Running rngtest with $ENTROPY_B bytes of entropy from $RNG_SOURCE..."
+
+# Generate entropy and run rngtest
+if ! dd if="$RNG_SOURCE" bs=1 count="$ENTROPY_B" status=none 2>/dev/null | rngtest -c 1000 2>&1 | tee "$TMP_OUT"; then
+    log_fail "$TESTNAME : rngtest pipeline execution failed"
+    echo "$TESTNAME FAIL" > "$res_file"
+    exit 1
+fi
+
+# Parse FIPS 140-2 failures
+failures=$(awk '/FIPS 140-2 failures:/ {print $NF}' "$TMP_OUT" | head -n1)
+
+if [ -z "$failures" ] || ! echo "$failures" | grep -Eq '^[0-9]+$'; then
+    log_fail "rngtest did not return a valid integer for failures; got: '$failures'"
+    echo "$TESTNAME FAIL" > "$res_file"
+    rm -f "$TMP_OUT"
+    exit 1
+fi
+
+log_info "rngtest: FIPS 140-2 failures = $failures"
+# You can tune this threshold as needed (10 means <1% fail allowed)
+if [ "$failures" -lt 10 ]; then
+    log_pass "$TESTNAME : Test Passed ($failures failures)"
+    echo "$TESTNAME PASS" > "$res_file"
+    rm -f "$TMP_OUT"
+    exit 0
+else
+    log_fail "$TESTNAME : Test Failed ($failures failures)"
+    echo "$TESTNAME FAIL" > "$res_file"
+    rm -f "$TMP_OUT"
+    exit 1
+fi
+
+log_info "-------------------Completed $TESTNAME Testcase----------------------------"