xref: /aosp_15_r20/external/pigweed/pw_chrono_rp2040/docs.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1.. _module-pw_chrono_rp2040:
2
3================
4pw_chrono_rp2040
5================
6This module provides a pw_chrono backend suitable for use with an RP2040-based
7board (e.g. Raspberry Pi Pico). This backend works with baremetal operation of
8a Pi Pico, and may be suitable for RTOS contexts with some additional
9configuration of the RTOS timer settings.
10
11-------------------
12SystemClock backend
13-------------------
14The ``pw_chrono_rp2040:system_clock`` backend target implements the
15``pw_chrono:system_clock`` facade by using the Pico SDK's time API. This is
16backed by a 64-bit hardware timer that reports time-since-boot as microseconds.
17As the peripheral API in the Pico SDK expects microseconds, this is the most
18appropriate clock to use when interacting with peripherals.
19
20See the :ref:`module-pw_chrono` documentation for ``pw_chrono`` for more
21information on what functionality this provides.
22