library manager: initial implementation

src/include/ipc4/module.h

@@ -373,6 +373,37 @@ struct ipc4_module_set_dx {
 	} extension;
 } __attribute__((packed, aligned(4)));
 
+struct ipc4_module_load_library {
+	union {
+ uint32_t dat;
+
+ struct {
+ /* ID of HD/A HO DMA to load the code */
+ uint32_t dma_id : 5;
+ uint32_t rsvd0 : 11;
+ /* ID of library */
+ uint32_t lib_id : 4;
+ uint32_t rsvd1 : 4;
+ /* Global::LOAD_LIBRARY */
+ uint32_t type : 5;
+ /* Msg::MSG_REQUEST */
+ uint32_t rsp : 1;
+ /* Msg::FW_GEN_MSG */
+ uint32_t msg_tgt : 1;
+ uint32_t _reserved_0 : 1;
+ } r;
+	} header;
+
+	union {
+ uint32_t dat;
+
+ struct {
+ uint32_t load_offset : 30;
+ uint32_t _reserved_2 : 2;
+ } r;
+	} data;
+} __packed __aligned(4);
+
 #define IPC4_COMP_ID(x, y)	((x) << 16 | (y))
 #define IPC4_MOD_ID(x) ((x) >> 16)
 #define IPC4_INST_ID(x)	((x) & 0xffff)

src/include/ipc4/notification.h

@@ -56,3 +56,28 @@ enum sof_ipc4_notification_type {
  ((SOF_IPC4_GLB_NOTIFICATION) << (SOF_IPC4_GLB_NOTIFY_MSG_TYPE_SHIFT)))
 
 #endif
+
+/**
+ * \brief IPC MAJOR 4 notification header. All IPC4 notifications use this header.
+ */
+union ipc4_notification_header {
+	uint32_t dat;
+
+	struct {
+ uint32_t rsvd0 : 16;
+
+ /**< Notification::MODULE_EVENT */
+ uint32_t notif_type : 8;
+
+ /**< One of Global::Type */
+ uint32_t type : 5;
+
+ /**< Msg::MSG_REQUEST */
+ uint32_t rsp : 1;
+
+ /**< Msg::FW_GEN_MSG */
+ uint32_t msg_tgt : 1;
+
+ uint32_t _reserved_0 : 1;
+	} r;
+} __packed __aligned(4);

src/include/sof/lib_manager.h

