From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 95B734591C; Fri, 6 Sep 2024 10:27:42 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 230D442E12; Fri, 6 Sep 2024 10:27:42 +0200 (CEST) Received: from NAM12-BN8-obe.outbound.protection.outlook.com (mail-bn8nam12on2063.outbound.protection.outlook.com [40.107.237.63]) by mails.dpdk.org (Postfix) with ESMTP id 17D494029E for ; Fri, 6 Sep 2024 10:27:40 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=kg6xoYvmfQ1WbMVy0dUKqjddBomHyjxld184HJCGh5qA6eISkUT6xzpF7WG9SC+eOAmC35XeVoyMvtQcMFbb5i+jY8PiEtoDMqygk4bwih2/r59thFFcqPM8XLuOzyH5XKWq4uOjVthSRzJnSqpUL3+T3b+TRjrY/lKaqZRm81PLyeWj/yO5rKmsiteZsiUi5yF1taS8G15P3cjLcuHU1WEM1xWdk5/m+UEMgR6Vv1cWTjcwHWvau+TuTkH9ygiMFuMbrv/nxEdZixP0LLjXsdrSF5icGTHYYMjsNhKGxx0heJd6sXKnUTSjKxciwHxEvY/KFt9LjBMwHeGPIdjDQw== 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=BLpojcwIgjAe3BwbWt5AF2cn969nTFZGmYprTH5WDUw=; b=nMdjEJEenJt91bEL4OCVKEvV4+d3anWQksW9U3hpfPuhUF7mTcgdCOBTKwFArWhMKxOTF/q9xmNABE2APd7dgr5eTmJndwTuAMA+JiWlNXacI52fbnnc1JFt7rJTHkzXtkgy3g7xomPAMuTYOTrVaycEM6XqUpl4r2kRa4dPnwsgGMaWrPvi+/tUP2Wws0ZqyhIqzw/PVEhwH6VKH79xLE2+7qlWrV49TvpuDF7n+YzedTUNPOAmEG9Q3HTe7un73/2o6snh31dwgQJFBYcNjYpdoh5yFkXdVhQF4l+QiDROZaRtRgYvSNGP7E+D7L1eID2PbaCdSRQpngwKvHoSVQ== 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=BLpojcwIgjAe3BwbWt5AF2cn969nTFZGmYprTH5WDUw=; b=hIAJHR9IZRwGPIzfwwourDLctycDpkuxuc9Zqj3hFy9KcysNYVQY1TYn9dKTSs3YNC6ZyTLF60+tCbvXklfgz7otMpbg8yEHdBDywPMGWrTbBGyR1uXiS/oOvUf82ypBAc1jwuaXno5zk+26En0GfkwNg2G0f7GSCaqLq6lkSOk= 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 PH0PR12MB7472.namprd12.prod.outlook.com (2603:10b6:510:1e9::9) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7918.28; Fri, 6 Sep 2024 08:27:37 +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; Fri, 6 Sep 2024 08:27:37 +0000 Message-ID: <5f8f4577-7143-4b02-a196-63b63d000dd7@amd.com> Date: Fri, 6 Sep 2024 09:27:31 +0100 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH v2] doc: add new driver guidelines To: fengchengwen , Stephen Hemminger , dev@dpdk.org Cc: Nandini Persad , Thomas Monjalon References: <20240814023604.124686-1-stephen@networkplumber.org> <20240814190901.14912-1-stephen@networkplumber.org> Content-Language: en-US From: Ferruh Yigit 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: Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-ClientProxiedBy: LO3P123CA0020.GBRP123.PROD.OUTLOOK.COM (2603:10a6:600:388::17) To CH2PR12MB4294.namprd12.prod.outlook.com (2603:10b6:610:a9::11) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CH2PR12MB4294:EE_|PH0PR12MB7472:EE_ X-MS-Office365-Filtering-Correlation-Id: c3bd355c-ea3c-444b-11b1-08dcce4dc3f5 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0;ARA:13230040|376014|366016|1800799024; X-Microsoft-Antispam-Message-Info: =?utf-8?B?UDJISzRaNUxldzJaSlR2Q1R6Q0lEUzMvd3h2V0ZXKzlDQW5zK1ZxOGZ2alhw?= =?utf-8?B?MXFNbW1EK1oyL1VxNWZFUWhYNEdEZ2wyTUR6cWk4SnAyVkVNVW9VZ3dOOXhS?= =?utf-8?B?MTJTUGhBSGo4VGVVQmtaTEZ0UjlhUE1IT2l4NmtrejN1Yjl2MVRMTGdjVzVS?= =?utf-8?B?QXpVVVhhNjlxVXN0U0JqOHFoK2dBTzdMVHFKZzJ1Z3dMbHFKRCtIc213eGJk?= =?utf-8?B?SWNCV3RiYXQvQXNLTytKcTAxVHBSYzFaVzJqZUowSTJCYTFhcVJxMXJ0NEJq?= =?utf-8?B?SmdxaW10bXNWY3lIOHBpMHFVbzQrQzVMSjl1YlMvRFM3MkhkL1dyTXczSXA0?= =?utf-8?B?NEhKZEtWT1NZWDBFZ05FM0llT2YvRW53b1l4WmFNL2hmNXBPclBRQXJXUHpK?= =?utf-8?B?QTdzV093MVdkZWFFMEN0NDBacmNMbU5zSUlCTE9EVkVlSmM0RUVYQWNvbGdC?= =?utf-8?B?bWh4Z0lvSmZZTFpCUVhKZldvbnRyNG1PTG00SFJpeVc3RG9HczN0aDBxTUhY?= =?utf-8?B?aGFWZnlHYWR0enkrekFIZmt3N3UwK0E5RXB0c3VEVUhoYU9ySEI2WWpUQWRi?= =?utf-8?B?c3FrZHYvTk9wUk1Fd0kxOTRGMVNFVHU3dXJzbVN6ekRQaloweStKVnVaajNy?= =?utf-8?B?UFFnZzdwSzZwckxhQU9KazFPSHVuVmxqUkYwdmEwWlpVZ0JVMHY4TFAzb1hG?= =?utf-8?B?Z3llaE5WOWtxTGxnNTdVZFlYM1d6UG1WeEFCQjRBMzJzMHU0dXJnUUE5bWlS?= =?utf-8?B?T0pDZTZwdm9kS3hnQkgxZnlMNjg1VkxWWFVpOHh4WEY2dXNTY2hRM1l6K3I1?= =?utf-8?B?TFFXWjZheWJCaWVKWUhaYnJkVDh2MjhWWmVySW9vM0ZERDQzZUEweUJMNlhw?= =?utf-8?B?b3BnOVI5Y2VGditHQWV3Z01kd0ZnMHZJdGppOE4wbG1wanEyUjVQVUlqM0JG?= =?utf-8?B?R1VCZ3I5UWU0WCt6dFExRkpqVFFCUXJYTnEvMVAxcXpVY21zYzZUTkYxUS9V?= =?utf-8?B?U0dPNHA2Uzh2UktrR05lVks2d1hoUHUvczBBNWhrK1JmSW1sQjltZmh3djJh?= =?utf-8?B?Y2h4YzBuL05VNzFKMThTR3Vxd2ZHQ3NhUWhIUWRsc25Id09pc25iSkJyUEpF?= =?utf-8?B?VHBIdjN6NWdNSjFpWlhKQnRnR1ArZzFyd08waTloTWpvQllUS3NGSERGNTFp?= =?utf-8?B?UnFSbDd5blVwRi9JVmgvMktTakV4d202Q0dmRXBxTGljL1NMS0xaWXZtQStt?= =?utf-8?B?OHR4SjE0cjcvYVZtVXI5SFdSNUI0ektzYllmS1hucHdNODdob25HM05VRXVR?= =?utf-8?B?NURqY0dtQitWN3grWG5NcG54cGJEZkVqekdBdWJvdzRzVXJnVm9YaU5uM005?= =?utf-8?B?azZGYWJLQmVTWUhjdGdMWmk4Tm90MmcrWE9zUDdTejM5VXc5RS83S1RFSVVB?= =?utf-8?B?SXZua3pZbUlRYUY0QzdIUm04dXJPM2xISGpnd2dlYXNKNk5UK3ROSVBLUUd3?= =?utf-8?B?NUxaMXVLcWlvMmQ4dGYwVWJKZDFvdnRDWWIwM0ZVSCt5eURvUUJqMEh2cEQ0?= =?utf-8?B?ZWJBNFpQV1lwTCs2KzBHZTlWZ1hFSkhWWWJIa3FYM1hhWWUvdnkwaFpFSXpB?= =?utf-8?B?V1k4MHhKTUl6aVhWNmU5RHQ2RkZITDdRaC81VTN1WHlGbGpUMjJLekxLeEl5?= =?utf-8?B?NEpncHBKdEgxRGRIa3o0UFJXY0dveVd1emdER2hPSmpVVnJ5SzQyNU1MUVJ5?= =?utf-8?B?MEM1VWRlaXRaNEJodWJPdi9HOTlaN2FtYWV5OEtTYTI3TzhEUklaMW9mMTNG?= =?utf-8?B?NlV4bDgveVRPUmZteENUdz09?= 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)(376014)(366016)(1800799024); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?Q3FONHkya2MyWUNMZ3JDWlRHdjBJOWVhSVZ3SUJHQUF1VVdLOEdPRVk0S1VH?= =?utf-8?B?ZVRtSGlwK0dQMEVXOENrT3FsK2lFSGpZTFF0NEJRMDJyTUdCT2V2djB4aldV?= =?utf-8?B?T2ZDS215MDlSWlM5eXNlTWo2anVUNUF2ZGVrUHJwc1JrR2c4YlVqdkpNSEpG?= =?utf-8?B?SWo4UUlXNHc5a0NCek82ajJCVmhOSlJBQ3czWERNbUlGRW5SU0ozUWZhS1RW?= =?utf-8?B?R3ljQkJZU005UG8xNzFtOHpKVE01NVdaR0JmZUZDUFE2cEhUN3BNNWxibndq?= =?utf-8?B?QmltUkhVQkZrdWVrLzlzc1prWnJEMzN1UTAvOTkrOWNoTmxHT1JqZ2ZKbWgw?= =?utf-8?B?OHQzcVlFazF1VVMyU3VRZGN0SmhIaW9PNTQ3ZSs0ZG5JYXNVbnYzdDdkVGVp?= =?utf-8?B?aVU5aytmRy9VOE51VmxQVmdzMUgvcFp4R2hZTE1xUytpR05NQTVHVi9HVHhG?= =?utf-8?B?K0RNazFXRndGK1NhQ0VkeVFXRUs5VzRnNDEyU09JdWhtWWM5eEVuanB3Y2FO?= =?utf-8?B?R0dDL1pqTEo4ZzF0Z3BTVUx2NUovY0x2M3RFbmVlN2xsTUtGNUxNemJHbExS?= =?utf-8?B?T1l0VDlsdDVpUytzUEJHd3RvZFFCY3ZTd0tJZGx3WmlQQ1lqN3BZTzk1anFX?= =?utf-8?B?NXJsa1diMEw2WnJKaW1qNTJXcGRsS2xZeEtSb3A2OHdBcnZzZkx4cHdBS01H?= =?utf-8?B?bEdwSkVzSGEwYVhuSi80SkovNWp4TkJiOFE1bTBRSm5DSFhBRFdNU29xSW1I?= =?utf-8?B?RXJkY3F4U2QvcndkaGdHVE9hUDRlNkNLR2pNc0xSNjJaNGJ5OUJDMVJHZXlQ?= =?utf-8?B?WDFubGhqejdQNGFkZEpmckR3K1JvUWkyS3ZPN0xZUCtOTXZHSm5ybXpZTS80?= =?utf-8?B?eEdlMzhCZXJ2N0FYQU9nZWFXYms2QWF4L2RNTW95QVJjU3ZyaFlSTkxZNWZr?= =?utf-8?B?ZkFPQWh6aWJSQ2lKcFY2VTMvTUI0THEwRFNIbjVkemdaVHBlakZ5YUJCSWNo?= =?utf-8?B?ZUJoSWU3TVBMRWlrWk9WKzkwaWJqdklSY1JyT0JEcXNwdkVUenZRT0hGc05P?= =?utf-8?B?cmlYOTJOMXE5MGlWYm1LblUrYS96aENlRGc4WVhMREdWYTBXUVhEMG0weWNM?= =?utf-8?B?V0d1ZXk2SGlhR2twZVg1TmQ3WDZwYmI2OCsya0VUS3l2QzBtZnZteElJY1ps?= =?utf-8?B?WGVEanArSk9YTThEaUtXaWJHcjR5N2c2NUlZNWhjOUhXbEpaVWVkYlJxV1pz?= =?utf-8?B?MTZNemR3V29RMmZUcXZSc3M2SXlQRUlIODF2TmE0eVE5QzE5UEQwQWFXL2Fp?= =?utf-8?B?UUVGLzZoRld1bmNyZC8wdlVkb05SNGM4ZSthb2tXN1RydWIwd0tsS3hzOHZU?= =?utf-8?B?MUU1YzQyQUpYSEl5b2NiaUpsS1lyQTdUQlJEMXFIZkhpZjFVNDdCbTdjZERI?= =?utf-8?B?UGpkR2lId2MzTkt0Y1F3QVZxeWtjTnNqdHJiYzdQT3NzWmJUaGc3Q2cwUlln?= =?utf-8?B?bWNONGp6RWNFTXFZV3k0b1FNWUJ2dXJZcmNQdFU1Q0JHL1lMdXdQMUV3TVp3?= =?utf-8?B?OW53ZHJjcHBtTkltV29rZURiaVlUdEZpM0lxWHhSZHpsQzRjWjJLUi80N2hF?= =?utf-8?B?NFZPMGhaQ0VBa0prWE1SYkJ6UUFaL29SQlFBdytoMnpnWkFwcUdpYjRESkpt?= =?utf-8?B?L0RidXljNUlrWmdpc0hNejhKVUF5WmFtYzRuUnFPa3VlVmpMeWpab0NDL3dX?= =?utf-8?B?akhPVjlISlJWNEpBSGsyRWZwNmdWcFdQd3krSnpLSGsyVHd3dGVpSlBkcUpt?= =?utf-8?B?RUVoSkwxNWtsWUlqRFE5dFFhODExTTNzRWFWUVpIWlh5VXFmSU5oRVNWWG1W?= =?utf-8?B?ZmQ4OHhROXNwazVsVVRmUDByc0JsV21VbHlHNmVaOGVqZmxvR3BpaC9ld0J2?= =?utf-8?B?TVZoajBRT1lYOUFNbjdDNDZTZSt2OHFvcFFiZEZYWWRvdDVja3BudHpIY3dY?= =?utf-8?B?clYrL0MwNUlvZk1KL3VDMHdiUEkrUXNweEpjaElnVUtnTXcyZFg2Vm96UkNN?= =?utf-8?B?ZnkxUWZWVnhoamgvcGlqMXY1a3VNcTlEU1UwT0VrNDc2VXpMTmYxUm1JZ0Nx?= =?utf-8?Q?r0xmQgIZIJv1pNp3Amj2zjtsS?= X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-Network-Message-Id: c3bd355c-ea3c-444b-11b1-08dcce4dc3f5 X-MS-Exchange-CrossTenant-AuthSource: CH2PR12MB4294.namprd12.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 06 Sep 2024 08:27:37.7030 (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: 5Xxy/GHhu6jSMsacWnFutvugYufEu4lH5UwQz30JA9wlrkgcLjFlyTApo2kYavNR X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH0PR12MB7472 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 On 9/6/2024 9:05 AM, fengchengwen wrote: > On 2024/8/15 3:08, Stephen Hemminger wrote: >> From: Nandini Persad >> >> This document was created to assist contributors in creating DPDK drivers >> and provides suggestions and guidelines on how to upstream effectively. >> >> Co-authored-by: Ferruh Yigit >> Co-authored-by: Thomas Monjalon >> Signed-off-by: Nandini Persad >> Reviewed-by: Stephen Hemminger >> --- >> >> 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 >> > > ... > >> + >> +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 >> +---------------------- >> + > > ... > >> + >> + >> +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`) > > The new -> The new > > ... > >> + >> +Additional Suggestions >> +---------------------- >> + >> +* We recommend using DPDK macros instead of inventing new ones in the PMD. >> +* Do not include unused headers. Use the ./devtools/process-iwyu.py tool. >> +* Do not disable compiler warnings in the build file. >> +* Do not use #ifdef with driver-defined macros, instead prefer runtime configuration. >> +* Document device parameters in the driver guide. >> +* Make device operations struct 'const'. >> +* Use dynamic logging. >> +* Do not use DPDK version checks in the upstream code. > > Could you explain it (DPDK version check) ? > It refers usage of 'RTE_VERSION_NUM' macro. This may be required for out of tree drivers, as they may be supporting multiple DPDK version. Not sure adding too much details for sure, what about following update: `* Do not use DPDK version checks (via RTE_VERSION_NUM) in the upstream code.` >> +* Be sure to have SPDX license tags and copyright notice on each side. >> + Use ./devtools/check-spdx-tag.sh >> +* Run the Coccinelle scripts ./devtools/cocci.sh which check for common cleanups such as >> + useless null checks before calling free routines. >> + >> +Dependencies >> +------------ >> + >> +At times, drivers may have dependencies to external software. >> +For driver dependencies, same DPDK rules for dependencies applies. >> +Dependencies should be publicly and freely available, >> +or this is a blocker for upstreaming the driver. > > Could you explain it (what's the blocker) ? > It is trying to say, this prevents upstreaming, wording can be updated to clarify, what about following: `Dependencies should be publicly and freely available to be able to upstream the driver.` >> + >> + >> +.. _tool_list: >> + >> +Test Tools >> +---------- >> + >> +Build and check the driver's documentation. Make sure there are no >> +warnings and driver shows up in the relevant index page. >> + >> +Be sure to run the following test tools per patch in a patch series: >> + >> +* checkpatches.sh >> +* check-git-log.sh >> +* check-meson.py >> +* check-doc-vs-code.sh >> > > Some drivers already provide private APIs, I think we should add note > for "not add private APIs, prefer to extend the corresponding framework API" for new drivers. > Ack. What about adding this to "Additional Suggestions", like following: `Do not introduce public APIs directly from the driver.`