From e2d9925b9ae5acef32a1a81f32a11c42bbd6acdd Mon Sep 17 00:00:00 2001 From: "maple \"mavica\" syrup" Date: Mon, 25 Mar 2024 18:50:51 -0300 Subject: [PATCH] docs/library/machine.I2S: Describe new PDM RX mode. Signed-off-by: maple "mavica" syrup --- docs/library/machine.I2S.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/library/machine.I2S.rst b/docs/library/machine.I2S.rst index 84edb94e78..907f97c50c 100644 --- a/docs/library/machine.I2S.rst +++ b/docs/library/machine.I2S.rst @@ -82,7 +82,7 @@ other things. For these drivers see: Constructor ----------- -.. class:: I2S(id, *, sck, ws, sd, mck=None, mode, bits, format, rate, ibuf) +.. class:: I2S(id, *, sck, ws=None, sd, mck=None, mode, bits, format, rate, ibuf) Construct an I2S object of the given id: @@ -91,7 +91,8 @@ Constructor Keyword-only parameters that are supported on all ports: - ``sck`` is a pin object for the serial clock line - - ``ws`` is a pin object for the word select line + - ``ws`` is a pin object for the word select line; + can be left unset if using ``I2S.PDM_RX`` mode - ``sd`` is a pin object for the serial data line - ``mck`` is a pin object for the master clock line; master clock frequency is sampling rate * 256 @@ -155,6 +156,10 @@ Constants for initialising the I2S bus ``mode`` to transmit +.. data:: I2S.PDM_RX + + for initialising the I2S bus ``mode`` to receive in PDM mode + .. data:: I2S.STEREO for initialising the I2S bus ``format`` to stereo