Update GOOGLE_RTC_AUDIO_PROCESSING for Zephyr

app/boards/intel_adsp_ace15_mtpm.conf

@@ -20,6 +20,8 @@ CONFIG_PM_POLICY_CUSTOM=y
 CONFIG_POWER_DOMAIN=y
 CONFIG_POWER_DOMAIN_INTEL_ADSP=y
 
+CONFIG_ADSP_IMR_CONTEXT_SAVE=y
+
 # enable Zephyr drivers
 CONFIG_ZEPHYR_NATIVE_DRIVERS=y
 CONFIG_DAI=y
@@ -73,7 +75,9 @@ CONFIG_LL_WATCHDOG=y
 
 # Temporary disabled options
 CONFIG_TRACE=n
+CONFIG_HOST_DMA_RELOAD_DELAY_ENABLE=n
+
 CONFIG_COMP_KPB=y
 CONFIG_COMP_ARIA=y
 CONFIG_CLOCK_CONTROL_ADSP=y
-CONFIG_CLOCK_CONTROL=y
+CONFIG_CLOCK_CONTROL=y

lmdk/README.md

@@ -0,0 +1,15 @@
+# Loadable Modules Dev Kit
+
+***TODO: add link to the documentation repo!***
+
+To build dummy loadable library execute:
+
+    cd libraries/dummy
+    mkdir build
+    cd build
+
+    cmake -DRIMAGE_COMMAND="/path/to/rimage" -DSIGNING_KEY="/path/to/signing/key.pem" ..
+    cmake --build .
+
+Here RIMAGE_COMMAND is path to rimage executable binary, SIGNING_KEY is path to
+signing key for rimage.

lmdk/cmake/build.cmake

@@ -0,0 +1,53 @@
+# This file is intended to be included from project's CMakeLists.txt.
+# Prior to include, MODULES_LIST variable should be initialised with list
+# of modules (subdirectories in modules dir) that should be built into
+# project's loadable library.
+
+if(NOT DEFINED MODULES_LIST)
+  message(FATAL_ERROR "Please define MODULES_LIST: list of modules to be built into loadable library")
+endif()
+
+include(${CMAKE_CURRENT_LIST_DIR}/config.cmake)
+
+foreach(MODULE ${MODULES_LIST})
+  add_executable(${MODULE})
+  add_subdirectory(${LMDK_BASE}/modules/${MODULE} ${MODULE}_module)
+
+###  set_target_properties(${MODULE} PROPERTIES OUTPUT_NAME ${MODULE}.mod)
+
+  target_include_directories(${MODULE} PRIVATE
+    "${LMDK_BASE}/include"
+    "${RIMAGE_INCLUDE_DIR}"
+  )
+
+  # generate linker script
+  get_target_property(HPSRAM_ADDR ${MODULE} HPSRAM_ADDR)
+
+  if(NOT DEFINED HPSRAM_ADDR)
+    message(FATAL_ERROR "Please define HPSRAM_ADDR for module ${MODULE}")
+  endif()
+
+  add_custom_command(TARGET ${MODULE} PRE_LINK
+    COMMAND ${CMAKE_COMMAND}
+      -DMODULE=${MODULE}
+      -DHPSRAM_ADDR=${HPSRAM_ADDR}
+      -P ${CMAKE_CURRENT_LIST_DIR}/ldscripts.cmake
+  )
+
+  target_link_options(${MODULE} PRIVATE
+    "-nostdlib" "-nodefaultlibs"
+    "-Wl,--no-undefined" "-Wl,--unresolved-symbols=report-all" "-Wl,--error-unresolved-symbols"
+    #"-Wl,--gc-sections"	# may remove .bss and that will result in rimage error, do not use for now
+    "-Wl,-Map,$<TARGET_FILE:${MODULE}>.map"	# optional: just for debug
+    "-T" "${MODULE}_ldscripts/elf32xtensa.x"
+  )
+endforeach()
+
+set(RIMAGE_OUTPUT_FILE ${PROJECT_NAME}_noextmft)
+set(OUTPUT_FILE ${PROJECT_NAME}.bin)
+
+add_custom_target(${PROJECT_NAME}_target ALL
+  DEPENDS ${MODULES_LIST}
+  COMMAND ${RIMAGE_COMMAND} -k ${SIGNING_KEY} -f 2.0.0 -b 1 -o ${RIMAGE_OUTPUT_FILE} -c ${TOML} -e ${MODULES_LIST}
+  COMMAND ${CMAKE_COMMAND} -E cat ${RIMAGE_OUTPUT_FILE}.xman ${RIMAGE_OUTPUT_FILE} > ${OUTPUT_FILE}
+)

