WIP: Userspace LL ztest

.clang-format

@@ -0,0 +1,181 @@
+# SPDX-License-Identifier: GPL-2.0
+#
+# clang-format configuration file. Intended for clang-format >= 11.
+#
+# For more information, see:
+#
+#   Documentation/dev-tools/clang-format.rst
+#   https://clang.llvm.org/docs/ClangFormat.html
+#   https://clang.llvm.org/docs/ClangFormatStyleOptions.html
+#
+---
+AccessModifierOffset: -4
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlines: Left
+AlignOperands: true
+AlignTrailingComments: false
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: None
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: false
+BinPackArguments: true
+BinPackParameters: true
+BraceWrapping:
+  AfterClass: false
+  AfterControlStatement: false
+  AfterEnum: false
+  AfterFunction: true
+  AfterNamespace: true
+  AfterObjCDeclaration: false
+  AfterStruct: false
+  AfterUnion: false
+  AfterExternBlock: false
+  BeforeCatch: false
+  BeforeElse: false
+  IndentBraces: false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Custom
+BreakBeforeInheritanceComma: false
+BreakBeforeTernaryOperators: false
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeComma
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: false
+ColumnLimit: 120
+CommentPragmas: '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+ConstructorInitializerIndentWidth: 8
+ContinuationIndentWidth: 8
+Cpp11BracedListStyle: false
+DerivePointerAlignment: false
+DisableFormat: false
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: false
+
+# Taken from:
+#   git grep -h '^#define [^[:space:]]*for_each[^[:space:]]*(' include/ tools/ \
+#   | sed "s,^#define \([^[:space:]]*for_each[^[:space:]]*\)(.*$,  - '\1'," \
+#   | LC_ALL=C sort -u
+ForEachMacros:
+  - 'ARRAY_FOR_EACH'
+  - 'ARRAY_FOR_EACH_PTR'
+  - 'FOR_EACH'
+  - 'FOR_EACH_FIXED_ARG'
+  - 'FOR_EACH_IDX'
+  - 'FOR_EACH_IDX_FIXED_ARG'
+  - 'FOR_EACH_NONEMPTY_TERM'
+  - 'FOR_EACH_FIXED_ARG_NONEMPTY_TERM'
+  - 'RB_FOR_EACH'
+  - 'RB_FOR_EACH_CONTAINER'
+  - 'SYS_DLIST_FOR_EACH_CONTAINER'
+  - 'SYS_DLIST_FOR_EACH_CONTAINER_SAFE'
+  - 'SYS_DLIST_FOR_EACH_NODE'
+  - 'SYS_DLIST_FOR_EACH_NODE_SAFE'
+  - 'SYS_SEM_LOCK'
+  - 'SYS_SFLIST_FOR_EACH_CONTAINER'
+  - 'SYS_SFLIST_FOR_EACH_CONTAINER_SAFE'
+  - 'SYS_SFLIST_FOR_EACH_NODE'
+  - 'SYS_SFLIST_FOR_EACH_NODE_SAFE'
+  - 'SYS_SLIST_FOR_EACH_CONTAINER'
+  - 'SYS_SLIST_FOR_EACH_CONTAINER_SAFE'
+  - 'SYS_SLIST_FOR_EACH_NODE'
+  - 'SYS_SLIST_FOR_EACH_NODE_SAFE'
+  - '_WAIT_Q_FOR_EACH'
+  - '_WAIT_Q_FOR_EACH_SAFE'
+  - 'Z_FOR_EACH'
+  - 'Z_FOR_EACH_ENGINE'
+  - 'Z_FOR_EACH_EXEC'
+  - 'Z_FOR_EACH_FIXED_ARG'
+  - 'Z_FOR_EACH_FIXED_ARG_EXEC'
+  - 'Z_FOR_EACH_IDX'
+  - 'Z_FOR_EACH_IDX_EXEC'
+  - 'Z_FOR_EACH_IDX_FIXED_ARG'
+  - 'Z_FOR_EACH_IDX_FIXED_ARG_EXEC'
+  - 'Z_GENLIST_FOR_EACH_CONTAINER'
+  - 'Z_GENLIST_FOR_EACH_CONTAINER_SAFE'
+  - 'Z_GENLIST_FOR_EACH_NODE'
+  - 'Z_GENLIST_FOR_EACH_NODE_SAFE'
+  - 'STRUCT_SECTION_FOREACH'
+  - 'STRUCT_SECTION_FOREACH_ALTERNATE'
+  - 'TYPE_SECTION_FOREACH'
+  - 'K_SPINLOCK'
+  - 'COAP_RESOURCE_FOREACH'
+  - 'COAP_SERVICE_FOREACH'
+  - 'COAP_SERVICE_FOREACH_RESOURCE'
+  - 'HTTP_RESOURCE_FOREACH'
+  - 'HTTP_SERVER_CONTENT_TYPE_FOREACH'
+  - 'HTTP_SERVICE_FOREACH'
+  - 'HTTP_SERVICE_FOREACH_RESOURCE'
+  - 'I3C_BUS_FOR_EACH_I3CDEV'
+  - 'I3C_BUS_FOR_EACH_I2CDEV'
+  - 'MIN_HEAP_FOREACH'
+  - 'comp_dev_for_each_consumer'
+  - 'comp_dev_for_each_consumer_safe'
+  - 'comp_dev_for_each_producer'
+  - 'comp_dev_for_each_producer_safe'
+
+IncludeBlocks: Preserve
+IncludeCategories:
+  - Regex: '.*'
+    Priority: 1
+IncludeIsMainRegex: '(Test)?$'
+IndentCaseLabels: false
+IndentGotoLabels: false
+IndentPPDirectives: None
+IndentWidth: 4
+IndentWrappedFunctionNames: false
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: false
+MacroBlockBegin: ''
+MacroBlockEnd: ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBinPackProtocolList: Auto
+ObjCBlockIndentWidth: 8
+ObjCSpaceAfterProperty: true
+ObjCSpaceBeforeProtocolList: true
+
+# Taken from git's rules
+PenaltyBreakAssignment: 10
+PenaltyBreakBeforeFirstCallParameter: 30
+PenaltyBreakComment: 10
+PenaltyBreakFirstLessLess: 0
+PenaltyBreakString: 10
+PenaltyExcessCharacter: 100
+PenaltyReturnTypeOnItsOwnLine: 60
+
+PointerAlignment: Right
+ReflowComments: false
+SortIncludes: false
+SortUsingDeclarations: false
+SpaceAfterCStyleCast: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: ControlStatementsExceptForEachMacros
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles: false
+SpacesInContainerLiterals: false
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+Standard: Cpp03
+TabWidth: 4
+UseTab: Never
+...

