From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from EUR01-DB5-obe.outbound.protection.outlook.com (mail-db5eur01on0065.outbound.protection.outlook.com [104.47.2.65]) by dpdk.org (Postfix) with ESMTP id BACD11B608 for ; Wed, 4 Oct 2017 10:18:18 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=Mellanox.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version; bh=u1OJX1R52lwcgRrC3JSL12DazrV1LEfhuWpOHsRyl+o=; b=Jkwl7pnVeUs+qelPmJ2USLf22h9xD6YPmLQJD7KCU9zy8TzmLY/LXJt4ewCIX9I9XBWSlfCHdAeg/iR3PO/j9Kn7WMc2L4RCrrbCq1ZuiHeEqvP93prAXg0ejnIcG7Nj5Rs/6lb9VQffxQFAyKKKRAI4SPH7oVKBWpFu2qIw0SI= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=shahafs@mellanox.com; Received: from mellanox.com (82.166.227.17) by VI1PR05MB3149.eurprd05.prod.outlook.com (2603:10a6:802:1b::14) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.77.7; Wed, 4 Oct 2017 08:18:16 +0000 From: Shahaf Shuler To: konstantin.ananyev@intel.com, thomas@monjalon.net, arybchenko@solarflare.com, jerin.jacob@caviumnetworks.com, ferruh.yigit@intel.com Cc: dev@dpdk.org Date: Wed, 4 Oct 2017 11:18:01 +0300 Message-Id: <44e451f86e4582815767cf75b4e0f01f5cc60b5f.1507104596.git.shahafs@mellanox.com> X-Mailer: git-send-email 2.12.0 In-Reply-To: References: MIME-Version: 1.0 Content-Type: text/plain X-Originating-IP: [82.166.227.17] X-ClientProxiedBy: VI1PR08CA0212.eurprd08.prod.outlook.com (2603:10a6:802:15::21) To VI1PR05MB3149.eurprd05.prod.outlook.com (2603:10a6:802:1b::14) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 21c7f5aa-0cae-4407-5623-08d50b007753 X-MS-Office365-Filtering-HT: Tenant X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001)(2017030254152)(48565401081)(2017052603199)(201703131423075)(201703031133081)(201702281549075); SRVR:VI1PR05MB3149; X-Microsoft-Exchange-Diagnostics: 1; VI1PR05MB3149; 3:p825/HDHs0S6RkeWcFvMVmshfX7rOo/Ka9pnvRumFLl/yrSf54lBqJQTqwhT4t90qUkCfVkaBgEkf1wMK91dJ1/Bl9leeSVbzkyugo/c3jk/+gguY961Sq8Nc5HvynACD5WCqUiFRvbF+wxR/dXUbBylMhdmGevg39mRTYLlKs1/xz030p5uzw8FO1YDcCxmTv+8zt1groz/stWPnrHDUjtt7wNbB00ELTeQEYIFT6BKCSL0YeovFhPhQlhJQIrt; 25:h3gGTO1ZLRlYOUhL5VScLEX/70XTHRZ/0Hs+zunig+pf/jQHfbzgl+xmPJvoeMwIIuPreOcaBlOHRTZfSHcPfF4XEgmPiZCF9xk74YVnjgnuMpcszv03CqTqfXUSILlue2T3c1f2ANQviTjIUeEEDpqEMqfpzfOCs9ip/RWVCtD+eWffRX4IhhyTH+so8lqYoPfD+RG0TZ7jlhTO2Ay0YoA43SYQx/Gs2jHgqFFeoILSAeJyo0HcWT79+QKd04I8os0q3TMuwfvP9jrFlrdDMzrNd+BjqgfsfTTzoLN8UuZlLeyiFT2jg3eh+t7jamur2aSDZR4seA9XyC5wtOwrhw==; 31:gdBNNsYVCRQPl9Z5YJK7UWmnxfVwU/WwH/asjraQFWetFX6iqITxXhxpq2vEqmyw6JQazVEGiIDCDvAA7mMmk+jLzmxpYACdAzbTHF2B2e2s+jRIOee2LzQLFSGGG59rZHEmTYnfmZNdedAjeHY2jrCP98iZvRI9VdznXDHw2pCRhG2BJhWGqLxEAJWGucLw0Mjck1LF/971/a3LgRhZAYUL3MJiL3Ssfbq6r4DK0bs= X-MS-TrafficTypeDiagnostic: VI1PR05MB3149: X-LD-Processed: a652971c-7d2e-4d9b-a6a4-d149256f461b,ExtAddr X-Microsoft-Exchange-Diagnostics: 1; VI1PR05MB3149; 20:axGvBEIf1SNvVfm4RY1V+fYjQTH2nKY50E1eYaVay8rQbU32xGaePCDYMiESFyBjY5EixBMfcK1jzXA6bPUZ0hfCOMf0doQ+dBrIPTiA053O7AMMKeXgH3exGGntOxvwjIgmQOSlAe2lFcZkrzvMl8xfYyNqgF/AzNwFuRhNOHzEdx4mm/zMXacFAp+DwQYlh6suBzB5UwyTw6YaK0cNrk56gTsXt7dsf6ejj3lglDm8EkHmD9h/Wb4k9NaLS3bjC2ZKzOEryxn0AI7K5iHWPJgJbaEE0xr6Qr7ovLbe2WsskhmSZGZmLxa2EMqLixpM9LzByouLKkuseXwyAHf22vqXLAUS7FzLqWJzvwGnHZc8nvwvoHjoOwyrjTsz2HFoWWoiXurv2cSgYJ6UWU3j2jr2Cv6zijI0B6SheEidtkcEAJh0qu+gqo+ISIRQv+KXVN3Dhsg91B1hhtfSfFbdXBhcm3R9Y60kJZGiyLruPI2yWhsFEb12AGN0ZHVH6uiF; 4:3INyuKroGDmurT48PXXj/uho3JO1v5NzKKBjVquunkc5jt7K9hndkStmNFZt3InqKPUi4ivMLMewnEgRKrZPxfoCFJmGB5jvneDCU12O2gBCKQ5RsNwb4QwXTS8b6XZqqrnnAYLq4CAsRXq8f6bZEtcmUvA9cGRIsvm4EpAc50u2yPbK2BNNL1Oqc/S5T21I3CdD1z/h/omhFr1LXdGXXZs7zXPYthaXgw6AsYJz3+wFsGNX2Ur6oDiyR/PAtTQ0O95jr2J/xUNHg7vKV0szzbq9BN80rSOzARnJL4BMQtU= X-Exchange-Antispam-Report-Test: UriScan:(228905959029699); X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(100000700101)(100105000095)(100000701101)(100105300095)(100000702101)(100105100095)(6040450)(2401047)(5005006)(8121501046)(3002001)(10201501046)(93006095)(93001095)(100000703101)(100105400095)(6055026)(6041248)(20161123562025)(201703131423075)(201702281528075)(201703061421075)(201703061406153)(20161123560025)(20161123564025)(20161123555025)(20161123558100)(6072148)(201708071742011)(100000704101)(100105200095)(100000705101)(100105500095); SRVR:VI1PR05MB3149; BCL:0; PCL:0; RULEID:(100000800101)(100110000095)(100000801101)(100110300095)(100000802101)(100110100095)(100000803101)(100110400095)(100000804101)(100110200095)(100000805101)(100110500095); SRVR:VI1PR05MB3149; X-Forefront-PRVS: 0450A714CB X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(979002)(6009001)(39860400002)(346002)(376002)(189002)(199003)(55016002)(105586002)(189998001)(21086003)(305945005)(8676002)(16586007)(106356001)(66066001)(25786009)(47776003)(33646002)(81166006)(8936002)(81156014)(16526018)(316002)(7736002)(86362001)(4326008)(53936002)(3846002)(50226002)(2950100002)(50466002)(97736004)(33026002)(6116002)(68736007)(48376002)(69596002)(5003940100001)(118296001)(5660300001)(36756003)(478600001)(6666003)(76176999)(50986999)(101416001)(2906002)(969003)(989001)(999001)(1009001)(1019001); DIR:OUT; SFP:1101; SCL:1; SRVR:VI1PR05MB3149; H:mellanox.com; FPR:; SPF:None; PTR:InfoNoRecords; MX:1; A:1; LANG:en; Received-SPF: None (protection.outlook.com: mellanox.com does not designate permitted sender hosts) X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; VI1PR05MB3149; 23:oEo2KHFbnHJkE1ESTOTR8c3p3JZT0DanpPiKpLTZJ?= =?us-ascii?Q?QIRi/a+acrcb6FE0U0QjTLKH+wj60zp2ygOUB7k3N7CmsbutwmIA1KrTms+E?= =?us-ascii?Q?m6nnuS/4nHcCIOejQoHzlarYWwasWlp6KV2giyeMeiui4DQB0neY9Lup4c7c?= =?us-ascii?Q?d9H5pVy3goXiy1UezCJY6Fwz7+KS0lG/1M7CfntuzMi4JFRbvSLA8FDAbapL?= =?us-ascii?Q?74KH3jPBTBU6nqnowQZJsv4v7iMlrtCZ562DuT6JawAZy2F/Y0AZawNWki4v?= =?us-ascii?Q?kNvU4we1axjjl266A1eVw15xnvXniLGjol1Q/JA5JBjc4bAhryiUFL5Eoe3b?= =?us-ascii?Q?QUHOwN0oy4l94Ul6dvmNQYjDPuIiT170rpyNURS5pcFwoiCkqaRoYClr2XmV?= =?us-ascii?Q?H7YrEWQx+o2ZsWiRzmY6pmaGwbgta9F1/Ec17R6pNJxlmIY8+24YMWIwESBp?= =?us-ascii?Q?/MS8z51u5hIUig1thVW5mlJepLQ2NHS2yhF+78jGAUdxEfaJZdLu4ibxiNaQ?= =?us-ascii?Q?NgUrh+UEfaqZ89tTlxlGR0sYcYBieG49Sp6z1ZGqVVj2dgGQiLLVJ8DOlMtH?= =?us-ascii?Q?74f9Mi4riPGiWcGRH/JjO0MXEvVzj8+DyXU+eYz9Go5ZqnBQAi1UCLy/2E5Z?= =?us-ascii?Q?6LFRd7Yj3d+7wbzCTEodg/wS/LybEWG5tKCrHSnBSdSulYLOalHNF5MQRXtd?= =?us-ascii?Q?vVUTSQZDYxYZuOApBRslzECCMVIgq/a+fl82VC3nkcBPRiogF2PJP+R/Hk/v?= =?us-ascii?Q?XybpOrRQqTEGnsTvN/RHomegJbjNpwSAhOvnqsgT96G7JtEMZA7R1e7n3SPl?= =?us-ascii?Q?c7n0JJvPRskKFsqCzGj9imFkbmXgFdW3UHYk4QS9okYO3hCmIcXBVpkV+8AW?= =?us-ascii?Q?kk4QLvfHEg8EdJoS9bTUbQv7Zr/P7Q04bHRkssA3NvvqRQyu6a3lALAdC2gO?= =?us-ascii?Q?btG9GsdjWhTDVi36/9Jjxs5ZnBYTkf9xbhDHWlQ6/MPQu8l5VkKHrrCkFrn9?= =?us-ascii?Q?wZ255nSZzMAVLagLrCsqIec+JZWqHNMfpfYYEYrZAlfBmDudRQ7mT+YshATT?= =?us-ascii?Q?4atdQ0ugyItbn2+BI1F2L7HyqPvG52XoHc61RlEnnkSc03U2lhFqyDKMeYTI?= =?us-ascii?Q?frQ5QwG4XMY5jaVnmCiaO5wJ0N6arIxifSvgEXS7zKZfmZ5Yw+iMfE/0VsS/?= =?us-ascii?Q?kXUN1+t7V6zCScB2TPynD60Q6TX4wi3tKD9UuEHLMvtCjnO9E3Ps27CSQ=3D?= =?us-ascii?Q?=3D?= X-Microsoft-Exchange-Diagnostics: 1; VI1PR05MB3149; 6:iMzIk4FLtrRe2R+SMNUB/f76xUDz4obhuO1zPBxf7voKn8D8uj9i1wYqYoM/5dZMie0/vVMUhAoeXQyrG7uFydXpIhbZ1NuJN+2u1bd5Sq6NXuDcuqPUG3q+In+NLWq58C3+gNJZXVwcl3NHfqEyedZdEpoeK7P73I2AjxEdQuL5wQwPEw8TqSsTzbGs24HFErnJVMtFKddlG0DCvW7XFkl3w4UZ5BDv56H59SeC4X9kMH7IBqfOu7rFhg3YE7gTJ/lEiH0+0SrB2FiOJg6S3kGdKxS7fO69Sx21lJ37hp6YVyn6CoV6lMCFOppzgkdYqYLQrhhGXghwFuJk7BCMWA==; 5:irlZ2mL1D2Zb2buw+LQdh4peWlvq88ks0ePNQDFtbryZ/UWBMwRYSoI9Sbg/WQTRvXdcUrb7NK5v4iF4nq/pOHJ3Mwdu8DIhWWrT1XjJeIdG0hZHUsWdRBb9iuWrF9/J7d171g3nBqXj4XAsWaVztw==; 24:xmghQoHccg2zxZNJZiKcTVST+sruEj8RUikr3BTFvnoxx+J9MPQpyiyRGLdnxBxzF1BAUkFSq9tpFQ7B8+n2WfKTlI5xiIiHrQethc1KA/Q=; 7:ki2TUa809k82sBczeU8DTEHkMCFqYFvsIJSouVqFZsJhG/6hxUx/gdf2Hdkbo3Kjzbmow3Inp0jK9EDdce1769u3LjwY7Lrj7BufX8/2GiTkHftrkmG+GXvF+FKxqFyiZga0VmfMlywIlf+/GLC5seD/Ckxxdq2MkVP6lvrfPVCGqjWdlGRblreyaemR+yREIwSDdxqZOyY8VC005i38KrIuWV+6jYnTXpdW/+nj2jI= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: Mellanox.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 04 Oct 2017 08:18:16.5145 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: a652971c-7d2e-4d9b-a6a4-d149256f461b X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR05MB3149 Subject: [dpdk-dev] [PATCH v6 4/4] doc: add details on ethdev offloads API 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: , X-List-Received-Date: Wed, 04 Oct 2017 08:18:19 -0000 Add the programmers guide details on the new offloads API introduced by commits: commit 67a1a59b597f ("ethdev: introduce Rx queue offloads API") commit f883eb32e2d4 ("ethdev: introduce Tx queue offloads API") Signed-off-by: Shahaf Shuler Reviewed-by: John McNamara --- doc/guides/prog_guide/poll_mode_drv.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/doc/guides/prog_guide/poll_mode_drv.rst b/doc/guides/prog_guide/poll_mode_drv.rst index 8922e39f4..423170997 100644 --- a/doc/guides/prog_guide/poll_mode_drv.rst +++ b/doc/guides/prog_guide/poll_mode_drv.rst @@ -310,6 +310,26 @@ exported by each PMD. The list of flags and their precise meaning is described in the mbuf API documentation and in the in :ref:`Mbuf Library `, section "Meta Information". +Per-Port and Per-Queue Offloads +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +In the DPDK offload API, offloads are divided into per-port and per-queue offloads. +The different offloads capabilities can be queried using ``rte_eth_dev_info_get()``. +Supported offloads can be either per-port or per-queue. + +Offloads are enabled using the existing ``DEV_TX_OFFLOAD_*`` or ``DEV_RX_OFFLOAD_*`` flags. +Per-port offload configuration is set using ``rte_eth_dev_configure``. +Per-queue offload configuration is set using ``rte_eth_rx_queue_setup`` and ``rte_eth_tx_queue_setup``. +To enable per-port offload, the offload should be set on both device configuration and queue setup. +In case of a mixed configuration the queue setup shall return with an error. +To enable per-queue offload, the offload can be set only on the queue setup. +Offloads which are not enabled are disabled by default. + +For an application to use the Tx offloads API it should set the ``ETH_TXQ_FLAGS_IGNORE`` flag in the ``txq_flags`` field located in ``rte_eth_txconf`` struct. +In such cases it is not required to set other flags in ``txq_flags``. +For an application to use the Rx offloads API it should set the ``ignore_offload_bitfield`` bit in the ``rte_eth_rxmode`` struct. +In such cases it is not required to set other bitfield offloads in the ``rxmode`` struct. + Poll Mode Driver API -------------------- -- 2.12.0