Adjust HAL platform defines, comments

4 years ago · 4d1357e318
44 changed files with 106 additions and 78 deletions
--- a/Marlin/src/HAL/DUE/HAL.cpp
+++ b/Marlin/src/HAL/DUE/HAL.cpp
@ -19,9 +19,7 @@
 */

 /**
- * Description: HAL for Arduino Due and compatible (SAM3X8E)
- *
- * For ARDUINO_ARCH_SAM
+ * HAL for Arduino Due and compatible (SAM3X8E)
 */

 #ifdef ARDUINO_ARCH_SAM
--- a/Marlin/src/HAL/DUE/HAL.h
+++ b/Marlin/src/HAL/DUE/HAL.h
@ -22,9 +22,7 @@
 #pragma once

 /**
- * Description: HAL for Arduino Due and compatible (SAM3X8E)
- *
- * For ARDUINO_ARCH_SAM
+ * HAL for Arduino Due and compatible (SAM3X8E)
 */

 #define CPU_32_BIT
--- a/Marlin/src/HAL/DUE/HAL_SPI.cpp
+++ b/Marlin/src/HAL/DUE/HAL_SPI.cpp
@ -30,7 +30,7 @@
 */

 /**
- * Description: HAL for Arduino Due and compatible (SAM3X8E)
+ * HAL for Arduino Due and compatible (SAM3X8E)
 *
 * For ARDUINO_ARCH_SAM
 */
--- a/Marlin/src/HAL/DUE/timers.cpp
+++ b/Marlin/src/HAL/DUE/timers.cpp
@ -21,9 +21,7 @@
 */

 /**
- * Description: HAL for Arduino Due and compatible (SAM3X8E)
- *
- * For ARDUINO_ARCH_SAM
+ * HAL Timers for Arduino Due and compatible (SAM3X8E)
 */

 #ifdef ARDUINO_ARCH_SAM
--- a/Marlin/src/HAL/DUE/timers.h
+++ b/Marlin/src/HAL/DUE/timers.h
@ -21,9 +21,7 @@
 #pragma once

 /**
- * HAL for Arduino Due and compatible (SAM3X8E)
- *
- * For ARDUINO_ARCH_SAM
+ * HAL Timers for Arduino Due and compatible (SAM3X8E)
 */

 #include <stdint.h>
--- a/Marlin/src/HAL/ESP32/HAL.h
+++ b/Marlin/src/HAL/ESP32/HAL.h
@ -20,7 +20,7 @@
 #pragma once

 /**
- * Description: HAL for Espressif ESP32 WiFi
+ * HAL for Espressif ESP32 WiFi
 */

 #define CPU_32_BIT
--- a/Marlin/src/HAL/TEENSY31_32/HAL.cpp
+++ b/Marlin/src/HAL/TEENSY31_32/HAL.cpp
@ -20,9 +20,8 @@
 *
 */

-
 /**
- * Description: HAL for Teensy32 (MK20DX256)
+ * HAL for Teensy 3.2 (MK20DX256)
 */

 #ifdef __MK20DX256__
--- a/Marlin/src/HAL/TEENSY31_32/HAL.h
+++ b/Marlin/src/HAL/TEENSY31_32/HAL.h
@ -22,7 +22,7 @@
 #pragma once

 /**
- * Description: HAL for Teensy 3.5 and Teensy 3.6
+ * HAL for Teensy 3.2 (MK20DX256)
 */

 #define CPU_32_BIT
@ -44,8 +44,9 @@
 //#undef MOTHERBOARD
 //#define MOTHERBOARD BOARD_TEENSY31_32

-#ifdef __MK20DX256__
-  #define IS_32BIT_TEENSY 1
+#define IS_32BIT_TEENSY 1
+#define IS_TEENSY_31_32 1
+#ifndef IS_TEENSY31
  #define IS_TEENSY32 1
 #endif

--- a/Marlin/src/HAL/TEENSY31_32/Servo.cpp
+++ b/Marlin/src/HAL/TEENSY31_32/Servo.cpp
@ -51,5 +51,4 @@ void libServo::move(const int value) {
 }

 #endif // HAS_SERVOS
