mirror of
https://fuchsia.googlesource.com/third_party/pigweed.googlesource.com/pigweed/pigweed
synced 2024-09-20 13:51:05 +00:00
9be741a17a
Change-Id: I659ddb43fdca5be9439d6c282b50cbc205adcbe6 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/70180 Reviewed-by: Scott James Remnant <keybuk@google.com> Reviewed-by: Ewout van Bekkum <ewout@google.com> Commit-Queue: Swati Wagh <swatiwagh@google.com>
26 lines
804 B
ReStructuredText
26 lines
804 B
ReStructuredText
.. _module-pw_i2c_mcuxpresso:
|
|
|
|
-----------------
|
|
pw_i2c_mcuxpresso
|
|
-----------------
|
|
|
|
``pw_i2c_mcuxpresso`` implements the ``pw_i2c`` interface using the
|
|
NXP MCUXpresso SDK.
|
|
|
|
The implementation is based on the i2c driver in SDK. I2C transfers use
|
|
non-blocking driver API.
|
|
|
|
Setup
|
|
=====
|
|
|
|
This module requires following setup:
|
|
|
|
1. Use ``pw_build_mcuxpresso`` to create a ``pw_source_set`` for an
|
|
MCUXpresso SDK.
|
|
2. Include the i2c driver component in this SDK definition.
|
|
3. Specify the ``pw_third_party_mcuxpresso_SDK`` GN global variable to specify
|
|
the name of this source set.
|
|
4. Use ``pw::i2c::McuxpressoInitiator`` implementation of
|
|
``pw::i2c::Initiator`` while creating ``pw::i2c::Device`` or
|
|
``pw::i2c::RegisterDevice`` interface to access the I2C devices connected to
|
|
target. |