third_party.pigweed.src/pw_sync_threadx/docs.rst

.. _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.
pw_sync_threadx: Add pw::sync::SpinLock backend Adds initial ThreadX support through a SpinLock backend for pw_sync. Note that this first backend does not support ThreadX with SMP enabled, taking a shortcut to detect SpinLock recursion instead. Change-Id: I6cb4d1edfe78bc97fc632cfb353589e53f87f2c7 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/25803 Commit-Queue: Ewout van Bekkum <ewout@google.com> Reviewed-by: Ewout van Bekkum <ewout@google.com> Reviewed-by: Wyatt Hepler <hepler@google.com> Reviewed-by: Keir Mierle <keir@google.com> 2020-11-23 18:46:16 +00:00			`.. _module-pw_sync_threadx:`

			`---------------`
			`pw_sync_threadx`
			`---------------`
pw_{sync,chrono}_threadx: Add initial ThreadX support Adds initial ThreadX support through a set of backends for pw_sync through pw_sync_threadx and pw_chrono through pw_chrono_threadx. Change-Id: I3e310323cfce3d4bf07557273c2a86f91f6479d7 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/24900 Reviewed-by: Wyatt Hepler <hepler@google.com> Commit-Queue: Ewout van Bekkum <ewout@google.com> 2020-11-16 19:56:41 +00:00			`This is a set of backends for pw_sync based on ThreadX. It is not ready for use,`
			`and is under construction.`
pw_sync_threadx: Add pw::sync::SpinLock backend Adds initial ThreadX support through a SpinLock backend for pw_sync. Note that this first backend does not support ThreadX with SMP enabled, taking a shortcut to detect SpinLock recursion instead. Change-Id: I6cb4d1edfe78bc97fc632cfb353589e53f87f2c7 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/25803 Commit-Queue: Ewout van Bekkum <ewout@google.com> Reviewed-by: Ewout van Bekkum <ewout@google.com> Reviewed-by: Wyatt Hepler <hepler@google.com> Reviewed-by: Keir Mierle <keir@google.com> 2020-11-23 18:46:16 +00:00
pw_sync_threadx: allow a custom pw::chrono::SystemClock backend Modifies the GN implementation for pw_sync_threadx to allow a custom backend for pw::chrono::SystemClock which is not pw_chrono_threadx:system_clock in case the TX time capability is not enabled in a ThreadX configuration. Change-Id: I1a4191425b4d2679472a86a388085c0ab64bedbe Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/28560 Reviewed-by: Keir Mierle <keir@google.com> Commit-Queue: Ewout van Bekkum <ewout@google.com> 2020-12-30 23:29:18 +00:00			`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.`