-
 #endif // __MK20DX256__
--- a/Marlin/src/HAL/TEENSY31_32/eeprom.cpp
+++ b/Marlin/src/HAL/TEENSY31_32/eeprom.cpp
@ -23,8 +23,7 @@
 #if USE_WIRED_EEPROM

 /**
- * PersistentStore for Arduino-style EEPROM interface
- * with implementations supplied by the framework.
+ * HAL PersistentStore for Teensy 3.2 (MK20DX256)
 */

 #include "../shared/eeprom_api.h"
--- a/Marlin/src/HAL/TEENSY31_32/timers.cpp
+++ b/Marlin/src/HAL/TEENSY31_32/timers.cpp
@ -21,7 +21,7 @@
 */

 /**
- * Teensy3.2 __MK20DX256__
+ * HAL Timers for Teensy 3.2 (MK20DX256)
 */

 #ifdef __MK20DX256__
--- a/Marlin/src/HAL/TEENSY31_32/timers.h
+++ b/Marlin/src/HAL/TEENSY31_32/timers.h
@ -22,8 +22,7 @@
 #pragma once

 /**
- * Description: HAL for
- * Teensy3.2 (__MK20DX256__)
+ * HAL Timers for Teensy 3.2 (MK20DX256)
 */

 #include <stdint.h>
--- a/Marlin/src/HAL/TEENSY35_36/HAL.cpp
+++ b/Marlin/src/HAL/TEENSY35_36/HAL.cpp
@ -21,7 +21,7 @@
 */

 /**
- * Description: HAL for Teensy35 (MK64FX512)
+ * HAL for Teensy 3.5 (MK64FX512) and Teensy 3.6 (MK66FX1M0)
 */

 #if defined(__MK64FX512__) || defined(__MK66FX1M0__)
--- a/Marlin/src/HAL/TEENSY35_36/HAL.h
+++ b/Marlin/src/HAL/TEENSY35_36/HAL.h
@ -22,7 +22,7 @@
 #pragma once

 /**
- * Description: HAL for Teensy 3.5 and Teensy 3.6
+ * HAL for Teensy 3.5 (MK64FX512) and Teensy 3.6 (MK66FX1M0)
 */

 #define CPU_32_BIT
@ -45,13 +45,12 @@
 // Defines
 // ------------------------

-#ifdef __MK64FX512__
-  #define IS_32BIT_TEENSY 1
-  #define IS_TEENSY35 1
-#endif
+#define IS_32BIT_TEENSY 1
+#define IS_TEENSY_35_36 1
 #ifdef __MK66FX1M0__
-  #define IS_32BIT_TEENSY 1
  #define IS_TEENSY36 1
+#else // __MK64FX512__
+  #define IS_TEENSY35 1
 #endif

 #define _MSERIAL(X) Serial##X
--- a/Marlin/src/HAL/TEENSY35_36/HAL_SPI.cpp
+++ b/Marlin/src/HAL/TEENSY35_36/HAL_SPI.cpp
@ -19,6 +19,11 @@
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 */
+
+/**
+ * HAL SPI for Teensy 3.5 (MK64FX512) and Teensy 3.6 (MK66FX1M0)
+ */
+
 #if defined(__MK64FX512__) || defined(__MK66FX1M0__)

 #include "HAL.h"
--- a/Marlin/src/HAL/TEENSY35_36/Servo.cpp
+++ b/Marlin/src/HAL/TEENSY35_36/Servo.cpp
@ -19,6 +19,11 @@
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 */
+
+/**
+ * HAL Servo for Teensy 3.5 (MK64FX512) and Teensy 3.6 (MK66FX1M0)
+ */
+
 #if defined(__MK64FX512__) || defined(__MK66FX1M0__)

 #include "../../inc/MarlinConfig.h"
@ -51,5 +56,4 @@ void libServo::move(const int value) {
 }

 #endif // HAS_SERVOS
-
 #endif // __MK64FX512__ || __MK66FX1M0__
--- a/Marlin/src/HAL/TEENSY35_36/Servo.h
+++ b/Marlin/src/HAL/TEENSY35_36/Servo.h
@ -21,6 +21,10 @@
 */
 #pragma once

