• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1.. _module-pw_sys_io_emcraft_sf2:
2
3---------------------
4pw_sys_io_emcraft_sf2
5---------------------
6.. pigweed-module::
7   :name: pw_sys_io_emcraft_sf2
8
9``pw_sys_io_emcraft_sf2`` implements the ``pw_sys_io`` facade over
10UART.
11
12The Emcraft SF2 sys IO backend provides a UART driver layer that allows
13applications built against the ``pw_sys_io`` interface to run on a
14SmartFusion/2 chip and do simple input/output via UART. However, this should
15work with all Smartfusion/2 variations.
16
17This backend allows you to configure which UART to use. The point of it is to
18provide bare-minimum platform code needed to do UART reads/writes.
19
20Setup
21=====
22This module requires relatively minimal setup:
23
241. Write code against the ``pw_sys_io`` facade.
252. Specify the ``dir_pw_sys_io_backend`` GN global variable to point to this
26   backend.
273. pw_sys_io_Init() provided by this module needs to be called in early boot
28   to get pw_sys_io into a working state.
294. Build an executable with a main() function using a toolchain that
30   supports Cortex-M3.
31
32.. note::
33   This module provides early firmware init, so it will conflict with other
34   modules that do any early device init.
35
36Module usage
37============
38After building an executable that utilizes this backend, flash the
39produced .elf binary to the development board. Then, using a serial
40communication terminal like minicom/screen (Linux/Mac) or TeraTerm (Windows),
41connect to the device at a baud rate of 57600 (8N1).
42
43Dependencies
44============
45- :ref:`module-pw_sys_io`
46- :ref:`module-pw_preprocessor`
47