Skip to content

Commit 3c4a6f7

Browse files
arikgreenarikgreen
committed
test-case: add new test case for check mic privacy
Add new test case to check hardware mic privacy mode enablement feature. For switching mic privacy state is using a USB relay. https://github.com/darrylb123/usbrelay Signed-off-by: Artur Wilczak <arturx.wilczak@intel.com>
1 parent 5124961 commit 3c4a6f7

3 files changed

Lines changed: 247 additions & 0 deletions

File tree

‎case-lib/relay.sh‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
#!/bin/bash
2+
3+
# SPDX-License-Identifier: BSD-3-Clause
4+
# Copyright(c) 2021-2025 Intel Corporation. All rights reserved.
5+
6+
# test-mic_privacy.sh needs to control mic privacy settings (on/off)
7+
# needs usbrelay package: https://github.com/darrylb123/usbrelay
8+
# param1: switch name
9+
# param2: switch state
10+
usbrelay_switch()
11+
{
12+
# Declare a constant for the relay settle time
13+
USBRELAY_SETTLE_TIME=0.5
14+
15+
local switch_name=$1
16+
local state=$2
17+
18+
dlogi "Setting usbrelay switch $switch_name to $state."
19+
usbrelay "$switch_name=$state" > /dev/null || {
20+
# if not detect relays hw module, skip the test
21+
die "Failed to set usbrelay switch $switch_name to $state.
22+
The usbrelay hw module is not responding or no relays detected.
23+
Check hardware connection."
24+
}
25+
26+
# wait for the switch to settle
27+
sleep "$USBRELAY_SETTLE_TIME"
28+
29+
# Display current state of the switch
30+
current_state=$(usbrelay | awk -F= -v name="$switch_name" '$1 == name { print $2 }')
31+
32+
# Check if current_state is equal to the requested state
33+
[[ "$current_state" == "$state" ]] || {
34+
die "usbrelay switch $switch_name failed to set to $state (current: $current_state)"
35+
}
36+
37+
case "$current_state" in
38+
'1') dlogi "Current state of $switch_name is: on";;
39+
'0') dlogi "Current state of $switch_name is: off";;
40+
*) die "Invalid state for $switch_name: $current_state";;
41+
esac
42+
}

‎env-check.sh‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@ func_check_pkg aplay
8787
func_check_pkg sox
8888
func_check_pkg tinycap
8989
func_check_pkg tinyplay
90+
# MIC privacy / JACK Audio detection relay switch
91+
func_check_pkg usbrelay
9092
# JACK Audio Connection Kit
9193
func_check_pkg jackd
9294
func_check_pkg jack_iodelay

‎test-case/test-mic-privacy.sh‎