.github/workflows/SPDX-README.md

@@ -1,7 +1,7 @@
 Read this section if there are some SPDX warnings above.
-Pleasing checkpatch is hard when adding new files because:
+Adding correct SPDX headers to new files can be tricky because:
 
-- checkpatch requests a different SPDX style for .c versus .h files.
+- a different SPDX style is expected for .c versus .h files.
   This is because some .h files are included in linker scripts or
   assembly code.
 - Some SOF reviewers reject C99 comments starting with //

.github/workflows/codestyle.yml

@@ -14,45 +14,9 @@ name: codestyle
 # yamllint disable-line rule:truthy
 on: [pull_request, workflow_call, workflow_dispatch]
 
-jobs:
-  checkpatch:
-    runs-on: ubuntu-22.04
-
-    strategy:
-      fail-fast: false
-      matrix:
-        strictness: [null, --subjective]
-
-    env:
-      PR_NUM: ${{github.event.number}}
-      # TODO: reduce duplication with scripts/sof-*-commit-hook.sh
-      # thanks to either some .conf file or some wrapper script
-      CHK_CMD_OPTS: --ignore UNKNOWN_COMMIT_ID --codespell
-
-    steps:
-      # depth 2 so:
-      # ^1. we can show the Subject of the current target branch tip
-      # ^2. we reconnect/graft to the later fetch pull/1234/head,
-      - uses: actions/checkout@v4
-        with: {fetch-depth: 2}
-
-      - name: install codespell
-        run: sudo apt-get -y install codespell && dpkg -L codespell | grep dict
 
