€•Z      Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”Œ//translations/zh_CN/driver-api/soundwire/stream”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ//translations/zh_TW/driver-api/soundwire/stream”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ//translations/it_IT/driver-api/soundwire/stream”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ//translations/ja_JP/driver-api/soundwire/stream”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ//translations/ko_KR/driver-api/soundwire/stream”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒPortuguese (Brazilian)”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ//translations/pt_BR/driver-api/soundwire/stream”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh–sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ//translations/sp_SP/driver-api/soundwire/stream”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒAudio Stream in SoundWire”h]”hŒAudio Stream in SoundWire”…””}”(hh¼h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhh·h²hh³ŒI/var/lib/git/docbuild/linux/Documentation/driver-api/soundwire/stream.rst”h´KubhŒ	paragraph”“”)”}”(hŒBAn audio stream is a logical or virtual connection created between”h]”hŒBAn audio stream is a logical or virtual connection created between”…””}”(hhÍh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khh·h²hubhŒblock_quote”“”)”}”(hŒ…(1) System memory buffer(s) and Codec(s)

(2) DSP memory buffer(s) and Codec(s)

(3) FIFO(s) and Codec(s)

(4) Codec(s) and Codec(s)
”h]”hŒenumerated_list”“”)”}”(hhh]”(hŒ	list_item”“”)”}”(hŒ%System memory buffer(s) and Codec(s)
”h]”hÌ)”}”(hŒ$System memory buffer(s) and Codec(s)”h]”hŒ$System memory buffer(s) and Codec(s)”…””}”(hhìh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khhèubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhhãubhç)”}”(hŒ"DSP memory buffer(s) and Codec(s)
”h]”hÌ)”}”(hŒ!DSP memory buffer(s) and Codec(s)”h]”hŒ!DSP memory buffer(s) and Codec(s)”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K	hj   ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhhãubhç)”}”(hŒFIFO(s) and Codec(s)
”h]”hÌ)”}”(hŒFIFO(s) and Codec(s)”h]”hŒFIFO(s) and Codec(s)”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhhãubhç)”}”(hŒCodec(s) and Codec(s)
”h]”hÌ)”}”(hŒCodec(s) and Codec(s)”h]”hŒCodec(s) and Codec(s)”…””}”(hj4  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khj0  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhhãubeh}”(h]”h ]”h"]”h$]”h&]”Œenumtype”Œarabic”Œprefix”Œ(”Œsuffix”Œ)”uh1háhhÝubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛh³hÊh´Khh·h²hubhÌ)”}”(hŒÇwhich is typically driven by a DMA(s) channel through the data link. An
audio stream contains one or more channels of data. All channels within
stream must have same sample rate and same sample size.”h]”hŒÇwhich is typically driven by a DMA(s) channel through the data link. An
audio stream contains one or more channels of data. All channels within
stream must have same sample rate and same sample size.”…””}”(hjZ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khh·h²hubhÌ)”}”(hŒ“Assume a stream with two channels (Left & Right) is opened using SoundWire
interface. Below are some ways a stream can be represented in SoundWire.”h]”hŒ“Assume a stream with two channels (Left & Right) is opened using SoundWire
interface. Below are some ways a stream can be represented in SoundWire.”…””}”(hjh  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khh·h²hubhÌ)”}”(hŒ?Stream Sample in memory (System memory, DSP memory or FIFOs) ::”h]”hŒ<Stream Sample in memory (System memory, DSP memory or FIFOs)”…””}”(hjv  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khh·h²hubhŒliteral_block”“”)”}”(hŒM-------------------------
| L | R | L | R | L | R |
-------------------------”h]”hŒM-------------------------
| L | R | L | R | L | R |
-------------------------”…””}”hj†  sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1j„  h³hÊh´Khh·h²hubhÌ)”}”(hŒExample 1: Stereo Stream with L and R channels is rendered from Master to
Slave. Both Master and Slave is using single port. ::”h]”hŒ|Example 1: Stereo Stream with L and R channels is rendered from Master to
Slave. Both Master and Slave is using single port.”…””}”(hj–  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khh·h²hubj…  )”}”(hX'  +---------------+                    Clock Signal  +---------------+
|    Master     +----------------------------------+     Slave     |
|   Interface   |                                  |   Interface   |
|               |                                  |       1       |
|               |                     Data Signal  |               |
|    L  +  R    +----------------------------------+    L  +  R    |
|     (Data)    |     Data Direction               |     (Data)    |
+---------------+  +----------------------->       +---------------+”h]”hX'  +---------------+                    Clock Signal  +---------------+
|    Master     +----------------------------------+     Slave     |
|   Interface   |                                  |   Interface   |
|               |                                  |       1       |
|               |                     Data Signal  |               |
|    L  +  R    +----------------------------------+    L  +  R    |
|     (Data)    |     Data Direction               |     (Data)    |
+---------------+  +----------------------->       +---------------+”…””}”hj¤  sbah}”(h]”h ]”h"]”h$]”h&]”j”  j•  uh1j„  h³hÊh´Khh·h²hubhÌ)”}”(hŒExample 2: Stereo Stream with L and R channels is captured from Slave to
Master. Both Master and Slave is using single port. ::”h]”hŒ|Example 2: Stereo Stream with L and R channels is captured from Slave to
Master. Both Master and Slave is using single port.”…””}”(hj²  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K)hh·h²hubj…  )”}”(hX'  +---------------+                    Clock Signal  +---------------+
|    Master     +----------------------------------+     Slave     |
|   Interface   |                                  |   Interface   |
|               |                                  |       1       |
|               |                     Data Signal  |               |
|    L  +  R    +----------------------------------+    L  +  R    |
|     (Data)    |     Data Direction               |     (Data)    |
+---------------+  <-----------------------+       +---------------+”h]”hX'  +---------------+                    Clock Signal  +---------------+
|    Master     +----------------------------------+     Slave     |
|   Interface   |                                  |   Interface   |
|               |                                  |       1       |
|               |                     Data Signal  |               |
|    L  +  R    +----------------------------------+    L  +  R    |
|     (Data)    |     Data Direction               |     (Data)    |
+---------------+  <-----------------------+       +---------------+”…””}”hjÀ  sbah}”(h]”h ]”h"]”h$]”h&]”j”  j•  uh1j„  h³hÊh´K-hh·h²hubhÌ)”}”(hŒ·Example 3: Stereo Stream with L and R channels is rendered by Master. Each
of the L and R channel is received by two different Slaves. Master and both
Slaves are using single port. ::”h]”hŒ´Example 3: Stereo Stream with L and R channels is rendered by Master. Each
of the L and R channel is received by two different Slaves. Master and both
Slaves are using single port.”…””}”(hjÎ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K7hh·h²hubj…  )”}”(hX‡  +---------------+                    Clock Signal  +---------------+
|    Master     +---------+------------------------+     Slave     |
|   Interface   |         |                        |   Interface   |
|               |         |                        |       1       |
|               |         |           Data Signal  |               |
|    L  +  R    +---+------------------------------+       L       |
|     (Data)    |   |     |    Data Direction      |     (Data)    |
+---------------+   |     |   +------------->      +---------------+
                    |     |
                    |     |
                    |     |                        +---------------+
                    |     +----------------------> |     Slave     |
                    |                              |   Interface   |
                    |                              |       2       |
                    |                              |               |
                    +----------------------------> |       R       |
                                                   |     (Data)    |
                                                   +---------------+”h]”hX‡  +---------------+                    Clock Signal  +---------------+
|    Master     +---------+------------------------+     Slave     |
|   Interface   |         |                        |   Interface   |
|               |         |                        |       1       |
|               |         |           Data Signal  |               |
|    L  +  R    +---+------------------------------+       L       |
|     (Data)    |   |     |    Data Direction      |     (Data)    |
+---------------+   |     |   +------------->      +---------------+
                    |     |
                    |     |
                    |     |                        +---------------+
                    |     +----------------------> |     Slave     |
                    |                              |   Interface   |
                    |                              |       2       |
                    |                              |               |
                    +----------------------------> |       R       |
                                                   |     (Data)    |
                                                   +---------------+”…””}”hjÜ  sbah}”(h]”h ]”h"]”h$]”h&]”j”  j•  uh1j„  h³hÊh´K;hh·h²hubhÌ)”}”(hX^  Example 4: Stereo Stream with L and R channels is rendered by
