[Intel-xe] [PATCH v2 2/2] drm/xe/mcr: Document how to initialize group/instance

[Matt Roper]

On Thu, Mar 09, 2023 at 01:12:10PM -0800, Lucas De Marchi wrote:
> Add a sentence about the initialization so it's clear for newcomers
> how to tweak the init functions for new platforms.
> 
> Signed-off-by: Lucas De Marchi <lucas.demarchi at intel.com>
> ---
>  drivers/gpu/drm/xe/xe_gt_mcr.c | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/gpu/drm/xe/xe_gt_mcr.c b/drivers/gpu/drm/xe/xe_gt_mcr.c
> index ab8fc649ba52..b7cee438f6e3 100644
> --- a/drivers/gpu/drm/xe/xe_gt_mcr.c
> +++ b/drivers/gpu/drm/xe/xe_gt_mcr.c
> @@ -34,7 +34,10 @@
>   * fused off or currently powered down due to power gating, the MMIO operation
>   * is "terminated" by the hardware.  Terminated read operations will return a
>   * value of zero and terminated unicast write operations will be silently
> - * ignored.
> + * ignored. During device initialization, the goal of the various
> + * ``init_steering_*()`` functions is to apply the termination rules for each
> + * steering type and return a steering that selects an instance that is not
> + * fused off.

Bikeshed:  how about wording it as:

        "During device initialization, the goal of the various
        ``init_steering_*()`` functions is to apply the
        platform-specific rules for each MCR register type to identify
        a steering target that will select a non-terminated instance."

Pretty much the same as what you had except that it clarifies these
rules are platform-specific, that "types" are technically register types
rather than steering types (steering behavior is just a detail of the
register type), and that we're 'identifying' rather than 'returning' the
target (since they're void functions).

Up to you whether you like that better or prefer the original form.
Either way,

Reviewed-by: Matt Roper <matthew.d.roper at intel.com>


>   */
>  
>  enum {
> -- 
> 2.39.0
> 

-- 
Matt Roper
Graphics Software Engineer
Linux GPU Platform Enablement
Intel Corporation