xref: /aosp_15_r20/external/pigweed/pw_sys_io_mcuxpresso/docs.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1.. _module-pw_sys_io_mcuxpresso:
2
3====================
4pw_sys_io_mcuxpresso
5====================
6``pw_sys_io_mcuxpresso`` implements the ``pw_sys_io`` facade using the
7NXP MCUXpresso SDK.
8
9The implementation is based on the debug console component.
10
11Setup
12=====
13This module requires a little setup:
14
151. Use ``pw_build_mcuxpresso`` to create a ``pw_source_set`` for an
16   MCUXpresso SDK.
172. Include the debug console component in this SDK definition.
183. Specify the ``pw_third_party_mcuxpresso_SDK`` GN global variable to specify
19   the name of this source set.
204. Use a target that calls ``pw_sys_io_mcuxpresso_Init`` in
21   ``pw_boot_PreMainInit`` or similar.
22
23The name of the SDK source set must be set in the
24"pw_third_party_mcuxpresso_SDK" GN arg
25
26Configuration
27=============
28The configuration of the module can be adjusted via compile-time configuration
29of the MCUXpresso source set, see the
30:ref:`documentation <module-pw_build_mcuxpresso>` for more details.
31
32.. c:macro:: DEBUG_CONSOLE_TRANSFER_NON_BLOCKING
33
34   Whether the MCUXpresso debug console supports non-blocking transfers. The
35   default will depend on your SDK configuration.
36
37   Enabling this adds support for ``pw::sys_io::TryReadByte``.
38