test-case: add new test case for check mic privacy

case-lib/relay.sh

@@ -0,0 +1,49 @@
+#!/bin/bash
+
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright(c) 2021-2025 Intel Corporation. All rights reserved.
+
+# needs usbrelay package: https://github.com/darrylb123/usbrelay
+# param1: --debug | switch name
+# param2: switch state
+usbrelay_switch()
+{
+    if [[ "$1" == "--debug" ]]; then
+        dlogi "Debug mode: Current status of all relays:"
+        usbrelay || {
+            die "Failed to get usbrelay status.
+            The usbrelay hw module is not responding or no relays detected.
+            Check hardware connection."
+        }
+    fi
+
+    # Declare a constant for the relay settle time
+    local USBRELAY_SETTLE_TIME=0.5
+
+    local switch_name=$1
+    local state=$2
+
+    dlogi "Setting usbrelay switch $switch_name to $state."
+    usbrelay "$switch_name=$state" --quiet || {
+        die "Failed to set usbrelay switch $switch_name to $state.
+        The usbrelay hw module is not responding or no relays detected.
+        Check hardware connection."
+    }
+
+    # wait for the switch to settle
+    sleep "$USBRELAY_SETTLE_TIME"
+
+    # Display current state of the switch
+    current_state=$(usbrelay | awk -F= -v name="$switch_name" '$1 == name { print $2 }')
+
+    # Check if current_state is equal to the requested state
+    [[ "$current_state" == "$state" ]] || {
+        die "usbrelay switch $switch_name failed to set to $state (current: $current_state)"
+    }
+
+    case "$current_state" in
+        '1') dlogi "Current state of $switch_name is: on";;
+        '0') dlogi "Current state of $switch_name is: off";;
+        *) die "Invalid state for $switch_name: $current_state";;
+    esac
+}

env-check.sh

@@ -87,6 +87,8 @@ func_check_pkg aplay
 func_check_pkg sox
 func_check_pkg tinycap
 func_check_pkg tinyplay
+# MIC privacy / JACK Audio detection relay switch
+func_check_pkg usbrelay
 # JACK Audio Connection Kit
 func_check_pkg jackd
 func_check_pkg jack_iodelay

test-case/test-mic-privacy.sh

