get:
Show a patch.

patch:
Update a patch.

put:
Update a patch.

GET /api/patches/46344/?format=api
HTTP 200 OK
Allow: GET, PUT, PATCH, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 46344,
    "url": "http://patches.dpdk.org/api/patches/46344/?format=api",
    "web_url": "http://patches.dpdk.org/project/dpdk/patch/1539076076-19786-24-git-send-email-anoob.joseph@caviumnetworks.com/",
    "project": {
        "id": 1,
        "url": "http://patches.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": "<1539076076-19786-24-git-send-email-anoob.joseph@caviumnetworks.com>",
    "list_archive_url": "https://inbox.dpdk.org/dev/1539076076-19786-24-git-send-email-anoob.joseph@caviumnetworks.com",
    "date": "2018-10-09T09:07:56",
    "name": "[v4,23/23] doc: add documentation for OCTEON TX crypto",
    "commit_ref": null,
    "pull_url": null,
    "state": "accepted",
    "archived": true,
    "hash": "7653848fe1d5f6fe443e8813c2827875cec9d1bb",
    "submitter": {
        "id": 893,
        "url": "http://patches.dpdk.org/api/people/893/?format=api",
        "name": "Anoob Joseph",
        "email": "anoob.joseph@caviumnetworks.com"
    },
    "delegate": {
        "id": 6690,
        "url": "http://patches.dpdk.org/api/users/6690/?format=api",
        "username": "akhil",
        "first_name": "akhil",
        "last_name": "goyal",
        "email": "gakhil@marvell.com"
    },
    "mbox": "http://patches.dpdk.org/project/dpdk/patch/1539076076-19786-24-git-send-email-anoob.joseph@caviumnetworks.com/mbox/",
    "series": [
        {
            "id": 1770,
            "url": "http://patches.dpdk.org/api/series/1770/?format=api",
            "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=1770",
            "date": "2018-10-09T09:07:33",
            "name": "Adding Cavium's OCTEON TX crypto PMD",
            "version": 4,
            "mbox": "http://patches.dpdk.org/series/1770/mbox/"
        }
    ],
    "comments": "http://patches.dpdk.org/api/patches/46344/comments/",
    "check": "fail",
    "checks": "http://patches.dpdk.org/api/patches/46344/checks/",
    "tags": {},
    "related": [],
    "headers": {
        "Return-Path": "<dev-bounces@dpdk.org>",
        "X-Original-To": "patchwork@dpdk.org",
        "Delivered-To": "patchwork@dpdk.org",
        "Received": [
            "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id A18521B436;\n\tTue,  9 Oct 2018 11:10:25 +0200 (CEST)",
            "from NAM03-DM3-obe.outbound.protection.outlook.com\n\t(mail-dm3nam03on0044.outbound.protection.outlook.com [104.47.41.44])\n\tby dpdk.org (Postfix) with ESMTP id 3FD0D1B20D\n\tfor <dev@dpdk.org>; Tue,  9 Oct 2018 11:10:16 +0200 (CEST)",
            "from ajoseph83.caveonetworks.com.com (115.113.156.2) by\n\tBN7PR07MB4897.namprd07.prod.outlook.com (2603:10b6:406:ef::26) with\n\tMicrosoft SMTP Server (version=TLS1_2,\n\tcipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id\n\t15.20.1207.28; Tue, 9 Oct 2018 09:10:10 +0000"
        ],
        "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=CAVIUMNETWORKS.onmicrosoft.com; s=selector1-cavium-com;\n\th=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck;\n\tbh=0etmCcKFL5P5HCv+nvYEUoCnXlWWn+MWcor95mKVNWY=;\n\tb=Sh8fT+P2qahwt8ywdfz0tdJyV1uuNiynlroBJezA0ivVQM/LkD50F+gy/SW4Yc7O6tG9YsEcKBBTYMMMF1CnK/Jjr0eCiJdgOCMk7kiUgIntLuV76IZj6v51RnUjs1Vl5p0cZh2tuyDkBIXdiFl7T/cy7nrN3xmQ9588+LY9+sY=",
        "Authentication-Results": "spf=none (sender IP is )\n\tsmtp.mailfrom=Anoob.Joseph@cavium.com; ",
        "From": "Anoob Joseph <anoob.joseph@caviumnetworks.com>",
        "To": "Akhil Goyal <akhil.goyal@nxp.com>,\n\tPablo de Lara <pablo.de.lara.guarch@intel.com>,\n\tThomas Monjalon <thomas@monjalon.net>",
        "Cc": "Anoob Joseph <anoob.joseph@caviumnetworks.com>,\n\tJerin Jacob <jerin.jacob@caviumnetworks.com>,\n\tNarayana Prasad <narayanaprasad.athreya@caviumnetworks.com>,\n\tAnkur Dwivedi <ankur.dwivedi@caviumnetworks.com>,\n\tMurthy NSSR <nidadavolu.murthy@caviumnetworks.com>,\n\tNithin Dabilpuram <nithin.dabilpuram@caviumnetworks.com>,\n\tRagothaman Jayaraman <rjayaraman@caviumnetworks.com>,\n\tSrisivasubramanian S <ssrinivasan@caviumnetworks.com>,\n\tTejasree Kondoj <kondoj.tejasree@caviumnetworks.com>, dev@dpdk.org",
        "Date": "Tue,  9 Oct 2018 14:37:56 +0530",
        "Message-Id": "<1539076076-19786-24-git-send-email-anoob.joseph@caviumnetworks.com>",
        "X-Mailer": "git-send-email 2.7.4",
        "In-Reply-To": "<1539076076-19786-1-git-send-email-anoob.joseph@caviumnetworks.com>",
        "References": "<1538744363-30340-1-git-send-email-anoob.joseph@caviumnetworks.com>\n\t<1539076076-19786-1-git-send-email-anoob.joseph@caviumnetworks.com>",
        "MIME-Version": "1.0",
        "Content-Type": "text/plain; charset=UTF-8",
        "Content-Transfer-Encoding": "8bit",
        "X-Originating-IP": "[115.113.156.2]",
        "X-ClientProxiedBy": "PN1PR0101CA0004.INDPRD01.PROD.OUTLOOK.COM\n\t(2603:1096:c00:e::14) To BN7PR07MB4897.namprd07.prod.outlook.com\n\t(2603:10b6:406:ef::26)",
        "X-MS-PublicTrafficType": "Email",
        "X-MS-Office365-Filtering-Correlation-Id": "488e3800-2f94-402f-f3b7-08d62dc705af",
        "X-Microsoft-Antispam": "BCL:0; PCL:0;\n\tRULEID:(7020095)(4652040)(8989299)(4534185)(7168020)(4627221)(201703031133081)(201702281549075)(8990200)(5600074)(711020)(2017052603328)(7153060)(7193020);\n\tSRVR:BN7PR07MB4897; ",
        "X-Microsoft-Exchange-Diagnostics": [
            "1; BN7PR07MB4897;\n\t3:Br4OdPhopkqt0n/+lwEEzZfhOYLcNGyHowp6NgZjMCe9wt+X0DiVllIT/9QgaQ3zc2GlhhCCl6z1fQ0z77f2/ykKpLRv3VRbSsCSlG/Y3QoSM51IwDErdy2F457d9Rx/bhybS82Y8oo/cWQRO9enFzSaiT9YqdLxUN6Osr6qsokRIII3ueNLAqixL+cE5B7xwQkzyi3AIAGDFneh6cRkYjP0A3gPeGmJznsjHDAX7Gen9v3Ty8IHqOnhxAyM6zyK;\n\t25:3OzhObX0Gqk46nqlGMaAUYiHlS67dk1s1iRaGXRK42PJ00ov5XSt71bkabpIFRgH+95YL+TP5jTI3hh4FoQRvsP5ZEKIQI7/0n/rh9TTnW+c1m6vUUk+N2fF1s+B86B2I7A3yKvinNg3cjEgYGVIX2V4LjYHyhrGoepzDrV4EXR/b/UCxCLVB+NszYnXqP54QghJbqY+V8hN/qZIvbVivy5DG8Oz4fYUrk1JAxNmyVX54PAxHM5Qa19g/8JcqO7euLJoOKvuLR6OXe0n6SLHlyaG6tdaBvbO6S8mXRAez6/bosR00oz2jI6A+mF7dcX4+o3xgAlJCBbuJ/QAuv9jIQ==;\n\t31:L32vQdfROc4e0kkYhOZt+8QR0IaeNqVaGCsNkCuZrOR4z3stPGmzqyyWJ/2ZnPNithvEMszsjncUXAuM+z6MiBbWS7k/6Wt3OjMu42kDhikI7DCLbRb1E4nLSYin9Dr7wiPOItXsQfILC+2x3Odw3kc7OHtCLvq1jJsjLGcXSenpZTm9DWtC8xh6yLiteBwsBRLORfdar2Vo0bqRrtCCTPeSIRf0GKKzhwOP7AnKH+Q=",
            "1; BN7PR07MB4897;\n\t20:s87G6rEmB+nzLyRUvoRY1hSwrNmcpQ1l9Wmoc6ywpcHXKPFZzvC45AfT8okkaovZe+4bH9XVq+eMchT7tVbBtBxFAWflOzJphsdaibk8dkdDZ0cTjquC9Fc5dZkRNC0q03BWJulRalr8Mne3arZbG4rdjKjkSM/3kTZ0Ol9iuWq3KMBFJWNrUi/R+CYlZHbYbp3hj4I4VASkgFCsTKYdWAP1K6XTU6/DYNHeRUU+lm7gX9GM/cjbvd2mnJkE3Nx1bqXdW/nIZOmAUwvHiYNXGD94DdDjrTwcSZpLrw5s7+gJ4yzp4wqf7ftuI6NqScs/chPXuIzbxJ2g54sGS/ehsPUq5ZFACiuTpslQjvu05OTBYSdozbtIHJwVuJaRz15BZbXJulcafyQUeizDpSg0pUDsTTDO6eXC7uCoyckR08SVTRZVoBInueSAdEhaSjYtRuTUrwwhE6UxHlUSCyxGCeI+qf3LGsjpPkDBAkdIApgw0WtHXc0su9jotzyZPPfiZRR7qYLHPa+EIgTC4xZVCwzfR7ldxJhvrqoDpMbguM4X3wsyC3LVTpbu/ceTvDSQaJ6QBltU9Y7AFguhvhzhckk8GnXooSDh++oczBt8MiU=",
            "1; BN7PR07MB4897;\n\t4:HXUJoy18DmGhWhPJXdj/UvSfnfoUBJDC3wONh87YdvTHGPia7Mt7msoiXlbOAzaQuz4m5k9cy5wn8CCIi63FEECtZhr4eSLQBP6UOK6XYEZcLBTNGwusVrUCUh0/WlTq/kvkp55NPPyiiI6M5MEYk7ZNPE26BfZT51pS5okWZSTdyD2NJXGLGMXnCIl3sZ8lAF3cugv6+A6ZnfOTxE3whsg0nEkVpLI1BGJNF6dSIKeLZywCBRcRefeZrAnt0yvd8jdIdUYvu/ybYDNn/M+mwl28lK7IVGNgkbO9sa3ueMKss8xK92KhKJjsIarAW2gaKvN+OvvKhRfJ20y37cqHXq2UA846Vk/gX7g55I8azvA=",
            "=?utf-8?q?1=3BBN7PR07MB4897=3B23=3AlaQC?=\n\t=?utf-8?q?iXFEPMU6pzYg51WC9I97JsoHC1FhNgApae8RDsPhAQxSlJBI+Ga1/ZE7?=\n\t=?utf-8?q?f26fDM+JTMA4iHozR2g+r3cJc1agTtw2ghX2SC2SqTncLMz8f4gn2M7R?=\n\t=?utf-8?q?4GtYZ42ezm79Rr+dLitxNCINE4oV1nmtAWe4DiwPjuHxwXOyPe/9XtM+?=\n\t=?utf-8?q?YusIB+Yaa8wQDRfXDV/WOLcv2cRPzyxQaXQqmA3mIm8f3TvAC+NMnfiR?=\n\t=?utf-8?q?ly4DoeDjNr3XLIWROEe38mDV4PGt0xxkjjdNUF0hhBetc5VUdV9tYUKI?=\n\t=?utf-8?q?Mv7origIA29B1qIuJp4voAPz/pF6WbEACfTU6wllzw7UP00FsKODwj1n?=\n\t=?utf-8?q?4kEDkm86Z5ElrQoZhSFq/0xAKZ7J8r/iRR9RxGIaXQOD0IcwYHObL405?=\n\t=?utf-8?q?J9d9PZ/QzRV4og5hcDr5AsUEI103XfpeFdUw1hh8Z2lqzJqbA1OIfTgx?=\n\t=?utf-8?q?2qruxCcy0fes30sZIBfEy9FvIQeUt7GAcqzxnjnx2XYHZ8/krq2E/zQM?=\n\t=?utf-8?q?wjqYxGs06mhru7zu0hemH/jdRhT0Y9vWG79Sv94cDqdNRq7pLbPwvO8H?=\n\t=?utf-8?q?F/Z/XfTyFsoyN5YBsf2flS/n2/S4lHSledd50vzohyuvIfzpOwmst3i8?=\n\t=?utf-8?q?eJMGj5VPdAwiS5r2MvMi3AQCL/oE1IvTiEf9Wdxx4k9VJYUsDoNYi5I4?=\n\t=?utf-8?q?d0MzKIJDw8ai5JEnxxrfPq6SZ1WnwWs9gA7Gj0rc9K5XKTR0DIvDsVZK?=\n\t=?utf-8?q?5Z+SkEmsanW09MRfPTepCa58uAn0lfcY/sg6TQDXVlHM2/hnyzPDhjHj?=\n\t=?utf-8?q?/OSe/ZWz8Dvwn63vdPOgZOQiaRobk9Fx7poGvcVkojP0kL5Tpsedgk2W?=\n\t=?utf-8?q?JuATIIrQWN+6LCipc3kyQU0v5SvXXA80TVNjKwPJBI+5oTJ7Lo/gEo7k?=\n\t=?utf-8?q?iBwQgtvNkG3cKoG1GOPn3MUFGTDqeU+WZ4x2PjhwFGHsZ8Mi+YWJVO0/?=\n\t=?utf-8?q?/19aIBp75t8DxTwfiO1dxYgiEb8g4GEWJLlrdMmf7VPnnVjiGera+yf9?=\n\t=?utf-8?q?hSTxTmf8JBXGgHae0IN3v5XzvK4xBknCJ7+m+9v7L79n5h9+BYUfVYJt?=\n\t=?utf-8?q?3lrdVPmMb3KTEKe7n5GbthiKh/1V8RzoFvF+8+daG8dYALjpe9L+TYJe?=\n\t=?utf-8?q?R3u0WzZPYhpQfG3ZL6OuKKWAi4ZqvAYxG3FOak4kOQTrHjQ315KDUekH?=\n\t=?utf-8?q?EUi8k2lGuliUSWyReK/cNEx+slmFkEDH7wqkjBaFDQvjIGfBxyA6FTvu?=\n\t=?utf-8?q?Ft8S10uxCVkztB7hoU9FJ0t6ZeQGH/KH7mg0kvXvocQE7Zm3l2t6vXNi?=\n\t=?utf-8?q?WYTCMb9/Ug=3D=3D?=",
            "1; BN7PR07MB4897;\n\t6:tFLrKJ+LGbR0ia8AKVkkQbzrFEZRSN+jL4Uk3WNppVtZp88/j7rEsBpD/Bg71BfrSSEGD+fK2nEthYIGPgz+RC4nmFOqMhePP6wURCij5ikU8rb9m+6Ek/Yeky7BSSakgK/gNd2KSZKQklvjoT2ngNSwWP/BxUSaQdoU/jeA/FCuwld+OLPKwmIV0boEMcs75I7+ah79ftSSnL6V7ECDhzTgN3HLDoZzqBsBV49LMNvlzlQPs8Kw6l5+qz9c0s6qCFl1Xeoz1qA414t7Ygugt86w+Um8Nokfww9jXp4YTbr8SKA60NzDFW0iY7rigBh9B/xE6KnS/D5wVpVQ7+9iPwsGzxzRYIZ6GA+1iu1BJ72C0MWrmS/invujy/f8kYPeIrNtfHTHguVyX2KaUDzkAuyll4Gg+VqR245gmJEP7SZZDvR+3vO9Hp31RVTSUMthCY0qiVBkb+UnYHwt/tnNew==;\n\t5:G3a8ndTdR018K7ZMHQEZOAlKlhyWUE0emKcoWQNCjC+nGWKcqNDHBl7rD9Z32rtSAuDDQfEbRbW4V1aoD08MnDwm5kcludMTOlAcOyCGVK5rWb/CxQYoXLRHLwsml9+cJezxO+cV0q6rRXCh4r+RfWSP8yNw6+sFy/cYHkDxIh8=;\n\t7:VY/9o4AtQK04WTznUadg5J8K6p4rPtesE5+86frcS+aimFt8Smz78KS+zfip0nTBqBWoBTakFxsQ1rZ/4tVPvNI5rjpdDScuosScAnG5pxJHZJWj1pgGioUr3Huvt1BGczNW6thiKzgKnNKLVtFuEPQLGVb2qPGNwDPrDc6TjMhcAcTVXHKayAJpBHdqtuXwDJ+RF4AMZdVLbtCDQBqoRNzht02X3iJQI4uktXb9bxViVaN1jMx6juE7M43OsenT"
        ],
        "X-MS-TrafficTypeDiagnostic": "BN7PR07MB4897:",
        "X-Microsoft-Antispam-PRVS": "<BN7PR07MB489721B04FCEC8AA78A8D45BF8E70@BN7PR07MB4897.namprd07.prod.outlook.com>",
        "X-Exchange-Antispam-Report-Test": "UriScan:(228905959029699)(278428928389397); ",
        "X-MS-Exchange-SenderADCheck": "1",
        "X-Exchange-Antispam-Report-CFA-Test": "BCL:0; PCL:0;\n\tRULEID:(8211001083)(6040522)(2401047)(5005006)(8121501046)(3002001)(93006095)(10201501046)(3231355)(944501410)(52105095)(149066)(150057)(6041310)(20161123560045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123562045)(20161123564045)(20161123558120)(201708071742011)(7699051);\n\tSRVR:BN7PR07MB4897; BCL:0; PCL:0; RULEID:; SRVR:BN7PR07MB4897; ",
        "X-Forefront-PRVS": "08200063E9",
        "X-Forefront-Antispam-Report": "SFV:NSPM;\n\tSFS:(10009020)(396003)(366004)(376002)(136003)(346002)(39860400002)(199004)(189003)(42882007)(47776003)(106356001)(6666003)(2870700001)(186003)(5660300001)(26005)(68736007)(16526019)(8936002)(25786009)(6116002)(2906002)(81156014)(50226002)(305945005)(81166006)(7736002)(3846002)(105586002)(478600001)(8676002)(54906003)(110136005)(14444005)(575784001)(6486002)(6506007)(50466002)(316002)(53936002)(386003)(23676004)(52116002)(76176011)(11346002)(6512007)(44832011)(446003)(36756003)(55236004)(956004)(2616005)(486006)(4326008)(66066001)(97736004)(72206003)(476003);\n\tDIR:OUT; SFP:1101; SCL:1; SRVR:BN7PR07MB4897;\n\tH:ajoseph83.caveonetworks.com.com; FPR:; SPF:None; LANG:en;\n\tPTR:InfoNoRecords; A:1; MX:1; ",
        "Received-SPF": "None (protection.outlook.com: cavium.com does not designate\n\tpermitted sender hosts)",
        "X-Microsoft-Antispam-Message-Info": "ai5qpxUvMNrrsK7sjMWR0sEipqfJNPNPAllM/M93wEjRh1v3bbM9uYjl+we1YVylZZ7ocyiAOpOXj4nCfSk/GDk7/09matGbTFFF2GQ97HqWtlvA7k9+hg4Fdk84fms2PprrE8rsXiLhORV8WEyT5dV02RA3jdOGwe+Te59Wn4vSk4Kg9wDYH76d8KV+Yr19u1OpOsI3x9Hk0y1e11KIWYl9b+/MjplTG6kaQjuKIRNWDcdM8XJum/ClpmhsYui0O4IoXS1YDclkvfLkACTTkWf58q9rPr3XFcQe1dYFtWUDPSsE2Y87mJ6kpmtWuv580su1qm0auL6YSgepKgu3ZDxYCUhpREabx2BiEqui2bM=",
        "SpamDiagnosticOutput": "1:99",
        "SpamDiagnosticMetadata": "NSPM",
        "X-OriginatorOrg": "caviumnetworks.com",
        "X-MS-Exchange-CrossTenant-OriginalArrivalTime": "09 Oct 2018 09:10:10.2519\n\t(UTC)",
        "X-MS-Exchange-CrossTenant-Network-Message-Id": "488e3800-2f94-402f-f3b7-08d62dc705af",
        "X-MS-Exchange-CrossTenant-FromEntityHeader": "Hosted",
        "X-MS-Exchange-CrossTenant-Id": "711e4ccf-2e9b-4bcf-a551-4094005b6194",
        "X-MS-Exchange-Transport-CrossTenantHeadersStamped": "BN7PR07MB4897",
        "Subject": "[dpdk-dev] [PATCH v4 23/23] doc: add documentation for OCTEON TX\n\tcrypto",
        "X-BeenThere": "dev@dpdk.org",
        "X-Mailman-Version": "2.1.15",
        "Precedence": "list",
        "List-Id": "DPDK patches and discussions <dev.dpdk.org>",
        "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n\t<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\t<mailto:dev-request@dpdk.org?subject=subscribe>",
        "Errors-To": "dev-bounces@dpdk.org",
        "Sender": "\"dev\" <dev-bounces@dpdk.org>"
    },
    "content": "Adding feature file and guide for OCTEON TX crypto PMD\n\nSigned-off-by: Ankur Dwivedi <ankur.dwivedi@caviumnetworks.com>\nSigned-off-by: Anoob Joseph <anoob.joseph@caviumnetworks.com>\nSigned-off-by: Murthy NSSR <nidadavolu.murthy@caviumnetworks.com>\nSigned-off-by: Nithin Dabilpuram <nithin.dabilpuram@caviumnetworks.com>\nSigned-off-by: Ragothaman Jayaraman <rjayaraman@caviumnetworks.com>\nSigned-off-by: Srisivasubramanian S <ssrinivasan@caviumnetworks.com>\nSigned-off-by: Tejasree Kondoj <kondoj.tejasree@caviumnetworks.com>\n---\n MAINTAINERS                                 |   2 +\n doc/guides/cryptodevs/features/octeontx.ini |  62 ++++++++++++++\n doc/guides/cryptodevs/index.rst             |   1 +\n doc/guides/cryptodevs/octeontx.rst          | 128 ++++++++++++++++++++++++++++\n 4 files changed, 193 insertions(+)\n create mode 100644 doc/guides/cryptodevs/features/octeontx.ini\n create mode 100644 doc/guides/cryptodevs/octeontx.rst",
    "diff": "diff --git a/MAINTAINERS b/MAINTAINERS\nindex 001bae9..afa0e56 100644\n--- a/MAINTAINERS\n+++ b/MAINTAINERS\n@@ -783,6 +783,8 @@ Cavium OCTEON TX crypto\n M: Anoob Joseph <anoob.joseph@caviumnetworks.com>\n F: drivers/common/cpt/\n F: drivers/crypto/octeontx/\n+F: doc/guides/cryptodevs/octeontx.rst\n+F: doc/guides/cryptodevs/features/octeontx.ini\n \n Crypto Scheduler\n M: Fan Zhang <roy.fan.zhang@intel.com>\ndiff --git a/doc/guides/cryptodevs/features/octeontx.ini b/doc/guides/cryptodevs/features/octeontx.ini\nnew file mode 100644\nindex 0000000..307ab88\n--- /dev/null\n+++ b/doc/guides/cryptodevs/features/octeontx.ini\n@@ -0,0 +1,62 @@\n+;\n+; Supported features of the 'octeontx' crypto driver.\n+;\n+; Refer to default.ini for the full list of available PMD features.\n+;\n+[Features]\n+Symmetric crypto       = Y\n+Sym operation chaining = Y\n+HW Accelerated         = Y\n+In Place SGL           = Y\n+OOP SGL In LB  Out     = Y\n+OOP SGL In SGL Out     = Y\n+\n+;\n+; Supported crypto algorithms of 'octeontx' crypto driver.\n+;\n+[Cipher]\n+NULL           = Y\n+3DES CBC       = Y\n+3DES ECB       = Y\n+AES CBC (128)  = Y\n+AES CBC (192)  = Y\n+AES CBC (256)  = Y\n+AES CTR (128)  = Y\n+AES CTR (192)  = Y\n+AES CTR (256)  = Y\n+AES XTS (128)  = Y\n+AES XTS (256)  = Y\n+DES CBC        = Y\n+KASUMI F8      = Y\n+SNOW3G UEA2    = Y\n+ZUC EEA3       = Y\n+\n+;\n+; Supported authentication algorithms of 'octeontx' crypto driver.\n+;\n+[Auth]\n+NULL         = Y\n+AES GMAC     = Y\n+KASUMI F9    = Y\n+MD5          = Y\n+MD5 HMAC     = Y\n+SHA1         = Y\n+SHA1 HMAC    = Y\n+SHA224       = Y\n+SHA224 HMAC  = Y\n+SHA256       = Y\n+SHA256 HMAC  = Y\n+SHA384       = Y\n+SHA384 HMAC  = Y\n+SHA512       = Y\n+SHA512 HMAC  = Y\n+SNOW3G UIA2  = Y\n+ZUC EIA3     = Y\n+\n+;\n+; Supported AEAD algorithms of 'octeontx' crypto driver.\n+;\n+[AEAD]\n+AES GCM (128) = Y\n+AES GCM (192) = Y\n+AES GCM (256) = Y\ndiff --git a/doc/guides/cryptodevs/index.rst b/doc/guides/cryptodevs/index.rst\nindex e9928a4..bd15885 100644\n--- a/doc/guides/cryptodevs/index.rst\n+++ b/doc/guides/cryptodevs/index.rst\n@@ -17,6 +17,7 @@ Crypto Device Drivers\n     dpaa2_sec\n     dpaa_sec\n     kasumi\n+    octeontx\n     openssl\n     mvsam\n     null\ndiff --git a/doc/guides/cryptodevs/octeontx.rst b/doc/guides/cryptodevs/octeontx.rst\nnew file mode 100644\nindex 0000000..1054446\n--- /dev/null\n+++ b/doc/guides/cryptodevs/octeontx.rst\n@@ -0,0 +1,128 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+   Copyright(c) 2018 Cavium, Inc\n+\n+Cavium OCTEON TX Crypto Poll Mode Driver\n+========================================\n+\n+The OCTEON TX crypto poll mode driver provides support for offloading\n+cryptographic operations to cryptographic accelerator units on\n+**OCTEON TX** :sup:`®` family of processors (CN8XXX). The OCTEON TX crypto\n+poll mode driver enqueues the crypto request to this accelerator and dequeues\n+the response once the operation is completed.\n+\n+Supported Algorithms\n+--------------------\n+\n+Cipher Algorithms\n+~~~~~~~~~~~~~~~~~\n+\n+* ``RTE_CRYPTO_CIPHER_NULL``\n+* ``RTE_CRYPTO_CIPHER_3DES_CBC``\n+* ``RTE_CRYPTO_CIPHER_3DES_ECB``\n+* ``RTE_CRYPTO_CIPHER_AES_CBC``\n+* ``RTE_CRYPTO_CIPHER_AES_CTR``\n+* ``RTE_CRYPTO_CIPHER_AES_XTS``\n+* ``RTE_CRYPTO_CIPHER_DES_CBC``\n+* ``RTE_CRYPTO_CIPHER_KASUMI_F8``\n+* ``RTE_CRYPTO_CIPHER_SNOW3G_UEA2``\n+* ``RTE_CRYPTO_CIPHER_ZUC_EEA3``\n+\n+Hash Algorithms\n+~~~~~~~~~~~~~~~\n+\n+* ``RTE_CRYPTO_AUTH_NULL``\n+* ``RTE_CRYPTO_AUTH_AES_GMAC``\n+* ``RTE_CRYPTO_AUTH_KASUMI_F9``\n+* ``RTE_CRYPTO_AUTH_MD5``\n+* ``RTE_CRYPTO_AUTH_MD5_HMAC``\n+* ``RTE_CRYPTO_AUTH_SHA1``\n+* ``RTE_CRYPTO_AUTH_SHA1_HMAC``\n+* ``RTE_CRYPTO_AUTH_SHA224``\n+* ``RTE_CRYPTO_AUTH_SHA224_HMAC``\n+* ``RTE_CRYPTO_AUTH_SHA256``\n+* ``RTE_CRYPTO_AUTH_SHA256_HMAC``\n+* ``RTE_CRYPTO_AUTH_SHA384``\n+* ``RTE_CRYPTO_AUTH_SHA384_HMAC``\n+* ``RTE_CRYPTO_AUTH_SHA512``\n+* ``RTE_CRYPTO_AUTH_SHA512_HMAC``\n+* ``RTE_CRYPTO_AUTH_SNOW3G_UIA2``\n+* ``RTE_CRYPTO_AUTH_ZUC_EIA3``\n+\n+AEAD Algorithms\n+~~~~~~~~~~~~~~~\n+\n+* ``RTE_CRYPTO_AEAD_AES_GCM``\n+\n+Compilation\n+-----------\n+\n+The **OCTEON TX** :sup:`®` board must be running the linux kernel based on\n+sdk-6.2.0 patch 3. In this, the OCTEON TX crypto PF driver is already built in.\n+\n+For compiling the OCTEON TX crypto poll mode driver, please check if the\n+CONFIG_RTE_LIBRTE_PMD_OCTEONTX_CRYPTO setting is set to `y` in\n+config/common_base file.\n+\n+* ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX_CRYPTO=y``\n+\n+The following are the steps to compile the OCTEON TX crypto poll mode driver:\n+\n+.. code-block:: console\n+\n+        cd <dpdk directory>\n+        make config T=arm64-thunderx-linuxapp-gcc\n+        make\n+\n+The example applications can be compiled using the following:\n+\n+.. code-block:: console\n+\n+        cd <dpdk directory>\n+        export RTE_SDK=$PWD\n+        export RTE_TARGET=build\n+        cd examples/<application>\n+        make\n+\n+Execution\n+---------\n+\n+The number of crypto VFs to be enabled can be controlled by setting sysfs entry,\n+`sriov_numvfs`, for the corresponding PF driver.\n+\n+.. code-block:: console\n+\n+        echo <num_vfs> > /sys/bus/pci/devices/<dev_bus_id>/sriov_numvfs\n+\n+The device bus ID, `dev_bus_id`, to be used in the above step can be found out\n+by using dpdk-devbind.py script. The OCTEON TX crypto PF device need to be\n+identified and the corresponding device number can be used to tune various PF\n+properties.\n+\n+\n+Once the required VFs are enabled, dpdk-devbind.py script can be used to\n+identify the VFs. To be accessible from DPDK, VFs need to be bound to vfio-pci\n+driver:\n+\n+.. code-block:: console\n+\n+        cd <dpdk directory>\n+        ./usertools/dpdk-devbind.py -u <vf device no>\n+        ./usertools/dpdk-devbind.py -b vfio-pci <vf device no>\n+\n+Appropriate huge page need to be setup in order to run the DPDK example\n+applications.\n+\n+.. code-block:: console\n+\n+        echo 8 > /sys/kernel/mm/hugepages/hugepages-524288kB/nr_hugepages\n+        mkdir /mnt/huge\n+        mount -t hugetlbfs nodev /mnt/huge\n+\n+Example applications can now be executed with crypto operations offloaded to\n+OCTEON TX crypto PMD.\n+\n+.. code-block:: console\n+\n+        ./build/ipsec-secgw --log-level=8 -c 0xff -- -P -p 0x3 -u 0x2 --config\n+        \"(1,0,0),(0,0,0)\" -f ep1.cfg\n+\n",
    "prefixes": [
        "v4",
        "23/23"
    ]
}