General cleanup of Re-ARM pins

Marlin/src/pins/pins_RAMPS_RE_ARM.h

@@ -98,13 +98,6 @@
   #define E1_CS_PIN        -1
 #endif
 
-//#define E2_STEP_PIN        P2_08   // (36)
-//#define E2_DIR_PIN         P2_13   // (34)
-//#define E2_ENABLE_PIN      P4_29   // (30)
-//#ifndef E2_CS_PIN
-//  #define E2_CS_PIN        -1
-//#endif
-
 //
 // Software SPI pins for TMC2130 stepper drivers
 //
@@ -118,14 +111,14 @@
 // Temperature Sensors
 //  3.3V max when defined as an analog input
 //
-#define TEMP_0_PIN         0   // A0 (T0) - (67) - TEMP_0_PIN
-#define TEMP_BED_PIN       1   // A1 (T1) - (68) - TEMP_BED_PIN
-#define TEMP_1_PIN         2   // A2 (T2) - (69) - TEMP_1_PIN
-#define TEMP_2_PIN         3   // A3 - (63) - J5-3 & AUX-2
-#define TEMP_3_PIN         4   // A4 - (37) - BUZZER_PIN
-//#define TEMP_4_PIN         5  // A5 - (49) - SD_DETECT_PIN
-//#define ??               6   // A6 - ( 0)  - RXD0 - J4-4 & AUX-1
-#define FILWIDTH_PIN       7   // A7 - ( 1)  - TXD0 - J4-5 & AUX-1
+#define TEMP_0_PIN          0   // A0 (T0) - (67) - TEMP_0_PIN
+#define TEMP_BED_PIN        1   // A1 (T1) - (68) - TEMP_BED_PIN
+#define TEMP_1_PIN          2   // A2 (T2) - (69) - TEMP_1_PIN
+#define TEMP_2_PIN          3   // A3 - (63) - J5-3 & AUX-2
+#define TEMP_3_PIN          4   // A4 - (37) - BUZZER_PIN
+//#define TEMP_4_PIN          5   // A5 - (49) - SD_DETECT_PIN
+//#define ??                  6   // A6 - ( 0)  - RXD0 - J4-4 & AUX-1
+#define FILWIDTH_PIN        7   // A7 - ( 1)  - TXD0 - J4-5 & AUX-1
 
 //
 // Augmentation for auto-assigning RAMPS plugs
@@ -195,55 +188,57 @@
 //
 // Misc. Functions
 //
-#define LED_PIN           P4_28   // (13)
+#define LED_PIN            P4_28   // (13)
 
 // define digital pin 4 for the filament runout sensor. Use the RAMPS 1.4 digital input 4 on the servos connector
 #ifndef FIL_RUNOUT_PIN
-  #define FIL_RUNOUT_PIN  P1_18   // (4)
+  #define FIL_RUNOUT_PIN   P1_18   // (4)
 #endif
 
-#define PS_ON_PIN         P2_12   // (12)
+#define PS_ON_PIN          P2_12   // (12)
 
 #if ENABLED(CASE_LIGHT_ENABLE) && !PIN_EXISTS(CASE_LIGHT) && !defined(SPINDLE_LASER_ENABLE_PIN)
-  #if !defined(NUM_SERVOS) || NUM_SERVOS < 4   // try to use servo connector
-    #define CASE_LIGHT_PIN    P1_18   // (4) MUST BE HARDWARE PWM
+  #if !defined(NUM_SERVOS) || NUM_SERVOS < 4   // Try to use servo connector
+    #define CASE_LIGHT_PIN P1_18   // (4) MUST BE HARDWARE PWM
   #endif
 #endif
 
 //
 // M3/M4/M5 - Spindle/Laser Control
+//            Use servo pins, if available
 //
 #if ENABLED(SPINDLE_LASER_ENABLE) && !PIN_EXISTS(SPINDLE_LASER_ENABLE)
