• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1.. _module-pw_sys_io_mcuxpresso:
2
3====================
4pw_sys_io_mcuxpresso
5====================
6.. pigweed-module::
7   :name: pw_sys_io_mcuxpresso
8
9``pw_sys_io_mcuxpresso`` implements the ``pw_sys_io`` facade using the
10NXP MCUXpresso SDK.
11
12The implementation is based on the debug console component.
13
14Setup
15=====
16This module requires a little setup:
17
181. Use ``pw_build_mcuxpresso`` to create a ``pw_source_set`` for an
19   MCUXpresso SDK.
202. Include the debug console component in this SDK definition.
213. Specify the ``pw_third_party_mcuxpresso_SDK`` GN global variable to specify
22   the name of this source set.
234. Use a target that calls ``pw_sys_io_mcuxpresso_Init`` in
24   ``pw_boot_PreMainInit`` or similar.
25
26The name of the SDK source set must be set in the
27"pw_third_party_mcuxpresso_SDK" GN arg
28
29Configuration
30=============
31The configuration of the module can be adjusted via compile-time configuration
32of the MCUXpresso source set, see the
33:ref:`documentation <module-pw_build_mcuxpresso>` for more details.
34
35.. c:macro:: DEBUG_CONSOLE_TRANSFER_NON_BLOCKING
36
37   Whether the MCUXpresso debug console supports non-blocking transfers. The
38   default will depend on your SDK configuration.
39
40   Enabling this adds support for ``pw::sys_io::TryReadByte``.
41