€•‚Q      Œ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”Œ0/translations/zh_CN/driver-api/soundwire/locking”Œ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”Œ0/translations/zh_TW/driver-api/soundwire/locking”Œ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”Œ0/translations/it_IT/driver-api/soundwire/locking”Œ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”Œ0/translations/ja_JP/driver-api/soundwire/locking”Œ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”Œ0/translations/ko_KR/driver-api/soundwire/locking”Œ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”Œ0/translations/sp_SP/driver-api/soundwire/locking”Œ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ŒSoundWire Locking”h]”hŒSoundWire Locking”…””}”(hh¨hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hh£hžhhŸŒJ/var/lib/git/docbuild/linux/Documentation/driver-api/soundwire/locking.rst”h KubhŒ	paragraph”“”)”}”(hŒ This document explains locking mechanism of the SoundWire Bus. Bus uses
following locks in order to avoid race conditions in Bus operations on
shared resources.”h]”hŒ This document explains locking mechanism of the SoundWire Bus. Bus uses
following locks in order to avoid race conditions in Bus operations on
shared resources.”…””}”(hh¹hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khh£hžhubhŒblock_quote”“”)”}”(hŒ- Bus lock

- Message lock
”h]”hŒbullet_list”“”)”}”(hhh]”(hŒ	list_item”“”)”}”(hŒ	Bus lock
”h]”h¸)”}”(hŒBus lock”h]”hŒBus lock”…””}”(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ŒMessage lock
”h]”h¸)”}”(hŒMessage lock”h]”hŒMessage lock”…””}”(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Ïubeh}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ-”uh1hÍhŸh¶h K	hhÉubah}”(h]”h ]”h"]”h$]”h&]”uh1hÇhŸh¶h K	hh£hžhubh¢)”}”(hhh]”(h§)”}”(hŒBus lock”h]”hŒBus lock”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj  hžhhŸh¶h Kubh¸)”}”(hŒÑSoundWire Bus lock is a mutex and is part of Bus data structure
(sdw_bus) which is used for every Bus instance. This lock is used to
serialize each of the following operations(s) within SoundWire Bus instance.”h]”hŒÑSoundWire Bus lock is a mutex and is part of Bus data structure
(sdw_bus) which is used for every Bus instance. This lock is used to
serialize each of the following operations(s) within SoundWire Bus instance.”…””}”(hj#  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khj  hžhubhÈ)”}”(hŒ- Addition and removal of Slave(s), changing Slave status.

- Prepare, Enable, Disable and De-prepare stream operations.

- Access of Stream data structure.
”h]”hÎ)”}”(hhh]”(hÓ)”}”(hŒ9Addition and removal of Slave(s), changing Slave status.
”h]”h¸)”}”(hŒ8Addition and removal of Slave(s), changing Slave status.”h]”hŒ8Addition and removal of Slave(s), changing Slave status.”…””}”(hj<  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khj8  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhj5  ubhÓ)”}”(hŒ;Prepare, Enable, Disable and De-prepare stream operations.
”h]”h¸)”}”(hŒ:Prepare, Enable, Disable and De-prepare stream operations.”h]”hŒ:Prepare, Enable, Disable and De-prepare stream operations.”…””}”(hjT  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KhjP  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhj5  ubhÓ)”}”(hŒ!Access of Stream data structure.
”h]”h¸)”}”(hŒ Access of Stream data structure.”h]”hŒ Access of Stream data structure.”…””}”(hjl  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khjh  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhj5  ubeh}”(h]”h ]”h"]”h$]”h&]”j
  j  uh1hÍhŸh¶h Khj1  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÇhŸh¶h Khj  hžhubeh}”(h]”Œbus-lock”ah ]”h"]”Œbus lock”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Kubh¢)”}”(hhh]”(h§)”}”(hŒMessage lock”h]”hŒMessage lock”…””}”(hj—  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj”  hžhhŸh¶h Kubh¸)”}”(hŒ·SoundWire message transfer lock. This mutex is part of
