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