Move log_buff() to virtio_log.c and set a proper name for _LOG_TRACE_IO_

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 */
@@ -197,41 +201,15 @@ size_t Print::println(const Printable &x)
 }
 
 extern "C" {
-#if defined (__LOG_TRACE_IO_)
-  /**
-   * By writing OpenAMP trace (log) buffer here, the Linux host can access
-   * to the content by the following command:
-   *   $ cat /sys/kernel/debug/remoteproc/remoteproc0/trace0
-   * Ceveats - When the buffer overflows (2kb), the buffer is cleaned by
-   * a null character. 2kb will be enough for core_debug() logging.
-   */
-#include "virtio_config.h"
-
-  char system_log_buf[SYSTEM_TRACE_BUF_SZ];
-
-  void log_buff(uint8_t *data, uint32_t size)
-  {
-    static int offset = 0;
-
-    for (uint32_t i = 0; i < size; i++) {
-      system_log_buf[offset++] = *(data + i);
-      if ((offset + 1) >= SYSTEM_TRACE_BUF_SZ) {
-        offset = 0;
-      }
-    }
-    system_log_buf[offset] = '\0';
-  }
-#endif
-
   __attribute__((weak))
   int _write(int file, char *ptr, int len)
   {
     switch (file) {
       case STDOUT_FILENO:
       case STDERR_FILENO:
         /* Used for core_debug() */
-#if defined (__LOG_TRACE_IO_)
-        log_buff((uint8_t *)ptr, (uint32_t)len);
+#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

cores/arduino/stm32/OpenAMP/rsc_table.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/virtio_config.h

@@ -23,10 +23,15 @@
 #define VRING_NUM_BUFFS         16
 #define RPMSG_VRING_TOTAL_PAYLOAD_SIZE (RPMSG_VRING_PAYLOAD_SIZE * VRING_NUM_BUFFS)
 
-#if defined (__LOG_TRACE_IO_)
-// OpenAMP trace (log) buffer configuration. See rsc_table.c and Print.cpp
-#define SYSTEM_TRACE_BUF_SZ 2048
-extern char system_log_buf[SYSTEM_TRACE_BUF_SZ]; /*!< buffer for debug traces */
+#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 // __VIRTIO_CONFIG_H

cores/arduino/stm32/OpenAMP/virtio_log.c

@@ -0,0 +1,43 @@
+/**
+ * MIT License:
+ * Copyright (c) 2020 Bumsik kim <k.bumsik@gmail.com>
+ *
+ * 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

cores/arduino/stm32/OpenAMP/virtio_log.h

@@ -0,0 +1,49 @@
+/**
+ * MIT License:
+ * Copyright (c) 2020 Bumsik kim <k.bumsik@gmail.com>
+ *
+ * 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.
+ */
+#ifndef __VIRTIO_LOG_H
+#define __VIRTIO_LOG_H
+
+#include <stdint.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief Write data to the OpenAMP trace buffer
+ * @note  By writing OpenAMP trace (log) buffer here, the Linux host can access
+ *        to the content by the following command:
+ *          $ cat /sys/kernel/debug/remoteproc/remoteproc0/trace0
+ * @note  When the buffer overflows (2kb by default, configurable.),
+ *        the buffer is cleaned by a null character. Consider increasing
+ *        VIRTIO_LOG_BUFFER_SIZE if a larger log buffer is needed.
+ * @param data: Data to send
+ * @param size: size of data
+ */
+void virtio_log(uint8_t *data, uint32_t size);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // __VIRTIO_LOG_H

platform.txt

@@ -85,7 +85,7 @@ build.pid=0
 # that the preprocessor cannot detect.
 
 # VirtIO RPMsg Serial Flags
-build.virtio_flags=-DVIRTIOCON -DHAL_IPCC_MODULE_ENABLED -DNO_ATOMIC_64_SUPPORT -DMETAL_INTERNAL -DMETAL_MAX_DEVICE_REGIONS=2 -DVIRTIO_SLAVE_ONLY -D__LOG_TRACE_IO_
+build.virtio_flags=-DVIRTIOCON -DHAL_IPCC_MODULE_ENABLED -DNO_ATOMIC_64_SUPPORT -DMETAL_INTERNAL -DMETAL_MAX_DEVICE_REGIONS=2 -DVIRTIO_SLAVE_ONLY -DVIRTIO_LOG
 build.virtio_extra_include="-I{build.system.path}/Middlewares/OpenAMP" "-I{build.system.path}/Middlewares/OpenAMP/open-amp/lib/include" "-I{build.system.path}/Middlewares/OpenAMP/libmetal/lib/include" "-I{build.system.path}/Middlewares/OpenAMP/virtual_driver"
 
 # Build information's