[02/24] drm: Extract drm_prime.h
diff mbox

Message ID 20170308141257.12119-3-daniel.vetter@ffwll.ch
State New
Headers show

Commit Message

Daniel Vetter March 8, 2017, 2:12 p.m. UTC
Plus a little bit more documentation.

v2: Untangle the missing forward decls to make drm_prime|gem.h
free-standing.

Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
---
 Documentation/gpu/drm-mm.rst  |  3 ++
 drivers/gpu/drm/drm_prime.c   |  3 +-
 include/drm/drmP.h            | 32 ++----------------
 include/drm/drm_gem.h         |  4 +++
 include/drm/drm_prime.h       | 79 +++++++++++++++++++++++++++++++++++++++++++
 include/drm/drm_vma_manager.h |  1 -
 6 files changed, 91 insertions(+), 31 deletions(-)
 create mode 100644 include/drm/drm_prime.h

Comments

Gustavo Padovan March 8, 2017, 2:57 p.m. UTC | #1
Hi Daniel,

2017-03-08 Daniel Vetter <daniel.vetter@ffwll.ch>:

> Plus a little bit more documentation.
> 
> v2: Untangle the missing forward decls to make drm_prime|gem.h
> free-standing.
> 
> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
> ---
>  Documentation/gpu/drm-mm.rst  |  3 ++
>  drivers/gpu/drm/drm_prime.c   |  3 +-
>  include/drm/drmP.h            | 32 ++----------------
>  include/drm/drm_gem.h         |  4 +++
>  include/drm/drm_prime.h       | 79 +++++++++++++++++++++++++++++++++++++++++++
>  include/drm/drm_vma_manager.h |  1 -
>  6 files changed, 91 insertions(+), 31 deletions(-)
>  create mode 100644 include/drm/drm_prime.h

Reviewed-by: Gustavo Padovan <gustavo.padovan@collabora.com>

