[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 43/51] docs/system/devices/igb: Add igb documentation
From: |
Jason Wang |
Subject: |
[PULL 43/51] docs/system/devices/igb: Add igb documentation |
Date: |
Tue, 7 Mar 2023 15:08:08 +0800 |
From: Akihiko Odaki <akihiko.odaki@daynix.com>
Signed-off-by: Akihiko Odaki <akihiko.odaki@daynix.com>
Reviewed-by: Cédric Le Goater <clg@redhat.com>
Signed-off-by: Jason Wang <jasowang@redhat.com>
---
MAINTAINERS | 1 +
docs/system/device-emulation.rst | 1 +
docs/system/devices/igb.rst | 71 ++++++++++++++++++++++++++++++++++++++++
3 files changed, 73 insertions(+)
create mode 100644 docs/system/devices/igb.rst
diff --git a/MAINTAINERS b/MAINTAINERS
index 77f3dd3..e10eaa7 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -2235,6 +2235,7 @@ F: tests/qtest/libqos/e1000e.*
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 0506006..c1b1934 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 0000000..70edadd
--- /dev/null
+++ b/docs/system/devices/igb.rst
@@ -0,0 +1,71 @@
+.. 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]_ and Windows HLK
+[3]_ during the initial development. The command used when testing with LTP 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 and Windows 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 [4]_.
+
+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://learn.microsoft.com/en-us/windows-hardware/test/hlk/
+.. [4] https://docs.kernel.org/PCI/pci-iov-howto.html
--
2.7.4
- [PULL 33/51] net/eth: Report if headers are actually present, (continued)
- [PULL 33/51] net/eth: Report if headers are actually present, Jason Wang, 2023/03/07
- [PULL 36/51] pcie: Introduce pcie_sriov_num_vfs, Jason Wang, 2023/03/07
- [PULL 39/51] tests/qtest/e1000e-test: Fabricate ethernet header, Jason Wang, 2023/03/07
- [PULL 35/51] net/eth: Introduce EthL4HdrProto, Jason Wang, 2023/03/07
- [PULL 38/51] Intrdocue igb device emulation, Jason Wang, 2023/03/07
- [PULL 42/51] tests/avocado: Add igb test, Jason Wang, 2023/03/07
- [PULL 45/51] hw/net/eepro100: Abort if pci_add_capability() ever fail, Jason Wang, 2023/03/07
- [PULL 44/51] ebpf: fix compatibility with libbpf 1.0+, Jason Wang, 2023/03/07
- [PULL 48/51] hw/net/eepro100: Pass E100PCIDeviceInfo as class init data, Jason Wang, 2023/03/07
- [PULL 47/51] hw/net/eepro100: Convert reset handler to DeviceReset, Jason Wang, 2023/03/07
- [PULL 43/51] docs/system/devices/igb: Add igb documentation,
Jason Wang <=
- [PULL 40/51] tests/qtest/libqos/e1000e: Export macreg functions, Jason Wang, 2023/03/07
- [PULL 50/51] hw/net/eepro100: Remove instance's EEPRO100State::device, Jason Wang, 2023/03/07
- [PULL 49/51] hw/net/eepro100: Remove instance EEPRO100State::has_extended_tcb_support, Jason Wang, 2023/03/07
- [PULL 41/51] igb: Introduce qtest for igb device, Jason Wang, 2023/03/07
- [PULL 46/51] hw/net/eepro100: Introduce TYPE_EEPRO100 QOM abstract parent, Jason Wang, 2023/03/07
- [PULL 51/51] hw/net/eepro100: Replace DO_UPCAST(EEPRO100State) by EEPRO100(), Jason Wang, 2023/03/07
- Re: [PULL 00/51] Net patches, Peter Maydell, 2023/03/07