Commit bbe04dec authored Dec 07, 2021 by Isabella Basso Committed by Alex Deucher Dec 13, 2021

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>

parent 0e2a82a3

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

+2 −2

Original line number	Diff line number	Diff line
		@@ -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
		* adev: amdgpu_device pointer
		* i2c_address: pointer to u8; if not NULL, will contain
		* @adev: amdgpu_device pointer
		* @i2c_address: pointer to u8; if not NULL, will contain
		* the RAS EEPROM address if the function returns true
		*
		* Return true if VBIOS supports RAS EEPROM address reporting,

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

+1 −1

Original line number	Diff line number	Diff line
		@@ -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
		*

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

+2 −2

Original line number	Diff line number	Diff line
		@@ -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
		* @pos: offset of the buffer in vram
		@@ -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
		*

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

+1 −1

Original line number	Diff line number	Diff line
		@@ -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
		*

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

+2 −0

Original line number	Diff line number	Diff line
		@@ -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
		*
		* @adev: amdgpu_device pointer
		* @nom: nominator
		* @den: denominator
		* @post_div: post divider
		@@ -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
		*
		* @adev: amdgpu_device pointer
		* @pll: information about the PLL
		* @freq: requested frequency
		* @dot_clock_p: resulting pixel clock