Subversion Repositories Kolibri OS

Rev

Rev 5270 | Rev 6293 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
4568 Serge 1
/*
2
 * Header file for dma buffer sharing framework.
3
 *
4
 * Copyright(C) 2011 Linaro Limited. All rights reserved.
5
 * Author: Sumit Semwal 
6
 *
7
 * Many thanks to linaro-mm-sig list, and specially
8
 * Arnd Bergmann , Rob Clark  and
9
 * Daniel Vetter  for their support in creation and
10
 * refining of this idea.
11
 *
12
 * This program is free software; you can redistribute it and/or modify it
13
 * under the terms of the GNU General Public License version 2 as published by
14
 * the Free Software Foundation.
15
 *
16
 * This program is distributed in the hope that it will be useful, but WITHOUT
17
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
19
 * more details.
20
 *
21
 * You should have received a copy of the GNU General Public License along with
22
 * this program.  If not, see .
23
 */
24
#ifndef __DMA_BUF_H__
25
#define __DMA_BUF_H__
26
 
27
#include 
28
#include 
29
#include 
30
#include 
31
#include 
32
#include 
5270 serge 33
#include 
34
#include 
4568 Serge 35
 
36
struct device;
37
struct dma_buf;
38
struct dma_buf_attachment;
39
 
40
/**
41
 * struct dma_buf_ops - operations possible on struct dma_buf
42
 * @attach: [optional] allows different devices to 'attach' themselves to the
43
 *	    given buffer. It might return -EBUSY to signal that backing storage
44
 *	    is already allocated and incompatible with the requirements
45
 *	    of requesting device.
46
 * @detach: [optional] detach a given device from this buffer.
47
 * @map_dma_buf: returns list of scatter pages allocated, increases usecount
48
 *		 of the buffer. Requires atleast one attach to be called
49
 *		 before. Returned sg list should already be mapped into
50
 *		 _device_ address space. This call may sleep. May also return
51
 *		 -EINTR. Should return -EINVAL if attach hasn't been called yet.
52
 * @unmap_dma_buf: decreases usecount of buffer, might deallocate scatter
53
 *		   pages.
54
 * @release: release this buffer; to be called after the last dma_buf_put.
55
 * @begin_cpu_access: [optional] called before cpu access to invalidate cpu
56
 * 		      caches and allocate backing storage (if not yet done)
57
 * 		      respectively pin the objet into memory.
58
 * @end_cpu_access: [optional] called after cpu access to flush caches.
59
 * @kmap_atomic: maps a page from the buffer into kernel address
60
 * 		 space, users may not block until the subsequent unmap call.
61
 * 		 This callback must not sleep.
62
 * @kunmap_atomic: [optional] unmaps a atomically mapped page from the buffer.
63
 * 		   This Callback must not sleep.
64
 * @kmap: maps a page from the buffer into kernel address space.
65
 * @kunmap: [optional] unmaps a page from the buffer.
66
 * @mmap: used to expose the backing storage to userspace. Note that the
67
 * 	  mapping needs to be coherent - if the exporter doesn't directly
68
 * 	  support this, it needs to fake coherency by shooting down any ptes
69
 * 	  when transitioning away from the cpu domain.
70
 * @vmap: [optional] creates a virtual mapping for the buffer into kernel
71
 *	  address space. Same restrictions as for vmap and friends apply.
72
 * @vunmap: [optional] unmaps a vmap from the buffer
73
 */
74
struct dma_buf_ops {
75
	int (*attach)(struct dma_buf *, struct device *,
76
			struct dma_buf_attachment *);
77
 
78
	void (*detach)(struct dma_buf *, struct dma_buf_attachment *);
79
 
80
	/* For {map,unmap}_dma_buf below, any specific buffer attributes
81
	 * required should get added to device_dma_parameters accessible
82
	 * via dev->dma_params.
83
	 */
84
	struct sg_table * (*map_dma_buf)(struct dma_buf_attachment *,
85
						enum dma_data_direction);
86
	void (*unmap_dma_buf)(struct dma_buf_attachment *,
87
						struct sg_table *,
88
						enum dma_data_direction);
89
	/* TODO: Add try_map_dma_buf version, to return immed with -EBUSY
90
	 * if the call would block.
91
	 */
92
 
93
	/* after final dma_buf_put() */
94
	void (*release)(struct dma_buf *);
95
 
96
	int (*begin_cpu_access)(struct dma_buf *, size_t, size_t,
97
				enum dma_data_direction);
98
	void (*end_cpu_access)(struct dma_buf *, size_t, size_t,
99
			       enum dma_data_direction);
100
	void *(*kmap_atomic)(struct dma_buf *, unsigned long);
101
	void (*kunmap_atomic)(struct dma_buf *, unsigned long, void *);
102
	void *(*kmap)(struct dma_buf *, unsigned long);
103
	void (*kunmap)(struct dma_buf *, unsigned long, void *);
104
 
105
	int (*mmap)(struct dma_buf *, struct vm_area_struct *vma);
106
 
107
	void *(*vmap)(struct dma_buf *);
108
	void (*vunmap)(struct dma_buf *, void *vaddr);
109
};
110
 
