blob: 7280656244e05e3c9be8de9cb3381ea18b7c7c82 [file] [log] [blame]
Wyatt Heplerf9fb90f2020-09-30 18:59:33 -07001.. _module-pw_sys_io_stdio:
Armando Montanezf7a5a742020-03-02 14:58:59 -08002
3---------------
4pw_sys_io_stdio
5---------------
6The ``pw_sys_io_stdio`` backend implements the ``pw_sys_io`` facade using
7stdio.
8
9Why not just use stdio directly?
10--------------------------------
11
12The nice thing about using ``pw_sys_io`` is that it's rather easy to get a
13board up and running with a target-specific backend. This means when drafting
14out a quick application you can write it against ``pw_sys_io`` and, with some
15care, the application will be able to run on both host and target devices.
16
17While it's not recommended to use ``pw_sys_io`` for any production
18applications, it can be rather helpful for early prototyping.
19
20Setup
21=====
22This module requires relatively minimal setup:
23
24 1. Write code against the ``pw_sys_io`` facade.
Armando Montaneza761e322020-06-15 16:30:40 -070025 2. Direct the ``pw_sys_io_BACKEND`` GN build arg to point to this backend.
Armando Montanezf7a5a742020-03-02 14:58:59 -080026
27Module usage
28============
29For the most part, applications built with this backend will behave similarly
30to an application built directly against stdio.
31
32Dependencies
33============
Armando Montanez0054a9b2020-03-13 13:06:24 -070034 * ``pw_sys_io`` facade