From nobody Tue Feb 10 11:58:01 2026 Delivered-To: importer@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+importer=patchew.org@nongnu.org ARC-Seal: i=1; a=rsa-sha256; t=1673669613; cv=none; d=zohomail.com; s=zohoarc; b=LDc/2pFonjcmcnwa+O6uUtZQK3UtQAK8qFyP60QaPuwctTTIpXjdFAp7mejk1vaKbuEmWTrAUMIKMchj3fVM8VL6vjGcOfYPBE5eamsOFv3UgV2b6uFco/vnfUnlXArY2ZQj1GkGca7BgYl0ZVD2yZNpqB+5HBINbKo8Psp52oA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1673669613; 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=rli4HZEvXsso9F4dz6jCJp4UP5tc1yAU04PdvBH668o=; b=MeQvdLpXtVCBFIk+RMJm1lsXjdlxGNZvwF2Dk0avnxauOnCGJ8vos1XN7x0kA8s01OMNFBG1D0WlZ8nY4nGW0ijA3j7VUfx1BUunTQfJJrw7qRTw40haCKDnzTQCxC7vEnwKl4NLy53RM/+KKY277mWVAF5mUWzdDS/oxHjXf1U= 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+importer=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 1673669613365824.425473812498; Fri, 13 Jan 2023 20:13:33 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pGXtD-0006cA-V9; Fri, 13 Jan 2023 23:11:31 -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 1pGXtC-0006bd-SC for qemu-devel@nongnu.org; Fri, 13 Jan 2023 23:11:30 -0500 Received: from mail-pj1-x102c.google.com ([2607:f8b0:4864:20::102c]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pGXtB-0007Zi-1W for qemu-devel@nongnu.org; Fri, 13 Jan 2023 23:11:30 -0500 Received: by mail-pj1-x102c.google.com with SMTP id u1-20020a17090a450100b0022936a63a21so2398261pjg.4 for ; Fri, 13 Jan 2023 20:11:28 -0800 (PST) Received: from alarm.flets-east.jp ([2400:4050:a840:1e00:4457:c267:5e09:481b]) by smtp.gmail.com with ESMTPSA id c21-20020a63ef55000000b00478bd458bdfsm12244535pgk.88.2023.01.13.20.11.23 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 13 Jan 2023 20:11:27 -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=rli4HZEvXsso9F4dz6jCJp4UP5tc1yAU04PdvBH668o=; b=zO3PoP412N6wIwmqp+r3OBhLJ0aXq0NE5qjFIZKHdzSHcLMb9KJN8BZhRuDgI65ckd YaPEEtVRhQx+Cu+drfgJ9zmmL5N2kT7mXsdBfsU+1GDeoP76hVRt6Zlyage/Oa9JFZsb gpzCRw15nLwH47CmKwqyiyhEGvyvWRm/blBKb/gNl+qBWqF8IIOynnnuO5pfFIUNt2fm SuauIX12gVB87OCrXf5uejsQKcMBFlMhaF3YZQgtip+V5eI9jt9XFFOTLbjrsIceQiOf 38mZrX5EymSTohWp1nQuLtldhY3JJSKrF659kQysSnYYnv891QeJ/OT7kvg7evss9fg3 ldTA== 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=rli4HZEvXsso9F4dz6jCJp4UP5tc1yAU04PdvBH668o=; b=GIsc94ZaGuTncwe/kiMC0tIAjjr8ifKBCy0C/FwUeRrCrOZwmPVzFZx0ZRj/Niowhe PPnFgEfdwXh27q53dAbcksyH7cdCRAlpwglLY5b5Kc6Tas7NbAoVZvoFNOL97+Syl/a6 N4ZhUwGDAiRf5g5Km42WK0PvFi49LIiYj7nD5brS8S6Z/JXtmmavVaVJwxuG1a5SImZu 3KZzfo6jh6t/znWXqhNP2E60kQIPfyuCow9k+b3P6Mz73KFoOjIWY3sxwr8znHTdaGEk pyBh2IA0dQHE1aWHhhCT0UH7bs6FeJVh69Edd0zgecAAc9QeZfWGRsXzXYaEknhWtXAj ekPQ== X-Gm-Message-State: AFqh2kpMRe5E+w6mMv5igWsYDBEB1a86EnvYs18WZDU/BANue/043PW3 uqa621rbck5dFwQRZPaS2SLNlA== X-Google-Smtp-Source: AMrXdXvMvYdebFgqCco+blP1rfPphz1GWucj+dtPGSGbPH5sOC8pm6ubMB9Cx99qjeKuQJwLxiQlBw== X-Received: by 2002:a17:90b:394a:b0:219:9973:2746 with SMTP id oe10-20020a17090b394a00b0021999732746mr13298914pjb.0.1673669487964; Fri, 13 Jan 2023 20:11:27 -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 Subject: [PATCH v2 13/13] docs/system/devices/igb: Add igb documentation Date: Sat, 14 Jan 2023 13:10:04 +0900 Message-Id: <20230114041004.36459-14-akihiko.odaki@daynix.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20230114041004.36459-1-akihiko.odaki@daynix.com> References: <20230114041004.36459-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+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: none client-ip=2607:f8b0:4864:20::102c; envelope-from=akihiko.odaki@daynix.com; helo=mail-pj1-x102c.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+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @daynix-com.20210112.gappssmtp.com) X-ZM-MESSAGEID: 1673669614514100001 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 5409f2d625..8a72a29658 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -2221,6 +2221,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