提交 a07b3b45 编写于 作者: G Gioh Kim 提交者: Sumit Semwal

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

Update some descriptions for API arguments and descriptions.
Signed-off-by: NGioh Kim <gioh.kim@lge.com>
Signed-off-by: NSumit Semwal <sumit.semwal@linaro.org>
上级 f1bd473f
...@@ -56,10 +56,10 @@ The dma_buf buffer sharing API usage contains the following steps: ...@@ -56,10 +56,10 @@ The dma_buf buffer sharing API usage contains the following steps:
size_t size, int flags, size_t size, int flags,
const char *exp_name) const char *exp_name)
If this succeeds, dma_buf_export allocates a dma_buf structure, and returns a If this succeeds, dma_buf_export_named allocates a dma_buf structure, and
pointer to the same. It also associates an anonymous file with this buffer, returns a pointer to the same. It also associates an anonymous file with this
so it can be exported. On failure to allocate the dma_buf object, it returns buffer, so it can be exported. On failure to allocate the dma_buf object,
NULL. it returns NULL.
'exp_name' is the name of exporter - to facilitate information while 'exp_name' is the name of exporter - to facilitate information while
debugging. debugging.
...@@ -76,7 +76,7 @@ The dma_buf buffer sharing API usage contains the following steps: ...@@ -76,7 +76,7 @@ The dma_buf buffer sharing API usage contains the following steps:
drivers and/or processes. drivers and/or processes.
Interface: 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; This API installs an fd for the anonymous file associated with this buffer;
returns either 'fd', or error. returns either 'fd', or error.
...@@ -157,7 +157,9 @@ to request use of buffer for allocation. ...@@ -157,7 +157,9 @@ to request use of buffer for allocation.
"dma_buf->ops->" indirection from the users of this interface. "dma_buf->ops->" indirection from the users of this interface.
In struct dma_buf_ops, unmap_dma_buf is defined as 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 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. map_dma_buf, this API also must be implemented by the exporter.
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册