[PATCH v10 2/4] drm/doc: Document device wedged event

[André Almeida]

Em 28/11/2024 12:37, Raag Jadav escreveu:
> Add documentation for device wedged event in a new 'Device wedging'
> chapter. The describes basic definitions, prerequisites and consumer
> expectations along with an example.
> 
>   v8: Improve documentation (Christian, Rodrigo)
>   v9: Add prerequisites section (Christian)
> v10: Clarify mmap cleanup and consumer prerequisites (Christian, Aravind)
> 
> Signed-off-by: Raag Jadav <raag.jadav at intel.com>
> Reviewed-by: Christian König <christian.koenig at amd.com>
> ---
>   Documentation/gpu/drm-uapi.rst | 112 ++++++++++++++++++++++++++++++++-
>   1 file changed, 109 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/gpu/drm-uapi.rst b/Documentation/gpu/drm-uapi.rst
> index b75cc9a70d1f..da2927cde53d 100644
> --- a/Documentation/gpu/drm-uapi.rst
> +++ b/Documentation/gpu/drm-uapi.rst
> @@ -371,9 +371,115 @@ Reporting causes of resets

I think it's a good idea to add a note about "device wedged event" in 
the section "Device reset > Kernel Mode Driver" since the idea is to 
explain what should kernel developer add to their kernel drivers to be 
used when a device resets.

>   
>   Apart from propagating the reset through the stack so apps can recover, it's
>   really useful for driver developers to learn more about what caused the reset in
> -the first place. DRM devices should make use of devcoredump to store relevant
> -information about the reset, so this information can be added to user bug
> -reports.
> +the first place. For this, drivers can make use of devcoredump to store relevant
> +information about the reset and send device wedged event without recovery method

and send a device wedged event with recovery method as "none" (as 
explained in the chapter "Device wedging")

> +(as explained in next chapter) to notify userspace, so this information can be
> +collected and added to user bug reports.
> +

With those changes applied:

Reviewed-by: André Almeida <andrealmeid at igalia.com>