From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <zhiyong.yang@intel.com>
Received: from mga14.intel.com (mga14.intel.com [192.55.52.115])
 by dpdk.org (Postfix) with ESMTP id BBBA62C16
 for <dev@dpdk.org>; Fri,  4 Aug 2017 07:27:58 +0200 (CEST)
Received: from fmsmga006.fm.intel.com ([10.253.24.20])
 by fmsmga103.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;
 03 Aug 2017 22:27:57 -0700
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.41,319,1498546800"; d="scan'208";a="136007655"
Received: from unknown (HELO dpdk5.bj.intel.com) ([172.16.182.182])
 by fmsmga006.fm.intel.com with ESMTP; 03 Aug 2017 22:27:56 -0700
From: Zhiyong Yang <zhiyong.yang@intel.com>
To: dev@dpdk.org
Cc: jianfeng.tan@intel.com, yliu@fridaylinux.org,
 jerin.jacob@caviumnetworks.com, thomas@monjalon.net,
 Zhiyong Yang <zhiyong.yang@intel.com>
Date: Fri,  4 Aug 2017 13:27:53 +0800
Message-Id: <20170804052753.35535-1-zhiyong.yang@intel.com>
X-Mailer: git-send-email 2.13.3
In-Reply-To: <20170712075846.14834-1-zhiyong.yang@intel.com>
References: <20170712075846.14834-1-zhiyong.yang@intel.com>
Subject: [dpdk-dev] [PATCH v2] 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 <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Fri, 04 Aug 2017 05:28:00 -0000

This is an API/ABI change notice for DPDK 17.11 on redefinition of
port_id. port_id is defined as uint8_t by now, which is just ranged
from 0 to 255. For more and more scenerioes, more than 256 ports are
needed to support for vdev scalability.

It is necessary for redefinition of port_id to extend from 1 bytes
to 2 bytes. All ethdev APIs and use cases 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

Signed-off-by: Zhiyong Yang <zhiyong.yang@intel.com>
Acked-by: Jianfeng Tan <jianfeng.tan@intel.com>
Acked-by: Yuanhan Liu <yliu@fridaylinux.org>
Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
---

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
-- 
2.13.3