debug: add RTT output support (#899)

Author: mbrossard

source/daplink/daplink_debug.c

@@ -0,0 +1,90 @@
+/**
+ * @file    daplink_debug.c
+ * @brief   optional trace messages useful in development
+ *
+ * DAPLink Interface Firmware
+ * Copyright (c) 2009-2021, Arm Limited, All Rights Reserved
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include <stdarg.h>
+#include <stdio.h>
+#include <string.h>
+#include <stdint.h>
+#include "cmsis_os2.h"
+#include "rl_usb.h"
+#include "util.h"
+
+#if defined (DAPLINK_DEBUG)
+
+#if defined (DAPLINK_DEBUG_RTT)
+
+#include "debug/SEGGER_RTT.c"
+
+uint32_t daplink_debug(uint8_t *buf, uint32_t size)
+{
+    return SEGGER_RTT_Write(0, buf, size);
+}
+
+#else
+
+static const char error_msg[] = "\r\n<OVERFLOW>\r\n";
+
+uint32_t daplink_debug(uint8_t *buf, uint32_t size)
+{
+    uint32_t total_free;
+    uint32_t write_free;
+    uint32_t error_len = strlen(error_msg);
+    total_free = USBD_CDC_ACM_DataFree();
+
+    if (total_free < error_len) {
+        // No space
+        return 0;
+    }
+
+    // Size available for writing
+    write_free = total_free - error_len;
+    size = MIN(write_free, size);
+    USBD_CDC_ACM_DataSend(buf, size);
+
+    if (write_free == size) {
+        USBD_CDC_ACM_DataSend((uint8_t *)error_msg, error_len);
+    }
+
+    return size;
+}
+#endif
+
+static char daplink_debug_buf[128] = {0};
+uint32_t daplink_debug_print(const char *format, ...)
+{
+    uint32_t ret;
+    int32_t r = 0;
+    va_list arg;
+    ret = 1;
+    va_start(arg, format);
+    r = vsnprintf(daplink_debug_buf, sizeof(daplink_debug_buf), format, arg);
+
+    if (r >= sizeof(daplink_debug_buf)) {
+        r = snprintf(daplink_debug_buf, sizeof(daplink_debug_buf), "<Error - string length %i exceeds print buffer>\r\n", r);
+        ret = 0;
+    }
+
+    va_end(arg);
+    daplink_debug((uint8_t *)daplink_debug_buf, r);
+    return ret;
+}
+
+#endif

source/daplink/daplink_debug.h

@@ -3,7 +3,7 @@
  * @brief   optional trace messages useful in development
  *
  * DAPLink Interface Firmware
- * Copyright (c) 2009-2016, ARM Limited, All Rights Reserved
+ * Copyright (c) 2009-2021, Arm Limited, All Rights Reserved
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may
@@ -26,65 +26,19 @@
 #include <stdio.h>
 #include <string.h>
 #include <stdint.h>
-#include "cmsis_os2.h"
-#include "rl_usb.h"
-#include "util.h"
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-#ifndef MSC_DEBUG
-//#define MSC_DEBUG
+#ifndef DAPLINK_DEBUG
+// #define DAPLINK_DEBUG
 #endif
 
-#if defined (MSC_DEBUG)
+#if defined (DAPLINK_DEBUG)
 
-static const char error_msg[] = "\r\n<OVERFLOW>\r\n";
-
-static inline uint32_t daplink_debug(uint8_t *buf, uint32_t size)
-{
-    uint32_t total_free;
-    uint32_t write_free;
-    uint32_t error_len = strlen(error_msg);
-    total_free = USBD_CDC_ACM_DataFree();
-
-    if (total_free < error_len) {
-        // No space
-        return 0;
-    }
-
-    // Size available for writing
-    write_free = total_free - error_len;
-    size = MIN(write_free, size);
-    USBD_CDC_ACM_DataSend(buf, size);
-
-    if (write_free == size) {
-        USBD_CDC_ACM_DataSend((uint8_t *)error_msg, error_len);
-    }
-
-    return size;
-}
-
-static char daplink_debug_buf[128] = {0};
-static inline uint32_t daplink_debug_print(const char *format, ...)
-{
-    uint32_t ret;
-    int32_t r = 0;
-    va_list arg;
-    ret = 1;
-    va_start(arg, format);
-    r = vsnprintf(daplink_debug_buf, sizeof(daplink_debug_buf), format, arg);
-
-    if (r >= sizeof(daplink_debug_buf)) {
-        r = snprintf(daplink_debug_buf, sizeof(daplink_debug_buf), "<Error - string length %i exceeds print buffer>\r\n", r);
-        ret = 0;
-    }
-
-    va_end(arg);
-    daplink_debug((uint8_t *)daplink_debug_buf, r);
-    return ret;
-}
+uint32_t daplink_debug_print(const char *format, ...);
+uint32_t daplink_debug(uint8_t *data, uint32_t size);
 
 #else
 
@@ -103,8 +57,8 @@ static inline uint32_t daplink_debug(uint8_t *data, uint32_t size)
 #define debug_msg(fmt, args...) daplink_debug_print(fmt, ## args);
 #define debug_data(buf, size) daplink_debug(buf, size);
 
-#ifdef __cplusplus
-}
 #endif
 
+#ifdef __cplusplus
+}
 #endif

source/daplink/debug/LICENSE.md

@@ -0,0 +1,36 @@
+
+                    SEGGER Microcontroller GmbH
+                       The Embedded Experts
+
+           (c) 1995 - 2021 SEGGER Microcontroller GmbH
+          www.segger.com     Support: [email protected]
+
+        SEGGER RTT  Real Time Transfer for embedded targets
+
+
+    All rights reserved.
+
+    SEGGER strongly recommends to not make any changes
+    to or modify the source code of this software in order to stay
+    compatible with the RTT protocol and J-Link.
+
+    Redistribution and use in source and binary forms, with or
+    without modification, are permitted provided that the following
+    condition is met:
+
+    - Redistributions of source code must retain the above copyright
+     notice, this condition and the following disclaimer.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+    CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+    MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+    DISCLAIMED. IN NO EVENT SHALL SEGGER Microcontroller BE LIABLE FOR
+    ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+    OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+    OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+    USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+    DAMAGE.