From patchwork Mon May 22 11:56:35 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Anoob Joseph X-Patchwork-Id: 127159 X-Patchwork-Delegate: gakhil@marvell.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id D7D9742B6F; Mon, 22 May 2023 13:56:39 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id AF5B640EE7; Mon, 22 May 2023 13:56:39 +0200 (CEST) Received: from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com [67.231.148.174]) by mails.dpdk.org (Postfix) with ESMTP id 9E44440EE5 for ; Mon, 22 May 2023 13:56:38 +0200 (CEST) Received: from pps.filterd (m0045849.ppops.net [127.0.0.1]) by mx0a-0016f401.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 34MBOETw023192; Mon, 22 May 2023 04:56:37 -0700 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com; h=from : to : cc : subject : date : message-id : mime-version : content-transfer-encoding : content-type; s=pfpt0220; bh=yZ2a2wO06aYzSPs+7IioL62/Ter94lOoGOW7s9d+dUQ=; b=chWfeiH87/rb2E76/ev1mMB44zYJvCIMenD8Lf5XKvrPpZDw+7woBrrW9enqfqbjNkH5 TBQo09zDAl3ZkCAdP9qIMxTj1CPEIb65zLLUpd43xnoZRPFlHxvxACYmS2QeQIJOAb6E DMgMiXarLND88anFFawY7PGrsljvFFq7E9SCYOVU89BQeg6JGhmt7rYgJaSkiPifs3bV gnSpkiQ04fSBise8nl/3/gkaCkV+FBe8PBoFxfvTTRIskhh3PNcutzPVNJNn9T2XNbcd QnWzGUmkxHXNi06gRdnGcJX4ANM84Q9TjbQ9N5pHJK2ARzzmY7xYzuOpXYlv7qliFIBw EA== Received: from dc5-exch01.marvell.com ([199.233.59.181]) by mx0a-0016f401.pphosted.com (PPS) with ESMTPS id 3qpujnea4v-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); Mon, 22 May 2023 04:56:37 -0700 Received: from DC5-EXCH02.marvell.com (10.69.176.39) by DC5-EXCH01.marvell.com (10.69.176.38) with Microsoft SMTP Server (TLS) id 15.0.1497.48; Mon, 22 May 2023 04:56:36 -0700 Received: from maili.marvell.com (10.69.176.80) by DC5-EXCH02.marvell.com (10.69.176.39) with Microsoft SMTP Server id 15.0.1497.48 via Frontend Transport; Mon, 22 May 2023 04:56:36 -0700 Received: from BG-LT92004.corp.innovium.com (unknown [10.28.161.183]) by maili.marvell.com (Postfix) with ESMTP id F0C4F3F708A; Mon, 22 May 2023 04:56:32 -0700 (PDT) From: Anoob Joseph To: Ciara Power , Akhil Goyal , "Fan Zhang" CC: Gagandeep Singh , Hemant Agrawal , Jerin Jacob , Tejasree Kondoj , Vidya Sagar Velumuri , Subject: [PATCH 1/2] cryptodev: update raw datapath API documentation Date: Mon, 22 May 2023 17:26:35 +0530 Message-ID: <20230522115636.309-1-anoobj@marvell.com> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 X-Proofpoint-ORIG-GUID: 8_pCRwTFvahtwdgXn0yT1nQ99dZj50xA X-Proofpoint-GUID: 8_pCRwTFvahtwdgXn0yT1nQ99dZj50xA X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.254,Aquarius:18.0.957,Hydra:6.0.573,FMLib:17.11.170.22 definitions=2023-05-22_07,2023-05-22_03,2023-02-09_01 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Clarify the error codes returned by rte_cryptodev_raw_dp_ctx. Cryptodev can return -ENOTSUP to indicate any unsupported features with raw APIs. Remove redundant references about 'rte_cryptodev_raw_attach_session()'. The API is not part of the specification. Signed-off-by: Anoob Joseph Signed-off-by: Vidya Sagar Velumuri Acked-by: Akhil Goyal --- lib/cryptodev/rte_cryptodev.h | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/lib/cryptodev/rte_cryptodev.h b/lib/cryptodev/rte_cryptodev.h index 3a9ad13660..fcc366805f 100644 --- a/lib/cryptodev/rte_cryptodev.h +++ b/lib/cryptodev/rte_cryptodev.h @@ -1519,18 +1519,13 @@ struct rte_crypto_raw_dp_ctx { /** * Configure raw data-path context data. * - * NOTE: - * After the context data is configured, the user should call - * rte_cryptodev_raw_attach_session() before using it in - * rte_cryptodev_raw_enqueue/dequeue function call. - * * @param dev_id The device identifier. * @param qp_id The index of the queue pair from which to * retrieve processed packets. The value must be * in the range [0, nb_queue_pair - 1] previously * supplied to rte_cryptodev_configure(). * @param ctx The raw data-path context data. - * @param sess_type session type. + * @param sess_type Session type. * @param session_ctx Session context data. * @param is_update Set 0 if it is to initialize the ctx. * Set 1 if ctx is initialized and only to update @@ -1538,6 +1533,9 @@ struct rte_crypto_raw_dp_ctx { * @return * - On success return 0. * - On failure return negative integer. + * - -EINVAL if input parameters are invalid. + * - -ENOTSUP if crypto device does not support raw DP operations with the + * provided session. */ __rte_experimental int