From patchwork Fri Oct 19 10:57:44 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: 10649003 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 19722112B for ; Fri, 19 Oct 2018 10:58:39 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 0810A28938 for ; Fri, 19 Oct 2018 10:58:39 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id F0872289D2; Fri, 19 Oct 2018 10:58:38 +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 9164B289CF for ; Fri, 19 Oct 2018 10:58:38 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id A7D376E352; Fri, 19 Oct 2018 10:58:37 +0000 (UTC) X-Original-To: dri-devel@lists.freedesktop.org Delivered-To: dri-devel@lists.freedesktop.org Received: from EUR04-HE1-obe.outbound.protection.outlook.com (mail-he1eur04on0626.outbound.protection.outlook.com [IPv6:2a01:111:f400:fe0d::626]) by gabe.freedesktop.org (Postfix) with ESMTPS id AAD9C6E343 for ; Fri, 19 Oct 2018 10:58:35 +0000 (UTC) Received: from e114479-lin.cambridge.arm.com (217.140.106.51) by AM5PR0802MB2546.eurprd08.prod.outlook.com (2603:10a6:203:a0::22) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.1228.25; Fri, 19 Oct 2018 10:58:33 +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, maxime.ripard@bootlin.com, 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 v5 1/9] drm: fourcc: Convert drm_format_info kerneldoc to in-line member documentation Date: Fri, 19 Oct 2018 11:57:44 +0100 Message-Id: <20181019105752.17741-2-alexandru-cosmin.gheorghe@arm.com> X-Mailer: git-send-email 2.18.0 In-Reply-To: <20181019105752.17741-1-alexandru-cosmin.gheorghe@arm.com> References: <20181019105752.17741-1-alexandru-cosmin.gheorghe@arm.com> MIME-Version: 1.0 X-Originating-IP: [217.140.106.51] X-ClientProxiedBy: LO2P265CA0387.GBRP265.PROD.OUTLOOK.COM (2603:10a6:600:f::15) To AM5PR0802MB2546.eurprd08.prod.outlook.com (2603:10a6:203:a0::22) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 8dd7f1f9-a62c-4033-5a09-08d635b1d00d X-MS-Office365-Filtering-HT: Tenant X-Microsoft-Antispam: BCL:0; PCL:0; RULEID:(7020095)(4652040)(8989299)(5600074)(711020)(4618075)(4534185)(4627221)(201703031133081)(201702281549075)(8990200)(2017052603328)(7153060)(7193020); SRVR:AM5PR0802MB2546; X-Microsoft-Exchange-Diagnostics: 1; AM5PR0802MB2546; 3:in59YvR/zZuKXTlqCupb1uoZuMht7V+tkIApI6pET/Y3oVQ19g5W3YcoTSsdOFjTlWTgoEG8KrTzkzl5lxjfJf+d7xX6iJPC+zrzMrAyR9fcOHV5BBzkaRo06Jy/nFXIHgKXKS4S+YEeGu0a7xw68VdfHZj8J5/n2WvJTvV5sJPt5A/Jn2YRCkCX6QMg8x2ANx65+MVSktGYJpCLsUf4wmnEF+AuRknQWzofO3Copzq/tljDB4SVCbmKshVmxoyp; 25:9cOGUcOf1K3JzrQdLTGLb3ufNLX2nLsetonIEYFBdHe8GRrOrtc0EBHcr88qwmSLM6uVn5MYPzpNqDI655iq2SM1S6QsTUm2pjaO9ajdmGB5e43057b0UJWy6kaBvTezzFq7nsISgrJJFPX1CD3DHLOHBOFWR/W1VIkrCd5O9eu7TcXz+UnYUBAcBjNj457h6agzRdzSgURqumzxoN4o+T3El75DfWMnC4AFoewP1t0Ghe1zaJeBeHsyL9NfpqcgPA2TIH0UkC4/f9i6+6WChL1cnBeVTAKdHwznI0Rx0dOkOomxA4AesKg5R4s+yddboCbsYN5sUwp42golR0d4zcM+kXbHxvzjvZLRiN5FE9M=; 31:QSgmX28p3dGR1qCAorwrSa5DgKvfx2ZIV2XG+5ZWyNe5F79oLH2hfaBVtIyyYJf9jWFHxwGJxiJoMyDdRJPVyNoYwjYlC/GFAGs5w+cV3jtenJpjFLOM+C5XnkV2J0YHY1vjTAYh44+fOrxvf/Sse5XV47UeD7Q9FNTKBZFxl3tCJMDEj7ETQdPHRo1AB7kSNH4wzzI/OvwWbcSfQCFs7dE9ov73yzO0u0DPGX24DG0= X-MS-TrafficTypeDiagnostic: AM5PR0802MB2546: NoDisclaimer: True X-Microsoft-Exchange-Diagnostics: 1; AM5PR0802MB2546; 20:byTTSJit9/7pjt/D6f5z75KrvAYX83k50g4PA3MQh2uLEDwxRPrm1oJV5pO7kv2/9jtCBjeVMNM6Z3XuVNwoOmHhcwivqYBNIgoU/ra/2MwGOp+x9fZMo8MXIOVfKWp0/1VfuaQFBARuydnTKmqKeah63KK3GiSVqalurhoeZa/sG/KmWq906JjT0ZXbDvHnXcXbFTsY1r/bZCyUD9AcVjhio0MbnAu807u7nU8q2wqQaJ3pFXmrFsHhqttOcVXOcIT+ULDTG+rqdVwdLFGUT9cD73oRlmelNgpuba5GEJ8W5eWEBjcTfIPc/ImFFGCQZI4xit61+4r7nGEwbYdrHYtL6aJyeRKdRVVoRwp5IBAjzKpDdiMQfFX19Q0B0I0zd81FoYPGGoMH4SxA8vA4e+BudsfGgltL4FHnwU3sm4E=; 4:AnQyX+EyB6MIsBRwplTeBAbNOyuvRgAcZ5+klkUFaJIp4TSILYE9IL6+b7JmLeadHacTSxcxV2fUndbFjjntWOxf2UppmtK9fi6dLXsnXSStbpBNDEfOod8kDOdkbnh2fzs5v0eEpCpJepTMzke2oK4WHWnRNs2BvgRiBGEZpE465lTlcwE5JKccTAKzv6t1h66vNWzplDDs5qurc1c3p3ViiXzjlXJI/j7PBHe2BzWYDmNDapYi3+JnXjBNAuwlm5UHX2IZDWd4aaGermfQ9+D3wnEPS5bczAvkdBpIPjFMM32pJ5j0NLFNQpMTbBeQ4Zx2Olb6qUbULftFFPuQCOpSfeIBLHfok4ZnCtWtr0Q= 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)(3231355)(944501410)(52105095)(10201501046)(93006095)(93001095)(3002001)(6055026)(149066)(150057)(6041310)(20161123564045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123562045)(20161123560045)(20161123558120)(201708071742011)(7699051)(76991095); SRVR:AM5PR0802MB2546; BCL:0; PCL:0; RULEID:; SRVR:AM5PR0802MB2546; X-Forefront-PRVS: 0830866D19 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(376002)(366004)(39860400002)(136003)(346002)(396003)(199004)(189003)(6636002)(11346002)(105586002)(81156014)(81166006)(50226002)(6306002)(106356001)(4326008)(97736004)(3846002)(476003)(25786009)(6116002)(16586007)(8676002)(53936002)(50466002)(486006)(1076002)(8936002)(316002)(2616005)(956004)(966005)(16526019)(48376002)(36756003)(26005)(478600001)(6486002)(386003)(7696005)(186003)(52116002)(51416003)(68736007)(446003)(5660300001)(305945005)(72206003)(76176011)(7736002)(2906002)(86362001)(66066001)(47776003)(6666004)(921003)(1121003); DIR:OUT; SFP:1101; SCL:1; SRVR:AM5PR0802MB2546; 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; AM5PR0802MB2546; 23:/GyP1vdGT6M+bE3/jmcfP3CeSZkceUT2tvn0BVj?= /9tGJko7IRJfVxNMKlwe1WySrRZglZubjyzW5BNU3Rz2dPRGBCZ5MvroY+pQH30elOKw8daJWD5WOF04r7bZD2UguBrRwBedy4cjpBj0vL6pqGK/3zPrhAMM81tMJYlrcxxRQut7uLmViCBRsLpOnm8F0ojLKyuervy7wHki5hLMGiJ0BfN/KzDXkcNbpas/TYYdf7q5RKhBH7aXtzShstHDnnUp+HSW5f8PH3Ugg8hB68T2qufE7Z1DsmA87JW6tGFnKq9SSvCUX9M6NnuIEtS79qOnbmtkv33l0ySS6kpV8EJUvLN71IjzQ0AqvFBHbFoCGoAomWmp16k/TVtyQWCkEFEyNJLKWoJ6CquDe8ELn89OKW20BwcZYnb/JiNXZVWK4wTQu38LAosq+qCfhsBn8/XtV2XzoJzlanVn/fU29j9r3mBtyG/2/QGzf8SOfTi/oK/YsFMXNX4cWNVBu/JL/All7s/D6cOXhpiFiAPMbHJ8oc0Zb2ZmeWcTjkXRT5cvrmPUC1JDjGTMktK+EUVUuyVoWT/NBmJPfUhntVQEkVu87OrB+st/AhPI48gwHgpVP1Gbat0MM/3PRhkDH24q1/eFVVpC5z7E3l5jBIiO7H91tyiqWk2nivTOQVNHQQJZwH7D6SZcfCdJmnqClPEdIMOkiJoqYte12NL9CJv6akQxZQ9jGuXXKJUpHFEePUcNzPA1bIhn7vDIpVga2Xc7mxdttpqzxl8cKp/CbqrW//Z58DwPO3HSTHwHTbXWaJJQLUhjRtoieMRiFAlQUguwsANpM57yMu1SHAUi96rzh8li1bzq03W3svpr5UBZlTiuEFwVXOeIsYeGHbhuXyn1/OC22Xp8WccfE0ZoXa9g1i0wcvWclJXUWWM6uiUiFFh2mlGp0COdztDDnD2gQvUYiNtRnZsFSzf2ktUc0krwxrPyeX20bRZI+b8+AbXHzLnoRJxkBkVG0g5BP0kcFk76LjAd4EjxRdxmyRq++7x8+XtqX6Sb9Cx7psn8xDNPIcpJ1IBaC63aVmUlNLnphhtEdMPiSy0dUJbUyjv6jr2N9OgzKKuiTvXLnahoaaT4aWjD5a5H9DFXWyK8QPv/5tvwd4jz+K3jwlXtuzC4Py0TziTLTMjGZ+jAUazx0mT+mCG9J6IkVhOMAGhOITfVIOxODGKjLnWIqtwjU+Z3M59/OqKow6SymFQ0doaHHmKfCVF0= X-Microsoft-Antispam-Message-Info: +Xoaw16bRimIJ2nBNS5D00tVB3UijOUszWFLoxGbjObd97BFUewjJKs2k/lB+FVeWTMhimRgUd1bMuXzt7Cb9bspmedkrnDpbBsLOU4ge7E9utzlnY1ke6O4vzj/ELw3AnGvQ3SzJUC/6hv7G090d/0j3GGw2+RSNiaO0gJXwDPUd+MnGi6ASXHgbii7Y2sBUdHRQ5gkFT3xV+lSwbk2M0BiqxQ4m590XlbFtSb7+PnrFkhGJmQu9REBRNQTuuclakgp0ZveDScutv7L7gii8O7Z0fN/UjaNZO4F3HpT+Ar0O2/PXRGCzgcKEIsh7P2SXKikdfguHO6X38j2qz2dNKfG1CgnMM7gMLXn8isInP0= X-Microsoft-Exchange-Diagnostics: 1; AM5PR0802MB2546; 6:W+uNaQv3yQU/1WX9DJSZHfi9Z+LOoag/zvtpT4AMjHsJTPlouwKn9QupCOI/YKUzXuvQ442IqGzPYT4nBwup/a+FPXYlj5IHjwwKQvEIN8Rj7w8aMym+NBsNC+Rquqsg5dDh3vrMIr1cFMGJSPyA+bdJqsc2TO23tRs0vSBKdxWuHInmoI5AFiINci2578x8xX3nmcLZ01+i1juq4T7wS0Jt3gfls/6kqFCIZ1iE7lHOQfltT3D8PYjF27jxLgil9Km6ARDFxp5aq7QsEBO8eqnkwPgfDORZrNb4bQeqE4m6xE1FU2wDR6XjD8XcZs1IYXmZZ0AnSTKmlmp0Lg8XH6Go7oLJRalNw9PC9TWJuJsNOvrtbFt7n+tcjbmVSvnZX+o/TlQtysx8F8eCA5h6wA+q6YJ22jFcE9Poxpuy4b6OzOT3iJTy2Nl0x4Oa/QSx+9o+SCZU2LqLcxSY9HMa/g==; 5:uUhYc2TrupF69UJkm2uZpP5sOSBapJaT9gMb4teLvpKNJIR/Fqr9/SWIEkPc/W+b7j0n9QZKrxNEKdMGTSuR0jXu2bdEH61Wq7JoZP2E2DfCKDKuSyJGrwyTtSxiVGiNlvGGFKOAsaQR80D1J9jOxcY/WUTypRH8T0xEzwlqBzA=; 7:1H9LFpFM9rPR7nnM0T4jlzYBUYn4giX8MOWUUrsO7SW0BIp1URjS3af/Zyyj1Fls5FWmm0VE1b4P5+uXYqWhFbxAmMBhwK2QY7uc9LyYTdyl+KmSFZn5pZNTwEYoZtXfwgvzAtzO4F40BsQO7CCfTQniS3QlvGt6piPeKY0NalT0oior7IWBu7kuOLcDKb4hl8CLszEomITpkdgtJuYWkTSvpoHzgUOcxs7cR71vGhHQl6qEIc7FPqiIYB9n0azp SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: arm.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 19 Oct 2018 10:58:33.3335 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 8dd7f1f9-a62c-4033-5a09-08d635b1d00d X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: f34e5979-57d9-4aaa-ad4d-b122a662184d X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM5PR0802MB2546 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 Reviewed-by: Maxime Ripard --- 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; };