From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from EUR03-DB5-obe.outbound.protection.outlook.com (mail-eopbgr40059.outbound.protection.outlook.com [40.107.4.59]) by dpdk.org (Postfix) with ESMTP id B99485592 for ; Thu, 28 Sep 2017 20:54:32 +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=DZJH8gBBFMi1y9Fe7ksFpB3E12kT+mpQLRc+b8XqKco=; b=c5DGeItpHhA4m4eyxUb1ezP+dlkyAuS8C1mxZPlmT0jjRDMFDOvvoXG0dTQNJAjBwjF/b8sB0LcRr4RvfBwoW4jkRUdineEkXLDkTzU1BNIKihV5ZiAdN+I/m2xk8krxfinsrWGaVAsJjr3GtTfmrkvrXOvyyHeJcEVP4DSPoXQ= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=shahafs@mellanox.com; Received: from mellanox.com (82.166.227.17) by AM4PR05MB3140.eurprd05.prod.outlook.com (2603:10a6:205:3::17) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.77.7; Thu, 28 Sep 2017 18:54:31 +0000 From: Shahaf Shuler To: ferruh.yigit@intel.com, thomas@monjalon.net Cc: arybchenko@solarflare.com, konstantin.ananyev@intel.com, jerin.jacob@caviumnetworks.com, dev@dpdk.org Date: Thu, 28 Sep 2017 21:54:16 +0300 Message-Id: <52640df538fc8beef5d6238b5a541ff4211a6091.1506624250.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: AM5PR0601CA0042.eurprd06.prod.outlook.com (2603:10a6:203:68::28) To AM4PR05MB3140.eurprd05.prod.outlook.com (2603:10a6:205:3::17) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 418f1690-2e47-49f4-6529-08d506a25aa7 X-MS-Office365-Filtering-HT: Tenant X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001)(2017030254152)(48565401081)(2017052603199)(201703131423075)(201703031133081)(201702281549075); SRVR:AM4PR05MB3140; X-Microsoft-Exchange-Diagnostics: 1; AM4PR05MB3140; 3:QNjZ9Ashnd3wkrFFdOarSefEnFthPTfUwd9U4wOPFO1eSJhr0GGqZQbfM/QizgSzycvZhY5xTNR1jGryq9ZoowwhaF9iM5np0GYVoPTNcHLZa1pJvRDSp9h4hZ/Oqplg9ET2JFO8b0Qub+JbsF+LUqyM0m+et4mdbBsak36yPsrwqTs45uAQVTVygevVt+lnnj3hOT8qfYS3u2fAbThUZWCIae8nzGLw3wwtJLrL6XQAy4svPaaHY9dekTV+Uq1h; 25:nbvzjpVYI7xcg7E5B8wIS+Vx125j3boDW6tzGZrO2KavFua0aOKXT1uftbIgpVpLBKFJtXjaJIK1p1TQ5B1YPCXnuqorhnnmcdCxvpH9hposzDamXUwAJCzxAPmcOHpvobqupC2rGihFL38llOKMCJtfR4Z2PQu4BRqzUnlsWar2Xl91tBQCT3M1BB/5n0GxNJQ8L8CFT2rU7pJjTocpxutQGFWYh4iU060rsMCCNtM1sHETczB8tbHDe1MrKCHoHmckJcbM40suHIpDtS5uT/0oMNMavrFUpOl1OKYyaIvFkV+BGHG4R2WdlJZfCVmY81WOY8XSEJDhNZGVC9i7gQ==; 31:WE+X8xJ2lXS43t5QcQ1LDKvCt1Wdj+Nur3O8YmzSmT+VkOMTEqCIpHEqGHVm7rYkKTO3czJ7pe2UhFBxh9Anuli0sNAGmVMDyKA/zTZM+BZMMsdHlFKZtQ2esOw/SCKGi13mZt3zlhnEgczcsuxQWMeDdPtFxCGV/j1NBOiC/Exo+r4gRetJkK+jmThhiOu02Dcil29PFk4nevsK/vHDUZeCZsJgMxQIRdpTt4gOYDk= X-MS-TrafficTypeDiagnostic: AM4PR05MB3140: X-LD-Processed: a652971c-7d2e-4d9b-a6a4-d149256f461b,ExtAddr X-Microsoft-Exchange-Diagnostics: 1; AM4PR05MB3140; 20:wE4Sk+d8mQ4au4F86ul8AYj+PqqjwimukaXMXFklPvd1IaXByV9uBiVQVg7kWfupJ6nmHKpPw9yDyfUsG8RpKMv1567u9aG9uAuhus4p6PiaFH+ZccJEHUAZPPtMIYo3VZmZ7I/JQm+2MzuLzBf6kpp8ZoL1G74frl1fDNYNfR54mg11DudW2Ats3ivprwyRRlMtFSc8qZa1NChTfft9qiyrme2L8T/c05Lj98TX1UnRJdGmjG2kr/m8ePizRlu/lMNGKvNtmzLZ+ftY9Fdz6KFGnva9OlYsFX0ER2SEVXAgYw9VcNEqbglXKF8+oSoblTWp7SDPUh2Gb2kOvUSAO+Wq7x/RHrVVzlkz5O7WiYGm7DbfmBXcTIDXRibYZJakHLmaJTYTouWSernWld4eV439lApVhSCnwY2wEVwJV2RC0bodBo2p+lwCj/voDz3rWwePQIhoiLaPyRPkS+fs2RI8eF05evz/cTd7no9rlU9gcIenZ6d34o4SkNAzACQA; 4:w++cuIjph8sP+16EA7dtsHTxiJWYfNqBAaeDtr98oAyYrS+MyVSUo3QkONIUjytHS/noh5vZM6GC+GrgH3eT4kI5P+pdxYVlsQ+vwgDyyI6DgWyJJPreLE2wSS8MMFmfK77ydJydRBQEhwQS4ToMCs5GhzoVw+yfYl9aPqmOSHflddG+Hv9JKF0yK5a0yI20GnPX1cHAHwzp4LtnN05lM/MiS/sEZTZUD0CSIVsQLMt1DWXI+30EDZY9WKshA01vqL+w0jMGGpP+xLoyQqGAzsIFXB3Xiu6lT2sQZJE+Bp4= 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)(8121501046)(5005006)(100000703101)(100105400095)(93006095)(93001095)(10201501046)(3002001)(6055026)(6041248)(20161123562025)(20161123558100)(20161123555025)(20161123564025)(20161123560025)(201703131423075)(201702281528075)(201703061421075)(201703061406153)(6072148)(201708071742011)(100000704101)(100105200095)(100000705101)(100105500095); SRVR:AM4PR05MB3140; BCL:0; PCL:0; RULEID:(100000800101)(100110000095)(100000801101)(100110300095)(100000802101)(100110100095)(100000803101)(100110400095)(100000804101)(100110200095)(100000805101)(100110500095); SRVR:AM4PR05MB3140; X-Forefront-PRVS: 0444EB1997 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(6009001)(39860400002)(376002)(346002)(189002)(199003)(101416001)(33646002)(118296001)(25786009)(97736004)(33026002)(2906002)(50986999)(76176999)(4326008)(81166006)(81156014)(69596002)(7736002)(47776003)(8676002)(53936002)(305945005)(50466002)(105586002)(66066001)(8936002)(106356001)(3846002)(68736007)(316002)(478600001)(48376002)(6666003)(189998001)(6116002)(5660300001)(16586007)(50226002)(55016002)(21086003)(5003940100001)(2950100002)(86362001)(36756003); DIR:OUT; SFP:1101; SCL:1; SRVR:AM4PR05MB3140; 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; AM4PR05MB3140; 23:+nI/bVdyxzVNzZAF89mV1krOZgrCJW9Dl9deX+kJL?= =?us-ascii?Q?VA8Sn6bnEWnmBsbl4FI9nJMRjKGRJMw6pbMscqKOrw8JYq6safFs3rRrOkX1?= =?us-ascii?Q?xEPA/Nm4m7RjG3nprFQx1qGFQjdq9DcqvVIcQ5z8DOBDhKjt2YUdDAfJoiTe?= =?us-ascii?Q?c4CMyCjLI8TT+UGlPhq8IwAmNG3IpnmP9eld5ooAA/x40AdGIIrpyZk5z+0T?= =?us-ascii?Q?J0IiPAG014D0EdXY0awsb9dmLp0/hmW+YOVog/py2bIKQo2HAR0t0PfxbUoI?= =?us-ascii?Q?csMwJzuQinJaVkl6lT6bAayoOv8hurQTJ5J685KfYkrE9SLlwumLoK+KiYc5?= =?us-ascii?Q?8r5QH0+PPqM+WxA9CIH4RYcmCaUPpzy66WIIRwL4BbYNajhkd1QrD9HqTot7?= =?us-ascii?Q?bRWp0XWeAu2e1KADIQbTqkdYKgmL7nWrsCmoJOONbtaGnH+eU4lOjKKSkzmK?= =?us-ascii?Q?0+JNCinnR4nwg+xk3OzFO45cJhrunHkz/yvwwjYzCShAPCSI/CrjCceE53O5?= =?us-ascii?Q?JHUbnQt8b4hZ4tnhqb0wEUVOiUBZXVXMnopGTtGAQJKdtcJI2zFevmRFPHWS?= =?us-ascii?Q?93SJRgGYNYun0aHG+sIxQ4c/YErgfZBVqE65CtdWZQNkz/CdaoMXg4QSuPwA?= =?us-ascii?Q?L/UEWAs7Fjt9Cfo58AJXkW4p/+DBk6CLv44X4+RW+DcIt0YGXvWaSR75EzVC?= =?us-ascii?Q?HOH6DdG7ubXzJ69xsKR7RZCMIzIvpR85QCq3KE7HPHj0dTcd+fuulDYLZAeI?= =?us-ascii?Q?tKXNaYc6Q0VjC5yoMmd88eHGeDSAyCrO28U7r3fb/i3GVWIt61Sh0K767uMl?= =?us-ascii?Q?FNOBB1mpdzsmlTyxlQaSP0Cr+/r0zB5fIPdF4CGiUKbDX70IprldRi+rata6?= =?us-ascii?Q?+Azkk9FSajXmzAhSdxv5MEOf7PxQE9S1Pft3mH7G/mmGSqYIKH7y4pLtB0L+?= =?us-ascii?Q?JSxyaY+tAttZ8hwlYNvqm0vssb889DDzlGqsObABDg5mcoJKxB4P5TOdSnHm?= =?us-ascii?Q?cdcrkWxyZwvflKSQN8kogCl+LgVzo9QnIpOsO6P6lZOvS9SWQ8LKLMYZ6Vhg?= =?us-ascii?Q?KtHxHAo1cHlqQO47tEDOrr5ZFHuB7JWLAkl/Ls0L0GDQXVeqA=3D=3D?= X-Microsoft-Exchange-Diagnostics: 1; AM4PR05MB3140; 6:QbyTYfvzk+2OH+kl6VctUrS/jz1xKoCYnRIDW6AJreBphDc7cR7TF0kYd3r585TwGbFnvA2pz96c21SaaQeqNA7ECajif3hMViTPSOVWF9k7Gn2du0CJle1X9X/zDY8viHdhoGtF15QVlSIITGjscgWE2WuogNNYwFfixieX44bYS++YFODExv5vBqnzeAEHMPGZo/UNblQ3nwgl+ek/4deauOS5D6eCornKZ/16BpTYSju7VeeYHeULmCHgixboTl3n0BhjIC7oBTHSxnVhNqJSjCeDve3uYBJjxIsUMS0Msj9JZgUnBJn9lN9HS3VzjwWcAo5QEvCk7zvzhioRsQ==; 5:tAC9rSn0NqIxuGNV0/Vo3xXE4C5+Af6rsDLFmkabRIWsnx70mAjQURDCe7t7nvwoKnoTYQXevY81Qt8ktjErzO65bcm0CJVR0EA7gcascj3sWHPfI3zubxgDdjpkyDG16ZBxyDlhtBCSxxmrstgCFg==; 24:sVM44URzVa9bItZsGEyctlmchFpTwtoXxcqp0S/ShXsWIGOvPb6g+RGxF1pda9j65xGCP9SV8qD/f6QC2jOBE1EebB60D4vbRlrtkhUEZ7g=; 7:62s9vfJx7r4gufhRYPsDCnVJnXaZHjFRGzMZcXS83c8EVM5xqhISPj9kiveu2o00vK97VTqqdpwdFPYy98u/xX0/k9LXcPoy4HR7U9L2QBWejmNE9u42ZzVw+2tMfH/5GM9z/lBtwerRu8hJv3ufWmr5S9i3e8ziO7MOXGQP/3gv8W+smsFN6iYvIAhyUZreLxQ9JDWFQIw2mo76d+pbVqPumdl/r25lphb9kNUq63A= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: Mellanox.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 28 Sep 2017 18:54:31.1619 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: a652971c-7d2e-4d9b-a6a4-d149256f461b X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM4PR05MB3140 Subject: [dpdk-dev] [PATCH v5 3/3] 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: Thu, 28 Sep 2017 18:54:33 -0000 Add the programmers guide details on the new offloads API introduced by commits: commit 3ef4f4a50d2c ("ethdev: introduce Rx queue offloads API") commit a23fa10f3ea0 ("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