Commit 1fdbbc12 authored by Fabio M. De Francesco's avatar Fabio M. De Francesco Committed by Alex Deucher
Browse files

drm/amd/amdgpu: Fix errors in documentation of function parameters 



In the function documentation, I removed the excess parameters,
described the undocumented ones, and fixed the syntax errors.

Signed-off-by: default avatarFabio M. De Francesco <fmdefrancesco@gmail.com>
Signed-off-by: default avatarAlex Deucher <alexander.deucher@amd.com>
parent a273f315

drivers/gpu/drm/amd/amdgpu/amdgpu_acpi.c

+6 −6
Original line number Diff line number Diff line
@@ -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)

drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_fence.c

+3 −1
Original line number Diff line number Diff line
@@ -113,6 +113,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)

{
@@ -137,7 +139,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.

drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_gfx_v9.c

+4 −4
Original line number Diff line number Diff line
@@ -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