-  #if !defined(NUM_SERVOS) || NUM_SERVOS == 1 // must use servo connector
-    #undef  SERVO1
-    #undef  SERVO2
-    #undef  SERVO3
-    #define SPINDLE_LASER_ENABLE_PIN  P1_21   // (6) Pin should have a pullup/pulldown!
-    #define SPINDLE_LASER_PWM_PIN     P1_18   // (4) MUST BE HARDWARE PWM
-    #define SPINDLE_DIR_PIN           P1_19   // (5)
+  #if NUM_SERVOS > 1
+    #error "SPINDLE_LASER_ENABLE requires 3 free servo pins."
   #endif
+  #define SPINDLE_LASER_ENABLE_PIN SERVO1_PIN   // (6) Pin should have a pullup/pulldown!
+  #define SPINDLE_LASER_PWM_PIN    SERVO3_PIN   // (4) MUST BE HARDWARE PWM
+  #define SPINDLE_DIR_PIN          SERVO2_PIN   // (5)
 #endif
 
 //
 // Průša i3 MK2 Multiplexer Support
 //
 #if SERIAL_PORT != 0 && SERIAL_PORT_2 != 0
-  #define E_MUX0_PIN         P0_03   // ( 0) Z_CS_PIN
-  #define E_MUX1_PIN         P0_02   // ( 1) E0_CS_PIN
+  #define E_MUX0_PIN       P0_03   // ( 0) Z_CS_PIN
+  #define E_MUX1_PIN       P0_02   // ( 1) E0_CS_PIN
 #endif
 #define E_MUX2_PIN         P0_26   // (63) E1_CS_PIN
 
 /**
  * LCD / Controller
  *
- * All controllers can use J3 and J5 on the Re-ARM board.  Custom cabling will be required.
+ * All controllers can use J3 and J5 on the Re-ARM board. Custom cabling will be required.
+ *
+ * - https://github.com/wolfmanjm/universal-panel-adapter
+ * - http://panucattdevices.freshdesk.com/support/solutions/articles/1000243195-lcd-display-installation
  */
 
 /**
  * Smart LCD adapter
  *
  * The Smart LCD adapter can be used for the two 10 pin LCD controllers such as
- * REPRAP_DISCOUNT_SMART_CONTROLLER.  It can't be used for controllers that use
+ * REPRAP_DISCOUNT_SMART_CONTROLLER. It can't be used for controllers that use
  * DOGLCD_A0, DOGLCD_CS, LCD_PINS_D5, LCD_PINS_D6 or LCD_PINS_D7. A custom cable
  * is needed to pick up 5V for the EXP1 connection.
  *
@@ -252,95 +247,91 @@
  * that the garbage/lines are erased immediately after the SD card accesses are completed.
  */
 
-#if ENABLED(ULTRA_LCD)
+#if ENABLED(CR10_STOCKDISPLAY)
 
-  #if ENABLED(CR10_STOCKDISPLAY)
+  // Re-Arm can support Creality stock display without SD card reader and single cable on EXP3.
+  // Re-Arm J3 pins 1 (p1.31) & 2 (P3.26) are not used. Stock cable will need to have one
+  // 10-pin IDC connector trimmed or replaced with a 12-pin IDC connector to fit J3.
+  // Requires REVERSE_ENCODER_DIRECTION in Configuration.h
 
-    // Re-Arm can support Creality stock display without SD card reader and single cable on EXP3.
-    // Re-Arm J3 pins 1 (p1.31) & 2 (P3.26) are not used. Stock cable will need to have one
-    // 10-pin IDC connector trimmed or replaced with a 12-pin IDC connector to fit J3.
-    // Requires REVERSE_ENCODER_DIRECTION in Configuration.h
+  #define BEEPER_PIN       P2_11   // J3-3 & AUX-4
 
