CMSIS-DAP v2.1 board and target string support.

- Add string fields to board and target structs.
- Update dap_strings.h functions to return board and target strings when available.
- Refactored code in dap_strings.h to use common return_dap_string() utility.

Author: flit

source/daplink/cmsis-dap/dap_strings.h

@@ -20,111 +20,113 @@
 
 #include "cmsis_compiler.h"
 #include "info.h"
+#include "util.h"
+#include "target_board.h"
+
+#if !defined(CMSIS_DAP_PRODUCT_NAME)
+#define CMSIS_DAP_PRODUCT_NAME "DAPLink"
+#endif
+
+//! Maximum output buffer length of all these functions.
+#define MAX_DAP_STR_LEN (60)
+
+//! @brief Utility to copy string to output buffer and return length.
+//!
+//! The source string is limited to the maximum output buffer size defined
+//! by the MAX_DAP_STR_LEN macro.
+static uint8_t return_dap_string(char *dst, const char *src)
+{
+    int length = MIN(MAX_DAP_STR_LEN, strlen(src) + 1);
+    memcpy(dst, src, length);
+    dst[MAX_DAP_STR_LEN - 1] = 0; // Ensure there's a terminating NULL.
+    return length;
+}
 
 /** Get Vendor Name string.
 \param str Pointer to buffer to store the string (max 60 characters).
 \return String length (including terminating NULL character) or 0 (no string).
 */
 __STATIC_INLINE uint8_t DAP_GetVendorString (char *str) {
-  (void)str;
-  return (0U);
+#if defined(CMSIS_DAP_VENDOR_NAME)
+    return return_dap_string(str, CMSIS_DAP_VENDOR_NAME);
+#else
+    (void)str;
+    return (0U);
+#endif
 }
 
 /** Get Product Name string.
 \param str Pointer to buffer to store the string (max 60 characters).
 \return String length (including terminating NULL character) or 0 (no string).
 */
 __STATIC_INLINE uint8_t DAP_GetProductString (char *str) {
-  (void)str;
-  return (0U);
+    return return_dap_string(str, CMSIS_DAP_PRODUCT_NAME);
 }
 
 /** Get Serial Number string.
 \param str Pointer to buffer to store the string (max 60 characters).
 \return String length (including terminating NULL character) or 0 (no string).
 */
 __STATIC_INLINE uint8_t DAP_GetSerNumString (char *str) {
-    const char * data = info_get_unique_id();
-    uint8_t length = (uint8_t)strlen(data) + 1;
-    memcpy(str, data, length);
-    return length;
+    return return_dap_string(str, info_get_unique_id());
 }
 
 /** Get Target Device Vendor string.
 \param str Pointer to buffer to store the string (max 60 characters).
 \return String length (including terminating NULL character) or 0 (no string).
 */
 __STATIC_INLINE uint8_t DAP_GetTargetDeviceVendorString (char *str) {
-#if TARGET_FIXED != 0
-  uint8_t len;
-
-  strcpy(str, TargetDeviceVendor);
-  len = (uint8_t)(strlen(TargetDeviceVendor) + 1U);
-  return (len);
-#else
-  (void)str;
-  return (0U);
-#endif
+    if (g_board_info.target_cfg && g_board_info.target_cfg->target_vendor) {
+        return return_dap_string(str, g_board_info.target_cfg->target_vendor);
+    }
+    else {
+        return (0U);
+    }
 }
 
 /** Get Target Device Name string.
 \param str Pointer to buffer to store the string (max 60 characters).
 \return String length (including terminating NULL character) or 0 (no string).
 */
 __STATIC_INLINE uint8_t DAP_GetTargetDeviceNameString (char *str) {
-#if TARGET_FIXED != 0
-  uint8_t len;
-
-  strcpy(str, TargetDeviceName);
-  len = (uint8_t)(strlen(TargetDeviceName) + 1U);
-  return (len);
-#else
-  (void)str;
-  return (0U);
-#endif
+    if (g_board_info.target_cfg && g_board_info.target_cfg->target_part_number) {
+        return return_dap_string(str, g_board_info.target_cfg->target_part_number);
+    }
+    else {
+        return (0U);
+    }
 }
 
 /** Get Target Board Vendor string.
 \param str Pointer to buffer to store the string (max 60 characters).
 \return String length (including terminating NULL character) or 0 (no string).
 */
 __STATIC_INLINE uint8_t DAP_GetTargetBoardVendorString (char *str) {
-#if TARGET_FIXED != 0
-  uint8_t len;
-
-  strcpy(str, TargetBoardVendor);
-  len = (uint8_t)(strlen(TargetBoardVendor) + 1U);
-  return (len);
-#else
-  (void)str;
-  return (0U);
-#endif
+    if (g_board_info.board_vendor) {
+        return return_dap_string(str, g_board_info.board_vendor);
+    }
+    else {
+        return (0U);
+    }
 }
 
 /** Get Target Board Name string.
 \param str Pointer to buffer to store the string (max 60 characters).
 \return String length (including terminating NULL character) or 0 (no string).
 */
 __STATIC_INLINE uint8_t DAP_GetTargetBoardNameString (char *str) {
-#if TARGET_FIXED != 0
-  uint8_t len;
-
-  strcpy(str, TargetBoardName);
-  len = (uint8_t)(strlen(TargetBoardName) + 1U);
-  return (len);
-#else
-  (void)str;
-  return (0U);
-#endif
+    if (g_board_info.board_name) {
+        return return_dap_string(str, g_board_info.board_name);
+    }
+    else {
+        return (0U);
+    }
 }
 
 /** Get Product Firmware Version string.
 \param str Pointer to buffer to store the string (max 60 characters).
 \return String length (including terminating NULL character) or 0 (no string).
 */
 __STATIC_INLINE uint8_t DAP_GetProductFirmwareVersionString (char *str) {
-    const char * data = info_get_version();
-    uint8_t length = (uint8_t)strlen(data) + 1;
-    memcpy(str, data, length);
-    return length;
+    return return_dap_string(str, info_get_version());
 }