Gustavo
Sean Paul March 13, 2017, 4:42 p.m. UTC | #2
On Wed, Mar 08, 2017 at 03:12:35PM +0100, Daniel Vetter wrote:
> Plus a little bit more documentation.
> 
> v2: Untangle the missing forward decls to make drm_prime|gem.h
> free-standing.
> 
> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
> ---
>  Documentation/gpu/drm-mm.rst  |  3 ++
>  drivers/gpu/drm/drm_prime.c   |  3 +-
>  include/drm/drmP.h            | 32 ++----------------
>  include/drm/drm_gem.h         |  4 +++
>  include/drm/drm_prime.h       | 79 +++++++++++++++++++++++++++++++++++++++++++
>  include/drm/drm_vma_manager.h |  1 -
>  6 files changed, 91 insertions(+), 31 deletions(-)
>  create mode 100644 include/drm/drm_prime.h
> 
> diff --git a/Documentation/gpu/drm-mm.rst b/Documentation/gpu/drm-mm.rst
> index d47cbe3a9ef3..96b9c34c21e4 100644
> --- a/Documentation/gpu/drm-mm.rst
> +++ b/Documentation/gpu/drm-mm.rst
> @@ -449,6 +449,9 @@ PRIME Helper Functions
>  PRIME Function References
>  -------------------------
>  
> +.. kernel-doc:: include/drm/drm_prime.h
> +   :internal:
> +
>  .. kernel-doc:: drivers/gpu/drm/drm_prime.c
>     :export:
>  
> diff --git a/drivers/gpu/drm/drm_prime.c b/drivers/gpu/drm/drm_prime.c
> index 866b294e7c61..9fb65b736a90 100644
> --- a/drivers/gpu/drm/drm_prime.c
> +++ b/drivers/gpu/drm/drm_prime.c
> @@ -29,8 +29,9 @@
>  #include <linux/export.h>
>  #include <linux/dma-buf.h>
>  #include <linux/rbtree.h>
> -#include <drm/drmP.h>
> +#include <drm/drm_prime.h>
>  #include <drm/drm_gem.h>
> +#include <drm/drmP.h>
>  
>  #include "drm_internal.h"
>  
> diff --git a/include/drm/drmP.h b/include/drm/drmP.h
> index 6105c050d7bc..5f829d2372da 100644
> --- a/include/drm/drmP.h
> +++ b/include/drm/drmP.h
> @@ -51,13 +51,13 @@
>  #include <linux/platform_device.h>
>  #include <linux/poll.h>
>  #include <linux/ratelimit.h>
> -#include <linux/rbtree.h>
>  #include <linux/sched.h>
>  #include <linux/slab.h>
>  #include <linux/types.h>
>  #include <linux/vmalloc.h>
>  #include <linux/workqueue.h>
>  #include <linux/dma-fence.h>
> +#include <linux/module.h>
>  
>  #include <asm/mman.h>
>  #include <asm/pgalloc.h>
> @@ -75,8 +75,8 @@
>  #include <drm/drm_mm.h>
>  #include <drm/drm_os_linux.h>
>  #include <drm/drm_sarea.h>
> -#include <drm/drm_vma_manager.h>
>  #include <drm/drm_drv.h>
> +#include <drm/drm_prime.h>
>  
>  struct module;
>  
> @@ -89,6 +89,7 @@ struct drm_dma_handle;
>  struct drm_gem_object;
>  struct drm_master;
>  struct drm_vblank_crtc;
> +struct drm_vma_offset_manager;
>  
>  struct device_node;
>  struct videomode;
> @@ -370,12 +371,6 @@ struct drm_pending_event {
>  		      we deliver the event, for tracing only */
>  };
>  
> -struct drm_prime_file_private {
> -	struct mutex lock;
> -	struct rb_root dmabufs;
> -	struct rb_root handles;
> -};
> -
>  /** File private data */
>  struct drm_file {
>  	unsigned authenticated :1;
> @@ -759,27 +754,6 @@ static inline int drm_debugfs_remove_files(const struct drm_info_list *files,
>  }
>  #endif
>  
> -struct dma_buf_export_info;
> -
> -extern struct dma_buf *drm_gem_prime_export(struct drm_device *dev,
> -					    struct drm_gem_object *obj,
> -					    int flags);
> -extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
> -		struct drm_file *file_priv, uint32_t handle, uint32_t flags,
> -		int *prime_fd);
> -extern struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev,
> -		struct dma_buf *dma_buf);
> -extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
> -		struct drm_file *file_priv, int prime_fd, uint32_t *handle);
> -struct dma_buf *drm_gem_dmabuf_export(struct drm_device *dev,
> -				      struct dma_buf_export_info *exp_info);
> -extern void drm_gem_dmabuf_release(struct dma_buf *dma_buf);
> -
> -extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
> -					    dma_addr_t *addrs, int max_pages);
> -extern struct sg_table *drm_prime_pages_to_sg(struct page **pages, unsigned int nr_pages);
> -extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
> -
>  
>  extern struct drm_dma_handle *drm_pci_alloc(struct drm_device *dev, size_t size,
>  					    size_t align);
> diff --git a/include/drm/drm_gem.h b/include/drm/drm_gem.h
> index 3b2a28f7f49f..b9ade75ecd82 100644
> --- a/include/drm/drm_gem.h
> +++ b/include/drm/drm_gem.h
> @@ -34,6 +34,10 @@
>   * OTHER DEALINGS IN THE SOFTWARE.
>   */
>  
> +#include <linux/kref.h>
> +
> +#include <drm/drm_vma_manager.h>
> +
>  /**
>   * struct drm_gem_object - GEM buffer object
>   *
> diff --git a/include/drm/drm_prime.h b/include/drm/drm_prime.h
> new file mode 100644
> index 000000000000..77ceca711bad
> --- /dev/null
> +++ b/include/drm/drm_prime.h
> @@ -0,0 +1,79 @@
> +/*
> + * Copyright © 2012 Red Hat
> + * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
> + * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
> + * Copyright (c) 2009-2010, Code Aurora Forum.
> + *
> + * Permission is hereby granted, free of charge, to any person obtaining a
> + * copy of this software and associated documentation files (the "Software"),
> + * to deal in the Software without restriction, including without limitation
> + * the rights to use, copy, modify, merge, publish, distribute, sublicense,
> + * and/or sell copies of the Software, and to permit persons to whom the
> + * Software is furnished to do so, subject to the following conditions:
> + *
> + * The above copyright notice and this permission notice (including the next
> + * paragraph) shall be included in all copies or substantial portions of the
> + * Software.
> + *
> + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
> + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
> + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
> + * IN THE SOFTWARE.
> + *
> + * Authors:
> + *      Dave Airlie <airlied@redhat.com>
> + *      Rob Clark <rob.clark@linaro.org>
> + *
> + */
> +
> +#ifndef __DRM_PRIME_H__
> +#define __DRM_PRIME_H__
> +
> +#include <linux/mutex.h>
> +#include <linux/rbtree.h>
> +
> +/**
> + * struct drm_prime_file_private - per-file tracking for PRIME
> + *
> + * This just contains the internal &struct dma_buf and handle caches for each
> + * &struct drm_file used by the PRIME core code.
> + */
> +
> +struct drm_prime_file_private {
> +/* private: */

I'm a little confused by this comment. The struct has private in its name, I'm
not sure you're adding any additional information. Could you either remove or
expand this?

Aside from that,

Reviewed-by: Sean Paul <seanpaul@chromium.org>

Sean

> +	struct mutex lock;
> +	struct rb_root dmabufs;
> +	struct rb_root handles;
> +};
> +
> +struct dma_buf_export_info;
> +struct dma_buf;
> +
> +struct drm_device;
> +struct drm_gem_object;
> +struct drm_file;
> +
> +extern struct dma_buf *drm_gem_prime_export(struct drm_device *dev,
> +					    struct drm_gem_object *obj,
> +					    int flags);
> +extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
> +		struct drm_file *file_priv, uint32_t handle, uint32_t flags,
> +		int *prime_fd);
> +extern struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev,
> +		struct dma_buf *dma_buf);
> +extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
> +		struct drm_file *file_priv, int prime_fd, uint32_t *handle);
> +struct dma_buf *drm_gem_dmabuf_export(struct drm_device *dev,
> +				      struct dma_buf_export_info *exp_info);
> +extern void drm_gem_dmabuf_release(struct dma_buf *dma_buf);
> +
> +extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
> +					    dma_addr_t *addrs, int max_pages);
> +extern struct sg_table *drm_prime_pages_to_sg(struct page **pages, unsigned int nr_pages);
> +extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
> +
> +
> +#endif /* __DRM_PRIME_H__ */
> diff --git a/include/drm/drm_vma_manager.h b/include/drm/drm_vma_manager.h
> index 9c03895dc479..d84d52f6d2b1 100644
> --- a/include/drm/drm_vma_manager.h
> +++ b/include/drm/drm_vma_manager.h
> @@ -25,7 +25,6 @@
>  
>  #include <drm/drm_mm.h>
>  #include <linux/mm.h>
> -#include <linux/module.h>
>  #include <linux/rbtree.h>
>  #include <linux/spinlock.h>
>  #include <linux/types.h>
> -- 
> 2.11.0
> 
> _______________________________________________
> Intel-gfx mailing list
> Intel-gfx@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Daniel Vetter March 14, 2017, 9:12 a.m. UTC | #3
On Mon, Mar 13, 2017 at 12:42:54PM -0400, Sean Paul wrote:
> On Wed, Mar 08, 2017 at 03:12:35PM +0100, Daniel Vetter wrote:
> > +/**
> > + * struct drm_prime_file_private - per-file tracking for PRIME
> > + *
> > + * This just contains the internal &struct dma_buf and handle caches for each
> > + * &struct drm_file used by the PRIME core code.
> > + */
> > +
> > +struct drm_prime_file_private {
> > +/* private: */
> 
> I'm a little confused by this comment. The struct has private in its name, I'm
> not sure you're adding any additional information. Could you either remove or
> expand this?

private: is special markup for kernel-doc to ingore everything below as
implementation-internals. This avoids warnings when building the docs. I
have no idea why it doesn't use the usual /** kernel-doc comment starter
...
-Daniel
Sean Paul March 14, 2017, 3:42 p.m. UTC | #4
On Tue, Mar 14, 2017 at 10:12:59AM +0100, Daniel Vetter wrote:
> On Mon, Mar 13, 2017 at 12:42:54PM -0400, Sean Paul wrote:
> > On Wed, Mar 08, 2017 at 03:12:35PM +0100, Daniel Vetter wrote:
> > > +/**
> > > + * struct drm_prime_file_private - per-file tracking for PRIME
> > > + *
> > > + * This just contains the internal &struct dma_buf and handle caches for each
> > > + * &struct drm_file used by the PRIME core code.
> > > + */
> > > +
> > > +struct drm_prime_file_private {
> > > +/* private: */
> > 
> > I'm a little confused by this comment. The struct has private in its name, I'm
> > not sure you're adding any additional information. Could you either remove or
> > expand this?
> 
> private: is special markup for kernel-doc to ingore everything below as
> implementation-internals. This avoids warnings when building the docs. I
> have no idea why it doesn't use the usual /** kernel-doc comment starter

Yeah, that kind of sucks. When there are public and private members, it's pretty
easy to reason about. However, when the struct is strictly private, it's pretty
redundant/annoying.

Ah well.

Sean

> ...
> -Daniel
> -- 
> Daniel Vetter
> Software Engineer, Intel Corporation
> http://blog.ffwll.ch
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel

Patch
diff mbox

diff --git a/Documentation/gpu/drm-mm.rst b/Documentation/gpu/drm-mm.rst
index d47cbe3a9ef3..96b9c34c21e4 100644
--- a/Documentation/gpu/drm-mm.rst
+++ b/Documentation/gpu/drm-mm.rst
@@ -449,6 +449,9 @@  PRIME Helper Functions
 PRIME Function References
 -------------------------
 
+.. kernel-doc:: include/drm/drm_prime.h
+   :internal:
+
 .. kernel-doc:: drivers/gpu/drm/drm_prime.c
    :export:
 
diff --git a/drivers/gpu/drm/drm_prime.c b/drivers/gpu/drm/drm_prime.c
index 866b294e7c61..9fb65b736a90 100644
--- a/drivers/gpu/drm/drm_prime.c
+++ b/drivers/gpu/drm/drm_prime.c
@@ -29,8 +29,9 @@ 
 #include <linux/export.h>
 #include <linux/dma-buf.h>
 #include <linux/rbtree.h>
-#include <drm/drmP.h>
+#include <drm/drm_prime.h>
 #include <drm/drm_gem.h>
+#include <drm/drmP.h>
 
 #include "drm_internal.h"
 
diff --git a/include/drm/drmP.h b/include/drm/drmP.h
index 6105c050d7bc..5f829d2372da 100644
--- a/include/drm/drmP.h
+++ b/include/drm/drmP.h
@@ -51,13 +51,13 @@ 
 #include <linux/platform_device.h>
 #include <linux/poll.h>
 #include <linux/ratelimit.h>
-#include <linux/rbtree.h>
 #include <linux/sched.h>
 #include <linux/slab.h>
 #include <linux/types.h>
 #include <linux/vmalloc.h>
 #include <linux/workqueue.h>
 #include <linux/dma-fence.h>
+#include <linux/module.h>
 
 #include <asm/mman.h>
 #include <asm/pgalloc.h>
@@ -75,8 +75,8 @@ 
 #include <drm/drm_mm.h>
 #include <drm/drm_os_linux.h>
 #include <drm/drm_sarea.h>
-#include <drm/drm_vma_manager.h>
 #include <drm/drm_drv.h>
+#include <drm/drm_prime.h>
 
 struct module;
 
@@ -89,6 +89,7 @@  struct drm_dma_handle;
 struct drm_gem_object;
 struct drm_master;
 struct drm_vblank_crtc;
+struct drm_vma_offset_manager;
 
 struct device_node;
 struct videomode;
@@ -370,12 +371,6 @@  struct drm_pending_event {
 		      we deliver the event, for tracing only */
 };
 
-struct drm_prime_file_private {
-	struct mutex lock;
-	struct rb_root dmabufs;
-	struct rb_root handles;
-};
-
 /** File private data */
 struct drm_file {
 	unsigned authenticated :1;
@@ -759,27 +754,6 @@  static inline int drm_debugfs_remove_files(const struct drm_info_list *files,
 }
 #endif
 
-struct dma_buf_export_info;
-
-extern struct dma_buf *drm_gem_prime_export(struct drm_device *dev,
-					    struct drm_gem_object *obj,
-					    int flags);
-extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
-		struct drm_file *file_priv, uint32_t handle, uint32_t flags,
-		int *prime_fd);
-extern struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev,
-		struct dma_buf *dma_buf);
-extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
-		struct drm_file *file_priv, int prime_fd, uint32_t *handle);
-struct dma_buf *drm_gem_dmabuf_export(struct drm_device *dev,
-				      struct dma_buf_export_info *exp_info);
-extern void drm_gem_dmabuf_release(struct dma_buf *dma_buf);
-
-extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
-					    dma_addr_t *addrs, int max_pages);
-extern struct sg_table *drm_prime_pages_to_sg(struct page **pages, unsigned int nr_pages);
-extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
-
 
 extern struct drm_dma_handle *drm_pci_alloc(struct drm_device *dev, size_t size,
 					    size_t align);
