2020-03-06 10:31:25

by Benjamin GAIGNARD

[permalink] [raw]
Subject: [PATCH] drm: vm: Clean up documentation

Fix kernel doc comments to avoid warnings when compiling with W=1.

Signed-off-by: Benjamin Gaignard <[email protected]>
---
drivers/gpu/drm/drm_vm.c | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/drivers/gpu/drm/drm_vm.c b/drivers/gpu/drm/drm_vm.c
index 64619fe90046..aa88911bbc06 100644
--- a/drivers/gpu/drm/drm_vm.c
+++ b/drivers/gpu/drm/drm_vm.c
@@ -102,7 +102,7 @@ static pgprot_t drm_dma_prot(uint32_t map_type, struct vm_area_struct *vma)
return tmp;
}

-/**
+/*
* \c fault method for AGP virtual memory.
*
* \param vma virtual memory area.
@@ -192,7 +192,7 @@ static vm_fault_t drm_vm_fault(struct vm_fault *vmf)
}
#endif

-/**
+/*
* \c nopage method for shared virtual memory.
*
* \param vma virtual memory area.
@@ -225,7 +225,7 @@ static vm_fault_t drm_vm_shm_fault(struct vm_fault *vmf)
return 0;
}

-/**
+/*
* \c close method for shared virtual memory.
*
* \param vma virtual memory area.
@@ -294,7 +294,7 @@ static void drm_vm_shm_close(struct vm_area_struct *vma)
mutex_unlock(&dev->struct_mutex);
}

-/**
+/*
* \c fault method for DMA virtual memory.
*
* \param address access address.
@@ -329,7 +329,7 @@ static vm_fault_t drm_vm_dma_fault(struct vm_fault *vmf)
return 0;
}

-/**
+/*
* \c fault method for scatter-gather virtual memory.
*
* \param address access address.
@@ -435,7 +435,7 @@ static void drm_vm_close_locked(struct drm_device *dev,
}
}

-/**
+/*
* \c close method for all virtual memory types.
*
* \param vma virtual memory area.
@@ -453,7 +453,7 @@ static void drm_vm_close(struct vm_area_struct *vma)
mutex_unlock(&dev->struct_mutex);
}

-/**
+/*
* mmap DMA memory.
*
* \param file_priv DRM file private.
@@ -513,7 +513,7 @@ static resource_size_t drm_core_get_reg_ofs(struct drm_device *dev)
#endif
}

-/**
+/*
* mmap DMA memory.
*
* \param file_priv DRM file private.
--
2.15.0


2020-03-06 10:31:58

by Benjamin GAIGNARD

[permalink] [raw]
Subject: [PATCH v2] drm: context: Clean up documentation

Fix kernel doc comments to avoid warnings when compiling with W=1.

Signed-off-by: Benjamin Gaignard <[email protected]>
---
version 2:
- Since it is legacy interface do not fix the description but
replace /** by /* to remove kerneldoc validation warnings

drivers/gpu/drm/drm_context.c | 28 ++++++++++++++--------------
1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/drivers/gpu/drm/drm_context.c b/drivers/gpu/drm/drm_context.c
index 1f802d8e5681..c99be950bf17 100644
--- a/drivers/gpu/drm/drm_context.c
+++ b/drivers/gpu/drm/drm_context.c
@@ -47,7 +47,7 @@ struct drm_ctx_list {
/** \name Context bitmap support */
/*@{*/

-/**
+/*
* Free a handle from the context bitmap.
*
* \param dev DRM device.
@@ -68,7 +68,7 @@ void drm_legacy_ctxbitmap_free(struct drm_device * dev, int ctx_handle)
mutex_unlock(&dev->struct_mutex);
}

-/**
+/*
* Context bitmap allocation.
*
* \param dev DRM device.
@@ -88,7 +88,7 @@ static int drm_legacy_ctxbitmap_next(struct drm_device * dev)
return ret;
}

-/**
+/*
* Context bitmap initialization.
*
* \param dev DRM device.
@@ -104,7 +104,7 @@ void drm_legacy_ctxbitmap_init(struct drm_device * dev)
idr_init(&dev->ctx_idr);
}

-/**
+/*
* Context bitmap cleanup.
*
* \param dev DRM device.
@@ -163,7 +163,7 @@ void drm_legacy_ctxbitmap_flush(struct drm_device *dev, struct drm_file *file)
/** \name Per Context SAREA Support */
/*@{*/

-/**
+/*
* Get per-context SAREA.
*
* \param inode device inode.
@@ -211,7 +211,7 @@ int drm_legacy_getsareactx(struct drm_device *dev, void *data,
return 0;
}

-/**
+/*
* Set per-context SAREA.
*
* \param inode device inode.
@@ -263,7 +263,7 @@ int drm_legacy_setsareactx(struct drm_device *dev, void *data,
/** \name The actual DRM context handling routines */
/*@{*/

