Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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: Fabio M. De Francesco <fmdefrancesco@gmail.com>
Signed-off-by: Alex Deucher <alexander.deucher@amd.com>

authored by

Fabio M. De Francesco and committed by
Alex Deucher
1fdbbc12 a273f315

+13 -11
+6 -6
drivers/gpu/drm/amd/amdgpu/amdgpu_acpi.c
··· 76 76 /** 77 77 * amdgpu_atif_call - call an ATIF method 78 78 * 79 - * @handle: acpi handle 79 + * @atif: acpi handle 80 80 * @function: the ATIF function to execute 81 81 * @params: ATIF function params 82 82 * ··· 166 166 /** 167 167 * amdgpu_atif_verify_interface - verify ATIF 168 168 * 169 - * @handle: acpi handle 170 169 * @atif: amdgpu atif struct 171 170 * 172 171 * Execute the ATIF_FUNCTION_VERIFY_INTERFACE ATIF function ··· 239 240 /** 240 241 * amdgpu_atif_get_notification_params - determine notify configuration 241 242 * 242 - * @handle: acpi handle 243 - * @n: atif notification configuration struct 243 + * @atif: acpi handle 244 244 * 245 245 * Execute the ATIF_FUNCTION_GET_SYSTEM_PARAMETERS ATIF function 246 246 * to determine if a notifier is used and if so which one ··· 302 304 /** 303 305 * amdgpu_atif_query_backlight_caps - get min and max backlight input signal 304 306 * 305 - * @handle: acpi handle 307 + * @atif: acpi handle 306 308 * 307 309 * Execute the QUERY_BRIGHTNESS_TRANSFER_CHARACTERISTICS ATIF function 308 310 * to determine the acceptable range of backlight values ··· 361 363 /** 362 364 * amdgpu_atif_get_sbios_requests - get requested sbios event 363 365 * 364 - * @handle: acpi handle 366 + * @atif: acpi handle 365 367 * @req: atif sbios request struct 366 368 * 367 369 * Execute the ATIF_FUNCTION_GET_SYSTEM_BIOS_REQUESTS ATIF function ··· 896 898 897 899 /** 898 900 * amdgpu_acpi_is_s0ix_supported 901 + * 902 + * @adev: amdgpu_device_pointer 899 903 * 900 904 * returns true if supported, false if not. 901 905 */
+3 -1
drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_fence.c
··· 113 113 * a KFD BO and schedules a job to move the BO. 114 114 * If fence is already signaled return true. 115 115 * If fence is not signaled schedule a evict KFD process work item. 116 + * 117 + * @f: dma_fence 116 118 */ 117 119 static bool amdkfd_fence_enable_signaling(struct dma_fence *f) 118 120 { ··· 139 137 /** 140 138 * amdkfd_fence_release - callback that fence can be freed 141 139 * 142 - * @fence: fence 140 + * @f: dma_fence 143 141 * 144 142 * This function is called when the reference count becomes zero. 145 143 * Drops the mm_struct reference and RCU schedules freeing up the fence.
+4 -4
drivers/gpu/drm/amd/amdgpu/amdgpu_amdkfd_gfx_v9.c
··· 719 719 } 720 720 721 721 /** 722 - * @get_wave_count: Read device registers to get number of waves in flight for 722 + * get_wave_count: Read device registers to get number of waves in flight for 723 723 * a particular queue. The method also returns the VMID associated with the 724 724 * queue. 725 725 * ··· 755 755 } 756 756 757 757 /** 758 - * @kgd_gfx_v9_get_cu_occupancy: Reads relevant registers associated with each 758 + * kgd_gfx_v9_get_cu_occupancy: Reads relevant registers associated with each 759 759 * shader engine and aggregates the number of waves that are in flight for the 760 760 * process whose pasid is provided as a parameter. The process could have ZERO 761 761 * or more queues running and submitting waves to compute units. 762 762 * 763 763 * @kgd: Handle of device from which to get number of waves in flight 764 764 * @pasid: Identifies the process for which this query call is invoked 765 - * @wave_cnt: Output parameter updated with number of waves in flight that 765 + * @pasid_wave_cnt: Output parameter updated with number of waves in flight that 766 766 * belong to process with given pasid 767 767 * @max_waves_per_cu: Output parameter updated with maximum number of waves 768 768 * possible per Compute Unit 769 769 * 770 - * @note: It's possible that the device has too many queues (oversubscription) 770 + * Note: It's possible that the device has too many queues (oversubscription) 771 771 * in which case a VMID could be remapped to a different PASID. This could lead 772 772 * to an iaccurate wave count. Following is a high-level sequence: 773 773 * Time T1: vmid = getVmid(); vmid is associated with Pasid P1