-
Notifications
You must be signed in to change notification settings - Fork 33
Add test script to validate USB UAC #266
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| ``` | ||
| 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. | ||
|
|
||
| --- | ||
|
|
||
| ## 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 | ||
| ``` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,185 @@ | ||
| #!/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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. current default is ./${TESTNAME}.res, so early SKIP paths before cd "$test_path" can write the result file into an unexpected working directory. |
||
|
|
||
| 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 grep is 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 = 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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 %-s\n' "DEVICE" "VID:PID" "PRODUCT" | ||
| printf '%s\n' "--------------------------------------------------------" | ||
| 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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. |
||
| product=$(tr -d '\000' < "$sys/product") | ||
| else | ||
| product="-" | ||
| fi | ||
| printf '%-9s %-9s %-s\n' "$dev" "$vid:$pid" "$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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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 | ||
|
|
||
| # 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 | ||
|
|
||
| # For each USB ALSA card, ensure playback or capture device nodes exist | ||
| missing_nodes=0 | ||
| while IFS= read -r c; do | ||
| card_path="/sys/class/sound/card$c" | ||
| ctrl_dev="/dev/snd/controlC$c" | ||
| has_pcm_p=0 | ||
| has_pcm_c=0 | ||
|
|
||
| # Detect at least one playback/capture PCM node for the card | ||
| for n in /dev/snd/pcmC"${c}"D*p; do | ||
| [ -e "$n" ] && has_pcm_p=1 && break | ||
| done | ||
| for n in /dev/snd/pcmC"${c}"D*c; do | ||
| [ -e "$n" ] && has_pcm_c=1 && break | ||
| done | ||
|
|
||
| if [ ! -e "$card_path" ]; then | ||
| log_fail "Missing sysfs sound card path: $card_path" | ||
| missing_nodes=1 | ||
| fi | ||
| if [ ! -e "$ctrl_dev" ]; then | ||
| log_fail "Missing ALSA control device: $ctrl_dev" | ||
| missing_nodes=1 | ||
| fi | ||
| if [ "$has_pcm_p" -ne 1 ] && [ "$has_pcm_c" -ne 1 ]; then | ||
| log_fail "Missing ALSA PCM device(s) for card $c (no playback or capture node found)" | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. tighten PASS to require all detected UAC-backed ALSA cards to have playback/capture nodes, or |
||
| missing_nodes=1 | ||
| else | ||
| msg="ALSA card $c device nodes present:" | ||
| [ "$has_pcm_p" -eq 1 ] && msg="$msg playback" | ||
| [ "$has_pcm_c" -eq 1 ] && msg="$msg capture" | ||
| log_info "$msg" | ||
| fi | ||
| done <<EOF | ||
| $usb_alsa_card_nums | ||
| EOF | ||
|
|
||
| if [ "$missing_nodes" -ne 0 ] 2>/dev/null; then | ||
| log_fail "$TESTNAME : Test Failed - One or more ALSA device nodes are missing for USB sound card(s)" | ||
| echo "$TESTNAME FAIL" > "$RES_FILE" | ||
| exit 0 | ||
| fi | ||
|
|
||
| log_pass "$TESTNAME : Test Passed - USB Audio device(s) detected and ALSA device nodes present" | ||
| echo "$TESTNAME PASS" > "$RES_FILE" | ||
| exit 0 | ||
| 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 | ||
|
|
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.
Improve README to clarify exact validation scope