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=-13.6 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED 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 C8959C433ED for ; Tue, 11 May 2021 17:16:34 +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 6FD44611F0 for ; Tue, 11 May 2021 17:16:34 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 6FD44611F0 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=ffwll.ch 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 C09716EA85; Tue, 11 May 2021 17:16:33 +0000 (UTC) Received: from mail-ed1-x52d.google.com (mail-ed1-x52d.google.com [IPv6:2a00:1450:4864:20::52d]) by gabe.freedesktop.org (Postfix) with ESMTPS id 58CBD6EA85 for ; Tue, 11 May 2021 17:16:32 +0000 (UTC) Received: by mail-ed1-x52d.google.com with SMTP id n25so23794530edr.5 for ; Tue, 11 May 2021 10:16:32 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ffwll.ch; s=google; h=date:from:to:cc:subject:message-id:mail-followup-to:references :mime-version:content-disposition:in-reply-to; bh=gJ4QXLOi5qYQcWsKhnhYHHHN84GDlI0qyOMz9LJ9MJA=; b=NAHQH1OXA4z8A3ywZoUPLx5PZOjYmtpy3Kvd0nDQV2Ehv6Pq4POjIhL0k8pP+J6W+3 Qsb5UVXY2TnQuCH72qYKa0w4e4thRDVppRcqJmjc3OMYxCHFW75FUpzVbAAa0xrdBJ4I jPQXapvhkl5itLg62egldnLCWd0n+GZGQAsGE= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id :mail-followup-to:references:mime-version:content-disposition :in-reply-to; bh=gJ4QXLOi5qYQcWsKhnhYHHHN84GDlI0qyOMz9LJ9MJA=; b=JsVs1Ej9YKDp0wNqv5LFnNm+S3JQ8LzCACL6u6o0dO51CZAh0TKPmVcAe10v81iXLh 4WPVCt1SV16J2dNmjuX0R6dIidRAGkkYcpvssZdDpkaUIc/vH7ZXtQfC2BagQripgk7T 27HVKRG5D/An3CE+iKDxIkSY5jMBMYjuYMgtCP2+YZ+tnvw9xLBzGjnQecZphLKTAVL8 tPfCvYGMC59nqePv602uVGH81t5LGZ80ri4XyOOtChcDQvDfh0HbaMsUUrOVICLI8Nis yr61Ryl01EQHMgpqCNiojmO/PDl3I8DKy1ORTfWvNnPWhGL67iXU3rL/fByHhU3aXNId ufHQ== X-Gm-Message-State: AOAM5334tf0aY/uNFfp4sJEgM/20O8EtB8CadpZ4VGtSITm4qxYMU7id IZ4r9NjUbUBowthZEZvcpbkjjw== X-Google-Smtp-Source: ABdhPJyxfQ58c7ka6SeEs+UawelflG7pWufRwVy5W/GQh4+rGazpGzJlf2TwRNN8Q1JvNbfW3bYa2A== X-Received: by 2002:aa7:d0c9:: with SMTP id u9mr37437114edo.43.1620753391002; Tue, 11 May 2021 10:16:31 -0700 (PDT) Received: from phenom.ffwll.local ([2a02:168:57f4:0:efd0:b9e5:5ae6:c2fa]) by smtp.gmail.com with ESMTPSA id u6sm12175280ejn.14.2021.05.11.10.16.30 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 11 May 2021 10:16:30 -0700 (PDT) Date: Tue, 11 May 2021 19:16:28 +0200 From: Daniel Vetter To: Maxime Ripard Subject: Re: [PATCH] Documentation: gpu: Mention the requirements for new properties Message-ID: Mail-Followup-To: Maxime Ripard , dri-devel@lists.freedesktop.org, Daniel Vetter , David Airlie , Maarten Lankhorst , Thomas Zimmermann , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Jonathan Corbet References: <20210511155512.582798-1-maxime@cerno.tech> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20210511155512.582798-1-maxime@cerno.tech> X-Operating-System: Linux phenom 5.10.32scarlett+ 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: linux-doc@vger.kernel.org, David Airlie , Jonathan Corbet , linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org, Thomas Zimmermann , Daniel Vetter Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" On Tue, May 11, 2021 at 05:55:12PM +0200, Maxime Ripard wrote: > New KMS properties come with a bunch of requirements to avoid each > driver from running their own, inconsistent, set of properties, > eventually leading to issues like property conflicts, inconsistencies > between drivers and semantics, etc. > > Let's document what we expect. > > Signed-off-by: Maxime Ripard > --- > Documentation/gpu/drm-kms.rst | 18 ++++++++++++++++++ > 1 file changed, 18 insertions(+) > > diff --git a/Documentation/gpu/drm-kms.rst b/Documentation/gpu/drm-kms.rst > index 87e5023e3f55..30f4c376f419 100644 > --- a/Documentation/gpu/drm-kms.rst > +++ b/Documentation/gpu/drm-kms.rst > @@ -463,6 +463,24 @@ KMS Properties > This section of the documentation is primarily aimed at user-space developers. > For the driver APIs, see the other sections. > > +Requirements > +------------ > + > +KMS drivers might need to add extra properties to support new features. > +Each new property introduced in a driver need to meet a few > +requirements, in addition to the one mentioned above.: > + > +- It must be standardized, with some documentation to describe the > + property can be used. > + > +- It must provide a generic helper in the core code to register that > + property on the object it attaches to. Maybe also include anything that drivers might want to precompute, e.g. we have helpers for cliprects. > + > +- Its content must be decoded by the core and provided in the object object's > + associated state structure. > + > +- An IGT test must be submitted. "... where reasonable." We have that disclaimer already here: https://dri.freedesktop.org/docs/drm/gpu/drm-uapi.html#testing-requirements-for-userspace-api I think would be good to cross-reference the uapi rules in general https://dri.freedesktop.org/docs/drm/gpu/drm-uapi.html#open-source-userspace-requirements With the bikesheds addressed: Reviewed-by: Daniel Vetter But this needs ideally a pile of acks from most display driver teams. -Daniel > + > Property Types and Blob Property Support > ---------------------------------------- > > -- > 2.31.1 > -- Daniel Vetter Software Engineer, Intel Corporation http://blog.ffwll.ch