alsa: Add common setup_alsa in ALSA tests

LukaszMrugala · LukaszMrugala · commit 107aeb3ccb40 · 2025-07-07T21:37:09.000Z
All tests using ALSA now use a common setup function,
setup_alsa, which checks locale, resets volume to 0dB,
verifies whether $MODEL has been set
and runs set_alsa_settings.

Signed-off-by: Lukasz Mrugala &lt;lukaszx.mrugala@intel.com&gt;
diff --git a/case-lib/lib.sh b/case-lib/lib.sh
@@ -1231,6 +1231,24 @@ restore_settings_via_alsactl()
     alsactl restore --file="$ALSACTL_STATE_FILE_PATH" --pedantic --no-init-fallback --no-ucm
 }
 
+# One-stop shop to initialise alsa-related stuff for tests using it.
+setup_alsa()
+{
+    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 MODEL-based settings configuration"
+    else
+        #dlogi "apply alsa settings for alsa_settings/MODEL.sh"
+        set_alsa_settings "$MODEL"
+    fi
+}
+
 # check-alsabat.sh need to run optimum alsa control settings
 # param1: platform name
 set_alsa_settings()
diff --git a/test-case/check-alsabat.sh b/test-case/check-alsabat.sh
@@ -81,19 +81,7 @@ then
 	exit 2
 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
+setup_alsa
 
 logger_disabled || func_lib_start_log_collect
 
diff --git a/test-case/check-audio-equalizer.sh b/test-case/check-audio-equalizer.sh
@@ -44,6 +44,7 @@ sofcard=${SOFCARD:-0}
 
 start_test
 setup_kernel_check_point
+setup_alsa
 
 # Test equalizer
 func_test_eq()
diff --git a/test-case/check-capture.sh b/test-case/check-capture.sh
@@ -61,6 +61,7 @@ start_test
 logger_disabled || func_lib_start_log_collect
 
 setup_kernel_check_point
+setup_alsa
 func_lib_check_sudo
 func_pipeline_export "$tplg" "type:capture & ${OPT_VAL['S']}"
 
diff --git a/test-case/check-fw-echo-reference.sh b/test-case/check-fw-echo-reference.sh
@@ -50,7 +50,7 @@ if [ "$PIPELINE_COUNT" != "2" ]; then
     die "Only detect $PIPELINE_COUNT pipeline(s) from topology, but two are needed"
 fi
 
-check_locale_for_alsabat
+setup_alsa
 
 for idx in $(seq 0 $((PIPELINE_COUNT - 1)))
 do
diff --git a/test-case/check-keyword-detection.sh b/test-case/check-keyword-detection.sh
@@ -56,6 +56,8 @@ duration=${OPT_VAL['d']}
 start_test
 logger_disabled || func_lib_start_log_collect
 
+setup_alsa
+
 func_pipeline_export "$tplg" "kpb:any"
 
 if test "$PIPELINE_COUNT" != "1"; then
diff --git a/test-case/check-kmod-load-unload-after-playback.sh b/test-case/check-kmod-load-unload-after-playback.sh
@@ -56,6 +56,8 @@ pb_duration=${OPT_VAL['d']}
 
 start_test
 
+setup_alsa
+
 func_pipeline_export "$tplg" "type:playback"
 
 func_lib_check_sudo
diff --git a/test-case/check-kmod-load-unload.sh b/test-case/check-kmod-load-unload.sh
@@ -40,6 +40,8 @@ setup_kernel_check_point
 
 start_test
 
+setup_alsa
+
 loop_cnt=${OPT_VAL['l']}
 
 PATH="${PATH%%:*}/kmod:$PATH"
diff --git a/test-case/check-pause-release-suspend-resume.sh b/test-case/check-pause-release-suspend-resume.sh
@@ -117,6 +117,8 @@ logger_disabled || func_lib_start_log_collect
 
 setup_kernel_check_point
 
+setup_alsa
+
 dlogi "Entering audio stream expect script with: $cmd -D $pcm -r $rate -c $channel -f $fmt -vv -i $dummy_file -q"
 dlogi "Will enter suspend-resume cycle during paused period of audio stream process"
 
diff --git a/test-case/check-pause-resume.sh b/test-case/check-pause-resume.sh
@@ -80,6 +80,8 @@ esac
 
 logger_disabled || func_lib_start_log_collect
 
+setup_alsa
+
 [[ -z $file_name ]] && file_name=$dummy_file
 
 func_pipeline_export "$tplg" "type:$test_mode & ${OPT_VAL['S']}"