Master. Both of the L and R channels are received by two different
Slaves. Master and both Slaves are using single port handling
L+R. Each Slave device processes the L + R data locally, typically
based on static configuration or dynamic orientation, and may drive
one or more speakers. ::”h]”hX[  Example 4: Stereo Stream with L and R channels is rendered by
Master. Both of the L and R channels are received by two different
Slaves. Master and both Slaves are using single port handling
L+R. Each Slave device processes the L + R data locally, typically
based on static configuration or dynamic orientation, and may drive
one or more speakers.”…””}”(hjê  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KNhh·h²hubj…  )”}”(hX‡  +---------------+                    Clock Signal  +---------------+
|    Master     +---------+------------------------+     Slave     |
|   Interface   |         |                        |   Interface   |
|               |         |                        |       1       |
|               |         |           Data Signal  |               |
|    L  +  R    +---+------------------------------+     L + R     |
|     (Data)    |   |     |    Data Direction      |     (Data)    |
+---------------+   |     |   +------------->      +---------------+
                    |     |
                    |     |
                    |     |                        +---------------+
                    |     +----------------------> |     Slave     |
                    |                              |   Interface   |
                    |                              |       2       |
                    |                              |               |
                    +----------------------------> |     L + R     |
                                                   |     (Data)    |
                                                   +---------------+”h]”hX‡  +---------------+                    Clock Signal  +---------------+
|    Master     +---------+------------------------+     Slave     |
|   Interface   |         |                        |   Interface   |
|               |         |                        |       1       |
|               |         |           Data Signal  |               |
|    L  +  R    +---+------------------------------+     L + R     |
|     (Data)    |   |     |    Data Direction      |     (Data)    |
+---------------+   |     |   +------------->      +---------------+
                    |     |
                    |     |
                    |     |                        +---------------+
                    |     +----------------------> |     Slave     |
                    |                              |   Interface   |
                    |                              |       2       |
                    |                              |               |
                    +----------------------------> |     L + R     |
                                                   |     (Data)    |
                                                   +---------------+”…””}”hjø  sbah}”(h]”h ]”h"]”h$]”h&]”j”  j•  uh1j„  h³hÊh´KUhh·h²hubhÌ)”}”(hŒExample 5: Stereo Stream with L and R channel is rendered by two different
Ports of the Master and is received by only single Port of the Slave
interface. ::”h]”hŒšExample 5: Stereo Stream with L and R channel is rendered by two different
Ports of the Master and is received by only single Port of the Slave
interface.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khhh·h²hubj…  )”}”(hX  +--------------------+
|                    |
|     +--------------+                             +----------------+
|     |             ||                             |                |
|     |  Data Port  ||  L Channel                  |                |
|     |      1      |------------+                 |                |
|     |  L Channel  ||           |                 +-----+----+     |
|     |   (Data)    ||           |   L + R Channel ||    Data |     |
| Master  +----------+           | +---+---------> ||    Port |     |
| Interface          |           |                 ||     1   |     |
|     +--------------+           |                 ||         |     |
|     |             ||           |                 +----------+     |
|     |  Data Port  |------------+                 |                |
|     |      2      ||  R Channel                  |     Slave      |
|     |  R Channel  ||                             |   Interface    |
|     |   (Data)    ||                             |       1        |
|     +--------------+         Clock Signal        |     L  +  R    |
|                    +---------------------------> |      (Data)    |
+--------------------+                             |                |
                                                   +----------------+”h]”hX  +--------------------+
|                    |
|     +--------------+                             +----------------+
|     |             ||                             |                |
|     |  Data Port  ||  L Channel                  |                |
|     |      1      |------------+                 |                |
|     |  L Channel  ||           |                 +-----+----+     |
|     |   (Data)    ||           |   L + R Channel ||    Data |     |
| Master  +----------+           | +---+---------> ||    Port |     |
| Interface          |           |                 ||     1   |     |
|     +--------------+           |                 ||         |     |
|     |             ||           |                 +----------+     |
|     |  Data Port  |------------+                 |                |
|     |      2      ||  R Channel                  |     Slave      |
|     |  R Channel  ||                             |   Interface    |
|     |   (Data)    ||                             |       1        |
|     +--------------+         Clock Signal        |     L  +  R    |
|                    +---------------------------> |      (Data)    |
+--------------------+                             |                |
                                                   +----------------+”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”j”  j•  uh1j„  h³hÊh´Klhh·h²hubhÌ)”}”(hŒßExample 6: Stereo Stream with L and R channel is rendered by 2 Masters, each
rendering one channel, and is received by two different Slaves, each
receiving one channel. Both Masters and both Slaves are using single port. ::”h]”hŒÜExample 6: Stereo Stream with L and R channel is rendered by 2 Masters, each
rendering one channel, and is received by two different Slaves, each
receiving one channel. Both Masters and both Slaves are using single port.”…””}”(hj"  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khh·h²hubj…  )”}”(hXP  +---------------+                    Clock Signal  +---------------+
|    Master     +----------------------------------+     Slave     |
|   Interface   |                                  |   Interface   |
|       1       |                                  |       1       |
|               |                     Data Signal  |               |
|       L       +----------------------------------+       L       |
|     (Data)    |     Data Direction               |     (Data)    |
+---------------+  +----------------------->       +---------------+

+---------------+                    Clock Signal  +---------------+
|    Master     +----------------------------------+     Slave     |
|   Interface   |                                  |   Interface   |
|       2       |                                  |       2       |
|               |                     Data Signal  |               |
|       R       +----------------------------------+       R       |
|     (Data)    |     Data Direction               |     (Data)    |
+---------------+  +----------------------->       +---------------+”h]”hXP  +---------------+                    Clock Signal  +---------------+
|    Master     +----------------------------------+     Slave     |
|   Interface   |                                  |   Interface   |
|       1       |                                  |       1       |
|               |                     Data Signal  |               |
|       L       +----------------------------------+       L       |
|     (Data)    |     Data Direction               |     (Data)    |
+---------------+  +----------------------->       +---------------+

+---------------+                    Clock Signal  +---------------+
|    Master     +----------------------------------+     Slave     |
|   Interface   |                                  |   Interface   |
|       2       |                                  |       2       |
|               |                     Data Signal  |               |
|       R       +----------------------------------+       R       |
|     (Data)    |     Data Direction               |     (Data)    |
+---------------+  +----------------------->       +---------------+”…””}”hj0  sbah}”(h]”h ]”h"]”h$]”h&]”j”  j•  uh1j„  h³hÊh´K…hh·h²hubhÌ)”}”(hŒ×Example 7: Stereo Stream with L and R channel is rendered by 2
Masters, each rendering both channels. Each Slave receives L + R. This
is the same application as Example 4 but with Slaves placed on
separate links. ::”h]”hŒÔExample 7: Stereo Stream with L and R channel is rendered by 2
Masters, each rendering both channels. Each Slave receives L + R. This
is the same application as Example 4 but with Slaves placed on
separate links.”…””}”(hj>  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K—hh·h²hubj…  )”}”(hXP  +---------------+                    Clock Signal  +---------------+
|    Master     +----------------------------------+     Slave     |
|   Interface   |                                  |   Interface   |
|       1       |                                  |       1       |
|               |                     Data Signal  |               |
|     L + R     +----------------------------------+     L + R     |
|     (Data)    |     Data Direction               |     (Data)    |
+---------------+  +----------------------->       +---------------+

+---------------+                    Clock Signal  +---------------+
|    Master     +----------------------------------+     Slave     |
|   Interface   |                                  |   Interface   |
|       2       |                                  |       2       |
|               |                     Data Signal  |               |
|     L + R     +----------------------------------+     L + R     |
|     (Data)    |     Data Direction               |     (Data)    |
+---------------+  +----------------------->       +---------------+”h]”hXP  +---------------+                    Clock Signal  +---------------+
|    Master     +----------------------------------+     Slave     |
|   Interface   |                                  |   Interface   |
|       1       |                                  |       1       |
|               |                     Data Signal  |               |
|     L + R     +----------------------------------+     L + R     |
|     (Data)    |     Data Direction               |     (Data)    |
+---------------+  +----------------------->       +---------------+

