arch: fw: sof-zephyr overview

Add overview chapter with architecture diagram
that present SOF-Zephyr integration

Signed-off-by: Michal Wasko <[email protected]>

Author: mwasko

architectures/firmware/index.rst

@@ -7,6 +7,7 @@ Firmware Architecture
    :maxdepth: 1
 
    sof-xtos/index
+   sof-zephyr/index
 
 Vendor Specific Architecture Information
 ========================================

architectures/firmware/sof-xtos/overview.rst

@@ -1,9 +1,9 @@
-.. _overview:
+.. _sof-legacy-overview:
 
 Overview
 ##########
 
-Currently SOF has support for the Cadence Xtensa DSP architecture in UP and SMP 
+Currently SOF has support for the Cadence Xtensa DSP architecture in UP and SMP
 modes in the upstream code base.
 
 The diagram below shows the high-level firmware architecture with the
@@ -41,6 +41,6 @@ main sections:
 	`Sound Open Firmware Architecture using Intel Bay Trail Platform`
 
 
-Each section above is well insulated from the other sections by partitioning 
-code into separate directories and by using DSP and platform agnostic generic 
+Each section above is well insulated from the other sections by partitioning
+code into separate directories and by using DSP and platform agnostic generic
 APIs for orchestration between the sections.

architectures/firmware/sof-zephyr/images/overview_diagram.pu

@@ -0,0 +1,42 @@
+@startuml
+allowmixing
+
+scale max 1280 width
+
+package "SOF" {
+
+  package "Application layer - user space" as APPLICATION_LAYER {
+      component "3rd party algorithms" - private" as 3RD_PARTY_ALGOS
+      component "Loadable libraries" as LOADABLE_COMPONENTS
+      component "Built-in Processing components" as BUILTIN_COMPONENTS
+
+      BUILTIN_COMPONENTS -[hidden]right- LOADABLE_COMPONENTS
+      LOADABLE_COMPONENTS -[hidden]right- 3RD_PARTY_ALGOS
+  }
+
+  package "Kernel space" {
+
+    package "Media Processing Pipelines layer - kernel extension" as KERNEL_EXTENSION {
+        component "Communication" as COMMUNICATION
+        component "Pipelines and Component Infrastructure" as PIPELINE_COMPONENT_INFRASTRUCTURE
+        component "AVS Scheduling" as AVS_SCHEDULERS
+
+        COMMUNICATION -[hidden]right- PIPELINE_COMPONENT_INFRASTRUCTURE
+        PIPELINE_COMPONENT_INFRASTRUCTURE -[hidden]right- AVS_SCHEDULERS
+    }
+
+    package "Zephyr RTOS layer" as RTOS {
+        component "Services" as SERVICES
+        component "SoC HAL" as SOC
+        component "Drivers" as DRIVERS
+
+        SERVICES --[hidden]right-- SOC
+        SOC --[hidden]right-- DRIVERS
+    }
+
+    APPLICATION_LAYER -[hidden]down- KERNEL_EXTENSION
+    KERNEL_EXTENSION -[hidden]down- RTOS
+  }
+}
+
+@enduml

architectures/firmware/sof-zephyr/index.rst

@@ -0,0 +1,9 @@
+.. _sof-zephyr:
+
+SOF with Zephyr Architecture
+############################
+
+.. toctree::
+   :maxdepth: 1
+
+   overview

architectures/firmware/sof-zephyr/overview.rst

@@ -0,0 +1,12 @@
+.. _sof-zephyr-overview:
+
+Overview
+########
+
+New SOF firmware architecture is based on Zephyr RTOS and introduce new IPC4
+Host protocol ABI. In result FW has been re-organized into layers. The
+interaction between the components across the layers is limited to the
+internally defined interfaces.
+
+.. uml:: images/overview_diagram.pu
+   :caption: SOF with Zephyr Architecture overview