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