Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 87e3f136 authored by Darren Powell's avatar Darren Powell Committed by Alex Deucher
Browse files

drm/amd: Remove errors from sphinx documentation 



Eliminating the warnings produced by sphinx when processing the sphinx comments in
 amdgpu_device.c & amdgpu_mn.c

Signed-off-by: default avatarDarren Powell <darren.powell@amd.com>
Reviewed-by: default avatarMichel Dänzer <michel.daenzer@amd.com>
Signed-off-by: default avatarAlex Deucher <alexander.deucher@amd.com>
parent 6f3472a9

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

+12 −8
Original line number Diff line number Diff line
@@ -1076,7 +1076,7 @@ static const struct vga_switcheroo_client_ops amdgpu_switcheroo_ops = { 
/**

 * amdgpu_device_ip_set_clockgating_state - set the CG state

 *

 * @adev: amdgpu_device pointer

 * @dev: amdgpu_device pointer

 * @block_type: Type of hardware IP (SMU, GFX, UVD, etc.)

 * @state: clockgating state (gate or ungate)

 *
@@ -1110,7 +1110,7 @@ int amdgpu_device_ip_set_clockgating_state(void *dev, 
/**

 * amdgpu_device_ip_set_powergating_state - set the PG state

 *

 * @adev: amdgpu_device pointer

 * @dev: amdgpu_device pointer

 * @block_type: Type of hardware IP (SMU, GFX, UVD, etc.)

 * @state: powergating state (gate or ungate)

 *
@@ -1221,7 +1221,7 @@ bool amdgpu_device_ip_is_idle(struct amdgpu_device *adev, 
 * amdgpu_device_ip_get_ip_block - get a hw IP pointer

 *

 * @adev: amdgpu_device pointer

 * @block_type: Type of hardware IP (SMU, GFX, UVD, etc.)

 * @type: Type of hardware IP (SMU, GFX, UVD, etc.)

 *

 * Returns a pointer to the hardware IP block structure

 * if it exists for the asic, otherwise NULL.
@@ -2229,7 +2229,7 @@ bool amdgpu_device_has_dc_support(struct amdgpu_device *adev) 
 * amdgpu_device_init - initialize the driver

 *

 * @adev: amdgpu_device pointer

 * @pdev: drm dev pointer

 * @ddev: drm dev pointer

 * @pdev: pci dev pointer

 * @flags: driver flags

 *
@@ -2602,8 +2602,9 @@ void amdgpu_device_fini(struct amdgpu_device *adev) 
/**

 * amdgpu_device_suspend - initiate device suspend

 *

 * @pdev: drm dev pointer

 * @state: suspend state

 * @dev: drm dev pointer

 * @suspend: suspend state

 * @fbcon : notify the fbdev of suspend

 *

 * Puts the hw in the suspend state (all asics).

 * Returns 0 for success or an error on failure.
@@ -2701,7 +2702,9 @@ int amdgpu_device_suspend(struct drm_device *dev, bool suspend, bool fbcon) 
/**

 * amdgpu_device_resume - initiate device resume

 *

 * @pdev: drm dev pointer

 * @dev: drm dev pointer

 * @resume: resume state

 * @fbcon : notify the fbdev of resume

 *

 * Bring the hw back to operating state (all asics).

 * Returns 0 for success or an error on failure.
@@ -3164,6 +3167,7 @@ static int amdgpu_device_reset(struct amdgpu_device *adev) 
 * amdgpu_device_reset_sriov - reset ASIC for SR-IOV vf

 *

 * @adev: amdgpu device pointer

 * @from_hypervisor: request from hypervisor

 *

 * do VF FLR and reinitialize Asic

 * return 0 means successed otherwise failed
@@ -3211,7 +3215,7 @@ static int amdgpu_device_reset_sriov(struct amdgpu_device *adev, 
 *

 * @adev: amdgpu device pointer

 * @job: which job trigger hang

 * @force forces reset regardless of amdgpu_gpu_recovery

 * @force: forces reset regardless of amdgpu_gpu_recovery

 *

 * Attempt to reset the GPU if it has hung (all asics).

 * Returns 0 for success or an error on failure.

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

+3 −2
Original line number Diff line number Diff line
@@ -58,7 +58,8 @@ 
 *

 * @adev: amdgpu device pointer

 * @mm: process address space

 * @mn: MMU notifier structur

 * @mn: MMU notifier structure

 * @type: type of MMU notifier

 * @work: destruction work item

 * @node: hash table node to find structure by adev and mn

 * @lock: rw semaphore protecting the notifier nodes
@@ -266,7 +267,7 @@ static void amdgpu_mn_invalidate_range_start_gfx(struct mmu_notifier *mn, 
 * amdgpu_mn_invalidate_range_start_hsa - callback to notify about mm change

 *

 * @mn: our notifier

 * @mn: the mm this callback is about

 * @mm: the mm this callback is about

 * @start: start of updated range

 * @end: end of updated range

 *