test-compressed-audio: add test

Add test that plays mp3 audio using cplay, and check PC states with
Socwatch

Signed-off-by: Emilia Kurdybelska <emiliax.kurdybelska@intel.com>

Author: ekurdybx

case-lib/lib.sh

@@ -1604,11 +1604,15 @@ analyze_mixed_sound()
     fi
 }
 
-# Generates 20s .mp3 file for testing
-# Arguments: 1 - output filename
+# Generates s 2-channels .mp3 file for testing
+# Arguments:
+# 1 - output filename
+# 2 - duration of the soundfile in seconds
+# 3 - number of channels
 generate_mp3_file()
 {
-    ffmpeg -f lavfi -i "sine=frequency=1000:duration=20" "$1"
+    mkdir -p "$HOME/Music"
+    ffmpeg -f lavfi -i "sine=frequency=1000:duration=$2" -ac "$3" "$1"
 }
 
 # Load socwatch and check if module was loaded correctly
@@ -1636,9 +1640,12 @@ run_with_socwatch()
     local output_file="$1"
     shift 
 
+    # ( set -x
+    #   sudo "$SOCWATCH_PATH"/socwatch -m -n 200 -f cpu-pkg-cstate-res \
+    #   -r json -o "$output_file" -p "$@") ||
+    # die "socwatch returned $?"
     ( set -x
-      sudo "$SOCWATCH_PATH"/socwatch -m -f sys -f cpu -f cpu-hw -f pcie \
-      -f hw-cpu-cstate -f pcd-slps0 -f tcss-state -f tcss -f pcie-lpm -n 200 \
-      -r json -o "$output_file" -p "$@") ||
+      sudo "$SOCWATCH_PATH"/socwatch -m -n 200 -f cpu-pkg-cstate-res \
+      -r json -o "$output_file" -t 60) ||
     die "socwatch returned $?"
 }

test-case/residency-time-test.sh

