Skip to content

Commit 7e5bff3

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 7e5bff3

File tree

3 files changed

+233
-0
lines changed

3 files changed

+233
-0
lines changed

‎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: 189 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,189 @@
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+
OPT_NAME['p']='pcm_p' OPT_DESC['p']='pcm for playback. Example: hw:0,0'
45+
OPT_HAS_ARG['p']=1 OPT_VAL['p']='hw:0,0'
46+
47+
OPT_NAME['N']='channel_p' OPT_DESC['N']='channel number for playback.'
48+
OPT_HAS_ARG['N']=1 OPT_VAL['N']='2'
49+
50+
OPT_NAME['c']='pcm_c' OPT_DESC['c']='pcm for capture. Example: hw:0,1'
51+
OPT_HAS_ARG['c']=1 OPT_VAL['c']='hw:0,1'
52+
53+
OPT_NAME['C']='channel_c' OPT_DESC['C']='channel number for capture.'
54+
OPT_HAS_ARG['C']=1 OPT_VAL['C']='2'
55+
56+
OPT_NAME['s']='sof-logger' OPT_DESC['s']="Open sof-logger trace the data will store at $LOG_ROOT"
57+
OPT_HAS_ARG['s']=0 OPT_VAL['s']=1
58+
59+
OPT_NAME['r']='rate' OPT_DESC['r']='sample rate'
60+
OPT_HAS_ARG['r']=1 OPT_VAL['r']=48000
61+
62+
OPT_NAME['u']='relay' OPT_DESC['u']='name of usbrelay switch, default value is HURTM_1'
63+
OPT_HAS_ARG['u']=1 OPT_VAL['u']='HURTM_1'
64+
65+
func_opt_parse_option "$@"
66+
67+
pcm_p=${OPT_VAL['p']}
68+
pcm_c=${OPT_VAL['c']}
69+
channel_c=${OPT_VAL['C']}
70+
channel_p=${OPT_VAL['N']}
71+
rate=${OPT_VAL['r']}
72+
relay=${OPT_VAL['u']}
73+
74+
dlogi "Params: pcm_p=$pcm_p, pcm_c=$pcm_c, channel_c=$channel_c, channel_p=$channel_p, rate=$rate, LOG_ROOT=$LOG_ROOT"
75+
76+
__upload_wav_files()
77+
{
78+
# upload the alsabat wav file
79+
for file in $ALSABAT_WAV_FILES; do
80+
# alsabat has a bug where it creates an empty record in playback mode
81+
if test -s "$file"; then
82+
cp -v "$file" "$LOG_ROOT/"
83+
fi
84+
done
85+
}
86+
87+
check_playback_capture()
88+
{
89+
# check if capture and playback work
90+
dlogc "alsabat -P$pcm_p -C$pcm_c -c 2 -r $rate"
91+
alsabat -P"$pcm_p" -C"$pcm_c" -c 2 -r "$rate" || {
92+
# upload failed wav file
93+
__upload_wav_files
94+
die "alsabat failed"
95+
}
96+
}
97+
98+
main()
99+
{
100+
setup_kernel_check_point
101+
102+
start_test
103+
104+
logger_disabled || func_lib_start_log_collect
105+
106+
if [ -z "$pcm_p" ] || [ -z "$pcm_c" ]; then
107+
skip_test "No playback or capture PCM is specified. Skip the $0 test."
108+
fi
109+
110+
# check if usbrelay tool is installed
111+
command -v usbrelay || {
112+
skip_test "usbrelay command not found. Please install usbrelay to control the mic privacy switch."
113+
}
114+
115+
check_locale_for_alsabat
116+
117+
# reset sof volume to 0dB
118+
reset_sof_volume
119+
120+
# If MODEL is defined, set proper gain for the platform
121+
if [ -z "$MODEL" ]; then
122+
# treat as warning only
123+
dlogw "NO MODEL is defined. Please define MODEL to run alsa_settings/MODEL.sh"
124+
else
125+
dlogi "apply alsa settings for alsa_settings/MODEL.sh"
126+
set_alsa_settings "$MODEL"
127+
fi
128+
129+
dlogi "Reset - Turn off the mic privacy"
130+
usbrelay_switch "$relay" 0
131+
132+
# check the PCMs before mic privacy test
133+
dlogi "check the PCMs before mic privacy test"
134+
aplay -Dplug"$pcm_p" -d 1 /dev/zero -q || die "Failed to play on PCM: $pcm_p"
135+
arecord -Dplug"$pcm_c" -d 1 /dev/null -q || die "Failed to capture on PCM: $pcm_c"
136+
137+
# Select the first card
138+
first_card_name=$(aplay -l | awk '/^card ([0-9]+)/ {print $3; exit}')
139+
# dump amixer contents always.
140+
# Good case amixer settings is for reference, bad case for debugging.
141+
amixer -c "${first_card_name}" contents > "$LOG_ROOT"/amixer_settings.txt
142+
143+
check_playback_capture
144+
145+
dlogi "Turn on the mic privacy switch"
146+
usbrelay_switch "$relay" 1
147+
148+
alsabat_output=$(mktemp)
149+
dlogc "alsabat -P$pcm_p -C$pcm_c -c 2 -r $rate"
150+
# Run alsabat and capture both output and exit status
151+
alsabat_status=0
152+
alsabat -P"$pcm_p" -C"$pcm_c" -c 2 -r "$rate" > "$alsabat_output" 2>&1 || {
153+
alsabat_status=$?
154+
}
155+
156+
case "$alsabat_status" in
157+
23)
158+
# alsabat returns 23 if no peak detected (expected for MIC privacy)
159+
if grep -q -e "Amplitude: 0.0; Percentage: \[0\]" -e "Return value is -1001" "$alsabat_output"; then
160+
dlogi "Alsabat output indicates zero signal as expected (MIC privacy works)."
161+
else
162+
dloge "alsabat failed with status $alsabat_status, but signal is not zero."
163+
__upload_wav_files
164+
die "alsabat failed with: $(cat "$alsabat_output")."
165+
fi
166+
;;
167+
0)
168+
dloge "The alsabat command was unexpectedly successful."
169+
__upload_wav_files
170+
die "MIC privacy doesn't work. alsabat output: $(cat "$alsabat_output")"
171+
;;
172+
*)
173+
dloge "The alsabat command failed with unexpected status $alsabat_status."
174+
__upload_wav_files
175+
die "alsabat failed with: $(cat "$alsabat_output")."
176+
;;
177+
esac
178+
179+
dlogi "Turn off the mic privacy switch."
180+
usbrelay_switch "$relay" 0
181+
182+
check_playback_capture
183+
184+
rm -rf "$alsabat_output"
185+
}
186+
187+
{
188+
main "$@"; exit "$?"
189+
}

0 commit comments

Comments
 (0)