Skip to content

ALSA reset #1284

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.

Sign up for GitHub

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

Merged
golowanow merged 4 commits into from
Aug 1, 2025
Merged

ALSA reset #1284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b0d4855
lib.sh: Reuse set_alsa()
golowanow Jul 23, 2025
250b755
lib.sh: Add log at reset_sof_volume
golowanow Jul 23, 2025
61d513c
check-alsabat.sh: Fix shellcheck warnings
golowanow Jul 23, 2025
549d7ba
lib.sh: Reset ALSA settings at set_alsa()
golowanow Jul 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 65 additions & 9 deletions case-lib/lib.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -828,7 +828,7 @@ set_sof_volume()
tinymix -D"$device" set "$control_name" "$value"
;;
*)
die "Unknown alsa tool $SOF_ALSA_TOOL"
die "Unknown ALSA tool ${SOF_ALSA_TOOL}"
;;
esac
}
Expand All @@ -847,7 +847,7 @@ get_sof_controls()
tinymix --card "$sofcard" controls
;;
*)
die "Unknown alsa tool $SOF_ALSA_TOOL"
die "Unknown ALSA tool ${SOF_ALSA_TOOL}"
;;
esac
}
Expand All @@ -863,7 +863,7 @@ kill_play_record()
pkill -9 tinyplay
;;
*)
die "Unknown alsa tool $SOF_ALSA_TOOL"
die "Unknown ALSA tool ${SOF_ALSA_TOOL}"
;;
esac
}
Expand All @@ -888,7 +888,7 @@ check_alsa_tool_process()
die "tinyplay process is terminated too early"
;;
*)
die "Unknown alsa tool $SOF_ALSA_TOOL"
die "Unknown ALSA tool ${SOF_ALSA_TOOL}"
;;
esac
}
Expand All @@ -911,7 +911,7 @@ aplay_opts()
# shellcheck disable=SC2086
aplay $SOF_ALSA_OPTS $SOF_APLAY_OPTS "$@"
else
die "Unknown ALSA tool: $SOF_ALSA_TOOL"
die "Unknown ALSA tool: ${SOF_ALSA_TOOL}"
fi
}

Expand All @@ -930,7 +930,7 @@ arecord_opts()
# shellcheck disable=SC2086
arecord $SOF_ALSA_OPTS $SOF_ARECORD_OPTS "$@"
else
die "Unknown ALSA tool: $SOF_ALSA_TOOL"
die "Unknown ALSA tool: ${SOF_ALSA_TOOL}"
fi
}

Expand Down Expand Up @@ -1236,16 +1236,72 @@ reset_sof_volume()
get_sof_controls "0" | sed -e "s/^.*'\(.*\)'.*/\1/" |grep -E 'PGA|gain' |
while read -r mixer_name
do
dlogi "Reset volume to ${level_db} on ${mixer_name}"
if [[ "$SOF_ALSA_TOOL" = "alsa" ]]; then
amixer -Dhw:0 -- sset "$mixer_name" "$level_db"
elif [[ "$SOF_ALSA_TOOL" = "tinyalsa" ]]; then
elif [[ "$SOF_ALSA_TOOL" = "tinyalsa" ]]; then
tinymix -D0 set "$mixer_name" "$level_db"
else
echo "Unknown alsa tool $SOF_ALSA_TOOL"
break
die "Unknown ALSA tool ${SOF_ALSA_TOOL}"
fi
done
}

# Initialize and restore ALSA mixer state to the last saved on the DUT,
# reset volume, and apply the HW MODEL-specific settings, if defined.
#
# This initialization procedure assumes that the DUT's ALSA init files,
# UCM2, and default state (/var/lib/alsa/asound.state) are either kept
# unchanged as a 'golden' config, or _mostly_ consistent with the MODEL.
# The latter case is when the alsa-restore service is active on the DUT and
# the state file keeps the last active mixer settings persistent to restore
# them after the DUT's reboot.
# The init files and the persistent state file should diverge not more
# than set_alsa_settings() aligns and should be reset to a 'golden' config
# during the DUT's deployment step of the test plan execution,
# which is external to the test case scope of operations.
#
set_alsa()
{
local alsa_log="${LOG_ROOT}/alsa_setup.log"
local asound_state="${LOG_ROOT}/asound_state"
local rc=0

# Read the ALSA restore service status
systemctl --no-pager status alsa-restore.service > "${alsa_log}" 2>&1 || rc=$?
Copy link
Contributor

@lyakh lyakh Aug 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose you could just rc=$? unconditionally after the systemctl call and remove the initialisation of rc

Copy link
Member Author

@golowanow golowanow Aug 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

right, its my intent to deal with rc explicitly and to tie command calls and rc set, so it is declared as a local variable at this function with init value and, despite any change in the following command calls, it will have the default value.

With command || rc=$? the script works the same way if it runs with bash -e - continue its execution.

Copy link
Collaborator

@marc-hb marc-hb Aug 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could probably do this but && has many pitfalls and is best avoided

systemctl --no-pager status alsa-restore.service > "${alsa_log}" 2>&1 && local rc=$?

@lyakh check the && pitfalls in #312

[[ "${rc}" -ne 0 ]] && dlogw "alsa-restore check error=${rc}" && rc=0
Copy link
Contributor

@lyakh lyakh Aug 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if for whatever reason dlogw exits with an error, rc won't be reset. I'd just use if here for determinism. More of these below, I'd be more explicit with rc

Copy link
Member Author

@golowanow golowanow Aug 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when dlogw fails (something really bad ? hopefully with some stderr output) the rc should not reset to zero as well.

[ -f /lib/systemd/system/alsa-restore.service ] && cat /lib/systemd/system/alsa-restore.service >> "${alsa_log}"

alsactl store -f "${asound_state}_old.txt" 2>&1 || rc=$?
[[ "${rc}" -ne 0 ]] && dlogw "alsactl store error=${rc}" && rc=0

dlogi "Try to initialize all devices to their default ALSA state (alsactl init)."
printf '%s\n' '-vv------- ALSA init -------vv-' >> "${alsa_log}"
alsactl -d init >> "${alsa_log}" 2>&1 || rc=$?
[[ "${rc}" -ne 0 ]] && dlogw "alsactl init error=${rc}" && rc=0
printf '%s\n' '-^^------- ALSA init -------^^-' >> "${alsa_log}"

dlogi "Restore ALSA defaults from /var/lib/alsa/asound.state"
printf '%s\n' '-vv------- Restore ALSA defaults -------vv-' >> "${alsa_log}"
# We don't need in sudo to write our log file, but to call `alsactl`
# shellcheck disable=SC2024
sudo alsactl -d restore >> "${alsa_log}" 2>&1 || rc=$?
[[ "${rc}" -ne 0 ]] && dlogw "alsactl restore error=${rc}" && rc=0
printf '%s\n' '-^^------- Restore ALSA defaults -------^^-' >> "${alsa_log}"

reset_sof_volume

# If MODEL is defined, set proper gain for the platform
if [ -z "$MODEL" ]; then
dlogw "NO MODEL is defined. Please define MODEL to run alsa_settings/\${MODEL}.sh"
else
set_alsa_settings "$MODEL"
fi

alsactl store -f "${asound_state}.txt" 2>&1 || rc=$?
[[ "${rc}" -ne 0 ]] && dlogw "alsactl store error=${rc}"
}

