Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Tue, 9 Aug 2022 06:12:06 -0400
From:   Rodrigo Vivi <rodrigo.vivi@intel.com>
To:     Mauro Carvalho Chehab <mchehab@kernel.org>
CC:     Thomas Zimmermann <tzimmermann@suse.de>,
        Jonathan Corbet <corbet@lwn.net>,
        David Airlie <airlied@linux.ie>,
        <dri-devel@lists.freedesktop.org>, <linux-kernel@vger.kernel.org>,
        <linux-doc@vger.kernel.org>, Maxime Ripard <mripard@kernel.org>,
        <intel-gfx@lists.freedesktop.org>
Subject: Re: [Intel-gfx] [PATCH v2 38/39] drm/i915: add descriptions for some
 RPM macros at intel_gt_pm.h
Message-ID: <YvIy9o2dHkB1gAr6@intel.com>
References: <cover.1657699522.git.mchehab@kernel.org>
 <37e3b9aac85f1d08c0a53bae86680d504308bf67.1657699522.git.mchehab@kernel.org>
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
In-Reply-To: <37e3b9aac85f1d08c0a53bae86680d504308bf67.1657699522.git.mchehab@kernel.org>
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?6UpbGqZ9w2sLL35n8Whvh4Qt3C2sE0VRJGEdDDV0ODzLd4AEm2z7AhJsQ4hN?=
 =?us-ascii?Q?C7+GjJyRHbunPJIgaJiS5QZzoZgCroGgW+LYZiipelp6q52g2hTC5TkXXHRq?=
 =?us-ascii?Q?xB6/ZpCs+6fxRMpus3mI/9BhKt0gcCpn73Ky81BAXxMJCQh+FZXh2Y2V+DT/?=
 =?us-ascii?Q?ZcrJ1t4Ac/apbNTUahitGiaSfZ7uIsXauuuvPy0HPOfYzw11ZozPCVVDo7Sm?=
 =?us-ascii?Q?qk+yC/Uhu3CpYSBx5J+3gGOEneYnf9qRf+FnfPnVz6EOMMWjj52BleEkDPaW?=
 =?us-ascii?Q?fQnV7FbYn8crXgWm/M1stv0clnbg8FC4rErn4hAJjZQVov9iZPfhiSBBhCy3?=
 =?us-ascii?Q?CcZf/uw/rSILHZBfDe0sOVESbMh+MuhCniLBGdw6GHbCYC1QZL7z+GFk3yke?=
 =?us-ascii?Q?7DlGzTE8NkG9IgCal40gQhGgl1MrOjuaHh3UBP2AnkIo5U+oLU07iphtpRVL?=
 =?us-ascii?Q?+DeLU3zdTu7yy0i4WJ9zeZzU4f3qxgxhmSYzKg+XQYqSCYQ7uXDA0XQ1MQYQ?=
 =?us-ascii?Q?phTMna6nsBgVOiK6t4Bucxm305ZjvWA7p20deDMnUi7UaXC2CPiSkVa6lvom?=
 =?us-ascii?Q?+dpBz+D1080tW/TBkmHJXXmqvdLKtFskLpoGRlueBDU/Zs4wu/bUNlGwMB2N?=
 =?us-ascii?Q?yqcqkokMyWLerZt7xj+ntMWFMdi6kEETO3e9x7k/uQYzqOxmkgi9KxdBgjxU?=
 =?us-ascii?Q?UTFAjMmB+zYcJ0kjLpQtLmr8eLiD4vFESMRitstrXvxLGCTLjyRpPD8/UjfA?=
 =?us-ascii?Q?VGLTBT10dZbQNUIpylwbbb30dC5m2s2wOOm5yrUejAUsqJx2YNisjPE20nMl?=
 =?us-ascii?Q?jgdbrzDuU1oaZHzcpzDvjnh9aYOqC3NNIUcQiadz1NNyTE6yy5TLLy+7lsq3?=
 =?us-ascii?Q?+JKDTObUqgA7a8YHv3rqy4ohI2PlvmqEUQB8kB0aoyF08ZP3l62qMmwdSy9S?=
 =?us-ascii?Q?/pBNsIpa2zp/m9SA8MS6IzllgQWbvF5XdU+ERIzYz8jFVfrIDWExoL4EKUqS?=
 =?us-ascii?Q?h+f8yvaO2ozDL9L/pD/LDE1LuuVMT95zMNs6VjJFZKG3Xju1q6/YYjpP4Ml/?=
 =?us-ascii?Q?GbLfKvqFKQ4Pyz/u85izh/ymapu+z6bPRWsnHkMM/PoxFxPCaXJGzxT4adkd?=
 =?us-ascii?Q?Ia/vOdqDkw+LHbM9D6/kGjkvRfqsU9WQIyEVxU6FkvO4j+kQguf9WZqIBut4?=
 =?us-ascii?Q?//i2dniJMVNNBQXefbA2uQG1Wi2whrUJaVY6+r1K4vZzOKOVincnCG8+xfuv?=
 =?us-ascii?Q?Hby83J0i4qTrH09OphjTPfX47iA0CK8kSDtjpb431cNGYyALLVM4kbejIgFG?=
 =?us-ascii?Q?fLGDcS3K5EelZD9fTk3mj6DnY/ou9LuasnwSfeOYapD3NEkRSFAITvD8Fem2?=
 =?us-ascii?Q?f1IywJSS6K0H7bkDdg26aL7uj6GACuKEmLP7gb7HD8fAh9g+2Wfi7Bvt7Nuk?=
 =?us-ascii?Q?jNlVFW+eWucaOg9MZRTkXThm9L0nZrowgE3iHY9wz0jR5LQzTK0LsE65nofX?=
 =?us-ascii?Q?J3lqPh8NwJ7lE5w2DxA3hR386zrPLc71hO0r1zd5dmL9Idj/sgNvQTx7wYFz?=
 =?us-ascii?Q?WWsf/kQX+WBiwv5jMhSHqlG73xRzQj2kyGdSvkKQJxdj94hfOLU0RatSOffB?=
 =?us-ascii?Q?hw=3D=3D?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 89c3c8fe-3196-4364-f2cd-08da79ef9fee