+/**
+ * HAL Servo for Teensy 3.5 (MK64FX512) and Teensy 3.6 (MK66FX1M0)
+ */
+
 #include <Servo.h>

 // Inherit and expand on core Servo library
--- a/Marlin/src/HAL/TEENSY35_36/eeprom.cpp
+++ b/Marlin/src/HAL/TEENSY35_36/eeprom.cpp
@ -22,15 +22,14 @@
 */
 #if defined(__MK64FX512__) || defined(__MK66FX1M0__)

+/**
+ * HAL PersistentStore for Teensy 3.5 (MK64FX512) and Teensy 3.6 (MK66FX1M0)
+ */
+
 #include "../../inc/MarlinConfig.h"

 #if USE_WIRED_EEPROM

-/**
- * PersistentStore for Arduino-style EEPROM interface
- * with implementations supplied by the framework.
- */
-
 #include "../shared/eeprom_api.h"
 #include <avr/eeprom.h>

--- a/Marlin/src/HAL/TEENSY35_36/endstop_interrupts.h
+++ b/Marlin/src/HAL/TEENSY35_36/endstop_interrupts.h
@ -22,7 +22,7 @@
 #pragma once

 /**
- * Endstop Interrupts
+ * HAL Endstop Interrupts for Teensy 3.5 (MK64FX512) and Teensy 3.6 (MK66FX1M0)
 *
 * Without endstop interrupts the endstop pins must be polled continually in
 * the temperature-ISR via endstops.update(), most of the time finding no change.
--- a/Marlin/src/HAL/TEENSY35_36/pinsDebug.h
+++ b/Marlin/src/HAL/TEENSY35_36/pinsDebug.h
@ -18,6 +18,10 @@
 */
 #pragma once

+/**
+ * HAL Pins Debugging for Teensy 3.5 (MK64FX512) and Teensy 3.6 (MK66FX1M0)
+ */
+
 #define NUMBER_PINS_TOTAL NUM_DIGITAL_PINS
 #define MULTI_NAME_PAD 16 // space needed to be pretty if not first name assigned to a pin

--- a/Marlin/src/HAL/TEENSY35_36/spi_pins.h
+++ b/Marlin/src/HAL/TEENSY35_36/spi_pins.h
@ -21,6 +21,10 @@
 */
 #pragma once

+/**
+ * HAL SPI Pins for Teensy 3.5 (MK64FX512) and Teensy 3.6 (MK66FX1M0)
+ */
+
 #define SCK_PIN   13
 #define MISO_PIN  12
 #define MOSI_PIN  11
--- a/Marlin/src/HAL/TEENSY35_36/timers.cpp
+++ b/Marlin/src/HAL/TEENSY35_36/timers.cpp
@ -21,8 +21,7 @@
 */

 /**
- * Teensy3.5 __MK64FX512__
- * Teensy3.6 __MK66FX1M0__
+ * HAL Timers for Teensy 3.5 (MK64FX512) and Teensy 3.6 (MK66FX1M0)
 */

 #if defined(__MK64FX512__) || defined(__MK66FX1M0__)
--- a/Marlin/src/HAL/TEENSY35_36/timers.h
+++ b/Marlin/src/HAL/TEENSY35_36/timers.h
@ -21,9 +21,7 @@
 #pragma once

 /**
- * Description: HAL for
- * Teensy3.5 (__MK64FX512__)
- * Teensy3.6 (__MK66FX1M0__)
+ * HAL Timers for Teensy 3.5 (MK64FX512) and Teensy 3.6 (MK66FX1M0)
 */

 #include <stdint.h>
--- a/Marlin/src/HAL/TEENSY40_41/HAL.cpp
+++ b/Marlin/src/HAL/TEENSY40_41/HAL.cpp
@ -21,7 +21,7 @@
 */

 /**
- * Description: HAL for Teensy40 (IMXRT1062)
+ * HAL for Teensy 4.0 / 4.1 (IMXRT1062)
 */

 #ifdef __IMXRT1062__
