xref: /aosp_15_r20/external/pigweed/pw_sys_io_ambiq_sdk/docs.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1.. _module-pw_sys_io_ambiq_sdk:
2
3===================
4pw_sys_io_ambiq_sdk
5===================
6``pw_sys_io_ambiq_sdk`` implements the ``pw_sys_io`` facade over UART using the
7Ambiq Suite SDK HAL.
8
9The UART baud rate is fixed at 115200 (8N1).
10
11Setup
12=====
13This module requires relatively minimal setup:
14
151. Write code against the ``pw_sys_io`` facade.
162. Specify the ``dir_pw_sys_io_backend`` GN global variable to point to this
17   backend.
183. Call ``pw_sys_io_Init()`` during init so the UART is properly initialized and
19   configured.
20
21The UART peripheral and the GPIO pins are defined in the ``am_bsp.h`` file. Make sure
22that the build argument ``pw_third_party_ambiq_PRODUCT`` is set correctly so that
23the correct bsp header file is included.
24