From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <dev-bounces@dpdk.org> Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id B8CDC4590C; Thu, 5 Sep 2024 11:49:23 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 8AEF140264; Thu, 5 Sep 2024 11:49:23 +0200 (CEST) Received: from NAM04-MW2-obe.outbound.protection.outlook.com (mail-mw2nam04on2040.outbound.protection.outlook.com [40.107.101.40]) by mails.dpdk.org (Postfix) with ESMTP id 640DF4025C for <dev@dpdk.org>; Thu, 5 Sep 2024 11:49:22 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=FCzPjWFVkd82mbTLLKUq7aPDvevn0pmMzpRNtmk+rS63nIZV9JEyRObYpVDDCZkr1bGqKyX6ek0ECuKqYwyAVivB9Oqsv6TeHec9hSrR5pdfgMfodOun6bgLRnCkgGqi3fptSmE7XMCKZPfQzOBUPR0xqWaTuhcAN4ZynlHkJ+HnoTqhIP+U1MEdB5HcBcl+wyi2RUngA7xlYKQbHzQi9s+i+ETAw5PjwoaiNE1ef1/gC9TCLzS44zG0wkRAXebOvRydNy0J1McEn6JWqpE8j7fXyEHVTuC7DgqqbEEoph8IAZoULW60vh9XvbMBrDEevCBsz+7+abbUTABi1pcuOQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; 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=Oaypr8iYcjZHBseB/7BZd9CKiYLXCtQ17e5hMPWb6qk=; b=k6kPc7e0akKp8UbO8Hja2RyctCxWf4SZkTkdiSncDY5Nb7VlVfmsJbeT0mjGCyoUvZiJjGz7BX+XvW9l8+s2g9Lio5oXC/iM9kdOVsV3hGLY/NQv3G0f+ZPqYMEBKRqCCeMOh9Wcs2X4oxIdzPKS/EVRCBx4rmAJAvT3MkQiN+d0OGvzKJ6OnFB3etE2d18FXp1WcB87TqeNTld8W0HNj2kNnGKGUVyv7k43Xpt3voVAfU/SRUyTc+BG+oVcLjjuhRLDHxcl2kCVH2OCHHTmz7f2mvIdYL38vH5hyCz5DhuevtdAPlwDRRW482FYbCVqGHSX0t9kU5nZXLFjp606gw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=amd.com; dmarc=pass action=none header.from=amd.com; dkim=pass header.d=amd.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=amd.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=Oaypr8iYcjZHBseB/7BZd9CKiYLXCtQ17e5hMPWb6qk=; b=1Yub+Nu9QnZKZKAOdoSrlIbBc2vCWlR/CWVOdqRrRN1kVqo2XQfe+tgZkAsj9E0xnYoE2ptSlS8ITjRoupatQR86gNmSVOUOLBumUmwIOC3I/D/Qa4FzCE7/hvDAQeQpqoOvtUxcU52ddE0yuEkuC8DNxOGC4mQun7q4/MXGIdQ= Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=amd.com; Received: from CH2PR12MB4294.namprd12.prod.outlook.com (2603:10b6:610:a9::11) by MW4PR12MB6951.namprd12.prod.outlook.com (2603:10b6:303:209::18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7918.25; Thu, 5 Sep 2024 09:49:18 +0000 Received: from CH2PR12MB4294.namprd12.prod.outlook.com ([fe80::ebfb:2f9f:f9ca:82cd]) by CH2PR12MB4294.namprd12.prod.outlook.com ([fe80::ebfb:2f9f:f9ca:82cd%4]) with mapi id 15.20.7918.019; Thu, 5 Sep 2024 09:49:18 +0000 Message-ID: <aa0ee9df-68ec-4562-9f9a-d7dd2a6665c2@amd.com> Date: Thu, 5 Sep 2024 10:49:13 +0100 User-Agent: Mozilla Thunderbird Subject: Re: [EXTERNAL] [PATCH v2] doc: add new driver guidelines To: Akhil Goyal <gakhil@marvell.com>, Stephen Hemminger <stephen@networkplumber.org>, "dev@dpdk.org" <dev@dpdk.org> Cc: Nandini Persad <nandinipersad361@gmail.com>, Thomas Monjalon <thomas@monjalon.net> References: <20240814023604.124686-1-stephen@networkplumber.org> <20240814190901.14912-1-stephen@networkplumber.org> <CO6PR18MB44848BCE6933AC04E996C656D89D2@CO6PR18MB4484.namprd18.prod.outlook.com> Content-Language: en-US From: Ferruh Yigit <ferruh.yigit@amd.com> Autocrypt: addr=ferruh.yigit@amd.com; keydata= xsFNBGJDD3EBEAC/M7Tk/DfQSmP1K96vyzdhfSBzlCaGtcxNXorq4fALruqVsD3oi0yfyEz9 4YN8x7py0o9EL8ZdpOX0skc0AMCDAaw033uWhCn0GLMeGRKUbfOAPvL6ecSDvGD7CJIO9j0J eZUvasBgPdM/435PEr9DmC6Ggzdzt8IuG4PoLi5jpFSfcqxZFCCxLUDEo/w0nuguk2FTuYJg B2zEZ4JTBZrw7hIHiFh8D8hr6YA6a5uTofq1tr+l048lbtdFUl8TR0aIExVzE4Z8qKZlcE+9 RQaewjK5Al1jLE4sHdmd3GN+IvgDF3D/fLsi25SKJDeGSdeHkOmaX0qGeM4WKIfU6iARRCiQ N3AmBIxZ/A7UXBKLaOyZ+/i3sE6Wb53nrO4i8+0K2Qwyh6LjTeiJAIjYKN43ppxz3DaI+QwQ vI+uyHr4Gg0Da9EPPz/YyKauSeOZCfCB5gIfICO0j6x0SCl8uQ2nLpjxcZkf0gjcwUzP3h+S 3x6NfDji9YEij0zczW/dcSpGgZ6vsFpPrtnP9ZXy6J53yp0kJtOJoOlkEFFdU2yCZnCDseum CoudmGLZVvS0/DzHDJejq+3kK3FDGktZBOxZIIpal+nFqS7lVgOZc4+huVv3jyhzoAUOEyXA XK5j6o7g8STUY+z33QNnHpdLvecMwuzmvqy0jR54yAbZ64mB9QARAQABzSNGZXJydWggWWln aXQgPGZlcnJ1aC55aWdpdEBhbWQuY29tPsLBlwQTAQgAQQIbAwULCQgHAgYVCgkICwIEFgID AQIeAQIXgAIZARYhBEm7aYjps5XGsPHCElRTPtCKKm/6BQJkdyEEBQkE3meNAAoJEFRTPtCK Km/6UdcP/0/kEp49aIUhkRnQfmKmNVpcBEs4NqceNCWTQlaXdEwL1lxf1L49dsF5Jz1yvWi3 tMtq0Mk1o68mQ7q8iZAzIeLxGQAlievMNE0BzLWPFmuX+ac98ITBqKdnUAn6ig5ezR+jxrAU 58utUszDl16eMabtCu76sINL5izB8zCWcDEUB4UqM8iBSQZ7/a7TSBVS0jVBldAORg1qfFIs cGMPQn/skhy3QqbK3u3Rhc44zRxvzrQJmhY6T1rpeniHSyGOeIYqjpbpnMU5n1VWzQ4NXvAD VDkZ4NDw6CpvF4S2h2Ds7w7GKvT6RRTddrl672IaLcaWRiqBNCPm+eKh4q5/XkOXTgUqYBVg Ors8uS9EbQC/SAcp9VHF9fB+3nadxZm4CLPe5ZDJnSmgu/ea7xjWQYR8ouo2THxqNZtkercc GOxGFxIaLcJIR/XChh9d0LKgc1FfVARTMW8UrPgINVEmVSFmAVSgVfsWIV+NSpG9/e90E4SV gMLPABn1YpJ8ca/IwqovctqDDXfxZOvCPOVWTzQe/ut767W+ctGR1kRkxWcz470SycOcY+PW VRPJd91Af0GdLFkwzZgNzkd6Gyc9XXcv4lwwqBLhWrBhqPYB0aZXIG1E/cVTiRp4dWpFHAFD DcuLldjIw93lCDsIeEDM9rBizGVMWEoeFmqSe7pzGTPXzsFNBGJDD3EBEAC8fBFQHej8qgIG CBzoIEd1cZgPIARlIhRudODXoNDbwA+zJMKtOVwol3Hh1qJ2/yZP11nZsqrP4fyUvMxrwhDe WBWFVDbWHLnqXMnKuUU1vQMujbzgq/4Rb9wSMW5vBL6YxhZng+h71JgS/9nVtzyaTtsOTrJi 6nzFSDx6Wbza2jYvL9rlK0yxJcMEiKwZQ/if4KcOesD0rtxomU/iSEv6DATcJbGXP6T93nPl 90XksijRKAmOwvdu3A8IIlxiSSVRP0lxiHOeR35y6PjHY2usfEDZZOVOfDfhlCVAIBZUZALv VmFOVSTYXeKgYa6Ooaf72+cHM3SgJIbYnevJfFv8YQW0MEAJ/IXE7B1Lk+pHNxwU3VBCrKnA fd/PTvviesuYRkrRD6qqZnINeu3b2DouVGGt2fVcGA38BujCd3p8i7azoGc7A6cgF7z9ETnr ANrbg1/dJyDmkDxOxVrVquTBbxJbDy2HaIe9wyJTEK2Sznpy62DaHVY+gfDQzexBXM10geHC IIUhEnOUYVaq65X3ZDjyAQnNDBQ4uMqSHZk8DpJ22X+T+IMzWzWl+VyU4UZXjkLKPvlqPjJk 1RbKScek5L2GhxHQbPaD76Hx4Jiel0vm2G+4wei8Ay1+0YRFkhySxogU/uQVXHTv63KzQMak oIfnN/V2R0ucarsvMBW+gwARAQABwsF8BBgBCAAmAhsMFiEESbtpiOmzlcaw8cISVFM+0Ioq b/oFAmR3IPsFCQTeZ44ACgkQVFM+0Ioqb/qINhAAtcor9bevHy22HvJvXX17IOpPSklZJAeQ Az43ZEo5kRlJ8mElc2g3RzYCvL/V3fSiIATxIsLq/MDtYhO8AAvklxND/u2zeBd7BkRZTZZX W1V1cM3oTvfx3LOhDu4f2ExQzCGdkzbXTRswSJIe1W0qwsDp+YPekbrsKp1maZArGeu+6FuW honeosIrWS98QJmscEhP8ooyJkLDCCOgEk+mJ/JBjzcJGuYn6+Iy/ApMw/vqiLGL1UWekcTA g18mREHqIR+A3ZvypIufSFB52oIs1zD/uh/MgmL62bY/Cw6M2SxiVxLRsav9TNkF6ZaNQCgn GqifliCEMvEuLZRBOZSYH2A/PfwjYW0Ss0Gyfywmb2IA990gcQsXxuCLG7pAbWaeYazoYYEQ NYmWatZNMAs68ERI2zvrVxdJ/fBWAllIEd0uQ4P05GtAHPdTIDQYp545+TPV7oyF0LfXcsQs SFVZE6igdvkjfYmh+QOrHGZvpWXLTmffVf/AQ81wspzbfxJ7sYM4P8Mg5kKOsaoUdyA/2qVe cMh1CLUHXF1GlofpGbe1lj4KUJVse5g3qwV7i9VrseA8c4VIZewdIjkzAhmmbxl+8rM/LKBH dZUMTzME5PFCXJIZ83qkZQ795MTe2YScp9dIV7fsS5tpDwIs7BZNVM1l3NAdK+DLHqNxKuyO 8Zk= In-Reply-To: <CO6PR18MB44848BCE6933AC04E996C656D89D2@CO6PR18MB4484.namprd18.prod.outlook.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-ClientProxiedBy: LO4P123CA0393.GBRP123.PROD.OUTLOOK.COM (2603:10a6:600:18f::20) To CH2PR12MB4294.namprd12.prod.outlook.com (2603:10b6:610:a9::11) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CH2PR12MB4294:EE_|MW4PR12MB6951:EE_ X-MS-Office365-Filtering-Correlation-Id: 0ea03940-a4e9-49c9-e463-08dccd900259 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0;ARA:13230040|1800799024|376014|366016; X-Microsoft-Antispam-Message-Info: =?utf-8?B?OEtNbXBsdnNGdXlBNHFYM3ZaN29lUGZZZlAxaG9CQXZtS0xwa3pYR3ljRzR4?= =?utf-8?B?S1JuZU5DaXBQZXF6bU9aa0RDR1llYlRDbmV5bTE1M2VIcENJQk1HR29wTFVL?= =?utf-8?B?c2w1ZmVUbE9uRmNOd1hMV1cxV1MrYXBQSUJub21ZbGJUNTN4QW9ZSDhFMmU2?= =?utf-8?B?V0dyY3FHMEZUZnVpR1NJR0diZVhrSGY5MjlkS2VwZm4yODgrT0NEb3FOTUd3?= =?utf-8?B?Vm50RGljYkRBaFM1MWNUTjVWSUtjYVVKU2lyQlBwakduQTNTLzR4dzF3NG5a?= =?utf-8?B?WHJTa1E5MG5KSGRRbkZITitVSnEydytmQmhzUjRKcGpLdjlLOFJSdFg0MUNT?= =?utf-8?B?UVRhVlBWeGJiSlI5U01OWlNuMURvWDJxcVZEamQ0a1lwczFGZm5DZzg0d1V3?= =?utf-8?B?TlQ3TXlGZXorOUtRdkN3akVYTHhjdlg0TnJWWDlRNUFwWUhybXIvWlpnR0R0?= =?utf-8?B?dnBEaWx6RlpROEpzTUFHOFhYbVA4T29nRFlDMHVZTlZscXRJVk9OZ2Rjd0ti?= =?utf-8?B?a3daby9tQ2ZURFAwWlNMdXJjZlVqV3dJMk53bUhDWjBZT1VCWmF5eEFmL29F?= =?utf-8?B?aGNaVzQyT05pRGU5RjdNekkxN0Zkd2oxVnVuSDNTZWROUlJJN1I2SjFWUHRQ?= =?utf-8?B?RnRnTnpyMVZ2anFpNHdPWVNxTlZibUdlTTRuWXJJN2Y2Y1Z3YzM4K0ZlQlNk?= =?utf-8?B?RVhwNTYyZ3dCSlBwU09EMWYyUXAvVDlFdjYyV3phK0ZzcW1sZkNCZzdnZExp?= =?utf-8?B?YlhKbzcxUGV4T0VmMHo4Q3c0VmlKc3Y0WFhCeGhZaDV2ZGlqSlJabFl2Y2VE?= =?utf-8?B?aHo3dVBKZG92ZmhPRXZHL0ZYZW5WREMwOFNpa1drQlFCK1FuaGhiQzd5cUNS?= =?utf-8?B?QnV4cStsSUdQb3BZMERQalY3RFlWamUwNjAzUUduQU9ZTkpQaFVtSlFjaDB4?= =?utf-8?B?a0o1UllJeFZ0cVVoNkJqaXNMODZmUkNxZmdxWTZRZHpYQklucUpDcVJKOUNG?= =?utf-8?B?Yi9ZbFpqSi9LMmJyWW9oa3lhcXB5WHlyRUZyUlBSTzRDbnB3WCtLVTU0VWI1?= =?utf-8?B?a3N1WmpUcHJDZGpIRDMzTld5dmlRNExqdGxNR1J4UG0zSW5nZ096SEdRK29L?= =?utf-8?B?aWlKdUZTRVBNQklCMHNpL1hPczZVczhHU20ydUJscGFobTk5cW9FSi9JcGJt?= =?utf-8?B?UG5RemdmUmNvOFp1UTM0WTBWaG5EUHpQNTZYalQrc3BCQTRXOEFtS0drNExz?= =?utf-8?B?bllMRG03TGhvbTNvTzVVdDdIMmNVaExVMktKK2dUc1hFd2k5NlRWbElVcE1M?= =?utf-8?B?MFlDcjR1am1QSEo1QWM2SmNxNU9QZXVpMDJHZGJvbW0zZEdGb3hLYWE4d05q?= =?utf-8?B?Ty9yUjJOVVFLVTZtR0IrUjNoL05wVkV5akRTUXpvZm1xMTJjY1djbisxZnBW?= =?utf-8?B?d1U0SXFVek5kcVJiQ3dqRW5CMUhncU93YmFqQXRXdFFtWi83cjRHczUyVEVs?= =?utf-8?B?dlI2SU1TQVRCOHNmS1k1bEx1TDN4Z2NscXhmaUY3bFlwMUJSU1ZLSmUxM1VN?= =?utf-8?B?RUs0NUhMOW5mSHM4NlAzNWRua2ZNZE1rMDdMYUdiejRuUi9lallDQk9FWStW?= =?utf-8?B?T0U0RUV3V051VUZrb2h2VkhuajB6amh5alE2MHc1Q0lGVzZ2aWpmQU8rNjZS?= =?utf-8?B?NS9pVFlaRENHNXh6WDBCOFhLU29nWGhyMmh1cklmQUp2QUdrMVJVR2NyVmk3?= =?utf-8?B?QUFUTXQ0eEVUOWxPZEdnbW5YajdqWU5JY2kwbFMxMUN5YkVHQ1kzV0hiNXJv?= =?utf-8?B?cWpCdUF4RlBlQnZYdFRMQT09?= X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:CH2PR12MB4294.namprd12.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230040)(1800799024)(376014)(366016); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?MWlIMDdOaVZjTlhYT0ZXL1JId2tPNGdTTURLWWdWM0tjQzZ1VEN4ZHVzNnRK?= =?utf-8?B?R3NrUDJZeDdWeUhFWTd6UWNGSzlNV0VMbXFBbThXMHo2RXdvY1U2dHdPOVB4?= =?utf-8?B?OGN6dUV2MThvU0IyRkVET1BjQUZ4aFR1ZS96ZVVidGExNzFUQnU3Q2VwL2xP?= =?utf-8?B?K1Q3cDBGQSttaHJIczBhdjY5b2J5WDdpbkZjY3U3UmVTaUpnZVNuTkhldCtw?= =?utf-8?B?V2lkaUJIaHRhcUQrM05Kc1pJMjljZEpMUnZlMWlIcVRVeU55MDhBVkhuK0Yx?= =?utf-8?B?aUw2ZzNyaGt5VTBmdldLZ2RaNzd4WEdTRHpCRE05OWk5dlhKNk9RYjFLa3lo?= =?utf-8?B?TjN3Um5RWS9JNURpQnM5NTRjQlpnNlZBTUdUWGowV21POGlPMEVxT3hETTdT?= =?utf-8?B?U1NpQzkvWVpiVFptTVVoMzBuMFcwbnVZbXRlV0pLVnU5Q0FIKzJYK3RoRzhi?= =?utf-8?B?Q0JJelI0TzhHWGhkSWZUdE5LdCs1Vk9SbitGS1JRNVhDUEYxZjREeXlMNDYr?= =?utf-8?B?ckhuZGFYYWduaUEvUWs3NnpvdEhNRXVOT3hEMXMzT2pZbnhWTmZQMWFsVmIy?= =?utf-8?B?WnRPdTJaMjFLOEV1bE1PSVdSbnMxTG9xaFJWNENzRFpJWUNCcTNJRXhka0dh?= =?utf-8?B?SGFFQWxKa3hIbVR4OEJrTFpzaXpmOUVwK2VyaUdtZ3NKZzBNbEwxci9vUXVK?= =?utf-8?B?dUFTOVZtRE5jZzZsYkpEb0l4K3g4b283a01uUnA2RWVabkNERGFLSU94Q29r?= =?utf-8?B?WC9HQkFqMVUzRG1vN3hodzVrSW94b2R2SDQzWnlXUFp4TVhnV3FvTnh1UkFT?= =?utf-8?B?Y3pxQTBNM25WMGlxSlh1dTF3L3JIVjRObXFzUmt2V2NvdHovaGNvdllsdHpp?= =?utf-8?B?U1BkL1FFZ3hyeTYxWkd2VWEzYkR5aHQ4NEIvSGFBeGNBbFRiRVlpNkw1Qmxt?= =?utf-8?B?a3hGYmJ6dzVURTgwN3d1Rk14NDdlYzE5UUhtT3RZWm0zWmJhRmZpbmF5c3Bw?= =?utf-8?B?Ui9JdEFOZ2dCUVlNT3VLdFpqRWRobnlmZ0laMUNrcjE1SlN3dkp2RnhaVWJR?= =?utf-8?B?Uk1wczhVWHhlVDYwdFlrQ2J4aEYyOWVKSzhRbmpTV1ljNHZlRDJ4MmZ6Q1dX?= =?utf-8?B?azBUMGlwMEtnejN2YysxMWZJc2pTR3NzLzRadTBmYnlSSE9xazdObklrMURL?= =?utf-8?B?R1NSUk1FdTNJaTFobHBlckc2S2dvNjJtejVPcVMzekpoVHlnQXdscy9VUVoz?= =?utf-8?B?SnVXVk1NcXUxQWlNZUdRZzYxQ2c5MVR5UU5rNU54Z3hYWFJENVUyaVBFSFFU?= =?utf-8?B?amtXZE5NSmJTKytvbmhDYmZpNVphdWt2aG5VT0ZLMkxhbnpHNjVIZGRpczJ5?= =?utf-8?B?RkNqRVRGdXB5cktqcXRBWHdvQXUxR05LYm9iRlNKSG5Pa0U4MXVRR25vemww?= =?utf-8?B?R2tuSjNYaUg4aDEybjJDSGZwNXRFWEN1bVNKRDZONXhHVFVncEJzVnBOQTBG?= =?utf-8?B?V2xxalYwUEdCUjhzOHZVTmg0U0EwSmhqcEhuY1F0aU82SWd4VkdqQmprM1pl?= =?utf-8?B?TzR3YS9GYWYzNkF0NGpOOERmdkFIeFZLd1V4U0JOMWcxQkJld254U0dLcnJP?= =?utf-8?B?YWJDd0M1THJtOWJLNlMrTjdoREgrTUFOcnpnMU9HV09IZUpmOW9zWEw4SWY2?= =?utf-8?B?K0ZiYVczbGlXbFhxNXBhWGxsQUtaVVZyU0xzTFA1eTZtU1o3ZUdHcVpKalBz?= =?utf-8?B?cWc0TU8xTEk5RTlUYkpYb05GVXN1OGFhRDVkdWloS3FYMjRHUXRKMEY2NE1o?= =?utf-8?B?bXBYVXBVMnpOOUpFdTJ4WUhYRWlDaVNSZEpabXJ0eTJjOCtOZkQ2OVdWbjJ0?= =?utf-8?B?U3c4STlYV2NuWEdSaXd4Vmc3bzN6WVlyZDZjb1E3STBjNFFMU25Ga3hzSWln?= =?utf-8?B?TjJQT3gwcW1jSUNSZSsvMkhadEx0aXNlSnNESU5BTXIvd3B0emdNYk44MWlR?= =?utf-8?B?TjhqMjFXbFAxcVBXelowTUQrMnNQQWI4WCtza1NmWjhoMElkYVNnSlQzSnBj?= =?utf-8?B?L2ZSL1FvNzhhYXpsYUhQUmNsU2E4WkJ4WHB4QmZORTdaS3B0SnF2M2hkdzNt?= =?utf-8?Q?lONCoJLPMqAWpgmslnBd+G7/J?= X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-Network-Message-Id: 0ea03940-a4e9-49c9-e463-08dccd900259 X-MS-Exchange-CrossTenant-AuthSource: CH2PR12MB4294.namprd12.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Sep 2024 09:49:18.0059 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: 9WeibQAxHBN1O4OODSEMWTRgNDYFOEm8eEjCXW9QeL+14D1IdLVKVApoz1NCWRnY X-MS-Exchange-Transport-CrossTenantHeadersStamped: MW4PR12MB6951 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions <dev.dpdk.org> List-Unsubscribe: <https://mails.dpdk.org/options/dev>, <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>, <mailto:dev-request@dpdk.org?subject=subscribe> Errors-To: dev-bounces@dpdk.org On 9/5/2024 10:16 AM, Akhil Goyal wrote: > Few crypto specific suggestions. > >> >> v2 - review feedback >> - add co-author and reviewed-by >> >> doc/guides/contributing/index.rst | 1 + >> doc/guides/contributing/new_driver.rst | 202 +++++++++++++++++++++++++ >> 2 files changed, 203 insertions(+) >> create mode 100644 doc/guides/contributing/new_driver.rst >> >> diff --git a/doc/guides/contributing/index.rst b/doc/guides/contributing/index.rst >> index dcb9b1fbf0..7fc6511361 100644 >> --- a/doc/guides/contributing/index.rst >> +++ b/doc/guides/contributing/index.rst >> @@ -15,6 +15,7 @@ Contributor's Guidelines >> documentation >> unit_test >> new_library >> + new_driver >> patches >> vulnerability >> stable >> diff --git a/doc/guides/contributing/new_driver.rst >> b/doc/guides/contributing/new_driver.rst >> new file mode 100644 >> index 0000000000..4aa1fd1d05 >> --- /dev/null >> +++ b/doc/guides/contributing/new_driver.rst >> @@ -0,0 +1,202 @@ >> +.. SPDX-License-Identifier: BSD-3-Clause >> + Copyright 2024 The DPDK contributors >> + >> + >> +Upstreaming New DPDK Drivers Guide >> +================================== >> + >> +The DPDK project continuously grows its ecosystem by adding support for new >> devices. >> +This document is designed to assist contributors in creating DPDK >> +drivers, also known as Poll Mode Drivers (PMD's). >> + >> +By having public support for a device, we can ensure accessibility across various >> +operating systems and guarantee community maintenance in future releases. >> +If a new device is similar to a device already supported by an existing driver, >> +it is more efficient to update the existing driver. >> + >> +Here are our best practice recommendations for creating a new driver. >> + >> + >> +Early Engagement with the Community >> +----------------------------------- >> + >> +When creating a new driver, we highly recommend engaging with the DPDK >> +community early instead of waiting the work to mature. >> + >> +These public discussions help align development of your driver with DPDK >> expectations. >> +You may submit a roadmap before the release to inform the community of >> +your plans. Additionally, sending a Request for Comments (RFC) early in >> +the release cycle, or even during the prior release, is advisable. >> + >> +DPDK is mainly consumed via Long Term Support (LTS) releases. >> +It is common to target a new PMD to a LTS release. For this, it is >> +suggested to start upstreaming at least one release before a LTS release. >> + >> + >> +Progressive Work >> +---------------- >> + >> +To continually progress your work, we recommend planning for incremental >> +upstreaming across multiple patch series or releases. >> + >> +It's important to prioritize quality of the driver over upstreaming >> +in a single release or single patch series. >> + >> + >> +Finalizing >> +---------- >> + >> +Once the driver has been upstreamed, the author has >> +a responsibility to the community to maintain it. >> + >> +This includes the public test report. Authors must send a public >> +test report after the first upstreaming of the PMD. The same >> +public test procedure may be reproduced regularly per release. >> + >> +After the PMD is upstreamed, the author should send a patch >> +to update the website with the name of the new PMD and supported devices >> +via the DPDK mailing list.. >> + >> +For more information about the role of maintainers, see :doc:`patches`. >> + >> + >> + >> +Splitting into Patches >> +---------------------- >> + >> +We recommend that drivers are split into patches, so that each patch represents >> +a single feature. If the driver code is already developed, it may be challenging >> +to split. However, there are many benefits to doing so. >> + >> +Splitting patches makes it easier to understand a feature and clarifies the >> +list of components/files that compose that specific feature. >> + >> +It also enables the ability to track from the source code to the feature >> +it is enabled for and helps users to understand the reasoning and intention >> +of implementation. This kind of tracing is regularly required >> +for defect resolution and refactoring. >> + >> +Another benefit of splitting the codebase per feature is that it highlights >> +unnecessary or irrelevant code, as any code not belonging to any specific >> +feature becomes obvious. >> + >> +Git bisect is also more useful if patches are split per patch. >> + >> +The split should focus on logical features >> +rather than file-based divisions. >> + >> +Each patch in the series must compile without errors >> +and should maintain functionality. >> + >> +Enable the build as early as possible within the series >> +to facilitate continuous integration and testing. >> +This approach ensures a clear and manageable development process. >> + >> +We suggest splitting patches following this approach: >> + >> +* Each patch should be organized logically as a new feature. >> +* Run test tools per patch (See :ref:`tool_list`:). >> +* Update relevant documentation and <driver>.ini file with each patch. >> + >> + >> +The following order in the patch series is as suggested below. >> + >> +The first patch should have the driver's skeleton which should include: >> + >> +* Maintainer's file update >> +* Driver documentation >> +* Document must have links to official product documentation web page >> +* The new document should be added into the index (`doc/guides/index.rst`) >> +* Initial <drive>.ini file >> +* Release notes announcement for the new driver >> + >> + >> +The next patches should include basic device features. >> +The following is suggested sample list to include in these patches: >> + >> +======================= ======================== >> +Net Crypto >> +======================= ======================== >> +Initialization Initialization >> +Configure queues Configure queues >> +Start queues Start queues >> +Simple Rx / Tx Simple Data Processing >> +Statistics Statistics >> +Device info >> +Link interrupt >> +Burst mode info >> +Promisc all-multicast >> +RSS >> +======================= ======================== > > For crypto, > Initialization > Configure queues > Configure sessions > Add capabilities. > Statistics and device info > Simple data processing > >> + >> + >> +Advanced features should be in the next group of patches. >> +The suggestions for these, listed below, are in no specific order: >> + >> +============================= >> +Net >> +============================= >> +Advanced Rx / Tx >> +Scatter Support >> +Vector Support >> +TSO / LRO >> +Rx / Tx Descriptor Status >> +RX / Tx Queue Info >> +Flow Offload >> +Traffic Management/Metering >> +Extended statistics >> +Secondary Process Support >> +FreeBSD / Windows Support >> +Flow control >> +FEC >> +EEPROM access >> +Register Dump >> +Time Synchronization, PTP >> +Perf documentation >> +============================= >> + > > ============================= > Crypto > ============================= > Chained operations > Scatter Gather > Security protocols - IPsec, MACsec etc. > Asymmetric crypto > >> + >> +After all features are enabled, if there is remaining base code that >> +is not upstreamed, they can be upstreamed at the end of the patch series. >> +However, we recommend these patches are still split into logical groups. >> + >> + >> +Additional Suggestions >> +---------------------- >> + > .ini file shall be updated for each of the new feature added in the same patch as code. > This is mentioned above as: "Update relevant documentation and <driver>.ini file with each patch."