lmdk/cmake/config.cmake

@@ -0,0 +1,25 @@
+
+if(NOT DEFINED RIMAGE_COMMAND)
+  message(FATAL_ERROR
+    " Please define RIMAGE_COMMAND: path to rimage executable.\n"
+    " E.g. using cmake -DRIMAGE_COMMAND=/path/rimage command line parameter."
+  )
+endif()
+
+if(NOT DEFINED SIGNING_KEY)
+  message(FATAL_ERROR
+    " Please define SIGNING_KEY: path to signing key for rimage.\n"
+    " E.g. using cmake -DSIGNING_KEY=/path/to/key.pem command line parameter."
+  )
+endif()
+
+# This Loadable Modules Dev Kit root dir
+set(LMDK_BASE ${CMAKE_CURRENT_LIST_DIR}/..)
+cmake_path(ABSOLUTE_PATH LMDK_BASE NORMALIZE)
+
+# thesofproject root dir
+set(SOF_BASE ${LMDK_BASE}/..)
+cmake_path(ABSOLUTE_PATH SOF_BASE NORMALIZE)
+
+set(RIMAGE_INCLUDE_DIR ${SOF_BASE}/rimage/src/include)
+cmake_path(ABSOLUTE_PATH RIMAGE_INCLUDE_DIR NORMALIZE)

lmdk/cmake/ldscripts.cmake

@@ -0,0 +1,49 @@
+# Linker scripts generator
+
+# These linker scripts are based on those found in https://github.com/thesofproject/converged-sof-modules
+#
+# There are few things these scripts ensure:
+#
+# (1) Each module has its own reserved (virtual) address space. This is specified as
+# HPSRAM_ADDR in module's CMakeLists.txt and goes to memory_header_linker_script.txt.
+#
+# (2) .buildinfo section must be put at 0 offset of .text section. .buildinfo contains
+# module loadable libraries API version. That API version is verified by base FW.
+# Base FW accesses it simply as 0 offset from module's code.
+#
+# (3) .module section contains module manifest description. This section is used by
+# rimage to generate module manifest. Scripts ensure that this section is not garbage
+# collected by linker.
+
+# Required parameters MODULE and HPSRAM_ADDR should be specified in command line.
+
+if(NOT DEFINED MODULE)
+  message(FATAL_ERROR "MODULE not defined")
+endif()
+
+if(NOT DEFINED HPSRAM_ADDR)
+  message(FATAL_ERROR "HPSRAM_ADDR not defined")
+endif()
+
+# reserve space for manifest?
+math(EXPR HPSRAM "${HPSRAM_ADDR} + 9 * 4096" OUTPUT_FORMAT HEXADECIMAL)
+
+set(LDSCRIPTS_DIR ${MODULE}_ldscripts)
+set(LDSCRIPT_FILE ${LDSCRIPTS_DIR}/elf32xtensa.x)
+
+file(MAKE_DIRECTORY ${LDSCRIPTS_DIR})
+file(WRITE ${LDSCRIPT_FILE} "")
+
+file(APPEND ${LDSCRIPT_FILE} "INCLUDE ${CMAKE_CURRENT_BINARY_DIR}/${LDSCRIPTS_DIR}/memory_header_linker_script.txt\n")
+configure_file(
+  ${CMAKE_CURRENT_LIST_DIR}/ldscripts/memory_header_linker_script.txt.in
+  ${CMAKE_CURRENT_BINARY_DIR}/${LDSCRIPTS_DIR}/memory_header_linker_script.txt
+)
+
+file(APPEND ${LDSCRIPT_FILE} "INCLUDE ${CMAKE_CURRENT_LIST_DIR}/ldscripts/text_linker_script.txt\n")
+file(APPEND ${LDSCRIPT_FILE} "INCLUDE ${CMAKE_CURRENT_LIST_DIR}/ldscripts/common_text_linker_script.txt\n")
+file(APPEND ${LDSCRIPT_FILE} "INCLUDE ${CMAKE_CURRENT_LIST_DIR}/ldscripts/data_linker_script.txt\n")
+file(APPEND ${LDSCRIPT_FILE} "INCLUDE ${CMAKE_CURRENT_LIST_DIR}/ldscripts/common_rodata_linker_script.txt\n")
+file(APPEND ${LDSCRIPT_FILE} "INCLUDE ${CMAKE_CURRENT_LIST_DIR}/ldscripts/bss_linker_script.txt\n")
+file(APPEND ${LDSCRIPT_FILE} "INCLUDE ${CMAKE_CURRENT_LIST_DIR}/ldscripts/xt_linker_script.txt\n")
+file(APPEND ${LDSCRIPT_FILE} "INCLUDE ${CMAKE_CURRENT_LIST_DIR}/ldscripts/guard_linker_script.txt\n")