-/**
+/*
* Switch context.
*
* \param dev DRM device.
@@ -290,7 +290,7 @@ static int drm_context_switch(struct drm_device * dev, int old, int new)
return 0;
}

-/**
+/*
* Complete context switch.
*
* \param dev DRM device.
@@ -318,7 +318,7 @@ static int drm_context_switch_complete(struct drm_device *dev,
return 0;
}

-/**
+/*
* Reserve contexts.
*
* \param inode device inode.
@@ -351,7 +351,7 @@ int drm_legacy_resctx(struct drm_device *dev, void *data,
return 0;
}

-/**
+/*
* Add context.
*
* \param inode device inode.
@@ -404,7 +404,7 @@ int drm_legacy_addctx(struct drm_device *dev, void *data,
return 0;
}

-/**
+/*
* Get context.
*
* \param inode device inode.
@@ -428,7 +428,7 @@ int drm_legacy_getctx(struct drm_device *dev, void *data,
return 0;
}

-/**
+/*
* Switch context.
*
* \param inode device inode.
@@ -452,7 +452,7 @@ int drm_legacy_switchctx(struct drm_device *dev, void *data,
return drm_context_switch(dev, dev->last_context, ctx->handle);
}

-/**
+/*
* New context.
*
* \param inode device inode.
@@ -478,7 +478,7 @@ int drm_legacy_newctx(struct drm_device *dev, void *data,
return 0;
}

-/**
+/*
* Remove context.
*
* \param inode device inode.
--
2.15.0

2020-03-06 10:33:02

by Benjamin GAIGNARD

[permalink] [raw]
Subject: [PATCH] drm: bufs: Clean up documentation

Fix kernel doc comments to avoid warnings when compiling with W=1.

Signed-off-by: Benjamin Gaignard <[email protected]>
---
drivers/gpu/drm/drm_bufs.c | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/drivers/gpu/drm/drm_bufs.c b/drivers/gpu/drm/drm_bufs.c
index 19297e58b232..dcabf5698333 100644
--- a/drivers/gpu/drm/drm_bufs.c
+++ b/drivers/gpu/drm/drm_bufs.c
@@ -134,7 +134,7 @@ static int drm_map_handle(struct drm_device *dev, struct drm_hash_item *hash,
shift, add);
}

-/**
+/*
* Core function to create a range of memory available for mapping by a
* non-root process.
*
@@ -398,7 +398,7 @@ struct drm_local_map *drm_legacy_findmap(struct drm_device *dev,
}
EXPORT_SYMBOL(drm_legacy_findmap);

-/**
+/*
* Ioctl to specify a range of memory that is available for mapping by a
* non-root process.
*
@@ -499,7 +499,7 @@ int drm_legacy_getmap_ioctl(struct drm_device *dev, void *data,
return 0;
}

-/**
+/*
* Remove a map private from list and deallocate resources if the mapping
* isn't in use.
*
@@ -659,7 +659,7 @@ int drm_legacy_rmmap_ioctl(struct drm_device *dev, void *data,
return ret;
}

-/**
+/*
* Cleanup after an error on one of the addbufs() functions.
*
* \param dev DRM device.
@@ -694,7 +694,7 @@ static void drm_cleanup_buf_error(struct drm_device *dev,
}

#if IS_ENABLED(CONFIG_AGP)
-/**
+/*
* Add AGP buffers for DMA transfers.
*
* \param dev struct drm_device to which the buffers are to be added.
@@ -1230,7 +1230,7 @@ static int drm_legacy_addbufs_sg(struct drm_device *dev,
return 0;
}

-/**
+/*
* Add buffers for DMA transfers (ioctl).
*
* \param inode device inode.
@@ -1271,7 +1271,7 @@ int drm_legacy_addbufs(struct drm_device *dev, void *data,
return ret;
}

-/**
+/*
* Get information about the buffer mappings.
*
* This was originally mean for debugging purposes, or by a sophisticated
@@ -1362,7 +1362,7 @@ int drm_legacy_infobufs(struct drm_device *dev, void *data,
return __drm_legacy_infobufs(dev, data, &request->count, copy_one_buf);
}

-/**
+/*
* Specifies a low and high water mark for buffer allocation
*
* \param inode device inode.
@@ -1411,7 +1411,7 @@ int drm_legacy_markbufs(struct drm_device *dev, void *data,
return 0;
}

-/**
+/*
* Unreserve the buffers in list, previously reserved using drmDMA.
*
* \param inode device inode.
@@ -1463,7 +1463,7 @@ int drm_legacy_freebufs(struct drm_device *dev, void *data,
return 0;
}

-/**
+/*
* Maps all of the DMA buffers into client-virtual space (ioctl).
*
* \param inode device inode.
--
2.15.0

2020-03-06 11:10:12

by Daniel Vetter

[permalink] [raw]
Subject: Re: [PATCH v2] drm: context: Clean up documentation

On Fri, Mar 06, 2020 at 11:29:37AM +0100, Benjamin Gaignard wrote:
> Fix kernel doc comments to avoid warnings when compiling with W=1.
>
> Signed-off-by: Benjamin Gaignard <[email protected]>
> ---
> version 2:
> - Since it is legacy interface do not fix the description but
> replace /** by /* to remove kerneldoc validation warnings

On the entire series:

Acked-by: Daniel Vetter <[email protected]>
>
> drivers/gpu/drm/drm_context.c | 28 ++++++++++++++--------------
> 1 file changed, 14 insertions(+), 14 deletions(-)
>
> diff --git a/drivers/gpu/drm/drm_context.c b/drivers/gpu/drm/drm_context.c
> index 1f802d8e5681..c99be950bf17 100644
> --- a/drivers/gpu/drm/drm_context.c
> +++ b/drivers/gpu/drm/drm_context.c
> @@ -47,7 +47,7 @@ struct drm_ctx_list {
> /** \name Context bitmap support */
> /*@{*/
>
> -/**
> +/*
> * Free a handle from the context bitmap.
> *
> * \param dev DRM device.
> @@ -68,7 +68,7 @@ void drm_legacy_ctxbitmap_free(struct drm_device * dev, int ctx_handle)
> mutex_unlock(&dev->struct_mutex);
> }
>
> -/**
> +/*
> * Context bitmap allocation.
> *
> * \param dev DRM device.
> @@ -88,7 +88,7 @@ static int drm_legacy_ctxbitmap_next(struct drm_device * dev)
> return ret;
> }
>
> -/**
> +/*
> * Context bitmap initialization.
> *
> * \param dev DRM device.
> @@ -104,7 +104,7 @@ void drm_legacy_ctxbitmap_init(struct drm_device * dev)
> idr_init(&dev->ctx_idr);
> }
>
> -/**
> +/*
> * Context bitmap cleanup.
> *
> * \param dev DRM device.
> @@ -163,7 +163,7 @@ void drm_legacy_ctxbitmap_flush(struct drm_device *dev, struct drm_file *file)
> /** \name Per Context SAREA Support */
> /*@{*/
>
> -/**
> +/*
> * Get per-context SAREA.
> *
> * \param inode device inode.
> @@ -211,7 +211,7 @@ int drm_legacy_getsareactx(struct drm_device *dev, void *data,
> return 0;
> }
>
> -/**
> +/*
> * Set per-context SAREA.
> *
> * \param inode device inode.
> @@ -263,7 +263,7 @@ int drm_legacy_setsareactx(struct drm_device *dev, void *data,
> /** \name The actual DRM context handling routines */
> /*@{*/
>
> -/**
> +/*
> * Switch context.
> *
> * \param dev DRM device.
> @@ -290,7 +290,7 @@ static int drm_context_switch(struct drm_device * dev, int old, int new)
> return 0;
> }
>
> -/**
> +/*
> * Complete context switch.
> *
> * \param dev DRM device.
> @@ -318,7 +318,7 @@ static int drm_context_switch_complete(struct drm_device *dev,
> return 0;
> }
>
> -/**
> +/*
> * Reserve contexts.
> *
> * \param inode device inode.
> @@ -351,7 +351,7 @@ int drm_legacy_resctx(struct drm_device *dev, void *data,
> return 0;
> }
>
> -/**
> +/*
> * Add context.
> *
> * \param inode device inode.
> @@ -404,7 +404,7 @@ int drm_legacy_addctx(struct drm_device *dev, void *data,
> return 0;
> }
>
> -/**
> +/*
> * Get context.
> *
> * \param inode device inode.
> @@ -428,7 +428,7 @@ int drm_legacy_getctx(struct drm_device *dev, void *data,
> return 0;
> }
>
> -/**
> +/*
> * Switch context.
> *
> * \param inode device inode.
> @@ -452,7 +452,7 @@ int drm_legacy_switchctx(struct drm_device *dev, void *data,
> return drm_context_switch(dev, dev->last_context, ctx->handle);
> }
>
> -/**
> +/*
> * New context.
> *
> * \param inode device inode.
> @@ -478,7 +478,7 @@ int drm_legacy_newctx(struct drm_device *dev, void *data,
> return 0;
> }
>
> -/**
> +/*
> * Remove context.
> *
> * \param inode device inode.
> --
> 2.15.0
>

--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch

2020-03-16 08:31:52

by Benjamin GAIGNARD

[permalink] [raw]
Subject: Re: [PATCH v2] drm: context: Clean up documentation



On 3/6/20 12:08 PM, Daniel Vetter wrote:
> Acked-by: Daniel Vetter<[email protected]>
The series has been pushed on drm-misc-next.

Thanks,

Benjamin