From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.3 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,NICE_REPLY_A,SPF_HELO_NONE,SPF_PASS,USER_AGENT_SANE_1 autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 95383C48BD1 for ; Fri, 11 Jun 2021 21:20:31 +0000 (UTC) Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 48C7561285 for ; Fri, 11 Jun 2021 21:20:31 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 48C7561285 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=collabora.com Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=dri-devel-bounces@lists.freedesktop.org Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id A3E566F3DA; Fri, 11 Jun 2021 21:20:30 +0000 (UTC) Received: from bhuna.collabora.co.uk (bhuna.collabora.co.uk [46.235.227.227]) by gabe.freedesktop.org (Postfix) with ESMTPS id 5985C6F3DA for ; Fri, 11 Jun 2021 21:20:29 +0000 (UTC) Received: from [IPv6:2804:431:e7dc:1201:ddd3:c6b:bb28:7501] (unknown [IPv6:2804:431:e7dc:1201:ddd3:c6b:bb28:7501]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) (Authenticated sender: leandrohrb) by bhuna.collabora.co.uk (Postfix) with ESMTPSA id D80D31F4478E; Fri, 11 Jun 2021 22:20:26 +0100 (BST) Subject: Re: [PATCH v5 1/1] drm/doc: document drm_mode_get_plane To: Daniel Vetter , Pekka Paalanen References: <20210610203824.50965-1-leandro.ribeiro@collabora.com> <20210610203824.50965-2-leandro.ribeiro@collabora.com> <20210611101945.2e7ef9e4@eldfell> From: Leandro Ribeiro Message-ID: <00f23d2f-33d1-8f0d-00b4-23e961a74305@collabora.com> Date: Fri, 11 Jun 2021 18:20:22 -0300 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Firefox/78.0 Thunderbird/78.11.0 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Dave Airlie , Collabora Kernel ML , dri-devel Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" On 6/11/21 4:33 AM, Daniel Vetter wrote: > On Fri, Jun 11, 2021 at 9:20 AM Pekka Paalanen wrote: >> >> On Thu, 10 Jun 2021 17:38:24 -0300 >> Leandro Ribeiro wrote: >> >>> Add a small description and document struct fields of >>> drm_mode_get_plane. >>> >>> Signed-off-by: Leandro Ribeiro >>> --- >>> include/uapi/drm/drm_mode.h | 35 +++++++++++++++++++++++++++++++++++ >>> 1 file changed, 35 insertions(+) >>> >>> diff --git a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h >>> index 9b6722d45f36..698559d9336b 100644 >>> --- a/include/uapi/drm/drm_mode.h >>> +++ b/include/uapi/drm/drm_mode.h >>> @@ -312,16 +312,51 @@ struct drm_mode_set_plane { >>> __u32 src_w; >>> }; >>> >>> +/** >>> + * struct drm_mode_get_plane - Get plane metadata. >>> + * >>> + * Userspace can perform a GETPLANE ioctl to retrieve information about a >>> + * plane. >>> + * >>> + * To retrieve the number of formats supported, set @count_format_types to zero >>> + * and call the ioctl. @count_format_types will be updated with the value. >>> + * >>> + * To retrieve these formats, allocate an array with the memory needed to store >>> + * @count_format_types formats. Point @format_type_ptr to this array and call >>> + * the ioctl again (with @count_format_types still set to the value returned in >>> + * the first ioctl call). >>> + */ >>> struct drm_mode_get_plane { >>> + /** >>> + * @plane_id: Object ID of the plane whose information should be >>> + * retrieved. Set by caller. >>> + */ >>> __u32 plane_id; >>> >>> + /** @crtc_id: Object ID of the current CRTC. */ >>> __u32 crtc_id; >>> + /** @fb_id: Object ID of the current fb. */ >>> __u32 fb_id; >>> >>> + /** >>> + * @possible_crtcs: Bitmask of CRTC's compatible with the plane. CRTC's >>> + * are created and they receive an index, which corresponds to their >>> + * position in the bitmask. Bit N corresponds to >>> + * :ref:`CRTC index` N. >>> + */ >>> __u32 possible_crtcs; >>> + /** >>> + * @gamma_size: Number of entries of the legacy gamma lookup table. >>> + * Deprecated. >>> + */ >>> __u32 gamma_size; >> >> Hi, >> >> I wonder, has this field ever been used? >> >> "The legacy gamma" refers to CRTC gamma LUT AFAIK, but this here is >> about planes. I forgot that at first, so didn't see anything funny. > > Yeah "Deprecated" isn't really conveying that this was never used or > implemented anywehere ever. I think we should put that into the docs > to make this clear, otherwise someone is going to wonder whether maybe > they still need to parse it since it's only deprecated and there's no > other plane gamma (yet). I wouldn't even put any further docs than > that in it, because stating that it's the number of entries for > something we never implemented is going to be confusing at best :-) > -Daniel > Nice, thanks for elaborating. I'll update to "@gamma_size: Never used". >> >> Anyway, whether the doc for this field is as is, or is changed to >> "never used" or "unused" or "reserved" or whatever, you have my: >> >> Reviewed-by: Pekka Paalanen >> >> With the caveat that I didn't actually build the docs to see how they >> look. >> >> >> Thanks, >> pq >> >>> >>> + /** @count_format_types: Number of formats. */ >>> __u32 count_format_types; >>> + /** >>> + * @format_type_ptr: Pointer to ``__u32`` array of formats that are >>> + * supported by the plane. These formats do not require modifiers. >>> + */ >>> __u64 format_type_ptr; >>> }; >>> >>> -- >>> 2.31.1 >>> >> > >