From patchwork Wed May 15 16:36:56 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Fiona Trahe X-Patchwork-Id: 53440 X-Patchwork-Delegate: gakhil@marvell.com 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 9F6BC5A44; Wed, 15 May 2019 18:37:16 +0200 (CEST) Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by dpdk.org (Postfix) with ESMTP id 40F435920 for ; Wed, 15 May 2019 18:37:14 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga001.jf.intel.com ([10.7.209.18]) by fmsmga101.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 15 May 2019 09:37:14 -0700 X-ExtLoop1: 1 Received: from sivswdev09.ir.intel.com (HELO localhost.localdomain) ([10.237.217.48]) by orsmga001.jf.intel.com with ESMTP; 15 May 2019 09:37:11 -0700 From: Fiona Trahe To: dev@dpdk.org Cc: fiona.trahe@intel.com, akhil.goyal@nxp.com, pablo.de.lara.guarch@intel.com, declan.doherty@intel.com, roy.fan.zhang@intel.com, jerinj@marvell.com, radu.nicolau@intel.com Date: Wed, 15 May 2019 17:36:56 +0100 Message-Id: <1557938216-3912-1-git-send-email-fiona.trahe@intel.com> X-Mailer: git-send-email 1.7.0.7 Subject: [dpdk-dev] [PATCH] doc/cryptodev: clarify that full xform struct should be zeroed before use 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" Signed-off-by: Fiona Trahe Acked-by: Akhil Goyal --- doc/guides/prog_guide/cryptodev_lib.rst | 10 ++++++++-- 1 files changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/guides/prog_guide/cryptodev_lib.rst b/doc/guides/prog_guide/cryptodev_lib.rst index 23fa5bc..cc53b25 100644 --- a/doc/guides/prog_guide/cryptodev_lib.rst +++ b/doc/guides/prog_guide/cryptodev_lib.rst @@ -497,7 +497,10 @@ Symmetric Crypto transforms (``rte_crypto_sym_xform``) are the mechanism used to specify the details of the Crypto operation. For chaining of symmetric operations such as cipher encrypt and authentication generate, the next pointer allows transform to be chained together. Crypto devices which support chaining -must publish the chaining of symmetric Crypto operations feature flag. +must publish the chaining of symmetric Crypto operations feature flag. Allocation of the +xform structure is in the the application domain. To allow future API extensions in a +backwardly compatible manner, e.g. addition of a new parameter, the application should +zero the full xform struct before populating it. Currently there are three transforms types cipher, authentication and AEAD. Also it is important to note that the order in which the @@ -881,7 +884,10 @@ Transforms and Transform Chaining Asymmetric Crypto transforms (``rte_crypto_asym_xform``) are the mechanism used to specify the details of the asymmetric Crypto operation. Next pointer within xform allows transform to be chained together. Also it is important to note that -the order in which the transforms are passed indicates the order of the chaining. +the order in which the transforms are passed indicates the order of the chaining. Allocation +of the xform structure is in the the application domain. To allow future API extensions in a +backwardly compatible manner, e.g. addition of a new parameter, the application should +zero the full xform struct before populating it. Not all asymmetric crypto xforms are supported for chaining. Currently supported asymmetric crypto chaining is Diffie-Hellman private key generation followed by