From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga12.intel.com (mga12.intel.com [192.55.52.136]) by dpdk.org (Postfix) with ESMTP id D02391B19 for ; Mon, 10 Sep 2018 16:03:42 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga003.jf.intel.com ([10.7.209.27]) by fmsmga106.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 10 Sep 2018 07:03:42 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.53,356,1531810800"; d="scan'208";a="82308732" Received: from dpdk51.sh.intel.com ([10.67.110.190]) by orsmga003.jf.intel.com with ESMTP; 10 Sep 2018 07:03:40 -0700 From: Qi Zhang To: thomas@monjalon.net, declan.doherty@intel.com, ferruh.yigit@intel.com Cc: dev@dpdk.org, Qi Zhang Date: Mon, 10 Sep 2018 22:04:37 +0800 Message-Id: <20180910140437.6741-1-qi.z.zhang@intel.com> X-Mailer: git-send-email 2.13.6 Subject: [dpdk-dev] [PATCH] 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: Mon, 10 Sep 2018 14:03:43 -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 claimed rte_eth_dev_reset 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/44513/ Signed-off-by: Qi Zhang --- doc/guides/rel_notes/deprecation.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index bade1e4c4..3490aac87 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -95,3 +95,8 @@ 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 claimed as an async API. + Application should not assume device reset is finished after + ``rte_eth_dev_reset`` return, it should always wait for a + RTE_ETH_EVENT_RESET_COMPLETE event and check the reset result. -- 2.13.6