-      # See shallowness issue https://github.com/thesofproject/linux/issues/2556
-      - name: fetch PR commits
-        run: |
-           .github/workflows/shallowfetchPRcommits.sh \
-              ${GITHUB_REPOSITORY} "$PR_NUM"
-           # show what we got
-           git --no-pager log --oneline --graph --decorate --max-count=50
-
-      - name: checkpatch
-        env:
-          STRICTNESS: ${{ matrix.strictness }}
-        run: .github/workflows/checkpatch_list.sh ${CHK_CMD_OPTS}
-          ${STRICTNESS} < PR_SHAs.txt
 
+jobs:
   yamllint:
     runs-on: ubuntu-latest
     steps:

.gitignore

@@ -49,7 +49,6 @@ tools/test/audio/reports/*
 tools/test/audio/zeros_in.raw
 
 __pycache__
-.checkpatch-camelcase.git.*
 
 build*/
 

app/boards/qemu_xtensa_dc233c.conf

@@ -3,3 +3,6 @@ CONFIG_IPC_MAJOR_4=y
 CONFIG_ZTEST=y
 CONFIG_MM_DRV=y
 CONFIG_ZEPHYR_NATIVE_DRIVERS=y
+
+# Ensure the kernel can exit QEMU on shutdown/panic
+CONFIG_REBOOT=y

app/boards/qemu_xtensa_dc233c_mmu.conf

@@ -5,3 +5,9 @@ CONFIG_ZTEST=y
 CONFIG_TEST_USERSPACE=y
 CONFIG_MM_DRV=y
 CONFIG_ZEPHYR_NATIVE_DRIVERS=y
+CONFIG_SOF_USERSPACE_LL=y
+CONFIG_SOF_BOOT_TEST_STANDALONE=y
+
+# Ensure the kernel can exit QEMU on shutdown/panic
+CONFIG_REBOOT=y
+CONFIG_ZTEST_STACK_SIZE=4096

app/prj.conf

@@ -50,3 +50,4 @@ CONFIG_SCHED_CPU_MASK=y
 CONFIG_SYS_CLOCK_TICKS_PER_SEC=15000
 CONFIG_DAI=y
 CONFIG_HEAP_MEM_POOL_SIZE=2048
+CONFIG_SPIN_VALIDATE=n

app/src/main.c

@@ -7,6 +7,7 @@
 #include <zephyr/kernel.h>
 #include <sof/boot_test.h>
 #include <zephyr/logging/log.h>
+
 LOG_MODULE_REGISTER(main, LOG_LEVEL_DBG);
 
 /* define qemu boot tests if any qemu target is defined, add targets to end */
@@ -56,12 +57,28 @@ static int sof_app_main(void)
 	return 0;
 }
 
+#if CONFIG_SOF_BOOT_TEST && defined(QEMU_BOOT_TESTS)
+/* cleanly exit qemu so CI can continue and check test results */
+static inline void qemu_xtensa_exit(int status) {
+    register int syscall_id __asm__ ("a2") = 1;      /* SYS_exit is 1 */
+    register int exit_status __asm__ ("a3") = status;
+
+    __asm__ __volatile__ (
+        "simcall\n"
+        :
+        : "r" (syscall_id), "r" (exit_status)
+        : "memory"
+    );
+}
+#endif
+
 #if CONFIG_ZTEST
 void test_main(void)
 {
 	sof_app_main();
 #if CONFIG_SOF_BOOT_TEST && defined(QEMU_BOOT_TESTS)
 	sof_run_boot_tests();
+	qemu_xtensa_exit(0);
 #endif
 }
 #else