diff --git a/docs/build-flavours/freertos-flavour.rst b/docs/build-flavours/freertos-flavour.rst index 18a28b991b95a4d90039b03e37396ed1890bc605..34eda856100a06c68e2daac9dcb31971232edb6e 100644 --- a/docs/build-flavours/freertos-flavour.rst +++ b/docs/build-flavours/freertos-flavour.rst @@ -2,6 +2,8 @@ .. .. SPDX-License-Identifier: CC-BY-4.0 +.. _FreeRTOS_Kernel: + FreeRTOS Kernel Build Flavour ############################# diff --git a/docs/build-flavours/linux-flavour.rst b/docs/build-flavours/linux-flavour.rst index 2ffaf6b7a08a520de14e77651d266a192970ca23..4eaa8101decc0575430561944880e8c19000b3d0 100644 --- a/docs/build-flavours/linux-flavour.rst +++ b/docs/build-flavours/linux-flavour.rst @@ -2,6 +2,8 @@ .. .. SPDX-License-Identifier: CC-BY-4.0 +.. _Linux_Kernel: + Linux Kernel Build Flavour ########################## diff --git a/docs/build-flavours/zephyr-flavour.rst b/docs/build-flavours/zephyr-flavour.rst index 5dca58ffe2986074e8deccb7098d7dc3e5086a72..6d2025f259da46f99d1126570fdd6690b144234a 100644 --- a/docs/build-flavours/zephyr-flavour.rst +++ b/docs/build-flavours/zephyr-flavour.rst @@ -2,6 +2,8 @@ .. .. SPDX-License-Identifier: CC-BY-4.0 +.. _Zephyr_Kernel: + Zephyr Kernel Build Flavour ########################### diff --git a/docs/hardware-support/boards/96b-Avenger.rst b/docs/hardware-support/boards/96b-Avenger.rst index 7b16a94b3d71d0b19b6b1b57933f393b1d3c385e..7fda97541bf1b9d4c2cde9ef6ae2d4b4208ad67a 100644 --- a/docs/hardware-support/boards/96b-Avenger.rst +++ b/docs/hardware-support/boards/96b-Avenger.rst @@ -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 =================== diff --git a/docs/hardware-support/boards/96b-nitrogen.rst b/docs/hardware-support/boards/96b-nitrogen.rst index 9a4985e605ad54193a9bd3059d9e6856415c1727..72d6679942245d233e4d4f9f9557d9267660c68f 100644 --- a/docs/hardware-support/boards/96b-nitrogen.rst +++ b/docs/hardware-support/boards/96b-nitrogen.rst @@ -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 ======================= diff --git a/docs/hardware-support/boards/raspberrypi4.rst b/docs/hardware-support/boards/raspberrypi4.rst index 487b8714a94fedac8d0399d2fc3d4eaa5f58e583..8701fdbd73c9dbe592e648703a71ef63038223f7 100644 --- a/docs/hardware-support/boards/raspberrypi4.rst +++ b/docs/hardware-support/boards/raspberrypi4.rst @@ -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 =============================== diff --git a/docs/hardware-support/boards/seco-imx8mm-c61.rst b/docs/hardware-support/boards/seco-imx8mm-c61.rst index 23463e23fa7e998b150c6d7d865b7b5bb67b2053..f5fd2e4a3d22ad84f49efb1ec44d7c524056b3e0 100644 --- a/docs/hardware-support/boards/seco-imx8mm-c61.rst +++ b/docs/hardware-support/boards/seco-imx8mm-c61.rst @@ -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 =================== diff --git a/docs/hardware-support/boards/seco-intel-b68.rst b/docs/hardware-support/boards/seco-intel-b68.rst index 08dd1dccf6d37a26273b3800d4d3440dd983a89e..a9e87333a698d45ea02c9d0af2165646964e70c7 100644 --- a/docs/hardware-support/boards/seco-intel-b68.rst +++ b/docs/hardware-support/boards/seco-intel-b68.rst @@ -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 =================== diff --git a/docs/hardware-support/virtual-boards/qemuarm.rst b/docs/hardware-support/virtual-boards/qemuarm.rst index fcd3a88f7c4e17b3d75ea0b382233ad743268f52..b0e8da860689e2aa5cdd55392af6d1e65514b8f0 100644 --- a/docs/hardware-support/virtual-boards/qemuarm.rst +++ b/docs/hardware-support/virtual-boards/qemuarm.rst @@ -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 ----------- diff --git a/docs/hardware-support/virtual-boards/qemuarm64.rst b/docs/hardware-support/virtual-boards/qemuarm64.rst index ba848fe68cd96d83e9e2ceddaaf754889b953f74..471f3dce1bba0b66d7482074d66298f61229799a 100644 --- a/docs/hardware-support/virtual-boards/qemuarm64.rst +++ b/docs/hardware-support/virtual-boards/qemuarm64.rst @@ -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 ----------- diff --git a/docs/hardware-support/virtual-boards/qemux86-64.rst b/docs/hardware-support/virtual-boards/qemux86-64.rst index 8beac404c3dea88b710a6228e80019028c3c7ed7..fdcc68ea6675d968a903fa66c8a0f1a0215fa131 100644 --- a/docs/hardware-support/virtual-boards/qemux86-64.rst +++ b/docs/hardware-support/virtual-boards/qemux86-64.rst @@ -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 ----------- diff --git a/docs/hardware-support/virtual-boards/qemux86.rst b/docs/hardware-support/virtual-boards/qemux86.rst index b38a7657857937593ace1e5eef46b3926fdc2a74..2d1a9b3c09f91f243be6f511474639ce1a2bcf89 100644 --- a/docs/hardware-support/virtual-boards/qemux86.rst +++ b/docs/hardware-support/virtual-boards/qemux86.rst @@ -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 ----------- diff --git a/docs/index.rst b/docs/index.rst index f5c6cbe8d53f61d4ed69adfa974a33f679db2c26..c0b83a04d79b3155b129b847cdbfd3fce249dfbc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,4 +15,5 @@ Build system documentation ohos-build/index ci/index blueprints/index + supported-images hardware-support/index diff --git a/docs/supported-images.rst b/docs/supported-images.rst new file mode 100644 index 0000000000000000000000000000000000000000..568714581455546fbceb084a265d7e24fc20f458 --- /dev/null +++ b/docs/supported-images.rst @@ -0,0 +1,73 @@ +.. 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>`.