aboutsummaryrefslogtreecommitdiff
path: root/pw_i2c_mcuxpresso/docs.rst
blob: 449f6e266fb6c05fcc893e8b9b6fc986c2ad04b5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
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.