diff options
Diffstat (limited to 'pw_sync_threadx/docs.rst')
| -rw-r--r-- | pw_sync_threadx/docs.rst | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/pw_sync_threadx/docs.rst b/pw_sync_threadx/docs.rst new file mode 100644 index 000000000..b6fac0861 --- /dev/null +++ b/pw_sync_threadx/docs.rst @@ -0,0 +1,13 @@ +.. _module-pw_sync_threadx: + +--------------- +pw_sync_threadx +--------------- +This is a set of backends for pw_sync based on ThreadX. It is not ready for use, +and is under construction. + +It is possible, if necessary, to use pw_sync_threadx without using the Pigweed +provided pw_chrono_threadx in case the ThreadX time API (``tx_time_get()``)) is +not available (i.e. ``TX_NO_TIMER`` is set). You are responsible for ensuring +that the chrono backend provided has counts which match the ThreadX tick based +API. |