[PATCH 3/6] drm/amdgpu/vm: fix up documentation in amdgpu_vm.c

[Christian König]

Am 19.09.19 um 23:45 schrieb Alex Deucher:
> Missing parameters, wrong comment type, etc.
>
> Signed-off-by: Alex Deucher <alexander.deucher at amd.com>
> ---
>   drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c | 17 ++++++++++-------
>   1 file changed, 10 insertions(+), 7 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
> index 2bb53191f655..a2c797e34a29 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
> @@ -342,7 +342,7 @@ static struct amdgpu_vm_pt *amdgpu_vm_pt_parent(struct amdgpu_vm_pt *pt)
>   	return container_of(parent->vm_bo, struct amdgpu_vm_pt, base);
>   }
>   
> -/**
> +/*

Hui? That doesn't look correct to me, why shouldn't this be a 
documentation comment?

Christian.

>    * amdgpu_vm_pt_cursor - state for for_each_amdgpu_vm_pt
>    */
>   struct amdgpu_vm_pt_cursor {
> @@ -483,6 +483,7 @@ static void amdgpu_vm_pt_next(struct amdgpu_device *adev,
>    *
>    * @adev: amdgpu_device structure
>    * @vm: amdgpu_vm structure
> + * @start: optional cursor to start with
>    * @cursor: state to initialize
>    *
>    * Starts a deep first traversal of the PD/PT tree.
> @@ -536,7 +537,7 @@ static void amdgpu_vm_pt_next_dfs(struct amdgpu_device *adev,
>   		amdgpu_vm_pt_ancestor(cursor);
>   }
>   
> -/**
> +/*
>    * for_each_amdgpu_vm_pt_dfs_safe - safe deep first search of all PDs/PTs
>    */
>   #define for_each_amdgpu_vm_pt_dfs_safe(adev, vm, start, cursor, entry)		\
> @@ -857,6 +858,7 @@ static void amdgpu_vm_bo_param(struct amdgpu_device *adev, struct amdgpu_vm *vm,
>    * @adev: amdgpu_device pointer
>    * @vm: VM to allocate page tables for
>    * @cursor: Which page table to allocate
> + * @direct: use a direct update
>    *
>    * Make sure a specific page table or directory is allocated.
>    *
> @@ -1196,10 +1198,10 @@ uint64_t amdgpu_vm_map_gart(const dma_addr_t *pages_addr, uint64_t addr)
>   	return result;
>   }
>   
> -/*
> +/**
>    * amdgpu_vm_update_pde - update a single level in the hierarchy
>    *
> - * @param: parameters for the update
> + * @params: parameters for the update
>    * @vm: requested vm
>    * @entry: entry to update
>    *
> @@ -1223,7 +1225,7 @@ static int amdgpu_vm_update_pde(struct amdgpu_vm_update_params *params,
>   	return vm->update_funcs->update(params, bo, pde, pt, 1, 0, flags);
>   }
>   
> -/*
> +/**
>    * amdgpu_vm_invalidate_pds - mark all PDs as invalid
>    *
>    * @adev: amdgpu_device pointer
> @@ -1242,7 +1244,7 @@ static void amdgpu_vm_invalidate_pds(struct amdgpu_device *adev,
>   			amdgpu_vm_bo_relocated(&entry->base);
>   }
>   
> -/*
> +/**
>    * amdgpu_vm_update_pdes - make sure that all directories are valid
>    *
>    * @adev: amdgpu_device pointer
> @@ -1294,7 +1296,7 @@ int amdgpu_vm_update_pdes(struct amdgpu_device *adev,
>   	return r;
>   }
>   
> -/**
> +/*
>    * amdgpu_vm_update_flags - figure out flags for PTE updates
>    *
>    * Make sure to set the right flags for the PTEs at the desired level.
> @@ -2815,6 +2817,7 @@ static int amdgpu_vm_check_clean_reserved(struct amdgpu_device *adev,
>    *
>    * @adev: amdgpu_device pointer
>    * @vm: requested vm
> + * @pasid: pasid to use
>    *
>    * This only works on GFX VMs that don't have any BOs added and no
>    * page tables allocated yet.