Skip to content
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

Jump to bottom

[SKIP CI] Enable check-pause-release-suspend-resume.sh to automatically test all PCMs #760

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

[SKIP CI] Enable check-pause-release-suspend-resume.sh to automatically test all PCMs #760

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f581a64
pause-release-suspend-resume: Extend the sleep time to 500ms
Sep 10, 2021
b35f4db
pause-release-suspend-resume: Parse audio parameters and test for eac…
Sep 15, 2021
fe183b8
pause-release-suspend-resume: Change code to be compatible with GLK
Sep 15, 2021
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
97 changes: 55 additions & 42 deletions test-case/check-pause-release-suspend-resume.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,14 @@ set -e
## Preconditions:
## N/A
## Description:
## test audio stream (playback or capture) with pause/release as well as suspend/resume
## fake pause/release with expect on audio stream process
## Get audio stream pipeline paremeters from the tplg file.
## test audio stream (playback or capture) with pause as well as suspend/resume
## fake pause with expect on audio stream process
## have system enter suspend state for 5 secs
## resume from suspend state
## release audio stream from paused state
## repeat
## repeat to all pipelines
Copy link
Member

Choose a reason for hiding this comment

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

the test description is not clear

line 15: is the stream always paused prior to suspend? Or can this be random/variable?
line 16: can we have multiple streams in parallel? This will be required for our tests, in fact if you see thesofproject/linux#3151 I am precisely having issues with suspend-resume with 2 paused streams.

Copy link
Author

Choose a reason for hiding this comment

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

In this PR, we will first implement a single pipeline test of pause-release-suspend-resume, and then we will re-prove a PR to implement multiple pipeline tests.

## user can use -S option to specify only one PCM to test also.
## Case step:
## 1. audio stream process is started
## 2. audio stream process is then paused via mock spacebar press via expect
Expand Down Expand Up @@ -51,22 +53,16 @@ set -e
## * No unexpected errors should be present in dmesg during or after test
## completion.

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

# shellcheck source=case-lib/lib.sh
source "$CASEDIR"/../case-lib/lib.sh

OPT_NAME['m']='mode' OPT_DESC['m']='test mode. Example: playback; capture'
OPT_HAS_ARG['m']=1 OPT_VAL['m']='playback'

OPT_NAME['p']='pcm' OPT_DESC['p']='audio pcm. Example: hw:0,0'
OPT_HAS_ARG['p']=1 OPT_VAL['p']='hw:0,0'

OPT_NAME['f']='fmt' OPT_DESC['f']='audio format value'
OPT_HAS_ARG['f']=1 OPT_VAL['f']='S16_LE'

OPT_NAME['c']='channel' OPT_DESC['c']='audio channel count'
OPT_HAS_ARG['c']=1 OPT_VAL['c']='2'

OPT_NAME['r']='rate' OPT_DESC['r']='audio rate'
OPT_HAS_ARG['r']=1 OPT_VAL['r']='48000'
OPT_NAME['S']='filter_string' OPT_DESC['S']='run this case on specified pipelines'
OPT_HAS_ARG['S']=1 OPT_VAL['S']='id:any'
Copy link
Collaborator

Choose a reason for hiding this comment

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

You cannot keep the same help message for a new option that works very differently! Maybe: "run test case on pipelines matching the filter argument"

Copy link

Choose a reason for hiding this comment

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

Maybe you can refer to check-pause-resume.sh to keep your options consistent with it.

Copy link
Author

Choose a reason for hiding this comment

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

@marc-hb The -S is used to specify the same PCM ID parameter as -p, so I copy the the help info. I change the option from -p to -S to align with case check-pause-resume.sh that uses -S to specify PCM ID.

Copy link

Choose a reason for hiding this comment

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

Since 'S' is an abbreviation, I think 'filter_string' is a better full name.

Copy link
Collaborator

Choose a reason for hiding this comment

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

OK I got confused because:

  • a first commit changes the option behavior, from aplay argument to topology parser argument without changing its name
  • then a second commit changes its name from -p to -S without changing its help message.

Please change the feature, option name and help message all in the same git commit.


OPT_NAME['F']='file' OPT_DESC['F']='file name. Example: /dev/zero; /dev/null'
OPT_HAS_ARG['F']=1 OPT_VAL['F']=''
Expand All @@ -75,21 +71,24 @@ OPT_NAME['l']='loop' OPT_DESC['l']='loop count'
OPT_HAS_ARG['l']=1 OPT_VAL['l']=5

OPT_NAME['i']='sleep-period' OPT_DESC['i']='sleep period of aplay, unit is ms'
OPT_HAS_ARG['i']=1 OPT_VAL['i']='100'
OPT_HAS_ARG['i']=1 OPT_VAL['i']='500'
Copy link
Member

