From patchwork Fri Oct 12 16:35:52 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexandru-Cosmin Gheorghe X-Patchwork-Id: 10638853 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id B7385157A for ; Fri, 12 Oct 2018 16:36:28 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id A5C712BEEE for ; Fri, 12 Oct 2018 16:36:28 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 98E9A2BF8D; Fri, 12 Oct 2018 16:36:28 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.2 required=2.0 tests=BAD_ENC_HEADER,BAYES_00, MAILING_LIST_MULTI,RCVD_IN_DNSWL_MED autolearn=ham version=3.3.1 Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 376582BEEE for ; Fri, 12 Oct 2018 16:36:28 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id CD44A6E4C4; Fri, 12 Oct 2018 16:36:26 +0000 (UTC) X-Original-To: dri-devel@lists.freedesktop.org Delivered-To: dri-devel@lists.freedesktop.org Received: from EUR04-VI1-obe.outbound.protection.outlook.com (mail-eopbgr80071.outbound.protection.outlook.com [40.107.8.71]) by gabe.freedesktop.org (Postfix) with ESMTPS id 2B4D16E4C4 for ; Fri, 12 Oct 2018 16:36:25 +0000 (UTC) Received: from e114479-lin.cambridge.arm.com (217.140.106.51) by AM5PR0802MB2545.eurprd08.prod.outlook.com (2603:10a6:203:a0::21) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.1228.24; Fri, 12 Oct 2018 16:36:22 +0000 From: Alexandru Gheorghe To: seanpaul@chromium.org, airlied@linux.ie, dri-devel@lists.freedesktop.org, liviu.dudau@arm.com, brian.starkey@arm.com, malidp@foss.arm.com, gustavo@padovan.org, maarten.lankhorst@linux.intel.com, ayan.halder@arm.com, daniel.vetter@ffwll.ch, raymond.smith@arm.com, david.garbett@arm.com, lisa.wu@arm.com, matt.szczesiak@arm.com, charles.xu@arm.com, james.qian.wang@arm.com Subject: [PATCH v4 1/9] drm: fourcc: Convert drm_format_info kerneldoc to in-line member documentation Date: Fri, 12 Oct 2018 17:35:52 +0100 Message-Id: <20181012163600.20331-2-alexandru-cosmin.gheorghe@arm.com> X-Mailer: git-send-email 2.18.0 In-Reply-To: <20181012163600.20331-1-alexandru-cosmin.gheorghe@arm.com> References: <20181012163600.20331-1-alexandru-cosmin.gheorghe@arm.com> MIME-Version: 1.0 X-Originating-IP: [217.140.106.51] X-ClientProxiedBy: CWLP265CA0200.GBRP265.PROD.OUTLOOK.COM (2603:10a6:401:4e::20) To AM5PR0802MB2545.eurprd08.prod.outlook.com (2603:10a6:203:a0::21) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 773b4742-aa2a-4d84-dcfa-08d63060d8a2 X-MS-Office365-Filtering-HT: Tenant X-Microsoft-Antispam: BCL:0; PCL:0; RULEID:(7020095)(4652040)(8989299)(4534185)(4627221)(201703031133081)(201702281549075)(8990200)(5600074)(711020)(4618075)(2017052603328)(7153060)(7193020); SRVR:AM5PR0802MB2545; X-Microsoft-Exchange-Diagnostics: 1; AM5PR0802MB2545; 3:2oKQMGAj1OtwmUiL1enMbDp2/EYz15C7H2dDJbJh7EJUs0+NRQE6tsXLXU6nBAxxlk2kxlpPrrz7VFa7C5VIj6itz0/rNuWAYyU2xXpDUKYXwACs46QHQZvESrKWrZCgrl1r2lXFBAkPagE+iPrrnedGAEZ+JV4BvF9C6ZeLEuh5rcXWOwn8Fo1cZxRhD5AQbd5bDERbIfMXMYn0HFJACQMgC+T/i6M4+KV6GqpZV7459ufO757JeAwro8DGJN8q; 25:awcGCN+5x5CSaEphWxHb9uMuyqzPPWli8ypP5tw5YCQSgqz20agbB/WmfxXaxQskacjPOKsfI6yYquYlSW6WZlz2v/WDcyaxWHCDglcmF25C+Zahvc5QCKv47MXfhU4vstNbyNNywdZp2lfk/Rr7ejEKwmF5YEia6SO1/4iQVdXkiHu2EkRFQ02/by+C0FWj+8+Mgip1ND2tdjddoiICa+OewDH5cqLau4PytNfdbOzLYmJLFm3YWkm63plGmIZhL8tzcZCqpAWtI59OiIZ56O5njLygks1IIUKHhX2+lafsHaV39Ln7iP7eRT1X58J6bjsgUi6P4W1FcEqH/DjU3w==; 31:OHCzJ4wXg07u1n13gZ9sn+yKMp8fUGwoCeMxD97gpZ4a5RahOgT31PRnDhzLmVCEA8kr3wAdIflSgtiXidATK+GM4UbUUgl+YLAaf9+ii50t9Bt3t55mCcS4STedRiW/18nxqVc9xDxuUyIhtKU+ohlbYINLi4AVsFz0huZ4saA3jrRZMNNbxL+sDR38Z55xAInLmaFWE43B6q6ak8iMlDmFRm61wg9LoKVKwrhHT0Y= X-MS-TrafficTypeDiagnostic: AM5PR0802MB2545: NoDisclaimer: True X-Microsoft-Exchange-Diagnostics: 1; AM5PR0802MB2545; 20:GH0Pe1K39XK5uR7wHTAt4gj0c22lmYcSjAHHuTjaH0CBktMP1lqfH29o+f1DaV6PsP6+Dn/EKnFuETUK8S8OqaDPtceag4tVOU9Hw0ZPkN2/D7C38YdL4PUUFcP5tYHf2TwlitywoujB2CPG1IDlwwAi56oJxiy7xXajaWU/YqKeLNLG0oKOtVxVtz5ldRdq46Kg1Cnlz0jSAuPtdEWO9grvYCX3H8UrwY+BA8Ln2pt8/jAyaxsWK6/qRh/k/gy+U/FuIeMu2CxBib14/C1QqUu7jRExQyeKvMwft6YopAj/vGegV/XeNl3m9fjZD/GgJyaPXX89KPbrZj5854H7S2AKUwlZpPdYRrIS2jEBPGZe/eU7vFHtY6T2OFx3MfBELZ7h8Dl9HGoijQQqTSYE7D2b8OuxkXPuDsrcvJufZ0o=; 4:2P2XhGRovQJKAGWToahj/FMJ22H91VbP5yjj+RrHstIMrzoPXNF0MMtjtxYGDdkh53Ce3gTc0auA7/YKnpHRmSIugtFC79jZFVJfAuMUjBCX7hZ5Dnxt+xlFF8Py/G6DxVkB5VHEPaqutRYreYeHvHui/dS/1fy3wL/c+YxnspdGB77XkapJu2lFSlquwvUOiYPOHfoKt6szr9hT9qGUzOD5WFVYG/cZcfIStNWopmFRhApiLNCYUm0TjG9aayOSGfPZh9QAQeMe/DlbWsixRGHwPQuJZ6/oW8paDzmAf1J3+4Z25BsBmZOh9CBR8A5a+mwdqiN+D5zrPFVfRIzTTgQrEV6FWnYwme9IBSVcXWc= X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(217544274631240)(180628864354917); X-MS-Exchange-SenderADCheck: 1 X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(8211001083)(6040522)(2401047)(5005006)(8121501046)(93006095)(93001095)(10201501046)(3002001)(3231355)(944501410)(52105095)(6055026)(149066)(150057)(6041310)(20161123564045)(20161123562045)(20161123558120)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123560045)(201708071742011)(7699051); SRVR:AM5PR0802MB2545; BCL:0; PCL:0; RULEID:; SRVR:AM5PR0802MB2545; X-Forefront-PRVS: 0823A5777B X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(396003)(136003)(39860400002)(346002)(376002)(366004)(199004)(189003)(6306002)(25786009)(4326008)(81156014)(72206003)(966005)(106356001)(105586002)(81166006)(478600001)(5660300001)(47776003)(97736004)(26005)(8936002)(50226002)(66066001)(476003)(16526019)(6486002)(186003)(2906002)(8676002)(316002)(16586007)(7696005)(50466002)(956004)(2616005)(486006)(6666004)(7736002)(305945005)(52116002)(48376002)(68736007)(76176011)(51416003)(86362001)(36756003)(53936002)(386003)(446003)(1076002)(3846002)(6116002)(11346002)(6636002)(921003)(1121003); DIR:OUT; SFP:1101; SCL:1; SRVR:AM5PR0802MB2545; H:e114479-lin.cambridge.arm.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; A:1; MX:1; Received-SPF: None (protection.outlook.com: arm.com does not designate permitted sender hosts) X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; AM5PR0802MB2545; 23:C5wk/LUMkcY0+QqRVi37li4jgINvGEZjoycY5Ln?= 3COFVt1vmY5xW+z7JDTRogFaKTDineNt3WVJz5MLBTvehXOTAei0SuzlC7hqLTMYVAT7V2jDdlK496CW3MBK7e7y/DRufZCvutJJ0bcFmvBAN4eIWaKXDnqCzBA2l8u7V/3YuqTVr0Upw4Bxt2N6E4RbSCkeNExmfcSzBcff+tmSFKkdKkJMVMiM2csS1QPFQJicdeYLgfWbMlK4gkzPQRK5stvNQN+pXhWJ467RaCm3fHHFuaLzA48iB6J5ZFWi0RDdwMBHkTET2uMEiT6HIn+22myNvJYaJ7wA8j0PkqWvYilGoLo8XAC3HbhQ+DIUT0c+51D2KyXQNfBpDWQu56LuhdxWcOa9fi7BNIOEx2IAClY2o3bvszh9UhQ8elvBQlV/i1BHUYCdzGzFHedfOmdFWDLsg5rNZE7VeJl3DmYLD7scpxB/fDGmPH10BBU2LmcnvT32e08ejDZDOCxqUmmZsRztDUG7zp2qicvdehezfvKj3GV2iNYxZV1hE7HWJvv3j7vnrpPBw4twehLtutzFxqERkyB/uVzz2ljZLWotPqD4BULBx6wDVwwZG7KLDIHYEIkopuDQqGOKmEyy66GpdqGNFYFOH0MFTfUQl31iw5LQHqZBCfxhT6XP2qpYx08qGWInZHQEHGYf0wx4pYNUQwr5spAR6iLAqN4XDiq0bArYpI59exu34yPa4KkRO27IYWoGqkXg28uN3uXYmiEQgLHQhzNB9tW6O8zqeCbOcKU6yt4AGNzYwdti2jI95IEg/vQ5mrFaySaGwGXBGjhhA9FmeQyphFgkHgPtlb47/utRzw5tbAyA7CFda2znnOjnBiwZrF2NkrLqe3/wM9MVEQ5GoGhZNr2kUeZDseXvXt1C6ub22+B1GHkQK9rSNS8OGTkI3IStVRefMCAMSFVIcbcIbo5MxpWo2XLhGsEfMimyxKqLM72UmeZzp9ZrIIyVV9WLvwMzeBsQyG5ZndElRmxtZOADEXGdFlIa38qHxshvCdM5abAWxNa5wdgS+bSf7M006jlyka6LX7dXV/3X9arFc7bWNP0qm7ZU8oVraJPMHZOAkb9c/3ADmqTEd4oX4HOXDq6+5OFpHV2Yamaezpqiakrlne0/GUlcDHPuMJpmqPPMte4ycIRQKkLhD4iUmCugVV2l56mywbQR9Z1w/beevvi54jkK6FsnVksDiCDyKvHFZiGujhY1Tfet/hmQ= X-Microsoft-Antispam-Message-Info: JZE/GkCFZTsLcQ8mYpI7pOmpTX/1/lvqaXJjmCHCtj8Fpoz1iA/iM79FhcY43V6lWI5g0G/OjcIMDlpQRjZxlyk+W3YlZA5do9rwLcccZQ3td2m7OIm4YJx4X/EqMYmzC5BNLqHlvYyRP3fXOdchm+FsqWLZP+12eNRAY7P6jLAsU4Mlk1wMoM6QUZdI3VzexH6XQg6g9//ILWJxlqo5UZEUS18tgzu/Dc1pu7JBIExyz2F8KTT06DDXyOQ9YAGpZ/f6DNuRkQznwAM8tB9saEUAN8/6E/xokBcWzZVS3K1sSSlsRFLRxXuM9PcR1Kka3f+DZNFsKFR77zPoZMUSLWmCyFvaoj4e8opkY6683hY= X-Microsoft-Exchange-Diagnostics: 1; AM5PR0802MB2545; 6:XK9VoqSXkVBzHEgbGE2Fjb9HASks8N5F9qxJ+3palBcuUmpoYlpcjEkOJxZ7+BBP9g81px3cEYo7KyHBptB0G4RXLudyZuBeEVdy/JiKuhmWPj4iuT6tmVSIIJqWeG++npuuUfnwVBnB5I15EBJLgevnXhNeurz0sUPbCZLY+66CC1GwPOx0KZ5RcZxJNUgSZBZ/e+FgcIlHPlxNNpDEactoPU9eeoedCpnvsp9hhcnyih96niSm9mas2drATlzqrF/GqdMqqJDBCvQHRPvt51rYbqApK4UsgXdthO2Ds8Fk8VBS1UVIEATTf/Mtoa17GRwccEWsCh46mj6uiIyL7ywShr+K0yj+ewvUUbH7EdDY3EoACKbvZUM/dNT3a/Ifl8sZwxmSH8C8I8dYPyKHdCChIhuHlTPMq4l7Yg4qWmkkNnzFSnI+7zde2LB+Bo7pbYEqDzCgI3X6HZd98CJ84A==; 5:M0JWdVtDMfjnbHDHf2qcn51OKtKC1GdaddbdGExIblzelHEMv08gaYI46XY0iBQp6vNAwB1i85jyGM6Z35imf06Jun6JsH3XkEJniNi1y63d6ZA4fj8z7Ku5dpH+q6hxEtVuZ7kw+ktA7IEyip906Z36cSc+Gv+6IegfAYnCCDQ=; 7:kZQstR+ac/ELHA+1xq7YTH1aXK7aZVdx4fVUUzlZ9aMFKYKa+HANDHuadd6H1fHe5Esxsafgm1ZOCJG6AQAA4LSRKLVIGqD2LkYskHpf6VJ76JwOzNRsyUqMIujwWQ2ZaarBvEf8LxQPBxOiUDEUVKhQVjsiuxXlIUVhta+6FCzLO3wRA+yd3D02pARZ4VJeE1x7EngVsBj4wSzG/wtJ6w0ABqNHRtCJtR7L9d5YZYez1CL0asRtAvEfx6pkvoMI SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: arm.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 12 Oct 2018 16:36:22.5626 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 773b4742-aa2a-4d84-dcfa-08d63060d8a2 X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: f34e5979-57d9-4aaa-ad4d-b122a662184d X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM5PR0802MB2545 X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: nd@arm.com, Alexandru Gheorghe Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" X-Virus-Scanned: ClamAV using ClamSMTP In-line member documentation seems to be desired way of documenting structure members. This change had been suggested by Daniel Vetter here: https://lists.freedesktop.org/archives/dri-devel/2018-October/192176.html Signed-off-by: Alexandru Gheorghe --- include/drm/drm_fourcc.h | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/include/drm/drm_fourcc.h b/include/drm/drm_fourcc.h index 865ef60c17af..345f11227e9e 100644 --- a/include/drm/drm_fourcc.h +++ b/include/drm/drm_fourcc.h @@ -52,25 +52,35 @@ struct drm_mode_fb_cmd2; /** * struct drm_format_info - information about a DRM format - * @format: 4CC format identifier (DRM_FORMAT_*) - * @depth: Color depth (number of bits per pixel excluding padding bits), - * valid for a subset of RGB formats only. This is a legacy field, do not - * use in new code and set to 0 for new formats. - * @num_planes: Number of color planes (1 to 3) - * @cpp: Number of bytes per pixel (per plane) - * @hsub: Horizontal chroma subsampling factor - * @vsub: Vertical chroma subsampling factor - * @has_alpha: Does the format embeds an alpha component? - * @is_yuv: Is it a YUV format? */ struct drm_format_info { + /** @format: 4CC format identifier (DRM_FORMAT_*) */ u32 format; + + /** + * @depth: + * + * Color depth (number of bits per pixel excluding padding bits), + * valid for a subset of RGB formats only. This is a legacy field, do + * not use in new code and set to 0 for new formats. + */ u8 depth; + + /** @num_planes: Number of color planes (1 to 3) */ u8 num_planes; + + /** @cpp: Number of bytes per pixel (per plane) */ u8 cpp[3]; + + /** @hsub: Horizontal chroma subsampling factor */ u8 hsub; + /** @vsub: Vertical chroma subsampling factor */ u8 vsub; + + /** @has_alpha: Does the format embeds an alpha component? */ bool has_alpha; + + /** @is_yuv: Is it a YUV format? */ bool is_yuv; };