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