From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wm0-f52.google.com (mail-wm0-f52.google.com [74.125.82.52]) by dpdk.org (Postfix) with ESMTP id BA7F693F2 for ; Wed, 25 Nov 2015 18:40:35 +0100 (CET) Received: by wmww144 with SMTP id w144so79083700wmw.0 for ; Wed, 25 Nov 2015 09:40:35 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id; bh=RxsNFxVt2CAYE8VX4yuHcwzm21ZzoHXWLGPVW5yFfXw=; b=Bex+cZNo/EARL+KX+cl4QDE0gfxPTRS9FOmVgy8dCjs7d75bqj4fj8Uz75c9nURzbo Eo1LqLDjss9R6hhMIU63KaIVGiY1PeOqC8N9Rsyyq0lbWhEM0iJ8cImZcbV026DV8js/ 9LScX5WCH/28ZuBzl82anu4bo459eUHGy+p+LA3ObBzhouQApbSdpAOa0SATXz89iHf0 iqvLkmSfCqI32bt9O4NV6cDp2g5zwcBsct40FpnwQxyUNflgFTMHBdfYUvPCMQKkANAh bwMfGLmOgNX2gm9VQ0UwsX28X+9eZMBTvr3/EFfj5mcFaRSS6TGUs80ZcH58YXg5VpGR E6lw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=RxsNFxVt2CAYE8VX4yuHcwzm21ZzoHXWLGPVW5yFfXw=; b=E0w0n9j4UHsZ7B0hRUN9ebkO8ADaxNvH0o6/1fXatn0MKJUEjI9vdzT5ENdtulcJVb 4I/dKwKdLmliPfCVj5yUfp9Izwsfdait/uNzByow8r3KmBOTZJk5WtjnQCo9VBCBO1D6 xzYExd6r8UTpU+qsa0PUDzFswjfOelvqcUViseuO7QVdC20fbDDJrVgOe6mEkpl9+9QR mwRdIX/Z0e1IBjsON29RQAQkveJMa1H1Z5gZAVGh2g7RUkFaPOCtFitqso2KlDvAvoD+ kutXWARZ7SjJM+1xr1ELOSq7CMcmIGxXLEkT7FmcT/0YzYad4B+bOnDOZgZlMcgB9TMD OOhw== X-Gm-Message-State: ALoCoQlZLC43rcsZrPYpZaT36cnu+ISIbqGUNx4L5IGDU2OCZXuEQgAhHykexmkXTzhuRfUniBAP X-Received: by 10.194.6.40 with SMTP id x8mr44010833wjx.50.1448473235463; Wed, 25 Nov 2015 09:40:35 -0800 (PST) Received: from localhost.localdomain (136-92-190-109.dsl.ovh.fr. [109.190.92.136]) by smtp.gmail.com with ESMTPSA id ot9sm24202404wjc.12.2015.11.25.09.40.34 (version=TLSv1/SSLv3 cipher=OTHER); Wed, 25 Nov 2015 09:40:34 -0800 (PST) From: Thomas Monjalon To: declan.doherty@intel.com Date: Wed, 25 Nov 2015 18:38:55 +0100 Message-Id: <1448473135-19604-1-git-send-email-thomas.monjalon@6wind.com> X-Mailer: git-send-email 2.5.2 Cc: dev@dpdk.org Subject: [dpdk-dev] [PATCH] cryptodev: mark experimental state X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 25 Nov 2015 17:40:35 -0000 The crypto API is in an early state. It requires more discussions and experiments to declare it stable, as discussed in http://dpdk.org/ml/archives/dev/2015-November/028634.html A documentation section will be required in the guides. Signed-off-by: Thomas Monjalon --- MAINTAINERS | 2 +- config/common_bsdapp | 1 + config/common_linuxapp | 1 + doc/guides/contributing/versioning.rst | 1 + doc/guides/rel_notes/release_2_2.rst | 10 ++++++++++ lib/librte_cryptodev/rte_cryptodev.h | 3 +++ 6 files changed, 17 insertions(+), 1 deletion(-) diff --git a/MAINTAINERS b/MAINTAINERS index 7f3d967..460245b 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -219,7 +219,7 @@ M: Thomas Monjalon F: lib/librte_ether/ F: scripts/test-null.sh -Crypto API +Crypto API - EXPERIMENTAL M: Declan Doherty F: lib/librte_cryptodev/ F: app/test/test_cryptodev* diff --git a/config/common_bsdapp b/config/common_bsdapp index 56020b6..3286481 100644 --- a/config/common_bsdapp +++ b/config/common_bsdapp @@ -310,6 +310,7 @@ CONFIG_RTE_PMD_PACKET_PREFETCH=y # # Compile generic crypto device library +# EXPERIMENTAL: API may change without prior notice # CONFIG_RTE_LIBRTE_CRYPTODEV=y CONFIG_RTE_LIBRTE_CRYPTODEV_DEBUG=n diff --git a/config/common_linuxapp b/config/common_linuxapp index eaad8d6..2866986 100644 --- a/config/common_linuxapp +++ b/config/common_linuxapp @@ -319,6 +319,7 @@ CONFIG_RTE_PMD_PACKET_PREFETCH=y # # Compile generic crypto device library +# EXPERIMENTAL: API may change without prior notice # CONFIG_RTE_LIBRTE_CRYPTODEV=y CONFIG_RTE_LIBRTE_CRYPTODEV_DEBUG=n diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst index 8a739dd..653c7d0 100644 --- a/doc/guides/contributing/versioning.rst +++ b/doc/guides/contributing/versioning.rst @@ -13,6 +13,7 @@ General Guidelines ------------------ #. Whenever possible, ABI should be preserved +#. The libraries marked in experimental state may change without constraint. #. The addition of symbols is generally not problematic #. The modification of symbols can generally be managed with versioning #. The removal of symbols generally is an ABI break and requires bumping of the diff --git a/doc/guides/rel_notes/release_2_2.rst b/doc/guides/rel_notes/release_2_2.rst index 8c77768..d0a9955 100644 --- a/doc/guides/rel_notes/release_2_2.rst +++ b/doc/guides/rel_notes/release_2_2.rst @@ -17,6 +17,16 @@ New Features * **Added keepalive support to EAL and example application.** +* **Added experimental cryptodev API** + + The cryptographic processing of packet is provided as a preview + with two drivers for: + + * Intel QuickAssist devices + * Intel AES-NI multi-buffer library + + Due to its experimental state, the API may change without prior notice. + * **Added ethdev API to support IEEE1588.** Added functions to read, write and adjust system time in the NIC. diff --git a/lib/librte_cryptodev/rte_cryptodev.h b/lib/librte_cryptodev/rte_cryptodev.h index 04bade7..aa9f785 100644 --- a/lib/librte_cryptodev/rte_cryptodev.h +++ b/lib/librte_cryptodev/rte_cryptodev.h @@ -39,6 +39,9 @@ * * Defines RTE Crypto Device APIs for the provisioning of cipher and * authentication operations. + * + * @warning + * @b EXPERIMENTAL: this API may change without prior notice */ #ifdef __cplusplus -- 2.5.2