check-xrun-injection.sh

#!/bin/bash

##
## Case Name: check-xrun-injection
## Preconditions:
##    Need to enable CONFIG_SND_PCM_XRUN_DEBUG in kenrel config
## Description:
##    check xrun injection during playback/capture
##    default duration is 10s
##    default interval time of xrun injection is 0.5s
## Case step:
##    1. Parse TPLG file to get pipeline
##    2. Specify the audio parameters
##    3. Run aplay or arecord on each pipeline with parameters
##    4. do xrun injection during playback or capture
## Expect result:
##    The return value of aplay/arecord should be 0
##

# shellcheck source=case-lib/lib.sh
source "$(dirname "${BASH_SOURCE[0]}")"/../case-lib/lib.sh

OPT_NAME['t']='tplg'     OPT_DESC['t']="tplg file, default value is env TPLG: $TPLG"
OPT_HAS_ARG['t']=1         OPT_VAL['t']="$TPLG"

OPT_NAME['m']='mode'     OPT_DESC['m']='test mode'
OPT_HAS_ARG['m']=1         OPT_VAL['m']='playback'

OPT_NAME['c']='count' OPT_DESC['c']='test count of xrun injection'
OPT_HAS_ARG['c']=1         OPT_VAL['c']=10

OPT_NAME['i']='interval'     OPT_DESC['i']='interval time of xrun injection'
OPT_HAS_ARG['i']=1         OPT_VAL['i']=0.5

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

func_opt_parse_option "$@"

tplg=${OPT_VAL['t']}
test_mode=${OPT_VAL['m']}
count=${OPT_VAL['c']}
interval=${OPT_VAL['i']}

start_test
logger_disabled || func_lib_start_log_collect

setup_kernel_check_point
func_lib_check_sudo

case $test_mode in
    "playback")
        cmd=aplay
        test_type=p
        dummy_file=/dev/zero
    ;;
    "capture")
        cmd=arecord
        test_type=c
        dummy_file=/dev/null
    ;;
    *)
        die "Invalid test mode: $test_mode (allow value : playback, capture)"
    ;;
esac

func_xrun_injection()
{
    local i=1
    while [ $i -le $count ] && [ "$(ps -p "$pid" --no-header)" ]
    do
        # check aplay/arecord process state
        sof-process-state.sh "$pid" >/dev/null || {
            dloge "aplay/arecord process is in an abnormal status"
            kill_process "$pid" || true
            wait "$pid" 2>/dev/null || true
            exit 1
        }
        dlogi "XRUN injection: $i"
        sudo bash -c "echo '1' > $xrun_injection"
        sleep $interval
        (( i++ ))
    done
}

func_pipeline_export "$tplg" "type:$test_mode"
for idx in $(seq 0 $((PIPELINE_COUNT - 1)))
do
    channel=$(func_pipeline_parse_value "$idx" channel)
    rate=$(func_pipeline_parse_value "$idx" rate)
    fmt=$(func_pipeline_parse_value "$idx" fmt)
    dev=$(func_pipeline_parse_value "$idx" dev)
    pcm=$(func_pipeline_parse_value "$idx" pcm)
    id=$(func_pipeline_parse_value "$idx" id)
    snd=$(func_pipeline_parse_value "$idx" snd)
    pipeline_type=$(func_pipeline_parse_value "$idx" "type")
    pcm=pcm${id}${test_type}
    xrun_injection="/proc/asound/card0/$pcm/sub0/xrun_injection"

    # check xrun injection file
    [[ ! -e $xrun_injection ]] && skip_test "XRUN DEBUG is not enabled in kernel, skip the test."
    dlogi "Testing: test xrun injection on PCM:$pcm,$pipeline_type. Interval time: $interval"
    dlogc "$cmd -D$dev -r $rate -c $channel -f $fmt $dummy_file -q"
    $cmd -D"$dev" -r "$rate" -c "$channel" -f "$fmt" $dummy_file -q &
    pid=$!

    # If the process is terminated too early, this is error case.
    # Typical root causes of the process early termination are
    #     1. soundcard is not enumerated
    #     2. soundcard is enumerated but the PCM device($dev) is not available
    #     3. the device is busy
    #     4. set params fails, etc
    sleep 0.5
    if [[ ! -d /proc/$pid ]]; then
        func_lib_lsof_error_dump "$snd"
        die "$cmd process[$pid] is terminated too early"
    fi

    # do xrun injection
    dlogc "echo 1 > $xrun_injection"
    func_xrun_injection
    # kill aplay/arecord process
    dlogc "kill process: $pid"
    kill_process "$pid" || true
    wait "$pid" 2>/dev/null || true
done

sof-kernel-log-check.sh "$KERNEL_CHECKPOINT"
exit $?