driver: add notes about GPIO36/39 issue (ECO 3.11) workaround

igrr · mythbuster5 · commit d890a516a109 · 2020-12-07T10:45:04.000+08:00
Closes IDFGH-1917 Closes #4117
diff --git a/components/driver/include/driver/gpio.h b/components/driver/include/driver/gpio.h
@@ -95,9 +95,11 @@ esp_err_t gpio_set_intr_type(gpio_num_t gpio_num, gpio_int_type_t intr_type);
 /**
  * @brief  Enable GPIO module interrupt signal
  *
- * @note Please do not use the interrupt of GPIO36 and GPIO39 when using ADC.
+ * @note Please do not use the interrupt of GPIO36 and GPIO39 when using ADC or Wi-Fi with sleep mode enabled.
  *       Please refer to the comments of `adc1_get_raw`.
  *       Please refer to section 3.11 of 'ECO_and_Workarounds_for_Bugs_in_ESP32' for the description of this issue.
+ *       As a workaround, call adc_power_acquire() in the app. This will result in higher power consumption (by ~1mA),
+ *       but will remove the glitches on GPIO36 and GPIO39.
  *
  * @param  gpio_num GPIO number. If you want to enable an interrupt on e.g. GPIO16, gpio_num should be GPIO_NUM_16 (16);
  *

Original file line number	Diff line number	Diff line change
`@@ -95,9 +95,11 @@ esp_err_t gpio_set_intr_type(gpio_num_t gpio_num, gpio_int_type_t intr_type);`
`95`	`95`	`/**`
`96`	`96`	`* @brief Enable GPIO module interrupt signal`
`97`	`97`	`*`
`98`		`- * @note Please do not use the interrupt of GPIO36 and GPIO39 when using ADC.`
	`98`	`+ * @note Please do not use the interrupt of GPIO36 and GPIO39 when using ADC or Wi-Fi with sleep mode enabled.`
`99`	`99`	* Please refer to the comments of `adc1_get_raw`.
`100`	`100`	`* Please refer to section 3.11 of 'ECO_and_Workarounds_for_Bugs_in_ESP32' for the description of this issue.`
	`101`	`+ * As a workaround, call adc_power_acquire() in the app. This will result in higher power consumption (by ~1mA),`
	`102`	`+ * but will remove the glitches on GPIO36 and GPIO39.`
`101`	`103`	`*`
`102`	`104`	`* @param gpio_num GPIO number. If you want to enable an interrupt on e.g. GPIO16, gpio_num should be GPIO_NUM_16 (16);`
`103`	`105`	`*`