🧑‍💻 Update pins formatter script (MarlinFirmware#26450)

vovodroid · Nov 21, 2023 · 20445b8 · 20445b8
1 parent 12881d5
commit 20445b8
Show file tree

Hide file tree

Showing 42 changed files with 103 additions and 79 deletions.
diff --git a/Makefile b/Makefile
@@ -5,6 +5,7 @@ CONTAINER_IMAGE := marlin-dev
 
 help:
 	@echo "Tasks for local development:"
+	@echo "* format-pins:                 Reformat all pins files
 	@echo "* tests-single-ci:             Run a single test from inside the CI"
 	@echo "* tests-single-local:          Run a single test locally"
 	@echo "* tests-single-local-docker:   Run a single test locally, using docker"
@@ -57,3 +58,12 @@ tests-all-local-docker:
 setup-local-docker:
 	$(CONTAINER_RT_BIN) build -t $(CONTAINER_IMAGE) -f docker/Dockerfile .
 .PHONY: setup-local-docker
+
+PINS := $(shell find Marlin/src/pins -mindepth 2 -name '*.h')
+
+.PHONY: $(PINS)
+
+$(PINS): %:
+	@echo "Formatting $@" && node buildroot/share/scripts/pinsformat.js $@
+
+format-pins: $(PINS)
diff --git a/Marlin/src/pins/gd32f1/pins_TRIGORILLA_V006.h b/Marlin/src/pins/gd32f1/pins_TRIGORILLA_V006.h
@@ -122,7 +122,7 @@
   //
   // SPI
   //
-  #define SPI_DEVICE                        -1   // Maple
+  #define SPI_DEVICE                        -1    // Maple
   #define SCK_PIN                           -1
   #define MISO_PIN                          -1
   #define MOSI_PIN                          -1

diff --git a/Marlin/src/pins/lpc1768/pins_BTT_SKR_V1_1.h b/Marlin/src/pins/lpc1768/pins_BTT_SKR_V1_1.h
@@ -202,7 +202,7 @@
       #undef E1_ENABLE_PIN
     #endif
 
-  #else                                           // !SOFTWARE_DRIVER_ENABLE
+  #else // !SOFTWARE_DRIVER_ENABLE
 
     // A chip-select pin is needed for each driver.
 

diff --git a/Marlin/src/pins/lpc1768/pins_BTT_SKR_V1_3.h b/Marlin/src/pins/lpc1768/pins_BTT_SKR_V1_3.h
@@ -372,7 +372,7 @@
       #define TFT_BACKLIGHT_PIN      EXP1_03_PIN
 
       #define TOUCH_BUTTONS_HW_SPI
-      #define TOUCH_BUTTONS_HW_SPI_DEVICE 1
+      #define TOUCH_BUTTONS_HW_SPI_DEVICE      1
 
       //#define TFT_RST_PIN          EXP2_07_PIN
       #define TFT_SCK_PIN            EXP2_02_PIN

diff --git a/Marlin/src/pins/lpc1768/pins_BTT_SKR_V1_4.h b/Marlin/src/pins/lpc1768/pins_BTT_SKR_V1_4.h
@@ -464,7 +464,7 @@
         #define NEOPIXEL_PIN         EXP1_06_PIN
       #endif
 
-    #else                                         // !FYSETC_MINI_12864
+    #else // !FYSETC_MINI_12864
 
       #if ENABLED(MKS_MINI_12864)
         #define DOGLCD_CS            EXP1_06_PIN

diff --git a/Marlin/src/pins/lpc1768/pins_MKS_SGEN_L.h b/Marlin/src/pins/lpc1768/pins_MKS_SGEN_L.h
@@ -350,7 +350,7 @@
       #define LCD_PINS_D7            EXP1_08_PIN
       #define KILL_PIN                     -1     // NC
 
-    #else                                         // !MKS_12864OLED_SSD1306
+    #else // !MKS_12864OLED_SSD1306
 
       #define LCD_PINS_RS            EXP1_04_PIN
 
@@ -385,7 +385,7 @@
           #define NEOPIXEL_PIN       EXP1_06_PIN
         #endif
 
-      #else                                       // !FYSETC_MINI_12864
+      #else // !FYSETC_MINI_12864
 
         #if ENABLED(MKS_MINI_12864)
           #define DOGLCD_CS          EXP1_06_PIN

diff --git a/Marlin/src/pins/lpc1769/pins_MKS_SGEN_L_V2.h b/Marlin/src/pins/lpc1769/pins_MKS_SGEN_L_V2.h
@@ -368,7 +368,7 @@
         #define TFT_QUEUE_SIZE              6144
       #endif
 
-    #else                                         // !MKS_12864OLED_SSD1306
+    #else // !MKS_12864OLED_SSD1306
 
       #define LCD_PINS_RS            EXP1_04_PIN
 
@@ -403,7 +403,7 @@
           #define NEOPIXEL_PIN       EXP1_06_PIN
         #endif
 
-      #else                                       // !FYSETC_MINI_12864
+      #else // !FYSETC_MINI_12864
 
         #if ENABLED(MKS_MINI_12864)
           #define DOGLCD_CS          EXP1_06_PIN

diff --git a/Marlin/src/pins/mega/pins_GT2560_REV_A.h b/Marlin/src/pins/mega/pins_GT2560_REV_A.h
@@ -104,7 +104,7 @@
 // Power monitoring pins - set to 0 for main VIN, 1 for dedicated bed supply rail.
 // Don't forget to enable POWER_MONITOR_VOLTAGE in Configuration_adv.h
 // and set POWER_MONITOR_VOLTS_PER_VOLT to 0.090909.
-#define POWER_MONITOR_VOLTAGE_PIN             0
+#define POWER_MONITOR_VOLTAGE_PIN              0
 
 /**              LCD                             SDCARD
  *              ------                           ------
@@ -181,7 +181,7 @@
     #define BTN_ENC                  EXP1_02_PIN
     #define SD_DETECT_PIN            EXP2_07_PIN
 
-  #else                                           // !IS_NEWPANEL
+  #else // !IS_NEWPANEL
 
     #define SHIFT_CLK_PIN            EXP2_07_PIN
     #define SHIFT_LD_PIN             EXP2_03_PIN

diff --git a/Marlin/src/pins/mega/pins_GT2560_REV_A_PLUS.h b/Marlin/src/pins/mega/pins_GT2560_REV_A_PLUS.h
@@ -30,6 +30,6 @@
 
 #define BOARD_INFO_NAME "GT2560 Rev.A+"
 
-#define SERVO0_PIN  11
+#define SERVO0_PIN                            11
 
 #include "pins_GT2560_REV_A.h"
diff --git a/Marlin/src/pins/mega/pins_PICAOLD.h b/Marlin/src/pins/mega/pins_PICAOLD.h
@@ -25,9 +25,9 @@
 // Origin: https://github.com/mjrice/PICA/blob/97ab9e7771a8e5eef97788f3adcc17a9fa9de9b9/pica_schematic.pdf
 // ATmega2560
 
-#define HEATER_0_PIN                          9   // E0
-#define HEATER_1_PIN                         10   // E1
-#define FAN0_PIN                             11
-#define FAN2_PIN                             12
+#define HEATER_0_PIN                           9  // E0
+#define HEATER_1_PIN                          10  // E1
+#define FAN0_PIN                              11
+#define FAN2_PIN                              12
 
 #include "pins_PICA.h"
diff --git a/Marlin/src/pins/rambo/pins_MINIRAMBO.h b/Marlin/src/pins/rambo/pins_MINIRAMBO.h
@@ -172,7 +172,7 @@
 
       #define SD_DETECT_PIN                   72
 
-    #else                                         // !MINIRAMBO_10A
+    #else // !MINIRAMBO_10A
 
       // AUX-4
       #define BEEPER_PIN                      84

diff --git a/Marlin/src/pins/rambo/pins_RAMBO.h b/Marlin/src/pins/rambo/pins_RAMBO.h
@@ -232,7 +232,7 @@
 
       #define LCD_SCREEN_ROTATE              180  // 0, 90, 180, 270
 
-    #else                                         // !VIKI2 && !miniVIKI
+    #else // !VIKI2 && !miniVIKI
 
       #define BEEPER_PIN                      79  // AUX-4
 
@@ -253,7 +253,7 @@
       #define BTN_ENC_EN             LCD_PINS_D7  // Detect the presence of the encoder
     #endif
 
-  #else                                           // !IS_NEWPANEL - old style panel with shift register
+  #else // !IS_NEWPANEL - old style panel with shift register
 
     // No Beeper added
     #define BEEPER_PIN                        33

diff --git a/Marlin/src/pins/ramps/pins_FELIX2.h b/Marlin/src/pins/ramps/pins_FELIX2.h
@@ -35,23 +35,23 @@
 //
 // Heaters / Fans
 //
-#define MOSFET_D_PIN                          7
+#define MOSFET_D_PIN                           7
 
 #include "pins_RAMPS.h"
 
 //
 // Misc. Functions
 //
-#define SDPOWER_PIN                           1
+#define SDPOWER_PIN                            1
 
-#define PS_ON_PIN                            12
+#define PS_ON_PIN                             12
 
 //
 // LCD / Controller
 //
 #if HAS_WIRED_LCD && IS_NEWPANEL
 
-  #define SD_DETECT_PIN                       6
+  #define SD_DETECT_PIN                        6
 
 #endif
 

diff --git a/Marlin/src/pins/ramps/pins_FORMBOT_TREX2PLUS.h b/Marlin/src/pins/ramps/pins_FORMBOT_TREX2PLUS.h
@@ -141,8 +141,8 @@
 //
 #define SDSS                                  53
 #ifndef LED_PIN
-  #define LED_PIN                             13  // The Formbot v 1 board has almost no unassigned pins on it.  The Board's LED
-#endif                          // is a good place to get a signal to control the Max7219 LED Matrix.
+  #define LED_PIN                             13  // The Formbot v 1 board has almost no unassigned pins.
+#endif                                            // The Board's LED is a good place to connect the Max7219 Matrix.
 
 // Use the RAMPS 1.4 Analog input 5 on the AUX2 connector
 #define FILWIDTH_PIN                           5  // Analog Input

diff --git a/Marlin/src/pins/ramps/pins_MAKEBOARD_MINI.h b/Marlin/src/pins/ramps/pins_MAKEBOARD_MINI.h
@@ -28,8 +28,8 @@
 //
 // Only 3 Limit Switch plugs on Micromake C1
 //
-#define X_STOP_PIN          2
-#define Y_STOP_PIN         15
-#define Z_STOP_PIN         19
+#define X_STOP_PIN                             2
+#define Y_STOP_PIN                            15
+#define Z_STOP_PIN                            19
 
 #include "pins_RAMPS.h"
diff --git a/Marlin/src/pins/ramps/pins_RAMPS_OLD.h b/Marlin/src/pins/ramps/pins_RAMPS_OLD.h
@@ -91,7 +91,7 @@
   #ifndef FAN0_PIN
     #define FAN0_PIN                          11
   #endif
-#else                                             // RAMPS_V_1_1 or RAMPS_V_1_2
+#else // RAMPS_V_1_1 or RAMPS_V_1_2
   #define HEATER_0_PIN                        10
   #define HEATER_BED_PIN                       8
   #ifndef FAN0_PIN

diff --git a/Marlin/src/pins/ramps/pins_RUMBA_RAISE3D.h b/Marlin/src/pins/ramps/pins_RUMBA_RAISE3D.h
@@ -27,7 +27,7 @@
 #define DEFAULT_MACHINE_NAME "Raise3D N Series"
 
 // Raise3D uses thermocouples on the standard input pins
-#define TEMP_0_PIN         15   // Analog Input
-#define TEMP_1_PIN         14   // Analog Input
+#define TEMP_0_PIN                            15  // Analog Input
+#define TEMP_1_PIN                            14  // Analog Input
 
 #include "pins_RUMBA.h"
diff --git a/Marlin/src/pins/ramps/pins_TRONXY_V3_1_0.h b/Marlin/src/pins/ramps/pins_TRONXY_V3_1_0.h
@@ -38,7 +38,7 @@
 //
 // Servos
 //
-#define SERVO1_PIN         12   // 2560 PIN 25/PB6
+#define SERVO1_PIN                            12  // 2560 PIN 25/PB6
 
 //
 // Import RAMPS 1.4 pins

diff --git a/Marlin/src/pins/ramps/pins_ULTIMAKER.h b/Marlin/src/pins/ramps/pins_ULTIMAKER.h
@@ -138,7 +138,7 @@
 
     #define SD_DETECT_PIN                     38
 
-  #else                                           // !IS_NEWPANEL - Old style panel with shift register
+  #else // !IS_NEWPANEL - Old style panel with shift register
 
     // Buttons attached to a shift register
     #define SHIFT_CLK_PIN                     38

diff --git a/Marlin/src/pins/ramps/pins_ULTIMAKER_OLD.h b/Marlin/src/pins/ramps/pins_ULTIMAKER_OLD.h
@@ -195,7 +195,7 @@
 
     #define SD_DETECT_PIN                     38
 
-  #else                                           // !IS_NEWPANEL - Old style panel with shift register
+  #else // !IS_NEWPANEL - Old style panel with shift register
 
     // Buttons attached to a shift register
     #define SHIFT_CLK_PIN                     38

diff --git a/Marlin/src/pins/ramps/pins_ZRIB_V53.h b/Marlin/src/pins/ramps/pins_ZRIB_V53.h
@@ -374,7 +374,7 @@
   #define KILL_PIN                            -1
   #if ANY(OLED_HW_IIC, OLED_HW_SPI)
     #error "Oops! You must choose SW SPI for ZRIB V53 board and connect the OLED screen to EXP1 connector."
-  #else                                           // SW_SPI
+  #else // SW_SPI
     #define DOGLCD_A0                LCD_PINS_DC
     #define DOGLCD_MOSI                       35  // SDA
     #define DOGLCD_SCK                        37  // SCK

diff --git a/Marlin/src/pins/sam/pins_RAMPS4DUE.h b/Marlin/src/pins/sam/pins_RAMPS4DUE.h
@@ -45,8 +45,8 @@
 //
 // Temperature Sensors
 //
-#define TEMP_0_PIN          9   // Analog Input
-#define TEMP_1_PIN         -1   // Analog Input
-#define TEMP_BED_PIN       10   // Analog Input
+#define TEMP_0_PIN                             9  // Analog Input
+#define TEMP_1_PIN                            -1  // Analog Input
+#define TEMP_BED_PIN                          10  // Analog Input
 
 #include "../ramps/pins_RAMPS.h"
diff --git a/Marlin/src/pins/sam/pins_RAMPS_FD_V2.h b/Marlin/src/pins/sam/pins_RAMPS_FD_V2.h
@@ -31,7 +31,7 @@
 #define BOARD_INFO_NAME "RAMPS-FD v2"
 
 #ifndef E0_CS_PIN
-  #define E0_CS_PIN        69 // moved from A13 to A15 on v2.2, if not earlier
+  #define E0_CS_PIN                           69  // moved from A13 to A15 on v2.2, if not earlier
 #endif
 
 #include "pins_RAMPS_FD_V1.h"
@@ -44,9 +44,9 @@
 #define MARLIN_EEPROM_SIZE 0x10000 // 64K in a 24C512
 
 #ifndef PS_ON_PIN
-  #define PS_ON_PIN        12
+  #define PS_ON_PIN                           12
 #endif
 
 #ifndef FILWIDTH_PIN
-  #define FILWIDTH_PIN      5   // Analog Input on AUX2
+  #define FILWIDTH_PIN                         5  // Analog Input on AUX2
 #endif
diff --git a/Marlin/src/pins/sanguino/pins_AZTEEG_X1.h b/Marlin/src/pins/sanguino/pins_AZTEEG_X1.h
@@ -29,6 +29,6 @@
 
 #define BOARD_INFO_NAME "Azteeg X1"
 
-#define FAN0_PIN 4
+#define FAN0_PIN                               4
 
 #include "pins_SANGUINOLOLU_12.h" // ... SANGUINOLOLU_11
diff --git a/Marlin/src/pins/sanguino/pins_SANGUINOLOLU_11.h b/Marlin/src/pins/sanguino/pins_SANGUINOLOLU_11.h
@@ -173,7 +173,7 @@
         // Marlin so this can be used for BEEPER_PIN. You can use this pin
         // with M42 instead of BEEPER_PIN.
         #define BEEPER_PIN                    27
-      #else                                       // Sanguinololu >=1.3
+      #else // Sanguinololu >=1.3
         #define LCD_PINS_RS                    4
         #define LCD_PINS_EN                   17
         #define LCD_PINS_D4                   30
@@ -197,7 +197,7 @@
         #define BEEPER_PIN                    27
         #define DOGLCD_CS                     28
 
-      #else                                       // !MAKRPANEL
+      #else // !MAKRPANEL
 
         #define DOGLCD_CS                     29
 
@@ -250,7 +250,7 @@
       #define BTN_ENC                         30
     #endif
 
-  #else                                           // !LCD_FOR_MELZI && !ZONESTAR_LCD && !LCD_I2C_PANELOLU2
+  #else // !LCD_FOR_MELZI && !ZONESTAR_LCD && !LCD_I2C_PANELOLU2
 
     #define BTN_ENC                           16
     #ifndef LCD_SDSS

diff --git a/Marlin/src/pins/stm32f1/pins_BTT_SKR_MINI_V1_1.h b/Marlin/src/pins/stm32f1/pins_BTT_SKR_MINI_V1_1.h
@@ -235,7 +235,7 @@
       //  #define NEOPIXEL_PIN       EXP1_06_PIN
       //#endif
 
-    #else                                         // !FYSETC_MINI_12864
+    #else // !FYSETC_MINI_12864
 
       #define LCD_PINS_D4            EXP1_05_PIN
       #if IS_ULTIPANEL

diff --git a/Marlin/src/pins/stm32f1/pins_KEDI_CONTROLLER_V1_2.h b/Marlin/src/pins/stm32f1/pins_KEDI_CONTROLLER_V1_2.h
@@ -242,7 +242,7 @@
       //  #define NEOPIXEL_PIN       EXP1_05_PIN
       //#endif
 
-    #else                                         // !FYSETC_MINI_12864
+    #else // !FYSETC_MINI_12864
 
       #define LCD_PINS_D4            EXP1_06_PIN
       #if IS_ULTIPANEL

diff --git a/Marlin/src/pins/stm32f1/pins_MKS_ROBIN_E3P.h b/Marlin/src/pins/stm32f1/pins_MKS_ROBIN_E3P.h
@@ -356,7 +356,7 @@
     #endif
     //#define LCD_SCREEN_ROTATE              180  // 0, 90, 180, 270
 
-  #else                                           // !MKS_MINI_12864
+  #else // !MKS_MINI_12864
 
     #define LCD_PINS_D4              EXP1_05_PIN
     #if IS_ULTIPANEL

diff --git a/Marlin/src/pins/stm32f1/pins_MKS_ROBIN_E3_V1_1_common.h b/Marlin/src/pins/stm32f1/pins_MKS_ROBIN_E3_V1_1_common.h
@@ -34,6 +34,6 @@
 #define Z_STEP_PIN                          PC14
 #define Z_DIR_PIN                           PC15
 
-#define BTN_ENC_EN                            -1
+#define BTN_ENC_EN                          -1
 
 #include "pins_MKS_ROBIN_E3_common.h"
diff --git a/Marlin/src/pins/stm32f1/pins_MKS_ROBIN_LITE.h b/Marlin/src/pins/stm32f1/pins_MKS_ROBIN_LITE.h
@@ -121,7 +121,7 @@
     #define DOGLCD_SCK                      PB13
     #define DOGLCD_MOSI                     PB15
 
-  #else                                           // !MKS_MINI_12864
+  #else // !MKS_MINI_12864
 
     #define LCD_PINS_D4              EXP3_06_PIN
     #if IS_ULTIPANEL

diff --git a/Marlin/src/pins/stm32f1/pins_MKS_ROBIN_LITE3.h b/Marlin/src/pins/stm32f1/pins_MKS_ROBIN_LITE3.h
@@ -122,7 +122,7 @@
       #define TFTGLCD_CS                    PB11
     #endif
 
-  #else                                           // !MKS_MINI_12864
+  #else // !MKS_MINI_12864
 
     #define LCD_PINS_D4                     PA6
     #if IS_ULTIPANEL

diff --git a/Marlin/src/pins/stm32f1/pins_MKS_ROBIN_NANO_V2.h b/Marlin/src/pins/stm32f1/pins_MKS_ROBIN_NANO_V2.h
@@ -356,7 +356,7 @@
     #endif
     //#define LCD_SCREEN_ROTATE              180  // 0, 90, 180, 270
 
-  #else                                           // !MKS_MINI_12864
+  #else // !MKS_MINI_12864
 
     #define LCD_PINS_D4                     PE14
     #if IS_ULTIPANEL