xref: /aosp_15_r20/external/pigweed/pw_sync_zephyr/docs.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985) 
1.. _module-pw_sync_zephyr:
2
3================
4pw_sync_zephyr
5================
6
7--------
8Overview
9--------
10This sync backend implements the ``pw_sync`` facade. To enable, set
11``CONFIG_PIGWEED_SYNC=y``. After that, specific submodules can be enabled via
12the Kconfig menu.
13
14* ``pw_sync.mutex`` can be enabled via ``CONFIG_PIGWEED_SYNC_MUTEX``.
15* ``pw_sync.binary_semaphore`` can be enabled via
16  ``CONFIG_PIGWEED_SYNC_BINARY_SEMAPHORE``.
17* ``pw_sync.interrupt_spin_lock`` can be enabled via ``CONFIG_PIGWEED_SYNC_INTERRUPT_SPIN_LOCK``.
18