From patchwork Thu Dec 1 01:38:48 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Chaoyong He X-Patchwork-Id: 120386 X-Patchwork-Delegate: ferruh.yigit@amd.com Return-Path: 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]) by inbox.dpdk.org (Postfix) with ESMTP id 93E84A00C2; Thu, 1 Dec 2022 02:39:08 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 8869D40693; Thu, 1 Dec 2022 02:39:08 +0100 (CET) Received: from NAM12-DM6-obe.outbound.protection.outlook.com (mail-dm6nam12on2090.outbound.protection.outlook.com [40.107.243.90]) by mails.dpdk.org (Postfix) with ESMTP id 0ACB04021D for ; Thu, 1 Dec 2022 02:39:07 +0100 (CET) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=P2rsSDRZYh9xFJGyfXdGRrK585E6HnfW8fok6AvCWwWOtsSShibSgoaZbQbj2rTdN3QIOfon6Ezgt3qTPM+02w9ZHkq1SGohtaGYx+F1uD5gauPO/dBBbH9WDtSC1pc9sdsa7GOD/a9gxD5ziEpTEMZIe4ltt6aX2PmTecFC0L8UJQaUs5UJWNJOTg8FKOoQmNtfMnnTFnXtZpJp8ghUxdMbPKMFe76vjHTmhFkPOz3meXSELrG7m/OxkXDnn8+m6oSSGvKOWWh4HwiPGbmIfsp4WOad/5MHeNxo8uyIw5LYUtmI48+VJmIYbEah4RHzQF3FeuwwMdL+vZ0nAKaMjw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=omKdlTJ82kXLMfyroOEaD6n+ABoVdP6ZY+mEMrRDnQQ=; b=fZXVedS8U6TDfxflrwMTNAe5+wXp9/GeCR9hVyw0sOsEbtNbYqDJcZlAPPtfwSrksw4pS30JK5ZtB//yYsZyClnWIodlZ4ptQtnb2T3gQsWUhr6vSgf7iEQvKMgESkGEoTNf3+/rnuRh7eJPcxPoeSPTHZzZFx4kyK61bzS3pGzke1GZDkEfNmyfgvWiNLBb9oBlGWWUFf4BtfBcCRkHvYaBiMoVdf+EQ2bvCYzAu3xv2AiB9CE3fzHz1GVgvfuaQviOpaPn7u8UG73I0Y2GzDMredXrlopuHLvnc6Sn+8fgkBTEkgjBMye+v5VofcgWZBCmsf/RxOGRiGfidOvshg== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=corigine.com; dmarc=pass action=none header.from=corigine.com; dkim=pass header.d=corigine.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=corigine.onmicrosoft.com; s=selector2-corigine-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=omKdlTJ82kXLMfyroOEaD6n+ABoVdP6ZY+mEMrRDnQQ=; b=W/vBwBo0jBgydyQHoPD807xJqxGSL2EnNZBJgp2eavNNFxJTAJWhpOpYJM52s0ifKoD7EuWnVH2W+D3hOKvl0IABIkfR1C12cibkNAel4m0p9RYvomKFQ9hiIqmknzrzMX11lLK/xA85j73v9YRuBhZrDqglTJT3ad0rHEKWR0M= Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=corigine.com; Received: from SJ0PR13MB5545.namprd13.prod.outlook.com (2603:10b6:a03:424::5) by BN0PR13MB4630.namprd13.prod.outlook.com (2603:10b6:408:114::14) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5857.23; Thu, 1 Dec 2022 01:39:01 +0000 Received: from SJ0PR13MB5545.namprd13.prod.outlook.com ([fe80::5122:8c31:51f3:4ee7]) by SJ0PR13MB5545.namprd13.prod.outlook.com ([fe80::5122:8c31:51f3:4ee7%5]) with mapi id 15.20.5857.023; Thu, 1 Dec 2022 01:39:01 +0000 From: Chaoyong He To: dev@dpdk.org Cc: oss-drivers@corigine.com, niklas.soderlund@corigine.com, Chaoyong He Subject: [PATCH] doc: add supported APIs section to nfp guide Date: Thu, 1 Dec 2022 09:38:48 +0800 Message-Id: <20221201013848.19843-1-chaoyong.he@corigine.com> X-Mailer: git-send-email 2.29.3 X-ClientProxiedBy: SJ0PR05CA0124.namprd05.prod.outlook.com (2603:10b6:a03:33d::9) To SJ0PR13MB5545.namprd13.prod.outlook.com (2603:10b6:a03:424::5) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: SJ0PR13MB5545:EE_|BN0PR13MB4630:EE_ X-MS-Office365-Filtering-Correlation-Id: c9d5f4c7-d536-40ba-60a5-08dad33cd2a8 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: ofKukpW4lkzOf3TJpqU/NznbFv0qfjbJ45WevrdOVGrcNiv/tLQ4ZXHJWVmKCbfSUCNbfMLA5VmUm0tKD7KT3ZMxK7VDihzv76Vo4ukTv2PwfPDhQHcB8njT+Sm1qzGmv4YREZpSGqlbpSbBMdHJvNQVbXYkU7ZhJm9nIZ7oOmPRM5kIRer5Bj0xE+fxHnNSaObR5HK1yKiPTjoeN8CCjK6Ibf8m4J0P2Y1jdxOZdG1wkR8ll0VgGvannyq/Hw8V3wygR6HyNuj0lU9KpMtU2A4ZM5gb0sAzTPRPoGQ6vmtcoz5xRMI8YB1o4ZAl8byQTbkK4XNOCrh01BPtik4VNx52WA77SdYuFhk+9Gc8zI2vz+LQyvnT6XoIg1mZP+HrsfIfl+pGX2Rx7Hdv7sqrjWxsW0b9HHI3VC+wUoi/DzdsRcpPL1KAQA5jep4VZk/F9GyWfCkzJ8zu1MoUCT1SSR2WhqyPtVnbJ2hvdBVlV45MCZdaYQb8IpZ4hE7w3B3EjzOj6i+xsIFImSMwS/2F4/R97ZWhE7+F45U+/F2XPJP9sdAoJbrwpp9B/l1RSlc6aC6vPRs9nTV7prZjn07hYCtlCxFdf9W++i4ctX/MpG0cXbnLx12k5kT5NNjCtyhIjTQxZ+wp0ZcE0zKis1xp4KyN0zr9PNsPjheOkSEoAuVFDIyVsb5lxujW+UXHXMoVGskczk4EqeCCHT23PRdsvOlfZcSyqeYHv2tGVbJnBpM= X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:SJ0PR13MB5545.namprd13.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230022)(4636009)(396003)(376002)(346002)(136003)(366004)(39840400004)(451199015)(83380400001)(38100700002)(66476007)(86362001)(6916009)(66556008)(2906002)(6486002)(41300700001)(44832011)(38350700002)(66574015)(107886003)(5660300002)(6506007)(4326008)(26005)(52116002)(6512007)(1076003)(186003)(6666004)(8936002)(2616005)(8676002)(316002)(66946007)(478600001)(36756003); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?q?fOn/spS9GhaDuy8OSLVtK04JEeup?= =?utf-8?q?Asxon6nLb2tUCZ3BzZ+mTGwDJZJ+a+926F4NXNBQ9CjfRmYB+Xe9jS34Y3ZI5lGfO?= =?utf-8?q?7bSXpE6KR8TbnpKXLBjmfVVa7Ev0eOU11/ytQoJb79TFmzP5XV5EF0hdrkhIMdkDs?= =?utf-8?q?sVNYlHcBzLfNJQObp2yXsKsRt7C/Z5dDEweQITPOG/EOHbBWuNL95NN/93ezkX9B/?= =?utf-8?q?D0TkB/rvDjfFEid523zE67ElTbrpqHsRkE5OsNAaKYjXi7hCVOasMRrrtZ+JFG8Kz?= =?utf-8?q?nhPiABKRwvOwkChUL1ezxhIR1A95VRpwTD50jeaujN+8F+cms405FI4v34BmCUtuB?= =?utf-8?q?zI42XXNad1j4osPsofJns/nAvsloA2obaPyPg+UXkT5MB9vMJsv0oPf4whV//qWxn?= =?utf-8?q?9RDnK3/8OG7USuaBTdNUH3aUYRJqA2Z7M40ZBL0r07Ys8UDj+izIv1WAKxf/qh7es?= =?utf-8?q?QoM+8VOrrxy0ZXIGxa6EUFWl6tRpSpgMC3GN6Yj8lSpCxX5tv2ldj/3+gxqLmmer5?= =?utf-8?q?CZjuJXGFNmsZG5qCaIE9syNHQJVtxH3hsL4Sxz2OTyhcfyUI3KElhY6gM10E+AMMM?= =?utf-8?q?cgldMICahvxNbEXytEM28FdRHG3SY5WdBTD4BeyQvz+IymHYzKBWRcDUOLPpIHPla?= =?utf-8?q?sldxtXWclNBqc5XNtGGJJroHM93SROjSKEJRDTwAij+sNNcA7CeAoBtyA3wq4RcsV?= =?utf-8?q?CE9TrS5j+agB54pY8Q8d8pAra8084oeYtkDyf/CX2A8pf9Pf8V7hM7Qly5d+aw8LD?= =?utf-8?q?6EqrxNRfDyMQQ8dIBXfZbfwBCW2jGSVVoNsj/VrJY/sQxY1EyloVSbjtS2sShAJjC?= =?utf-8?q?RbSjRUP9GnmZa4kyZ1gEz0pgN0TYT/DMhxSwPvy0DBsW81SH5ZBOUpEPKDLepGTTo?= =?utf-8?q?gswUh4OGdvVdqZ6Mhp00YX+NLpy7BNK6VSXT8A65nWaWauHBTj9hRBg/CWLisvVRu?= =?utf-8?q?U/FrB21qcE+SZn2oigZiO5U6Q9NyuHeMHVdTTZ3ACfKVj9h0rGi+HgVqcU95yYPFR?= =?utf-8?q?z8ofWpHwDcXax3meGs2QL7RJ18H8kLFcV+grBL00OvFVta/s7pPYk1oCSszQNTO9k?= =?utf-8?q?uA8lzcSJlzOvauSq3rQUVmAmhHM3/LpVkbCy/98yxmDCJtGn42Bepo/1XlRFNH7HR?= =?utf-8?q?8j+bTpPzjcWb6J+ajG3ke59oLgW22W//c+ilBR3snHIxZiLiTroe9ksN2E4Tu4hYM?= =?utf-8?q?+Alc+3nI4SZnFi3BczSXgPYdX2POK1c0lv7poaDS63kcX+bwz2zZ6gRAeweofvq0O?= =?utf-8?q?z1Mwj6azJyKSHnADxzQjinRgJqnRM5g0agXNF5rRGffu2mVLRrjmMFvb0kJmiGKX2?= =?utf-8?q?U5CAgrGVeNTecf2b3o3unLBqpRBiXh0WVQX1G1PfgNXyH5MBltGbAUMKqu7ketD/X?= =?utf-8?q?JZ6iU9MHfSDZyEf0vYL7Kfi1XWVRb/oKpgwJrNI2i7FdsZ9VFDotshm1AC38QC4+2?= =?utf-8?q?e+mXLBdXVWteNxsGTSEJZKgARfo4tW+rhV6FP3rqVTCk+qeP83DWNQvKVz8KrcChq?= =?utf-8?q?/jbJhHyDvZYT+5rZRD+5zYbk4m0knHWHxA=3D=3D?= X-OriginatorOrg: corigine.com X-MS-Exchange-CrossTenant-Network-Message-Id: c9d5f4c7-d536-40ba-60a5-08dad33cd2a8 X-MS-Exchange-CrossTenant-AuthSource: SJ0PR13MB5545.namprd13.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 01 Dec 2022 01:39:01.5076 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: fe128f2c-073b-4c20-818e-7246a585940c X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: /lcZJJLdZunXoKHtQoxbTq8n8BJcPg5aewH8v7BJ1DRa1sGE8Wfrrj618WaaOUMXrD5I8deB6jG/Po4cPiA3WOx9om+Veq8Z4GX3pldn3sI= X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN0PR13MB4630 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Add a new section 'Supported APIs', inculding the supported APIs/items/actions of rte_flow. Signed-off-by: Chaoyong He Reviewed-by: Niklas Söderlund --- doc/guides/nics/nfp.rst | 71 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst index b74067c875..615f7dab9f 100644 --- a/doc/guides/nics/nfp.rst +++ b/doc/guides/nics/nfp.rst @@ -213,3 +213,74 @@ PF vNIC. The ctrl vNIC service handling various control message, like the creation and configuration of representor port, the pattern and action of flow rules, the statistics of flow rules, and so on. + +Supported APIs +-------------- + +rte_flow APIs +~~~~~~~~~~~~~ + +Listed below are the rte_flow functions supported: +* ``rte_flow_ops_get`` +* ``rte_flow_validate`` +* ``rte_flow_create`` +* ``rte_flow_destroy`` +* ``rte_flow_flush`` +* ``nfp_flow_query`` +* ``rte_flow_tunnel_action_decap_release`` +* ``rte_flow_tunnel_decap_set`` +* ``rte_flow_tunnel_item_release`` +* ``rte_flow_tunnel_match`` + +rte_flow Items +~~~~~~~~~~~~~~ + +Refer to "Table 1.2 rte_flow items availability in networking drivers" in +`Overview of Networking Drivers `. + +Listed below are the rte_flow items supported: + +* ``eth`` +* ``geneve`` +* ``gre`` +* ``gre_key`` +* ``ipv4`` +* ``ipv6`` +* ``port_id`` +* ``sctp`` +* ``tcp`` +* ``udp`` +* ``vlan`` +* ``vxlan`` + +rte_flow Actions +~~~~~~~~~~~~~~~~ + +Refer to "Table 1.3 rte_flow actions availability in networking drivers" in +`Overview of Networking Drivers `. + +Listed below are the rte_flow actions supported: + +* ``count`` +* ``drop`` +* ``jump`` +* ``of_pop_vlan`` +* ``of_push_vlan`` +* ``of_set_vlan_pcp`` +* ``of_set_vlan_vid`` +* ``raw_decap`` +* ``raw_encap`` +* ``port_id`` +* ``set_ipv4_dscp`` +* ``set_ipv4_dst`` +* ``set_ipv4_src`` +* ``set_ipv6_dscp`` +* ``set_ipv6_dst`` +* ``set_ipv6_src`` +* ``set_mac_dst`` +* ``set_mac_src`` +* ``set_tp_dst`` +* ``set_tp_src`` +* ``set_ttl`` +* ``vxlan_decap`` +* ``vxlan_encap``