run.sh

#!/bin/sh

# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
# SPDX-License-Identifier: BSD-3-Clause
# Validate USB Mass Storage device detection
# Requires at least one USB Mass Storage peripheral (USB flash drive, external HDD/SSD, etc.) connected to a USB Host port.

TESTNAME="usb_msd"

# Robustly find and source init_env
SCRIPT_DIR="$(
  cd "$(dirname "$0")" || exit 1
  pwd
)"

# Default result file (works even before functestlib is available)
# shellcheck disable=SC2034
RES_FILE="$SCRIPT_DIR/${TESTNAME}.res"

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
	echo "$TESTNAME SKIP" >"$RES_FILE" 2>/dev/null || true
    exit 0
fi

# Only source if not already loaded (idempotent)
if [ -z "${__INIT_ENV_LOADED:-}" ]; then
    # shellcheck disable=SC1090
    . "$INIT_ENV"
    __INIT_ENV_LOADED=1
fi
# Always source functestlib.sh, using $TOOLS exported by init_env
# shellcheck disable=SC1090,SC1091
. "$TOOLS/functestlib.sh"

# Resolve test path and cd (single SKIP/exit path)
SKIP_REASON=""
test_path=$(find_test_case_by_name "$TESTNAME")
if [ -z "$test_path" ] || [ ! -d "$test_path" ]; then
  SKIP_REASON="$TESTNAME SKIP - test path not found"
elif ! cd "$test_path"; then
  SKIP_REASON="$TESTNAME SKIP - cannot cd into $test_path"
else
  RES_FILE="$test_path/${TESTNAME}.res"
fi

if [ -n "$SKIP_REASON" ]; then
  log_skip "$SKIP_REASON"
  echo "$TESTNAME SKIP" >"$RES_FILE" 2>/dev/null || true
  exit 0
fi

log_info "-----------------------------------------------------------------------------------------"
log_info "-------------------Starting $TESTNAME Testcase----------------------------"
log_info "=== Test Initialization ==="

# Check if dependecies are installed, else skip test
deps_list="grep sed sort wc tr"
if ! check_dependencies "$deps_list"; then
  log_skip "$TESTNAME SKIP - missing dependencies: $deps_list"
  echo "$TESTNAME SKIP" >"$RES_FILE"
  exit 0
fi

# Detect unique devices with bInterfaceClass = 08 (MSD) under /sys/bus/usb/devices
log_info "=== USB Mass Storage device Detection ==="
msd_device_list="$(
  for f in /sys/bus/usb/devices/*/bInterfaceClass; do
    [ -r "$f" ] || continue
    if grep -qx '08' "$f"; then
      d=${f%/bInterfaceClass}
      d=${d%:*}
      printf '%s\n' "${d##*/}"
    fi
  done 2>/dev/null | sort -u
)"

msd_device_count="$(printf "%s\n" "$msd_device_list" | sed '/^$/d' | wc -l | tr -d '[:space:]')"
log_info "Number of MSD devices found: $msd_device_count"

if [ "$msd_device_count" -gt 0 ] 2>/dev/null; then

  log_info "=== Enumerated Mass Storage Devices ==="
  printf '\n%-9s %-9s %-18s %-s\n' "DEVICE" "VID:PID" "DRIVER" "PRODUCT"
  printf '%s\n' "-------------------------------------------------------------------------------"

  has_devnodes_count=0

  for dev in $(printf "%s\n" "$msd_device_list" | sed '/^$/d'); do
    sys="/sys/bus/usb/devices/$dev"
    vid=$([ -r "$sys/idVendor"  ]  && tr -d '[:space:]' < "$sys/idVendor"  || echo -)
    pid=$([ -r "$sys/idProduct" ]  && tr -d '[:space:]' < "$sys/idProduct" || echo -)
    if [ -r "$sys/product" ]; then
      product=$(tr -d '\000' < "$sys/product")
    else
      product="-"
    fi

    # Determine transport driver (uas vs usb-storage) from the MSD interface
    driver="-"
    found_block=0

    for intf in "$sys":*; do
      # Only consider MSD interfaces (bInterfaceClass == 08)
      if [ -r "$intf/bInterfaceClass" ] && grep -qx '08' "$intf/bInterfaceClass"; then
        # Resolve driver symlink and extract driver name (uas or usb-storage)
        if [ -L "$intf/driver" ]; then
          link="$(readlink "$intf/driver" 2>/dev/null)"
          driver="$(printf "%s\n" "$link" | grep -Eo '(uas|usb-storage)' || echo -)"
        fi

        # Discover associated block device(s) via sysfs
        blk_list=""
        for b in \
          "$intf"/host*/target*/*/block/* \
          "$intf"/host*/target*/*/*/block/* \
          "$intf"/host*/target*/block/*; do
          [ -e "$b" ] || continue
          bn=${b##*/}
          blk_list="$blk_list $bn"
        done

        # Verify at least one block dev node exists for the USB device
        for bn in $blk_list; do
          [ -n "$bn" ] || continue
          if [ -e "/dev/$bn" ]; then
            found_block=1
            break
          fi
        done
        if [ "$found_block" -eq 1 ] 2>/dev/null; then
          has_devnodes_count=$((has_devnodes_count + 1))
        fi
        break
      fi
    done

    printf '%-9s %-9s %-18s %-s\n' "$dev" "$vid:$pid" "$driver" "$product"
  done

  printf '\n'
fi

if [ "$msd_device_count" -gt 0 ]; then
    if [ "${has_devnodes_count:-0}" -gt 0 ] 2>/dev/null; then
        log_pass "$TESTNAME : Test Passed - USB Mass Storage device(s) detected with block device associated"
        echo "$TESTNAME PASS" > "$RES_FILE"
        exit 0
    else
        log_fail "$TESTNAME : Test Failed - MSD interface(s) detected but no associated block device found"
        echo "$TESTNAME FAIL" > "$RES_FILE"
        exit 0
    fi
else
    log_fail "$TESTNAME : Test Failed - No USB 'Mass Storage Device' found"
    echo "$TESTNAME FAIL" > "$RES_FILE"
    exit 0
fi