From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 4AE8E432CE; Wed, 8 Nov 2023 04:04:17 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 36A2540299; Wed, 8 Nov 2023 04:04:17 +0100 (CET) Received: from szxga03-in.huawei.com (szxga03-in.huawei.com [45.249.212.189]) by mails.dpdk.org (Postfix) with ESMTP id 47E8B40041 for ; Wed, 8 Nov 2023 04:04:16 +0100 (CET) Received: from kwepemm000004.china.huawei.com (unknown [172.30.72.53]) by szxga03-in.huawei.com (SkyGuard) with ESMTP id 4SQ8vP2zdszMmbJ; Wed, 8 Nov 2023 10:59:45 +0800 (CST) Received: from [10.67.121.59] (10.67.121.59) by kwepemm000004.china.huawei.com (7.193.23.18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.31; Wed, 8 Nov 2023 11:03:25 +0800 Message-ID: Date: Wed, 8 Nov 2023 11:03:25 +0800 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:91.0) Gecko/20100101 Thunderbird/91.2.0 Subject: Re: [PATCH v3 7/7] doc: testpmd support event handling section To: Chengwen Feng , , , , , Aman Singh , Yuying Zhang CC: , , , References: <20230301030610.49468-1-fengchengwen@huawei.com> <20231106131128.33499-1-fengchengwen@huawei.com> <20231106131128.33499-8-fengchengwen@huawei.com> From: "lihuisong (C)" In-Reply-To: <20231106131128.33499-8-fengchengwen@huawei.com> Content-Type: text/plain; charset="UTF-8"; format=flowed Content-Transfer-Encoding: 8bit X-Originating-IP: [10.67.121.59] X-ClientProxiedBy: dggems706-chm.china.huawei.com (10.3.19.183) To kwepemm000004.china.huawei.com (7.193.23.18) X-CFilter-Loop: Reflected X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Acked-by: Huisong Li 在 2023/11/6 21:11, Chengwen Feng 写道: > Add new section of event handling, which documented the ethdev and > device events. > > Signed-off-by: Chengwen Feng > --- > doc/guides/testpmd_app_ug/event_handling.rst | 81 ++++++++++++++++++++ > doc/guides/testpmd_app_ug/index.rst | 1 + > 2 files changed, 82 insertions(+) > create mode 100644 doc/guides/testpmd_app_ug/event_handling.rst > > diff --git a/doc/guides/testpmd_app_ug/event_handling.rst b/doc/guides/testpmd_app_ug/event_handling.rst > new file mode 100644 > index 0000000000..1c39e0c486 > --- /dev/null > +++ b/doc/guides/testpmd_app_ug/event_handling.rst > @@ -0,0 +1,81 @@ > +.. SPDX-License-Identifier: BSD-3-Clause > + Copyright(c) 2023 HiSilicon Limited. > + > +Event Handling > +============== > + > +The ``testpmd`` application supports following two type event handling: > + > +ethdev events > +------------- > + > +The ``testpmd`` provide options "--print-event" and "--mask-event" to control > +whether display such as "Port x y event" when received "y" event on port "x". > +This is named as default processing. > + > +This section details the support events, unless otherwise specified, only the > +default processing is support. > + > +- ``RTE_ETH_EVENT_INTR_LSC``: > + If device started with lsc enabled, the PMD will launch this event when it > + detect link status changes. > + > +- ``RTE_ETH_EVENT_QUEUE_STATE``: > + Used when notify queue state event changed, for example: vhost PMD use this > + event report whether vring enabled. > + > +- ``RTE_ETH_EVENT_INTR_RESET``: > + Used to report reset interrupt happened, this event only reported when the > + PMD supports ``RTE_ETH_ERROR_HANDLE_MODE_PASSIVE``. > + > +- ``RTE_ETH_EVENT_VF_MBOX``: > + Used as a PF to process mailbox messages of the VFs to which the PF belongs. > + > +- ``RTE_ETH_EVENT_INTR_RMV``: > + Used to report device removal event. The ``testpmd`` will remove the port > + later. > + > +- ``RTE_ETH_EVENT_NEW``: > + Used to report port was probed event. The ``testpmd`` will setup the port > + later. > + > +- ``RTE_ETH_EVENT_DESTROY``: > + Used to report port was released event. The ``testpmd`` will changes the > + port's status. > + > +- ``RTE_ETH_EVENT_MACSEC``: > + Used to report MACsec offload related event. > + > +- ``RTE_ETH_EVENT_IPSEC``: > + Used to report IPsec offload related event. > + > +- ``RTE_ETH_EVENT_FLOW_AGED``: > + Used to report new aged-out flows was detected. Only valid with mlx5 PMD. > + > +- ``RTE_ETH_EVENT_RX_AVAIL_THRESH``: > + Used to report available Rx descriptors was smaller than the threshold. Only > + valid with mlx5 PMD. > + > +- ``RTE_ETH_EVENT_ERR_RECOVERING``: > + Used to report error happened, and PMD will do recover after report this > + event. The ``testpmd`` will stop packet forwarding when received the event. > + > +- ``RTE_ETH_EVENT_RECOVERY_SUCCESS``: > + Used to report error recovery success. The ``testpmd`` will restart packet > + forwarding when received the event. > + > +- ``RTE_ETH_EVENT_RECOVERY_FAILED``: > + Used to report error recovery failed. The ``testpmd`` will display one > + message to show which ports failed. > + > +.. note:: > + > + The ``RTE_ETH_EVENT_ERR_RECOVERING``, ``RTE_ETH_EVENT_RECOVERY_SUCCESS`` and > + ``RTE_ETH_EVENT_RECOVERY_FAILED`` only reported when the PMD supports > + ``RTE_ETH_ERROR_HANDLE_MODE_PROACTIVE``. > + > +device events > +------------- > + > +Including two events ``RTE_DEV_EVENT_ADD`` and ``RTE_DEV_EVENT_ADD``, and > +enabled only when the ``testpmd`` stated with options "--hot-plug". > diff --git a/doc/guides/testpmd_app_ug/index.rst b/doc/guides/testpmd_app_ug/index.rst > index 1ac0d25d57..3c09448c4e 100644 > --- a/doc/guides/testpmd_app_ug/index.rst > +++ b/doc/guides/testpmd_app_ug/index.rst > @@ -14,3 +14,4 @@ Testpmd Application User Guide > build_app > run_app > testpmd_funcs > + event_handling