--- a/Marlin/src/HAL/TEENSY40_41/HAL.h
+++ b/Marlin/src/HAL/TEENSY40_41/HAL.h
@ -22,7 +22,7 @@
 #pragma once

 /**
- * Description: HAL for Teensy 4.0 and Teensy 4.1
+ * HAL for Teensy 4.0 (IMXRT1062DVL6A) / 4.1 (IMXRT1062DVJ6A)
 */

 #define CPU_32_BIT
@ -45,8 +45,9 @@
 // Defines
 // ------------------------

-#ifdef __IMXRT1062__
-  #define IS_32BIT_TEENSY 1
+#define IS_32BIT_TEENSY 1
+#define IS_TEENSY_40_41 1
+#ifndef IS_TEENSY40
  #define IS_TEENSY41 1
 #endif

--- a/Marlin/src/HAL/TEENSY40_41/HAL_SPI.cpp
+++ b/Marlin/src/HAL/TEENSY40_41/HAL_SPI.cpp
@ -19,6 +19,11 @@
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 */
+
+/**
+ * HAL SPI for Teensy 4.0 (IMXRT1062DVL6A) / 4.1 (IMXRT1062DVJ6A)
+ */
+
 #ifdef __IMXRT1062__

 #include "HAL.h"
--- a/Marlin/src/HAL/TEENSY40_41/Servo.cpp
+++ b/Marlin/src/HAL/TEENSY40_41/Servo.cpp
@ -19,6 +19,11 @@
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 */
+
+/**
+ * HAL Servo for Teensy 4.0 (IMXRT1062DVL6A) / 4.1 (IMXRT1062DVJ6A)
+ */
+
 #ifdef __IMXRT1062__

 #include "../../inc/MarlinConfig.h"
@ -53,5 +58,4 @@ void libServo::detach() {
 }

 #endif // HAS_SERVOS
-
 #endif // __IMXRT1062__
--- a/Marlin/src/HAL/TEENSY40_41/Servo.h
+++ b/Marlin/src/HAL/TEENSY40_41/Servo.h
@ -21,6 +21,10 @@
 */
 #pragma once

+/**
+ * HAL Servo for Teensy 4.0 (IMXRT1062DVL6A) / 4.1 (IMXRT1062DVJ6A)
+ */
+
 #include <PWMServo.h>

 // Inherit and expand on core Servo library
--- a/Marlin/src/HAL/TEENSY40_41/eeprom.cpp
+++ b/Marlin/src/HAL/TEENSY40_41/eeprom.cpp
@ -27,8 +27,7 @@
 #if USE_WIRED_EEPROM

 /**
- * PersistentStore for Arduino-style EEPROM interface
- * with implementations supplied by the framework.
+ * HAL PersistentStore for Teensy 4.0 (IMXRT1062DVL6A) / 4.1 (IMXRT1062DVJ6A)
 */

 #include "../shared/eeprom_api.h"
--- a/Marlin/src/HAL/TEENSY40_41/endstop_interrupts.h
+++ b/Marlin/src/HAL/TEENSY40_41/endstop_interrupts.h
@ -22,7 +22,7 @@
 #pragma once

 /**
- * Endstop Interrupts
+ * HAL Endstop Interrupts for Teensy 4.0 (IMXRT1062DVL6A) / 4.1 (IMXRT1062DVJ6A)
 *
 * Without endstop interrupts the endstop pins must be polled continually in
 * the temperature-ISR via endstops.update(), most of the time finding no change.
--- a/Marlin/src/HAL/TEENSY40_41/fastio.h
+++ b/Marlin/src/HAL/TEENSY40_41/fastio.h
@ -23,7 +23,7 @@
 #pragma once

 /**
- * Fast I/O interfaces for Teensy 4
+ * Fast I/O interfaces for Teensy 4.0 (IMXRT1062DVL6A) / 4.1 (IMXRT1062DVJ6A)
 * These use GPIO functions instead of Direct Port Manipulation, as on AVR.
 */

--- a/Marlin/src/HAL/TEENSY40_41/pinsDebug.h
+++ b/Marlin/src/HAL/TEENSY40_41/pinsDebug.h
@ -18,6 +18,10 @@
 */
 #pragma once