-    #define BEEPER_PIN          P2_11   // J3-3 & AUX-4
+  #define BTN_EN1          P0_16   // J3-7 & AUX-4
+  #define BTN_EN2          P1_23   // J3-5 & AUX-4
+  #define BTN_ENC          P3_25   // J3-4 & AUX-4
 
-    #define BTN_EN1             P0_16   // J3-7 & AUX-4
-    #define BTN_EN2             P1_23   // J3-5 & AUX-4
-    #define BTN_ENC             P3_25   // J3-4 & AUX-4
+  #define LCD_PINS_RS      P0_15   // J3-9 & AUX-4 (CS)
+  #define LCD_PINS_ENABLE  P0_18   // J3-10 & AUX-3 (SID, MOSI)
+  #define LCD_PINS_D4      P2_06   // J3-8 & AUX-3 (SCK, CLK)
 
-    #define LCD_PINS_RS         P0_15   // J3-9 & AUX-4 (CS)
-    #define LCD_PINS_ENABLE     P0_18   // J3-10 & AUX-3 (SID, MOSI)
-    #define LCD_PINS_D4         P2_06   // J3-8 & AUX-3 (SCK, CLK)
-
-  #else
+#elif ENABLED(ULTRA_LCD)
 
-    #define BEEPER_PIN          P1_30   // (37) not 5V tolerant
+  #define BEEPER_PIN       P1_30   // (37) not 5V tolerant
 
-    #define BTN_EN1             P3_26   // (31) J3-2 & AUX-4
-    #define BTN_EN2             P3_25   // (33) J3-4 & AUX-4
-    #define BTN_ENC             P2_11   // (35) J3-3 & AUX-4
+  #define BTN_EN1          P3_26   // (31) J3-2 & AUX-4
+  #define BTN_EN2          P3_25   // (33) J3-4 & AUX-4
+  #define BTN_ENC          P2_11   // (35) J3-3 & AUX-4
 
-    #define SD_DETECT_PIN       P1_31   // (49) not 5V tolerant   J3-1 & AUX-3
-    #define KILL_PIN            P1_22   // (41) J5-4 & AUX-4
-    #define LCD_PINS_RS         P0_16   // (16) J3-7 & AUX-4
-    #define LCD_SDSS            P0_16   // (16) J3-7 & AUX-4
+  #define SD_DETECT_PIN    P1_31   // (49) J3-1 & AUX-3 (NOT 5V tolerant)
+  #define KILL_PIN         P1_22   // (41) J5-4 & AUX-4
+  #define LCD_PINS_RS      P0_16   // (16) J3-7 & AUX-4
+  #define LCD_SDSS         P0_16   // (16) J3-7 & AUX-4
 
-    #if ENABLED(NEWPANEL)
-      #if ENABLED(REPRAPWORLD_KEYPAD)
-        #define SHIFT_OUT         P0_18   // (51)  (MOSI) J3-10 & AUX-3
-        #define SHIFT_CLK         P0_15   // (52)  (SCK)  J3-9 & AUX-3
-        #define SHIFT_LD          P1_31   // (49)  not 5V tolerant   J3-1 & AUX-3
-      #endif
-    #else
-      //#define SHIFT_CLK           P3_26   // (31)  J3-2 & AUX-4
-      //#define SHIFT_LD            P3_25   // (33)  J3-4 & AUX-4
-      //#define SHIFT_OUT           P2_11   // (35)  J3-3 & AUX-4
-      //#define SHIFT_EN            P1_22   // (41)  J5-4 & AUX-4
+  #if ENABLED(NEWPANEL)
+    #if ENABLED(REPRAPWORLD_KEYPAD)
+      #define SHIFT_OUT    P0_18   // (51) (MOSI) J3-10 & AUX-3
+      #define SHIFT_CLK    P0_15   // (52) (SCK)  J3-9 & AUX-3
+      #define SHIFT_LD     P1_31   // (49)        J3-1 & AUX-3 (NOT 5V tolerant)
     #endif