+---------------+                    Clock Signal  +---------------+
|    Master     +----------------------------------+     Slave     |
|   Interface   |                                  |   Interface   |
|       2       |                                  |       2       |
|               |                     Data Signal  |               |
|     L + R     +----------------------------------+     L + R     |
|     (Data)    |     Data Direction               |     (Data)    |
+---------------+  +----------------------->       +---------------+”…””}”hjL  sbah}”(h]”h ]”h"]”h$]”h&]”j”  j•  uh1j„  h³hÊh´Kœhh·h²hubhÌ)”}”(hŒuExample 8: 4-channel Stream is rendered by 2 Masters, each rendering a
2 channels. Each Slave receives 2 channels. ::”h]”hŒrExample 8: 4-channel Stream is rendered by 2 Masters, each rendering a
2 channels. Each Slave receives 2 channels.”…””}”(hjZ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K®hh·h²hubj…  )”}”(hXP  +---------------+                    Clock Signal  +---------------+
|    Master     +----------------------------------+     Slave     |
|   Interface   |                                  |   Interface   |
|       1       |                                  |       1       |
|               |                     Data Signal  |               |
|    L1 + R1    +----------------------------------+    L1 + R1    |
|     (Data)    |     Data Direction               |     (Data)    |
+---------------+  +----------------------->       +---------------+

+---------------+                    Clock Signal  +---------------+
|    Master     +----------------------------------+     Slave     |
|   Interface   |                                  |   Interface   |
|       2       |                                  |       2       |
|               |                     Data Signal  |               |
|     L2 + R2   +----------------------------------+    L2 + R2    |
|     (Data)    |     Data Direction               |     (Data)    |
+---------------+  +----------------------->       +---------------+”h]”hXP  +---------------+                    Clock Signal  +---------------+
|    Master     +----------------------------------+     Slave     |
|   Interface   |                                  |   Interface   |
|       1       |                                  |       1       |
|               |                     Data Signal  |               |
|    L1 + R1    +----------------------------------+    L1 + R1    |
|     (Data)    |     Data Direction               |     (Data)    |
+---------------+  +----------------------->       +---------------+

+---------------+                    Clock Signal  +---------------+
|    Master     +----------------------------------+     Slave     |
|   Interface   |                                  |   Interface   |
|       2       |                                  |       2       |
|               |                     Data Signal  |               |
|     L2 + R2   +----------------------------------+    L2 + R2    |
|     (Data)    |     Data Direction               |     (Data)    |
+---------------+  +----------------------->       +---------------+”…””}”hjh  sbah}”(h]”h ]”h"]”h$]”h&]”j”  j•  uh1j„  h³hÊh´K±hh·h²hubhÌ)”}”(hX,  Note1: In multi-link cases like above, to lock, one would acquire a global
lock and then go on locking bus instances. But, in this case the caller
framework(ASoC DPCM) guarantees that stream operations on a card are
always serialized. So, there is no race condition and hence no need for
global lock.”h]”hX,  Note1: In multi-link cases like above, to lock, one would acquire a global
lock and then go on locking bus instances. But, in this case the caller
framework(ASoC DPCM) guarantees that stream operations on a card are
always serialized. So, there is no race condition and hence no need for
global lock.”…””}”(hjv  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KÃhh·h²hubhÌ)”}”(hX  Note2: A Slave device may be configured to receive all channels
transmitted on a link for a given Stream (Example 4) or just a subset
of the data (Example 3). The configuration of the Slave device is not
handled by a SoundWire subsystem API, but instead by the
snd_soc_dai_set_tdm_slot() API. The platform or machine driver will
typically configure which of the slots are used. For Example 4, the
same slots would be used by all Devices, while for Example 3 the Slave
Device1 would use e.g. Slot 0 and Slave device2 slot 1.”h]”hX  Note2: A Slave device may be configured to receive all channels
transmitted on a link for a given Stream (Example 4) or just a subset
of the data (Example 3). The configuration of the Slave device is not
handled by a SoundWire subsystem API, but instead by the
snd_soc_dai_set_tdm_slot() API. The platform or machine driver will
typically configure which of the slots are used. For Example 4, the
same slots would be used by all Devices, while for Example 3 the Slave
Device1 would use e.g. Slot 0 and Slave device2 slot 1.”…””}”(hj„  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KÉhh·h²hubhÌ)”}”(hŒúNote3: Multiple Sink ports can extract the same information for the
same bitSlots in the SoundWire frame, however multiple Source ports
shall be configured with different bitSlot configurations. This is the
same limitation as with I2S/PCM TDM usages.”h]”hŒúNote3: Multiple Sink ports can extract the same information for the
same bitSlots in the SoundWire frame, however multiple Source ports
shall be configured with different bitSlot configurations. This is the
same limitation as with I2S/PCM TDM usages.”…””}”(hj’  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KÒhh·h²hubh¶)”}”(hhh]”(h»)”}”(hŒ SoundWire Stream Management flow”h]”hŒ SoundWire Stream Management flow”…””}”(hj£  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj   h²hh³hÊh´KØubh¶)”}”(hhh]”(h»)”}”(hŒStream definitions”h]”hŒStream definitions”…””}”(hj´  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj±  h²hh³hÊh´KÛubhÜ)”}”(hX7  (1) Current stream: This is classified as the stream on which operation has
    to be performed like prepare, enable, disable, de-prepare etc.

(2) Active stream: This is classified as the stream which is already active
    on Bus other than current stream. There can be multiple active streams
    on the Bus.
”h]”hâ)”}”(hhh]”(hç)”}”(hŒ‡Current stream: This is classified as the stream on which operation has
to be performed like prepare, enable, disable, de-prepare etc.
”h]”hÌ)”}”(hŒ†Current stream: This is classified as the stream on which operation has
to be performed like prepare, enable, disable, de-prepare etc.”h]”hŒ†Current stream: This is classified as the stream on which operation has
to be performed like prepare, enable, disable, de-prepare etc.”…””}”(hjÍ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KÝhjÉ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhjÆ  ubhç)”}”(hŒ›Active stream: This is classified as the stream which is already active
on Bus other than current stream. There can be multiple active streams
on the Bus.
”h]”hÌ)”}”(hŒšActive stream: This is classified as the stream which is already active
on Bus other than current stream. There can be multiple active streams
on the Bus.”h]”hŒšActive stream: This is classified as the stream which is already active
on Bus other than current stream. There can be multiple active streams
on the Bus.”…””}”(hjå  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kàhjá  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhjÆ  ubeh}”(h]”h ]”h"]”h$]”h&]”jN  jO  jP  jQ  jR  jS  uh1háhjÂ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛh³hÊh´KÝhj±  h²hubhÌ)”}”(hX  SoundWire Bus manages stream operations for each stream getting
rendered/captured on the SoundWire Bus. This section explains Bus operations
done for each of the stream allocated/released on Bus. Following are the
stream states maintained by the Bus for each of the audio stream.”h]”hX  SoundWire Bus manages stream operations for each stream getting
rendered/captured on the SoundWire Bus. This section explains Bus operations
done for each of the stream allocated/released on Bus. Following are the
stream states maintained by the Bus for each of the audio stream.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kähj±  h²hubeh}”(h]”Œstream-definitions”ah ]”h"]”Œstream definitions”ah$]”h&]”uh1hµhj   h²hh³hÊh´KÛubh¶)”}”(hhh]”(h»)”}”(hŒSoundWire stream states”h]”hŒSoundWire stream states”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj  h²hh³hÊh´KëubhÌ)”}”(hŒHBelow shows the SoundWire stream states and state transition diagram. ::”h]”hŒEBelow shows the SoundWire stream states and state transition diagram.”…””}”(hj,  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kíhj  h²hubj…  )”}”(hXH  +-----------+     +------------+     +----------+     +----------+
| ALLOCATED +---->| CONFIGURED +---->| PREPARED +---->| ENABLED  |
|   STATE   |     |    STATE   |     |  STATE   |     |  STATE   |
+-----------+     +------------+     +---+--+---+     +----+-----+
                                         ^  ^              ^
                                         |  |              |
                                       __|  |___________   |
                                      |                 |  |
                                      v                 |  v
         +----------+           +-----+------+        +-+--+-----+
         | RELEASED |<----------+ DEPREPARED |<-------+ DISABLED |
         |  STATE   |           |   STATE    |        |  STATE   |
         +----------+           +------------+        +----------+”h]”hXH  +-----------+     +------------+     +----------+     +----------+
| ALLOCATED +---->| CONFIGURED +---->| PREPARED +---->| ENABLED  |
|   STATE   |     |    STATE   |     |  STATE   |     |  STATE   |
+-----------+     +------------+     +---+--+---+     +----+-----+
                                         ^  ^              ^
                                         |  |              |
                                       __|  |___________   |
                                      |                 |  |
                                      v                 |  v
         +----------+           +-----+------+        +-+--+-----+
         | RELEASED |<----------+ DEPREPARED |<-------+ DISABLED |
         |  STATE   |           |   STATE    |        |  STATE   |
         +----------+           +------------+        +----------+”…””}”hj:  sbah}”(h]”h ]”h"]”h$]”h&]”j”  j•  uh1j„  h³hÊh´Kïhj  h²hubhÌ)”}”(hX  NOTE: State transitions between ``SDW_STREAM_ENABLED`` and