Bus data structure (sdw_bus). This lock is used to serialize the message
transfers (read/write) within a SoundWire Bus instance.”h]”hŒ·SoundWire message transfer lock. This mutex is part of
Bus data structure (sdw_bus). This lock is used to serialize the message
transfers (read/write) within a SoundWire Bus instance.”…””}”(hj¥  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khj”  hžhubh¸)”}”(hŒ+Below examples show how locks are acquired.”h]”hŒ+Below examples show how locks are acquired.”…””}”(hj³  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K!hj”  hžhubh¢)”}”(hhh]”(h§)”}”(hŒ	Example 1”h]”hŒ	Example 1”…””}”(hjÄ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjÁ  hžhhŸh¶h K$ubh¸)”}”(hŒMessage transfer.”h]”hŒMessage transfer.”…””}”(hjÒ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K&hjÁ  hžhubhÈ)”}”(hXí  1. For every message transfer

   a. Acquire Message lock.

   b. Transfer message (Read/Write) to Slave1 or broadcast message on
      Bus in case of bank switch.

   c. Release Message lock

   ::

      +----------+                    +---------+
      |          |                    |         |
      |   Bus    |                    | Master  |
      |          |                    | Driver  |
      |          |                    |         |
      +----+-----+                    +----+----+
           |                               |
           |     bus->ops->xfer_msg()      |
           <-------------------------------+   a. Acquire Message lock
           |                               |   b. Transfer message
           |                               |
           +------------------------------->   c. Release Message lock
           |    return success/error       |   d. Return success/error
           |                               |
           +                               +
”h]”hŒenumerated_list”“”)”}”(hhh]”hÓ)”}”(hX®  For every message transfer

a. Acquire Message lock.

b. Transfer message (Read/Write) to Slave1 or broadcast message on
   Bus in case of bank switch.

c. Release Message lock

::

   +----------+                    +---------+
   |          |                    |         |
   |   Bus    |                    | Master  |
   |          |                    | Driver  |
   |          |                    |         |
   +----+-----+                    +----+----+
        |                               |
        |     bus->ops->xfer_msg()      |
        <-------------------------------+   a. Acquire Message lock
        |                               |   b. Transfer message
        |                               |
        +------------------------------->   c. Release Message lock
        |    return success/error       |   d. Return success/error
        |                               |
        +                               +
”h]”(h¸)”}”(hŒFor every message transfer”h]”hŒFor every message transfer”…””}”(hjí  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K(hjé  ubjå  )”}”(hhh]”(hÓ)”}”(hŒAcquire Message lock.
”h]”h¸)”}”(hŒAcquire Message lock.”h]”hŒAcquire Message lock.”…””}”(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Œ\Transfer message (Read/Write) to Slave1 or broadcast message on
Bus in case of bank switch.
”h]”h¸)”}”(hŒ[Transfer message (Read/Write) to Slave1 or broadcast message on
Bus in case of bank switch.”h]”hŒ[Transfer message (Read/Write) to Slave1 or broadcast message on
Bus in case of bank switch.”…””}”(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ŒRelease Message lock
”h]”h¸)”}”(hŒRelease Message lock”h]”hŒRelease Message lock”…””}”(hj2  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&]”Œenumtype”Œ
loweralpha”Œprefix”hŒsuffix”Œ.”uh1jä  hjé  ubhŒliteral_block”“”)”}”(hXÊ  +----------+                    +---------+
|          |                    |         |
|   Bus    |                    | Master  |
|          |                    | Driver  |
|          |                    |         |
+----+-----+                    +----+----+
     |                               |
     |     bus->ops->xfer_msg()      |
     <-------------------------------+   a. Acquire Message lock
     |                               |   b. Transfer message
     |                               |
     +------------------------------->   c. Release Message lock
     |    return success/error       |   d. Return success/error
     |                               |
     +                               +”h]”hXÊ  +----------+                    +---------+
