Stag 12 VCU

.github/PULL_REQUEST_TEMPLATE.md

@@ -10,7 +10,7 @@ Closes # (issue)
 
 - [ ] Code has been tested on STM32 hardware.
 - [ ] Changes do not generate any new compiler warnings.
-- [ ] Code has been formatted using `trunk fmt`.
+- [ ] Code has been formatted using `make format`.
 - [ ] Commit messages follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#specification) specification.
 
 ### Additional Notes

.github/workflows/trunk-action.yaml

@@ -0,0 +1,29 @@
+name: Trunk Code Quality
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+permissions: read-all
+
+jobs:
+  trunk_check:
+    name: Trunk Code Quality Runner
+    runs-on: ubuntu-latest
+    permissions:
+      checks: write
+      contents: read
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install cppcheck
+        run: sudo apt-get update && sudo apt-get install -y cppcheck
+
+      - name: Trunk Code Quality
+        uses: trunk-io/trunk-action@v1

.gitignore

@@ -159,3 +159,6 @@ misra.txt
 
 # TraceX
 *.trx
+
+# CANoe
+*.cbf

.gitmodules

@@ -1,6 +1,6 @@
-[submodule "src/Middlewares/SUFST/rtcan"]
-	path = src/Middlewares/SUFST/rtcan
+[submodule "src/SUFST/Middlewares/rtcan"]
+	path = src/SUFST/Middlewares/rtcan
 	url = https://github.com/sufst/rtcan
-[submodule "src/Middlewares/SUFST/can-defs"]
-	path = src/Middlewares/SUFST/can-defs
+[submodule "src/SUFST/Middlewares/can-defs"]
+	path = src/SUFST/Middlewares/can-defs
 	url = https://github.com/sufst/can-defs

.trunk/trunk.yaml

@@ -58,8 +58,10 @@ lint:
         - src/AZURE_RTOS/**
         - src/Core/**
         - src/Drivers/**
-        - src/Middlewares/ST
-        - scripts/*
+        - src/Middlewares/**
+        - src/FileX/**
+        - src/USBX/**
+        - scripts/**
     - linters: [clang-format]
       paths:
         - src/SUFST/Inc/config.h

.vscode/c_cpp_properties.json

@@ -11,7 +11,7 @@
         "${workspaceFolder}/src/Drivers/CMSIS/**",
         "${workspaceFolder}/src/Middlewares/ST/threadx/common/inc",
         "${workspaceFolder}/src/Middlewares/ST/threadx/ports/cortex_m7/gnu/inc",
-        "${workspaceFolder}/src/SUFST/Inc/CAN",
+        "${workspaceFolder}/src/SUFST/Inc/",
         "${workspaceFolder}/src/Drivers/STM32F7xx_HAL_Driver/Inc"
       ],
       "defines": [

.vscode/launch.json

@@ -4,7 +4,7 @@
     {
       "cwd": "${workspaceFolder}",
       "name": "debug (stutil)",
-      "executable": "build/VCU.elf",
+      "executable": "build/debug/VCU.elf",
       "request": "launch",
       "type": "cortex-debug",
       "showDevDebugOutput": "none",
@@ -16,7 +16,7 @@
     // debug with openocd
     {
       "cwd": "${workspaceFolder}",
-      "executable": "build/VCU.elf",
+      "executable": "build/debug/VCU.elf",
       "name": "debug (openocd)",
       "request": "launch",
       "type": "cortex-debug",

.vscode/settings.json

@@ -50,10 +50,13 @@
     "torque_map_funcs.h": "c",
     "rtds.h": "c",
     "pm100.h": "c",
-    "can_c.h": "c",
+    "can_t.h": "c",
     "ctrl.h": "c"
   },
+  "cortex-debug.gdbPath": "gdb-multiarch",
   "cortex-debug.variableUseNaturalFormat": true,
-  "C_Cpp.errorSquiggles": "Enabled",
-  "mcu-debug.rtos-views.showRTOS": false
+  "C_Cpp.errorSquiggles": "enabled",
+  "C_Cpp.intelliSenseEngine": "default",
+  "mcu-debug.rtos-views.showRTOS": false,
+  "clangd.enable": false
 }

README.md

@@ -3,7 +3,7 @@
 # Table of Contents
 
 - [About](#about)
-- [Development Environment](#development-environment)
+- [Development Environment](#setup--development-environment)
 - [Contributing](#contributing)
 - [Useful Resources](#useful-resources)
 - [Related Projects](#related-projects)
@@ -20,10 +20,10 @@ SUFST Docs Site.
 
 ## Using the setup script
 
+Run the below command once to install dependencies, clone the repository and initialise submodules
+
 ```sh
-curl https://raw.githubusercontent.com/sufst/vcu/refs/heads/main/vcu-setup-script.sh -o vcu-setup-script.sh
-chmod +x vcu-setup-script.sh
-./vcu-setup-script.sh
+curl -LsSf https://raw.githubusercontent.com/sufst/vcu/refs/heads/main/vcu-setup-script.sh | bash
 ```
 
 ## Submodules