+  #else
+    //#define SHIFT_CLK    P3_26   // (31)  J3-2 & AUX-4
+    //#define SHIFT_LD     P3_25   // (33)  J3-4 & AUX-4
+    //#define SHIFT_OUT    P2_11   // (35)  J3-3 & AUX-4
+    //#define SHIFT_EN     P1_22   // (41)  J5-4 & AUX-4
+  #endif
 
-    #if ENABLED(VIKI2) || ENABLED(miniVIKI)
-      // #define LCD_SCREEN_ROT_180
-
-      #define BTN_EN1             P3_26   // (31) J3-2 & AUX-4
-      #define BTN_EN2             P3_25   // (33) J3-4 & AUX-4
-      #define BTN_ENC             P2_11   // (35) J3-3 & AUX-4
+  #if ENABLED(VIKI2) || ENABLED(miniVIKI)
+    // #define LCD_SCREEN_ROT_180
 
-      #define SD_DETECT_PIN       P1_31   // (49) not 5V tolerant   J3-1 & AUX-3
-      #define KILL_PIN            P1_22   // (41) J5-4 & AUX-4
+    #define BTN_EN1        P3_26   // (31) J3-2 & AUX-4
+    #define BTN_EN2        P3_25   // (33) J3-4 & AUX-4
+    #define BTN_ENC        P2_11   // (35) J3-3 & AUX-4
 
-      #define DOGLCD_CS           P0_16   // (16)
-      #define DOGLCD_A0           P2_06   // (59) J3-8 & AUX-2
-      #define DOGLCD_SCK          SCK_PIN
-      #define DOGLCD_MOSI         MOSI_PIN
+    #define SD_DETECT_PIN  P1_31   // (49) J3-1 & AUX-3 (NOT 5V tolerant)
+    #define KILL_PIN       P1_22   // (41) J5-4 & AUX-4
 
-      #define STAT_LED_BLUE_PIN   P0_26   // (63)  may change if cable changes
-      #define STAT_LED_RED_PIN    P1_21   // ( 6)  may change if cable changes
-    #else
-      #define DOGLCD_CS           P0_26   // (63) J5-3 & AUX-2
-      #define DOGLCD_A0           P2_06   // (59) J3-8 & AUX-2
-      #define LCD_BACKLIGHT_PIN   P0_16   // (16) J3-7 & AUX-4 - only used on DOGLCD controllers
-      #define LCD_PINS_ENABLE     P0_18   // (51) (MOSI) J3-10 & AUX-3
-      #define LCD_PINS_D4         P0_15   // (52) (SCK)  J3-9 & AUX-3
-      #if ENABLED(ULTIPANEL)
-        #define LCD_PINS_D5       P1_17   // (71) ENET_MDIO
-        #define LCD_PINS_D6       P1_14   // (73) ENET_RX_ER
-        #define LCD_PINS_D7       P1_10   // (75) ENET_RXD1
-      #endif
-    #endif
+    #define DOGLCD_CS      P0_16   // (16)
+    #define DOGLCD_A0      P2_06   // (59) J3-8 & AUX-2
+    #define DOGLCD_SCK     SCK_PIN
+    #define DOGLCD_MOSI    MOSI_PIN
 
