diff options
Diffstat (limited to 'pw_i2c_mcuxpresso/docs.rst')
| -rw-r--r-- | pw_i2c_mcuxpresso/docs.rst | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/pw_i2c_mcuxpresso/docs.rst b/pw_i2c_mcuxpresso/docs.rst new file mode 100644 index 000000000..449f6e266 --- /dev/null +++ b/pw_i2c_mcuxpresso/docs.rst @@ -0,0 +1,26 @@ +.. _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.
\ No newline at end of file |