From patchwork Mon Aug 7 12:42:30 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Yang, Zhiyong" X-Patchwork-Id: 27475 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id C7174374C; Mon, 7 Aug 2017 14:42:37 +0200 (CEST) Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by dpdk.org (Postfix) with ESMTP id 39F34326B for ; Mon, 7 Aug 2017 14:42:35 +0200 (CEST) Received: from orsmga005.jf.intel.com ([10.7.209.41]) by orsmga104.jf.intel.com with ESMTP; 07 Aug 2017 05:42:34 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.41,338,1498546800"; d="scan'208";a="134603951" Received: from unknown (HELO dpdk5.bj.intel.com) ([172.16.182.182]) by orsmga005.jf.intel.com with ESMTP; 07 Aug 2017 05:42:33 -0700 From: Zhiyong Yang To: dev@dpdk.org Cc: jianfeng.tan@intel.com, yliu@fridaylinux.org, jerin.jacob@caviumnetworks.com, thomas@monjalon.net, remy.horton@intel.com, Zhiyong Yang Date: Mon, 7 Aug 2017 20:42:30 +0800 Message-Id: <20170807124230.3030-1-zhiyong.yang@intel.com> X-Mailer: git-send-email 2.13.3 In-Reply-To: <20170804052753.35535-1-zhiyong.yang@intel.com> References: <20170804052753.35535-1-zhiyong.yang@intel.com> Subject: [dpdk-dev] [PATCH v3] doc: announce API and ABI change for ethdev 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" This is an API/ABI change notice for DPDK 17.11 announcing the redefinition of port_id. port_id is currently defined as uint8_t, which is limited to the range 0 to 255. A larger range is required for vdev scalability. It is necessary for a redefinition of port_id to extend it from 1 bytes to 2 bytes. All ethdev APIs and usages related to port_id will be changed at the same time. cc: jianfeng.tan@intel.com cc: yliu@fridaylinux.org cc: jerin.jacob@caviumnetworks.com cc: thomas@monjalon.net cc: remy.horton@intel.com Signed-off-by: Zhiyong Yang Acked-by: Jianfeng Tan Acked-by: Yuanhan Liu Acked-by: Jerin Jacob Acked-by: Remy Horton Acked-by: Shahaf Shuler --- Change in V3. update the commit log. Thanks for Remy's comment. Change in V2. 1. remove indent of paragraph in commit log. 2. add more description about API/ABI according to yuanhan's comments. 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 72aa40495..4edaf92fb 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -49,6 +49,12 @@ Deprecation Notices Target release for removal of the legacy API will be defined once most PMDs have switched to rte_flow. +* ABI/API changes are planned for 17.11 in all structures which include port_id + definition such as "rte_eth_dev_data", "rte_port_ethdev_reader_params", + "rte_port_ethdev_writer_params", and so on. The definition of port_id will be + changed from 8 bits to 16 bits in order to support more than 256 ports in + DPDK. All APIs which have port_id parameter will be changed at the same time. + * librte_table: The ``key_mask`` parameter will be added to all the hash tables that currently do not have it, as well as to the hash compute function prototype. The non-"do-sig" versions of the hash tables will be removed