Extend cbridge to support generation as pair - improved (#165)

Author: ZigaMahne

internal/stm32CubeMX/mxDevice.go

@@ -193,80 +193,68 @@ func writeMXdeviceH(contextMap map[string]map[string]string, srcFolder string, m
 		}
 
 		if generatedAsPair == "true" {
-			/* search into file peripheral */
-			if strings.Contains(peripheral, "I2C") {
-				i2c := path.Join(srcFolderAbs, "i2c.c")
-				i2c = filepath.Clean(i2c)
-				i2c = filepath.ToSlash(i2c)
-				fI2C, errI2c := os.Open(i2c)
-				if errI2c != nil {
-					return errI2c
-				} else {
-					i2cInfo, err = getI2cInfo(fI2C, peripheral)
-					if err != nil {
-						return err
-					}
-					pins, err = getPins(contextMap, fI2C, peripheral)
-					if err != nil {
-						return err
-					}
-					defer fI2C.Close()
-				}
-			} else if strings.Contains(peripheral, "USB") {
-				usbFileName := "usb.c"
-				if strings.Contains(peripheral, "OTG") {
-					usbFileName = "usb_otg.c"
-				}
-				usb := path.Join(srcFolderAbs, usbFileName)
-				usb = filepath.Clean(usb)
-				usb = filepath.ToSlash(usb)
-				fUsb, errUsb := os.Open(usb)
-				if errUsb != nil {
-					return errUsb
-				} else {
-					usbHandle, err = getUSBHandle(fUsb, peripheral)
-					if err != nil {
-						return err
-					}
-					pins, err = getPins(contextMap, fUsb, peripheral)
-					if err != nil {
-						return err
+
+			periName := map[string]string{
+				"USART":  "usart.c",
+				"UART":   "usart.c",
+				"LPUART": "usart.c",
+				"SPI":    "spi.c",
+				"I2C":    "i2c.c",
+				"ETH":    "eth.c",
+				"SDMMC":  "sdmmc.c",
+				"CAN":    "can.c",
+				"USB":    "usb.c",
+				"SDIO":   "sdio.c"}
+
+			for key, value := range periName {
+				/* search for peripherals to handle pins*/
+				if strings.Contains(peripheral, key) {
+					fileName := value
+					if strings.Contains(peripheral, "OTG") {
+						fileName = "usb_otg.c"
+					} else if strings.Contains(peripheral, "FD") {
+						fileName = "fdcan.c"
 					}
-					defer fUsb.Close()
-				}
-			} else if strings.Contains(peripheral, "SDMMC") {
-				mmc := path.Join(srcFolderAbs, "sdmmc.c")
-				mmc = filepath.Clean(mmc)
-				mmc = filepath.ToSlash(mmc)
-				fMMC, errMmc := os.Open(mmc)
-				if errMmc != nil {
-					return errMmc
-				} else {
-					mciMode, err = getMCIMode(fMMC, peripheral)
-					if err != nil {
-						return err
+					periPath := path.Join(srcFolderAbs, fileName)
+					periPath = filepath.Clean(periPath)
+					periPath = filepath.ToSlash(periPath)
+					fPeri, errPeri := os.Open(periPath)
+					if errPeri != nil {
+						return errPeri
+					} else {
+						pins, err = getPins(contextMap, fPeri, peripheral)
+						if err != nil {
+							return err
+						}
 					}
-					pins, err = getPins(contextMap, fMMC, peripheral)
-					if err != nil {
-						return err
+					/* peripherals custom infos */
+					if strings.Contains(peripheral, "I2C") {
+						i2cInfo, err = getI2cInfo(fPeri, peripheral)
+						if err != nil {
+							return err
+						}
+					} else if strings.Contains(peripheral, "USB") {
+						usbHandle, err = getUSBHandle(fPeri, peripheral)
+						if err != nil {
+							return err
+						}
+					} else if strings.Contains(peripheral, "SDMMC") {
+						mciMode, err = getMCIMode(fPeri, peripheral)
+						if err != nil {
+							return err
+						}
+					} else if strings.Contains(peripheral, "SDIO") {
+						mciMode, err = getMCIMode(fPeri, peripheral)
+						if err != nil {
+							return err
+						}
+					} else if strings.Contains(peripheral, "SPI") {
+						if freq == "" {
+							freq = getSPIFreq(fPeri, contextMap, peripheral)
+						}
 					}
-					defer fMMC.Close()
-				}
-			} else if strings.Contains(peripheral, "SPI") {
-				spi := path.Join(srcFolderAbs, "spi.c")
-				spi = filepath.Clean(spi)
-				spi = filepath.ToSlash(spi)
-				fSPI, errSpi := os.Open(spi)
-				if errSpi != nil {
-					return errSpi
-				}
-				defer fSPI.Close()
-				pins, err = getPins(contextMap, fSPI, peripheral)
-				if err != nil {
-					return err
-				}
-				if freq == "" {
-					freq = getSPIFreq(fSPI, contextMap, peripheral)
+					defer fPeri.Close()
+					break
 				}
 			}
 		} else {

internal/stm32CubeMX/mxDevice_test.go

@@ -12,11 +12,92 @@ import (
 	"errors"
 	"io"
 	"os"
+	"path/filepath"
 	"reflect"
+	"strings"
 	"testing"
 	"time"
 )
 
+func Test_MXDeviceContexts(t *testing.T) {
+
+	tests := []struct {
+		name       string
+		cfgPath    string
+		cfgName    string
+		cfgRefName string
+		wantErr    bool
+	}{
+		{"STM32H7_SC", "STM32H7_SC/STM32CubeMX/device/MX_Device/", "MX_Device.h", "MX_Device_ref.h", false},
+		{"STM32H7_DC:CM4", "STM32H7_DC/STM32CubeMX/STM32H745BGTx/MX_Device/CM4/", "MX_Device.h", "MX_Device_ref.h", false},
+		{"STM32H7_DC:CM7", "STM32H7_DC/STM32CubeMX/STM32H745BGTx/MX_Device/CM7/", "MX_Device.h", "MX_Device_ref.h", false},
+		{"STM32U5_noTZ", "STM32U5_noTZ/STM32CubeMX/Board/MX_Device/", "MX_Device.h", "MX_Device_ref.h", false},
+		{"STM32U5_TZ:NonSecure", "STM32U5_TZ/STM32CubeMX/Board/MX_Device/NonSecure/", "MX_Device.h", "MX_Device_ref.h", false},
+		{"STM32U5_TZ:Secure", "STM32U5_TZ/STM32CubeMX/Board/MX_Device/Secure/", "MX_Device.h", "MX_Device_ref.h", false},
+		{"STM32WL_DC:CM0PLUS", "STM32WL_DC/test/STM32CubeMX/STM32WL54CCUx/MX_Device/CM0PLUS/", "MX_Device.h", "MX_Device_ref.h", false},
+		{"STM32WL_DC:CM4", "STM32WL_DC/test/STM32CubeMX/STM32WL54CCUx/MX_Device/CM4/", "MX_Device.h", "MX_Device_ref.h", false},
+		{"STM32H5", "STM32H5/STM32CubeMX/STM32H573IIKxQ/MX_Device/", "MX_Device.h", "MX_Device_ref.h", false},
+		{"STM32H7", "STM32H7/STM32CubeMX/STM32H743XIHx/MX_Device/", "MX_Device.h", "MX_Device_ref.h", false},
+		{"STM32F7", "STM32F7/STM32CubeMX/STM32F746NGHx/MX_Device/", "MX_Device.h", "MX_Device_ref.h", false},
+		{"STM32U5", "STM32U5/STM32CubeMX/STM32U5G9ZJTxQ/MX_Device/", "MX_Device.h", "MX_Device_ref.h", false},
+		{"STM32F2", "STM32F2/STM32CubeMX/STM32F217IGHx/MX_Device/", "MX_Device.h", "MX_Device_ref.h", false},
+		{"STM32F4", "STM32F4/STM32CubeMX/STM32F469NIHx/MX_Device/", "MX_Device.h", "MX_Device_ref.h", false},
+		{"STM32G4", "STM32G4/STM32CubeMX/STM32G474QETx/MX_Device/", "MX_Device.h", "MX_Device_ref.h", false},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+
+			tt.cfgPath = filepath.Join("../../testdata/testExamples/", tt.cfgPath)
+
+			data, err := os.ReadFile(filepath.Join(tt.cfgPath, tt.cfgName))
+			if err != nil {
+				t.Errorf(" %s; cannot open MX_Device.h file", tt.name)
+				return
+			}
+
+			dataRef, errRef := os.ReadFile(filepath.Join(tt.cfgPath, tt.cfgRefName))
+			if errRef != nil {
+				t.Errorf(" %s; cannot open MX_Device_ref.h file", tt.name)
+				return
+			}
+
+			// Normalize line endings inline
+			content := strings.ReplaceAll(string(data), "\r\n", "\n")
+			contentRef := strings.ReplaceAll(string(dataRef), "\r\n", "\n")
+
+			lines := strings.Split(content, "\n")
+			linesRef := strings.Split(contentRef, "\n")
+
+			content = strings.Join(lines[3:], "\n")
+			contentRef = strings.Join(linesRef[3:], "\n")
+
+			if reflect.DeepEqual((content != contentRef), !tt.wantErr) {
+				t.Errorf(" %s; MX_Device.h file content mismatch", tt.name)
+			}
+		})
+	}
+}
+
+func Test_ReadContexts(t *testing.T) {
+
+	tests := []struct {
+		name    string
+		iocFile string
+		params  BridgeParamType
+		wantErr bool
+	}{
+		{"STM32H7_SC", "../../testdata/testExamples/STM32H7_SC/STM32CubeMX/device/STM32CubeMX/STM32CubeMX.ioc", BridgeParamType{"device", "", "STM32H743AGIx", "", "test", "single-core", "", "", "AC6", "", "test", "", ""}, false},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			argsSlice := []BridgeParamType{tt.params}
+			if err := ReadContexts(tt.iocFile, argsSlice); (err != nil) != tt.wantErr {
+				t.Errorf("ReadContexts() %s error = %v, wantErr %v", tt.name, err, tt.wantErr)
+			}
+		})
+	}
+}
+
 func Test_createContextMap(t *testing.T) {
 	t.Parallel()
 

testdata/testExamples/STM32F2/CubeMX.cproject.yml

@@ -0,0 +1,8 @@
+# A project translates into one executable or library.
+project:
+
+  # List components to use for your application.
+  # A software component is a re-usable unit that may be configurable.
+  components:
+    - component: ARM::CMSIS:CORE
+    - component: Device:CubeMX

testdata/testExamples/STM32F2/CubeMX.csolution.yml

@@ -0,0 +1,36 @@
+# A solution is a collection of related projects that share same base configuration.
+solution:
+  created-for: CMSIS-Toolbox@2.6.0
+  cdefault:
+
+  # List of tested compilers that can be selected
+  select-compiler:
+    - compiler: AC6
+    - compiler: GCC
+    - compiler: IAR
+
+  # List the packs that define the device and/or board.
+  packs:
+    - pack: Keil::STM32F2xx_DFP
+    - pack: ARM::CMSIS
+
+  # List different hardware targets that are used to deploy the solution.
+  target-types:
+    - type: STM32F217IGHx
+      device: STM32F217IGHx
+      # device: STMicroelectronics::STM32F103RB
+
+      # List of different build configurations.
+  build-types:
+    - type: Debug
+      debug: on
+      optimize: none
+
+    - type: Release
+      debug: off
+      optimize: balanced
+
+  # List related projects.
+  projects:
+    - project: CubeMX.cproject.yml
+  compiler: AC6

testdata/testExamples/STM32F2/STM32CubeMX/STM32F217IGHx/CubeMX.cgen.yml

@@ -0,0 +1,47 @@
+generator-import:
+  for-device: STM32F217IGHx
+  define:
+    - USE_HAL_DRIVER
+    - STM32F217xx
+  add-path:
+    - ./STM32CubeMX/Drivers/STM32F2xx_HAL_Driver/Inc
+    - ./STM32CubeMX/Drivers/STM32F2xx_HAL_Driver/Inc/Legacy
+    - ./STM32CubeMX/Drivers/CMSIS/Device/ST/STM32F2xx/Include
+    - ./STM32CubeMX/Inc
+    - ./MX_Device
+  groups:
+    - group: CubeMX
+      files:
+        - file: ./STM32CubeMX/Src/main.c
+        - file: ./STM32CubeMX/Src/gpio.c
+        - file: ./STM32CubeMX/Src/eth.c
+        - file: ./STM32CubeMX/Src/i2c.c
+        - file: ./STM32CubeMX/Src/sdio.c
+        - file: ./STM32CubeMX/Src/spi.c
+        - file: ./STM32CubeMX/Src/usart.c
+        - file: ./STM32CubeMX/Src/usb_otg.c
+        - file: ./STM32CubeMX/Src/stm32f2xx_it.c
+        - file: ./STM32CubeMX/Src/stm32f2xx_hal_msp.c
+        - file: ./STM32CubeMX/MDK-ARM/startup_stm32f217xx.s
+        - file: ./STM32CubeMX/Src/system_stm32f2xx.c
+    - group: STM32 HAL Driver
+      files:
+        - file: ./STM32CubeMX/Drivers/STM32F2xx_HAL_Driver/Src/stm32f2xx_hal_eth.c
+        - file: ./STM32CubeMX/Drivers/STM32F2xx_HAL_Driver/Src/stm32f2xx_hal.c
+        - file: ./STM32CubeMX/Drivers/STM32F2xx_HAL_Driver/Src/stm32f2xx_hal_rcc.c
+        - file: ./STM32CubeMX/Drivers/STM32F2xx_HAL_Driver/Src/stm32f2xx_hal_rcc_ex.c
+        - file: ./STM32CubeMX/Drivers/STM32F2xx_HAL_Driver/Src/stm32f2xx_hal_cortex.c
+        - file: ./STM32CubeMX/Drivers/STM32F2xx_HAL_Driver/Src/stm32f2xx_hal_flash.c
+        - file: ./STM32CubeMX/Drivers/STM32F2xx_HAL_Driver/Src/stm32f2xx_hal_flash_ex.c
+        - file: ./STM32CubeMX/Drivers/STM32F2xx_HAL_Driver/Src/stm32f2xx_hal_pwr.c
+        - file: ./STM32CubeMX/Drivers/STM32F2xx_HAL_Driver/Src/stm32f2xx_hal_pwr_ex.c
+        - file: ./STM32CubeMX/Drivers/STM32F2xx_HAL_Driver/Src/stm32f2xx_hal_gpio.c
+        - file: ./STM32CubeMX/Drivers/STM32F2xx_HAL_Driver/Src/stm32f2xx_hal_dma.c
+        - file: ./STM32CubeMX/Drivers/STM32F2xx_HAL_Driver/Src/stm32f2xx_hal_dma_ex.c
+        - file: ./STM32CubeMX/Drivers/STM32F2xx_HAL_Driver/Src/stm32f2xx_hal_exti.c
+        - file: ./STM32CubeMX/Drivers/STM32F2xx_HAL_Driver/Src/stm32f2xx_hal_i2c.c
+        - file: ./STM32CubeMX/Drivers/STM32F2xx_HAL_Driver/Src/stm32f2xx_ll_sdmmc.c
+        - file: ./STM32CubeMX/Drivers/STM32F2xx_HAL_Driver/Src/stm32f2xx_hal_sd.c
+        - file: ./STM32CubeMX/Drivers/STM32F2xx_HAL_Driver/Src/stm32f2xx_hal_mmc.c
+        - file: ./STM32CubeMX/Drivers/STM32F2xx_HAL_Driver/Src/stm32f2xx_hal_spi.c
+        - file: ./STM32CubeMX/Drivers/STM32F2xx_HAL_Driver/Src/stm32f2xx_hal_uart.c