+/**
+ * HAL Pins Debugging for Teensy 4.0 (IMXRT1062DVL6A) / 4.1 (IMXRT1062DVJ6A)
+ */
+
 #warning "PINS_DEBUGGING is not fully supported for Teensy 4.0 / 4.1 so 'M43' may cause hangs."

 #define NUMBER_PINS_TOTAL NUM_DIGITAL_PINS
--- a/Marlin/src/HAL/TEENSY40_41/spi_pins.h
+++ b/Marlin/src/HAL/TEENSY40_41/spi_pins.h
@ -21,6 +21,10 @@
 */
 #pragma once

+/**
+ * HAL SPI Pins for Teensy 4.0 (IMXRT1062DVL6A) / 4.1 (IMXRT1062DVJ6A)
+ */
+
 #define SCK_PIN   13
 #define MISO_PIN  12
 #define MOSI_PIN  11
--- a/Marlin/src/HAL/TEENSY40_41/timers.cpp
+++ b/Marlin/src/HAL/TEENSY40_41/timers.cpp
@ -21,7 +21,7 @@
 */

 /**
- * Teensy4.0/4.1 (__IMXRT1062__)
+ * HAL Timers for Teensy 4.0 (IMXRT1062DVL6A) / 4.1 (IMXRT1062DVJ6A)
 */

 #ifdef __IMXRT1062__
--- a/Marlin/src/HAL/TEENSY40_41/timers.h
+++ b/Marlin/src/HAL/TEENSY40_41/timers.h
@ -21,8 +21,7 @@
 #pragma once

 /**
- * Description: HAL for
- * Teensy4.0/4.1 (__IMXRT1062__)
+ * HAL Timers for Teensy 4.0 (IMXRT1062DVL6A) / 4.1 (IMXRT1062DVJ6A)
 */

 #include <stdint.h>
--- a/Marlin/src/HAL/TEENSY40_41/watchdog.cpp
+++ b/Marlin/src/HAL/TEENSY40_41/watchdog.cpp
@ -19,6 +19,11 @@
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 */
+
+/**
+ * HAL Watchdog for Teensy 4.0 (IMXRT1062DVL6A) / 4.1 (IMXRT1062DVJ6A)
+ */
+
 #ifdef __IMXRT1062__

 #include "../../inc/MarlinConfig.h"
@ -48,5 +53,4 @@ void HAL_watchdog_refresh() {
 }

 #endif // USE_WATCHDOG
-
 #endif // __IMXRT1062__
--- a/Marlin/src/HAL/TEENSY40_41/watchdog.h
+++ b/Marlin/src/HAL/TEENSY40_41/watchdog.h
@ -22,7 +22,7 @@
 #pragma once

 /**
- * Watchdog for Teensy4.0/4.1 (__IMXRT1062__)
+ * HAL Watchdog for Teensy 4.0 (IMXRT1062DVL6A) / 4.1 (IMXRT1062DVJ6A)
 */

 void watchdog_init();
--- a/Marlin/src/gcode/calibrate/M100.cpp
+++ b/Marlin/src/gcode/calibrate/M100.cpp
@ -60,7 +60,7 @@

 #define TEST_BYTE ((char) 0xE5)

-#if defined(__AVR__) || IS_32BIT_TEENSY
+#if EITHER(__AVR__, IS_32BIT_TEENSY)

  extern char __bss_end;
  char *end_bss = &__bss_end,
--- a/Marlin/src/pins/teensy3/pins_TEENSY31_32.h
+++ b/Marlin/src/pins/teensy3/pins_TEENSY31_32.h
@ -27,7 +27,7 @@
 * https://www.pjrc.com/teensy/teensyduino.html
 */

-#if NOT_TARGET(IS_32BIT_TEENSY)
+#if NOT_TARGET(IS_TEENSY_31_32)
  #error "Oops! Select 'Teensy 3.1' or 'Teensy 3.2' in 'Tools > Board.'"
 #endif

--- a/Marlin/src/pins/teensy3/pins_TEENSY35_36.h
+++ b/Marlin/src/pins/teensy3/pins_TEENSY35_36.h
@ -27,7 +27,7 @@
 * https://www.pjrc.com/teensy/teensyduino.html
 ****************************************************************************************/

