From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 901E2A046B for ; Tue, 23 Jul 2019 16:08:10 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 7EF6B1C020; Tue, 23 Jul 2019 16:08:09 +0200 (CEST) Received: from dispatch1-us1.ppe-hosted.com (dispatch1-us1.ppe-hosted.com [148.163.129.52]) by dpdk.org (Postfix) with ESMTP id C827E1C00F for ; Tue, 23 Jul 2019 16:08:07 +0200 (CEST) X-Virus-Scanned: Proofpoint Essentials engine Received: from webmail.solarflare.com (webmail.solarflare.com [12.187.104.26]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-SHA384 (256/256 bits)) (No client certificate requested) by mx1-us2.ppe-hosted.com (PPE Hosted ESMTP Server) with ESMTPS id 2EC1BA40097; Tue, 23 Jul 2019 14:08:05 +0000 (UTC) Received: from ocex03.SolarFlarecom.com (10.20.40.36) by ocex03.SolarFlarecom.com (10.20.40.36) with Microsoft SMTP Server (TLS) id 15.0.1395.4; Tue, 23 Jul 2019 07:08:02 -0700 Received: from opal.uk.solarflarecom.com (10.17.10.1) by ocex03.SolarFlarecom.com (10.20.40.36) with Microsoft SMTP Server (TLS) id 15.0.1395.4 via Frontend Transport; Tue, 23 Jul 2019 07:08:01 -0700 Received: from ukv-loginhost.uk.solarflarecom.com (ukv-loginhost.uk.solarflarecom.com [10.17.10.39]) by opal.uk.solarflarecom.com (8.13.8/8.13.8) with ESMTP id x6NE80cr018704; Tue, 23 Jul 2019 15:08:00 +0100 Received: from ukv-loginhost.uk.solarflarecom.com (localhost [127.0.0.1]) by ukv-loginhost.uk.solarflarecom.com (Postfix) with ESMTP id 9810E1613C3; Tue, 23 Jul 2019 15:08:00 +0100 (BST) From: Andrew Rybchenko To: Thomas Monjalon , Ferruh Yigit CC: Date: Tue, 23 Jul 2019 15:07:51 +0100 Message-ID: <1563890871-26901-1-git-send-email-arybchenko@solarflare.com> X-Mailer: git-send-email 1.8.3.1 MIME-Version: 1.0 Content-Type: text/plain X-TM-AS-Product-Ver: SMEX-12.5.0.1300-8.5.1010-24788.002 X-TM-AS-Result: No-0.918300-4.000000-10 X-TMASE-MatchedRID: I6Wcs5Ard+WID0Lqh6RYhLrbxxduc6FPD+jls0cSwJMrxUs8Nw/2fh/Q aTHp1jSKrdoLblq9S5pomViyNzIIqWM2XgNitpqtbm8pd3f6T7/IqCUInvw46dctGlxeXl/oHEK EygixNPWilC2NpSpl+w3n1zz4+h1Ui2RWFwdAkVkcLuEDP+gqcnvEgoSBmr8B0fdJMjDg/DJKNN gKeyWO9GwG2Hqyve3AZmEowaccX53WiWF9/GqFgZXi1z8zt1TR/qWl+m17jWFpsnGGIgWMmQvm/ BVUWs37XSjVgziIU9OAMuqetGVetnyef22ep6XYro1URZJFbJstyvCXjREeRk5vWbs/rHAIjLsF RyyOz0/uH5Yqm8LXyY9yUeUF67MC6fqGA+R/UDsQr4uWc8PYnqgIn49wDwWstJ7/BgwAGkbw7Jx wU0EvZMqEROLb/+yO4/0Jvn0rwAJmtL4Dw+zNb0D/MIf9Orkd X-TM-AS-User-Approved-Sender: No X-TM-AS-User-Blocked-Sender: No X-TMASE-Result: 10-0.918300-4.000000 X-TMASE-Version: SMEX-12.5.0.1300-8.5.1010-24788.002 X-MDID: 1563890886-z5vkVb9hQ5az Subject: [dpdk-dev] [PATCH] doc: add deprecation notice to fix ethdev API returning void 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: , Errors-To: dev-bounces@dpdk.org Sender: "dev" void return value is bad for get API (like rte_eth_dev_info-get()) since caller does not know if the function does its job or not and output value is filled in. void return value is bad for state changing API (like rte_eth_promiscuous_enable()) since caller should use get API to understand if state is really changed. Signed-off-by: Andrew Rybchenko --- doc/guides/rel_notes/deprecation.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 37b8592b6..79689f136 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -59,6 +59,20 @@ Deprecation Notices Target release for removal of the legacy API will be defined once most PMDs have switched to rte_flow. +* ethdev: update API functions returning ``void`` to return ``int`` with + negative errno values to indicate various error conditions (e.g. + invalid port ID, unsupported operation, failed operation): + + - ``rte_eth_dev_info_get`` + - ``rte_eth_promiscuous_enable`` and ``rte_eth_promiscuous_disable`` + - ``rte_eth_allmulticast_enable`` and ``rte_eth_allmulticast_disable`` + - ``rte_eth_link_get`` and ``rte_eth_link_get_nowait`` + - ``rte_eth_dev_stop`` + - ``rte_eth_dev_close`` + - ``rte_eth_xstats_reset`` + - ``rte_eth_macaddr_get`` + - ``rte_eth_dev_owner_delete`` + * cryptodev: support for using IV with all sizes is added, J0 still can be used but only when IV length in following structs ``rte_crypto_auth_xform``, ``rte_crypto_aead_xform`` is set to zero. When IV length is greater or equal -- 2.17.1