[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 31/31] docs/system/devices/igb: Add igb documentation
From: |
Akihiko Odaki |
Subject: |
[PATCH 31/31] docs/system/devices/igb: Add igb documentation |
Date: |
Thu, 12 Jan 2023 18:57:43 +0900 |
Signed-off-by: Akihiko Odaki <akihiko.odaki@daynix.com>
---
MAINTAINERS | 1 +
docs/system/device-emulation.rst | 1 +
docs/system/devices/igb.rst | 70 ++++++++++++++++++++++++++++++++
3 files changed, 72 insertions(+)
create mode 100644 docs/system/devices/igb.rst
diff --git a/MAINTAINERS b/MAINTAINERS
index 5301c1908f..9bca2adf40 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -2211,6 +2211,7 @@ F: tests/qtest/fuzz-e1000e-test.c
igb
M: Akihiko Odaki <akihiko.odaki@daynix.com>
S: Maintained
+F: docs/system/devices/igb.rst
F: hw/net/igb*
F: tests/avocado/igb.py
F: tests/qtest/igb-test.c
diff --git a/docs/system/device-emulation.rst b/docs/system/device-emulation.rst
index 0506006056..c1b1934e3d 100644
--- a/docs/system/device-emulation.rst
+++ b/docs/system/device-emulation.rst
@@ -93,3 +93,4 @@ Emulated Devices
devices/virtio-pmem.rst
devices/vhost-user-rng.rst
devices/canokey.rst
+ devices/igb.rst
diff --git a/docs/system/devices/igb.rst b/docs/system/devices/igb.rst
new file mode 100644
index 0000000000..1a77c82ed8
--- /dev/null
+++ b/docs/system/devices/igb.rst
@@ -0,0 +1,70 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+.. _igb:
+
+igb
+---
+
+igb is a family of Intel's gigabit ethernet controllers. In QEMU, 82576
+emulation is implemented in particular. Its datasheet is available at [1]_.
+
+This implementation is expected to be useful to test SR-IOV networking without
+requiring physical hardware.
+
+Limitations
+===========
+
+This igb implementation was tested with Linux Test Project [2]_ during the
+initial development. The command used when testing is:
+
+.. code-block:: shell
+
+ network.sh -6mta
+
+Be aware that this implementation lacks many functionalities available with the
+actual hardware, and you may experience various failures if you try to use it
+with a different operating system other than Linux or if you try
functionalities
+not covered by the tests.
+
+Using igb
+=========
+
+Using igb should be nothing different from using another network device. See
+:ref:`pcsys_005fnetwork` in general.
+
+However, you may also need to perform additional steps to activate SR-IOV
+feature on your guest. For Linux, refer to [3]_.
+
+Developing igb
+==============
+
+igb is the successor of e1000e, and e1000e is the successor of e1000 in turn.
+As these devices are very similar, if you make a change for igb and the same
+change can be applied to e1000e and e1000, please do so.
+
+Please do not forget to run tests before submitting a change. As tests included
+in QEMU is very minimal, run some application which is likely to be affected by
+the change to confirm it works in an integrated system.
+
+Testing igb
+===========
+
+A qtest of the basic functionality is available. Run the below at the build
+directory:
+
+.. code-block:: shell
+
+ meson test qtest-x86_64/qos-test
+
+ethtool can test register accesses, interrupts, etc. It is automated as an
+Avocado test and can be ran with the following command:
+
+.. code:: shell
+
+ make check-avocado AVOCADO_TESTS=tests/avocado/igb.py
+
+References
+==========
+
+.. [1]
https://www.intel.com/content/dam/www/public/us/en/documents/datasheets/82576eb-gigabit-ethernet-controller-datasheet.pdf
+.. [2] https://github.com/linux-test-project/ltp
+.. [3] https://docs.kernel.org/PCI/pci-iov-howto.html
--
2.39.0
- [PATCH 07/31] e1000: Use more constant definitions, (continued)
- [PATCH 07/31] e1000: Use more constant definitions, Akihiko Odaki, 2023/01/12
- [PATCH 11/31] e1000e: Remove pending interrupt flags, Akihiko Odaki, 2023/01/12
- [PATCH 19/31] hw/net/net_tx_pkt: Introduce net_tx_pkt_get_eth_hdr, Akihiko Odaki, 2023/01/12
- [PATCH 21/31] e1000: Split header files, Akihiko Odaki, 2023/01/12
- [PATCH 22/31] igb: Copy e1000e code, Akihiko Odaki, 2023/01/12
- [PATCH 18/31] tests/qtest/libqos/e1000e: Remove duplicate register definitions, Akihiko Odaki, 2023/01/12
- [PATCH 31/31] docs/system/devices/igb: Add igb documentation,
Akihiko Odaki <=
- [PATCH 24/31] igb: Build igb, Akihiko Odaki, 2023/01/12
- [PATCH 03/31] fsl_etsec: Use hw/net/mii.h, Akihiko Odaki, 2023/01/12
- [PATCH 25/31] igb: Transform to 82576 implementation, Akihiko Odaki, 2023/01/12
- [PATCH 09/31] e1000: Use memcpy to intialize registers, Akihiko Odaki, 2023/01/12
- [PATCH 10/31] e1000e: Use memcpy to intialize registers, Akihiko Odaki, 2023/01/12
- [PATCH 13/31] e1000: Configure ResettableClass, Akihiko Odaki, 2023/01/12
- [PATCH 15/31] e1000e: Introduce e1000_rx_desc_union, Akihiko Odaki, 2023/01/12
- [PATCH 16/31] e1000e: Set MII_ANER_NWAY, Akihiko Odaki, 2023/01/12