[VirtIO] Add logging support for core_debug()

Author: kbumsik

cores/arduino/Print.cpp

@@ -28,6 +28,10 @@
 
 #include "Print.h"
 
+#if defined (VIRTIO_LOG)
+#include "virtio_log.h"
+#endif
+
 // Public Methods //////////////////////////////////////////////////////////////
 
 /* default implementation: may be overridden */
@@ -203,10 +207,13 @@ extern "C" {
     switch (file) {
       case STDOUT_FILENO:
       case STDERR_FILENO:
-#if defined(HAL_UART_MODULE_ENABLED) && !defined(HAL_UART_MODULE_ONLY)
         /* Used for core_debug() */
+#if defined (VIRTIO_LOG)
+        virtio_log((uint8_t *)ptr, (uint32_t)len);
+#elif defined(HAL_UART_MODULE_ENABLED) && !defined(HAL_UART_MODULE_ONLY)
         uart_debug_write((uint8_t *)ptr, (uint32_t)len);
 #endif
+        break;
       case STDIN_FILENO:
         break;
       default:

cores/arduino/VirtIOSerial.h

@@ -27,7 +27,6 @@
 #if defined (VIRTIOCON)
 #include "Stream.h"
 #include "openamp.h"
-#include "openamp_log.h"
 #include "wiring.h"
 #include "virtio_buffer.h"
 

cores/arduino/stm32/OpenAMP/openamp_conf.h

@@ -27,10 +27,6 @@
 extern "C" {
 #endif
 
-/* Includes ------------------------------------------------------------------*/
-#if defined (__LOG_TRACE_IO_) || defined(__LOG_UART_IO_)
-#include "openamp_log.h"
-#endif
 /**
  * Note: Do not remove this. Removing this might not trigger compile error but
  * the configuration can be significantly different.

cores/arduino/stm32/OpenAMP/openamp_log.c

@@ -31,13 +31,13 @@
 /* VirtIO rpmsg device id */
 #define VIRTIO_ID_RPMSG       7
 
-#if defined (__LOG_TRACE_IO_)
-extern char system_log_buf[];
+#if defined (VIRTIO_LOG)
+extern char virtio_log_buffer[];
 #endif
 
 const struct shared_resource_table __attribute__((__section__(".resource_table"))) __attribute__((used)) resource_table = {
   .version = 1,
-#if defined (__LOG_TRACE_IO_)
+#if defined (VIRTIO_LOG)
   .num = 2,
 #else
   .num = 1,
@@ -74,13 +74,13 @@ const struct shared_resource_table __attribute__((__section__(".resource_table")
     .notifyid = VRING1_ID,
     .reserved = 0
   },
-#if defined (__LOG_TRACE_IO_)
+#if defined (VIRTIO_LOG)
   .cm_trace = {
     .type = RSC_TRACE,
-    .da = (uint32_t)system_log_buf,
-    .len = SYSTEM_TRACE_BUF_SZ,
+    .da = (uint32_t)virtio_log_buffer,
+    .len = VIRTIO_LOG_BUFFER_SIZE,
     .reserved = 0,
-    .name = "arduino_core_debug",
+    .name = "arduino_log",
   },
 #endif
 } ;

cores/arduino/stm32/OpenAMP/openamp_log.h

@@ -28,4 +28,15 @@
 #endif
 #define RPMSG_VRING_TOTAL_PAYLOAD_SIZE (RPMSG_VRING_PAYLOAD_SIZE * VRING_NUM_BUFFS)
 
+#if defined (VIRTIO_LOG)
+/**
+ * OpenAMP trace (log) buffer configuration.
+ * Users are free to redefine the size if needed.
+ */
+#ifndef VIRTIO_LOG_BUFFER_SIZE
+#define VIRTIO_LOG_BUFFER_SIZE (2048)
+#endif
+
+#endif
+
 #endif // __OPENAMP_VIRTIO_CONFIG_H

cores/arduino/stm32/OpenAMP/rsc_table.c

@@ -0,0 +1,43 @@
+/**
+ * MIT License:
+ * Copyright (c) 2020 Bumsik kim <[email protected]>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+#if defined(VIRTIOCON) && defined(VIRTIO_LOG)
+
+#include "virtio_config.h"
+#include "virtio_log.h"
+
+char virtio_log_buffer[VIRTIO_LOG_BUFFER_SIZE];
+
+void virtio_log(uint8_t *data, uint32_t size)
+{
+  static int offset = 0;
+
+  for (uint32_t i = 0; i < size; i++) {
+    virtio_log_buffer[offset++] = *(data + i);
+    if ((offset + 1) >= VIRTIO_LOG_BUFFER_SIZE) {
+      offset = 0;
+    }
+  }
+  virtio_log_buffer[offset] = '\0';
+}
+
+#endif