diff options
author | Gioh Kim <gioh.kim@lge.com> | 2014-05-13 19:49:43 -0400 |
---|---|---|
committer | Sumit Semwal <sumit.semwal@linaro.org> | 2014-08-28 02:27:24 -0400 |
commit | a07b3b4508447682574cf18fdad23ed709365dd1 (patch) | |
tree | b7ecb29488fb820bc628cc2c273456de5c502a85 /Documentation | |
parent | f1bd473f95e02bc382d4dae94d7f82e2a455e05d (diff) |
Documentation/dma-buf-sharing.txt: update API descriptions
Update some descriptions for API arguments and descriptions.
Signed-off-by: Gioh Kim <gioh.kim@lge.com>
Signed-off-by: Sumit Semwal <sumit.semwal@linaro.org>
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/dma-buf-sharing.txt | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/Documentation/dma-buf-sharing.txt b/Documentation/dma-buf-sharing.txt index 67a4087d53f9..bb9753b635a3 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: | |||
56 | size_t size, int flags, | 56 | size_t size, int flags, |
57 | const char *exp_name) | 57 | const char *exp_name) |
58 | 58 | ||
59 | If this succeeds, dma_buf_export allocates a dma_buf structure, and returns a | 59 | If this succeeds, dma_buf_export_named allocates a dma_buf structure, and |
60 | pointer to the same. It also associates an anonymous file with this buffer, | 60 | returns a pointer to the same. It also associates an anonymous file with this |
61 | so it can be exported. On failure to allocate the dma_buf object, it returns | 61 | buffer, so it can be exported. On failure to allocate the dma_buf object, |
62 | NULL. | 62 | it returns NULL. |
63 | 63 | ||
64 | 'exp_name' is the name of exporter - to facilitate information while | 64 | 'exp_name' is the name of exporter - to facilitate information while |
65 | debugging. | 65 | debugging. |
@@ -76,7 +76,7 @@ The dma_buf buffer sharing API usage contains the following steps: | |||
76 | drivers and/or processes. | 76 | drivers and/or processes. |
77 | 77 | ||
78 | Interface: | 78 | Interface: |
79 | int dma_buf_fd(struct dma_buf *dmabuf) | 79 | int dma_buf_fd(struct dma_buf *dmabuf, int flags) |
80 | 80 | ||
81 | This API installs an fd for the anonymous file associated with this buffer; | 81 | This API installs an fd for the anonymous file associated with this buffer; |
82 | returns either 'fd', or error. | 82 | returns either 'fd', or error. |
@@ -157,7 +157,9 @@ to request use of buffer for allocation. | |||
157 | "dma_buf->ops->" indirection from the users of this interface. | 157 | "dma_buf->ops->" indirection from the users of this interface. |
158 | 158 | ||
159 | In struct dma_buf_ops, unmap_dma_buf is defined as | 159 | In struct dma_buf_ops, unmap_dma_buf is defined as |
160 | void (*unmap_dma_buf)(struct dma_buf_attachment *, struct sg_table *); | 160 | void (*unmap_dma_buf)(struct dma_buf_attachment *, |
161 | struct sg_table *, | ||
162 | enum dma_data_direction); | ||
161 | 163 | ||
162 | unmap_dma_buf signifies the end-of-DMA for the attachment provided. Like | 164 | unmap_dma_buf signifies the end-of-DMA for the attachment provided. Like |
163 | map_dma_buf, this API also must be implemented by the exporter. | 165 | map_dma_buf, this API also must be implemented by the exporter. |