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