Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/127577/?format=api
{ "id": 127577, "url": "http://patchwork.dpdk.org/api/patches/127577/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/patch/20230526210214.617-12-anoobj@marvell.com/", "project": { "id": 1, "url": "http://patchwork.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20230526210214.617-12-anoobj@marvell.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20230526210214.617-12-anoobj@marvell.com", "date": "2023-05-26T21:02:03", "name": "[v4,11/22] doc: add PDCP library guide", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "0b12d619041a102c9a021f9a1b6a305a37952db1", "submitter": { "id": 1205, "url": "http://patchwork.dpdk.org/api/people/1205/?format=api", "name": "Anoob Joseph", "email": "anoobj@marvell.com" }, "delegate": { "id": 6690, "url": "http://patchwork.dpdk.org/api/users/6690/?format=api", "username": "akhil", "first_name": "akhil", "last_name": "goyal", "email": "gakhil@marvell.com" }, "mbox": "http://patchwork.dpdk.org/project/dpdk/patch/20230526210214.617-12-anoobj@marvell.com/mbox/", "series": [ { "id": 28214, "url": "http://patchwork.dpdk.org/api/series/28214/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/list/?series=28214", "date": "2023-05-26T21:01:52", "name": "lib: add pdcp protocol", "version": 4, "mbox": "http://patchwork.dpdk.org/series/28214/mbox/" } ], "comments": "http://patchwork.dpdk.org/api/patches/127577/comments/", "check": "success", "checks": "http://patchwork.dpdk.org/api/patches/127577/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "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])\n\tby inbox.dpdk.org (Postfix) with ESMTP id B84F042BAD;\n\tFri, 26 May 2023 23:03:58 +0200 (CEST)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id EDF0942D33;\n\tFri, 26 May 2023 23:03:31 +0200 (CEST)", "from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com\n [67.231.148.174])\n by mails.dpdk.org (Postfix) with ESMTP id 364A04282D\n for <dev@dpdk.org>; Fri, 26 May 2023 23:03:30 +0200 (CEST)", "from pps.filterd (m0045849.ppops.net [127.0.0.1])\n by mx0a-0016f401.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id\n 34QHdjGe018586; Fri, 26 May 2023 14:03:28 -0700", "from dc5-exch02.marvell.com ([199.233.59.182])\n by mx0a-0016f401.pphosted.com (PPS) with ESMTPS id 3qu1c78nfx-1\n (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT);\n Fri, 26 May 2023 14:03:28 -0700", "from DC5-EXCH02.marvell.com (10.69.176.39) by DC5-EXCH02.marvell.com\n (10.69.176.39) with Microsoft SMTP Server (TLS) id 15.0.1497.48;\n Fri, 26 May 2023 14:03:26 -0700", "from maili.marvell.com (10.69.176.80) by DC5-EXCH02.marvell.com\n (10.69.176.39) with Microsoft SMTP Server id 15.0.1497.48 via Frontend\n Transport; Fri, 26 May 2023 14:03:26 -0700", "from BG-LT92004.corp.innovium.com (unknown [10.193.32.169])\n by maili.marvell.com (Postfix) with ESMTP id D66BE3F706D;\n Fri, 26 May 2023 14:03:21 -0700 (PDT)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com;\n h=from : to : cc :\n subject : date : message-id : in-reply-to : references : mime-version :\n content-transfer-encoding : content-type; s=pfpt0220;\n bh=uxDsSpjGOMtsxCHZ5gd2jBvceUgNd2FIEyNKRKqI1i4=;\n b=IhrRBZIOFa4Osx6jvrqBxBB2+YXIRIpVZI7Sk3SM+TOMCYkMvNRWDdPEg12+HetP4nKs\n elHpamTdgTTFcf8ALmvh6c4/yj7WFlMzbzgoCkRHUxb+i+wYGRCzocxgPHqeKVZLx33y\n 4aK6c+iatj6Ux+rncL3Twb84TuhSl5Rl7ug1QErCpQkU7A8tmEk5w+stdd/qZ/PPZ/t5\n 2pFJq5vs9/RcIXwEJog6arbaFXNmHZ3QSf8qeMykY/6ZZgIRY4m8/Dgj47YDDfntaAqE\n q/jvGJ9KxMzS8kajc7sijM2hIvfNaRyJIF7Sfh3+U3QmOzC3RNCiBO1O8Py9D0YbWzjn Rw==", "From": "Anoob Joseph <anoobj@marvell.com>", "To": "Thomas Monjalon <thomas@monjalon.net>, Akhil Goyal <gakhil@marvell.com>,\n Jerin Jacob <jerinj@marvell.com>, Konstantin Ananyev\n <konstantin.v.ananyev@yandex.ru>", "CC": "Hemant Agrawal <hemant.agrawal@nxp.com>,\n =?utf-8?q?Mattias_R=C3=B6nnblom?= <mattias.ronnblom@ericsson.com>,\n \"Kiran Kumar K\" <kirankumark@marvell.com>,\n Volodymyr Fialko <vfialko@marvell.com>, <dev@dpdk.org>,\n Olivier Matz <olivier.matz@6wind.com>,\n Stephen Hemminger <stephen@networkplumber.org>", "Subject": "[PATCH v4 11/22] doc: add PDCP library guide", "Date": "Sat, 27 May 2023 02:32:03 +0530", "Message-ID": "<20230526210214.617-12-anoobj@marvell.com>", "X-Mailer": "git-send-email 2.25.1", "In-Reply-To": "<20230526210214.617-1-anoobj@marvell.com>", "References": "<20230524160116.304-1-anoobj@marvell.com>\n <20230526210214.617-1-anoobj@marvell.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "quoted-printable", "Content-Type": "text/plain", "X-Proofpoint-GUID": "rB9C3VhOLSwEGozuGeh_I9G5jk_MR63I", "X-Proofpoint-ORIG-GUID": "rB9C3VhOLSwEGozuGeh_I9G5jk_MR63I", "X-Proofpoint-Virus-Version": "vendor=baseguard\n engine=ICAP:2.0.254,Aquarius:18.0.957,Hydra:6.0.573,FMLib:17.11.176.26\n definitions=2023-05-26_10,2023-05-25_03,2023-05-22_02", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org" }, "content": "Add guide for PDCP library.\n\nSigned-off-by: Anoob Joseph <anoobj@marvell.com>\nSigned-off-by: Kiran Kumar K <kirankumark@marvell.com>\nSigned-off-by: Volodymyr Fialko <vfialko@marvell.com>\n---\n .../img/pdcp_functional_overview.svg | 1 +\n doc/guides/prog_guide/index.rst | 1 +\n doc/guides/prog_guide/pdcp_lib.rst | 254 ++++++++++++++++++\n 3 files changed, 256 insertions(+)\n create mode 100644 doc/guides/prog_guide/img/pdcp_functional_overview.svg\n create mode 100644 doc/guides/prog_guide/pdcp_lib.rst", "diff": "diff --git a/doc/guides/prog_guide/img/pdcp_functional_overview.svg b/doc/guides/prog_guide/img/pdcp_functional_overview.svg\nnew file mode 100644\nindex 0000000000..287daafc21\n--- /dev/null\n+++ b/doc/guides/prog_guide/img/pdcp_functional_overview.svg\n@@ -0,0 +1 @@\n+<svg width=\"1280\" height=\"720\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" overflow=\"hidden\"><defs><clipPath id=\"clip0\"><rect x=\"0\" y=\"0\" width=\"1280\" height=\"720\"/></clipPath></defs><g clip-path=\"url(#clip0)\"><rect x=\"0\" y=\"0\" width=\"1280\" height=\"720\" fill=\"#FFFFFF\"/><rect x=\"202\" y=\"100\" width=\"369\" height=\"457\" fill=\"#A5A5A5\" fill-opacity=\"0.501961\"/><rect x=\"640\" y=\"100\" width=\"369\" height=\"457\" fill=\"#A5A5A5\" fill-opacity=\"0.501961\"/><path d=\"M605.5 73.5001 605.5 590.633\" stroke=\"#000000\" stroke-width=\"1.33333\" stroke-miterlimit=\"8\" fill=\"none\" fill-rule=\"evenodd\"/><path d=\"M380.5 634 803.25 634 803.25 585.907 790.5 585.907 816 557.5 841.5 585.907 828.75 585.907 828.75 659.5 380.5 659.5Z\" stroke=\"#787878\" stroke-width=\"1.33333\" stroke-miterlimit=\"8\" fill=\"#A5A5A5\" fill-rule=\"evenodd\"/><rect x=\"362.5\" y=\"557.5\" width=\"28\" height=\"102\" stroke=\"#787878\" stroke-width=\"1.33333\" stroke-miterlimit=\"8\" fill=\"#A5A5A5\"/><rect x=\"412.5\" y=\"671.5\" width=\"370\" height=\"32\" stroke=\"#000000\" stroke-linejoin=\"round\" stroke-miterlimit=\"10\" fill=\"none\"/><text font-family=\"Arial,Arial_MSFontService,sans-serif\" font-weight=\"400\" font-size=\"19\" transform=\"translate(492.364 694)\">Radio Interface (<tspan font-size=\"19\" x=\"137.5\" y=\"0\">Uu</tspan><tspan font-size=\"19\" x=\"161.333\" y=\"0\">/PC5)</tspan><tspan font-size=\"19\" x=\"-282.121\" y=\"-653\">UE/NG</tspan><tspan font-size=\"19\" x=\"-222.955\" y=\"-653\">-</tspan><tspan font-size=\"19\" x=\"-216.788\" y=\"-653\">RAN/UE A</tspan><tspan font-size=\"19\" x=\"375.54\" y=\"-653\">NG</tspan>-<tspan font-size=\"19\" x=\"409.706\" y=\"-653\">RAN/UE/UE B</tspan><tspan font-size=\"14\" x=\"0.896851\" y=\"-647\">Transmitting </tspan><tspan font-size=\"14\" x=\"1.31018\" y=\"-631\">PDCP entity</tspan><tspan font-size=\"14\" x=\"167.401\" y=\"-647\">Receiving </tspan><tspan font-size=\"14\" x=\"160.148\" y=\"-631\">PDCP entity</tspan></text><path d=\"M314.5 71.5001 431.364 71.6549\" stroke=\"#000000\" stroke-width=\"0.666667\" stroke-miterlimit=\"8\" fill=\"none\" fill-rule=\"evenodd\"/><path d=\"M331.5 71.5001C331.5 65.9772 349.633 61.5001 372 61.5001 394.368 61.5001 412.5 65.9772 412.5 71.5001 412.5 77.0229 394.368 81.5001 372 81.5001 349.633 81.5001 331.5 77.0229 331.5 71.5001Z\" stroke=\"#000000\" stroke-width=\"1.33333\" stroke-miterlimit=\"8\" fill=\"#FFFFFF\" fill-rule=\"evenodd\"/><path d=\"M353.5 90.5001 363.5 90.5001 363.5 48.5001 383.5 48.5001 383.5 90.5001 393.5 90.5001 373.5 110.5Z\" stroke=\"#000000\" stroke-width=\"1.33333\" stroke-miterlimit=\"8\" fill=\"#FFFFFF\" fill-rule=\"evenodd\"/><path d=\"M877.364 82.6549 760.5 82.5001\" stroke=\"#000000\" stroke-width=\"0.666667\" stroke-miterlimit=\"8\" fill=\"none\" fill-rule=\"evenodd\"/><path d=\"M860.5 83.5001C860.5 89.0229 842.368 93.5001 820 93.5001 797.633 93.5001 779.5 89.0229 779.5 83.5001 779.5 77.9772 797.633 73.5001 820 73.5001 842.368 73.5001 860.5 77.9772 860.5 83.5001Z\" stroke=\"#000000\" stroke-width=\"1.33333\" stroke-miterlimit=\"8\" fill=\"#FFFFFF\" fill-rule=\"evenodd\"/><path d=\"M838.5 64.5 828.5 64.5 828.5 106.5 808.5 106.5 808.5 64.5 798.5 64.5 818.5 44.5001Z\" stroke=\"#000000\" stroke-width=\"1.33333\" stroke-miterlimit=\"8\" fill=\"#FFFFFF\" fill-rule=\"evenodd\"/><rect x=\"244.5\" y=\"128.5\" width=\"285\" height=\"55\" stroke=\"#000000\" stroke-width=\"1.33333\" stroke-miterlimit=\"8\" fill=\"#FFFFFF\"/><text font-family=\"Arial,Arial_MSFontService,sans-serif\" font-weight=\"400\" font-size=\"19\" transform=\"translate(302.494 150)\">Transmission buffer:<tspan font-size=\"19\" x=\"-4.67999\" y=\"23\">Sequence</tspan><tspan font-size=\"19\" x=\"84.32\" y=\"23\">numberin</tspan>g</text><rect x=\"244.5\" y=\"199.5\" width=\"285\" height=\"55\" stroke=\"#000000\" stroke-width=\"1.33333\" stroke-miterlimit=\"8\" fill=\"#FFFFFF\"/><text font-family=\"Arial,Arial_MSFontService,sans-serif\" font-weight=\"400\" font-size=\"19\" transform=\"translate(297.314 222)\">Header or uplink data<tspan font-size=\"19\" x=\"34.08\" y=\"23\">Compressio</tspan>n</text><rect x=\"682.5\" y=\"141.5\" width=\"285\" height=\"55\" stroke=\"#000000\" stroke-width=\"1.33333\" stroke-miterlimit=\"8\" fill=\"#FFFFFF\"/><text font-family=\"Arial,Arial_MSFontService,sans-serif\" font-weight=\"400\" font-size=\"19\" transform=\"translate(735.782 164)\">Header or uplink data<tspan font-size=\"19\" x=\"24.2466\" y=\"23\">Decompressio</tspan>n</text><rect x=\"244.5\" y=\"482.5\" width=\"285\" height=\"33\" stroke=\"#000000\" stroke-width=\"1.33333\" stroke-miterlimit=\"8\" fill=\"#FFFFFF\"/><text font-family=\"Arial,Arial_MSFontService,sans-serif\" font-weight=\"400\" font-size=\"19\" transform=\"translate(300.314 505)\">Routing / Duplication</text><rect x=\"244.5\" y=\"437.5\" width=\"285\" height=\"32\" stroke=\"#000000\" stroke-width=\"1.33333\" stroke-miterlimit=\"8\" fill=\"#FFFFFF\"/><text font-family=\"Arial,Arial_MSFontService,sans-serif\" font-weight=\"400\" font-size=\"19\" transform=\"translate(309.734 460)\">Add PDCP header</text><rect x=\"244.5\" y=\"383.5\" width=\"189\" height=\"33\" stroke=\"#000000\" stroke-width=\"1.33333\" stroke-miterlimit=\"8\" fill=\"#FFFFFF\"/><text font-family=\"Arial,Arial_MSFontService,sans-serif\" font-weight=\"400\" font-size=\"19\" transform=\"translate(298.62 406)\">Ciphering</text><rect x=\"244.5\" y=\"333.5\" width=\"189\" height=\"32\" stroke=\"#000000\" stroke-width=\"1.33333\" stroke-miterlimit=\"8\" fill=\"#FFFFFF\"/><text font-family=\"Arial,Arial_MSFontService,sans-serif\" font-weight=\"400\" font-size=\"19\" transform=\"translate(261.953 356)\">Integrity protection</text><path d=\"M472.167 267.5 472.167 409.802 470.833 409.802 470.833 267.5ZM475.5 408.468 471.5 416.468 467.5 408.468Z\"/><path d=\"M332.167 267.5 332.167 319.552 330.833 319.552 330.833 267.5ZM335.5 318.218 331.5 326.218 327.5 318.219Z\"/><text font-family=\"Arial,Arial_MSFontService,sans-serif\" font-weight=\"400\" font-size=\"19\" transform=\"translate(253.644 291)\">Packets associated <tspan font-size=\"19\" x=\"14.0067\" y=\"23\">to a PDCP SDU</tspan></text><text font-family=\"Arial,Arial_MSFontService,sans-serif\" font-weight=\"400\" font-size=\"19\" transform=\"matrix(6.12323e-17 1 -1 6.12323e-17 499.312 299)\">Packets not <tspan font-size=\"19\" x=\"-14\" y=\"23\">associated to a </tspan><tspan font-size=\"19\" x=\"-2.75546e-15\" y=\"45\">PDCP SDU</tspan></text><rect x=\"682.5\" y=\"482.5\" width=\"285\" height=\"33\" stroke=\"#000000\" stroke-width=\"1.33333\" stroke-miterlimit=\"8\" fill=\"#FFFFFF\"/><text font-family=\"Arial,Arial_MSFontService,sans-serif\" font-weight=\"400\" font-size=\"19\" transform=\"translate(728.535 505)\">Remove PDCP Header</text><rect x=\"682.5\" y=\"437.5\" width=\"203\" height=\"32\" stroke=\"#000000\" stroke-width=\"1.33333\" stroke-miterlimit=\"8\" fill=\"#FFFFFF\"/><text font-family=\"Arial,Arial_MSFontService,sans-serif\" font-weight=\"400\" font-size=\"19\" transform=\"translate(733.729 460)\">Deciphering</text><rect x=\"682.5\" y=\"389.5\" width=\"203\" height=\"33\" stroke=\"#000000\" stroke-width=\"1.33333\" stroke-miterlimit=\"8\" fill=\"#FFFFFF\"/><text font-family=\"Arial,Arial_MSFontService,sans-serif\" font-weight=\"400\" font-size=\"19\" transform=\"translate(702.159 412)\">Integrity Verification</text><rect x=\"682.5\" y=\"303.5\" width=\"203\" height=\"77\" stroke=\"#000000\" stroke-width=\"1.33333\" stroke-miterlimit=\"8\" fill=\"#FFFFFF\"/><text font-family=\"Arial,Arial_MSFontService,sans-serif\" font-weight=\"400\" font-size=\"19\" transform=\"translate(712.729 325)\">Reception buffer:<tspan font-size=\"19\" x=\"24.6667\" y=\"23\">Reordering</tspan><tspan font-size=\"19\" x=\"-13.1667\" y=\"45\">Duplicate discardin</tspan><tspan font-size=\"19\" x=\"144.167\" y=\"45\">g</tspan><tspan font-size=\"19\" x=\"-10.0989\" y=\"-84\">Packets associated </tspan><tspan font-size=\"19\" x=\"3.90784\" y=\"-61\">to a PDCP SDU</tspan></text><text font-family=\"Arial,Arial_MSFontService,sans-serif\" font-weight=\"400\" font-size=\"19\" transform=\"matrix(6.12323e-17 1 -1 6.12323e-17 960.34 294)\">Packets not <tspan font-size=\"19\" x=\"-14\" y=\"23\">associated to a </tspan><tspan font-size=\"19\" x=\"1\" y=\"45\">PDCP SDU</tspan></text><path d=\"M0.666667-8.2074e-07 0.666763 78.6116-0.66657 78.6116-0.666667 8.2074e-07ZM4.00009 77.2782 0.000104987 85.2782-3.9999 77.2782Z\" transform=\"matrix(1 0 0 -1 779.5 296.778)\"/><path d=\"M0.666667-2.88742e-07 0.666769 235.734-0.666565 235.734-0.666667 2.88742e-07ZM4.0001 234.401 0.000104987 242.401-3.9999 234.401Z\" transform=\"matrix(1 0 0 -1 931.5 453.901)\"/></g></svg>\n\\ No newline at end of file\ndiff --git a/doc/guides/prog_guide/index.rst b/doc/guides/prog_guide/index.rst\nindex 87333ee84a..6099ff63cd 100644\n--- a/doc/guides/prog_guide/index.rst\n+++ b/doc/guides/prog_guide/index.rst\n@@ -77,4 +77,5 @@ Programmer's Guide\n lto\n profile_app\n asan\n+ pdcp_lib\n glossary\ndiff --git a/doc/guides/prog_guide/pdcp_lib.rst b/doc/guides/prog_guide/pdcp_lib.rst\nnew file mode 100644\nindex 0000000000..8369c71600\n--- /dev/null\n+++ b/doc/guides/prog_guide/pdcp_lib.rst\n@@ -0,0 +1,254 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+ Copyright(C) 2023 Marvell.\n+\n+PDCP Protocol Processing Library\n+================================\n+\n+DPDK provides a library for PDCP protocol processing. The library utilizes\n+other DPDK libraries such as cryptodev, reorder, etc., to provide the\n+application with a transparent and high performant PDCP protocol processing\n+library.\n+\n+The library abstracts complete PDCP protocol processing conforming to\n+``ETSI TS 138 323 V17.1.0 (2022-08)``.\n+https://www.etsi.org/deliver/etsi_ts/138300_138399/138323/17.01.00_60/ts_138323v170100p.pdf\n+\n+PDCP would involve the following operations,\n+\n+1. Transfer of user plane data\n+2. Transfer of control plane data\n+3. Header compression\n+4. Uplink data compression\n+5. Ciphering and integrity protection\n+\n+.. _figure_pdcp_functional_overview:\n+\n+.. figure:: img/pdcp_functional_overview.*\n+\n+ PDCP functional overview new\n+\n+PDCP library would abstract the protocol offload features of the cryptodev and\n+would provide a uniform interface and consistent API usage to work with\n+cryptodev irrespective of the protocol offload features supported.\n+\n+PDCP entity API\n+---------------\n+\n+PDCP library provides following control path APIs that is used to\n+configure various PDCP entities,\n+\n+1. ``rte_pdcp_entity_establish()``\n+2. ``rte_pdcp_entity_suspend()``\n+3. ``rte_pdcp_entity_release()``\n+\n+A PDCP entity would translate to one ``rte_cryptodev_sym_session`` or\n+``rte_security_session`` based on the config. The sessions would be created/\n+destroyed while corresponding PDCP entity operations are performed.\n+\n+When upper layers request a PDCP entity suspend (``rte_pdcp_entity_suspend()``),\n+it would result in flushing out of all cached packets. Internal state variables\n+are updated as described in 5.1.4.\n+\n+When upper layers request a PDCP entity release (``rte_pdcp_entity_release()``),\n+it would result in flushing out of all cached packets and releasing of all\n+memory associated with the entity. It would internally free any crypto/security\n+sessions created. All procedures mentioned in 5.1.3 would be performed.\n+\n+PDCP PDU (Protocol Data Unit) API\n+---------------------------------\n+\n+PDCP PDUs can be categorized as,\n+\n+1. Control PDU\n+2. Data PDU\n+\n+Control PDUs are used for signalling between entities on either end and can be\n+one of the following,\n+\n+1. PDCP status report\n+2. ROHC feedback\n+3. EHC feedback\n+\n+Control PDUs are not ciphered or authenticated, and so such packets are not\n+submitted to cryptodev for processing.\n+\n+Data PDUs are regular packets submitted by upper layers for transmission to\n+other end. Such packets would need to be ciphered and authenticated based on\n+the entity configuration.\n+\n+PDCP packet processing API for data PDU\n+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n+\n+PDCP processing is split into 2 parts. One before cryptodev processing\n+(``rte_pdcp_pkt_pre_process()``) and one after cryptodev processing\n+(``rte_pdcp_pkt_post_process()``). Since cryptodev dequeue can return crypto\n+operations belonging to multiple entities, ``rte_pdcp_pkt_crypto_group()``\n+is added to help grouping crypto operations belonging to same PDCP entity.\n+\n+Lib PDCP would allow application to use same API sequence while leveraging\n+protocol offload features enabled by ``rte_security`` library. Lib PDCP would\n+internally change the handles registered for ``pre_process`` and\n+``post_process`` based on features enabled in the entity.\n+\n+Lib PDCP would create the required sessions on the device provided in entity to\n+minimize the application requirements. Also, the crypto_op allocation and free\n+would also be done internally by lib PDCP to allow the library to create\n+crypto ops as required for the input packets. For example, when control PDUs are\n+received, no cryptodev enqueue-dequeue is expected for the same and lib PDCP\n+is expected to handle it differently.\n+\n+Supported features\n+------------------\n+\n+- 12 bit & 18 bit sequence numbers\n+- Uplink & downlink traffic\n+- HFN increment\n+- IV generation as required per algorithm\n+\n+Supported ciphering algorithms\n+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n+\n+- NULL\n+- AES-CTR\n+- SNOW3G-CIPHER\n+- ZUC-CIPHER\n+\n+Supported integrity protection algorithms\n+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n+\n+- NULL\n+- AES-CMAC\n+- SNOW3G-AUTH\n+- ZUC-AUTH\n+\n+Sample API usage\n+----------------\n+\n+The ``rte_pdcp_entity_conf`` structure is used to pass the configuration\n+parameters for entity creation.\n+\n+.. literalinclude:: ../../../lib/pdcp/rte_pdcp.h\n+ :language: c\n+ :start-after: Structure rte_pdcp_entity_conf 8<\n+ :end-before: >8 End of structure rte_pdcp_entity_conf.\n+\n+.. code-block:: c\n+\n+\tstruct rte_mbuf **out_mb, *pkts[MAX_BURST_SIZE];\n+\tstruct rte_crypto_op *cop[MAX_BURST_SIZE];\n+\tstruct rte_pdcp_group grp[MAX_BURST_SIZE];\n+\tstruct rte_pdcp_entity *pdcp_entity;\n+\tint nb_max_out_mb, ret, nb_grp;\n+\tuint16_t nb_ops;\n+\n+\t/* Create PDCP entity */\n+\tpdcp_entity = rte_pdcp_entity_establish(&conf);\n+\n+\t/**\n+\t * Allocate buffer for holding mbufs returned during PDCP suspend,\n+\t * release & post-process APIs.\n+\t */\n+\n+\t/* Max packets that can be cached in entity + burst size */\n+\tnb_max_out_mb = pdcp_entity->max_pkt_cache + MAX_BURST_SIZE;\n+\tout_mb = rte_malloc(NULL, nb_max_out_mb * sizeof(uintptr_t), 0);\n+\tif (out_mb == NULL) {\n+\t\t/* Handle error */\n+\t}\n+\n+\twhile (1) {\n+\t\t/* Receive packet and form mbuf */\n+\n+\t\t/**\n+\t\t * Prepare packets for crypto operation. Following operations\n+\t\t * would be done,\n+\t\t *\n+\t\t * Transmitting entity/UL (only data PDUs):\n+\t\t * - Perform compression\n+\t\t * - Assign sequence number\n+\t\t * - Add PDCP header\n+\t\t * - Create & prepare crypto_op\n+\t\t * - Prepare IV for crypto operation (auth_gen, encrypt)\n+\t\t * - Save original PDCP SDU (during PDCP re-establishment,\n+\t\t * unconfirmed PDCP SDUs need to crypto processed again and\n+\t\t * transmitted/re-transmitted)\n+\t\t *\n+\t\t * Receiving entity/DL:\n+\t\t * - Any control PDUs received would be processed and\n+\t\t * appropriate actions taken. If data PDU, continue.\n+\t\t * - Determine sequence number (based on HFN & per packet SN)\n+\t\t * - Prepare crypto_op\n+\t\t * - Prepare IV for crypto operation (decrypt, auth_verify)\n+\t\t */\n+\t\tnb_success = rte_pdcp_pkt_pre_process(pdcp_entity, pkts, cop,\n+\t\t\t\t\t\t nb_rx, &nb_err);\n+\t\tif (nb_err != 0) {\n+\t\t\t/* Handle error packets */\n+\t\t}\n+\n+\t\tif ((rte_cryptodev_enqueue_burst(dev_id, qp_id, cop, nb_success)\n+\t\t\t\t!= nb_success) {\n+\t\t\t/* Retry for enqueue failure packets */\n+\t\t}\n+\n+\t\t...\n+\n+\t\tnb_ops = rte_cryptodev_dequeue_burst(dev_id, qp_id, cop,\n+\t\t\t\t\t\t MAX_BURST_SIZE);\n+\t\tif (nb_ops == 0)\n+\t\t\tcontinue;\n+\n+\t\t/**\n+\t\t * Received a burst of completed crypto ops from cryptodev. It\n+\t\t * may belong to various entities. Group similar ones together\n+\t\t * for entity specific post-processing.\n+\t\t */\n+\n+\t\t/**\n+\t\t * Groups similar entities together. Frees crypto op and based\n+\t\t * on crypto_op status, set mbuf->ol_flags which would be\n+\t\t * checked in rte_pdcp_pkt_post_process().\n+\t\t */\n+\t\tnb_grp = rte_pdcp_pkt_crypto_group(cop, pkts, grp, ret);\n+\n+\t\tfor (i = 0; i != nb_grp; i++) {\n+\n+\t\t\t/**\n+\t\t\t * Post process packets after crypto completion.\n+\t\t\t * Following operations would be done,\n+\t\t\t *\n+\t\t\t * Transmitting entity/UL:\n+\t\t\t * - Check crypto result\n+\t\t\t *\n+\t\t\t * Receiving entity/DL:\n+\t\t\t * - Check crypto operation status\n+\t\t\t * - Check for duplication (if yes, drop duplicate)\n+\t\t\t * - Perform decompression\n+\t\t\t * - Trim PDCP header\n+\t\t\t * - Hold packet (SDU) for in-order delivery (return\n+\t\t\t * completed packets as and when sequence is\n+\t\t\t * completed)\n+\t\t\t * - If not in sequence, cache the packet and start\n+\t\t\t * t-Reordering timer. When timer expires, the\n+\t\t\t * packets need to delivered to upper layers (not\n+\t\t\t * treated as error packets).\n+\t\t\t */\n+\t\t\tnb_success = rte_pdcp_pkt_post_process(grp[i].id.ptr,\n+\t\t\t\t\t\t\t grp[i].m, out_mb,\n+\t\t\t\t\t\t\t grp[i].cnt,\n+\t\t\t\t\t\t\t &nb_err);\n+\t\t\tif (nb_err != 0) {\n+\t\t\t\t/* Handle error packets */\n+\t\t\t}\n+\n+\t\t\t/* Perform additional operations */\n+\n+\t\t\t/**\n+\t\t\t * Transmitting entity/UL\n+\t\t\t * - If duplication is enabled, duplicate PDCP PDUs\n+\t\t\t * - When lower layers confirm reception of a PDCP PDU,\n+\t\t\t * it should be communicated to PDCP layer so that\n+\t\t\t * PDCP can drop the corresponding SDU\n+\t\t\t */\n+\t\t}\n+\t}\n", "prefixes": [ "v4", "11/22" ] }