1.. _up_squared:
2
3UP Squared
4##########
5
6Overview
7********
8
9UP |sup2| (UP Squared) is an ultra compact single board computer with high
10performance and low power consumption. It features the latest Intel |reg| Apollo
11Lake Celeron |trade| and Pentium |trade| Processors with only 4W of Scenario Design Power and
12a powerful and flexible Intel |reg| FPGA Altera MAX 10 onboard.
13
14.. figure:: img/up_squared.jpg
15   :align: center
16   :alt: UP Squared
17
18   Up Squared (Credit: https://up-board.org)
19
20This board configuration enables kernel support for the `UP Squared`_ board.
21
22.. note::
23   This board configuration works on all three variants of `UP Squared`_
24   boards containing Intel |reg| Pentium |trade| SoC,
25   Intel |reg| Celeron |trade| SoC, or Intel |reg| Atom |trade| SoC.
26
27Hardware
28********
29
30General information about the board can be found at the `UP Squared`_ website.
31
32.. include:: ../../../../soc/intel/apollo_lake/doc/supported_features.txt
33
34GPIO
35----
36
37GPIOs are exposed through the HAT header, and can be referred using
38predefined macros such as ``UP2_HAT_PIN3``. The physical pins are
39connected to the on-board FPGA acting as level shifter. Therefore,
40to actually utilize these GPIO pins, the function of the pins and
41directions (input/output) must be set in the BIOS. This can be
42accomplished in BIOS, under menu ``Advanced``, and option
43``HAT Configurations``. When a corresponding pin is set to act as
44GPIO, there is an option to set the direction of the pin. This needs
45to be set accordingly for the GPIO to function properly.
46
47Connections and IOs
48===================
49
50Refer to the `UP Squared`_ website and `UP Squared Pinout`_ website
51for connection diagrams.
52
53Programming and Debugging
54*************************
55
56Use the following procedures for booting an image on a UP Squared board.
57
58.. contents::
59   :depth: 1
60   :local:
61   :backlinks: top
62
63Build Zephyr application
64========================
65
66#. Build a Zephyr application; for instance, to build the ``hello_world``
67   application on UP Squared:
68
69   .. zephyr-app-commands::
70      :zephyr-app: samples/hello_world
71      :board: up_squared
72      :goals: build
73
74   .. note::
75
76      A Zephyr EFI image file named :file:`zephyr.efi` is automatically
77      created in the build directory after the application is built.
78
79Booting the UP Squared Board using UEFI
80=======================================
81
82.. include:: ../../../intel/common/efi_boot.rst
83   :start-after: start_include_here
84
85.. note::
86   Refer to the `UP Squared Serial Console Wiki page
87   <https://wiki.up-community.org/Serial_console>`_ for instructions on how to
88   connect serial console.
89
90.. note::
91   You can safely ignore this message if it appears:
92
93   .. code-block:: console
94
95      WARNING: no console will be available to OS
96
97Booting the UP Squared Board over network
98=========================================
99
100.. include:: ../../../intel/common/net_boot.rst
101   :start-after: start_include_here
102
103.. note::
104   Refer to the `UP Squared Serial Console Wiki page
105   <https://wiki.up-community.org/Serial_console>`_ for instructions on how to
106   connect serial console.
107
108.. note::
109   To enable PXE boot for Up Squared board do the following:
110
111   #. Enable network from BIOS settings.
112
113      .. code-block:: console
114
115         Advanced -> Network Stack Configuration -> Enable Network Stack -> Enable Ipv4 PXE Support
116
117   #. Make network boot as the first boot option.
118
119      .. code-block:: console
120
121         Boot -> Boot Option #1 : [Network]
122
123.. _UP Squared: https://www.up-board.org/upsquared/specifications
124
125.. _UP Squared Pinout: https://wiki.up-community.org/Pinout
126