X-MS-Exchange-CrossTenant-AuthSource: MN0PR11MB6059.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 09 Aug 2022 10:12:11.6084
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: zRrpRxiJ2WU4ZJ/jmtZLWaFZFiyXYN6pN9uEj6UgZ2cOcuZTOzLum6jVkZ14/x7CxpptNGDUL35OHY2h6oOJNw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN6PR11MB4052
X-OriginatorOrg: intel.com
X-Spam-Status: No, score=-5.0 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
        DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,
        SPF_HELO_NONE,SPF_NONE,T_SCC_BODY_TEXT_LINE autolearn=ham
        autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On Wed, Jul 13, 2022 at 09:12:26AM +0100, Mauro Carvalho Chehab wrote:
> The intel_gt_pm.h file contains some convenient macros to be used
> in GT code in order to get/put runtime PM references and for
> checking them.
> 
> Add descriptions based on the ones at intel_wakeref.h and
> intel_runtime_pm.c.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
> ---
> 
> To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
> See [PATCH v2 00/39] at: https://lore.kernel.org/all/cover.1657699522.git.mchehab@kernel.org/
> 
>  Documentation/gpu/i915.rst            |  2 +
>  drivers/gpu/drm/i915/gt/intel_gt_pm.h | 62 +++++++++++++++++++++++++++
>  2 files changed, 64 insertions(+)
> 
> diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
> index 6bb50edc6d79..9862d504df4d 100644
> --- a/Documentation/gpu/i915.rst
> +++ b/Documentation/gpu/i915.rst
> @@ -709,6 +709,8 @@ Table Manager (TTM)
>  
>  .. kernel-doc:: drivers/gpu/drm/i915/gem/i915_gem_ttm_move.c
>  
> +.. kernel-doc:: drivers/gpu/drm/i915/gt/intel_gt_pm.h

I don't believe this is the right placement for this.

the rest lgtm

