From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from EUR01-HE1-obe.outbound.protection.outlook.com (mail-he1eur01on0044.outbound.protection.outlook.com [104.47.0.44]) by dpdk.org (Postfix) with ESMTP id B4450532D for ; Sun, 17 Sep 2017 08:54:50 +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=PJ+ECU6964Kmc3thoDq6APr2PhVl+oYyRCSYvcAmhx8=; b=olA9pI58w4z1HtxxNbIaniNmpfmHykHZuO7X4Fu8da3jFLKmKy7kXgk6moNtcnWzZv/XuiSYxihNWyODTpCkmN0iB5ndZA+0Wq49oqNmMkPBkvVsCcqeEa/nrwWjvRqOPtIykQ12SQL3bo9TcxPnqQBO/GaLsMKxgfJfkQ+xUmQ= 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.35.12; Sun, 17 Sep 2017 06:54:49 +0000 From: Shahaf Shuler To: thomas@monjalon.net, jerin.jacob@caviumnetworks.com, konstantin.ananyev@intel.com, arybchenko@solarflare.com Cc: dev@dpdk.org Date: Sun, 17 Sep 2017 09:54:37 +0300 Message-Id: <6b4402ed833f9edb53c907e77f38130434d8b40a.1505630554.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: DB6PR0202CA0003.eurprd02.prod.outlook.com (2603:10a6:4:29::13) To AM4PR05MB3140.eurprd05.prod.outlook.com (2603:10a6:205:3::17) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 867fddd9-0f1f-4572-873f-08d4fd98fdaf X-MS-Office365-Filtering-HT: Tenant X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(300000500095)(300135000095)(300000501095)(300135300095)(22001)(300000502095)(300135100095)(2017030254152)(300000503095)(300135400095)(48565401081)(201703131423075)(201703031133081)(201702281549075)(300000504095)(300135200095)(300000505095)(300135600095)(300000506095)(300135500095); SRVR:AM4PR05MB3140; X-Microsoft-Exchange-Diagnostics: 1; AM4PR05MB3140; 3:shed7YsrIgBJT3GWeNsDa8M8yws71HWs99I3oCr2vjlB32+UVv3YkQGyJAIwX62DcP2Vgb7to8qbPXCyGAWgh70TYkeNID7zMYxCYgktwjtcFS00qvXrR574trvuUQQptZtnUBZrXWUKEYJP9hz9O/9Ku9QVWj8opzoZA2ZQVY0HMCIMGoPB9Vfg2c0cO2Fw3eI0WTuJW6eI2VxAeKFgO4qZu4vtSLv8zx63HSJs/7M0gsd8okVwK7n8XNCirIkb; 25:Z2vrprh1ozNG1tX1huZunrgd1o7lTrkb/m3XfG5LSG65FPeAk3dCZLcsKcmd8NTf28oyW4s9LDRK7EV0vBjNJ77Bg8XgAWhcym9zlxXE7JQndncuiW+qWPCTO7cmAOCTS23BDlhuuMT/NULtLY2EvNoGvzX8M6rsoUnMlR4HTVPm53gWvbyeIfhvOu6r/1wUNVekmHuLmg7K4oZA+3caREOpypjvI6g20T5/Y8KaUkch4CejMFVophjuhJm9teF7VLP26Vkvc16vdkF9HIgC+jYZDlAAB+KYSzxcUlHaY7cS0gycqlCdFp+4a3jFkAAgz+CsOUxXekJDnH8mfpoTGw==; 31:saJksdSA8ecs28Ik0ACDDl0BKE+7RpiFK/2sfcK4IePYmNBptC0CnAVZgpLpegE1wId5DTAVgpMCV5PDRNOLlTPXyBce9Gaxlrr5deyz6JZRHx886eAEr9UT3oTkDNJP3kCKSGUDTHSKzXW+/9j7babvTUxOpPlleltu1rk88oXxEHsaNMIKho01wN8/XnY9MJmUailTGNJM1hGqq+aCJl0IfiMvO3MPTaUpTQf4pVc= X-MS-TrafficTypeDiagnostic: AM4PR05MB3140: X-LD-Processed: a652971c-7d2e-4d9b-a6a4-d149256f461b,ExtAddr X-Microsoft-Exchange-Diagnostics: 1; AM4PR05MB3140; 20:daQTXUqO3RkeXoSyIfkdYmclk1Qv9j1gsW/nJofqWWPBG9LF+Xj+RsGC2hXdDjAbgwlDNd/ct5CfF4VUg+9oEqx4JppuomQ8vZne2SA719jOpviHq5NBa7uikP7ZoA5Ak9/vnNi+0QEH+HwHOfUMRnpFGq37QYht51OjN8ZfPi3bxzTMRsPomR/0A3SJWHFO6ttHhi3+ObfV9cVI23ewHnLkkhqpjjJT9rURsEnfLKeqTGtxjiSr+5tJfFFBBVzEV0lHEI+EmK/BCj++fW4cXAZvkrnRT5IdUH/aQGvSSfH+vU/SP/lEGizZ5MIKKeVTYh/6ZR1UnRFPNgH+gZ6HW+8s3/YyNGFSCW2/gXzz80eqQBdo5FBYxABzE5hzja7//bKK7jcnVYM+CUwxONp6Fmv04TN1Etbr/KvHQimgXJ4swKba7+dCa+ZVZvHYjwhDc6FitIZfo0wt6eHbiPlBcjDqQiOCxhNsZsnAEHWRndmZKpO+3R0k3bi+hWGQVIa1; 4:5iHLoPV6ANkdoUIQYYqkKVlMYtpk6ehNlaDRWkDI/j8/NoO4cDguMjSaWh0mLKYxlNJo1QLQKczJEmpSLZJjYqfb2YygA9L4+zlopm1jWt9S6eAynmITtZbrYTk9znWPCnNCNMt6x05G9AotCV/hHYppdgcKZ4f5Zd6UXHYHRC3SSrXG1/OAvFuU87SNZAEtvzMTHVcDAIHgfgzlpRsSPstw4Yz7u+CwcoD6X8F9OMQzhGv+C6wkgqCZSGQox/6Y X-Exchange-Antispam-Report-Test: UriScan:; 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)(201703131423075)(201702281528075)(201703061421075)(201703061406153)(20161123555025)(20161123564025)(20161123560025)(20161123558100)(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: 0433DB2766 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(4630300001)(7370300001)(6009001)(39860400002)(346002)(376002)(199003)(189002)(305945005)(3846002)(81156014)(55016002)(53936002)(68736007)(86362001)(76176999)(101416001)(50986999)(2950100002)(97736004)(48376002)(106356001)(118296001)(33026002)(105586002)(110136004)(5003940100001)(36756003)(21086003)(189998001)(69596002)(8676002)(2906002)(316002)(33646002)(47776003)(50226002)(6666003)(50466002)(25786009)(478600001)(4326008)(16586007)(66066001)(5660300001)(6116002)(81166006)(7736002)(7350300001); DIR:OUT; SFP:1101; SCL:1; SRVR:AM4PR05MB3140; H:mellanox.com; FPR:; SPF:None; PTR:InfoNoRecords; A:1; MX: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:J6FgNGCD/rYnpEqnfPQBZCljW2baPomvxuJqVaMmw?= =?us-ascii?Q?RPBSP4dCVC7TWRHrg0B/OThKVlM8Sf7adAqrsdkZX0zHNlLtj7LV+Oh3wpa0?= =?us-ascii?Q?hr4dOffNHaN99Yeiqvb4LRuF52MFHFywcTd56EEseiygnTqwCrjENi4/zqpL?= =?us-ascii?Q?1cH7xc2OsD5RhgiX1nYR3R/bfw8gi+WlHyX7eaBOIAcTHkc6+cWMTYNzOWNL?= =?us-ascii?Q?fDcxc6rlGDmXGgIzyqigMDBgZbN5OwXgAA0UhDcQFpDmjQJh9NHGemkEmsIl?= =?us-ascii?Q?XvrtYVnh7udWNcC2R0bhjpQvVfKVg6m78O/HLNYWpVtzYk9dEAyHIAG+ek1t?= =?us-ascii?Q?HFz+dGtzP+8eBaslO9iWtoPabO/zVchAENGlfG6ac6vU+f4vX4RQgqaxTTGY?= =?us-ascii?Q?wjW5peFFUftutKO1Pa35o40pyLIPKiyJOTdcq5uyaqcMxx7vTK+F16FMDTzD?= =?us-ascii?Q?18xHAStKZfBwtlp/IXCCvjI4JNoycTQ527mcK+SFQwwNqoa7Knjec/USSIRV?= =?us-ascii?Q?KNG0zE1V51qohBAtSrdWv6TF7cQwBXBJqefE8SwiEBtN+1VdOE5V6g1rXk5h?= =?us-ascii?Q?EGfd/bwdtRPl/NMHebmN4qSTodPaOAZd75E+NOlOdL+cdIbyfK9HJm15bjN4?= =?us-ascii?Q?3Xde1da9DrVgttbBpJBs7c1Ui5VQA+pKEm33ddbRPDiUXAUy898hF+sItH3h?= =?us-ascii?Q?Htl6D/mLH3tjslyR5bZjqoNg4jF0bt0DZc9I4ik+Hf0CSMx+C/xm0spAuyq1?= =?us-ascii?Q?DQbx9RnsRxR0qs0KvHC9SdB7z+/2IXrk1lRuutKNyzbO84h1YMXjXESSCads?= =?us-ascii?Q?9maHZ+tJEb6DFBM8VU6ppZeIjbtoTvoKGday2gIDvf6Dtcnc+A5FUGMLdOIc?= =?us-ascii?Q?4lLMdagDfgW2sh/UbjNlxZ9pjWZcMCE6k2a5/v3S391MujzFwK7VD4/UPEWl?= =?us-ascii?Q?AoTsRGulr8zs2wg521bHNBxQ/NSoRJRuei0NucJdkSLFRf+gsThrHYU2wXtW?= =?us-ascii?Q?RAuw+t2gknepLsa8JOllVRlDY4Uiiacbk22aL0/xOJXpycvmyPOYgXiOC2/T?= =?us-ascii?Q?4W1M0tjujwSYeZhF0U2r0/Vbu4+MTxlqVt6PSXj9zs81IbOLM4+WqY8Y2nCX?= =?us-ascii?Q?2RfKBtDStJJpSJP6uIMKmSuZiYfT1jeZNU/3s8qMUVj2oaYevWLm+0xmbV5C?= =?us-ascii?Q?GVSTAhzijkFD48=3D?= X-Microsoft-Exchange-Diagnostics: 1; AM4PR05MB3140; 6:v0GkLhfu6g8RrGQCItwO5D88s/XN/Hb9DH2kbGSmbprLMOOAgcEdWcyy/Sz2StVb4T9HeakqPLmJWPQUG6gX2kQD9n8dBvS2/mstmVrvdO/C5dgZyJujfLpQprm12RjilYOTA3L0kteO1Bdxee0EX5ShlO2rLkZ2ETxXjSziiwMP7mtvNvvhMFFm8LV8qMtZkPHqoahA332QS4r3moH1Ax8G0NtZiCzux8N31DfYWWpdjQYMlzLstFEHllM/o35te2F2oxl1yUeeAvffTpjUtqf8RsCPVEmD0y9cRFR2qs/2zGXqmm05FBZQhpInWbNjwX5bPfCAuwDyHEm53VnR+A==; 5:LUGX9oj764v5+COPFyRxdEPFRhz2FtSMcrJe08B1XnOXUvXugAm4QtehbI4izk0+8ji7aCzaB5CVgdAlQY7ajX26/e6U3rkOd+yDwksnCT2kPbzVjNRJCu9Zyhw/9Kb7AihWhKTzfblcuSyLoQJ79A==; 24:eCUdRNIwGa8ONdUp7G5pv8zYviWjDm9TQlhsGOpSNxHf0/p3Bp3q+7JULydFxKyMHcrpcKADbPgaFI1lHqlXzhEwrHB5/LHwPH3UwWO81XE=; 7:ooI5gGyt9ud6CUQ3ayz7XgxHXj388INrfcW0DnJQCccNZXv+AspqOEZds02VvDnIptVAQKEfc9OwVZcnIHbUP238PX2YUFRP1s74UhhJyv9s+BjANqpBSlnoFnniU7C91F4+jkbx4VKXT4YUDUHwxiBYQOT9NNhNHA4xywuhtjIoZ3UKfW42ta1TO7XixNc/o8sUhX1BXnkFrn8EY1YOTbeVAgKAv4i4fSzVA1S7VGI= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: Mellanox.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 17 Sep 2017 06:54:49.1579 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM4PR05MB3140 Subject: [dpdk-dev] [PATCH v4 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: Sun, 17 Sep 2017 06:54:51 -0000 Add the programmers guide details on the new offloads API introduced by commits: commit f649472cad9d ("ethdev: introduce Rx queue offloads API") commit ecb46b66cda5 ("ethdev: introduce Tx queue offloads API") Signed-off-by: Shahaf Shuler --- doc/guides/prog_guide/poll_mode_drv.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/guides/prog_guide/poll_mode_drv.rst b/doc/guides/prog_guide/poll_mode_drv.rst index 8922e39f4..03092ae98 100644 --- a/doc/guides/prog_guide/poll_mode_drv.rst +++ b/doc/guides/prog_guide/poll_mode_drv.rst @@ -310,6 +310,23 @@ 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 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +On DPDK 17.11, a new offloads API was introduced. + +In the new API, offloads are divided into per-port and per-queue offloads. +The different offloads capabilities can be queried by ``rte_eth_dev_info_get()``. Offloads which is supported 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 on ``rte_eth_dev_configure``. Per-queue offload configuration is set on ``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 shell return with 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 application to use this Tx offloads API it should set the ``ETH_TXQ_FLAGS_IGNORE`` flag on ``txq_flags`` field located in ``rte_eth_txconf`` struct. On such case it is not required to set other flags on ``txq_flags``. +For application to use this Rx offloads API it should set the ``ignore_offload_bitfield`` bit in ``rte_eth_rxmode`` struct. On such case it is not required to set other bitfield offloads on ``rxmode`` struct. + Poll Mode Driver API -------------------- -- 2.12.0