On Wed, Jan 17, 2018 at 11:47:40AM -0500, Samuel Li wrote:
> Signed-off-by: Samuel Li <Samuel.Li@xxxxxxx>
Thanks a lot for updating the docs.
> ---
> drivers/gpu/drm/drm_prime.c | 81 +++++++++++++++++++++++++++++++++++++++++++++
> 1 file changed, 81 insertions(+)
>
> diff --git a/drivers/gpu/drm/drm_prime.c b/drivers/gpu/drm/drm_prime.c
> index ca09ce7..3ead5a6 100644
> --- a/drivers/gpu/drm/drm_prime.c
> +++ b/drivers/gpu/drm/drm_prime.c
> @@ -73,6 +73,9 @@
> * Drivers should detect this situation and return back the gem object
> * from the dma-buf private. Prime will do this automatically for drivers that
> * use the drm_gem_prime_{import,export} helpers.
> + *
> + * GEM dmabuf_ops symbols are now exported. They can be resued by drivers
s/dmabuf_ops/struct &dma_buf_ops/ and we get a nice hyperlink in the
generated html.
> + * which implement GEM interface.
> */
>
> struct drm_prime_member {
> @@ -180,6 +183,17 @@ static int drm_prime_lookup_buf_handle(struct drm_prime_file_private *prime_fpri
> return -ENOENT;
> }
>
> +/**
> + * drm_gem_map_attach - dma_buf attach implementation for GEM
> + * @dmabuf: buffer to attach device to.
> + * @target_dev: not used
> + * @attach: buffer attachment data
> + *
> + * Allocates drm_prime_attachment and calls driver's gem_prime_pin for device
> + * specific attachment.
Maybe add a sentence here like "This can be used as the
&dma_buf_ops.attach callback." Also &struct drm_prime_attachment and
&drm_driver.gem_prime_pin so we get hyperlinks for those too. Yes
gem_prime_* vfuncs aren't documented yet, but still good to have the links
ready already.
Similar for all the others. That should help driver authors figuring out
what these functions are for.
When you add/fix those hyperlinks pls make sure they're not typoed by
checking the resulting docs after running
$ make htmldocs
With that bit of kerneldoc polish applied:
Reviewed-by: Daniel Vetter <daniel.vetter@xxxxxxxx>
I'd expect one of the amd people with drm-misc commit rights to push v2.
Cheers, Daniel
> + *
> + * Returns 0 on success, negative error code on failure.
> + */
> int drm_gem_map_attach(struct dma_buf *dma_buf, struct device *target_dev,
> struct dma_buf_attachment *attach)
> {
> @@ -201,6 +215,13 @@ int drm_gem_map_attach(struct dma_buf *dma_buf, struct device *target_dev,
> }
> EXPORT_SYMBOL(drm_gem_map_attach);
>
> +/**
> + * drm_gem_map_detach - dma_buf detach implementation for GEM
> + * @dmabuf: buffer to detach from.
> + * @attach: attachment to be detached.
> + *
> + * Cleans up dma_buf_attachment.
> + */
> void drm_gem_map_detach(struct dma_buf *dma_buf,
> struct dma_buf_attachment *attach)
> {
> @@ -255,6 +276,17 @@ void drm_prime_remove_buf_handle_locked(struct drm_prime_file_private *prime_fpr
> }
> }
>
> +/**
> + * drm_gem_map_dma_buf - map_dma_buf implementation for GEM
> + * @attach: attachment whose scatterlist is to be returned
> + * @dir: direction of DMA transfer
> + *
> + * This calls driver's gem_prime_get_sg_table() and then maps the scatterlist.
> + *
> + * Returns sg_table containing the scatterlist to be returned; returns ERR_PTR
> + * on error. May return -EINTR if it is interrupted by a signal.
> + */
> +
> struct sg_table *drm_gem_map_dma_buf(struct dma_buf_attachment *attach,
> enum dma_data_direction dir)
> {
> @@ -294,6 +326,11 @@ struct sg_table *drm_gem_map_dma_buf(struct dma_buf_attachment *attach,
> }
> EXPORT_SYMBOL(drm_gem_map_dma_buf);
>
> +/**
> + * drm_gem_unmap_dma_buf - unmap_dma_buf implementation for GEM
> + *
> + * Not implemented. The unmap is done at drm_gem_map_detach().
> + */
> void drm_gem_unmap_dma_buf(struct dma_buf_attachment *attach,
> struct sg_table *sgt,
> enum dma_data_direction dir)
> @@ -351,6 +388,14 @@ void drm_gem_dmabuf_release(struct dma_buf *dma_buf)
> }
> EXPORT_SYMBOL(drm_gem_dmabuf_release);
>
> +/**
> + * drm_gem_dmabuf_vmap - dma_buf vmap implementation for GEM
> + * @dma_buf: buffer to be mapped
> + *
> + * Sets up a kernel virtual mapping.
> + *
> + * Returns the kernel virtual address.
> + */
> void *drm_gem_dmabuf_vmap(struct dma_buf *dma_buf)
> {
> struct drm_gem_object *obj = dma_buf->priv;
> @@ -360,6 +405,13 @@ void *drm_gem_dmabuf_vmap(struct dma_buf *dma_buf)
> }
> EXPORT_SYMBOL(drm_gem_dmabuf_vmap);
>
> +/**
> + * drm_gem_dmabuf_vunmap - dma_buf vunmap implementation for GEM
> + * @dma_buf: buffer to be unmapped
> + * @vaddr: the virtual address of the buffer
> + *
> + * Releases a kernel virtual mapping.
> + */
> void drm_gem_dmabuf_vunmap(struct dma_buf *dma_buf, void *vaddr)
> {
> struct drm_gem_object *obj = dma_buf->priv;
> @@ -369,6 +421,11 @@ void drm_gem_dmabuf_vunmap(struct dma_buf *dma_buf, void *vaddr)
> }
> EXPORT_SYMBOL(drm_gem_dmabuf_vunmap);
>
> +/**
> + * drm_gem_dmabuf_kmap_atomic - map_atomic implementation for GEM
> + *
> + * Not implemented.
> + */
> void *drm_gem_dmabuf_kmap_atomic(struct dma_buf *dma_buf,
> unsigned long page_num)
> {
> @@ -376,6 +433,11 @@ void *drm_gem_dmabuf_kmap_atomic(struct dma_buf *dma_buf,
> }
> EXPORT_SYMBOL(drm_gem_dmabuf_kmap_atomic);
>
> +/**
> + * drm_gem_dmabuf_kunmap_atomic - unmap_atomic implementation for GEM
> + *
> + * Not implemented.
> + */
> void drm_gem_dmabuf_kunmap_atomic(struct dma_buf *dma_buf,
> unsigned long page_num, void *addr)
> {
> @@ -383,12 +445,22 @@ void drm_gem_dmabuf_kunmap_atomic(struct dma_buf *dma_buf,
> }
> EXPORT_SYMBOL(drm_gem_dmabuf_kunmap_atomic);
>
> +/**
> + * drm_gem_dmabuf_kmap - map implementation for GEM
> + *
> + * Not implemented.
> + */
> void *drm_gem_dmabuf_kmap(struct dma_buf *dma_buf, unsigned long page_num)
> {
> return NULL;
> }
> EXPORT_SYMBOL(drm_gem_dmabuf_kmap);
>
> +/**
> + * drm_gem_dmabuf_kunmap - unmap implementation for GEM
> + *
> + * Not implemented.
> + */
> void drm_gem_dmabuf_kunmap(struct dma_buf *dma_buf, unsigned long page_num,
> void *addr)
> {
> @@ -396,6 +468,15 @@ void drm_gem_dmabuf_kunmap(struct dma_buf *dma_buf, unsigned long page_num,
> }
> EXPORT_SYMBOL(drm_gem_dmabuf_kunmap);
>
> +/**
> + * drm_gem_dmabuf_mmap - dma_buf mmap implementation for GEM
> + * @dma_buf: buffer to be mapped
> + * @vma: virtual address range
> + *
> + * Provides memory mapping for the buffer.
> + *
> + * Returns 0 on success or a negative error code on failure.
> + */
> int drm_gem_dmabuf_mmap(struct dma_buf *dma_buf, struct vm_area_struct *vma)
> {
> struct drm_gem_object *obj = dma_buf->priv;
> --
> 2.7.4
>
> _______________________________________________
> dri-devel mailing list
> dri-devel@xxxxxxxxxxxxxxxxxxxxx
> https://lists.freedesktop.org/mailman/listinfo/dri-devel
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
dri-devel@xxxxxxxxxxxxxxxxxxxxx
https://lists.freedesktop.org/mailman/listinfo/dri-devel