> +
>  Graphics Execution Manager (GEM)
>  --------------------------------
>  
> diff --git a/drivers/gpu/drm/i915/gt/intel_gt_pm.h b/drivers/gpu/drm/i915/gt/intel_gt_pm.h
> index bc898df7a48c..a8ea6846980a 100644
> --- a/drivers/gpu/drm/i915/gt/intel_gt_pm.h
> +++ b/drivers/gpu/drm/i915/gt/intel_gt_pm.h
> @@ -11,21 +11,57 @@
>  #include "intel_gt_types.h"
>  #include "intel_wakeref.h"
>  
> +/**
> + * intel_gt_pm_is_awake: Query whether the runtime PM is awake held
> + *
> + * @gt: pointer to the graphics engine
> + *
> + * Returns: true if a runtime pm reference is currently held and the GT is
> + * awake.
> + */
>  static inline bool intel_gt_pm_is_awake(const struct intel_gt *gt)
>  {
>  	return intel_wakeref_is_active(&gt->wakeref);
>  }
>  
> +/**
> + * intel_gt_pm_get: grab a runtime PM reference ensuring that GT is powered up
> + * @gt: pointer to the graphics engine
> + *
> + * Any runtime pm reference obtained by this function must have a symmetric
> + * call to intel_gt_pm_put() to release the reference again.
> + *
> + * Note that this is allowed to fail, in which case the runtime-pm wakeref
> + * will be released and the acquisition unwound.
> + */
>  static inline void intel_gt_pm_get(struct intel_gt *gt)
>  {
>  	intel_wakeref_get(&gt->wakeref);
>  }
>  
> +/**
> + * __intel_gt_pm_get: Acquire the runtime PM reference again
> + * @gt: pointer to the graphics engine which contains the wakeref
> + *
> + * Increment the PM reference counter, only valid if it is already held by
> + * the caller.
> + *
> + * See intel_gt_pm_get().
> + */
>  static inline void __intel_gt_pm_get(struct intel_gt *gt)
>  {
>  	__intel_wakeref_get(&gt->wakeref);
>  }
>  
> +/**
> + * intel_gt_pm_get_if_awake: Acquire the runtime PM reference if active
> + * @gt: pointer to the graphics engine which contains the PM reference
> + *
> + * Acquire a hold on the PM reference, but only if the GT is already
> + * active.
> + *
> + * Returns: true if the wakeref was acquired, false otherwise.
> + */
>  static inline bool intel_gt_pm_get_if_awake(struct intel_gt *gt)
>  {
>  	return intel_wakeref_get_if_active(&gt->wakeref);
> @@ -36,6 +72,14 @@ static inline void intel_gt_pm_might_get(struct intel_gt *gt)
>  	intel_wakeref_might_get(&gt->wakeref);
>  }
>  
> +/**
> + * intel_gt_pm_put: Release the runtime PM reference
> + * @gt: pointer to the graphics engine which contains the PM reference
> + *
> + * Release our hold on the runtime PM for GT.
> + *
> + * It might power down the GT right away if this is the last reference.
> + */
>  static inline void intel_gt_pm_put(struct intel_gt *gt)
>  {
>  	intel_wakeref_put(&gt->wakeref);
> @@ -51,10 +95,28 @@ static inline void intel_gt_pm_might_put(struct intel_gt *gt)
>  	intel_wakeref_might_put(&gt->wakeref);
>  }
>  
> +/**
> + * with_intel_gt_pm - get a GT reference ensuring that GT is powered up,
> + *	run some code and then put the reference away.
> + *
> + * @gt: pointer to the gt
> + * @tmp: pointer to a temporary wakeref.
> + */
>  #define with_intel_gt_pm(gt, tmp) \
>  	for (tmp = 1, intel_gt_pm_get(gt); tmp; \
>  	     intel_gt_pm_put(gt), tmp = 0)
>  
> +/**
> + * intel_gt_pm_wait_for_idle: Wait until the runtime PM reference is idle
> + * @gt: pointer to the graphics engine which contains the PM reference
> + *
> + * Wait for the earlier asynchronous release of the runtime PM reference. Note
> + * this will wait for any third party as well, so make sure you only wait
> + * when you have control over the GT runtime PM and trust no one else is
> + * acquiring it.
> + *
> + * Return: 0 on success, error code if killed.
> + */
>  static inline int intel_gt_pm_wait_for_idle(struct intel_gt *gt)
>  {
>  	return intel_wakeref_wait_for_idle(&gt->wakeref);
> -- 
> 2.36.1
>