``SDW_STREAM_DISABLED`` are only relevant when then INFO_PAUSE flag is
supported at the ALSA/ASoC level. Likewise the transition between
``SDW_DISABLED_STATE`` and ``SDW_PREPARED_STATE`` depends on the
INFO_RESUME flag.”h]”(hŒ NOTE: State transitions between ”…””}”(hjH  h²hh³Nh´NubhŒliteral”“”)”}”(hŒ``SDW_STREAM_ENABLED``”h]”hŒSDW_STREAM_ENABLED”…””}”(hjR  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jP  hjH  ubhŒ and
”…””}”(hjH  h²hh³Nh´NubjQ  )”}”(hŒ``SDW_STREAM_DISABLED``”h]”hŒSDW_STREAM_DISABLED”…””}”(hjd  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jP  hjH  ubhŒr are only relevant when then INFO_PAUSE flag is
supported at the ALSA/ASoC level. Likewise the transition between
”…””}”(hjH  h²hh³Nh´NubjQ  )”}”(hŒ``SDW_DISABLED_STATE``”h]”hŒSDW_DISABLED_STATE”…””}”(hjv  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jP  hjH  ubhŒ and ”…””}”(hjH  h²hh³Nh´NubjQ  )”}”(hŒ``SDW_PREPARED_STATE``”h]”hŒSDW_PREPARED_STATE”…””}”(hjˆ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jP  hjH  ubhŒ! depends on the
INFO_RESUME flag.”…””}”(hjH  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kýhj  h²hubhÌ)”}”(hŒÔNOTE2: The framework implements basic state transition checks, but
does not e.g. check if a transition from DISABLED to ENABLED is valid
on a specific platform. Such tests need to be added at the ALSA/ASoC
level.”h]”hŒÔNOTE2: The framework implements basic state transition checks, but
does not e.g. check if a transition from DISABLED to ENABLED is valid
on a specific platform. Such tests need to be added at the ALSA/ASoC
level.”…””}”(hj   h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mhj  h²hubeh}”(h]”Œsoundwire-stream-states”ah ]”h"]”Œsoundwire stream states”ah$]”h&]”uh1hµhj   h²hh³hÊh´Këubh¶)”}”(hhh]”(h»)”}”(hŒStream State Operations”h]”hŒStream State Operations”…””}”(hj¹  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj¶  h²hh³hÊh´M	ubhÌ)”}”(hŒtBelow section explains the operations done by the Bus on Master(s) and
Slave(s) as part of stream state transitions.”h]”hŒtBelow section explains the operations done by the Bus on Master(s) and
Slave(s) as part of stream state transitions.”…””}”(hjÇ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mhj¶  h²hubh¶)”}”(hhh]”(h»)”}”(hŒSDW_STREAM_ALLOCATED”h]”hŒSDW_STREAM_ALLOCATED”…””}”(hjØ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjÕ  h²hh³hÊh´MubhÌ)”}”(hŒwAllocation state for stream. This is the entry state
of the stream. Operations performed before entering in this state:”h]”hŒwAllocation state for stream. This is the entry state
of the stream. Operations performed before entering in this state:”…””}”(hjæ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´MhjÕ  h²hubhÜ)”}”(hX¤  (1) A stream runtime is allocated for the stream. This stream
    runtime is used as a reference for all the operations performed
    on the stream.

(2) The resources required for holding stream runtime information are
    allocated and initialized. This holds all stream related information
    such as stream type (PCM/PDM) and parameters, Master and Slave
    interface associated with the stream, stream state etc.
”h]”hâ)”}”(hhh]”(hç)”}”(hŒ‰A stream runtime is allocated for the stream. This stream
runtime is used as a reference for all the operations performed
on the stream.
”h]”hÌ)”}”(hŒˆA stream runtime is allocated for the stream. This stream
runtime is used as a reference for all the operations performed
on the stream.”h]”hŒˆA stream runtime is allocated for the stream. This stream
runtime is used as a reference for all the operations performed
on the stream.”…””}”(hjÿ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mhjû  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhjø  ubhç)”}”(hŒþThe resources required for holding stream runtime information are
allocated and initialized. This holds all stream related information
such as stream type (PCM/PDM) and parameters, Master and Slave
interface associated with the stream, stream state etc.
”h]”hÌ)”}”(hŒýThe resources required for holding stream runtime information are
allocated and initialized. This holds all stream related information
such as stream type (PCM/PDM) and parameters, Master and Slave
interface associated with the stream, stream state etc.”h]”hŒýThe resources required for holding stream runtime information are
allocated and initialized. This holds all stream related information
such as stream type (PCM/PDM) and parameters, Master and Slave
interface associated with the stream, stream state etc.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhjø  ubeh}”(h]”h ]”h"]”h$]”h&]”jN  jO  jP  jQ  jR  jS  uh1háhjô  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛh³hÊh´MhjÕ  h²hubhÌ)”}”(hŒ[After all above operations are successful, stream state is set to
``SDW_STREAM_ALLOCATED``.”h]”(hŒBAfter all above operations are successful, stream state is set to
”…””}”(hj7  h²hh³Nh´NubjQ  )”}”(hŒ``SDW_STREAM_ALLOCATED``”h]”hŒSDW_STREAM_ALLOCATED”…””}”(hj?  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jP  hj7  ubhŒ.”…””}”(hj7  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´MhjÕ  h²hubhÌ)”}”(hŒªBus implements below API for allocate a stream which needs to be called once
per stream. From ASoC DPCM framework, this stream state maybe linked to
.startup() operation.”h]”hŒªBus implements below API for allocate a stream which needs to be called once
per stream. From ASoC DPCM framework, this stream state maybe linked to
.startup() operation.”…””}”(hjW  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M hjÕ  h²hubj…  )”}”(hŒDint sdw_alloc_stream(char * stream_name, enum sdw_stream_type type);”h]”hŒDint sdw_alloc_stream(char * stream_name, enum sdw_stream_type type);”…””}”hje  sbah}”(h]”h ]”h"]”h$]”h&]”j”  j•  Œforce”‰Œlanguage”Œc”Œhighlight_args”}”uh1j„  h³hÊh´M$hjÕ  h²hubhÌ)”}”(hŒÛThe SoundWire core provides a sdw_startup_stream() helper function,
typically called during a dailink .startup() callback, which performs
stream allocation and sets the stream pointer for all DAIs
connected to a stream.”h]”hŒÛThe SoundWire core provides a sdw_startup_stream() helper function,
typically called during a dailink .startup() callback, which performs
stream allocation and sets the stream pointer for all DAIs
connected to a stream.”…””}”(hjx  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M(hjÕ  h²hubeh}”(h]”Œsdw-stream-allocated”ah ]”h"]”Œsdw_stream_allocated”ah$]”h&]”uh1hµhj¶  h²hh³hÊh´Mubh¶)”}”(hhh]”(h»)”}”(hŒSDW_STREAM_CONFIGURED”h]”hŒSDW_STREAM_CONFIGURED”…””}”(hj‘  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjŽ  h²hh³hÊh´M.ubhÌ)”}”(hŒRConfiguration state of stream. Operations performed before entering in
this state:”h]”hŒRConfiguration state of stream. Operations performed before entering in
this state:”…””}”(hjŸ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M0hjŽ  h²hubhÜ)”}”(hX±  (1) The resources allocated for stream information in SDW_STREAM_ALLOCATED
    state are updated here. This includes stream parameters, Master(s)
    and Slave(s) runtime information associated with current stream.

(2) All the Master(s) and Slave(s) associated with current stream provide
    the port information to Bus which includes port numbers allocated by
    Master(s) and Slave(s) for current stream and their channel mask.
”h]”hâ)”}”(hhh]”(hç)”}”(hŒËThe resources allocated for stream information in SDW_STREAM_ALLOCATED
state are updated here. This includes stream parameters, Master(s)
and Slave(s) runtime information associated with current stream.
”h]”hÌ)”}”(hŒÊThe resources allocated for stream information in SDW_STREAM_ALLOCATED
state are updated here. This includes stream parameters, Master(s)
and Slave(s) runtime information associated with current stream.”h]”hŒÊThe resources allocated for stream information in SDW_STREAM_ALLOCATED
state are updated here. This includes stream parameters, Master(s)
and Slave(s) runtime information associated with current stream.”…””}”(hj¸  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M3hj´  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhj±  ubhç)”}”(hŒÍAll the Master(s) and Slave(s) associated with current stream provide
the port information to Bus which includes port numbers allocated by
Master(s) and Slave(s) for current stream and their channel mask.
”h]”hÌ)”}”(hŒÌAll the Master(s) and Slave(s) associated with current stream provide
the port information to Bus which includes port numbers allocated by
Master(s) and Slave(s) for current stream and their channel mask.”h]”hŒÌAll the Master(s) and Slave(s) associated with current stream provide
the port information to Bus which includes port numbers allocated by
Master(s) and Slave(s) for current stream and their channel mask.”…””}”(hjÐ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M7hjÌ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhj±  ubeh}”(h]”h ]”h"]”h$]”h&]”jN  jO  jP  jQ  jR  jS  uh1háhj­  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛh³hÊh´M3hjŽ  h²hubhÌ)”}”(hŒ\After all above operations are successful, stream state is set to
``SDW_STREAM_CONFIGURED``.”h]”(hŒBAfter all above operations are successful, stream state is set to
”…””}”(hjð  h²hh³Nh´NubjQ  )”}”(hŒ``SDW_STREAM_CONFIGURED``”h]”hŒSDW_STREAM_CONFIGURED”…””}”(hjø  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jP  hjð  ubhŒ.”…””}”(hjð  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M;hjŽ  h²hubhÌ)”}”(hX  Bus implements below APIs for CONFIG state which needs to be called by
the respective Master(s) and Slave(s) associated with stream. These APIs can
only be invoked once by respective Master(s) and Slave(s). From ASoC DPCM
framework, this stream state is linked to .hw_params() operation.”h]”hX  Bus implements below APIs for CONFIG state which needs to be called by
the respective Master(s) and Slave(s) associated with stream. These APIs can
only be invoked once by respective Master(s) and Slave(s). From ASoC DPCM
framework, this stream state is linked to .hw_params() operation.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M>hjŽ  h²hubj…  )”}”(hX±  int sdw_stream_add_master(struct sdw_bus * bus,
              struct sdw_stream_config * stream_config,
              const struct sdw_ports_config * ports_config,
              struct sdw_stream_runtime * stream);

int sdw_stream_add_slave(struct sdw_slave * slave,
              struct sdw_stream_config * stream_config,
              const struct sdw_ports_config * ports_config,
              struct sdw_stream_runtime * stream);”h]”hX±  int sdw_stream_add_master(struct sdw_bus * bus,
              struct sdw_stream_config * stream_config,
              const struct sdw_ports_config * ports_config,
              struct sdw_stream_runtime * stream);

