[PATCH] Documentation/dma-buf-sharing.txt: update API descriptions

[Bjorn Helgaas]

On Wed, May 14, 2014 at 08:49:43AM +0900, Gioh Kim wrote:
> Update some descriptions for API arguments and descriptions.
> 
> Signed-off-by: Gioh Kim <gioh.kim at lge.com>

I applied this to my "dma-api" branch for v3.16, thanks!

> ---
>  Documentation/dma-buf-sharing.txt |   14 ++++++++------
>  1 file changed, 8 insertions(+), 6 deletions(-)
> 
> diff --git a/Documentation/dma-buf-sharing.txt b/Documentation/dma-buf-sharing.txt
> index 505e711..aadd901 100644
> --- a/Documentation/dma-buf-sharing.txt
> +++ b/Documentation/dma-buf-sharing.txt
> @@ -56,10 +56,10 @@ The dma_buf buffer sharing API usage contains the following steps:
>  				     size_t size, int flags,
>  				     const char *exp_name)
>  
> -   If this succeeds, dma_buf_export allocates a dma_buf structure, and returns a
> -   pointer to the same. It also associates an anonymous file with this buffer,
> -   so it can be exported. On failure to allocate the dma_buf object, it returns
> -   NULL.
> +   If this succeeds, dma_buf_export_named allocates a dma_buf structure, and
> +   returns a pointer to the same. It also associates an anonymous file with this
> +   buffer, so it can be exported. On failure to allocate the dma_buf object,
> +   it returns NULL.
>  
>     'exp_name' is the name of exporter - to facilitate information while
>     debugging.
> @@ -76,7 +76,7 @@ The dma_buf buffer sharing API usage contains the following steps:
>     drivers and/or processes.
>  
>     Interface:
> -      int dma_buf_fd(struct dma_buf *dmabuf)
> +      int dma_buf_fd(struct dma_buf *dmabuf, int flags)
>  
>     This API installs an fd for the anonymous file associated with this buffer;
>     returns either 'fd', or error.
> @@ -157,7 +157,9 @@ to request use of buffer for allocation.
>     "dma_buf->ops->" indirection from the users of this interface.
>  
>     In struct dma_buf_ops, unmap_dma_buf is defined as
> -      void (*unmap_dma_buf)(struct dma_buf_attachment *, struct sg_table *);
> +      void (*unmap_dma_buf)(struct dma_buf_attachment *,
> +                            struct sg_table *,
> +                            enum dma_data_direction);
>  
>     unmap_dma_buf signifies the end-of-DMA for the attachment provided. Like
>     map_dma_buf, this API also must be implemented by the exporter.
> -- 
> 1.7.9.5
> 
> --
> To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
> the body of a message to majordomo at vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
> Please read the FAQ at  http://www.tux.org/lkml/