From a2e6fb29029477fb1c1ec1ffe59c0f9d663f0708 Mon Sep 17 00:00:00 2001
From: ellensp <530024+ellensp@users.noreply.github.com>
Date: Mon, 15 Jul 2024 07:16:56 +1200
Subject: [PATCH] Fix Marlin API (#47)

* update function names in Marlin api
* update Arduino impl
---
 include/pinmapping.h                                 |  4 ++--
 src/MarlinSimulator/marlin_arduino_impl/arduino.cpp  | 12 ++++++------
 .../marlin_arduino_impl/pinmapping.cpp               |  4 ++--
 src/MarlinSimulator/marlin_hal_impl/HAL.cpp          |  2 +-
 4 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/include/pinmapping.h b/include/pinmapping.h
index a8d55b2..a36cb50 100644
--- a/include/pinmapping.h
+++ b/include/pinmapping.h
@@ -46,10 +46,10 @@ constexpr pin_t analogInputToDigitalPin(const int8_t p) {
 int16_t GET_PIN_MAP_INDEX(const pin_t pin);
 
 // Test whether the pin is valid
-bool VALID_PIN(const pin_t p);
+bool isValidPin(const pin_t p);
 
 // Get the analog index for a digital pin
-int8_t DIGITAL_PIN_TO_ANALOG_PIN(const pin_t p);
+int8_t digitalPinToAnalogIndex(const pin_t p);
 
 // Test whether the pin is PWM
 bool PWM_PIN(const pin_t p);
diff --git a/src/MarlinSimulator/marlin_arduino_impl/arduino.cpp b/src/MarlinSimulator/marlin_arduino_impl/arduino.cpp
index e80daba..54451f7 100644
--- a/src/MarlinSimulator/marlin_arduino_impl/arduino.cpp
+++ b/src/MarlinSimulator/marlin_arduino_impl/arduino.cpp
@@ -57,28 +57,28 @@ extern "C" void delay(const int msec) {
 // IO functions
 // As defined by Arduino INPUT(0x0), OUTPUT(0x1), INPUT_PULLUP(0x2)
 void pinMode(const pin_t pin, const uint8_t mode) {
-  if (!VALID_PIN(pin)) return;
+  if (!isValidPin(pin)) return;
   Gpio::setMode(pin, mode);
 }
 
 void digitalWrite(pin_t pin, uint8_t pin_status) {
-  if (!VALID_PIN(pin)) return;
+  if (!isValidPin(pin)) return;
   Gpio::set(pin, pin_status);
 }
 
 bool digitalRead(pin_t pin) {
-  if (!VALID_PIN(pin)) return false;
+  if (!isValidPin(pin)) return false;
   return Gpio::get(pin);
 }
 
 void analogWrite(pin_t pin, int pwm_value) {  // 1 - 254: pwm_value, 0: LOW, 255: HIGH
-  if (!VALID_PIN(pin)) return;
+  if (!isValidPin(pin)) return;
   Gpio::set(pin, pwm_value);
 }
 
 uint16_t analogRead(pin_t adc_pin) {
-  if (!VALID_PIN(DIGITAL_PIN_TO_ANALOG_PIN(adc_pin))) return 0;
-  return Gpio::get(DIGITAL_PIN_TO_ANALOG_PIN(adc_pin));
+  if (!isValidPin(digitalPinToAnalogIndex(adc_pin))) return 0;
+  return Gpio::get(digitalPinToAnalogIndex(adc_pin));
 }
 
 char *dtostrf(double __val, signed char __width, unsigned char __prec, char *__s) {
diff --git a/src/MarlinSimulator/marlin_arduino_impl/pinmapping.cpp b/src/MarlinSimulator/marlin_arduino_impl/pinmapping.cpp
index c744cdb..b63b217 100644
--- a/src/MarlinSimulator/marlin_arduino_impl/pinmapping.cpp
+++ b/src/MarlinSimulator/marlin_arduino_impl/pinmapping.cpp
@@ -30,12 +30,12 @@ int16_t GET_PIN_MAP_INDEX(const pin_t pin) {
 }
 
 // Test whether the pin is valid
-bool VALID_PIN(const pin_t p) {
+bool isValidPin(const pin_t p) {
   return WITHIN(p, 0, NUM_DIGITAL_PINS);
 }
 
 // Get the analog index for a digital pin
-int8_t DIGITAL_PIN_TO_ANALOG_PIN(const pin_t p) {
+int8_t digitalPinToAnalogIndex(const pin_t p) {
   return (WITHIN(p, analog_offset, NUM_DIGITAL_PINS) ? p - analog_offset : P_NC);
 }
 
diff --git a/src/MarlinSimulator/marlin_hal_impl/HAL.cpp b/src/MarlinSimulator/marlin_hal_impl/HAL.cpp
index 69d0e92..0c20c5c 100644
--- a/src/MarlinSimulator/marlin_hal_impl/HAL.cpp
+++ b/src/MarlinSimulator/marlin_hal_impl/HAL.cpp
@@ -66,7 +66,7 @@ bool MarlinHAL::adc_ready() {
 
 uint16_t MarlinHAL::adc_value() {
   pin_t pin = analogInputToDigitalPin(active_ch);
-  if (!VALID_PIN(pin)) return 0;
+  if (!isValidPin(pin)) return 0;
   uint16_t data = ((Gpio::get(pin) >> 2) & 0x3FF);
   return data;    // return 10bit value as Marlin expects
 }