@plbossart plbossart Sep 14, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

can I ask what platforms? This is a 5x increase, but the intervals between pause_release and pause_push are rather small.

I also don't get why this is different from the regular pause-resume test.

Copy link
Author

Choose a reason for hiding this comment

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

@YongAnLu00 Yongan test the script on his TGLU_SKU0A32_SDCA device and found that 200ms seems still too short, and Marc suggest change the sleep time much longer but still quick like 1se


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['t']='tplg' OPT_DESC['t']='tplg file with complete path, default is environment variable: TPLG'
OPT_HAS_ARG['t']=1 OPT_VAL['t']="$TPLG"

OPT_NAME['T']='type' OPT_DESC['T']="suspend/resume type from /sys/power/mem_sleep"
OPT_HAS_ARG['T']=1 OPT_VAL['T']=""
Copy link
Member

Choose a reason for hiding this comment

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

I was not able to understand what the option means. the 'from' part threw me off, did you mean instead that it would set the suspend/resume type by writing to sysfs?

Copy link
Collaborator

Choose a reason for hiding this comment

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

This option is merely passed passed-through to test-case/check-suspend-resume.sh and the description is merely copied from there (which does not mean it cannot be improved)


This conversation was marked as resolved.
Show resolved Hide resolved
func_opt_parse_option "$@"

pcm=${OPT_VAL['p']}
fmt=${OPT_VAL['f']}
channel=${OPT_VAL['c']}
rate=${OPT_VAL['r']}
repeat_count=${OPT_VAL['l']}
sleep_period=${OPT_VAL['i']}
test_mode=${OPT_VAL['m']}
file_name=${OPT_VAL['F']}
tplg=${OPT_VAL['t']}

This conversation was marked as resolved.
Show resolved Hide resolved
case $test_mode in
"playback")
Expand All @@ -105,31 +104,45 @@ case $test_mode in
;;
esac

[[ -z $file_name ]] && file_name=$dummy_file
if [ -n "${OPT_VAL['T']}" ]; then
suspend_opts="-l 1 -T ${OPT_VAL['T']}"
else
suspend_opts="-l 1"
fi

[[ -z $file_name ]] && file_name=$dummy_file

logger_disabled || func_lib_start_log_collect

setup_kernel_check_point

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"
func_pipeline_export "$tplg" "type:$test_mode & ${OPT_VAL['S']}"

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)

rm -rf /tmp/sof-test.lock
dlogi "Entering audio stream expect script with:
$cmd -D $dev -r $rate -c $channel -f $fmt -vv -i $file_name -q"
dlogi "Will enter suspend-resume cycle during paused period of audio stream process"

# expect is tcl language script
# catch: Evaluate script and trap exceptional returns
# after ms: Ms must be an integer giving a time in milliseconds.
# The command sleeps for ms milliseconds and then returns.
expect <<AUDIO
spawn $cmd -D $pcm -r $rate -c $channel -f $fmt -vv -i $dummy_file -q
# expect is tcl language script
# catch: Evaluate script and trap exceptional returns
# after ms: Ms must be an integer giving a time in milliseconds.
# The command sleeps for ms milliseconds and then returns.
expect <<AUDIO

spawn $cmd -D $dev -r $rate -c $channel -f $fmt -vv -i $file_name -q
set i 1
set sleep_t $sleep_period
expect {
"#*+*\%" {
#audio stream (aplay or arecord) is active now and playing
puts "\r===== (\$i/$repeat_count) pb_pbm: Pause $cmd, then wait for ===== "
puts "\r(\$i/$repeat_count) pb_pbm: $sleep_t ms after pause"
puts "\r(\$i/$repeat_count) pb_pbm: \$sleep_t ms after pause"
send " "
after \$sleep_t
puts "Finished sleep. Confirming $cmd is paused."
Expand All @@ -146,7 +159,7 @@ expect {
}

#enter suspend-resume cycle once per pause instance
set retval [catch { exec bash check-suspend-resume.sh -l 1 } msg]
set retval [catch { exec bash $CASEDIR/check-suspend-resume.sh $suspend_opts } msg]

#prints logs from suspend-resume test
puts \$msg
Expand All @@ -172,13 +185,13 @@ expect {
}
AUDIO

ret=$?
#flush the output
echo
if [ $ret -ne 0 ]; then
sof-process-kill.sh
[[ $? -ne 0 ]] && dlogw "Kill process catch error"
exit $ret
fi
sof-kernel-log-check.sh "$KERNEL_CHECKPOINT"
exit $?
ret=$?
#flush the output
echo
if [ $ret -ne 0 ]; then
sof-process-kill.sh || dlogw "sof-process-kill.sh failed"
exit $ret
fi
sof-kernel-log-check.sh "$KERNEL_CHECKPOINT" || die "Caught error in kernel log"

done