From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by dpdk.org (Postfix) with ESMTP id 8545356A3 for ; Thu, 20 Sep 2018 06:59:02 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by orsmga102.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 19 Sep 2018 21:59:01 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.53,397,1531810800"; d="scan'208";a="264159364" Received: from dpdk51.sh.intel.com ([10.67.110.190]) by fmsmga005.fm.intel.com with ESMTP; 19 Sep 2018 21:58:59 -0700 From: Qi Zhang To: thomas@monjalon.net, declan.doherty@intel.com, ferruh.yigit@intel.com Cc: ktraynor@redhat.com, dev@dpdk.org, benjamin.h.shelton@intel.com, narender.vangati@intel.com, Qi Zhang Date: Thu, 20 Sep 2018 12:59:59 +0800 Message-Id: <20180920045959.106252-1-qi.z.zhang@intel.com> X-Mailer: git-send-email 2.13.6 Subject: [dpdk-dev] [PATCH v2] doc: update API deprecation for device reset X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 20 Sep 2018 04:59:02 -0000 Device reset may have the dependency, for example, a VF reset expects PF ready, or a NIC function as a part of a SOC need to wait for other parts of the system be ready, these are time-consuming tasks and will block current thread. So we rename rte_eth_dev_reset to rte_eth_dev_reset_async as an async API, that makes things easy for an application that what to reset the device from the interrupt thread since typically a RTE_ETH_EVENT_INTR_RESET handler is invoked in interrupt thread. RFC patch: http://patchwork.dpdk.org/patch/44989/ Signed-off-by: Qi Zhang --- v2: - rename rte_eth_dev_reset to rte_eth_dev_reset_async doc/guides/rel_notes/deprecation.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index bade1e4c4..c8dd6522e 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -95,3 +95,9 @@ Deprecation Notices - ``rte_pdump_set_socket_dir`` will be removed; - The parameter, ``path``, of ``rte_pdump_init`` will be removed; - The enum ``rte_pdump_socktype`` will be removed. + +* ethdev: In v19.02 ``rte_eth_dev_reset`` is renamed to + ``rte_eth_dev_reset_async``. As the name, it is an async API. + Application should not assume device reset is finished after + ``rte_eth_dev_reset_async`` return, it should always wait for a + RTE_ETH_EVENT_RESET_COMPLETE event and check the reset result. -- 2.13.6