Lines changed: 203 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,203 @@
1+
#!/bin/bash
2+
3+
# SPDX-License-Identifier: BSD-3-Clause
4+
# Copyright(c) 2025 Intel Corporation. All rights reserved.
5+
6+
##
7+
## Case Name: test-mic-privacy
8+
##
9+
## Preconditions:
10+
## HW managed mode (Only for DMIC PCH and SNDW interfaces).
11+
## This test case requires physical loopback between playback and capture.
12+
## playback <=====> capture
13+
## USB relay switch is connected. The usbrelay app is installed.
14+
## Instruction: https://github.com/darrylb123/usbrelay
15+
##
16+
## Description:
17+
## Run alsabat process perform both playback and capture.
18+
## Enable MIC privacy.
19+
## Run alsabat process perform both playback and capture again.
20+
##
21+
## Case step:
22+
## 1. Specify the pcm IDs for playback and capture
23+
## 2. Check if usbrelay is installed and connected properly.
24+
## 3. Run alsabat process perform both playback and capture.
25+
## 4. Switch relay 1 to enable MIC privacy.
26+
## 5. Run alsabat process perform both playback and capture.
27+
##
28+
## Expect result:
29+
## After step 3 the return value is 0.
30+
## After step 5 the return value is -1001 (no peak be detected).
31+
32+
TESTDIR=$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)
33+
TESTLIB="${TESTDIR}/case-lib"
34+
35+
# shellcheck disable=SC1091 source=case-lib/lib.sh
36+
source "${TESTLIB}/lib.sh"
37+
# shellcheck disable=SC1091 source=case-lib/relay.sh
38+
source "${TESTLIB}/relay.sh"
39+
40+
# remove the existing alsabat wav files
41+
ALSABAT_WAV_FILES="/tmp/mc.wav.*"
42+
rm -f "$ALSABAT_WAV_FILES"
43+
44+
TWO_SECONDS=2
45+
46+
OPT_NAME['p']='pcm_p' OPT_DESC['p']='pcm for playback. Example: hw:0,0'
47+
OPT_HAS_ARG['p']=1 OPT_VAL['p']='hw:0,0'
48+
49+
OPT_NAME['N']='channel_p' OPT_DESC['N']='channel number for playback.'
50+
OPT_HAS_ARG['N']=1 OPT_VAL['N']='2'
51+
52+
OPT_NAME['c']='pcm_c' OPT_DESC['c']='pcm for capture. Example: hw:0,1'
53+
OPT_HAS_ARG['c']=1 OPT_VAL['c']='hw:0,1'
54+
55+
OPT_NAME['C']='channel_c' OPT_DESC['C']='channel number for capture.'
56+
OPT_HAS_ARG['C']=1 OPT_VAL['C']='2'
57+
58+
OPT_NAME['s']='sof-logger' OPT_DESC['s']="Open sof-logger trace the data will store at $LOG_ROOT"
59+
OPT_HAS_ARG['s']=0 OPT_VAL['s']=1
60+
61+
OPT_NAME['r']='rate' OPT_DESC['r']='sample rate'
62+
OPT_HAS_ARG['r']=1 OPT_VAL['r']=48000
63+
64+
OPT_NAME['u']='relay' OPT_DESC['u']='name of usbrelay switch, default value is HURTM_1'
65+
OPT_HAS_ARG['u']=1 OPT_VAL['u']='HURTM_1'
66+
67+
func_opt_parse_option "$@"
68+
69+
pcm_p=${OPT_VAL['p']}
70+
pcm_c=${OPT_VAL['c']}
71+
channel_c=${OPT_VAL['C']}
72+
channel_p=${OPT_VAL['N']}
73+
rate=${OPT_VAL['r']}
74+
relay=${OPT_VAL['u']}
75+
76+
dlogi "Params: pcm_p=$pcm_p, pcm_c=$pcm_c, channel_c=$channel_c, channel_p=$channel_p, rate=$rate, LOG_ROOT=$LOG_ROOT"
77+
78+
__upload_wav_files()
79+
{
80+
# upload the alsabat wav file
81+
for file in $ALSABAT_WAV_FILES; do
82+
# alsabat has a bug where it creates an empty record in playback mode
83+
if test -s "$file"; then
84+
cp -v "$file" "$LOG_ROOT/"
85+
fi
86+
done
87+
}
88+
89+
check_playback_capture()
90+
{
91+
# check if capture and playback work
92+
dlogc "alsabat -P$pcm_p -C$pcm_c -c 2 -r $rate"
93+
alsabat -P"$pcm_p" -C"$pcm_c" -c 2 -r "$rate" || {
94+
# upload failed wav file
95+
__upload_wav_files
96+
die "alsabat failed"
97+
}
98+
}
99+
100+
main()
101+
{
102+
setup_kernel_check_point
103+
104+
start_test
105+
106+
logger_disabled || func_lib_start_log_collect
107+
108+
if [ -z "$pcm_p" ] || [ -z "$pcm_c" ]; then
109+
skip_test "No playback or capture PCM is specified. Skip the $0 test."
110+
fi
111+
112+
# check if usbrelay tool is installed
113+
command -v usbrelay || {
114+
skip_test "usbrelay command not found. Please install usbrelay to control the mic privacy switch."
115+
}
116+
117+
check_locale_for_alsabat
118+
119+
# reset sof volume to 0dB
120+
reset_sof_volume
121+
122+
# If MODEL is defined, set proper gain for the platform
123+
if [ -z "$MODEL" ]; then
124+
# treat as warning only
125+
dlogw "NO MODEL is defined. Please define MODEL to run alsa_settings/MODEL.sh"
126+
else
127+
dlogi "apply alsa settings for alsa_settings/MODEL.sh"
128+
set_alsa_settings "$MODEL"
129+
fi
130+
131+
dlogi "Reset - Turn off the mic privacy"
132+
usbrelay_switch "$relay" 0
133+
134+
# wait for the switch to settle
135+
sleep "$TWO_SECONDS"
136+
137+
# check the PCMs before mic privacy test
138+
dlogi "Check playback/capture before mic privacy test"
139+
check_playback_capture
140+
141+
# Select the first card
142+
first_card_name=$(aplay -l | awk '/^card ([0-9]+)/ {print $3; exit}')
143+
# dump amixer contents always.
144+
# Good case amixer settings is for reference, bad case for debugging.
145+
amixer -c "${first_card_name}" contents > "$LOG_ROOT"/amixer_settings.txt
146+
147+
check_playback_capture
148+
149+
sleep "$TWO_SECONDS"
150+
151+
dlogi "===== Testing: MIC privacy ====="
152+
dlogi "Turn on the mic privacy switch"
153+
usbrelay_switch "$relay" 1
154+
155+
# wait for the switch to settle
156+
sleep "$TWO_SECONDS"
157+
158+
alsabat_output=$(mktemp)
159+
dlogc "alsabat -P$pcm_p -C$pcm_c -c 2 -r $rate"
160+
# Run alsabat and capture both output and exit status
161+
alsabat_status=0
162+
alsabat -P"$pcm_p" -C"$pcm_c" -c 2 -r "$rate" > "$alsabat_output" 2>&1 || {
163+
alsabat_status=$?
164+
}
165+
166+
case "$alsabat_status" in
167+
23)
168+
# alsabat returns 23 if no peak detected (expected for MIC privacy)
169+
if grep -q -e "Amplitude: 0.0; Percentage: \[0\]" -e "Return value is -1001" "$alsabat_output"; then
170+
dlogi "Alsabat output indicates zero signal as expected (MIC privacy works)."
171+
else
172+
dloge "alsabat failed with status $alsabat_status, but signal is not zero."
173+
__upload_wav_files
174+
die "alsabat failed with: $(cat "$alsabat_output")."
175+
fi
176+
;;
177+
0)
178+
dloge "The alsabat command was unexpectedly successful."
179+
__upload_wav_files
180+
die "MIC privacy doesn't work. alsabat output: $(cat "$alsabat_output")"
181+
;;
182+
*)
183+
dloge "The alsabat command failed with unexpected status $alsabat_status."
184+
__upload_wav_files
185+
die "alsabat failed with: $(cat "$alsabat_output")."
186+
;;
187+
esac
188+
189+
dlogi "Turn off the mic privacy switch."
190+
usbrelay_switch "$relay" 0
191+
192+
check_playback_capture
193+
194+
dlogi "===== Test completed successfully. ====="
195+
196+
rm -rf "$alsabat_output"
197+
198+
sof-kernel-log-check.sh "$KERNEL_CHECKPOINT"
199+
}
200+
201+
{
202+
main "$@"; exit "$?"
203+
}

0 commit comments

Comments
 (0)