|          |                    |         |
|   Bus    |                    | Master  |
|          |                    | Driver  |
|          |                    |         |
+----+-----+                    +----+----+
     |                               |
     |     bus->ops->xfer_msg()      |
     <-------------------------------+   a. Acquire Message lock
     |                               |   b. Transfer message
     |                               |
     +------------------------------->   c. Release Message lock
     |    return success/error       |   d. Return success/error
     |                               |
     +                               +”…””}”hjS  sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1jQ  hŸh¶h K3hjé  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÒhjæ  ubah}”(h]”h ]”h"]”h$]”h&]”jL  Œarabic”jN  hjO  jP  uh1jä  hjà  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÇhŸh¶h K(hjÁ  hžhubeh}”(h]”Œ	example-1”ah ]”h"]”Œ	example 1”ah$]”h&]”uh1h¡hj”  hžhhŸh¶h K$ubh¢)”}”(hhh]”(h§)”}”(hŒ	Example 2”h]”hŒ	Example 2”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj~  hžhhŸh¶h KDubh¸)”}”(hŒPrepare operation.”h]”hŒPrepare operation.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KFhj~  hžhubhÈ)”}”(hXl  1. Acquire lock for Bus instance associated with Master 1.

2. For every message transfer in Prepare operation

   a. Acquire Message lock.

   b. Transfer message (Read/Write) to Slave1 or broadcast message on
      Bus in case of bank switch.

   c. Release Message lock.

3. Release lock for Bus instance associated with Master 1 ::

      +----------+                    +---------+
      |          |                    |         |
      |   Bus    |                    | Master  |
      |          |                    | Driver  |
      |          |                    |         |
      +----+-----+                    +----+----+
           |                               |
           |    sdw_prepare_stream()       |
           <-------------------------------+   1. Acquire bus lock
           |                               |   2. Perform stream prepare
           |                               |
           |                               |
           |     bus->ops->xfer_msg()      |
           <-------------------------------+   a. Acquire Message lock
           |                               |   b. Transfer message
           |                               |
           +------------------------------->   c. Release Message lock
           |    return success/error       |   d. Return success/error
           |                               |
           |                               |
           |    return success/error       |   3. Release bus lock
           +------------------------------->   4. Return success/error
           |                               |
           +                               +”h]”jå  )”}”(hhh]”(hÓ)”}”(hŒ8Acquire lock for Bus instance associated with Master 1.
”h]”h¸)”}”(hŒ7Acquire lock for Bus instance associated with Master 1.”h]”hŒ7Acquire lock for Bus instance associated with Master 1.”…””}”(hj¨  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KHhj¤  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhj¡  ubhÓ)”}”(hŒÇFor every message transfer in Prepare operation

a. Acquire Message lock.

b. Transfer message (Read/Write) to Slave1 or broadcast message on
   Bus in case of bank switch.

c. Release Message lock.
”h]”(h¸)”}”(hŒ/For every message transfer in Prepare operation”h]”hŒ/For every message transfer in Prepare operation”…””}”(hjÀ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KJhj¼  ubjå  )”}”(hhh]”(hÓ)”}”(hŒAcquire Message lock.
”h]”h¸)”}”(hŒAcquire Message lock.”h]”hŒAcquire Message lock.”…””}”(hjÕ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KLhjÑ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhjÎ  ubhÓ)”}”(hŒ\Transfer message (Read/Write) to Slave1 or broadcast message on
Bus in case of bank switch.
”h]”h¸)”}”(hŒ[Transfer message (Read/Write) to Slave1 or broadcast message on
Bus in case of bank switch.”h]”hŒ[Transfer message (Read/Write) to Slave1 or broadcast message on
Bus in case of bank switch.”…””}”(hjí  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KNhjé  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhjÎ  ubhÓ)”}”(hŒRelease Message lock.
”h]”h¸)”}”(hŒRelease Message lock.”h]”hŒRelease Message lock.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KQhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÒhjÎ  ubeh}”(h]”h ]”h"]”h$]”h&]”jL  jM  jN  hjO  jP  uh1jä  hj¼  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÒhj¡  ubhÓ)”}”(hX  Release lock for Bus instance associated with Master 1 ::

   +----------+                    +---------+
   |          |                    |         |
   |   Bus    |                    | Master  |
   |          |                    | Driver  |
   |          |                    |         |
   +----+-----+                    +----+----+
        |                               |
        |    sdw_prepare_stream()       |
        <-------------------------------+   1. Acquire bus lock
        |                               |   2. Perform stream prepare
        |                               |
        |                               |
        |     bus->ops->xfer_msg()      |
        <-------------------------------+   a. Acquire Message lock
        |                               |   b. Transfer message
        |                               |
        +------------------------------->   c. Release Message lock
        |    return success/error       |   d. Return success/error
        |                               |
        |                               |
        |    return success/error       |   3. Release bus lock
        +------------------------------->   4. Return success/error
        |                               |
        +                               +”h]”(h¸)”}”(hŒ9Release lock for Bus instance associated with Master 1 ::”h]”hŒ6Release lock for Bus instance associated with Master 1”…””}”(hj)  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KShj%  ubjR  )”}”(hX‹  +----------+                    +---------+
|          |                    |         |
|   Bus    |                    | Master  |
|          |                    | Driver  |
|          |                    |         |
+----+-----+                    +----+----+
     |                               |
     |    sdw_prepare_stream()       |
     <-------------------------------+   1. Acquire bus lock
     |                               |   2. Perform stream prepare
     |                               |
     |                               |
     |     bus->ops->xfer_msg()      |
     <-------------------------------+   a. Acquire Message lock
     |                               |   b. Transfer message
     |                               |
     +------------------------------->   c. Release Message lock
     |    return success/error       |   d. Return success/error
     |                               |
     |                               |
     |    return success/error       |   3. Release bus lock
     +------------------------------->   4. Return success/error
     |                               |
     +                               +”h]”hX‹  +----------+                    +---------+
