Add test script to validate USB UAC #266
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| ``` | ||
| 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 | ||
| ------------------------------------------------------------------------------- | ||
| <dev> <vid:pid> <snd-usb-audio> <product> | ||
| ``` | ||
| The test PASS requires all detected UAC devices to have associated ALSA nodes. | ||
| Running this test on a DUT without a connected USB Audio peripheral is expected to FAIL with the message: No 'USB Audio Device' found. | ||
|
|
||
| --- | ||
|
|
||
| ## 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. | ||
|
Contributor
There was a problem hiding this comment. Improve README to clarify exact validation scope |
||
|
|
||
| --- | ||
|
|
||
| ## 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 | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,276 @@ | ||
| #!/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" | ||
|
Contributor
There was a problem hiding this comment. current default is ./${TESTNAME}.res, so early SKIP paths before cd "$test_path" can write the result file into an unexpected working directory.
Contributor
Author
There was a problem hiding this comment. Skip paths before cd "$test_path" could reliably write result file in "$SCRIPT_DIR", please correct me if my understanding is wrong. Does default result file need to be changed to "./${TESTNAME}.res" instead of "$SCRIPT_DIR/${TESTNAME}.res"?
Contributor
There was a problem hiding this comment.
Yes, your understanding is correct. Using: RES_FILE="$SCRIPT_DIR/${TESTNAME}.res" is better for the early SKIP paths before RES_FILE="./${TESTNAME}.res" then early failures such as missing
Contributor
Author
There was a problem hiding this comment. Using RES_FILE="$SCRIPT_DIR/${TESTNAME}.res" for early skip paths in the script |
||
|
|
||
| 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 | ||
| # Include all external utilities used by this script | ||
| deps_list="grep sed sort wc tr readlink head awk" | ||
| check_dependencies "$deps_list" | ||
|
|
||
| # 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 | ||
|
Contributor
There was a problem hiding this comment. Validate more than bInterfaceClass == 01 |
||
| 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" | ||
|
Contributor
There was a problem hiding this comment. Distinguish playback-only vs capture-only devices and also log bound driver info from sysfs |
||
|
|
||
| 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 | ||
|
Contributor
There was a problem hiding this comment. when a UAC interface enumerates but ALSA integration is incomplete, we still lose useful debug context in CI logs. Add a DRIVER column and populate it from the relevant interface driver symlink in sysfs.
Contributor
Author
There was a problem hiding this comment. Added driver info as well for each UAC device. |
||
| 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" | ||
|
Contributor
There was a problem hiding this comment. Consider whether “no UAC device attached” should be FAIL or SKIP |
||
| 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 | ||
|
|
||
| # Build ALSA card -> USB device map via sysfs (use /proc/asound/cards only for logging) | ||
| card_map="" | ||
| for card_dir in /sys/class/sound/card*; do | ||
| [ -d "$card_dir" ] || continue | ||
| c="${card_dir##*/}" | ||
| c="${c#card}" | ||
| target="$(readlink -f "$card_dir/device" 2>/dev/null || true)" | ||
| [ -n "$target" ] || continue | ||
|
|
||
| cur="$target" | ||
| usb_parent="" | ||
| # Walk up until a USB device (with idVendor/idProduct) or an interface dir (X-Y:Z.W) is found | ||
| while [ "$cur" != "/" ] && [ -z "$usb_parent" ]; do | ||
| if [ -r "$cur/idVendor" ] && [ -r "$cur/idProduct" ]; then | ||
| base="${cur##*/}" | ||
| usb_parent="$base" | ||
| break | ||
| fi | ||
| base="${cur##*/}" | ||
| case "$base" in | ||
| *:*) | ||
| usb_parent="${base%%:*}" | ||
| break | ||
| ;; | ||
| esac | ||
| cur="$(dirname "$cur")" | ||
| done | ||
|
|
||
| [ -n "$usb_parent" ] || continue | ||
|
|
||
| # Only map cards whose parent USB device is in detected UAC device list | ||
| if printf "%s\n" "$audio_device_list" | sed '/^$/d' | grep -qx "$usb_parent"; then | ||
| card_map="${card_map}${usb_parent}|${c}\n" | ||
| log_info "Mapped ALSA card$c -> USB device $usb_parent" | ||
| fi | ||
| done | ||
|
|
||
| # For each detected UAC device, verify mapped ALSA card(s) and device nodes | ||
| has_devnodes_count=0 | ||
| for dev in $(printf "%s\n" "$audio_device_list" | sed '/^$/d'); do | ||
| # Look up device details for debug messages (literal field matching) | ||
| vidpid="$(printf "%b" "$dev_info_db" | awk -F'|' -v dev="$dev" '$1==dev{print $2; exit}')" | ||
| driver_info="$(printf "%b" "$dev_info_db" | awk -F'|' -v dev="$dev" '$1==dev{print $3; exit}')" | ||
| product_info="$(printf "%b" "$dev_info_db" | awk -F'|' -v dev="$dev" '$1==dev{print $4; exit}')" | ||
|
|
||
| missing_nodes=0 | ||
|
|
||
| # Cards mapped to this USB device (literal field matching) | ||
| cards_for_dev="$(printf "%b" "$card_map" | awk -F'|' -v dev="$dev" '$1==dev{print $2}' | tr '\n' ' ' | sed 's/[[:space:]]*$//')" | ||
|
|
||
| if [ -z "$cards_for_dev" ]; then | ||
|
Contributor
There was a problem hiding this comment. The same raw-device-id regex issue is used to derive cards_for_dev from card_map. This is more than a logging issue; a wrong match here can map the wrong ALSA card to a UAC device or fail to map a valid one. Recommended fix: replace the sed lookup with literal field matching, for example awk -F'|' -v dev="$dev" '$1 == dev {print $2}', then join results.
Contributor
Author
There was a problem hiding this comment. Using awk for literal-field comparison |
||
| log_info "UAC device $dev ($vidpid '$product_info', driver: $driver_info): No ALSA card mapped" | ||
| missing_nodes=1 | ||
| continue | ||
| fi | ||
|
|
||
| for c in $cards_for_dev; do | ||
| ctrl_dev="/dev/snd/controlC$c" | ||
|
|
||
| # Check if control device exists | ||
| if [ ! -e "$ctrl_dev" ]; then | ||
| log_info "UAC device $dev (card$c): Missing control device $ctrl_dev" | ||
| missing_nodes=1 | ||
| else | ||
| log_info "UAC device $dev ($vidpid '$product_info') -> card$c: $ctrl_dev exists" | ||
| fi | ||
|
|
||
| # Validate PCMs using /proc/asound/pcm, then verify corresponding /dev nodes | ||
| has_play_cap="$(awk -v c="$c" ' | ||
| BEGIN{p=0;cap=0} | ||
| /^[0-9]+-[0-9]+:/ { | ||
| s=$1 | ||
| s=sub(":", "", s) | ||
| } | ||
| /^[0-9]+-[0-9]+:/ { | ||
| split($1,a,"-"); gsub(":","",a[2]); if ((a[1]+0)==c) { | ||
| if ($0 ~ /playback[[:space:]]+[1-9]/) p=1 | ||
| if ($0 ~ /capture[[:space:]]+[1-9]/) cap=1 | ||
| } | ||
| } | ||
| END{ printf "%d %d\n", p, cap } | ||
| ' /proc/asound/pcm 2>/dev/null || printf "0 0\n")" | ||
|
|
||
| has_play="$(printf "%s" "$has_play_cap" | awk '{print $1}')" | ||
| has_cap="$(printf "%s" "$has_play_cap" | awk '{print $2}')" | ||
|
|
||
| if [ "${has_play:-0}" -eq 1 ]; then | ||
| play_node_exists=0 | ||
| for n in /dev/snd/pcmC"${c}"D*p; do | ||
| [ -e "$n" ] || continue | ||
| log_info " PCM device (playback): $n exists" | ||
| play_node_exists=1 | ||
| done | ||
| if [ "$play_node_exists" -eq 0 ]; then | ||
| log_info " PCM device (playback): nodes missing for card$c" | ||
| missing_nodes=1 | ||
| fi | ||
| else | ||
| log_info " No playback streams for card$c" | ||
| fi | ||
|
|
||
| if [ "${has_cap:-0}" -eq 1 ]; then | ||
| cap_node_exists=0 | ||
| for n in /dev/snd/pcmC"${c}"D*c; do | ||
| [ -e "$n" ] || continue | ||
| log_info " PCM device (capture): $n exists" | ||
| cap_node_exists=1 | ||
| done | ||
| if [ "$cap_node_exists" -eq 0 ]; then | ||
| log_info " PCM device (capture): nodes missing for card$c" | ||
| missing_nodes=1 | ||
| fi | ||
| else | ||
| log_info " No capture streams for card$c" | ||
| fi | ||
|
|
||
| if [ "${has_play:-0}" -eq 0 ] && [ "${has_cap:-0}" -eq 0 ]; then | ||
| log_info " No PCM playback/capture streams 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 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
|
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The README says PASS requires all detected UAC devices to have associated ALSA nodes, but it does not describe the expected behavior when no USB audio peripheral is connected. The script currently reports FAIL in that case. lab users may schedule this test on boards without an attached UAC peripheral and interpret the result incorrectly.
Recommended fix: document “no UAC device connected” as an expected FAIL, or add a YAML/script parameter such as USB_UAC_REQUIRED=1 so labs can choose FAIL vs SKIP.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated README noting that “no UAC device connected” is an expected FAIL.