From patchwork Mon Nov 6 01:41:41 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Monjalon X-Patchwork-Id: 31195 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 4472B1B2F1; Mon, 6 Nov 2017 02:42:28 +0100 (CET) Received: from out4-smtp.messagingengine.com (out4-smtp.messagingengine.com [66.111.4.28]) by dpdk.org (Postfix) with ESMTP id A0D8B1B2BB for ; Mon, 6 Nov 2017 02:42:23 +0100 (CET) Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id 55621205FC; Sun, 5 Nov 2017 20:42:23 -0500 (EST) Received: from frontend2 ([10.202.2.161]) by compute1.internal (MEProxy); Sun, 05 Nov 2017 20:42:23 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= cc:date:from:in-reply-to:message-id:references:subject:to :x-me-sender:x-me-sender:x-sasl-enc; s=mesmtp; bh=MUHx66Vg4D1yxD N4syj+e+lhzN6ma5pqEKTix94ReK4=; b=d5ZcyIceQ10T77HsWpzNRD89ki0JWZ 3TuFsCpJ1QZwsZ6KJemyF9s5r3LRFhCyUBc77iGLX4xGpqRfJFBVyGBIewwUEGMD /mEG4wBoxptUvyAQ77eP0cv1wCtVfWZqnZrjI1LG012dAHbfaI1c+0rTBlOhfD1D r1HjNFE/yfhsM= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:date:from:in-reply-to:message-id :references:subject:to:x-me-sender:x-me-sender:x-sasl-enc; s= fm1; bh=MUHx66Vg4D1yxDN4syj+e+lhzN6ma5pqEKTix94ReK4=; b=AtSGkLN/ ibZumfxaHJrh3u+QAhX7rHnMKZf7rsZLAiNrZOdsW3DayzYlwgzIWhBfINMcURSp XU0N/dUvhxeHeXFbfQhr1R1VwE/IZRawq/F0y0CEun3TGzVsPaUDuHiNySW7Llty 9GwJJusTiVNZYjNLry25Nv8CXi+RA/bzh0ReyLsloaLRBxqKy6nyHjzjWtO5HqQe i6mbStqrPAHgcNMOKZEm5stE7Ya0XIcIcmAFn28R2wZdZQPJ0sIflSD0juGBxelw 94I87zczvl58yn0Ue9dYH9rTOghel+yTjUN1aPLijvnMw8zDiqf2Kgobbo9MJjvH CESEKGy6gnjiNQ== X-ME-Sender: Received: from xps.monjalon.net (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id 8DC9524108; Sun, 5 Nov 2017 20:42:22 -0500 (EST) From: Thomas Monjalon To: Santosh Shukla Cc: olivier.matz@6wind.com, sergio.gonzalez.monroy@intel.com, anatoly.burakov@intel.com, dev@dpdk.org Date: Mon, 6 Nov 2017 02:41:41 +0100 Message-Id: <20171106014141.13266-16-thomas@monjalon.net> X-Mailer: git-send-email 2.14.2 In-Reply-To: <20171106014141.13266-1-thomas@monjalon.net> References: <20170814151537.29454-1-santosh.shukla@caviumnetworks.com> <20171106014141.13266-1-thomas@monjalon.net> Subject: [dpdk-dev] [PATCH v4 15/15] doc: add IOVA aware API changes in release notes 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" The wording changes have been done in the API without breaking the ABI. The deprecated fields and symbols can be removed later when an another ABI change will be required. The deprecation notice can be removed. The release notes describe the new available API with IOVA wording. Signed-off-by: Thomas Monjalon Acked-by: Santosh Shukla Acked-by: John McNamara --- doc/guides/rel_notes/deprecation.rst | 7 ------- doc/guides/rel_notes/release_17_11.rst | 17 +++++++++++++++++ 2 files changed, 17 insertions(+), 7 deletions(-) diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index a93c3e170..817f19213 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -21,13 +21,6 @@ Deprecation Notices - ``rte_eal_devargs_type_count`` - ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse`` -* eal: An ABI change is planned for 17.11 to make DPDK aware of IOVA address - translation scheme. - Reference to phys address in EAL data-structure or functions may change to - IOVA address or more appropriate name. - The change will be only for the name. - Functional aspects of the API or data-structure will remain same. - * pci: Several exposed functions are misnamed. The following functions are deprecated starting from v17.11 and are replaced: diff --git a/doc/guides/rel_notes/release_17_11.rst b/doc/guides/rel_notes/release_17_11.rst index b96b23614..85505fa8e 100644 --- a/doc/guides/rel_notes/release_17_11.rst +++ b/doc/guides/rel_notes/release_17_11.rst @@ -321,6 +321,23 @@ API Changes * ``rte_mem_phy2mch`` was used in Xen dom0 to obtain the physical address; remove this API as Xen dom0 support was removed. +* **Some data type, structure members and functions related to physical address + are deprecated and have new alias with IOVA wording.** + + * ``phys_addr_t`` can be often replaced by ``rte_iova_t`` of same size. + * ``RTE_BAD_PHYS_ADDR`` is often replaced by ``RTE_BAD_IOVA`` of same value. + * ``rte_memseg.phys_addr`` is aliased with ``rte_memseg.iova_addr``. + * ``rte_mem_virt2phy()`` can often be replaced by ``rte_mem_virt2iova``. + * ``rte_malloc_virt2phy`` is aliased with ``rte_malloc_virt2iova``. + * ``rte_memzone.phys_addr`` is aliased with ``rte_memzone.iova``. + * ``rte_mempool_objhdr.physaddr`` is aliased with ``rte_mempool_objhdr.iova``. + * ``rte_mempool_memhdr.phys_addr`` is aliased with ``rte_mempool_memhdr.iova``. + * ``rte_mempool_virt2phy()`` can be replaced by ``rte_mempool_virt2iova()``. + * ``rte_mempool_populate_phys*()`` are aliased with ``rte_mempool_populate_iova*()`` + * ``rte_mbuf.buf_physaddr`` is aliased with ``rte_mbuf.buf_iova``. + * ``rte_mbuf_data_dma_addr*()`` are aliased with ``rte_mbuf_data_iova*()``. + * ``rte_pktmbuf_mtophys*`` are aliased with ``rte_pktmbuf_iova*()``. + * **PCI bus API moved outside of the EAL** The PCI bus previously implemented within the EAL has been moved.