111
/**
112
 * struct dma_buf - shared buffer object
113
 * @size: size of the buffer
114
 * @file: file pointer used for sharing buffers across, and for refcounting.
115
 * @attachments: list of dma_buf_attachment that denotes all devices attached.
116
 * @ops: dma_buf_ops associated with this buffer object.
117
 * @exp_name: name of the exporter; useful for debugging.
6082 serge 118
 * @owner: pointer to exporter module; used for refcounting when exporter is a
119
 *         kernel module.
4568 Serge 120
 * @list_node: node for dma_buf accounting and debugging.
121
 * @priv: exporter specific private data for this buffer object.
5056 serge 122
 * @resv: reservation object linked to this dma-buf
4568 Serge 123
 */
124
struct dma_buf {
125
	size_t size;
126
	struct file *file;
127
	struct list_head attachments;
128
	const struct dma_buf_ops *ops;
129
	/* mutex to serialize list manipulation, attach/detach and vmap/unmap */
130
	struct mutex lock;
131
	unsigned vmapping_counter;
132
	void *vmap_ptr;
133
	const char *exp_name;
134
	struct list_head list_node;
135
	void *priv;
136
};
137
 
138
/**
139
 * struct dma_buf_attachment - holds device-buffer attachment data
140
 * @dmabuf: buffer for this attachment.
141
 * @dev: device attached to the buffer.
142
 * @node: list of dma_buf_attachment.
143
 * @priv: exporter specific attachment data.
144
 *
145
 * This structure holds the attachment information between the dma_buf buffer
146
 * and its user device(s). The list contains one attachment struct per device
147
 * attached to the buffer.
148
 */
149
struct dma_buf_attachment {
150
	struct dma_buf *dmabuf;
151
	struct device *dev;
152
	struct list_head node;
153
	void *priv;
154
};
155
 
156
/**
157
 * get_dma_buf - convenience wrapper for get_file.
158
 * @dmabuf:	[in]	pointer to dma_buf
159
 *
160
 * Increments the reference count on the dma-buf, needed in case of drivers
161
 * that either need to create additional references to the dmabuf on the
162
 * kernel side.  For example, an exporter that needs to keep a dmabuf ptr
163
 * so that subsequent exports don't create a new dmabuf.
164
 */
165
static inline void get_dma_buf(struct dma_buf *dmabuf)
166
{
167
	get_file(dmabuf->file);
168
}
169
 
170
struct dma_buf_attachment *dma_buf_attach(struct dma_buf *dmabuf,
171
							struct device *dev);
172
void dma_buf_detach(struct dma_buf *dmabuf,
173
				struct dma_buf_attachment *dmabuf_attach);
174
 
6082 serge 175
struct dma_buf *dma_buf_export(const struct dma_buf_export_info *exp_info);
4568 Serge 176
 
177
int dma_buf_fd(struct dma_buf *dmabuf, int flags);
178
struct dma_buf *dma_buf_get(int fd);
179
void dma_buf_put(struct dma_buf *dmabuf);
180
 
181
struct sg_table *dma_buf_map_attachment(struct dma_buf_attachment *,
182
					enum dma_data_direction);
183
void dma_buf_unmap_attachment(struct dma_buf_attachment *, struct sg_table *,
184
				enum dma_data_direction);
185
int dma_buf_begin_cpu_access(struct dma_buf *dma_buf, size_t start, size_t len,
186
			     enum dma_data_direction dir);
187
void dma_buf_end_cpu_access(struct dma_buf *dma_buf, size_t start, size_t len,
188
			    enum dma_data_direction dir);
189
void *dma_buf_kmap_atomic(struct dma_buf *, unsigned long);
190
void dma_buf_kunmap_atomic(struct dma_buf *, unsigned long, void *);
191
void *dma_buf_kmap(struct dma_buf *, unsigned long);
192
void dma_buf_kunmap(struct dma_buf *, unsigned long, void *);
193
 
194
int dma_buf_mmap(struct dma_buf *, struct vm_area_struct *,
195
		 unsigned long);
196
void *dma_buf_vmap(struct dma_buf *);
197
void dma_buf_vunmap(struct dma_buf *, void *vaddr);
5056 serge 198
int dma_buf_debugfs_create_file(const char *name,
199
				int (*write)(struct seq_file *));
4568 Serge 200
#endif /* __DMA_BUF_H__ */