I2S documentation refers to non-existent i2s_adc_start/stop() functions (IDFGH-578)

[detly]

The documentation for I2S, specifically the is2_read() function, refers to functions i2s_adc_start and i2s_adc_stop:

Note: If the built-in ADC mode is enabled, we should call i2s_adc_start and i2s_adc_stop around the whole reading process, to prevent the data getting corrupted.

These functions don't appear anywhere in the source code (for I2S or the whole IDF library as far as I can tell).

[itaisod]

Indeed.

[mehmetcanbalci-Notrino]

They are doing deliberately

[giPeteR]

I'm having a hard time getting the I2S ADC DMA to work in >4.0.
Confusing documentation still mentioning i2s_adc_start and i2s_adc_stop doesn't help:
https://docs.espressif.com/projects/esp-idf/en/release-v4.1/api-reference/peripherals/i2s.html

The example:
\examples\peripherals\i2s_adc_dac
works in 4.0, but in 4.2-dev the ADC works about every 4'th reset, DAC never works.

[koobest]

Hi,@detly
We will update the DOC
@giPeteR
Can you please open a new issue?

thanks !!