Commit bbe04dec authored by Isabella Basso's avatar Isabella Basso Committed by Alex Deucher

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: default avatarIsabella Basso <isabbasso@riseup.net>
Signed-off-by: default avatarAlex Deucher <alexander.deucher@amd.com>
parent 0e2a82a3
...@@ -470,8 +470,8 @@ bool amdgpu_atomfirmware_dynamic_boot_config_supported(struct amdgpu_device *ade ...@@ -470,8 +470,8 @@ bool amdgpu_atomfirmware_dynamic_boot_config_supported(struct amdgpu_device *ade
/** /**
* amdgpu_atomfirmware_ras_rom_addr -- Get the RAS EEPROM addr from VBIOS * amdgpu_atomfirmware_ras_rom_addr -- Get the RAS EEPROM addr from VBIOS
* adev: amdgpu_device pointer * @adev: amdgpu_device pointer
* i2c_address: pointer to u8; if not NULL, will contain * @i2c_address: pointer to u8; if not NULL, will contain
* the RAS EEPROM address if the function returns true * the RAS EEPROM address if the function returns true
* *
* Return true if VBIOS supports RAS EEPROM address reporting, * Return true if VBIOS supports RAS EEPROM address reporting,
......
...@@ -165,7 +165,7 @@ static void amdgpu_atpx_parse_functions(struct amdgpu_atpx_functions *f, u32 mas ...@@ -165,7 +165,7 @@ static void amdgpu_atpx_parse_functions(struct amdgpu_atpx_functions *f, u32 mas
} }
/** /**
* amdgpu_atpx_validate_functions - validate ATPX functions * amdgpu_atpx_validate - validate ATPX functions
* *
* @atpx: amdgpu atpx struct * @atpx: amdgpu atpx struct
* *
......
...@@ -331,7 +331,7 @@ void amdgpu_device_mm_access(struct amdgpu_device *adev, loff_t pos, ...@@ -331,7 +331,7 @@ void amdgpu_device_mm_access(struct amdgpu_device *adev, loff_t pos,
} }
/** /**
* amdgpu_device_vram_access - access vram by vram aperature * amdgpu_device_aper_access - access vram by vram aperature
* *
* @adev: amdgpu_device pointer * @adev: amdgpu_device pointer
* @pos: offset of the buffer in vram * @pos: offset of the buffer in vram
...@@ -3801,7 +3801,7 @@ static void amdgpu_device_unmap_mmio(struct amdgpu_device *adev) ...@@ -3801,7 +3801,7 @@ static void amdgpu_device_unmap_mmio(struct amdgpu_device *adev)
} }
/** /**
* amdgpu_device_fini - tear down the driver * amdgpu_device_fini_hw - tear down the driver
* *
* @adev: amdgpu_device pointer * @adev: amdgpu_device pointer
* *
......
...@@ -390,7 +390,7 @@ void amdgpu_irq_fini_hw(struct amdgpu_device *adev) ...@@ -390,7 +390,7 @@ void amdgpu_irq_fini_hw(struct amdgpu_device *adev)
} }
/** /**
* amdgpu_irq_fini - shut down interrupt handling * amdgpu_irq_fini_sw - shut down interrupt handling
* *
* @adev: amdgpu device pointer * @adev: amdgpu device pointer
* *
......
...@@ -69,6 +69,7 @@ static void amdgpu_pll_reduce_ratio(unsigned *nom, unsigned *den, ...@@ -69,6 +69,7 @@ static void amdgpu_pll_reduce_ratio(unsigned *nom, unsigned *den,
/** /**
* amdgpu_pll_get_fb_ref_div - feedback and ref divider calculation * amdgpu_pll_get_fb_ref_div - feedback and ref divider calculation
* *
* @adev: amdgpu_device pointer
* @nom: nominator * @nom: nominator
* @den: denominator * @den: denominator
* @post_div: post divider * @post_div: post divider
...@@ -106,6 +107,7 @@ static void amdgpu_pll_get_fb_ref_div(struct amdgpu_device *adev, unsigned int n ...@@ -106,6 +107,7 @@ static void amdgpu_pll_get_fb_ref_div(struct amdgpu_device *adev, unsigned int n
/** /**
* amdgpu_pll_compute - compute PLL paramaters * amdgpu_pll_compute - compute PLL paramaters
* *
* @adev: amdgpu_device pointer
* @pll: information about the PLL * @pll: information about the PLL
* @freq: requested frequency * @freq: requested frequency
* @dot_clock_p: resulting pixel clock * @dot_clock_p: resulting pixel clock
......
...@@ -59,7 +59,7 @@ static DEVICE_ATTR_RO(mem_info_preempt_used); ...@@ -59,7 +59,7 @@ static DEVICE_ATTR_RO(mem_info_preempt_used);
* @man: TTM memory type manager * @man: TTM memory type manager
* @tbo: TTM BO we need this range for * @tbo: TTM BO we need this range for
* @place: placement flags and restrictions * @place: placement flags and restrictions
* @mem: the resulting mem object * @res: TTM memory object
* *
* Dummy, just count the space used without allocating resources or any limit. * Dummy, just count the space used without allocating resources or any limit.
*/ */
...@@ -85,7 +85,7 @@ static int amdgpu_preempt_mgr_new(struct ttm_resource_manager *man, ...@@ -85,7 +85,7 @@ static int amdgpu_preempt_mgr_new(struct ttm_resource_manager *man,
* amdgpu_preempt_mgr_del - free ranges * amdgpu_preempt_mgr_del - free ranges
* *
* @man: TTM memory type manager * @man: TTM memory type manager
* @mem: TTM memory object * @res: TTM memory object
* *
* Free the allocated GTT again. * Free the allocated GTT again.
*/ */
......
...@@ -1161,9 +1161,9 @@ int amdgpu_ras_error_inject(struct amdgpu_device *adev, ...@@ -1161,9 +1161,9 @@ int amdgpu_ras_error_inject(struct amdgpu_device *adev,
/** /**
* amdgpu_ras_query_error_count -- Get error counts of all IPs * amdgpu_ras_query_error_count -- Get error counts of all IPs
* adev: pointer to AMD GPU device * @adev: pointer to AMD GPU device
* ce_count: pointer to an integer to be set to the count of correctible errors. * @ce_count: pointer to an integer to be set to the count of correctible errors.
* ue_count: pointer to an integer to be set to the count of uncorrectible * @ue_count: pointer to an integer to be set to the count of uncorrectible
* errors. * errors.
* *
* If set, @ce_count or @ue_count, count and return the corresponding * If set, @ce_count or @ue_count, count and return the corresponding
......
...@@ -434,7 +434,6 @@ void amdgpu_vce_free_handles(struct amdgpu_device *adev, struct drm_file *filp) ...@@ -434,7 +434,6 @@ void amdgpu_vce_free_handles(struct amdgpu_device *adev, struct drm_file *filp)
* *
* @ring: ring we should submit the msg to * @ring: ring we should submit the msg to
* @handle: VCE session handle to use * @handle: VCE session handle to use
* @bo: amdgpu object for which we query the offset
* @fence: optional fence to return * @fence: optional fence to return
* *
* Open up a stream for HW test * Open up a stream for HW test
......
...@@ -481,8 +481,6 @@ static void sdma_v5_0_ring_emit_ib(struct amdgpu_ring *ring, ...@@ -481,8 +481,6 @@ static void sdma_v5_0_ring_emit_ib(struct amdgpu_ring *ring,
* sdma_v5_0_ring_emit_mem_sync - flush the IB by graphics cache rinse * sdma_v5_0_ring_emit_mem_sync - flush the IB by graphics cache rinse
* *
* @ring: amdgpu ring pointer * @ring: amdgpu ring pointer
* @job: job to retrieve vmid from
* @ib: IB object to schedule
* *
* flush the IB by graphics cache rinse. * flush the IB by graphics cache rinse.
*/ */
......
...@@ -368,8 +368,6 @@ static void sdma_v5_2_ring_emit_ib(struct amdgpu_ring *ring, ...@@ -368,8 +368,6 @@ static void sdma_v5_2_ring_emit_ib(struct amdgpu_ring *ring,
* sdma_v5_2_ring_emit_mem_sync - flush the IB by graphics cache rinse * sdma_v5_2_ring_emit_mem_sync - flush the IB by graphics cache rinse
* *
* @ring: amdgpu ring pointer * @ring: amdgpu ring pointer
* @job: job to retrieve vmid from
* @ib: IB object to schedule
* *
* flush the IB by graphics cache rinse. * flush the IB by graphics cache rinse.
*/ */
......
...@@ -108,8 +108,8 @@ svm_migrate_gart_map(struct amdgpu_ring *ring, uint64_t npages, ...@@ -108,8 +108,8 @@ svm_migrate_gart_map(struct amdgpu_ring *ring, uint64_t npages,
* svm_migrate_copy_memory_gart - sdma copy data between ram and vram * svm_migrate_copy_memory_gart - sdma copy data between ram and vram
* *
* @adev: amdgpu device the sdma ring running * @adev: amdgpu device the sdma ring running
* @src: source page address array * @sys: system DMA pointer to be copied
* @dst: destination page address array * @vram: vram destination DMA pointer
* @npages: number of pages to copy * @npages: number of pages to copy
* @direction: enum MIGRATION_COPY_DIR * @direction: enum MIGRATION_COPY_DIR
* @mfence: output, sdma fence to signal after sdma is done * @mfence: output, sdma fence to signal after sdma is done
......
...@@ -251,14 +251,13 @@ static void kfd_sdma_activity_worker(struct work_struct *work) ...@@ -251,14 +251,13 @@ static void kfd_sdma_activity_worker(struct work_struct *work)
} }
/** /**
* @kfd_get_cu_occupancy - Collect number of waves in-flight on this device * kfd_get_cu_occupancy - Collect number of waves in-flight on this device
* by current process. Translates acquired wave count into number of compute units * by current process. Translates acquired wave count into number of compute units
* that are occupied. * that are occupied.
* *
* @atr: Handle of attribute that allows reporting of wave count. The attribute * @attr: Handle of attribute that allows reporting of wave count. The attribute
* handle encapsulates GPU device it is associated with, thereby allowing collection * handle encapsulates GPU device it is associated with, thereby allowing collection
* of waves in flight, etc * of waves in flight, etc
*
* @buffer: Handle of user provided buffer updated with wave count * @buffer: Handle of user provided buffer updated with wave count
* *
* Return: Number of bytes written to user buffer or an error value * Return: Number of bytes written to user buffer or an error value
......
...@@ -1650,6 +1650,10 @@ static void svm_range_restore_work(struct work_struct *work) ...@@ -1650,6 +1650,10 @@ static void svm_range_restore_work(struct work_struct *work)
/** /**
* svm_range_evict - evict svm range * svm_range_evict - evict svm range
* @prange: svm range structure
* @mm: current process mm_struct
* @start: starting process queue number
* @last: last process queue number
* *
* Stop all queues of the process to ensure GPU doesn't access the memory, then * Stop all queues of the process to ensure GPU doesn't access the memory, then
* return to let CPU evict the buffer and proceed CPU pagetable update. * return to let CPU evict the buffer and proceed CPU pagetable update.
...@@ -2161,6 +2165,9 @@ svm_range_unmap_from_cpu(struct mm_struct *mm, struct svm_range *prange, ...@@ -2161,6 +2165,9 @@ svm_range_unmap_from_cpu(struct mm_struct *mm, struct svm_range *prange,
/** /**
* svm_range_cpu_invalidate_pagetables - interval notifier callback * svm_range_cpu_invalidate_pagetables - interval notifier callback
* @mni: mmu_interval_notifier struct
* @range: mmu_notifier_range struct
* @cur_seq: value to pass to mmu_interval_set_seq()
* *
* If event is MMU_NOTIFY_UNMAP, this is from CPU unmap range, otherwise, it * If event is MMU_NOTIFY_UNMAP, this is from CPU unmap range, otherwise, it
* is from migration, or CPU page invalidation callback. * is from migration, or CPU page invalidation callback.
......
...@@ -285,8 +285,12 @@ static int __set_input_tf(struct dc_transfer_func *func, ...@@ -285,8 +285,12 @@ static int __set_input_tf(struct dc_transfer_func *func,
} }
/** /**
* amdgpu_dm_verify_lut_sizes
* @crtc_state: the DRM CRTC state
*
* Verifies that the Degamma and Gamma LUTs attached to the |crtc_state| are of * Verifies that the Degamma and Gamma LUTs attached to the |crtc_state| are of
* the expected size. * the expected size.
*
* Returns 0 on success. * Returns 0 on success.
*/ */
int amdgpu_dm_verify_lut_sizes(const struct drm_crtc_state *crtc_state) int amdgpu_dm_verify_lut_sizes(const struct drm_crtc_state *crtc_state)
......
...@@ -94,7 +94,7 @@ static void smu_cmn_read_arg(struct smu_context *smu, ...@@ -94,7 +94,7 @@ static void smu_cmn_read_arg(struct smu_context *smu,
/** /**
* __smu_cmn_poll_stat -- poll for a status from the SMU * __smu_cmn_poll_stat -- poll for a status from the SMU
* smu: a pointer to SMU context * @smu: a pointer to SMU context
* *
* Returns the status of the SMU, which could be, * Returns the status of the SMU, which could be,
* 0, the SMU is busy with your command; * 0, the SMU is busy with your command;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment