From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 751DFA04DD; Mon, 26 Oct 2020 20:08:49 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id DF87D1E2B; Mon, 26 Oct 2020 20:08:46 +0100 (CET) Received: from EUR03-AM5-obe.outbound.protection.outlook.com (mail-eopbgr30063.outbound.protection.outlook.com [40.107.3.63]) by dpdk.org (Postfix) with ESMTP id 748391D9E for ; Mon, 26 Oct 2020 20:08:45 +0100 (CET) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=C+ifR9s4ANKVmv5CAi9ufjZnxasm2YbyPjJRkCBhEzNm2kO9zwcmNblcWaH1bpsUSvxpEB4It89h0hBtlvA4Jbc+k+jQz4DwPYNBmXNTZnrvQ85U9Lw1sE4Vx9lBcMssZdBQn3+Yi0KJUhKP2AKmAcd6JamgO1byp3UptKcSOYHblMibpLJE1hTfdfjfPd+j8Bz4OCMcL40lICC7mSe/+ramWw+Rk48GFfaNXY6RGTBfHGrntdbQ/HqNa9F0mcedOziy5HYq7Z7Sy9cQuvxEW63+R/fiNqJhX+h/66ESTOwNbUGi/xqdnCDmTEQM0YNELEOoey9PsmMx2+55hDRI2w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=657hWAASMFQfvZ7c34jsOJEKtbrwnk+88xbP7eND91g=; b=K75AvylukaRVQQZo94LYyS6wK16K9MadGvicDA8x+MKNCXrkBtEBFfUc3Fpy76xVtv0sbQe8AiSNXNnKB7BIWfeJjUSISDyvrDHjhoC0r2c0YKg0hbA1MAddW2eUuv6ZQbk/9iDdOWwFEDfcGNHLba4u62fznaA/V1p8Xt9bkqkEPDmb1k+NbYFGUP+sf4rnw5Ja5ujxCWF1HfmCi6vY+WhApylpkfDGPuIqYnwg2Zyta9f75YE8Ig5WsuzwfTYHk75Ts7ByDW4JJrDMFIzuQ3jINmjV3UyEy1kZ2ohPeppsI99WDjunk/3vLszsb4mvWuRgVI4qtbXcuPiYyJy8XQ== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=nxp.com; dmarc=pass action=none header.from=nxp.com; dkim=pass header.d=nxp.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=nxp.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=657hWAASMFQfvZ7c34jsOJEKtbrwnk+88xbP7eND91g=; b=sq1ml2hBfybOF1iDefe7NJ5nSvk8YxPokX4I68nePksTF5lfX5UU69rQX94TLYrF8Ltpq1lyK/n4drfgafnMHSKIoMiSJxtk3C9+oEzRzIPcOP6igXtyCEiIt+jwi/v2JrbXlDbwhfuzZ4ysRptIDpHNwEi1IMRxiIQBjQ73eac= Received: from VI1PR04MB3168.eurprd04.prod.outlook.com (2603:10a6:802:6::10) by VI1PR0402MB3693.eurprd04.prod.outlook.com (2603:10a6:803:18::21) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3477.20; Mon, 26 Oct 2020 19:08:42 +0000 Received: from VI1PR04MB3168.eurprd04.prod.outlook.com ([fe80::9513:3b55:931f:216e]) by VI1PR04MB3168.eurprd04.prod.outlook.com ([fe80::9513:3b55:931f:216e%4]) with mapi id 15.20.3499.018; Mon, 26 Oct 2020 19:08:42 +0000 From: Akhil Goyal To: Abhinandan Gujjar , "dev@dpdk.org" , "declan.doherty@intel.com" , "Honnappa.Nagarahalli@arm.com" , "konstantin.ananyev@intel.com" CC: "narender.vangati@intel.com" , "jerinj@marvell.com" Thread-Topic: [v4 3/3] doc: add enqueue callback APIs Thread-Index: AQHWq8keE/LE9K1L50OvJ630p1LHsqmqOzzA Date: Mon, 26 Oct 2020 19:08:42 +0000 Message-ID: References: <1603619090-118652-1-git-send-email-abhinandan.gujjar@intel.com> <1603619090-118652-4-git-send-email-abhinandan.gujjar@intel.com> In-Reply-To: <1603619090-118652-4-git-send-email-abhinandan.gujjar@intel.com> Accept-Language: en-IN, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: authentication-results: intel.com; dkim=none (message not signed) header.d=none;intel.com; dmarc=none action=none header.from=nxp.com; x-originating-ip: [122.162.226.234] x-ms-publictraffictype: Email x-ms-office365-filtering-ht: Tenant x-ms-office365-filtering-correlation-id: 39c7f814-d8cf-4a92-f5a8-08d879e28e0c x-ms-traffictypediagnostic: VI1PR0402MB3693: x-microsoft-antispam-prvs: x-ms-oob-tlc-oobclassifiers: OLM:8273; x-ms-exchange-senderadcheck: 1 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: kYd6uRuW+sXa4bfU5OwB5hMcxxWbWR4abiIt0ewZSQ1KIq25MiJKxI8vR58kaQ3B27w9aY2Mc7JEeVceg/5Wq4l2iu//rd0fVk4Elb0sMpX/eKJfe/bG1+2kxvc45EXyt6UDI/65eHnuquEcKLd6Yk0sRw1cG8z2I/nu4AQ5CFz72FOuElOTJmCX01+phblAK+/E8HNEZg9RGvuZe3+tvxlrktetKRwgpS5RMlGGmaJlSSGvWmySU2xnyHLTOClVYBflhvnSatYP0rzNwvtITTZBOEJzOoUuysjz+PHl4ehz0CA0Vf/qqqECV/GHid5rqxp8oJFa4wQ3DhLl9ks1JQ== x-forefront-antispam-report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:VI1PR04MB3168.eurprd04.prod.outlook.com; PTR:; CAT:NONE; SFS:(4636009)(396003)(39860400002)(136003)(366004)(346002)(376002)(76116006)(26005)(5660300002)(55016002)(6506007)(83380400001)(66446008)(52536014)(44832011)(7696005)(66476007)(66946007)(66556008)(64756008)(86362001)(478600001)(8936002)(71200400001)(4326008)(186003)(2906002)(33656002)(8676002)(9686003)(110136005)(54906003)(316002); DIR:OUT; SFP:1101; x-ms-exchange-antispam-messagedata: d+Qh1yW5SC5Gf/SGbSNxQXYnfEsVzhMW3pYyREeBbV/9qZW+/IDfwlRLLXZLLfrGbFZb6r/qqQkurSrZ+WydO9XWpUbe64Ct5c9YgpbqFHAu6sC7jSAiE589R+4KHzqohnquqmbj+Y8seBlOHmGNeouqLekfzzEOcXD6Rp95GM0/Zx32ZXgxbqk64sEE7t72Q6ScEX2WM9MyFg3/9nXDRaCrww/ljMDjYd+xVx8ENAsbSuyv4lcjvDToqNtZ6pc81B+vAFlGmcae2eOw1XLAIUTuoHkPzpHJm930os0+zqfXwv1UeVPFbfpjC8cSe2e5QFnCf/95W9IgD2If+uY0S/DKcwpHYudNKqBngVyEjaCT+f1Lzv1Yd8yhhVR6uAYrKfa1RjrAtu8MFv4xMVYHzTghD0quuOyE58tDrTeAGlrKbdbaf5P8DAhEmtrJ0fh8ZIyaZU1pEZTqCz/7C+ZHqlAFsSzzCzLtysEEp0SCtLwhB9SVjd7r8igRC8DitfBbBiMYJJ+xz6OodVpk2MFMDjr+9b+Iob8mOidK4BbkrXFdmf698+pkBLTgazPqOalJHT/lw0imbPXUnPTCAH0iRPef7D2tpeAvxTjanZPj400fs8JgKT6crhc70Eyr48y+m8knbZd5NgG1hMtBHyuggQ== x-ms-exchange-transport-forked: True Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-OriginatorOrg: nxp.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: VI1PR04MB3168.eurprd04.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: 39c7f814-d8cf-4a92-f5a8-08d879e28e0c X-MS-Exchange-CrossTenant-originalarrivaltime: 26 Oct 2020 19:08:42.4849 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635 X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: uHXz5SfFi8XyrvL6dTidU6jm/5+9PIdyq69DzUBdTO8RF7JVp4BB+CWAjnfHDERVLNDWCF6mHRdQSeJxQay5Tw== X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR0402MB3693 Subject: Re: [dpdk-dev] [v4 3/3] doc: add enqueue callback APIs 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" > Subject: [v4 3/3] doc: add enqueue callback APIs >=20 > Add enqueue callback support for cryptodev library >=20 No need for separate documentation patch. It should be part of patch which = is adding The functionality. > Signed-off-by: Abhinandan Gujjar > --- > doc/guides/prog_guide/cryptodev_lib.rst | 22 ++++++++++++++++++++++ > doc/guides/rel_notes/release_20_11.rst | 5 +++++ > 2 files changed, 27 insertions(+) >=20 > diff --git a/doc/guides/prog_guide/cryptodev_lib.rst > b/doc/guides/prog_guide/cryptodev_lib.rst > index 72129e4..bb3de61 100644 > --- a/doc/guides/prog_guide/cryptodev_lib.rst > +++ b/doc/guides/prog_guide/cryptodev_lib.rst > @@ -366,6 +366,28 @@ can never be larger than ``nb_ops``. > uint16_t rte_cryptodev_dequeue_burst(uint8_t dev_id, uint16_t qp_id, > struct rte_crypto_op **ops, uint= 16_t nb_ops) >=20 > +User callback APIs > +~~~~~~~~~~~~~~~~~~ > +The add API configures a callback function to be called for each burst o= f crypto > +ops received on a given crypto device queue pair. The return value is a = pointer > +that can be used later to remove the callback using > rte_cryptodev_remove_enq_callback(). Does that mean callback cannot be called for each packet and it will be cal= led for Each burst only? The usage of these APIs is not clear with this documentation. Probably you = can add More text/ pseudo code about the sequence of APIs to be used. > +Multiple callback functions can be added for a given queue pair. Can we add callbacks at runtime or is it before the first enqueue only? > + > +.. code-block:: c > + > + struct rte_cryptodev_cb * > + rte_cryptodev_add_enq_callback(uint8_t dev_id, > + uint16_t qp_id, > + rte_cryptodev_callback_fn cb_fn, > + void *cb_arg); > + > +The remove API removes a callback function added by > rte_cryptodev_add_enq_callback(). > + > +.. code-block:: c > + > + int rte_cryptodev_remove_enq_callback(uint8_t dev_id, > + uint16_t qp_id, > + struct rte_cryptodev_cb *cb); >=20 > Operation Representation > ~~~~~~~~~~~~~~~~~~~~~~~~ > diff --git a/doc/guides/rel_notes/release_20_11.rst > b/doc/guides/rel_notes/release_20_11.rst > index 48717ee..7e2fd30 100644 > --- a/doc/guides/rel_notes/release_20_11.rst > +++ b/doc/guides/rel_notes/release_20_11.rst > @@ -285,6 +285,11 @@ New Features > * Added scatter gather support. > * Added NIST GCMVS complaint GMAC test method support. >=20 > +* **Added enqueue callback APIs for cryptodev library.** > + > + Cryptodev is added with enqueue callback APIs to enable applications > + to add/remove user callbacks which gets called for every enqueue > + operations. Please follow the sequence mentioned. It should be after the other new feat= ures Of cryptodev. >=20 > Removed Items > ------------- > -- > 1.9.1