-    //#define MISO_PIN            P0_17   // (50)  system defined J3-10 & AUX-3
-    //#define MOSI_PIN            P0_18   // (51)  system defined J3-10 & AUX-3
-    //#define SCK_PIN             P0_15   // (52)  system defined J3-9 & AUX-3
-    //#define SS_PIN              P1_23   // (53)  system defined J3-5 & AUX-3 - sometimes called SDSS
-
-    #if ENABLED(MINIPANEL)
-      // GLCD features
-      //#define LCD_CONTRAST   190
-      // Uncomment screen orientation
-      //#define LCD_SCREEN_ROT_90
-      //#define LCD_SCREEN_ROT_180
-      //#define LCD_SCREEN_ROT_270
+    #define STAT_LED_BLUE_PIN P0_26 //(63)  may change if cable changes
+    #define STAT_LED_RED_PIN P1_21 // ( 6)  may change if cable changes
+  #else
+    #define DOGLCD_CS      P0_26   // (63) J5-3 & AUX-2
+    #define DOGLCD_A0      P2_06   // (59) J3-8 & AUX-2
+    #define LCD_BACKLIGHT_PIN P0_16 //(16) J3-7 & AUX-4 - only used on DOGLCD controllers
+    #define LCD_PINS_ENABLE P0_18  // (51) (MOSI) J3-10 & AUX-3
+    #define LCD_PINS_D4    P0_15   // (52) (SCK)  J3-9 & AUX-3
+    #if ENABLED(ULTIPANEL)
+      #define LCD_PINS_D5  P1_17   // (71) ENET_MDIO
+      #define LCD_PINS_D6  P1_14   // (73) ENET_RX_ER
+      #define LCD_PINS_D7  P1_10   // (75) ENET_RXD1
     #endif
+  #endif
 
+  //#define MISO_PIN         P0_17   // (50)  system defined J3-10 & AUX-3
+  //#define MOSI_PIN         P0_18   // (51)  system defined J3-10 & AUX-3
+  //#define SCK_PIN          P0_15   // (52)  system defined J3-9 & AUX-3
+  //#define SS_PIN           P1_23   // (53)  system defined J3-5 & AUX-3 (Sometimes called SDSS)
+
+  #if ENABLED(MINIPANEL)
+    // GLCD features
+    //#define LCD_CONTRAST   190
+    // Uncomment screen orientation
+    //#define LCD_SCREEN_ROT_90
+    //#define LCD_SCREEN_ROT_180
+    //#define LCD_SCREEN_ROT_270
   #endif
 
 #endif // ULTRA_LCD
@@ -349,17 +340,17 @@
 // Ethernet pins
 //
 #if DISABLED(ULTIPANEL)
-  #define ENET_MDIO   P1_17   // (71)  J12-4
-  #define ENET_RX_ER  P1_14   // (73)  J12-6
-  #define ENET_RXD1   P1_10   // (75)  J12-8
+  #define ENET_MDIO        P1_17   // (71)  J12-4
+  #define ENET_RX_ER       P1_14   // (73)  J12-6
+  #define ENET_RXD1        P1_10   // (75)  J12-8
 #endif
-#define ENET_MOC      P1_16   // (70)  J12-3
-#define REF_CLK       P1_15   // (72)  J12-5
-#define ENET_RXD0     P1_09   // (74)  J12-7
-#define ENET_CRS      P1_08   // (76)  J12-9
-#define ENET_TX_EN    P1_04   // (77)  J12-10
-#define ENET_TXD0     P1_00   // (78)  J12-11
-#define ENET_TXD1     P1_01   // (79)  J12-12
+#define ENET_MOC           P1_16   // (70)  J12-3
+#define REF_CLK            P1_15   // (72)  J12-5
+#define ENET_RXD0          P1_09   // (74)  J12-7
+#define ENET_CRS           P1_08   // (76)  J12-9
+#define ENET_TX_EN         P1_04   // (77)  J12-10
+#define ENET_TXD0          P1_00   // (78)  J12-11
+#define ENET_TXD1          P1_01   // (79)  J12-12
 
 //#define USB_SD_DISABLED
 #define USB_SD_ONBOARD        // Provide the onboard SD card to the host as a USB mass storage device
@@ -369,11 +360,11 @@
 
 #if ENABLED(LPC_SD_LCD)
 
