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