diff --git a/test-case/check-performance.sh b/test-case/check-performance.sh
@@ -45,6 +45,7 @@ start_test
 logger_disabled || func_lib_start_log_collect
 
 setup_kernel_check_point
+setup_alsa
 func_lib_check_sudo
 func_pipeline_export "$tplg" "type:any"
 
diff --git a/test-case/check-playback.sh b/test-case/check-playback.sh
@@ -68,6 +68,9 @@ else
 fi
 
 setup_kernel_check_point
+
+setup_alsa
+
 func_lib_check_sudo
 func_pipeline_export "$tplg" "type:playback & ${OPT_VAL['S']}"
 
diff --git a/test-case/check-runtime-pm-double-active.sh b/test-case/check-runtime-pm-double-active.sh
@@ -73,6 +73,9 @@ APP_LST['capture']='arecord'
 DEV_LST['capture']='/dev/null'
 
 logger_disabled || func_lib_start_log_collect
+
+setup_alsa
+
 func_pipeline_export "$tplg" "type:any"
 
 for idx in $(seq 0 $(expr $PIPELINE_COUNT - 1))
diff --git a/test-case/check-runtime-pm-status.sh b/test-case/check-runtime-pm-status.sh
@@ -69,6 +69,9 @@ APP_LST['capture']='arecord'
 DEV_LST['capture']='/dev/null'
 
 logger_disabled || func_lib_start_log_collect
+
+setup_alsa
+
 func_pipeline_export "$tplg" "type:any"
 
 for idx in $(seq 0 $(expr $PIPELINE_COUNT - 1))
diff --git a/test-case/check-signal-stop-start.sh b/test-case/check-signal-stop-start.sh
@@ -62,6 +62,8 @@ esac
 
 setup_kernel_check_point
 