@@ -0,0 +1,232 @@
+#!/bin/bash
+
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright(c) 2025 Intel Corporation. All rights reserved.
+
+##
+## Case Name: test-mic-privacy
+##
+## Preconditions:
+##    HW managed mode (Only for DMIC PCH and SNDW interfaces).
+##    This test case requires physical loopback between playback and capture.
+##    playback <=====> capture
+##    USB relay switch is connected. The usbrelay app is installed.
+##    Instruction: https://github.com/darrylb123/usbrelay
+##
+## Description:
+##    Run alsabat process perform both playback and capture.
+##    Enable MIC privacy.
+##    Run alsabat process perform both playback and capture again.
+##
+## Case step:
+##    1. Specify the pcm IDs for playback and capture
+##    2. Check if usbrelay is installed and connected properly.
+##    3. Run alsabat process perform both playback and capture.
+##    4. Switch relay 1 to enable MIC privacy.
+##    5. Run alsabat process perform both playback and capture.
+##
+## Expect result:
+##    After step 3 the return value is 0.
+##    After step 5 the return value is -1001 (no peak be detected).
+
+TESTDIR=$(realpath -e "$(dirname "${BASH_SOURCE[0]}")/..")
+TESTLIB="${TESTDIR}/case-lib"
+
+# shellcheck disable=SC1091 source=case-lib/lib.sh
+source "${TESTLIB}/lib.sh"
+# shellcheck disable=SC1091 source=case-lib/relay.sh
+source "${TESTLIB}/relay.sh"
+
+# remove the existing alsabat wav files
+ALSABAT_WAV_FILES="/tmp/mc.wav.*"
+rm -f "$ALSABAT_WAV_FILES"
+
+DSP_SETTLE_TIME=2
+
+OPT_NAME['p']='pcm_p'     	OPT_DESC['p']='pcm for playback. Example: hw:0,0'
+OPT_HAS_ARG['p']=1          OPT_VAL['p']='hw:0,0'
+
+OPT_NAME['N']='channel_p'   OPT_DESC['N']='channel number for playback.'
+OPT_HAS_ARG['N']=1          OPT_VAL['N']='2'
+
+OPT_NAME['c']='pcm_c'      	OPT_DESC['c']='pcm for capture. Example: hw:0,1'
+OPT_HAS_ARG['c']=1          OPT_VAL['c']='hw:0,1'
+
+OPT_NAME['C']='channel_c'   OPT_DESC['C']='channel number for capture.'
+OPT_HAS_ARG['C']=1          OPT_VAL['C']='2'
+
+OPT_NAME['s']='sof-logger'  OPT_DESC['s']="Open sof-logger trace the data will store at $LOG_ROOT"
+OPT_HAS_ARG['s']=0          OPT_VAL['s']=1
+
+OPT_NAME['r']='rate'        OPT_DESC['r']='sample rate'
+OPT_HAS_ARG['r']=1          OPT_VAL['r']=48000
+
+OPT_NAME['u']='relay'       OPT_DESC['u']='name of usbrelay switch, default value is HURTM_1'
+OPT_HAS_ARG['u']=1          OPT_VAL['u']='HURTM_1'
+
+func_opt_parse_option "$@"
+
+pcm_p=${OPT_VAL['p']}
+pcm_c=${OPT_VAL['c']}
+channel_c=${OPT_VAL['C']}
+channel_p=${OPT_VAL['N']}
+rate=${OPT_VAL['r']}
+relay=${OPT_VAL['u']}
+
+dlogi "Params: pcm_p=$pcm_p, pcm_c=$pcm_c, channel_c=$channel_c, channel_p=$channel_p, rate=$rate, LOG_ROOT=$LOG_ROOT"
+
+__upload_wav_files()
+{
+    # upload the alsabat wav file
+    for file in $ALSABAT_WAV_FILES; do
+        # alsabat has a bug where it creates an empty record in playback mode
+        if test -s "$file"; then
+            cp -v "$file" "$LOG_ROOT/"
+        fi
+    done
+}
+
+check_playback_capture()
+{
+    # check if capture and playback work
+    dlogc "alsabat -P$pcm_p -C$pcm_c -c 2 -r $rate"
+    alsabat -P"$pcm_p" -C"$pcm_c" -c 2 -r "$rate" || {
+        # upload failed wav file
+        __upload_wav_files
+        die "check_playback_capture() failed - check if a loopback is connected."
+    }
+}
+
+handle_alsabat_result()
+{
+    case "$alsabat_status" in
+        23)
+            # alsabat returns 23 if no peak detected (expected for MIC privacy)
+            if grep -q -e "Amplitude: 0.0; Percentage: \[0\]" -e "Return value is -1001" "$alsabat_output"; then
+                dlogi "Alsabat output indicates zero signal as expected (MIC privacy works)."
+            else
+                dloge "alsabat failed with status $alsabat_status, but signal is not zero."
+                __upload_wav_files
+                die "alsabat failed with: $(cat "$alsabat_output")."
+            fi
+            ;;
+        0)
+            dloge "The alsabat command was unexpectedly successful."
+            __upload_wav_files
+            die "MIC privacy doesn't work. alsabat output: $(cat "$alsabat_output")"
+            ;;
+        *)
+            dloge "The alsabat command failed with unexpected status $alsabat_status."
+            __upload_wav_files
+            die "alsabat failed with: $(cat "$alsabat_output")."
+            ;;
+    esac
+}
+
+show_control_state()
+{
+    dlogi "Current state of the mic privacy control:"
+    amixer -c 0 contents | awk '
+        /^numid=/ {
+            n=$0
+            show = tolower($0) ~ /capture/
+            found = 0
+        }
+        /type=BOOLEAN/ {
+            t = $0
+            if (show) found = 1
+        }
+        /: values=/ && found {
+            print n
+            print t
+            print $0
+            found = 0
+        }'
+}
+
+main()
+{
+    setup_kernel_check_point
+
+    start_test
+
+    logger_disabled || func_lib_start_log_collect
+
+    if [ -z "$pcm_p" ] || [ -z "$pcm_c" ]; then
+        skip_test "No playback or capture PCM is specified. Skip the $0 test."
+    fi
+
+    # check if usbrelay tool is installed
+    command -v usbrelay || {
+        skip_test "usbrelay command not found. Please install usbrelay to control the mic privacy switch."
+    }
+
+    dlogi "Current DSP status is $(sof-dump-status.py --dsp_status 0)" || {
+        skip_test "platform doesn't support runtime pm, skip test case"
+    }
+
+    dlogi "Starting preconditions check"
+
+    # display current status of relays
+    usbrelay "--debug"
+
+    check_locale_for_alsabat
+
+    set_alsa
+
+    dlogi "Reset - Turn off the mic privacy"
+    usbrelay_switch "$relay" 0
+
+    show_control_state
+
+    # wait for the switch to settle
+    sleep "$DSP_SETTLE_TIME"
+
+    # check the PCMs before mic privacy test
+    dlogi "Check playback/capture before mic privacy test"
+    check_playback_capture
+
+    # select the first card
+    first_card_name=$(aplay -l | awk '/^card ([0-9]+)/ {print $3; exit}')
+    # dump amixer contents always.
+    # good case amixer settings is for reference, bad case for debugging.
+    amixer -c "${first_card_name}" contents > "$LOG_ROOT"/amixer_settings.txt
+
+    check_playback_capture
+
+    dlogi "Preconditions are met, starting mic privacy test"
+
+    sleep "$DSP_SETTLE_TIME"
+
+    dlogi "===== Testing: MIC privacy ====="
+    dlogi "Turn on the mic privacy switch"
+    usbrelay_switch "$relay" 1
+
+    # wait for the switch to settle
+    sleep "$DSP_SETTLE_TIME"
+
+    alsabat_output=$(mktemp)
+    dlogc "alsabat -P$pcm_p -C$pcm_c -c 2 -r $rate"
+    # run alsabat and capture both output and exit status
+    alsabat_status=0
+    alsabat -P"$pcm_p" -C"$pcm_c" -c 2 -r "$rate" > "$alsabat_output" 2>&1 || {
+        alsabat_status=$?
+    }
+
+    handle_alsabat_result
+
+    dlogi "Turn off the mic privacy switch."
+    usbrelay_switch "$relay" 0
+
+    check_playback_capture
+
+    sof-kernel-log-check.sh "$KERNEL_CHECKPOINT"
+
+    dlogi "===== Test completed successfully. ====="
+
+    rm -rf "$alsabat_output"
+}
+
+{
+  main "$@"; exit "$?"
+}