aboutsummaryrefslogtreecommitdiff
path: root/pw_sync_zephyr/docs.rst
blob: 9e96a431bd9412dfdd8d1e31a50f59463b621692 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
.. _module-pw_sync_zephyr:

================
pw_sync_zephyr
================

--------
Overview
--------
This sync backend implements the ``pw_sync`` facade. To enable, set
``CONFIG_PIGWEED_SYNC=y``. After that, specific submodules can be enabled via
the Kconfig menu.

* ``pw_sync.mutex`` can be enabled via ``CONFIG_PIGWEED_SYNC_MUTEX``.
* ``pw_sync.binary_semaphore`` can be enabled via
  ``CONFIG_PIGWEED_SYNC_BINARY_SEMAPHORE``.
* ``pw_sync.interrupt_spin_lock`` can be enabled via ``CONFIG_PIGWEED_SYNC_INTERRUPT_SPIN_LOCK``.