Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/133896/?format=api
{ "id": 133896, "url": "http://patches.dpdk.org/api/patches/133896/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20231106131128.33499-8-fengchengwen@huawei.com/", "project": { "id": 1, "url": "http://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20231106131128.33499-8-fengchengwen@huawei.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20231106131128.33499-8-fengchengwen@huawei.com", "date": "2023-11-06T13:11:27", "name": "[v3,7/7] doc: testpmd support event handling section", "commit_ref": null, "pull_url": null, "state": "new", "archived": false, "hash": "f44b4068c83a8896d7f060f315d07780e5769358", "submitter": { "id": 2146, "url": "http://patches.dpdk.org/api/people/2146/?format=api", "name": "fengchengwen", "email": "fengchengwen@huawei.com" }, "delegate": { "id": 319, "url": "http://patches.dpdk.org/api/users/319/?format=api", "username": "fyigit", "first_name": "Ferruh", "last_name": "Yigit", "email": "ferruh.yigit@amd.com" }, "mbox": "http://patches.dpdk.org/project/dpdk/patch/20231106131128.33499-8-fengchengwen@huawei.com/mbox/", "series": [ { "id": 30169, "url": "http://patches.dpdk.org/api/series/30169/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=30169", "date": "2023-11-06T13:11:23", "name": "fix race-condition of proactive error handling mode", "version": 3, "mbox": "http://patches.dpdk.org/series/30169/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/133896/comments/", "check": "success", "checks": "http://patches.dpdk.org/api/patches/133896/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 0D47F432B0;\n\tMon, 6 Nov 2023 14:15:17 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 33D1340C35;\n\tMon, 6 Nov 2023 14:14:24 +0100 (CET)", "from szxga01-in.huawei.com (szxga01-in.huawei.com [45.249.212.187])\n by mails.dpdk.org (Postfix) with ESMTP id 95C66402EF\n for <dev@dpdk.org>; Mon, 6 Nov 2023 14:14:13 +0100 (CET)", "from dggpeml100024.china.huawei.com (unknown [172.30.72.55])\n by szxga01-in.huawei.com (SkyGuard) with ESMTP id 4SPBYg3TTnzrTxL;\n Mon, 6 Nov 2023 21:11:03 +0800 (CST)", "from localhost.localdomain (10.50.165.33) by\n dggpeml100024.china.huawei.com (7.185.36.115) with Microsoft SMTP Server\n (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id\n 15.1.2507.31; Mon, 6 Nov 2023 21:14:12 +0800" ], "From": "Chengwen Feng <fengchengwen@huawei.com>", "To": "<thomas@monjalon.net>, <ferruh.yigit@amd.com>,\n <konstantin.ananyev@huawei.com>, <ajit.khaparde@broadcom.com>, Aman Singh\n <aman.deep.singh@intel.com>, Yuying Zhang <yuying.zhang@intel.com>", "CC": "<dev@dpdk.org>, <andrew.rybchenko@oktetlabs.ru>,\n <kalesh-anakkur.purayil@broadcom.com>, <Honnappa.Nagarahalli@arm.com>", "Subject": "[PATCH v3 7/7] doc: testpmd support event handling section", "Date": "Mon, 6 Nov 2023 13:11:27 +0000", "Message-ID": "<20231106131128.33499-8-fengchengwen@huawei.com>", "X-Mailer": "git-send-email 2.17.1", "In-Reply-To": "<20231106131128.33499-1-fengchengwen@huawei.com>", "References": "<20230301030610.49468-1-fengchengwen@huawei.com>\n <20231106131128.33499-1-fengchengwen@huawei.com>", "MIME-Version": "1.0", "Content-Type": "text/plain", "X-Originating-IP": "[10.50.165.33]", "X-ClientProxiedBy": "dggems703-chm.china.huawei.com (10.3.19.180) To\n dggpeml100024.china.huawei.com (7.185.36.115)", "X-CFilter-Loop": "Reflected", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org" }, "content": "Add new section of event handling, which documented the ethdev and\ndevice events.\n\nSigned-off-by: Chengwen Feng <fengchengwen@huawei.com>\n---\n doc/guides/testpmd_app_ug/event_handling.rst | 81 ++++++++++++++++++++\n doc/guides/testpmd_app_ug/index.rst | 1 +\n 2 files changed, 82 insertions(+)\n create mode 100644 doc/guides/testpmd_app_ug/event_handling.rst", "diff": "diff --git a/doc/guides/testpmd_app_ug/event_handling.rst b/doc/guides/testpmd_app_ug/event_handling.rst\nnew file mode 100644\nindex 0000000000..1c39e0c486\n--- /dev/null\n+++ b/doc/guides/testpmd_app_ug/event_handling.rst\n@@ -0,0 +1,81 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+ Copyright(c) 2023 HiSilicon Limited.\n+\n+Event Handling\n+==============\n+\n+The ``testpmd`` application supports following two type event handling:\n+\n+ethdev events\n+-------------\n+\n+The ``testpmd`` provide options \"--print-event\" and \"--mask-event\" to control\n+whether display such as \"Port x y event\" when received \"y\" event on port \"x\".\n+This is named as default processing.\n+\n+This section details the support events, unless otherwise specified, only the\n+default processing is support.\n+\n+- ``RTE_ETH_EVENT_INTR_LSC``:\n+ If device started with lsc enabled, the PMD will launch this event when it\n+ detect link status changes.\n+\n+- ``RTE_ETH_EVENT_QUEUE_STATE``:\n+ Used when notify queue state event changed, for example: vhost PMD use this\n+ event report whether vring enabled.\n+\n+- ``RTE_ETH_EVENT_INTR_RESET``:\n+ Used to report reset interrupt happened, this event only reported when the\n+ PMD supports ``RTE_ETH_ERROR_HANDLE_MODE_PASSIVE``.\n+\n+- ``RTE_ETH_EVENT_VF_MBOX``:\n+ Used as a PF to process mailbox messages of the VFs to which the PF belongs.\n+\n+- ``RTE_ETH_EVENT_INTR_RMV``:\n+ Used to report device removal event. The ``testpmd`` will remove the port\n+ later.\n+\n+- ``RTE_ETH_EVENT_NEW``:\n+ Used to report port was probed event. The ``testpmd`` will setup the port\n+ later.\n+\n+- ``RTE_ETH_EVENT_DESTROY``:\n+ Used to report port was released event. The ``testpmd`` will changes the\n+ port's status.\n+\n+- ``RTE_ETH_EVENT_MACSEC``:\n+ Used to report MACsec offload related event.\n+\n+- ``RTE_ETH_EVENT_IPSEC``:\n+ Used to report IPsec offload related event.\n+\n+- ``RTE_ETH_EVENT_FLOW_AGED``:\n+ Used to report new aged-out flows was detected. Only valid with mlx5 PMD.\n+\n+- ``RTE_ETH_EVENT_RX_AVAIL_THRESH``:\n+ Used to report available Rx descriptors was smaller than the threshold. Only\n+ valid with mlx5 PMD.\n+\n+- ``RTE_ETH_EVENT_ERR_RECOVERING``:\n+ Used to report error happened, and PMD will do recover after report this\n+ event. The ``testpmd`` will stop packet forwarding when received the event.\n+\n+- ``RTE_ETH_EVENT_RECOVERY_SUCCESS``:\n+ Used to report error recovery success. The ``testpmd`` will restart packet\n+ forwarding when received the event.\n+\n+- ``RTE_ETH_EVENT_RECOVERY_FAILED``:\n+ Used to report error recovery failed. The ``testpmd`` will display one\n+ message to show which ports failed.\n+\n+.. note::\n+\n+ The ``RTE_ETH_EVENT_ERR_RECOVERING``, ``RTE_ETH_EVENT_RECOVERY_SUCCESS`` and\n+ ``RTE_ETH_EVENT_RECOVERY_FAILED`` only reported when the PMD supports\n+ ``RTE_ETH_ERROR_HANDLE_MODE_PROACTIVE``.\n+\n+device events\n+-------------\n+\n+Including two events ``RTE_DEV_EVENT_ADD`` and ``RTE_DEV_EVENT_ADD``, and\n+enabled only when the ``testpmd`` stated with options \"--hot-plug\".\ndiff --git a/doc/guides/testpmd_app_ug/index.rst b/doc/guides/testpmd_app_ug/index.rst\nindex 1ac0d25d57..3c09448c4e 100644\n--- a/doc/guides/testpmd_app_ug/index.rst\n+++ b/doc/guides/testpmd_app_ug/index.rst\n@@ -14,3 +14,4 @@ Testpmd Application User Guide\n build_app\n run_app\n testpmd_funcs\n+ event_handling\n", "prefixes": [ "v3", "7/7" ] }