Skip to content

Commit

Permalink
docs/psoc6/quickref.rst: Updated I2S section with diff to ref API.
Browse files Browse the repository at this point in the history
Signed-off-by: enriquezgarc <enriquezgarcia.external@infineon.com>
  • Loading branch information
jaenrig-ifx authored and actions-user committed May 29, 2024
1 parent 2a96706 commit dd896c6
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions docs/psoc6/quickref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -669,12 +669,25 @@ I2S bus

See :ref:`machine.I2S <machine.I2S>`.

.. note::
The only difference with the reference API is the usage of the ``id`` in the constructor ``IS2()``. In the PSoC6 port the ``id`` value is ignored.
Any integer value can be passed as ``id``.
New instances of the I2S class will be allocated as long as there are available slots and the chosen I2S pins aren't already allocated by other instance.
The following specialization applies to this port:

Constructor
-----------

.. class:: I2S(id, *, sck, ws, sd, mck=None, mode, bits, format, rate, ibuf)

Construct an I2S object of the given id:

- ``id`` takes any integer (This value is ignored for PSoC6 port)

Keyword-only parameters:

- ``rate`` specifies audio sampling rate (Hz);
this is the frequency of the ``ws`` signal. Supported sample rates are 8KHz, 16KHz, 32KHz, 48KHz, 22.05KHz, 44.1KHz.

- ``mck`` is not implemented.

Supported sample rates are 8KHz, 16KHz, 32KHz, 48KHz, 22.05KHz, 44.1KHz.
The rest of the parameters match the reference API.

::

Expand Down

0 comments on commit dd896c6

Please sign in to comment.