Skip to content

Commit

Permalink
docs/psoc6: Clock API Documentation.
Browse files Browse the repository at this point in the history
Signed-off-by: IFX-Anusha <[email protected]>
  • Loading branch information
IFX-Anusha committed Oct 23, 2024
1 parent 64f66a1 commit 8f85718
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/psoc6/quickref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,13 @@ The :mod:`machine` module::

import machine

machine.freq() # get the current frequency of the CPU
machine.freq() # get the current frequency of the Core M4
machine.freq(CM4, freq) # set the frequency of the Core M4 sourced by PLL to freq. Value of freq can be upto 150 MHz
machine.freq(CM4_FLL, freq) # set the frequency of the Core M4 sourced by FLL to freq. Value of freq can be upto 48 MHz
machine.freq(AUDIO_I2S_98_MHZ) # set the frequency of the I2S clock to 98 MHz
machine.freq(AUDIO_I2S_90_MHZ) # set the frequency of the I2S clock to 90 MHz
machine.freq(AUDIO_PDM_24_576_000_HZ) # set the frequency of the I2S clock to 24576000 HZ
machine.freq(AUDIO_PDM_22_579_200_HZ) # set the frequency of the I2S clock to 22579200 HZ

Delay and timing
----------------
Expand Down Expand Up @@ -548,6 +554,11 @@ See :ref:`machine.I2S <machine.I2S>`.

The following specialization applies to this port:

Before using the I2S bus, the I2S clock frequency needs to be set. The I2S clock frequency can be set to 98 MHz or 90 MHz. The I2S clock frequency can be set using the following function:

machine.freq(AUDIO_I2S_98_MHZ) # set the frequency of the I2S clock to 98 MHz. For sample rates: 8KHz / 16 KHz / 32 KHz / 48 KHz
machine.freq(AUDIO_I2S_90_MHZ) # set the frequency of the I2S clock to 90 MHz. For sample rates: 22.05 KHz / 44.1 KHz

Constructor
^^^^^^^^^^^^

Expand Down

0 comments on commit 8f85718

Please sign in to comment.