log: Add Intel ADSP logging backend

Add logging backend for Intel Audio DSP.

Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>

subsys/logging/CMakeLists.txt

@@ -48,6 +48,11 @@ if(NOT CONFIG_LOG_MINIMAL)
     CONFIG_LOG_MIPI_SYST_ENABLE
     log_output_syst.c
   )
+
+  zephyr_sources_ifdef(
+    CONFIG_LOG_BACKEND_ADSP
+    log_backend_adsp.c
+  )
 else()
   zephyr_sources(log_minimal.c)
 endif()

subsys/logging/Kconfig

@@ -443,7 +443,7 @@ config LOG_BACKEND_NATIVE_POSIX
 
 config LOG_BACKEND_XTENSA_SIM
 	bool "Enable xtensa simulator backend"
-	depends on SOC_XTENSA_SAMPLE_CONTROLLER
+	depends on SOC_XTENSA_SAMPLE_CONTROLLER || SOC_INTEL_APL_ADSP
 	help
 	  Enable backend in xtensa simulator
 
@@ -508,6 +508,27 @@ config LOG_BACKEND_NET_SYST_ENABLE
 
 endif # LOG_BACKEND_NET
 
+config LOG_BACKEND_ADSP
+	bool "Enable Intel ADSP backend"
+	depends on SOC_INTEL_APL_ADSP
+	select RING_BUFFER
+	help
+	  Enable backend in APL ADSP using memory mailbox
+
+if LOG_BACKEND_ADSP
+
+config LOG_BACKEND_ADSP_RINGBUF_BASE
+	hex "Ringbuf base address"
+	help
+	  Address of the ring buffer in the memory.
+
+config LOG_BACKEND_ADSP_RINGBUF_SIZE
+	hex "Size of the ring buffer"
+	help
+	  Size of the ring buffer.
+
+endif # LOG_BACKEND_ADSP
+
 config LOG_BACKEND_SHOW_COLOR
 	bool "Enable colors in the backend"
 	depends on LOG_BACKEND_UART || LOG_BACKEND_NATIVE_POSIX || LOG_BACKEND_RTT \

subsys/logging/log_backend_adsp.c

