Allow gen-device-svd to handle multi-line device descriptions

Blinkinlabs · Nov 17, 2024 · 52bd80d · 52bd80d
1 parent 3bbfffd
commit 52bd80d
Showing 1 changed file with 11 additions and 4 deletions.
diff --git a/tools/gen-device-svd/gen-device-svd.go b/tools/gen-device-svd/gen-device-svd.go
@@ -445,6 +445,13 @@ func readSVD(path, sourceURL string) (*Device, error) {
 		return interruptList[i].PeripheralIndex < interruptList[j].PeripheralIndex
 	})
 
+	// Properly format the description, with comments.
+	description := ""
+	if text := device.Description; text != "" {
+		description = "//     " + strings.ReplaceAll(text, "\n", "\n//     ")
+		description = regexp.MustCompile(`\s+\n`).ReplaceAllString(description, "\n")
+	}
+
 	// Properly format the license block, with comments.
 	licenseBlock := ""
 	if text := formatText(device.LicenseText); text != "" {
@@ -460,7 +467,7 @@ func readSVD(path, sourceURL string) (*Device, error) {
 		DescriptorSource: sourceURL,
 		Name:             device.Name,
 		NameLower:        nameLower,
-		Description:      strings.TrimSpace(device.Description),
+		Description:      description,
 		LicenseBlock:     licenseBlock,
 	}
 	if device.CPU != nil {
@@ -902,9 +909,9 @@ func writeGo(outdir string, device *Device, interruptSystem string) error {
 
 //go:build {{.pkgName}} && {{.device.Metadata.NameLower}}
 
-/*
+
 {{.device.Metadata.Description}}
-*/
+
 {{.device.Metadata.LicenseBlock}}
 package {{.pkgName}}
 
@@ -1351,7 +1358,7 @@ func writeAsm(outdir string, device *Device) error {
 	t := template.Must(template.New("go").Parse(`// Automatically generated file. DO NOT EDIT.
 // Generated by gen-device-svd.go from {{.File}}, see {{.DescriptorSource}}
 
-// {{.Description}}
+{{.Description}}
 //
 {{.LicenseBlock}}