lmdk/cmake/ldscripts/bss_linker_script.txt

@@ -0,0 +1,20 @@
+
+PHDRS {
+    bss_phdr PT_LOAD;
+}
+
+SECTIONS {
+    max_instances = 1;
+    max_instances-1 = max_instances - 1;
+
+    .bss (NOLOAD) : ALIGN(4096) {
+        _first_start = ABSOLUTE(.);
+        *(.first)
+        _first_end = ABSOLUTE(.);
+        _next_start = ABSOLUTE(.);
+        . += (_first_end - _first_start) * max_instances-1;
+        _next_end = ABSOLUTE(.);
+        *(.bss)
+        *(.bss.*)
+    } >HPSRAM_seg : bss_phdr
+}

lmdk/cmake/ldscripts/common_rodata_linker_script.txt

@@ -0,0 +1,38 @@
+
+PHDRS {
+    rodata_phdr PT_LOAD;
+}
+
+SECTIONS {
+    .common.rodata : ALIGN(4096) {
+        _rodata_start = ABSOLUTE(.);
+        *(.rodata)
+        *(.rodata.*)
+        *(.rodata1)
+        __XT_EXCEPTION_TABLE__ = ABSOLUTE(.);
+        KEEP (*(.xt_except_table))
+        KEEP (*(.gcc_except_table))
+        *(.gnu.linkonce.e.*)
+        *(.gnu.version_r)
+        KEEP (*(.eh_frame))
+        /*  C++ constructor and destructor tables properly ordered:  */
+        KEEP (*crtbegin.o(.ctors))
+        KEEP (*(EXCLUDE_FILE (*crtend.o) .ctors))
+        KEEP (*(SORT(.ctors.*)))
+        KEEP (*(.ctors))
+        KEEP (*crtbegin.o(.dtors))
+        KEEP (*(EXCLUDE_FILE (*crtend.o) .dtors))
+        KEEP (*(SORT(.dtors.*)))
+        KEEP (*(.dtors))
+        /*  C++ exception handlers table:  */
+        __XT_EXCEPTION_DESCS__ = ABSOLUTE(.);
+        *(.xt_except_desc)
+        *(.gnu.linkonce.h.*)
+        __XT_EXCEPTION_DESCS_END__ = ABSOLUTE(.);
+        *(.xt_except_desc_end)
+        *(.dynamic)
+        *(.gnu.version_d)
+        . = ALIGN(4);       /* this table MUST be 4-byte aligned */
+        _rodata_end = ABSOLUTE(.);
+    } >HPSRAM_seg : rodata_phdr
+}

lmdk/cmake/ldscripts/common_text_linker_script.txt

@@ -0,0 +1,24 @@
+
+PHDRS {
+    text_phdr PT_LOAD;
+}
+
+SECTIONS {
+    .common.text : ALIGN(4096){
+        _common_text_start = ABSOLUTE(.);
+        *(.entry.text)
+        *(.init.literal)
+        KEEP(*(.init))
+        *(.literal .text)
+        *(.literal.* .text.*)
+        *(.stub)
+        *(.gnu.warning)
+        *(.gnu.linkonce.literal*)
+        *(.gnu.linkonce.t.*.literal*)
+        *(.gnu.linkonce.t*)
+        *(.fini.literal)
+        KEEP(*(.fini))
+        *(.gnu.version)
+        _common_text_end = ABSOLUTE(.);
+    } >HPSRAM_seg : text_phdr
+}

lmdk/cmake/ldscripts/data_linker_script.txt

@@ -0,0 +1,30 @@
+
+PHDRS {
+    data_phdr PT_LOAD;
+    rodata_phdr PT_LOAD;
+}
+
+EXTERN(HPSRAM)
+
+SECTIONS {
+    .data : ALIGN(4096) {
+        _data_start = ABSOLUTE(.);
+        *(.data)
+        *(.data.*)
+        _data_end = ABSOLUTE(.);
+    } >HPSRAM_seg : data_phdr
+
+    .rodata : ALIGN(4096) {
+        _rodata_start = ABSOLUTE(.);
+        *(.gnu.linkonce.r.*)
+        *(.rodata)
+        *(.rodata.*)
+        KEEP (*(.eh_frame))
+        _rodata_end = ABSOLUTE(.);
+    } >HPSRAM_seg : rodata_phdr
+
+    /* Module manifest is here */
+    .module : ALIGN(4096) {
+        KEEP(*(.module))
+    } >HPSRAM_seg : rodata_phdr
+}