@@ -56,10 +56,12 @@ check_socwatch_module_loaded()
 check_for_PC10_state()
 {
     pc10_count=$(awk '/Package C-State Summary: Entry Counts/{f=1; next} f && /PC10/{print $3; exit}' "$socwatch_output".csv)
-    if [ -z "$pc10_count" ]; then
-        die "PC10 State not achieved"
+    if [ -z "$pc10_count" ] || [ "$pc10_count" -eq 0 ]; then
+        dlogw "PC10 State not achieved"
+    else
+        dlogi "Entered into PC10 State $pc10_count times"
+        pc10_achieved=true # PC10 state needs to be entered at least once to pass the test
     fi
-    dlogi "Entered into PC10 State $pc10_count times"
 
     pc10_per=$(awk '/Package C-State Summary: Residency/{f=1; next} f && /PC10/{print $3; exit}' "$socwatch_output".csv)
     pc10_time=$(awk '/Package C-State Summary: Residency/{f=1; next} f && /PC10/{print $5; exit}' "$socwatch_output".csv)
@@ -87,8 +89,8 @@ socwatch_test_once()
     setup_kernel_check_point
 
     ( set -x
-      sudo "$SOCWATCH_PATH"/socwatch -m -f sys -f cpu -f cpu-hw -f pcie -f hw-cpu-cstate \
-      -f pcd-slps0 -f tcss-state -f tcss -f pcie-lpm -n 200 -t "$duration" -s "$wait_time" \
+      sudo "$SOCWATCH_PATH"/socwatch -m -f sys -f cpu -f cpu-hw -f hw-cpu-cstate \
+      -f tcss-state -f pcie-lpm -n 200 -t "$duration" -s "$wait_time" \
       -r json -o "$socwatch_output" ) ||
     die "socwatch returned $?"
 
@@ -137,10 +139,15 @@ load_modules()
 
 run_socwatch_tests()
 {
+    # load socwatch module, if the module is loaded, go ahead with the testing
+    sudo bash "$SOCWATCH_PATH"/drivers/insmod-socwatch || true
+    check_socwatch_module_loaded || die "socwatch module not loaded"
+
     # Create a dir for all socwatch reports
     mkdir "$LOG_ROOT/socwatch-results"
     pc10_results_file="$LOG_ROOT/socwatch-results/pc10_results.json"
     touch "$pc10_results_file"
+    pc10_achieved=false
 
     for i in $(seq 1 "$loop_count")
     do
@@ -155,14 +162,21 @@ run_socwatch_tests()
     cd "$LOG_ROOT"
     tar -zcvf socwatch-results.tar.gz socwatch-results/
     rm -rf "$LOG_ROOT/socwatch-results/"
+
+    # unload socwatch module
+    sudo bash "$SOCWATCH_PATH"/drivers/rmmod-socwatch
+
+    if "$pc10_achieved"; then
+        dlogi "PASS: PC10 state entered at least once"
+    else
+        die "FAIL: PC10 state NOT ENTERED"
+    fi
 }
 
 main()
 {
     unload_modules
-    load_socwatch
     run_socwatch_tests
-    unload_socwatch
     load_modules
 }
 

test-case/test-compressed-audio.sh

@@ -0,0 +1,95 @@
+#!/bin/bash
+
+##
+## Case Name: test-compressed-audio
+##
+## Preconditions:
+##    TODO
+##
+## Description:
+##    TODO
+##
+## Case step:
+##    TODO
+##
+## Expect result:
+##    TODO
+##
+
+# shellcheck source=case-lib/lib.sh
+source "$(dirname "${BASH_SOURCE[0]}")"/../case-lib/lib.sh
+
+OPT_NAME['p']='pcm_p'     	    OPT_DESC['p']='compression device for playback. Example: 50'
+OPT_HAS_ARG['p']=1          	OPT_VAL['p']=''
+
+OPT_NAME['N']='channels_p'       OPT_DESC['N']='channel number for playback.'
+OPT_HAS_ARG['N']=1              OPT_VAL['N']='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['d']='duration'        OPT_DESC['d']='duration time for playing the test sound'
+OPT_HAS_ARG['d']=1              OPT_VAL['d']=10
+
+: "${SOCWATCH_PATH:=$HOME/socwatch}"
+
+func_opt_parse_option "$@"
+setup_kernel_check_point
+
+pcm_p=${OPT_VAL['p']}
+channels_p=${OPT_VAL['N']}
+duration=${OPT_VAL['d']}
+
+analyze_socwatch_results()
+{
+    pc_states_file="$LOG_ROOT/pc_states.csv"
+    touch "$pc_states_file"
+    results=$(cat "$socwatch_output".csv | grep "Platform Monitoring Technology CPU Package C-States Residency Summary: Residency" -A 10)
+    echo "$results" | tee "$pc_states_file"
+
+    # expected_results='{"PC0":12.00, "PC2":88, "PC6.1":0, "PC6.2":11, "PC10.1":2, "PC10.2":72, "PC10.3":0}'
+    expected_results='{"PC10.2":80}'
+
+    # Analyze if the % of the time spent in given PC state was as expected
+    if python3 "$SCRIPT_HOME"/tools/analyze-pc-states.py "$pc_states_file" "$expected_results"; then
+        dlogi "All Package Residency (%) values were as expected"
+    else
+        die "Some Package Residency (%) values different from expected!"
+    fi
+}
+
+# Checks for soundfile needed for test, generates missing ones
+prepare_test_soundfile()
+{
+    if [ ! -f "$audio_filename" ]; then
+        dlogi "Generating audio file for the test..."
+        generate_mp3_file "$audio_filename" "$duration" "$channels_p"
+    fi
+}
+
+run_test()
+{
+    audio_filename="$HOME/Music/$channels_p-ch-$duration-s.mp3"
+    prepare_test_soundfile
+
+    socwatch_output="$LOG_ROOT/socwatch-results/socwatch_report"
+
+    play_command=("aplay" "-Dhw:0,0" "Music/test.wav" "-f" "S16_LE" "-c" "2" "-v")
+    # play_command=("cplay" "-c" "0" "-d" "$pcm_p" "-I" "MP3" "${audio_filename}" "-v")
+
+    run_with_socwatch "$socwatch_output" "${play_command[@]}"
+    
+    analyze_socwatch_results
+}
+
+main()
+{
+    export RUN_SOCWATCH=true
+    start_test
+    logger_disabled || func_lib_start_log_collect
+    run_test
+}
+
+{
+    main "$@"; exit "$?"
+}