@@ -0,0 +1,156 @@
+/*
+ * Copyright (c) 2019 Intel Corporation
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <logging/log_backend.h>
+#include <logging/log_core.h>
+#include <logging/log_msg.h>
+#include <logging/log_output.h>
+#include <sys/ring_buffer.h>
+#include <zephyr.h>
+#include <device.h>
+#include <assert.h>
+#include <soc.h>
+
+#define BUF_SIZE 64
+
+BUILD_ASSERT(CONFIG_LOG_BACKEND_ADSP_RINGBUF_SIZE % BUF_SIZE == 0);
+
+static struct ring_buf ringbuf;
+
+/*
+ * Log message format
+ * logging started with magic number 0x55aa followed by lo message id.
+ * Log message ended with null terminator and takes BUF_SIZE slot
+ */
+
+static void init(void)
+{
+	ring_buf_init(&ringbuf, CONFIG_LOG_BACKEND_ADSP_RINGBUF_SIZE,
+		      (void *)CONFIG_LOG_BACKEND_ADSP_RINGBUF_BASE);
+}
+
+static void trace(const u8_t *data, size_t length)
+{
+	const u16_t magic = 0x55aa;
+	static u16_t log_id;
+	volatile u8_t *t, *region;
+	int space;
+	int i;
+
+	space = ring_buf_space_get(&ringbuf);
+	if (space < BUF_SIZE) {
+		u8_t *dummy;
+
+		/* Remove oldest entry */
+		ring_buf_get_claim(&ringbuf, &dummy, BUF_SIZE);
+		ring_buf_get_finish(&ringbuf, BUF_SIZE);
+	}
+
+	ring_buf_put_claim(&ringbuf, (u8_t **)&t, BUF_SIZE);
+	region = t;
+
+	/* Add magic number at the beginning of the slot */
+	*(u16_t *)t = magic;
+	t += 2;
+
+	/* Add log id */
+	*(u16_t *)t = log_id++;
+	t += 2;
+
+	for (i = 0; i < MIN(length, BUF_SIZE - 4); i++) {
+		*t++ = data[i];
+	}
+
+	SOC_DCACHE_FLUSH((void *)region, BUF_SIZE);
+
+	ring_buf_put_finish(&ringbuf, BUF_SIZE);
+}
+
+static int char_out(u8_t *data, size_t length, void *ctx)
+{
+	trace(data, length);
+
+	return length;
+}
+
+/* magic and log id takes space */
+static u8_t buf[BUF_SIZE - 4];
+
+LOG_OUTPUT_DEFINE(log_output, char_out, buf, sizeof(buf));
+
+static void put(const struct log_backend *const backend,
+		struct log_msg *msg)
+{
+	log_msg_get(msg);
+
+	u32_t flags = LOG_OUTPUT_FLAG_LEVEL;
+
+	if (IS_ENABLED(CONFIG_LOG_BACKEND_FORMAT_TIMESTAMP)) {
+		flags |= LOG_OUTPUT_FLAG_FORMAT_TIMESTAMP;
+	}
+
+	log_output_msg_process(&log_output, msg, flags);
+
+	log_msg_put(msg);
+}
+
+static void panic(struct log_backend const *const backend)
+{
+	log_output_flush(&log_output);
+}
+
+static void dropped(const struct log_backend *const backend, u32_t cnt)
+{
+	ARG_UNUSED(backend);
+
+	log_output_dropped_process(&log_output, cnt);
+}
+
+static void sync_string(const struct log_backend *const backend,
+			struct log_msg_ids src_level, u32_t timestamp,
+			const char *fmt, va_list ap)
+{
+	u32_t flags = LOG_OUTPUT_FLAG_LEVEL;
+	u32_t key;
+
+	if (IS_ENABLED(CONFIG_LOG_BACKEND_FORMAT_TIMESTAMP)) {
+		flags |= LOG_OUTPUT_FLAG_FORMAT_TIMESTAMP;
+	}
+
+	key = irq_lock();
+	log_output_string(&log_output, src_level, timestamp, fmt, ap, flags);
+	irq_unlock(key);
+}
+
+static void sync_hexdump(const struct log_backend *const backend,
+			 struct log_msg_ids src_level, u32_t timestamp,
+			 const char *metadata, const u8_t *data, u32_t length)
+{
+	u32_t flags = LOG_OUTPUT_FLAG_LEVEL | LOG_OUTPUT_FLAG_TIMESTAMP;
+	u32_t key;
+
+	if (IS_ENABLED(CONFIG_LOG_BACKEND_FORMAT_TIMESTAMP)) {
+		flags |= LOG_OUTPUT_FLAG_FORMAT_TIMESTAMP;
+	}
+
+	key = irq_lock();
+	log_output_hexdump(&log_output, src_level, timestamp,
+			   metadata, data, length, flags);
+	irq_unlock(key);
+}
+
+const struct log_backend_api log_backend_adsp_api = {
+	.put = IS_ENABLED(CONFIG_LOG_IMMEDIATE) ? NULL : put,
+	.put_sync_string = IS_ENABLED(CONFIG_LOG_IMMEDIATE) ?
+			sync_string : NULL,
+	.put_sync_hexdump = IS_ENABLED(CONFIG_LOG_IMMEDIATE) ?
+			sync_hexdump : NULL,
+	.panic = panic,
+	.init = init,
+	.dropped = IS_ENABLED(CONFIG_LOG_IMMEDIATE) ? NULL : dropped,
+};
+
+LOG_BACKEND_DEFINE(log_backend_adsp, log_backend_adsp_api, true);