+setup_alsa
+
 func_stop_start_pipeline()
 {
     local i=1
diff --git a/test-case/check-smart-amplifier.sh b/test-case/check-smart-amplifier.sh
@@ -59,6 +59,8 @@ tplg=${OPT_VAL['t']}
 start_test
 logger_disabled || func_lib_start_log_collect
 
+setup_alsa
+
 func_pipeline_export "$tplg" "smart_amp:any"
 setup_kernel_check_point
 
diff --git a/test-case/check-sof-logger.sh b/test-case/check-sof-logger.sh
@@ -33,6 +33,7 @@ start_test
 type -a sof-logger ||
     die "sof-logger Not Installed!"
 
+setup_alsa
 
 # Checksum a list of files, one filename per stdin line.
 # Whitespace-safe and shellcheck-approved.
@@ -72,7 +73,7 @@ sof_alsa_card_found()
     #   - /proc/asound/sofsoundwire/id
     #   - /proc/asound/sofhdadsp/id
     # - https://github.com/thesofproject/sof-test/issues/1243
-    # Designed to support multiple SOF instances with SOF probes 
+    # Designed to support multiple SOF instances with SOF probes
     for i in /proc/asound/sof*/id; do
         if test -e "$i"; then return 0; fi
     done
diff --git a/test-case/check-suspend-resume-with-audio.sh b/test-case/check-suspend-resume-with-audio.sh
@@ -65,6 +65,8 @@ tplg=${OPT_VAL['t']}
 start_test
 logger_disabled || func_lib_start_log_collect
 
+setup_alsa
+
 # overwrite the subscript: test-case LOG_ROOT environment
 # so when load the test-case in current script
 # the test-case will write the log to the store folder LOG_ROOT
diff --git a/test-case/check-suspend-resume.sh b/test-case/check-suspend-resume.sh
@@ -53,6 +53,8 @@ func_lib_check_sudo
 
 start_test
 
+setup_alsa
+
 type=${OPT_VAL['T']}
 # switch type
 if [ "$type" ]; then
diff --git a/test-case/check-userspace-cardinfo.sh b/test-case/check-userspace-cardinfo.sh
@@ -24,6 +24,8 @@ setup_kernel_check_point
 
 start_test
 
+setup_alsa
+
 # check pulseaudio runs properly or not
 func_lib_check_pa || die "Please check whether pulseaudio runs correctly or not"
 
diff --git a/test-case/check-userspace-paplay.sh b/test-case/check-userspace-paplay.sh
@@ -46,6 +46,8 @@ setup_kernel_check_point
 
 start_test
 
+setup_alsa
+
 round_cnt=${OPT_VAL['r']}
 duration=${OPT_VAL['d']}
 file=${OPT_VAL['f']}
diff --git a/test-case/check-userspace-parecord.sh b/test-case/check-userspace-parecord.sh
@@ -53,6 +53,8 @@ channel=${OPT_VAL['C']}
 
 start_test
 
+setup_alsa
+
 [[ -e $file ]] || { dlogw "$file does not exist, use /dev/zero as dummy playback source" && file=/dev/null; }
 
 # TODO: check the parameter is valid or not
diff --git a/test-case/check-volume-levels.sh b/test-case/check-volume-levels.sh
@@ -289,6 +289,8 @@ do_preparations () {
     dlogi "Capture device is $CAP_HW"
     dlogi "Capture PGA is $CAP_PGA"
 
+    setup_alsa
+
     # Find amixer controls for capture, error if more than one PGA
     numpga=${#CAP_PGA[@]}
     test "$numpga" = 1 || die "Error: more than one capture PGA found."
diff --git a/test-case/check-xrun-injection.sh b/test-case/check-xrun-injection.sh
@@ -45,6 +45,8 @@ interval=${OPT_VAL['i']}
 start_test
 logger_disabled || func_lib_start_log_collect
 
+setup_alsa
+
 setup_kernel_check_point
 func_lib_check_sudo
 
diff --git a/test-case/latency-metrics.sh b/test-case/latency-metrics.sh
@@ -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()
 {
@@ -280,7 +268,7 @@ main()
 
   logger_disabled || func_lib_start_log_collect
 
-  set_alsa
+  setup_alsa
 
   check_jackd_configured
 
diff --git a/test-case/multiple-pipeline.sh b/test-case/multiple-pipeline.sh
@@ -63,6 +63,8 @@ f_arg=${OPT_VAL['f']}
 start_test
 logger_disabled || func_lib_start_log_collect
 
+setup_alsa
+
 # skip the Echo Reference pipeline
 MULTI_PIPELINE_FILTER='~pcm:Amplifier Reference'
 max_count=0
diff --git a/test-case/simultaneous-playback-capture.sh b/test-case/simultaneous-playback-capture.sh
@@ -42,6 +42,8 @@ loop_cnt=${OPT_VAL['l']}
 
 start_test
 
+setup_alsa
+
 # get 'both' pcm, it means pcm have same id with different type
 declare -A tmp_id_lst
 id_lst_str=""
diff --git a/test-case/test-speaker.sh b/test-case/test-speaker.sh
@@ -34,6 +34,8 @@ tplg=${OPT_VAL['t']}
 start_test
 logger_disabled || func_lib_start_log_collect
 
+setup_alsa
+
 func_pipeline_export "$tplg" "type:playback"
 tcnt=${OPT_VAL['l']}
 setup_kernel_check_point
diff --git a/test-case/verify-bootsequence.sh b/test-case/verify-bootsequence.sh
@@ -34,6 +34,8 @@ setup_kernel_check_point
 
 start_test
 
+setup_alsa
+
 main()
 {
     local tmp
diff --git a/test-case/verify-pcm-list.sh b/test-case/verify-pcm-list.sh
@@ -28,6 +28,8 @@ tplg=${OPT_VAL['t']}
 
 start_test
 
+setup_alsa
+
 tplg_path=$(func_lib_get_tplg_path "$tplg") ||
        	die "No available topology for this test case"
 
diff --git a/test-case/verify-sof-firmware-load.sh b/test-case/verify-sof-firmware-load.sh
@@ -23,6 +23,8 @@ disable_kernel_check_point
 
 start_test
 
+setup_alsa
+
 cmd="journalctl_cmd"
 
 dlogi "Checking SOF Firmware load info in kernel log"
diff --git a/test-case/verify-ucm-config.sh b/test-case/verify-ucm-config.sh
@@ -29,6 +29,8 @@ setup_kernel_check_point
 
 start_test
 
+setup_alsa
+
 declare -A verb_array
 
 # get the cards all verbs. The verbs are the items of SectionUseCase in
diff --git a/test-case/volume-basic-test.sh b/test-case/volume-basic-test.sh
@@ -39,6 +39,8 @@ maxloop=${OPT_VAL['l']}
 
 start_test
 
+setup_alsa
+
 [[ -z $tplg ]] && die "Missing tplg file needed to run"
 func_pipeline_export "$tplg" "type:playback"
 logger_disabled || func_lib_start_log_collect
