xref: /aosp_15_r20/external/pigweed/docs/os/zephyr/index.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1*61c4878aSAndroid Build Coastguard Worker.. _docs-os-zephyr:
2*61c4878aSAndroid Build Coastguard Worker
3*61c4878aSAndroid Build Coastguard Worker======
4*61c4878aSAndroid Build Coastguard WorkerZephyr
5*61c4878aSAndroid Build Coastguard Worker======
6*61c4878aSAndroid Build Coastguard WorkerPigweed has preliminary support for `Zephyr <https://www.zephyrproject.org/>`_.
7*61c4878aSAndroid Build Coastguard WorkerSee the docs for these modules for more information:
8*61c4878aSAndroid Build Coastguard Worker
9*61c4878aSAndroid Build Coastguard Worker- :ref:`pw_assert_zephyr <module-pw_assert_zephyr>`
10*61c4878aSAndroid Build Coastguard Worker- :ref:`pw_chrono_zephyr <module-pw_chrono_zephyr>`
11*61c4878aSAndroid Build Coastguard Worker- :ref:`pw_interrupt_zephyr <module-pw_interrupt_zephyr>`
12*61c4878aSAndroid Build Coastguard Worker- :ref:`pw_log_zephyr <module-pw_log_zephyr>`
13*61c4878aSAndroid Build Coastguard Worker- :ref:`pw_sync_zephyr <module-pw_sync_zephyr>`
14*61c4878aSAndroid Build Coastguard Worker- :ref:`pw_sys_io_zephyr <module-pw_sys_io_zephyr>`
15*61c4878aSAndroid Build Coastguard Worker- :ref:`pw_thread_zephyr <module-pw_thread_zephyr>`
16*61c4878aSAndroid Build Coastguard Worker
17*61c4878aSAndroid Build Coastguard Worker.. note:: The version of Zephyr bundled with `pw package install zephyr` is
18*61c4878aSAndroid Build Coastguard Worker   being migrated to v3.6 as we near the latest release.
19*61c4878aSAndroid Build Coastguard Worker
20*61c4878aSAndroid Build Coastguard Worker.. _docs-os-zephyr-get-started:
21*61c4878aSAndroid Build Coastguard Worker
22*61c4878aSAndroid Build Coastguard Worker-----------------------------------
23*61c4878aSAndroid Build Coastguard WorkerGet started with Zephyr and Pigweed
24*61c4878aSAndroid Build Coastguard Worker-----------------------------------
25*61c4878aSAndroid Build Coastguard Worker1. Check out the `zephyr_pigweed`_ repository for an example of a Zephyr starter
26*61c4878aSAndroid Build Coastguard Worker   project that has been set up to use Pigweed.
27*61c4878aSAndroid Build Coastguard Worker2. See :ref:`docs-os-zephyr-kconfig` to find the Kconfig options for
28*61c4878aSAndroid Build Coastguard Worker   enabling individual Pigweed modules and features.
29*61c4878aSAndroid Build Coastguard Worker
30*61c4878aSAndroid Build Coastguard Worker-------
31*61c4878aSAndroid Build Coastguard WorkerTesting
32*61c4878aSAndroid Build Coastguard Worker-------
33*61c4878aSAndroid Build Coastguard WorkerTo test against Zephyr, first go through the `zephyr_pigweed`_ tutorial.
34*61c4878aSAndroid Build Coastguard WorkerOnce set up, simply invoke:
35*61c4878aSAndroid Build Coastguard Worker
36*61c4878aSAndroid Build Coastguard Worker.. code-block:: bash
37*61c4878aSAndroid Build Coastguard Worker
38*61c4878aSAndroid Build Coastguard Worker   $ source ${PW_ROOT}/activate.sh
39*61c4878aSAndroid Build Coastguard Worker   $ west twister -T ${PW_ROOT}
40*61c4878aSAndroid Build Coastguard Worker
41*61c4878aSAndroid Build Coastguard Worker.. attention:: Testing has only been verified with `-p native_posix`. Proceed with caution.
42*61c4878aSAndroid Build Coastguard Worker
43*61c4878aSAndroid Build Coastguard Worker.. _zephyr_pigweed: https://github.com/yperess/zephyr-pigweed/
44*61c4878aSAndroid Build Coastguard Worker
45*61c4878aSAndroid Build Coastguard Worker.. toctree::
46*61c4878aSAndroid Build Coastguard Worker   :hidden:
47*61c4878aSAndroid Build Coastguard Worker
48*61c4878aSAndroid Build Coastguard Worker   kconfig
49