@@ -0,0 +1,194 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ *
+ * Copyright(c) 2022 Intel Corporation. All rights reserved.
+ *
+ * Author: Jaroslaw Stelter <jaroslaw.stelter@intel.com>
+ * Pawel Dobrowolski <pawelx.dobrowolski@intel.com>
+ */
+
+/*
+ * Library manager implementation for SOF is using module adapter API for
+ * loadable native and external libraries. Depends of information received from
+ * it manages memory and locate accordingly to available space.
+ *
+ * Driver IPC4 Library MEMORY ENTITY
+ * Handler Manager VERIF.
+ * | | | | |
+ * | IPC4_GLB_LOAD_LIBRARY | | | |
+ * | --------------------> | lib_manager_load_library() | | |
+ * | | -------------------------> | Prepare DMA transfer | |
+ * | | | ------- | |
+ * | | | | | |
+ * | | | <------ | |
+ * | | | -----------------------> | |
+ * | | | | |
+ * | | | (IF AUTH_API_ENABLED) | |
+ * | | | Verify Manifest | |
+ * | | | -------------------------|-------> |
+ * | | | results | |
+ * | | | <------------------------|-------- |
+ * | | | (IF AUTH_API_ENABLED) | |
+ * | | | | |
+ * | | | Parse Manifest | |
+ * | | | Prepare Storage Memory | |
+ * | | | ------- | |
+ * | | | | | |
+ * | | | <------ | |
+ * | | | | |
+ * | | | Copy Library Data | |
+ * | | | -----------------------> | |
+ * | | | | |
+ * | | | (IF AUTH_API_ENABLED) | |
+ * | | | Verify Manifest | |
+ * | | | -------------------------|-------> |
+ * | | | results | |
+ * | | | <------------------------|-------- |
+ * | | | (IF AUTH_API_ENABLED) | |
+ * | | | | |
+ * | | | Update Library | |
+ * | | | descriptors table | |
+ * | | | ------- | |
+ * | | | | | |
+ * | | | <------ | |
+ * | | return status | | |
+ * | | <------------------------- | | |
+ * | Complete IPC request | | | |
+ * | <------------------- | | | |
+ *
+ * Driver IPC4 Library MEMORY ENTITY
+ * Handler Manager VERIF.
+ */
+
+#ifndef __SOF_LIB_MANAGER_H__
+#define __SOF_LIB_MANAGER_H__
+
+#include <stdint.h>
+#include <rimage/cavs/cavs_ext_manifest.h>
+#include <rimage/sof/user/manifest.h>
+
+#define LIB_MANAGER_MAX_LIBS 16
+#define LIB_MANAGER_LIB_ID_SHIFT 12
+#define LIB_MANAGER_LIB_NOTIX_MAX_COUNT 4
+
+#define LIB_MANAGER_GET_LIB_ID(module_id) ((module_id) >> LIB_MANAGER_LIB_ID_SHIFT)
+#define LIB_MANAGER_GET_MODULE_INDEX(module_id) ((module_id) & 0xFFF)
+
+#ifdef CONFIG_LIBRARY_MANAGER
+struct ipc_lib_msg {
+	struct ipc_msg *msg;
+	struct list_item list;
+};
+
+struct ext_library {
+	struct k_spinlock lock;	/* last locking CPU record */
+	struct sof_man_fw_desc *desc[LIB_MANAGER_MAX_LIBS];
+	uint32_t mods_exec_load_cnt;
+	struct ipc_lib_msg *lib_notif_pool;
+	uint32_t lib_notif_count;
+};
+
+/* lib manager context, used by lib_notification */
+extern struct tr_ctx lib_manager_tr;
+
+static inline struct ext_library *ext_lib_get(void)
+{
+	return sof_get()->ext_library;
+}
+#endif
+
+/*
+ * \brief Initialize library manager
+ */
+void lib_manager_init(void);
+
+/*
+ * \brief Register module on driver list
+ *
+ * param[in] desc - library manifest descriptor
+ * param[in] module_id - used to get manifest offset for module
+ *
+ * Creates new comp_driver_info and initialize it for module from library
+ * Adds new module to sof_get()->comp_drivers list
+ */
+int lib_manager_register_module(struct sof_man_fw_desc *desc, int module_id);
+
+/*
+ * \brief Get library module manifest descriptor
+ *
+ * param[in] module_id - used to get text manifest offset
+ *
+ * Gets firmware manifest descriptor using module_id to locate it
+ */
+struct sof_man_fw_desc *lib_manager_get_library_module_desc(int module_id);
+
+/*
+ * \brief Allocate module
+ *
+ * param[in] drv - component driver
+ * param[in] ipc_config - audio component base configuration from IPC at creation
+ * param[in] ipc_specific_config - ipc4 base configuration
+ *
+ * Function is responsible to allocate module in available free memory and assigning proper address.
+ * (WIP) These feature will contain module validation and proper memory management.
+ */
+uint32_t lib_manager_allocate_module(const struct comp_driver *drv,
+ struct comp_ipc_config *ipc_config,
+ void *ipc_specific_config);
+
+/*
+ * \brief Free module
+ *
+ * param[in] drv - component driver
+ * param[in] ipc_config - audio component base configuration from IPC at creation
+ * param[in] ipc_specific_config - ipc4 base configuration
+ *
+ * Function is responsible to free module resources in HP memory.
+ */
+int lib_manager_free_module(const struct comp_driver *drv,
+ struct comp_ipc_config *ipc_config);
+/*
+ * \brief Load library
+ *
+ * param[in] dma_id - channel used to transfer binary from host
+ * param[in] lib_id
+ *
+ * Function will load library manifest into temporary buffer.
+ * Then it will read library parameters, allocate memory for library and load it into
+ * destination memory region.
+ */
+int lib_manager_load_library(uint32_t dma_id, uint32_t lib_id);
+
+/*
+ * \brief Initialize message
+ *
+ * param[in] header - IPC header provided by caller
+ * param[in] size - size of data buffer for messege to be send
+ *
+ * Function search lib_notif_pool for free message handler.
+ * If not found allocates new message handle and returns it to
+ * caller.
+ */
+struct ipc_msg *lib_notif_msg_init(uint32_t header, uint32_t size);
+
+/*
+ * \brief Send message
+ *
+ * param[in] msg - IPC message handler
+ *
+ * Function sends IPC message and calls lib_notif_msg_clean() to
+ * free unused message handlers. Only single message handle will
+ * be kept in list while at least one loadable module is loaded.
+ */
+void lib_notif_msg_send(struct ipc_msg *msg);
+
+/*
+ * \brief Clean unused message handles
+ *
+ * param[in] leave_one_handle - remove all unused or keep one
+ *
+ * Function search lib_notif_pool list for unused message handles.
+ * Remove them keeping one if leave_one_handle == true.
+ */
+void lib_notif_msg_clean(bool leave_one_handle);
+
+#endif /* __SOF_LIB_MANAGER_H__ */

src/include/sof/sof.h

@@ -101,6 +101,11 @@ struct sof {
 	/* pipelines stream position */
 	struct pipeline_posn *pipeline_posn;
 
+#ifdef CONFIG_LIBRARY_MANAGER
+	/* dynamically loaded libraries */
+	struct ext_library *ext_library;
+#endif
+
 	__aligned(PLATFORM_DCACHE_ALIGN) int alignment[0];
 } __aligned(PLATFORM_DCACHE_ALIGN);
 