int sdw_stream_add_slave(struct sdw_slave * slave,
              struct sdw_stream_config * stream_config,
              const struct sdw_ports_config * ports_config,
              struct sdw_stream_runtime * stream);”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”j”  j•  js  ‰jt  ju  jv  }”uh1j„  h³hÊh´MChjŽ  h²hubeh}”(h]”Œsdw-stream-configured”ah ]”h"]”Œsdw_stream_configured”ah$]”h&]”uh1hµhj¶  h²hh³hÊh´M.ubh¶)”}”(hhh]”(h»)”}”(hŒSDW_STREAM_PREPARED”h]”hŒSDW_STREAM_PREPARED”…””}”(hj8  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj5  h²hh³hÊh´MQubhÌ)”}”(hŒLPrepare state of stream. Operations performed before entering in this state:”h]”hŒLPrepare state of stream. Operations performed before entering in this state:”…””}”(hjF  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´MShj5  h²hubhÜ)”}”(hXx  (0) Steps 1 and 2 are omitted in the case of a resume operation,
    where the bus bandwidth is known.

(1) Bus parameters such as bandwidth, frame shape, clock frequency,
    are computed based on current stream as well as already active
    stream(s) on Bus. Re-computation is required to accommodate current
    stream on the Bus.

(2) Transport and port parameters of all Master(s) and Slave(s) port(s) are
    computed for the current as well as already active stream based on frame
    shape and clock frequency computed in step 1.

(3) Computed Bus and transport parameters are programmed in Master(s) and
    Slave(s) registers. The banked registers programming is done on the
    alternate bank (bank currently unused). Port(s) are enabled for the
    already active stream(s) on the alternate bank (bank currently unused).
    This is done in order to not disrupt already active stream(s).

(4) Once all the values are programmed, Bus initiates switch to alternate
    bank where all new values programmed gets into effect.

(5) Ports of Master(s) and Slave(s) for current stream are prepared by
    programming PrepareCtrl register.
