boards/up-bridge-the-gap/up_squared/doc/index.rst
.. zephyr:board:: up_squared
Overview
UP² (UP Squared) is an ultra compact single board computer with high performance and low power consumption. It features the latest Intel® Apollo Lake Celeron™ and Pentium™ Processors with only 4W of Scenario Design Power and a powerful and flexible Intel® FPGA Altera MAX 10 onboard.
This board configuration enables kernel support for the UP Squared_ board.
.. note::
This board configuration works on all three variants of UP Squared_
boards containing Intel® Pentium™ SoC,
Intel® Celeron™ SoC, or Intel® Atom™ SoC.
Hardware
General information about the board can be found at the UP Squared_ website.
.. include:: ../../../../soc/intel/apollo_lake/doc/supported_features.txt
GPIOs are exposed through the HAT header, and can be referred using
predefined macros such as UP2_HAT_PIN3. The physical pins are
connected to the on-board FPGA acting as level shifter. Therefore,
to actually utilize these GPIO pins, the function of the pins and
directions (input/output) must be set in the BIOS. This can be
accomplished in BIOS, under menu Advanced, and option
HAT Configurations. When a corresponding pin is set to act as
GPIO, there is an option to set the direction of the pin. This needs
to be set accordingly for the GPIO to function properly.
Refer to the UP Squared_ website and UP Squared Pinout_ website
for connection diagrams.
Programming and Debugging
.. zephyr:board-supported-runners::
Use the following procedures for booting an image on a UP Squared board.
.. contents:: :depth: 1 :local: :backlinks: top
#. Build a Zephyr application; for instance, to build the hello_world
application on UP Squared:
.. zephyr-app-commands:: :zephyr-app: samples/hello_world :board: up_squared :goals: build
.. note::
A Zephyr EFI image file named :file:`zephyr.efi` is automatically
created in the build directory after the application is built.
.. include:: ../../../intel/common/efi_boot.rst :start-after: start_include_here
.. note::
Refer to the UP Squared Serial Console Wiki page <https://wiki.up-community.org/Serial_console>_ for instructions on how to
connect serial console.
.. note:: You can safely ignore this message if it appears:
.. code-block:: console
WARNING: no console will be available to OS
.. include:: ../../../intel/common/net_boot.rst :start-after: start_include_here
.. note::
Refer to the UP Squared Serial Console Wiki page <https://wiki.up-community.org/Serial_console>_ for instructions on how to
connect serial console.
.. note:: To enable PXE boot for Up Squared board do the following:
#. Enable network from BIOS settings.
.. code-block:: console
Advanced -> Network Stack Configuration -> Enable Network Stack -> Enable Ipv4 PXE Support
#. Make network boot as the first boot option.
.. code-block:: console
Boot -> Boot Option #1 : [Network]
.. _UP Squared: https://www.up-board.org/upsquared/specifications
.. _UP Squared Pinout: https://wiki.up-community.org/Pinout