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

drm/amd: fix improper docstring syntax

This fixes various warnings relating to erroneous docstring syntax, of
which some are listed below:

warning: Function parameter or member 'adev' not described in
'amdgpu_atomfirmware_ras_rom_addr'
...
warning: expecting prototype for amdgpu_atpx_validate_functions().
Prototype was for amdgpu_atpx_validate() instead
...
warning: Excess function parameter 'mem' description in 'amdgpu_preempt_mgr_new'
...
warning: Cannot understand * @kfd_get_cu_occupancy - Collect number of
waves in-flight on this device
...
warning: This comment starts with '/**', but isn't a kernel-doc
comment. Refer Documentation/doc-guide/kernel-doc.rst

Signed-off-by: Isabella Basso <isabbasso@riseup.net>
Signed-off-by: Alex Deucher <alexander.deucher@amd.com>

authored by

Isabella Basso and committed by
Alex Deucher
bbe04dec 0e2a82a3

+29 -22
+2 -2
drivers/gpu/drm/amd/amdgpu/amdgpu_atomfirmware.c
··· 470 470 471 471 /** 472 472 * amdgpu_atomfirmware_ras_rom_addr -- Get the RAS EEPROM addr from VBIOS 473 - * adev: amdgpu_device pointer 474 - * i2c_address: pointer to u8; if not NULL, will contain 473 + * @adev: amdgpu_device pointer 474 + * @i2c_address: pointer to u8; if not NULL, will contain 475 475 * the RAS EEPROM address if the function returns true 476 476 * 477 477 * Return true if VBIOS supports RAS EEPROM address reporting,
+1 -1
drivers/gpu/drm/amd/amdgpu/amdgpu_atpx_handler.c
··· 165 165 } 166 166 167 167 /** 168 - * amdgpu_atpx_validate_functions - validate ATPX functions 168 + * amdgpu_atpx_validate - validate ATPX functions 169 169 * 170 170 * @atpx: amdgpu atpx struct 171 171 *
+2 -2
drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
··· 331 331 } 332 332 333 333 /** 334 - * amdgpu_device_vram_access - access vram by vram aperature 334 + * amdgpu_device_aper_access - access vram by vram aperature 335 335 * 336 336 * @adev: amdgpu_device pointer 337 337 * @pos: offset of the buffer in vram ··· 3801 3801 } 3802 3802 3803 3803 /** 3804 - * amdgpu_device_fini - tear down the driver 3804 + * amdgpu_device_fini_hw - tear down the driver 3805 3805 * 3806 3806 * @adev: amdgpu_device pointer 3807 3807 *
+1 -1
drivers/gpu/drm/amd/amdgpu/amdgpu_irq.c
··· 390 390 } 391 391 392 392 /** 393 - * amdgpu_irq_fini - shut down interrupt handling 393 + * amdgpu_irq_fini_sw - shut down interrupt handling 394 394 * 395 395 * @adev: amdgpu device pointer 396 396 *
+2
drivers/gpu/drm/amd/amdgpu/amdgpu_pll.c
··· 69 69 /** 70 70 * amdgpu_pll_get_fb_ref_div - feedback and ref divider calculation 71 71 * 72 + * @adev: amdgpu_device pointer 72 73 * @nom: nominator 73 74 * @den: denominator 74 75 * @post_div: post divider ··· 107 106 /** 108 107 * amdgpu_pll_compute - compute PLL paramaters 109 108 * 109 + * @adev: amdgpu_device pointer 110 110 * @pll: information about the PLL 111 111 * @freq: requested frequency 112 112 * @dot_clock_p: resulting pixel clock
+2 -2
drivers/gpu/drm/amd/amdgpu/amdgpu_preempt_mgr.c
··· 59 59 * @man: TTM memory type manager 60 60 * @tbo: TTM BO we need this range for 61 61 * @place: placement flags and restrictions 62 - * @mem: the resulting mem object 62 + * @res: TTM memory object 63 63 * 64 64 * Dummy, just count the space used without allocating resources or any limit. 65 65 */ ··· 85 85 * amdgpu_preempt_mgr_del - free ranges 86 86 * 87 87 * @man: TTM memory type manager 88 - * @mem: TTM memory object 88 + * @res: TTM memory object 89 89 * 90 90 * Free the allocated GTT again. 91 91 */
+3 -3
drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
··· 1161 1161 1162 1162 /** 1163 1163 * amdgpu_ras_query_error_count -- Get error counts of all IPs 1164 - * adev: pointer to AMD GPU device 1165 - * ce_count: pointer to an integer to be set to the count of correctible errors. 1166 - * ue_count: pointer to an integer to be set to the count of uncorrectible 1164 + * @adev: pointer to AMD GPU device 1165 + * @ce_count: pointer to an integer to be set to the count of correctible errors. 1166 + * @ue_count: pointer to an integer to be set to the count of uncorrectible 1167 1167 * errors. 1168 1168 * 1169 1169 * If set, @ce_count or @ue_count, count and return the corresponding
-1
drivers/gpu/drm/amd/amdgpu/amdgpu_vce.c
··· 434 434 * 435 435 * @ring: ring we should submit the msg to 436 436 * @handle: VCE session handle to use 437 - * @bo: amdgpu object for which we query the offset 438 437 * @fence: optional fence to return 439 438 * 440 439 * Open up a stream for HW test
-2
drivers/gpu/drm/amd/amdgpu/sdma_v5_0.c
··· 481 481 * sdma_v5_0_ring_emit_mem_sync - flush the IB by graphics cache rinse 482 482 * 483 483 * @ring: amdgpu ring pointer 484 - * @job: job to retrieve vmid from 485 - * @ib: IB object to schedule 486 484 * 487 485 * flush the IB by graphics cache rinse. 488 486 */
-2
drivers/gpu/drm/amd/amdgpu/sdma_v5_2.c
··· 368 368 * sdma_v5_2_ring_emit_mem_sync - flush the IB by graphics cache rinse 369 369 * 370 370 * @ring: amdgpu ring pointer 371 - * @job: job to retrieve vmid from 372 - * @ib: IB object to schedule 373 371 * 374 372 * flush the IB by graphics cache rinse. 375 373 */
+2 -2
drivers/gpu/drm/amd/amdkfd/kfd_migrate.c
··· 108 108 * svm_migrate_copy_memory_gart - sdma copy data between ram and vram 109 109 * 110 110 * @adev: amdgpu device the sdma ring running 111 - * @src: source page address array 112 - * @dst: destination page address array 111 + * @sys: system DMA pointer to be copied 112 + * @vram: vram destination DMA pointer 113 113 * @npages: number of pages to copy 114 114 * @direction: enum MIGRATION_COPY_DIR 115 115 * @mfence: output, sdma fence to signal after sdma is done
+2 -3
drivers/gpu/drm/amd/amdkfd/kfd_process.c
··· 251 251 } 252 252 253 253 /** 254 - * @kfd_get_cu_occupancy - Collect number of waves in-flight on this device 254 + * kfd_get_cu_occupancy - Collect number of waves in-flight on this device 255 255 * by current process. Translates acquired wave count into number of compute units 256 256 * that are occupied. 257 257 * 258 - * @atr: Handle of attribute that allows reporting of wave count. The attribute 258 + * @attr: Handle of attribute that allows reporting of wave count. The attribute 259 259 * handle encapsulates GPU device it is associated with, thereby allowing collection 260 260 * of waves in flight, etc 261 - * 262 261 * @buffer: Handle of user provided buffer updated with wave count 263 262 * 264 263 * Return: Number of bytes written to user buffer or an error value
+7
drivers/gpu/drm/amd/amdkfd/kfd_svm.c
··· 1650 1650 1651 1651 /** 1652 1652 * svm_range_evict - evict svm range 1653 + * @prange: svm range structure 1654 + * @mm: current process mm_struct 1655 + * @start: starting process queue number 1656 + * @last: last process queue number 1653 1657 * 1654 1658 * Stop all queues of the process to ensure GPU doesn't access the memory, then 1655 1659 * return to let CPU evict the buffer and proceed CPU pagetable update. ··· 2165 2161 2166 2162 /** 2167 2163 * svm_range_cpu_invalidate_pagetables - interval notifier callback 2164 + * @mni: mmu_interval_notifier struct 2165 + * @range: mmu_notifier_range struct 2166 + * @cur_seq: value to pass to mmu_interval_set_seq() 2168 2167 * 2169 2168 * If event is MMU_NOTIFY_UNMAP, this is from CPU unmap range, otherwise, it 2170 2169 * is from migration, or CPU page invalidation callback.
+4
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm_color.c
··· 285 285 } 286 286 287 287 /** 288 + * amdgpu_dm_verify_lut_sizes 289 + * @crtc_state: the DRM CRTC state 290 + * 288 291 * Verifies that the Degamma and Gamma LUTs attached to the |crtc_state| are of 289 292 * the expected size. 293 + * 290 294 * Returns 0 on success. 291 295 */ 292 296 int amdgpu_dm_verify_lut_sizes(const struct drm_crtc_state *crtc_state)
+1 -1
drivers/gpu/drm/amd/pm/swsmu/smu_cmn.c
··· 94 94 95 95 /** 96 96 * __smu_cmn_poll_stat -- poll for a status from the SMU 97 - * smu: a pointer to SMU context 97 + * @smu: a pointer to SMU context 98 98 * 99 99 * Returns the status of the SMU, which could be, 100 100 * 0, the SMU is busy with your command;