From 8788c4cea05d3ec4ab5f559e007d7a53a1613321 Mon Sep 17 00:00:00 2001
From: shettygururaj <gururaj.shetty@huawei.com>
Date: Wed, 19 May 2021 19:27:26 +0530
Subject: [PATCH] docs/faq: Introduce FAQ section with initial faulty hardware
device section
* List the supported hardware devices which can be used as an
altrnative for the respetive faulty device.
* New FAQ folder created under docs to accommodate all new FAQs
related to meta-ohos.
* Reference to the FAQ provided from the relevant topics.
* This closes #59
Signed-off-by: shettygururaj <gururaj.shetty@huawei.com>
---
docs/fallback-devices-support.rst | 56 +++++++++++++++++++
docs/hardware-support/boards/96b-Avenger.rst | 6 ++
docs/hardware-support/boards/raspberrypi4.rst | 4 ++
.../boards/seco-imx8mm-c61.rst | 2 +
.../boards/seco-intel-b68.rst | 2 +
docs/index.rst | 1 +
6 files changed, 71 insertions(+)
create mode 100644 docs/fallback-devices-support.rst
diff --git a/docs/fallback-devices-support.rst b/docs/fallback-devices-support.rst
new file mode 100644
index 00000000..6975bb96
--- /dev/null
+++ b/docs/fallback-devices-support.rst
@@ -0,0 +1,56 @@
+.. SPDX-FileCopyrightText: Huawei Inc.
+..
+.. SPDX-License-Identifier: CC-BY-4.0
+
+.. _FallbackSupport:
+
+How to handle faulty hardware device?
+#####################################
+
+In a situation where you have enabled a new board and one of the devices is
+faulty or has some issues (e.g. driver, hardware, firmware, and so on), to
+continue with the setup, it is important to have an alternative option for the
+faulty device.
+
+You can replace the respective faulty device with an external devices listed
+in the following table. The devices listed are hardware components with
+opensource drivers and have no usage restrictions.
+
+ .. list-table:: Supported External Hardware Device
+ :header-rows: 1
+
+ * - Device
+ - Chip
+ - Firmware status
+ - Dongle name
+ - Remarks
+ * - Ethernet
+ - RTL8153
+ - `linux-firmware <https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/WHENCE#n3284>`__
+ - Many available
+ - SFP variants available
+ * - WiFi
+ - RTl8192cu
+ - `linux-firmware <https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/WHENCE#n2972>`__, `license <https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/LICENCE.rtlwifi_firmware.txt>`__
+ - OURLiNK
+ - Works out-of-the-box
+ * - WiFi
+ - Ralink RT5372
+ - `linux-firmware <https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/WHENCE#n1673>`__, `license <https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/LICENCE.ralink-firmware.txt>`__
+ - PAU05 - Panda Wireless
+ - Works out-of-the-box
+ * - Bluetooth
+ - BCM20702A0
+ - `linux-firmwar <https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/WHENCE#n13>`__, `license <https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/LICENCE.cypress>`__
+ - PLUGABLE
+ - Works out-of-the-box
+ * - Bluetooth
+ - BCM20702A0
+ - `linux-firmwar <https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/WHENCE#n13>`__, `license <https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/LICENCE.cypress>`__
+ - Kinivo
+ - Works out-of-the-box
+ * - IEEE 802.15.4
+ - AT86RF231
+ - Flashed on device
+ - ATUSB
+ - `Open hardware and firmware <http://downloads.qi-hardware.com/people/werner/wpan/web/>`_
diff --git a/docs/hardware-support/boards/96b-Avenger.rst b/docs/hardware-support/boards/96b-Avenger.rst
index 7fda9754..2074c2ea 100644
--- a/docs/hardware-support/boards/96b-Avenger.rst
+++ b/docs/hardware-support/boards/96b-Avenger.rst
@@ -269,6 +269,8 @@ Wired connection works out of the box. You can use standard tools like ``ip``,
``ifconfig`` to configure the connection. The connection seems to have stable
1Gb/s bandwidth.
+For any fault in the hardware device, see :ref:`How to handle faulty hardware device <FallbackSupport>`.
+
USB Host
========
@@ -366,6 +368,8 @@ brought up with ``wpa_supplicant -i wlan0 -c ./wpa.conf``:
key_mgmt=NONE
}
+For any fault in the hardware device, see :ref:`How to handle faulty hardware device <FallbackSupport>`.
+
Bluetooth
---------
@@ -394,3 +398,5 @@ enabled as follows:
Pairing and establishing connection is possible with ``pair`` and ``connect``
commands.
+
+For any fault in the hardware device, see :ref:`How to handle faulty hardware device <FallbackSupport>`.
diff --git a/docs/hardware-support/boards/raspberrypi4.rst b/docs/hardware-support/boards/raspberrypi4.rst
index 11ebfc77..97ed0f46 100644
--- a/docs/hardware-support/boards/raspberrypi4.rst
+++ b/docs/hardware-support/boards/raspberrypi4.rst
@@ -146,6 +146,8 @@ Bluetooth & BLE
===============
By default, BT and BLE are supported.
+For any fault in the hardware device, see :ref:`How to handle faulty hardware device <FallbackSupport>`.
+
Ethernet & WiFi
===============
@@ -156,6 +158,8 @@ Setting a static of dynamic IP for the interface is implementation and
deployment specific and any network configuration tool can be used to
configure IPv4 or IPv6 address to RPi.
+For any fault in the hardware device, see :ref:`How to handle faulty hardware device <FallbackSupport>`.
+
Audio
=====
diff --git a/docs/hardware-support/boards/seco-imx8mm-c61.rst b/docs/hardware-support/boards/seco-imx8mm-c61.rst
index f5fd2e4a..7f8470c8 100644
--- a/docs/hardware-support/boards/seco-imx8mm-c61.rst
+++ b/docs/hardware-support/boards/seco-imx8mm-c61.rst
@@ -111,6 +111,8 @@ You can use standard tools like ``ip``, ``ifconfig`` to configure the connection
collisions:0 txqueuelen:1000
RX bytes:0 (0.0 B) TX bytes:0 (0.0 B)
+For any fault in the hardware device, see :ref:`How to handle faulty hardware device <FallbackSupport>`.
+
USB Host
========
diff --git a/docs/hardware-support/boards/seco-intel-b68.rst b/docs/hardware-support/boards/seco-intel-b68.rst
index a9e87333..6b3e0154 100644
--- a/docs/hardware-support/boards/seco-intel-b68.rst
+++ b/docs/hardware-support/boards/seco-intel-b68.rst
@@ -101,6 +101,8 @@ Ethernet
Wired connection works out of the box. You can use standard tools like ``ip``, ``ifconfig`` to configure the connection.
+For any fault in the hardware device, see :ref:`How to handle faulty hardware device <FallbackSupport>`.
+
USB Host
========
diff --git a/docs/index.rst b/docs/index.rst
index 1448459f..9dc32766 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -17,3 +17,4 @@ Build System Guide
blueprints/index
supported-images
hardware-support/index
+ fallback-devices-support
--
GitLab