-#if NOT_TARGET(IS_32BIT_TEENSY)
+#if NOT_TARGET(IS_TEENSY_35_36)
  #error "Oops! Select 'Teensy 3.5' or 'Teensy 3.6' in 'Tools > Board.'"
 #endif

--- a/Marlin/src/pins/teensy4/pins_T41U5XBB.h
+++ b/Marlin/src/pins/teensy4/pins_T41U5XBB.h
@ -27,12 +27,12 @@
 * https://www.pjrc.com/teensy/teensyduino.html
 ****************************************************************************************/

-#if NOT_TARGET(IS_32BIT_TEENSY) || NOT_TARGET(IS_TEENSY41)
+#if NOT_TARGET(IS_TEENSY41)
  #error "Oops! Select 'Teensy 4.1' in 'Tools > Board.'"
-#else
-  #define BOARD_INFO_NAME "Teensy4.1"
 #endif

+#define BOARD_INFO_NAME "Teensy4.1"
+
 /**
 * Plan for Teensy 4.0 and Teensy 4.1:
 *                                     USB
--- a/Marlin/src/pins/teensy4/pins_TEENSY41.h
+++ b/Marlin/src/pins/teensy4/pins_TEENSY41.h
@ -27,12 +27,12 @@
 * https://www.pjrc.com/teensy/teensyduino.html
 ****************************************************************************************/

-#if NOT_TARGET(IS_32BIT_TEENSY) || NOT_TARGET(IS_TEENSY41)
+#if NOT_TARGET(IS_TEENSY41)
  #error "Oops! Select 'Teensy 4.1' in 'Tools > Board.'"
-#else
-  #define BOARD_INFO_NAME "Teensy4.1"
 #endif

+#define BOARD_INFO_NAME "Teensy4.1"
+
 /**
 * Plan for Teensy 4.0 and Teensy 4.1:
 *                                            USB
--- a/Marlin/src/sd/Sd2Card.h
+++ b/Marlin/src/sd/Sd2Card.h
@ -78,13 +78,11 @@ uint8_t const SD_CARD_TYPE_SD1  = 1,                    // Standard capacity V1
              SD_CARD_TYPE_SDHC = 3;                    // High Capacity SD card

 /**
- * define SOFTWARE_SPI to use bit-bang SPI
+ * Define SOFTWARE_SPI to use bit-bang SPI
 */
-#if MEGA_SOFT_SPI
+#if EITHER(MEGA_SOFT_SPI, USE_SOFTWARE_SPI)
  #define SOFTWARE_SPI
-#elif USE_SOFTWARE_SPI
-  #define SOFTWARE_SPI
-#endif  // MEGA_SOFT_SPI
+#endif

 /**
 * \class Sd2Card
--- a/Marlin/src/sd/usb_flashdrive/Sd2Card_FlashDrive.h
+++ b/Marlin/src/sd/usb_flashdrive/Sd2Card_FlashDrive.h
@ -30,19 +30,20 @@
 #include "../SdInfo.h"

 /**
- * define SOFTWARE_SPI to use bit-bang SPI
+ * Define SOFTWARE_SPI to use bit-bang SPI
 */
-#if MEGA_SOFT_SPI || USE_SOFTWARE_SPI
+#if EITHER(MEGA_SOFT_SPI, USE_SOFTWARE_SPI)
  #define SOFTWARE_SPI
 #endif

 // SPI pin definitions - do not edit here - change in SdFatConfig.h
-#if DISABLED(SOFTWARE_SPI)
+#if ENABLED(SOFTWARE_SPI)
+  #warning "Auto-assigning '10' as the SD_CHIP_SELECT_PIN."
+  #define SD_CHIP_SELECT_PIN  10                // Software SPI chip select pin for the SD
+#else
  // hardware pin defs
  #define SD_CHIP_SELECT_PIN  SS_PIN            // The default chip select pin for the SD card is SS.
-#else  // SOFTWARE_SPI
-  #define SD_CHIP_SELECT_PIN  10                // Software SPI chip select pin for the SD
-#endif // SOFTWARE_SPI
+#endif

 class Sd2Card {
  private: