docs: add warning to gpio_get_level()

On most microcontrollers I have worked with one can retrieve the
current state of output GPIO pins. On ESP32 this is not the case
if the pad is not explictly configured to route this information into
the port by configuring it as input or i/o.
Thus add a warning to the API documentation of gpio_get_level().

Merges https://github.com/espressif/esp-idf/pull/1740

diff --git a/components/driver/include/driver/gpio.h b/components/driver/include/driver/gpio.h
index 7cace8836a19cb403bd6c78dee0a2acdd77224d9..8246c415ef361c37046fc3f85c9b8bcc48485d08 100644 (file)
--- a/components/driver/include/driver/gpio.h
+++ b/components/driver/include/driver/gpio.h
@@ -302,6 +302,8 @@ esp_err_t gpio_set_level(gpio_num_t gpio_num, uint32_t level);
 /**
  * @brief  GPIO get input level
  *
+ * @warning If the pad is not configured for input (or input and output) the returned value is always 0.
+ *
  * @param  gpio_num GPIO number. If you want to get the logic level of e.g. pin GPIO16, gpio_num should be GPIO_NUM_16 (16);
  *
  * @return