|          |                    |         |
|   Bus    |                    | Master  |
|          |                    | Driver  |
|          |                    |         |
+----+-----+                    +----+----+
     |                               |
     |    sdw_prepare_stream()       |
     <-------------------------------+   1. Acquire bus lock
     |                               |   2. Perform stream prepare
     |                               |
     |                               |
     |     bus->ops->xfer_msg()      |
     <-------------------------------+   a. Acquire Message lock
     |                               |   b. Transfer message
     |                               |
     +------------------------------->   c. Release Message lock
     |    return success/error       |   d. Return success/error
     |                               |
     |                               |
     |    return success/error       |   3. Release bus lock
     +------------------------------->   4. Return success/error
     |                               |
     +                               +”…””}”hj7  sbah}”(h]”h ]”h"]”h$]”h&]”ja  jb  uh1jQ  hŸh¶h KUhj%  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÒhj¡  ubeh}”(h]”h ]”h"]”h$]”h&]”jL  jo  jN  hjO  jP  uh1jä  hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hÇhŸh¶h KHhj~  hžhubeh}”(h]”Œ	example-2”ah ]”h"]”Œ	example 2”ah$]”h&]”uh1h¡hj”  hžhhŸh¶h KDubeh}”(h]”Œmessage-lock”ah ]”h"]”Œmessage lock”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Kubeh}”(h]”Œsoundwire-locking”ah ]”h"]”Œsoundwire locking”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”}”(jl  ji  j‘  jŽ  jd  ja  j{  jx  j\  jY  uŒ	nametypes”}”(jl  ‰j‘  ‰jd  ‰j{  ‰j\  ‰uh}”(ji  h£jŽ  j  ja  j”  jx  jÁ  jY  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”]”Œtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nhžhub.