-  #define SCK_PIN            P0_15
-  #define MISO_PIN           P0_17
-  #define MOSI_PIN           P0_18
-  #define SS_PIN             P1_23   // Chip select for SD card used by Marlin
-  #define ONBOARD_SD_CS      P0_06   // Chip select for "System" SD card
+  #define SCK_PIN          P0_15
+  #define MISO_PIN         P0_17
+  #define MOSI_PIN         P0_18
+  #define SS_PIN           P1_23   // Chip select for SD card used by Marlin
+  #define ONBOARD_SD_CS    P0_06   // Chip select for "System" SD card
 
 #elif ENABLED(LPC_SD_ONBOARD)
 
@@ -383,66 +374,51 @@
     #define SHARED_SD_CARD
     #undef SD_DETECT_PIN // there is also no detect pin for the onboard card
   #endif
-  #define SCK_PIN            P0_07
-  #define MISO_PIN           P0_08
-  #define MOSI_PIN           P0_09
-  #define SS_PIN             P0_06   // Chip select for SD card used by Marlin
-  #define ONBOARD_SD_CS      P0_06   // Chip select for "System" SD card
+
+  #define SCK_PIN          P0_07
+  #define MISO_PIN         P0_08
+  #define MOSI_PIN         P0_09
+  #define SS_PIN           P0_06   // Chip select for SD card used by Marlin
+  #define ONBOARD_SD_CS    P0_06   // Chip select for "System" SD card
 
 #endif
 
 /**
  *  Fast PWMs
  *
- *  The LPC1768's hardware PWM controller has 6 channels.  Each channel
+ *  The LPC1768's hardware PWM controller has 6 channels. Each channel
  *  can be setup to either control a dedicated pin directly or to generate
- *  an interrupt.  The direct method's duty cycle is accurate to within a
- *  a microsecond.  The interrupt method's average duty cycle has the
+ *  an interrupt. The direct method's duty cycle is accurate to within a
+ *  a microsecond. The interrupt method's average duty cycle has the
  *  the same accuracy but the individual cycles can vary because of higher
  *  priority interrupts.
  *
  *  All Fast PWMs have a 50Hz rate.
  *
- *  The following pins/signals use the direct method.  All other pins use the
+ *  The following pins/signals use the direct method. All other pins use the
  *  the interrupt method. Note that SERVO2_PIN and RAMPS_D8_PIN use the
  *  interrupt method.
+ *
  *     P1_20 (11)   SERVO0_PIN
  *     P1_21 ( 6)   SERVO1_PIN       J5-1
  *     P0_18 ( 4)   SERVO3_PIN       5V output
  *    *P2_04 ( 9)   RAMPS_D9_PIN
  *    *P2_05 (10)   RAMPS_D10_PIN
  *
- *    * - If used as a heater driver then a Fast PWM is NOT assigned.  If used as
+ *    * - If used as a heater driver then a Fast PWM is NOT assigned. If used as
  *        a fan driver then enabling FAST_PWM_FAN assigns a Fast PWM to it.
  */
 
  /**
   * Special pins
-  *   P1_30  (37) - not 5V tolerant
-  *   P1_31  (49) - not 5V tolerant
-  *   P0_27  (57) - open collector
-  *   P0_28  (58) - open collector
-  *
- */
+  *   P1_30  (37) (NOT 5V tolerant)
+  *   P1_31  (49) (NOT 5V tolerant)
+  *   P0_27  (57) (Open collector)
+  *   P0_28  (58) (Open collector)
+  */
 
 /**
- *  The following mega2560 pins are NOT available in a Re-ARM system
- *  7
- *  17
- *  22
- *  23
- *  25
- *  27
- *  29
- *  32
- *  39
- *  40
- *  42
- *  43
- *  44
- *  45
- *  47
- *  64
- *  65
- *  66
+ *  The following mega2560 pins are NOT available in a Re-ARM system:
+ *
+ *  7, 17, 22, 23, 25, 27, 29, 32, 39, 40, 42, 43, 44, 45, 47, 64, 65, 66
  */