DO_PERF_ANALYSIS=0

perf_analyze()
Expand Down
12 changes: 0 additions & 12 deletions test-case/check-alsa-conformance.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,18 +221,6 @@ select_PCMs()
done
dlogi "Capture devices: ${CAPTURE_DEVICES[*]}"
}

set_alsa()
{
reset_sof_volume

# If MODEL is defined, set proper gain for the platform
if [ -z "$MODEL" ]; then
dlogw "No MODEL is defined. Please define MODEL to run alsa_settings/\${MODEL}.sh"
else
set_alsa_settings "$MODEL"
fi
}

alsa_conformance_device_info()
{
Expand Down
22 changes: 6 additions & 16 deletions test-case/check-alsabat.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,20 +83,10 @@ fi

check_locale_for_alsabat

# reset sof volume to 0dB
reset_sof_volume

# If MODEL is defined, set proper gain for the platform
if [ -z "$MODEL" ]; then
# treat as warning only
dlogw "NO MODEL is defined. Please define MODEL to run alsa_settings/MODEL.sh"
else
#dlogi "apply alsa settings for alsa_settings/MODEL.sh"
set_alsa_settings "$MODEL"
fi

logger_disabled || func_lib_start_log_collect

set_alsa

function __upload_wav_file
{
# upload the alsabat wav file
Expand All @@ -112,13 +102,13 @@ function __upload_wav_file

# check the PCMs before alsabat test
dlogi "check the PCMs before alsabat test"
aplay -Dplug$pcm_p -d 1 /dev/zero -q || die "Failed to play on PCM: $pcm_p"
arecord -Dplug$pcm_c -d 1 /dev/null -q || die "Failed to capture on PCM: $pcm_c"
aplay "-Dplug${pcm_p}" -d 1 /dev/zero -q || die "Failed to play on PCM: ${pcm_p}"
arecord "-Dplug${pcm_c}" -d 1 /dev/null -q || die "Failed to capture on PCM: ${pcm_c}"

# alsabat test
# BT offload PCMs also support mono playback.
dlogc "alsabat -P$pcm_p --standalone -n $frames -r $rate -c $channel_p -f $format -F $frequency -k $sigmak"
alsabat -P$pcm_p --standalone -n $frames -c $channel_p -r $rate -f $format -F $frequency -k $sigmak & playPID=$!
alsabat "-P${pcm_p}" --standalone -n "${frames}" -c "${channel_p}" -r "${rate}" -f "${format}" -F "${frequency}" -k "${sigmak}" & playPID=$!

# playback may have low latency, add one second delay to aviod recording zero at beginning.
sleep 1
Expand All @@ -132,7 +122,7 @@ amixer -c "${first_card_name}" contents > "$LOG_ROOT"/amixer_settings.txt
# We use different USB sound cards in CI, part of them only support 1 channel for capture,
# so make the channel as an option and config it in alsabat-playback.csv
dlogc "alsabat -C$pcm_c -c $channel_c -r $rate -f $format -F $frequency -k $sigmak"
alsabat -C$pcm_c -c $channel_c -r $rate -f $format -F $frequency -k $sigmak || {
alsabat "-C${pcm_c}" -c "${channel_c}" -r "${rate}" -f "${format}" -F "${frequency}" -k "${sigmak}" || {
# upload failed wav file
__upload_wav_file
exit 1
Expand Down
12 changes: 0 additions & 12 deletions test-case/latency-metrics.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,18 +142,6 @@ check_latency_options()
fi
}

set_alsa()
{
reset_sof_volume

# If MODEL is defined, set proper gain for the platform
if [ -z "$MODEL" ]; then
dlogw "NO MODEL is defined. Please define MODEL to run alsa_settings/MODEL.sh"
else
set_alsa_settings "$MODEL"
fi
}

# set/update commands in case the test iterates or sweep over a range
compose_commands()
{
Expand Down