”h]”hâ)”}”(hhh]”(hç)”}”(hŒ_Steps 1 and 2 are omitted in the case of a resume operation,
where the bus bandwidth is known.
”h]”hÌ)”}”(hŒ^Steps 1 and 2 are omitted in the case of a resume operation,
where the bus bandwidth is known.”h]”hŒ^Steps 1 and 2 are omitted in the case of a resume operation,
where the bus bandwidth is known.”…””}”(hj_  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´MUhj[  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhjX  ubhç)”}”(hŒÖBus parameters such as bandwidth, frame shape, clock frequency,
are computed based on current stream as well as already active
stream(s) on Bus. Re-computation is required to accommodate current
stream on the Bus.
”h]”hÌ)”}”(hŒÕBus parameters such as bandwidth, frame shape, clock frequency,
are computed based on current stream as well as already active
stream(s) on Bus. Re-computation is required to accommodate current
stream on the Bus.”h]”hŒÕBus parameters such as bandwidth, frame shape, clock frequency,
are computed based on current stream as well as already active
stream(s) on Bus. Re-computation is required to accommodate current
stream on the Bus.”…””}”(hjw  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´MXhjs  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhjX  ubhç)”}”(hŒ¿Transport and port parameters of all Master(s) and Slave(s) port(s) are
computed for the current as well as already active stream based on frame
shape and clock frequency computed in step 1.
”h]”hÌ)”}”(hŒ¾Transport and port parameters of all Master(s) and Slave(s) port(s) are
computed for the current as well as already active stream based on frame
shape and clock frequency computed in step 1.”h]”hŒ¾Transport and port parameters of all Master(s) and Slave(s) port(s) are
computed for the current as well as already active stream based on frame
shape and clock frequency computed in step 1.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M]hj‹  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhjX  ubhç)”}”(hXU  Computed Bus and transport parameters are programmed in Master(s) and
Slave(s) registers. The banked registers programming is done on the
alternate bank (bank currently unused). Port(s) are enabled for the
already active stream(s) on the alternate bank (bank currently unused).
This is done in order to not disrupt already active stream(s).
”h]”hÌ)”}”(hXT  Computed Bus and transport parameters are programmed in Master(s) and
Slave(s) registers. The banked registers programming is done on the
alternate bank (bank currently unused). Port(s) are enabled for the
already active stream(s) on the alternate bank (bank currently unused).
This is done in order to not disrupt already active stream(s).”h]”hXT  Computed Bus and transport parameters are programmed in Master(s) and
Slave(s) registers. The banked registers programming is done on the
alternate bank (bank currently unused). Port(s) are enabled for the
already active stream(s) on the alternate bank (bank currently unused).
This is done in order to not disrupt already active stream(s).”…””}”(hj§  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mahj£  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhjX  ubhç)”}”(hŒ}Once all the values are programmed, Bus initiates switch to alternate
bank where all new values programmed gets into effect.
”h]”hÌ)”}”(hŒ|Once all the values are programmed, Bus initiates switch to alternate
bank where all new values programmed gets into effect.”h]”hŒ|Once all the values are programmed, Bus initiates switch to alternate
bank where all new values programmed gets into effect.”…””}”(hj¿  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mghj»  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhjX  ubhç)”}”(hŒePorts of Master(s) and Slave(s) for current stream are prepared by
programming PrepareCtrl register.
”h]”hÌ)”}”(hŒdPorts of Master(s) and Slave(s) for current stream are prepared by
programming PrepareCtrl register.”h]”hŒdPorts of Master(s) and Slave(s) for current stream are prepared by
programming PrepareCtrl register.”…””}”(hj×  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´MjhjÓ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhjX  ubeh}”(h]”h ]”h"]”h$]”h&]”jN  jO  jP  jQ  jR  jS  Œstart”K uh1háhjT  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛh³hÊh´MUhj5  h²hubhÌ)”}”(hŒZAfter all above operations are successful, stream state is set to
``SDW_STREAM_PREPARED``.”h]”(hŒBAfter all above operations are successful, stream state is set to
”…””}”(hjø  h²hh³Nh´NubjQ  )”}”(hŒ``SDW_STREAM_PREPARED``”h]”hŒSDW_STREAM_PREPARED”…””}”(hj   h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jP  hjø  ubhŒ.”…””}”(hjø  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mmhj5  h²hubhÌ)”}”(hX<  Bus implements below API for PREPARE state which needs to be called
once per stream. From ASoC DPCM framework, this stream state is linked
to .prepare() operation. Since the .trigger() operations may not
follow the .prepare(), a direct transition from
``SDW_STREAM_PREPARED`` to ``SDW_STREAM_DEPREPARED`` is allowed.”h]”(hŒüBus implements below API for PREPARE state which needs to be called
once per stream. From ASoC DPCM framework, this stream state is linked
to .prepare() operation. Since the .trigger() operations may not
follow the .prepare(), a direct transition from
”…””}”(hj  h²hh³Nh´NubjQ  )”}”(hŒ``SDW_STREAM_PREPARED``”h]”hŒSDW_STREAM_PREPARED”…””}”(hj   h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jP  hj  ubhŒ to ”…””}”(hj  h²hh³Nh´NubjQ  )”}”(hŒ``SDW_STREAM_DEPREPARED``”h]”hŒSDW_STREAM_DEPREPARED”…””}”(hj2  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jP  hj  ubhŒ is allowed.”…””}”(hj  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mphj5  h²hubj…  )”}”(hŒ;int sdw_prepare_stream(struct sdw_stream_runtime * stream);”h]”hŒ;int sdw_prepare_stream(struct sdw_stream_runtime * stream);”…””}”hjJ  sbah}”(h]”h ]”h"]”h$]”h&]”j”  j•  js  ‰jt  ju  jv  }”uh1j„  h³hÊh´Mvhj5  h²hubeh}”(h]”Œsdw-stream-prepared”ah ]”h"]”Œsdw_stream_prepared”ah$]”h&]”uh1hµhj¶  h²hh³hÊh´MQubh¶)”}”(hhh]”(h»)”}”(hŒSDW_STREAM_ENABLED”h]”hŒSDW_STREAM_ENABLED”…””}”(hjd  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhja  h²hh³hÊh´M|ubhÌ)”}”(hŒ‚Enable state of stream. The data port(s) are enabled upon entering this state.
Operations performed before entering in this state:”h]”hŒ‚Enable state of stream. The data port(s) are enabled upon entering this state.
Operations performed before entering in this state:”…””}”(hjr  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M~hja  h²hubhÜ)”}”(hX  (1) All the values computed in SDW_STREAM_PREPARED state are programmed
    in alternate bank (bank currently unused). It includes programming of
    already active stream(s) as well.

(2) All the Master(s) and Slave(s) port(s) for the current stream are
    enabled on alternate bank (bank currently unused) by programming
    ChannelEn register.

(3) Once all the values are programmed, Bus initiates switch to alternate
    bank where all new values programmed gets into effect and port(s)
    associated with current stream are enabled.
”h]”hâ)”}”(hhh]”(hç)”}”(hŒ¬All the values computed in SDW_STREAM_PREPARED state are programmed
in alternate bank (bank currently unused). It includes programming of
already active stream(s) as well.
”h]”hÌ)”}”(hŒ«All the values computed in SDW_STREAM_PREPARED state are programmed
in alternate bank (bank currently unused). It includes programming of
already active stream(s) as well.”h]”hŒ«All the values computed in SDW_STREAM_PREPARED state are programmed
in alternate bank (bank currently unused). It includes programming of
already active stream(s) as well.”…””}”(hj‹  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mhj‡  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhj„  ubhç)”}”(hŒ—All the Master(s) and Slave(s) port(s) for the current stream are
enabled on alternate bank (bank currently unused) by programming
ChannelEn register.
”h]”hÌ)”}”(hŒ–All the Master(s) and Slave(s) port(s) for the current stream are
enabled on alternate bank (bank currently unused) by programming
ChannelEn register.”h]”hŒ–All the Master(s) and Slave(s) port(s) for the current stream are
enabled on alternate bank (bank currently unused) by programming
ChannelEn register.”…””}”(hj£  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M…hjŸ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhj„  ubhç)”}”(hŒ´Once all the values are programmed, Bus initiates switch to alternate
bank where all new values programmed gets into effect and port(s)
associated with current stream are enabled.
”h]”hÌ)”}”(hŒ³Once all the values are programmed, Bus initiates switch to alternate
bank where all new values programmed gets into effect and port(s)
associated with current stream are enabled.”h]”hŒ³Once all the values are programmed, Bus initiates switch to alternate
bank where all new values programmed gets into effect and port(s)
associated with current stream are enabled.”…””}”(hj»  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M‰hj·  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhj„  ubeh}”(h]”h ]”h"]”h$]”h&]”jN  jO  jP  jQ  jR  jS  uh1háhj€  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛh³hÊh´Mhja  h²hubhÌ)”}”(hŒYAfter all above operations are successful, stream state is set to
``SDW_STREAM_ENABLED``.”h]”(hŒBAfter all above operations are successful, stream state is set to
”…””}”(hjÛ  h²hh³Nh´NubjQ  )”}”(hŒ``SDW_STREAM_ENABLED``”h]”hŒSDW_STREAM_ENABLED”…””}”(hjã  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jP  hjÛ  ubhŒ.”…””}”(hjÛ  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mhja  h²hubhÌ)”}”(hŒ¨Bus implements below API for ENABLE state which needs to be called once per
stream. From ASoC DPCM framework, this stream state is linked to
.trigger() start operation.”h]”hŒ¨Bus implements below API for ENABLE state which needs to be called once per
stream. From ASoC DPCM framework, this stream state is linked to
.trigger() start operation.”…””}”(hjû  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mhja  h²hubj…  )”}”(hŒ:int sdw_enable_stream(struct sdw_stream_runtime * stream);”h]”hŒ:int sdw_enable_stream(struct sdw_stream_runtime * stream);”…””}”hj	  sbah}”(h]”h ]”h"]”h$]”h&]”j”  j•  js  ‰jt  ju  jv  }”uh1j„  h³hÊh´M”hja  h²hubeh}”(h]”Œsdw-stream-enabled”ah ]”h"]”Œsdw_stream_enabled”ah$]”h&]”uh1hµhj¶  h²hh³hÊh´M|ubh¶)”}”(hhh]”(h»)”}”(hŒSDW_STREAM_DISABLED”h]”hŒSDW_STREAM_DISABLED”…””}”(hj#  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj   h²hh³hÊh´M™ubhÌ)”}”(hŒƒDisable state of stream. The data port(s) are disabled upon exiting this state.
Operations performed before entering in this state:”h]”hŒƒDisable state of stream. The data port(s) are disabled upon exiting this state.
Operations performed before entering in this state:”…””}”(hj1  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M›hj   h²hubhÜ)”}”(hXå  (1) All the Master(s) and Slave(s) port(s) for the current stream are
    disabled on alternate bank (bank currently unused) by programming
    ChannelEn register.

(2) All the current configuration of Bus and active stream(s) are programmed
    into alternate bank (bank currently unused).

(3) Once all the values are programmed, Bus initiates switch to alternate
    bank where all new values programmed gets into effect and port(s) associated
    with current stream are disabled.
”h]”hâ)”}”(hhh]”(hç)”}”(hŒ˜All the Master(s) and Slave(s) port(s) for the current stream are
disabled on alternate bank (bank currently unused) by programming
ChannelEn register.
”h]”hÌ)”}”(hŒ—All the Master(s) and Slave(s) port(s) for the current stream are
disabled on alternate bank (bank currently unused) by programming
ChannelEn register.”h]”hŒ—All the Master(s) and Slave(s) port(s) for the current stream are
disabled on alternate bank (bank currently unused) by programming
ChannelEn register.”…””}”(hjJ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´MžhjF  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhjC  ubhç)”}”(hŒvAll the current configuration of Bus and active stream(s) are programmed
into alternate bank (bank currently unused).
”h]”hÌ)”}”(hŒuAll the current configuration of Bus and active stream(s) are programmed
into alternate bank (bank currently unused).”h]”hŒuAll the current configuration of Bus and active stream(s) are programmed
into alternate bank (bank currently unused).”…””}”(hjb  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M¢hj^  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhjC  ubhç)”}”(hŒµOnce all the values are programmed, Bus initiates switch to alternate
bank where all new values programmed gets into effect and port(s) associated
with current stream are disabled.
”h]”hÌ)”}”(hŒ´Once all the values are programmed, Bus initiates switch to alternate
bank where all new values programmed gets into effect and port(s) associated
with current stream are disabled.”h]”hŒ´Once all the values are programmed, Bus initiates switch to alternate
bank where all new values programmed gets into effect and port(s) associated
with current stream are disabled.”…””}”(hjz  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M¥hjv  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhjC  ubeh}”(h]”h ]”h"]”h$]”h&]”jN  jO  jP  jQ  jR  jS  uh1háhj?  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛh³hÊh´Mžhj   h²hubhÌ)”}”(hŒZAfter all above operations are successful, stream state is set to
``SDW_STREAM_DISABLED``.”h]”(hŒBAfter all above operations are successful, stream state is set to
”…””}”(hjš  h²hh³Nh´NubjQ  )”}”(hŒ``SDW_STREAM_DISABLED``”h]”hŒSDW_STREAM_DISABLED”…””}”(hj¢  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jP  hjš  ubhŒ.”…””}”(hjš  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M©hj   h²hubhÌ)”}”(hŒ©Bus implements below API for DISABLED state which needs to be called once
per stream. From ASoC DPCM framework, this stream state is linked to
.trigger() stop operation.”h]”hŒ©Bus implements below API for DISABLED state which needs to be called once
per stream. From ASoC DPCM framework, this stream state is linked to
.trigger() stop operation.”…””}”(hjº  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M¬hj   h²hubhÌ)”}”(hŒ`When the INFO_PAUSE flag is supported, a direct transition to
``SDW_STREAM_ENABLED`` is allowed.”h]”(hŒ>When the INFO_PAUSE flag is supported, a direct transition to
”…””}”(hjÈ  h²hh³Nh´NubjQ  )”}”(hŒ``SDW_STREAM_ENABLED``”h]”hŒSDW_STREAM_ENABLED”…””}”(hjÐ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jP  hjÈ  ubhŒ is allowed.”…””}”(hjÈ  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M°hj   h²hubhÌ)”}”(hŒðFor resume operations where ASoC will use the .prepare() callback, the
stream can transition from ``SDW_STREAM_DISABLED`` to
``SDW_STREAM_PREPARED``, with all required settings restored but
without updating the bandwidth and bit allocation.”h]”(hŒbFor resume operations where ASoC will use the .prepare() callback, the
stream can transition from ”…””}”(hjè  h²hh³Nh´NubjQ  )”}”(hŒ``SDW_STREAM_DISABLED``”h]”hŒSDW_STREAM_DISABLED”…””}”(hjð  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jP  hjè  ubhŒ to
”…””}”(hjè  h²hh³Nh´NubjQ  )”}”(hŒ``SDW_STREAM_PREPARED``”h]”hŒSDW_STREAM_PREPARED”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jP  hjè  ubhŒ\, with all required settings restored but
without updating the bandwidth and bit allocation.”…””}”(hjè  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M³hj   h²hubj…  )”}”(hŒ;int sdw_disable_stream(struct sdw_stream_runtime * stream);”h]”hŒ;int sdw_disable_stream(struct sdw_stream_runtime * stream);”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”j”  j•  js  ‰jt  ju  jv  }”uh1j„  h³hÊh´M¸hj   h²hubeh}”(h]”Œsdw-stream-disabled”ah ]”h"]”Œsdw_stream_disabled”ah$]”h&]”uh1hµhj¶  h²hh³hÊh´M™ubh¶)”}”(hhh]”(h»)”}”(hŒSDW_STREAM_DEPREPARED”h]”hŒSDW_STREAM_DEPREPARED”…””}”(hj4  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj1  h²hh³hÊh´M¾ubhÌ)”}”(hŒODe-prepare state of stream. Operations performed before entering in this
state:”h]”hŒODe-prepare state of stream. Operations performed before entering in this
state:”…””}”(hjB  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´MÀhj1  h²hubhÜ)”}”(hX/  (1) All the port(s) of Master(s) and Slave(s) for current stream are
    de-prepared by programming PrepareCtrl register.

(2) The payload bandwidth of current stream is reduced from the total
    bandwidth requirement of bus and new parameters calculated and
    applied by performing bank switch etc.
”h]”hâ)”}”(hhh]”(hç)”}”(hŒrAll the port(s) of Master(s) and Slave(s) for current stream are
de-prepared by programming PrepareCtrl register.
”h]”hÌ)”}”(hŒqAll the port(s) of Master(s) and Slave(s) for current stream are
de-prepared by programming PrepareCtrl register.”h]”hŒqAll the port(s) of Master(s) and Slave(s) for current stream are
de-prepared by programming PrepareCtrl register.”…””}”(hj[  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´MÃhjW  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhjT  ubhç)”}”(hŒ¨The payload bandwidth of current stream is reduced from the total
bandwidth requirement of bus and new parameters calculated and
applied by performing bank switch etc.
”h]”hÌ)”}”(hŒ§The payload bandwidth of current stream is reduced from the total
bandwidth requirement of bus and new parameters calculated and
applied by performing bank switch etc.”h]”hŒ§The payload bandwidth of current stream is reduced from the total
bandwidth requirement of bus and new parameters calculated and
applied by performing bank switch etc.”…””}”(hjs  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´MÆhjo  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhjT  ubeh}”(h]”h ]”h"]”h$]”h&]”jN  jO  jP  jQ  jR  jS  uh1háhjP  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛh³hÊh´MÃhj1  h²hubhÌ)”}”(hŒ\After all above operations are successful, stream state is set to
``SDW_STREAM_DEPREPARED``.”h]”(hŒBAfter all above operations are successful, stream state is set to
”…””}”(hj“  h²hh³Nh´NubjQ  )”}”(hŒ``SDW_STREAM_DEPREPARED``”h]”hŒSDW_STREAM_DEPREPARED”…””}”(hj›  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jP  hj“  ubhŒ.”…””}”(hj“  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´MÊhj1  h²hubhÌ)”}”(hŒåBus implements below API for DEPREPARED state which needs to be called
once per stream. ALSA/ASoC do not have a concept of 'deprepare', and
the mapping from this stream state to ALSA/ASoC operation may be
implementation specific.”h]”hŒéBus implements below API for DEPREPARED state which needs to be called
once per stream. ALSA/ASoC do not have a concept of â€˜deprepareâ€™, and
the mapping from this stream state to ALSA/ASoC operation may be
implementation specific.”…””}”(hj³  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´MÍhj1  h²hubhÌ)”}”(hŒWhen the INFO_PAUSE flag is supported, the stream state is linked to
the .hw_free() operation - the stream is not deprepared on a
TRIGGER_STOP.”h]”hŒWhen the INFO_PAUSE flag is supported, the stream state is linked to
the .hw_free() operation - the stream is not deprepared on a
TRIGGER_STOP.”…””}”(hjÁ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´MÒhj1  h²hubhÌ)”}”(hŒ¨Other implementations may transition to the ``SDW_STREAM_DEPREPARED``
state on TRIGGER_STOP, should they require a transition through the
``SDW_STREAM_PREPARED`` state.”•7'      h]”(hŒ,Other implementations may transition to the ”…””}”(hjÏ  h²hh³Nh´NubjQ  )”}”(hŒ``SDW_STREAM_DEPREPARED``”h]”hŒSDW_STREAM_DEPREPARED”…””}”(hj×  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jP  hjÏ  ubhŒE
state on TRIGGER_STOP, should they require a transition through the
”…””}”(hjÏ  h²hh³Nh´NubjQ  )”}”(hŒ``SDW_STREAM_PREPARED``”h]”hŒSDW_STREAM_PREPARED”…””}”(hjé  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jP  hjÏ  ubhŒ state.”…””}”(hjÏ  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´MÖhj1  h²hubj…  )”}”(hŒ=int sdw_deprepare_stream(struct sdw_stream_runtime * stream);”h]”hŒ=int sdw_deprepare_stream(struct sdw_stream_runtime * stream);”…””}”hj	  sbah}”(h]”h ]”h"]”h$]”h&]”j”  j•  js  ‰jt  ju  jv  }”uh1j„  h³hÊh´MÚhj1  h²hubeh}”(h]”Œsdw-stream-deprepared”ah ]”h"]”Œsdw_stream_deprepared”ah$]”h&]”uh1hµhj¶  h²hh³hÊh´M¾ubh¶)”}”(hhh]”(h»)”}”(hŒSDW_STREAM_RELEASED”h]”hŒSDW_STREAM_RELEASED”…””}”(hj	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj	  h²hh³hÊh´MàubhÌ)”}”(hŒLRelease state of stream. Operations performed before entering in this state:”h]”hŒLRelease state of stream. Operations performed before entering in this state:”…””}”(hj)	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mâhj	  h²hubhÜ)”}”(hX  (1) Release port resources for all Master(s) and Slave(s) port(s)
    associated with current stream.

(2) Release Master(s) and Slave(s) runtime resources associated with
    current stream.

(3) Release stream runtime resources associated with current stream.
”h]”hâ)”}”(hhh]”(hç)”}”(hŒ^Release port resources for all Master(s) and Slave(s) port(s)
associated with current stream.
”h]”hÌ)”}”(hŒ]Release port resources for all Master(s) and Slave(s) port(s)
associated with current stream.”h]”hŒ]Release port resources for all Master(s) and Slave(s) port(s)
associated with current stream.”…””}”(hjB	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mähj>	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhj;	  ubhç)”}”(hŒQRelease Master(s) and Slave(s) runtime resources associated with
current stream.
”h]”hÌ)”}”(hŒPRelease Master(s) and Slave(s) runtime resources associated with
current stream.”h]”hŒPRelease Master(s) and Slave(s) runtime resources associated with
current stream.”…””}”(hjZ	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´MçhjV	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhj;	  ubhç)”}”(hŒARelease stream runtime resources associated with current stream.
”h]”hÌ)”}”(hŒ@Release stream runtime resources associated with current stream.”h]”hŒ@Release stream runtime resources associated with current stream.”…””}”(hjr	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mêhjn	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhj;	  ubeh}”(h]”h ]”h"]”h$]”h&]”jN  jO  jP  jQ  jR  jS  uh1háhj7	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÛh³hÊh´Mähj	  h²hubhÌ)”}”(hŒZAfter all above operations are successful, stream state is set to
``SDW_STREAM_RELEASED``.”h]”(hŒBAfter all above operations are successful, stream state is set to
”…””}”(hj’	  h²hh³Nh´NubjQ  )”}”(hŒ``SDW_STREAM_RELEASED``”h]”hŒSDW_STREAM_RELEASED”…””}”(hjš	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jP  hj’	  ubhŒ.”…””}”(hj’	  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mìhj	  h²hubhÌ)”}”(hŒÍBus implements below APIs for RELEASE state which needs to be called by
all the Master(s) and Slave(s) associated with stream. From ASoC DPCM
framework, this stream state is linked to .hw_free() operation.”h]”hŒÍBus implements below APIs for RELEASE state which needs to be called by
all the Master(s) and Slave(s) associated with stream. From ASoC DPCM
framework, this stream state is linked to .hw_free() operation.”…””}”(hj²	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mïhj	  h²hubj…  )”}”(hŒÎint sdw_stream_remove_master(struct sdw_bus * bus,
              struct sdw_stream_runtime * stream);
int sdw_stream_remove_slave(struct sdw_slave * slave,
              struct sdw_stream_runtime * stream);”h]”hŒÎint sdw_stream_remove_master(struct sdw_bus * bus,
              struct sdw_stream_runtime * stream);
int sdw_stream_remove_slave(struct sdw_slave * slave,
              struct sdw_stream_runtime * stream);”…””}”hjÀ	  sbah}”(h]”h ]”h"]”h$]”h&]”j”  j•  js  ‰jt  ju  jv  }”uh1j„  h³hÊh´Móhj	  h²hubhÌ)”}”(hŒnThe .shutdown() ASoC DPCM operation calls below Bus API to release
stream assigned as part of ALLOCATED state.”h]”hŒnThe .shutdown() ASoC DPCM operation calls below Bus API to release
stream assigned as part of ALLOCATED state.”…””}”(hjÏ	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mûhj	  h²hubhÌ)”}”(hŒHIn .shutdown() the data structure maintaining stream state are freed up.”h]”hŒHIn .shutdown() the data structure maintaining stream state are freed up.”…””}”(hjÝ	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mþhj	  h²hubj…  )”}”(hŒ<void sdw_release_stream(struct sdw_stream_runtime * stream);”h]”hŒ<void sdw_release_stream(struct sdw_stream_runtime * stream);”…””}”hjë	  sbah}”(h]”h ]”h"]”h$]”h&]”j”  j•  js  ‰jt  ju  jv  }”uh1j„  h³hÊh´M hj	  h²hubhÌ)”}”(hŒñThe SoundWire core provides a sdw_shutdown_stream() helper function,
typically called during a dailink .shutdown() callback, which clears
the stream pointer for all DAIS connected to a stream and releases the
memory allocated for the stream.”h]”hŒñThe SoundWire core provides a sdw_shutdown_stream() helper function,
typically called during a dailink .shutdown() callback, which clears
the stream pointer for all DAIS connected to a stream and releases the
memory allocated for the stream.”…””}”(hjú	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mhj	  h²hubeh}”(h]”Œsdw-stream-released”ah ]”h"]”Œsdw_stream_released”ah$]”h&]”uh1hµhj¶  h²hh³hÊh´Màubeh}”(h]”Œstream-state-operations”ah ]”h"]”Œstream state operations”ah$]”h&]”uh1hµhj   h²hh³hÊh´M	ubeh}”(h]”Œ soundwire-stream-management-flow”ah ]”h"]”Œ soundwire stream management flow”ah$]”h&]”uh1hµhh·h²hh³hÊh´KØubh¶)”}”(hhh]”(h»)”}”(hŒNot Supported”h]”hŒNot Supported”…””}”(hj#
  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj 
  h²hh³hÊh´M
ubhâ)”}”(hhh]”hç)”}”(hŒîA single port with multiple channels supported cannot be used between two
streams or across stream. For example a port with 4 channels cannot be used
to handle 2 independent stereo streams even though it's possible in theory
in SoundWire.”h]”hÌ)”}”(hŒîA single port with multiple channels supported cannot be used between two
streams or across stream. For example a port with 4 channels cannot be used
to handle 2 independent stereo streams even though it's possible in theory
in SoundWire.”h]”hŒðA single port with multiple channels supported cannot be used between two
streams or across stream. For example a port with 4 channels cannot be used
to handle 2 independent stereo streams even though itâ€™s possible in theory
in SoundWire.”…””}”(hj8
  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mhj4
  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hæhj1
  h²hh³hÊh´Nubah}”(h]”h ]”h"]”h$]”h&]”jN  jO  jP  hjR  Œ.”uh1háhj 
  h²hh³hÊh´Mubeh}”(h]”Œnot-supported”ah ]”h"]”Œnot supported”ah$]”h&]”uh1hµhh·h²hh³hÊh´M
ubeh}”(h]”Œaudio-stream-in-soundwire”ah ]”h"]”Œaudio stream in soundwire”ah$]”h&]”uh1hµhhh²hh³hÊh´Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”hÊuh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(hºNŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒtoc_backlinks”Œentry”Œfootnote_backlinks”KŒsectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒstrip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”j†
  Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œlanguage_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œid”Œdump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”hÊŒ_destination”NŒ_config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œdocinfo_xform”KŒsectsubtitle_xform”‰Œimage_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(j`
  j]
  j
  j
  j  j  j³  j°  j
  j
  j‹  jˆ  j2  j/  j^  j[  j  j  j.  j+  j	  j	  j
  j

  jX
  jU
  uŒ	nametypes”}”(j`
  ‰j
  ‰j  ‰j³  ‰j
  ‰j‹  ‰j2  ‰j^  ‰j  ‰j.  ‰j	  ‰j
  ‰jX
  ‰uh}”(j]
  h·j
  j   j  j±  j°  j  j
  j¶  jˆ  jÕ  j/  jŽ  j[  j5  j  ja  j+  j   j	  j1  j

  j	  jU
  j 
  uŒfootnote_refs”}”Œcitation_refs”}”Œautofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”KŒsymbol_footnote_start”K Œ
id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”hŒsystem_message”“”)”}”(hhh]”hÌ)”}”(hŒ:Enumerated list start value not ordinal-1: "0" (ordinal 0)”h]”hŒ>Enumerated list start value not ordinal-1: â€œ0â€ (ordinal 0)”…””}”(hjí
  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËhjê
  ubah}”(h]”h ]”h"]”h$]”h&]”Œlevel”KŒtype”ŒINFO”Œsource”hÊŒline”Kuh1jè
  hjT  ubaŒtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nh²hub.