From nobody Tue May 13 17:27:25 2025 Delivered-To: importer2@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer2=patchew.org@nongnu.org ARC-Seal: i=1; a=rsa-sha256; t=1673521427; cv=none; d=zohomail.com; s=zohoarc; b=NQ6c+tM/70M/suypiES79wKH8z/24EBXErq6VUCuNW513tfwUbrQi+JmHmawhOjPYIbPi2mbEgPIIUY3kXlEb8gBVyOL7mKzB1rUDbDg+LFQxG8CIN/q8vNx4cNi+MYZNZIZmAMcxveqSFnfbgVe471YJuhPxHESrgV43GGbhmk= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1673521427; h=Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject; bh=g6mkBxM0Z3pNaEsozqsc7CcE/5VUZ1sBak/IAZz3dxQ=; b=l2i6oNf5q9leMJIYU2tjSys6TomktEY4a2QMmu6EW3hMgUvYfwSRhR3bc4ItzW88WE1+7ND3UV3LCzyzhrgb4aqkrCttUgrnEB+aIjmXejFGwW/0qa+wCiGAOipAbRtndcEcLFN/MrhBbVoQz76Bl+JSq7yzS2nkQLeODgowZSA= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer2=patchew.org@nongnu.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1673521427157461.8802079979455; Thu, 12 Jan 2023 03:03:47 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pFuO8-0004ry-Gu; Thu, 12 Jan 2023 05:00:48 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pFuNw-0004iN-BM for qemu-devel@nongnu.org; Thu, 12 Jan 2023 05:00:45 -0500 Received: from mail-pj1-x102e.google.com ([2607:f8b0:4864:20::102e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pFuNu-0004ud-0E for qemu-devel@nongnu.org; Thu, 12 Jan 2023 05:00:36 -0500 Received: by mail-pj1-x102e.google.com with SMTP id gz9-20020a17090b0ec900b002290bda1b07so323287pjb.1 for ; Thu, 12 Jan 2023 02:00:33 -0800 (PST) Received: from alarm.flets-east.jp ([2400:4050:a840:1e00:4457:c267:5e09:481b]) by smtp.gmail.com with ESMTPSA id k13-20020a17090a3ccd00b00219025945dcsm12095450pjd.19.2023.01.12.02.00.27 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 12 Jan 2023 02:00:32 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=daynix-com.20210112.gappssmtp.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=g6mkBxM0Z3pNaEsozqsc7CcE/5VUZ1sBak/IAZz3dxQ=; b=5I9QnRlffLYwI1eU8lAME7d8PuoWGf0k1pjvLCJuds4vn6xc0Ip5XOXSFjaqX7WX01 HIcoi9cCOGtj1iUSPeLocGes4800BGVz+1k38CIiSauNjzDiYS63E7MJGTyZpcNWgDn0 qwA3QnGm4ds6FmxYYvl3igxGKVXLEoGXXVnrYH5FPe7u8tZds6CwWBuSNMMwPj+ENhfa 3tyxL7UmTaW9YHgZ5dbDdR7A1t58+ZoeXxtCSB6rkspW/Kb/ac18favuLkoq/XxNTY4L +Al+2T2W3J4lUc9kfU57h8qs9UT+2SIKc8qOcskkAx0Pwl7Erqc31bwTkCH1p+U8Zrsp VdRA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=g6mkBxM0Z3pNaEsozqsc7CcE/5VUZ1sBak/IAZz3dxQ=; b=i4kHTKuFU5pgQc/cdovzuKNl6zxBpQepcPbv+m/QyDt6CNNycEw9HdMZKcA/Qk6l0p x5XJDXUSsBW/FWIdqR8DqtwfmE2xR7l8LOe+o2GN+FuwPvYwIa5ipb6rw8tOj3LstjDC uhT22b3WxDGhSYson/O/mxkmQ8P77RE0RTkEp0AOtVGMmM38EBP8KDcvx4ctaddFG1Z3 DEPECwRdLWy8g8m1CixOjFxKQ33ZLas0mWZy/TsX13Z6KBf3UULpcmBWpTF+n3ZjukzH LNCPIQvXMcmSBR/vgi6XWdB+aaP2J0zyILr6qa0XJgkmSNcZCgiuJ3hj2fnYqTckk/Gt L9cQ== X-Gm-Message-State: AFqh2krBccc1ck1BXt+hly6t4NJ2+lgXtLeaptdmMkJyGRr/kfmiY3be UhtPPy5pm4as9LFB5ayLfod/1A== X-Google-Smtp-Source: AMrXdXsF8CcoEQqFDtmFYtElfmokq4mKMLtuJFKzZ/2W9Ms7+YzBix3QL0fs46Ez5dB6/W18em0SJw== X-Received: by 2002:a17:90a:e604:b0:228:d8a5:2177 with SMTP id j4-20020a17090ae60400b00228d8a52177mr7859064pjy.22.1673517632562; Thu, 12 Jan 2023 02:00:32 -0800 (PST) From: Akihiko Odaki To: Cc: Akihiko Odaki , Jason Wang , Dmitry Fleytman , "Michael S. Tsirkin" , Marcel Apfelbaum , =?UTF-8?q?Alex=20Benn=C3=A9e?= , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Thomas Huth , Wainer dos Santos Moschetta , Beraldo Leal , Cleber Rosa , Laurent Vivier , Paolo Bonzini , Alexander Bulekov , Bandan Das , Stefan Hajnoczi , Darren Kenny , Qiuhao Li , qemu-devel@nongnu.org, qemu-ppc@nongnu.org, devel@daynix.com, Yan Vugenfirer , Yuri Benditovich , Sriram Yagnaraman Subject: [PATCH 31/31] docs/system/devices/igb: Add igb documentation Date: Thu, 12 Jan 2023 18:57:43 +0900 Message-Id: <20230112095743.20123-32-akihiko.odaki@daynix.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20230112095743.20123-1-akihiko.odaki@daynix.com> References: <20230112095743.20123-1-akihiko.odaki@daynix.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer2=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: none client-ip=2607:f8b0:4864:20::102e; envelope-from=akihiko.odaki@daynix.com; helo=mail-pj1-x102e.google.com X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_NONE=0.001 autolearn=unavailable autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer2=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer2=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @daynix-com.20210112.gappssmtp.com) X-ZM-MESSAGEID: 1673521429307100001 Content-Type: text/plain; charset="utf-8" Signed-off-by: Akihiko Odaki --- 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 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-emulatio= n.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 wit= hout +requiring physical hardware. + +Limitations +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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 wit= h 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 functiona= lities +not covered by the tests. + +Using igb +=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Using igb should be nothing different from using another network device. S= ee +: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 +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +igb is the successor of e1000e, and e1000e is the successor of e1000 in tu= rn. +As these devices are very similar, if you make a change for igb and the sa= me +change can be applied to e1000e and e1000, please do so. + +Please do not forget to run tests before submitting a change. As tests inc= luded +in QEMU is very minimal, run some application which is likely to be affect= ed by +the change to confirm it works in an integrated system. + +Testing igb +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +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=3Dtests/avocado/igb.py + +References +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +.. [1] https://www.intel.com/content/dam/www/public/us/en/documents/datash= eets/82576eb-gigabit-ethernet-controller-datasheet.pdf +.. [2] https://github.com/linux-test-project/ltp +.. [3] https://docs.kernel.org/PCI/pci-iov-howto.html --=20 2.39.0