source/target/target_board.h

@@ -55,7 +55,7 @@ enum _board_info_flags {
  * by the device family.
  */
 typedef struct board_info {
-    uint16_t info_version;              /*!< Version number of the board info */ 
+    uint16_t info_version;              /*!< Version number of the board info */
     uint16_t family_id;                 /*!< Use to select or identify target family from defined target family or custom ones */
     char board_id[5];                   /*!< 4-char board ID plus null terminator */
     uint8_t _padding[3];
@@ -76,6 +76,12 @@ typedef struct board_info {
     uint8_t (*target_set_state)(target_state_t state);  /*!< Boards can customize target debug states with precedence over target family */
     uint32_t soft_reset_type;                               /*!< Boards can override software reset type to VECTRESET or SYSRESETREQ */
     //@}
+
+    //! @name CMSIS-DAP v2.1 board strings
+    //@{
+    char *board_vendor; //!< Board vendor. Maximum 60 characters including terminal NULL.
+    char *board_name;   //!< Board name. Maximum 60 characters including terminal NULL.
+    //@}
 } board_info_t;
 
 //! @brief Information describing the board on which DAPLink is running.

source/target/target_config.h

@@ -30,9 +30,9 @@
 
 //! @brief Current target configuration version.
 //!
-//! - Version 0: Initial version.
+//! - Version 1: Initial version.
 enum _target_config_version {
-    kTargetConfigVersion = 0, //!< The current board info version.
+    kTargetConfigVersion = 1, //!< The current board info version.
 };
 
 //! This can vary from target to target and should be in the structure or flash blob
@@ -71,6 +71,15 @@ typedef struct __attribute__((__packed__)) target_cfg {
     uint16_t rt_family_id;                      /*!< If assigned, this is a flexible family ID */
     uint8_t erase_reset;                        /*!< Reset after performing an erase */
     uint8_t pad;
+
+    //! @name CMSIS-DAP v2.1 target strings
+    //@{
+    char *target_vendor;        /*!< Must match the Dvendor attribute value of the CMSIS DFP, excluding the
+                                     colon and vendor code suffix when present. Maximum 60 characters including
+                                     terminal NULL. */
+    char *target_part_number;   /*!< Part number of the target device. Must match the Dname attribute value
+                                     of the device's CMSIS DFP. Maximum 60 characters including terminal NULL. */
+    //@}
 } target_cfg_t;
 
 extern target_cfg_t target_device;