Skip to content
Snippets Groups Projects
Commit 7cdea09c authored by Arul Kumaran's avatar Arul Kumaran
Browse files

docs/hardware-support: Introduce new topic 'Supported Images'


* Hardware supported boards modified to reference Supported Images.
* docs/index.rst modified to include Supported Images topic in toctree.

Signed-off-by: default avatarArul Kumaran <arulkumaran.devarajan@huawei.com>
parent 33bb47ae
No related branches found
No related tags found
No related merge requests found
Showing
with 80 additions and 126 deletions
......@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
.. _FreeRTOS_Kernel:
FreeRTOS Kernel Build Flavour
#############################
......
......@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
.. _Linux_Kernel:
Linux Kernel Build Flavour
##########################
......
......@@ -2,6 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
.. _Zephyr_Kernel:
Zephyr Kernel Build Flavour
###########################
......
......@@ -31,24 +31,6 @@ For more details on Avenger96 board, see `Avenger96 product page <https://www.96
Working with the board
**********************
Supported images
================
.. list-table:: Supported images
:widths: auto
:header-rows: 1
* - Image Name
- Size
- Description
* - allscenarios-image-base
- Approximate 100-200 MB
- All Scenarios OS image including the base OS software stack
* - allscenarios-image-extra
- Approximate 100-200 MB
- All Scenarios OS Wayland image including the base OS software stack
Building OHOS image
===================
......
......@@ -35,11 +35,6 @@ For more details on 96Boards Nitrogen, see `Nitrogen product page <https://www.9
Working with the board
**********************
Supported image
===============
* zephyr-philosophers
Building an application
=======================
......
......@@ -50,20 +50,6 @@ For more details on the Raspberry Pi 4 board, see `Raspberry Pi hardware page
Working with the board
**********************
Supported images
================
.. list-table:: Supported images
:widths: auto
:header-rows: 1
* - Image Name
- Description
* - allscenarios-image-base
- All Scenarios OS image including the base OS software stack
* - allscenarios-image-extra
- All Scenarios OS Wayland image including the base OS software stack
Building All Scenarios OS image
===============================
......
......@@ -29,21 +29,6 @@ For more detailed specifications of SBC-C61 SECO board, see `SBC-C61 Specificati
Working with the board
**********************
Supported image
===============
.. list-table:: Supported images
:widths: auto
:header-rows: 1
* - Image Name
- Size
- Description
* - allscenarios-image-base
- Approximate 100-200 MB
- All Scenarios OS image including the base OS software stack
Building OHOS image
===================
......
......@@ -28,24 +28,6 @@ For more detailed specifications of SBC-B68-eNUC SECO board, see `SBC-B68-eNUC S
Working with the board
**********************
Supported images
================
.. list-table:: Supported images
:widths: auto
:header-rows: 1
* - Image Name
- Size
- Description
* - allscenarios-image-base
- Approximate 100-200 MB
- All Scenarios OS image including the base OS software stack
* - allscenarios-image-extra
- Approximate 100-200 MB
- All Scenarios OS Wayland image including the base OS software stack
Building OHOS image
===================
......
......@@ -21,20 +21,6 @@ To clone the source code, perform the procedure in: :ref:`Setting up a repo work
Building a Linux image
======================
Supported images
----------------
.. list-table:: Supported images
:widths: auto
:header-rows: 1
* - Image Name
- Description
* - allscenarios-image-base
- All Scenarios OS image including the base OS software stack
* - allscenarios-image-extra
- All Scenarios OS Wayland image including the base OS software stack
Build steps
-----------
......
......@@ -21,20 +21,6 @@ To clone the source code, perform the procedure in: :ref:`Setting up a repo work
Building a Linux image
======================
Supported images
----------------
.. list-table:: Supported images
:widths: auto
:header-rows: 1
* - Image Name
- Description
* - allscenarios-image-base
- All Scenarios OS image including the base OS software stack
* - allscenarios-image-extra
- All Scenarios OS Wayland image including the base OS software stack
Build steps
-----------
......
......@@ -21,20 +21,6 @@ To clone the source code, perform the procedure in: :ref:`Setting up a repo work
Building a Linux image
======================
Supported images
----------------
.. list-table:: Supported images
:widths: auto
:header-rows: 1
* - Image Name
- Description
* - allscenarios-image-base
- All Scenarios OS image including the base OS software stack
* - allscenarios-image-extra
- All Scenarios OS Wayland image including the base OS software stack
Build steps
-----------
......
......@@ -21,20 +21,6 @@ To clone the source code, perform the procedure in: :ref:`Setting up a repo work
Building a Linux image
======================
Supported images
----------------
.. list-table:: Supported images
:widths: auto
:header-rows: 1
* - Image Name
- Description
* - allscenarios-image-base
- All Scenarios OS image including the base OS software stack
* - allscenarios-image-extra
- All Scenarios OS Wayland image including the base OS software stack
Build steps
-----------
......
......@@ -15,4 +15,5 @@ Build system documentation
ohos-build/index
ci/index
blueprints/index
supported-images
hardware-support/index
.. SPDX-FileCopyrightText: Huawei Inc.
..
.. SPDX-License-Identifier: CC-BY-4.0
Supported Images
################
To create a custom Linux distribution to match the product requirements,
All Scenarios OS includes a set of predefined images for developing a product image.
Linux Kernel
************
The Linux kernel is a free and open-source Unix-like operating system (OS)
kernel that serves as the primary interface between the computer's hardware and its processes.
All Scenarios OS supports the following images listed in the table:
.. list-table:: Linux supported images
:header-rows: 1
* - Image Name
- Description
* - allscenarios-image-base
-
* All Scenarios OS image including the base OS software stack.
* This image also includes middleware and application packages to support a wide range of hardware which includes WiFi, Bluetooth, sound, and serial ports.
* - allscenarios-image-extra
-
* All Scenarios OS Wayland image including the base OS software stack. This is a Wayland protocol and Weston reference compositor-based image.
* It uses the Wayland protocol and implementation to exchange data with its clients.
* This image provides the Wayland protocol libraries and the reference Weston compositor and includes a Wayland-capable terminal program.
To build a Linux-based image for a supported machine, see :ref:`Linux Kernel Build Flavour <Linux_Kernel>`.
Zephyr Kernel
*************
The Zephyr OS is a well-known security-oriented real-time operating system (RTOS)
that is intended for use on resource-constrained and embedded systems.
For more detailed information on Zephyr OS Kernel, see `Zephyr documentation <https://docs.zephyrproject.org/latest/index.html#>`_.
All Scenarios OS supports the following images for the Zephyr OS kernel:
.. list-table:: Zephyr supported images
:header-rows: 1
* - Image Name
- Description
* - zephyr-philosophers
- A sample Zephyr application implementing the Dining Philosophers problem.
To build a Zephyr-based image for a supported machine, see :ref:`Zephyr Kernel Build Flavour <Zephyr_Kernel>`.
FreeRTOS Kernel
***************
The FreeRTOS kernel is a real-time operating system (RTOS) that runs on a variety
of platforms which is used to build microcontroller-based embedded applications.
The standard RTOS kernel binary image ranges from 4000 to 9000 bytes.
All Scenarios OS supports the following images for FreeRTOS Kernel:
.. list-table:: FreeRTOS supported images
:header-rows: 1
* - Image Name
- Description
* - freertos-demo
- Machine configuration for running an ARMv5 system on QEMU.
To build a FreeRTOS-based image for a supported machine, see :ref:`FreeRTOS Kernel Build Flavour <FreeRTOS_Kernel>`.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment