From nobody Tue May 13 17:22:51 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=1675224963; cv=none; d=zohomail.com; s=zohoarc; b=MyqzszwpwOargbjTZjwadj08DzhCLTOaxMFV5+6YKTCPYVj7irWvRo08hpW1rcos/rqzHg6XfzMhTTm2Q9mM5eLlrW6tE1eo6pEgBp1t8C8PbMhsqs03Qt6E80OI42CVKLLwY+GPb+8M1vwOiauU3u+8OdtJxPeO7Hfvo/wxbNU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1675224963; 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=y2qTfeWrJluLuVNB72grEFW1qk7ta0SqRfMD7BVVAZw=; b=kazo9KXNcwH/3nGYwXOGoztVMGZs85OQap+aJ7NRHHI5O9dpO11oEmwVi9+jBlvn+g4IZCeinjz7R0+eaGdTmv2BnU1gv4ppbIYnnW0Lsql/41t+e5tOV53tDu7y9kW1IXzZCrI9jFLFV+x0YI6Wb+tawNhInaZsaCS0VjS8pRk= 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 1675224963082132.83365775028267; Tue, 31 Jan 2023 20:16:03 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pN4Vo-0001Uh-Ch; Tue, 31 Jan 2023 23:14:20 -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 1pN4Vn-0001U4-C2 for qemu-devel@nongnu.org; Tue, 31 Jan 2023 23:14:19 -0500 Received: from mail-pj1-x1029.google.com ([2607:f8b0:4864:20::1029]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pN4Vl-0001Cl-K4 for qemu-devel@nongnu.org; Tue, 31 Jan 2023 23:14:19 -0500 Received: by mail-pj1-x1029.google.com with SMTP id rm7-20020a17090b3ec700b0022c05558d22so741194pjb.5 for ; Tue, 31 Jan 2023 20:14:17 -0800 (PST) Received: from alarm.flets-east.jp ([2400:4050:a840:1e00:4457:c267:5e09:481b]) by smtp.gmail.com with ESMTPSA id q8-20020a17090a7a8800b0022c01052e92sm231350pjf.56.2023.01.31.20.14.12 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 31 Jan 2023 20:14:16 -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=y2qTfeWrJluLuVNB72grEFW1qk7ta0SqRfMD7BVVAZw=; b=Df6l0WlbZV90KL+OeYtTSegT7XifS3IzQRbVLsinNfYyLndKb7WSAetO90AxE1rPJX SPaRNk6hloJUxHw3R74uGN56sXHDRDR94rVfvponQUHY5MlSvrOoyfq0C+g/0Rn4Cf3k LCOVQyjnYyVmkeRLiMbMqfU1716lan5yrUROq7EDv2DZQ7PhKtWse0vcQrwxkPwW2Lgg o+O7HdH+ylEOFcHMEwtsdj73l+Dftl2kvkTYYngNMC3pJGF+S71MVkYdqVb1wt3zfM7x RBzKh6weQuWDwsjjWilxxQA6vz3FIjTiV2u2rw9ehKLeXOGoy6PTopzRxPIAZN2dTdfA 7nJA== 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=y2qTfeWrJluLuVNB72grEFW1qk7ta0SqRfMD7BVVAZw=; b=GppojR1WG4C6avwq2zMqwT+B7+hO55GnUSo0umJ8Z2ICzKjJMUilRmIf+Lg3BaMQkZ 5kikGkwb6Wp8nJ8RAyHOfJYJq9wqvbeH025oO/Y0o1bTQINaRY5df/mp1TIOSYGsHBUw wCe8b1I+GXkYg+8jLDmAs/9Nn9cf6Zzn7MXxaxIT3qf62ghKyKUP6UofWw4i3ft6Yg+7 roPxetY19V7J612lN6nJaAKsbpExF5FdgABZz1S2wX7iRgfPL3L3v71VvT80UraSt0iA aE1No0XTWACWMat/DUcDMg/rcTLk88OQLW6Lrn5HP+pPleK+SzpnfgJdhUN5WW765FQr umKg== X-Gm-Message-State: AO0yUKWCl/J4LVhj59OG+r52yqBAIPZEDym98ILbPoZT1D5VT7pBP61u ZlUL66jfMq4ENvuKiTb9uq7fMQ== X-Google-Smtp-Source: AK7set8mWYJRY17JsWNyHozzufN5DbnnTHWX3FDsR2T2e4Xp5lLtGDPixUNjedB7YxdslCpbu8YHeQ== X-Received: by 2002:a17:90a:1902:b0:22b:e71b:1fde with SMTP id 2-20020a17090a190200b0022be71b1fdemr739861pjg.15.1675224856938; Tue, 31 Jan 2023 20:14:16 -0800 (PST) From: Akihiko Odaki To: Cc: 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 , Gal Hammer , Akihiko Odaki Subject: [PATCH v6 9/9] docs/system/devices/igb: Add igb documentation Date: Wed, 1 Feb 2023 13:13:20 +0900 Message-Id: <20230201041320.32096-10-akihiko.odaki@daynix.com> X-Mailer: git-send-email 2.39.1 In-Reply-To: <20230201041320.32096-1-akihiko.odaki@daynix.com> References: <20230201041320.32096-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::1029; envelope-from=akihiko.odaki@daynix.com; helo=mail-pj1-x1029.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=ham 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: 1675224964351100001 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 | 71 ++++++++++++++++++++++++++++++++ 3 files changed, 73 insertions(+) create mode 100644 docs/system/devices/igb.rst diff --git a/MAINTAINERS b/MAINTAINERS index c0831aeb56..e85957e37f 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -2224,6 +2224,7 @@ F: tests/qtest/libqos/e1000e.* 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..70edadd574 --- /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 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]_ and Window= s HLK +[3]_ during the initial development. The command used when testing with LT= P 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 and Windows or if you t= ry +functionalities 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 [4]_. + +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://learn.microsoft.com/en-us/windows-hardware/test/hlk/ +.. [4] https://docs.kernel.org/PCI/pci-iov-howto.html --=20 2.39.1