lmdk/cmake/ldscripts/guard_linker_script.txt

@@ -0,0 +1,12 @@
+
+PHDRS {
+    guard_phdr PT_LOAD;
+}
+
+SECTIONS {
+    .guard : ALIGN(4096) {
+        _guard_section_start = ABSOLUTE(.);
+        *(.*)
+        _guard_section_end = ABSOLUTE(.);
+    } >HPSRAM_seg : guard_phdr
+}

lmdk/cmake/ldscripts/memory_header_linker_script.txt.in

@@ -0,0 +1,8 @@
+
+MEMORY {
+    HPSRAM_seg : org = ${HPSRAM}, len = 0xFFFFFFFF
+}
+
+PHDRS {
+    HPSRAM_phdr PT_LOAD;
+}

lmdk/cmake/ldscripts/text_linker_script.txt

@@ -0,0 +1,31 @@
+
+/* EXTERN(${PACKAGE_ENTRY_POINT}) */
+
+PHDRS {
+    text_phdr PT_LOAD;
+    cmi_text_phdr PT_LOAD;
+}
+
+/* .buildinfo should be put at the beginning of .text segment! API version is defined there. */
+
+SECTIONS {
+    .text : ALIGN(4096) {
+        _text_start = ABSOLUTE(.);
+        *(.buildinfo)
+        *(.gnu.linkonce.literal.*)
+        *(.gnu.linkonce.lit4)
+        *(.literal)
+        *(.literal.*)
+        *(.gnu.linkonce.t*)
+        *(.text)
+        *(.text.*)
+        *(.cmi.literal)
+        _text_end = ABSOLUTE(.);
+    } >HPSRAM_seg : text_phdr
+
+    .cmi.text : ALIGN(4096) {
+        _cmi_text_start = ABSOLUTE(.);
+        *(.cmi.text)
+        _cmi_text_end = ABSOLUTE(.);
+    } >HPSRAM_seg : cmi_text_phdr
+}

lmdk/cmake/ldscripts/xt_linker_script.txt

@@ -0,0 +1,55 @@
+
+SECTIONS {
+        .debug  0 :           { *(.debug) }
+        .line  0 :            { *(.line) }
+        .xtensa.info  0 :     { *(.xtensa.info) }
+        .comment  0 :         { *(.comment) }
+        .debug_ranges  0 :    { *(.debug_ranges) }
+        .debug_srcinfo  0 :   { *(.debug_srcinfo) }
+        .debug_sfnames  0 :   { *(.debug_sfnames) }
+        .debug_aranges  0 :   { *(.debug_aranges) }
+        .debug_pubnames  0 :  { *(.debug_pubnames) }
+        .debug_info  0 :      { *(.debug_info) }
+        .debug_abbrev  0 :    { *(.debug_abbrev) }
+        .debug_line  0 :      { *(.debug_line) }
+        .debug_frame  0 :     { *(.debug_frame) }
+        .debug_str  0 :       { *(.debug_str) }
+        .debug_loc  0 :       { *(.debug_loc) }
+        .debug_macinfo  0 :   { *(.debug_macinfo) }
+        .debug_weaknames  0 : { *(.debug_weaknames) }
+        .debug_funcnames  0 : { *(.debug_funcnames) }
+        .debug_typenames  0 : { *(.debug_typenames) }
+        .debug_varnames  0 :  { *(.debug_varnames) }
+        .xt.insn 0 :
+        {
+          KEEP (*(.xt.insn))
+          KEEP (*(.gnu.linkonce.x.*))
+        }
+        .xt.prop 0 :
+        {
+          KEEP (*(.xt.prop))
+          KEEP (*(.xt.prop.*))
+          KEEP (*(.gnu.linkonce.prop.*))
+        }
+        .xt.lit 0 :
+        {
+          KEEP (*(.xt.lit))
+          KEEP (*(.xt.lit.*))
+          KEEP (*(.gnu.linkonce.p.*))
+        }
+        .xt.profile_range 0 :
+        {
+          KEEP (*(.xt.profile_range))
+          KEEP (*(.gnu.linkonce.profile_range.*))
+        }
+        .xt.profile_ranges 0 :
+        {
+          KEEP (*(.xt.profile_ranges))
+          KEEP (*(.gnu.linkonce.xt.profile_ranges.*))
+        }
+        .xt.profile_files 0 :
+        {
+          KEEP (*(.xt.profile_files))
+          KEEP (*(.gnu.linkonce.xt.profile_files.*))
+        }
+}