diff --git a/include/drm/drm_gem.h b/include/drm/drm_gem.h
index 3b2a28f7f49f..b9ade75ecd82 100644
--- a/include/drm/drm_gem.h
+++ b/include/drm/drm_gem.h
@@ -34,6 +34,10 @@ 
  * OTHER DEALINGS IN THE SOFTWARE.
  */
 
+#include <linux/kref.h>
+
+#include <drm/drm_vma_manager.h>
+
 /**
  * struct drm_gem_object - GEM buffer object
  *
diff --git a/include/drm/drm_prime.h b/include/drm/drm_prime.h
new file mode 100644
index 000000000000..77ceca711bad
--- /dev/null
+++ b/include/drm/drm_prime.h
@@ -0,0 +1,79 @@ 
+/*
+ * Copyright © 2012 Red Hat
+ * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
+ * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
+ * Copyright (c) 2009-2010, Code Aurora Forum.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the next
+ * paragraph) shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ *
+ * Authors:
+ *      Dave Airlie <airlied@redhat.com>
+ *      Rob Clark <rob.clark@linaro.org>
+ *
+ */
+
+#ifndef __DRM_PRIME_H__
+#define __DRM_PRIME_H__
+
+#include <linux/mutex.h>
+#include <linux/rbtree.h>
+
+/**
+ * struct drm_prime_file_private - per-file tracking for PRIME
+ *
+ * This just contains the internal &struct dma_buf and handle caches for each
+ * &struct drm_file used by the PRIME core code.
+ */
+
+struct drm_prime_file_private {
+/* private: */
+	struct mutex lock;
+	struct rb_root dmabufs;
+	struct rb_root handles;
+};
+
+struct dma_buf_export_info;
+struct dma_buf;
+
+struct drm_device;
+struct drm_gem_object;
+struct drm_file;
+
+extern struct dma_buf *drm_gem_prime_export(struct drm_device *dev,
+					    struct drm_gem_object *obj,
+					    int flags);
+extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
+		struct drm_file *file_priv, uint32_t handle, uint32_t flags,
+		int *prime_fd);
+extern struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev,
+		struct dma_buf *dma_buf);
+extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
+		struct drm_file *file_priv, int prime_fd, uint32_t *handle);
+struct dma_buf *drm_gem_dmabuf_export(struct drm_device *dev,
+				      struct dma_buf_export_info *exp_info);
+extern void drm_gem_dmabuf_release(struct dma_buf *dma_buf);
+
+extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
+					    dma_addr_t *addrs, int max_pages);
+extern struct sg_table *drm_prime_pages_to_sg(struct page **pages, unsigned int nr_pages);
+extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
+
+
+#endif /* __DRM_PRIME_H__ */
diff --git a/include/drm/drm_vma_manager.h b/include/drm/drm_vma_manager.h
index 9c03895dc479..d84d52f6d2b1 100644
--- a/include/drm/drm_vma_manager.h
+++ b/include/drm/drm_vma_manager.h
@@ -25,7 +25,6 @@ 
 
 #include <drm/drm_mm.h>
 #include <linux/mm.h>
-#include <linux/module.h>
 #include <linux/rbtree.h>
 #include <linux/spinlock.h>
 #include <linux/types.h>