From eaf38acbc85d3d303f3107722f9d10a302b545bb Mon Sep 17 00:00:00 2001 From: Aanchal Chaurasia Date: Fri, 27 Feb 2026 14:17:44 +0530 Subject: [PATCH] Add test script to validate USB UAC The shell script verifies the enumeration of USB Audio Class devices. Signed-off-by: Aanchal Chaurasia --- .../Kernel/Baseport/USB/usb_uac/README.md | 49 ++++ .../suites/Kernel/Baseport/USB/usb_uac/run.sh | 240 ++++++++++++++++++ .../Kernel/Baseport/USB/usb_uac/usb_uac.yaml | 16 ++ 3 files changed, 305 insertions(+) create mode 100644 Runner/suites/Kernel/Baseport/USB/usb_uac/README.md create mode 100755 Runner/suites/Kernel/Baseport/USB/usb_uac/run.sh create mode 100644 Runner/suites/Kernel/Baseport/USB/usb_uac/usb_uac.yaml diff --git a/Runner/suites/Kernel/Baseport/USB/usb_uac/README.md b/Runner/suites/Kernel/Baseport/USB/usb_uac/README.md new file mode 100644 index 00000000..aa6f8592 --- /dev/null +++ b/Runner/suites/Kernel/Baseport/USB/usb_uac/README.md @@ -0,0 +1,49 @@ +``` +Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries. +SPDX-License-Identifier: BSD-3-Clause +``` + +# USB Audio Class Validation + +## Overview + +This shell script executes on the DUT (Device-Under-Test) and validates USB Audio Class (UAC) devices. +The test validation scope includes: +- Successful enumeration of UAC devices and display following details for each device: + - DEVICE (USB device address), VID:PID, and PRODUCT string. +- Validation of ALSA integration: + - Confirm /proc/asound/cards exists. + - Identify ALSA cards corresponding to the UAC device. + - At least one PCM playback or capture node exists for each such card. +- Print a table of enumerated devices: + +``` +DEVICE VID:PID DRIVER PRODUCT +------------------------------------------------------------------------------- + +``` +The test PASS requires all detected UAC devices to have associated ALSA nodes. + +--- + +## Setup + +- Connect USB Audio peripheral(s) to USB port(s) on DUT. +- Only applicable for USB ports that support Host Mode functionality. +- USB Audio peripherals examples: USB headset, microphone, sound card, etc. + +--- + +## Usage +### Instructions: +1. **Copy the test suite to the target device** using `scp` or any preferred method. +2. **Navigate to the test directory** on the target device. +3. **Run the test script** using the test runner or directly. + +--- + +### Quick Example +``` +cd Runner +./run-test.sh usb_uac +``` diff --git a/Runner/suites/Kernel/Baseport/USB/usb_uac/run.sh b/Runner/suites/Kernel/Baseport/USB/usb_uac/run.sh new file mode 100755 index 00000000..3947e2d4 --- /dev/null +++ b/Runner/suites/Kernel/Baseport/USB/usb_uac/run.sh @@ -0,0 +1,240 @@ +#!/bin/sh + +# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries. +# SPDX-License-Identifier: BSD-3-Clause +# Validate USB Audio Class (UAC) device detection +# Requires at least one USB Audio peripheral (e.g., USB headset, microphone, sound card) connected to a USB Host port. + +TESTNAME="usb_uac" + +# 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 dependencies are installed, else skip test +deps_list="grep sed sort wc tr readlink" +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 = 01 (UAC) under /sys/bus/usb/devices +log_info "=== USB Audio device Detection ===" +audio_device_list="$( + for f in /sys/bus/usb/devices/*/bInterfaceClass; do + [ -r "$f" ] || continue + if grep -qx '01' "$f"; then + d=${f%/bInterfaceClass} + d=${d%:*} + printf '%s\n' "${d##*/}" + fi + done 2>/dev/null | sort -u +)" + +audio_device_count="$(printf "%s\n" "$audio_device_list" | sed '/^$/d' | wc -l | tr -d '[:space:]')" +log_info "Number of USB audio devices found: $audio_device_count" + +if [ "$audio_device_count" -gt 0 ] 2>/dev/null; then + log_info "=== Enumerated USB Audio Devices ===" + printf '\n%-9s %-9s %-18s %-s\n' "DEVICE" "VID:PID" "DRIVER" "PRODUCT" + printf '%s\n' "--------------------------------------------------------" + dev_info_db="" + for dev in $(printf "%s\n" "$audio_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 driver from the UAC interface driver symlink + driver="-" + + for intf in "$sys":*; do + # Only consider UAC interfaces (bInterfaceClass == 01) + if [ -r "$intf/bInterfaceClass" ] && grep -qx '01' "$intf/bInterfaceClass"; then + # Resolve driver symlink and extract driver name + if [ -L "$intf/driver" ]; then + link="$(readlink "$intf/driver" 2>/dev/null)" + driver="$(printf "%s\n" "$link" | grep -o 'snd-usb-audio' || echo -)" + fi + break + fi + done + dev_info_db="${dev_info_db}\n${dev}|${vid}:${pid}|${driver}|${product}" + printf '%-9s %-9s %-18s %-s\n' "$dev" "$vid:$pid" "$driver" "$product" + done + printf '\n' +fi + +if [ "$audio_device_count" -le 0 ] 2>/dev/null; then + log_fail "$TESTNAME : Test Failed - No 'USB Audio Device' found" + echo "$TESTNAME FAIL" > "$RES_FILE" + exit 0 +fi + +# Verify ALSA is available +if [ ! -r /proc/asound/cards ]; then + log_fail "$TESTNAME : Test Failed - ALSA not available (/proc/asound/cards missing)" + echo "$TESTNAME FAIL" > "$RES_FILE" + exit 0 +fi + +if [ -r /proc/asound/cards ]; then + log_info "ALSA cards (/proc/asound/cards):" + while IFS= read -r line; do + log_info " $line" + done < /proc/asound/cards +fi + +# Identify ALSA cards that correspond to USB +usb_alsa_card_nums="$(sed -n 's/^[[:space:]]*\([0-9][0-9]*\)[[:space:]]\{1,\}\[[^]]*\]:[[:space:]]\{1,\}USB.*/\1/p' /proc/asound/cards | sort -u)" +usb_alsa_card_count="$(printf "%s\n" "$usb_alsa_card_nums" | sed '/^$/d' | wc -l | tr -d '[:space:]')" +log_info "Number of ALSA USB sound cards: $usb_alsa_card_count" + +if [ "$usb_alsa_card_count" -le 0 ] 2>/dev/null; then + log_fail "$TESTNAME : Test Failed - No ALSA 'USB' cards found for detected USB Audio device(s)" + echo "$TESTNAME FAIL" > "$RES_FILE" + exit 0 +fi + +# Map ALSA USB cards to their parent USB device id (e.g., 1-2.3 from 1-2.3:1.0) +card_map="" +while IFS= read -r c; do + [ -n "$c" ] || continue + link="$(readlink "/sys/class/sound/card${c}/device" 2>/dev/null || true)" + [ -n "$link" ] || continue + base="${link##*/}" + parent="${base%%:*}" + [ -n "$parent" ] || continue + card_map="${card_map}${parent}|${c}\n" +done < card$c: $ctrl_dev exists" + fi + + # Check for PCM devices (playback/capture) + pcm_found=0 + + for pcm in "$card_path"/pcmC"${c}"D*p "$card_path"/pcmC"${c}"D*c; do + [ -e "$pcm" ] || continue + pcm_found=1 + pcm_name="${pcm##*/}" + dev_node="/dev/snd/${pcm_name}" + case "$pcm_name" in + *p) pcm_dir="playback" ;; + *c) pcm_dir="capture" ;; + *) pcm_dir="unknown" ;; + esac + if [ -e "$dev_node" ]; then + log_info " PCM device ($pcm_dir): $dev_node exists" + else + log_info " PCM device ($pcm_dir): $dev_node missing" + missing_nodes=1 + fi + done + + if [ "$pcm_found" -eq 0 ]; then + log_info " No PCM devices found for card$c" + missing_nodes=1 + fi + done + if [ "$missing_nodes" -eq 0 ]; then + has_devnodes_count=$((has_devnodes_count + 1)) + fi +done + +if [ "${has_devnodes_count:-0}" -eq "$audio_device_count" ] 2>/dev/null; then + log_pass "$TESTNAME : Test Passed - All ($audio_device_count/$audio_device_count) USB Audio device(s) detected have associated ALSA device nodes present" + echo "$TESTNAME PASS" > "$RES_FILE" + exit 0 +else + log_fail "$TESTNAME : Test Failed - $((audio_device_count - has_devnodes_count))/$audio_device_count USB Audio device(s) missing associated ALSA device nodes" + echo "$TESTNAME FAIL" > "$RES_FILE" + exit 0 +fi diff --git a/Runner/suites/Kernel/Baseport/USB/usb_uac/usb_uac.yaml b/Runner/suites/Kernel/Baseport/USB/usb_uac/usb_uac.yaml new file mode 100644 index 00000000..b324c6be --- /dev/null +++ b/Runner/suites/Kernel/Baseport/USB/usb_uac/usb_uac.yaml @@ -0,0 +1,16 @@ +metadata: + name: usb_uac + format: "Lava-Test Test Definition 1.0" + description: "This shell script executes on the DUT (Device-Under-Test) and verifies enumeration of connected USB Audio Class (UAC) Devices." + os: + - linux + scope: + - functional + +run: + steps: + - REPO_PATH=$PWD + - cd Runner/suites/Kernel/Baseport/USB/usb_uac + - ./run.sh || true + - $REPO_PATH/Runner/utils/send-to-lava.sh usb_uac.res +