xref: /aosp_15_r20/external/pigweed/pw_sys_io_zephyr/docs.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1*61c4878aSAndroid Build Coastguard Worker.. _module-pw_sys_io_zephyr:
2*61c4878aSAndroid Build Coastguard Worker
3*61c4878aSAndroid Build Coastguard Worker================
4*61c4878aSAndroid Build Coastguard Workerpw_sys_io_zephyr
5*61c4878aSAndroid Build Coastguard Worker================
6*61c4878aSAndroid Build Coastguard Worker
7*61c4878aSAndroid Build Coastguard Worker--------
8*61c4878aSAndroid Build Coastguard WorkerOverview
9*61c4878aSAndroid Build Coastguard Worker--------
10*61c4878aSAndroid Build Coastguard WorkerThis sys I/O backend implements the ``pw_sys_io`` facade. To enable, set
11*61c4878aSAndroid Build Coastguard Worker``CONFIG_PIGWEED_SYS_IO=y``. Once enabled, I/O operations will be routed to
12*61c4878aSAndroid Build Coastguard WorkerZephyr's console. Additionally, it is possible to enable the USB subsystem
13*61c4878aSAndroid Build Coastguard Workerby setting ``CONFIG_PIGWEED_SYS_IO_USB=y``.
14*61c4878aSAndroid Build Coastguard Worker
15*61c4878aSAndroid Build Coastguard WorkerThe I/O backend initializes during Zephyr's ``APPLICATION`` level and uses
16*61c4878aSAndroid Build Coastguard Worker``CONFIG_PIGWEED_SYS_IO_INIT_PRIORITY`` to set the priority level. This config
17*61c4878aSAndroid Build Coastguard Workervalue defaults to 1, but is configurable via Kconfig.
18