lkml.org 
[lkml]   [2021]   [Apr]   [29]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
SubjectRe: [PATCH v2] drm/amd/amdgpu: Fix errors in documentation of function parameters
From
Date
On 2021-04-27 7:27, Fabio M. De Francesco wrote:
> In the documentation of functions, removed excess parameters, described
> undocumented ones, and fixed syntax errors.
>
> Signed-off-by: Fabio M. De Francesco <fmdefrancesco@gmail.com>
> ---
>
> Changes from v1: Cc'ed all the maintainers.

Looks like Alex already applied V1. So this one doesn't apply. "git am
-3" tells me:

Applying: drm/amd/amdgpu: Fix errors in documentation of function parameters
Using index info to reconstruct a base tree...
M drivers/gpu/drm/amd/amdgpu/amdgpu_acpi.c
M drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_fence.c
M drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_gfx_v9.c
Falling back to patching base and 3-way merge...
No changes -- Patch already applied.

Regards,
  Felix


>
> drivers/gpu/drm/amd/amdgpu/amdgpu_acpi.c | 12 ++++++------
> drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_fence.c | 4 +++-
> drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_gfx_v9.c | 8 ++++----
> 3 files changed, 13 insertions(+), 11 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_acpi.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_acpi.c
> index 2e9b16fb3fcd..bf2939b6eb43 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_acpi.c
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_acpi.c
> @@ -76,7 +76,7 @@ struct amdgpu_atif {
> /**
> * amdgpu_atif_call - call an ATIF method
> *
> - * @handle: acpi handle
> + * @atif: acpi handle
> * @function: the ATIF function to execute
> * @params: ATIF function params
> *
> @@ -166,7 +166,6 @@ static void amdgpu_atif_parse_functions(struct amdgpu_atif_functions *f, u32 mas
> /**
> * amdgpu_atif_verify_interface - verify ATIF
> *
> - * @handle: acpi handle
> * @atif: amdgpu atif struct
> *
> * Execute the ATIF_FUNCTION_VERIFY_INTERFACE ATIF function
> @@ -240,8 +239,7 @@ static acpi_handle amdgpu_atif_probe_handle(acpi_handle dhandle)
> /**
> * amdgpu_atif_get_notification_params - determine notify configuration
> *
> - * @handle: acpi handle
> - * @n: atif notification configuration struct
> + * @atif: acpi handle
> *
> * Execute the ATIF_FUNCTION_GET_SYSTEM_PARAMETERS ATIF function
> * to determine if a notifier is used and if so which one
> @@ -304,7 +302,7 @@ static int amdgpu_atif_get_notification_params(struct amdgpu_atif *atif)
> /**
> * amdgpu_atif_query_backlight_caps - get min and max backlight input signal
> *
> - * @handle: acpi handle
> + * @atif: acpi handle
> *
> * Execute the QUERY_BRIGHTNESS_TRANSFER_CHARACTERISTICS ATIF function
> * to determine the acceptable range of backlight values
> @@ -363,7 +361,7 @@ static int amdgpu_atif_query_backlight_caps(struct amdgpu_atif *atif)
> /**
> * amdgpu_atif_get_sbios_requests - get requested sbios event
> *
> - * @handle: acpi handle
> + * @atif: acpi handle
> * @req: atif sbios request struct
> *
> * Execute the ATIF_FUNCTION_GET_SYSTEM_BIOS_REQUESTS ATIF function
> @@ -899,6 +897,8 @@ void amdgpu_acpi_fini(struct amdgpu_device *adev)
> /**
> * amdgpu_acpi_is_s0ix_supported
> *
> + * @adev: amdgpu_device_pointer
> + *
> * returns true if supported, false if not.
> */
> bool amdgpu_acpi_is_s0ix_supported(struct amdgpu_device *adev)
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_fence.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_fence.c
> index 5af464933976..98d31ebad9ce 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_fence.c
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_fence.c
> @@ -111,6 +111,8 @@ static const char *amdkfd_fence_get_timeline_name(struct dma_fence *f)
> * a KFD BO and schedules a job to move the BO.
> * If fence is already signaled return true.
> * If fence is not signaled schedule a evict KFD process work item.
> + *
> + * @f: dma_fence
> */
> static bool amdkfd_fence_enable_signaling(struct dma_fence *f)
> {
> @@ -131,7 +133,7 @@ static bool amdkfd_fence_enable_signaling(struct dma_fence *f)
> /**
> * amdkfd_fence_release - callback that fence can be freed
> *
> - * @fence: fence
> + * @f: dma_fence
> *
> * This function is called when the reference count becomes zero.
> * Drops the mm_struct reference and RCU schedules freeing up the fence.
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_gfx_v9.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_gfx_v9.c
> index b43e68fc1378..ed3014fbb563 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_gfx_v9.c
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_gfx_v9.c
> @@ -719,7 +719,7 @@ static void unlock_spi_csq_mutexes(struct amdgpu_device *adev)
> }
>
> /**
> - * @get_wave_count: Read device registers to get number of waves in flight for
> + * get_wave_count: Read device registers to get number of waves in flight for
> * a particular queue. The method also returns the VMID associated with the
> * queue.
> *
> @@ -755,19 +755,19 @@ static void get_wave_count(struct amdgpu_device *adev, int queue_idx,
> }
>
> /**
> - * @kgd_gfx_v9_get_cu_occupancy: Reads relevant registers associated with each
> + * kgd_gfx_v9_get_cu_occupancy: Reads relevant registers associated with each
> * shader engine and aggregates the number of waves that are in flight for the
> * process whose pasid is provided as a parameter. The process could have ZERO
> * or more queues running and submitting waves to compute units.
> *
> * @kgd: Handle of device from which to get number of waves in flight
> * @pasid: Identifies the process for which this query call is invoked
> - * @wave_cnt: Output parameter updated with number of waves in flight that
> + * @pasid_wave_cnt: Output parameter updated with number of waves in flight that
> * belong to process with given pasid
> * @max_waves_per_cu: Output parameter updated with maximum number of waves
> * possible per Compute Unit
> *
> - * @note: It's possible that the device has too many queues (oversubscription)
> + * Note: It's possible that the device has too many queues (oversubscription)
> * in which case a VMID could be remapped to a different PASID. This could lead
> * to an iaccurate wave count. Following is a high-level sequence:
> * Time T1: vmid = getVmid(); vmid is associated with Pasid P1

\
 
 \ /
  Last update: 2021-04-29 08:45    [W:0.081 / U:2.604 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site