esp32/machine_pin: Add mode and pull in machine_pin_print() as repr() function. - #12293

@jimmo
Could you give your opinion about this PR?

Thanks @IhorNehrutsa -- I can definitely see that adding this information to the print output is useful for debugging, and making the pin serialisable is certainly a nice bonus.

However, there are two main concerns:

1. We don't ensure that the pins can be eval'ed on other ports. For example, on rp2040:

>>> machine.Pin.board.D12
Pin(GPIO4, mode=ALT, pull=PULL_DOWN, alt=31)

It's quite useful (for debugging) that it prints the mode strings rather than the numbers too. (I guess you could in theory make this work with eval with the right combination of globals passed to eval).

2. It's not a trivial decision to dedicate ~90 bytes (2 uint8_t * ~45 pins) of RAM just to tracking this state. 90 bytes isn't much, but I don't know if it justifies this? I was quite surprised to find that the IDF doesn't provide a way to extract this information from a pin, but that definitely seems to be the case in both the driver and HAL.

What if we turned machine_pin_obj_cfg_t into a bitfield (3 bits for gpio_mode_t, two bits for gpio_pull_mode_t). Then it would be only 45 bytes?

I opened the ESP-IDF issue:
GPIO feature: Add gpio_get_direction() and gpio_get_pull_mode() (IDFGH-10987) #12176

Function gpio_dump_io_configuration()
Dump IO configuration information to console.

Commit espressif/esp-idf@321f628
feat(gpio): add a dump API to dump IO configurations

feat(gpio): add a dump API to dump IO configurations (IDFGH-11366)
espressif/esp-idf#12511
Cherry pick from master to release/v5.1

This is an automated heads-up that we've just merged a Pull Request
that removes the STATIC macro from MicroPython's C API.

See #13763

A search suggests this PR might apply the STATIC macro to some C code. If it
does, then next time you rebase the PR (or merge from master) then you should
please replace all the STATIC keywords with static.

Although this is an automated message, feel free to @-reply to me directly if
you have any questions about this.

Now that esp32 port uses IDF 5.2.2, are the required IDF functions available to retrieve the GPIO state?

Also, would be nice to print the string of the mode/pull, rather than just the integer (like the rp2 port does).

Code size report:

Reference:  esp8266: Remove obsolete --verify option from ESP8266. [e496000]
Comparison: esp32/machine_pin: Add mode, pull and drive to machine_pin_print(). [merge of cc502ab]
  mpy-cross:    +0 +0.000% 
   bare-arm:    +0 +0.000% 
minimal x86:    +0 +0.000% 
   unix x64:    +0 +0.000% standard
      stm32:    +0 +0.000% PYBV10
      esp32:  +712 +0.041% ESP32_GENERIC[incl +136(data)]
     mimxrt:    +0 +0.000% TEENSY40
        rp2:    +0 +0.000% RPI_PICO_W
       samd:    +0 +0.000% ADAFRUIT_ITSYBITSY_M4_EXPRESS
  qemu rv32:    +0 +0.000% VIRT_RV32

Test code is:

from time import sleep
from machine import Pin

PIN = 27 # 5 #

pin = Pin(PIN, mode=Pin.IN, pull=Pin.PULL_DOWN)
sleep(2)
print(pin, pin())

pin = Pin(PIN, mode=Pin.IN, pull=Pin.PULL_UP)
sleep(2)
print(pin, pin())

pin = Pin(PIN, mode=Pin.IN, pull=None)
sleep(2)
print(pin, pin())

pin = Pin(PIN, mode=Pin.OUT, value=0)
sleep(2)
print(pin, pin())

pin = Pin(PIN, mode=Pin.OUT, value=1, drive=Pin.DRIVE_1)
sleep(2)
print(pin, pin())

The output is:

Pin(27, mode=Pin.IN, pull=Pin.PULL_DOWN) 0
Pin(27, mode=Pin.IN, pull=Pin.PULL_UP) 0
Pin(27, mode=Pin.IN) 0
Pin(27, mode=Pin.OUT) 0
Pin(27, mode=Pin.OUT, drive=Pin.DRIVE_1) 1

This PR requires in esp-idf
GPIO: Add gpio_get_io_config() and xxx_is_enabled(). (IDFGH-14117)

Now that esp32 port uses IDF 5.2.2, are the required IDF functions available to retrieve the GPIO state?

Also, would be nice to print the string of the mode/pull, rather than just the integer (like the rp2 port does).

This PR requires:
esp-idf commit espressif/esp-idf@4535c27
esp32: IDF v.5.5 compile. #16565

See also comment
espressif/esp-idf#14923 (comment)

Thanks @IhorNehrutsa for persisting with this PR.

I've marked it as a draft for now, because we won't be able to review and merge it until there's a release version of ESP-IDF v5.5 that MicroPython supports. When this happens, please feel free to rebase and click "Ready for review".

(One thing to note, it will be a very long time before we drop support for all older ESP-IDF, so this PR will probably need some #if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 5, 0) guards around it.)

#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 5, 0) guards around it.

Done.

Ready with IDF v.5.5
Tested on esp32 dev board.
Tested on esp32s3 dev board.

@dpgeorge

Now that esp32 port uses IDF 5.2.2, are the required IDF functions available to retrieve the GPIO state?

Also, would be nice to print the string of the mode/pull, rather than just the integer (like the rp2 port does).

Ready

Merged! Thanks for keeping this going.