src/ipc/ipc-common.c

@@ -190,8 +190,9 @@ void ipc_msg_send(struct ipc_msg *msg, void *data, bool high_priority)
 
 	key = k_spin_lock(&ipc->lock);
 
-	/* copy mailbox data to message */
-	if (msg->tx_size > 0 && msg->tx_size < SOF_IPC_MSG_MAX_SIZE) {
+	/* copy mailbox data to message if not already copied */
+	if ((msg->tx_size > 0 && msg->tx_size < SOF_IPC_MSG_MAX_SIZE) &&
+ msg->tx_data != data) {
  ret = memcpy_s(msg->tx_data, msg->tx_size, data, msg->tx_size);
  assert(!ret);
 	}

src/ipc/ipc4/handler.c

@@ -32,6 +32,8 @@
 #include <user/trace.h>
 
 #include <rtos/kernel.h>
+#include <sof/trace/dma-trace.h>
+#include <sof/lib_manager.h>
 
 #include <errno.h>
 #include <stdbool.h>
@@ -498,6 +500,22 @@ static int ipc4_set_pipeline_state(struct ipc4_message_request *ipc4)
 	return ret;
 }
 
+#if CONFIG_LIBRARY_MANAGER
+static int ipc4_load_library(struct ipc4_message_request *ipc4)
+{
+	struct ipc4_module_load_library library;
+	int ret = IPC4_UNAVAILABLE;
+
+	library.header.dat = ipc4->primary.dat;
+	library.data.dat = ipc4->extension.dat;
+
+	ret = lib_manager_load_library(library.header.r.dma_id, library.header.r.lib_id);
+	tr_info(&ipc_tr, "ipc: ipc4_load_library %d", ret);
+
+	return ret;
+}
+#endif
+
 static int ipc4_process_chain_dma(struct ipc4_message_request *ipc4)
 {
 	struct ipc4_chain_dma cdma;
@@ -569,7 +587,11 @@ static int ipc4_process_glb_message(struct ipc4_message_request *ipc4)
  break;
 
 	/* Loads library (using Code Load or HD/A Host Output DMA) */
+#ifdef CONFIG_LIBRARY_MANAGER
 	case SOF_IPC4_GLB_LOAD_LIBRARY:
+ ret = ipc4_load_library(ipc4);
+ break;
+#endif
 	case SOF_IPC4_GLB_INTERNAL_MESSAGE:
  tr_err(&ipc_tr, "not implemented ipc message type %d", type);
  ret = IPC4_UNAVAILABLE;

src/ipc/ipc4/helper.c

@@ -31,6 +31,8 @@
 #include <ipc4/pipeline.h>
 #include <ipc4/module.h>
 #include <ipc4/error_status.h>
+#include <sof/lib_manager.h>
+
 #include <errno.h>
 #include <stdbool.h>
 #include <stddef.h>
@@ -800,15 +802,39 @@ const struct comp_driver *ipc4_get_comp_drv(int module_id)
 	struct sof_man_module *mod;
 	int entry_index;
 
-	/* module_id 0 is used for base fw which is in entry 1 */
-	if (!module_id)
- entry_index = 1;
-	else
- entry_index = module_id;
+	uint32_t lib_idx = LIB_MANAGER_GET_LIB_ID(module_id);
 
+	if (lib_idx == 0) {
+ /* module_id 0 is used for base fw which is in entry 1 */
+ if (!module_id)
+ entry_index = 1;
+ else
+ entry_index = module_id;
+	} else {
+ /* Library index greater than 0 possible only when LIBRARY_MANAGER
+ * support enabled.
+ */
+#if CONFIG_LIBRARY_MANAGER
+ desc = lib_manager_get_library_module_desc(module_id);
+ entry_index = LIB_MANAGER_GET_MODULE_INDEX(module_id);
+#else
+ tr_err(&comp_tr, "Error: lib index:%d, while loadable libraries are not supported!!!",
+ lib_idx);
+ return NULL;
+#endif
+	}
+	/* Check already registered components */
 	mod = (struct sof_man_module *)((char *)desc + SOF_MAN_MODULE_OFFSET(entry_index));
 	drv = ipc4_get_drv(mod->uuid);
 
+#if CONFIG_LIBRARY_MANAGER
+	if (!drv) {
+ /* New module not registered yet. */
+ lib_manager_register_module(desc, module_id);
+ drv = ipc4_get_drv(mod->uuid);
+	}
+#endif
+
 	return drv;
 }
 

src/library_manager/CMakeLists.txt

@@ -0,0 +1,5 @@
+# SPDX-License-Identifier: BSD-3-Clause
+
+if(CONFIG_LIBRARY_MANAGER)
+ add_local_sources(sof lib_manager.c, lib_notifications.c)
+endif()