xref: /linux/include/media/v4l2-mem2mem.h (revision 0d456bad36d42d16022be045c8a53ddbb59ee478)
1 /*
2  * Memory-to-memory device framework for Video for Linux 2.
3  *
4  * Helper functions for devices that use memory buffers for both source
5  * and destination.
6  *
7  * Copyright (c) 2009 Samsung Electronics Co., Ltd.
8  * Pawel Osciak, <pawel@osciak.com>
9  * Marek Szyprowski, <m.szyprowski@samsung.com>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by the
13  * Free Software Foundation; either version 2 of the
14  * License, or (at your option) any later version
15  */
16 
17 #ifndef _MEDIA_V4L2_MEM2MEM_H
18 #define _MEDIA_V4L2_MEM2MEM_H
19 
20 #include <media/videobuf2-core.h>
21 
22 /**
23  * struct v4l2_m2m_ops - mem-to-mem device driver callbacks
24  * @device_run:	required. Begin the actual job (transaction) inside this
25  *		callback.
26  *		The job does NOT have to end before this callback returns
27  *		(and it will be the usual case). When the job finishes,
28  *		v4l2_m2m_job_finish() has to be called.
29  * @job_ready:	optional. Should return 0 if the driver does not have a job
30  *		fully prepared to run yet (i.e. it will not be able to finish a
31  *		transaction without sleeping). If not provided, it will be
32  *		assumed that one source and one destination buffer are all
33  *		that is required for the driver to perform one full transaction.
34  *		This method may not sleep.
35  * @job_abort:	required. Informs the driver that it has to abort the currently
36  *		running transaction as soon as possible (i.e. as soon as it can
37  *		stop the device safely; e.g. in the next interrupt handler),
38  *		even if the transaction would not have been finished by then.
39  *		After the driver performs the necessary steps, it has to call
40  *		v4l2_m2m_job_finish() (as if the transaction ended normally).
41  *		This function does not have to (and will usually not) wait
42  *		until the device enters a state when it can be stopped.
43  */
44 struct v4l2_m2m_ops {
45 	void (*device_run)(void *priv);
46 	int (*job_ready)(void *priv);
47 	void (*job_abort)(void *priv);
48 	void (*lock)(void *priv);
49 	void (*unlock)(void *priv);
50 };
51 
52 struct v4l2_m2m_dev;
53 
54 struct v4l2_m2m_queue_ctx {
55 /* private: internal use only */
56 	struct vb2_queue	q;
57 
58 	/* Queue for buffers ready to be processed as soon as this
59 	 * instance receives access to the device */
60 	struct list_head	rdy_queue;
61 	spinlock_t		rdy_spinlock;
62 	u8			num_rdy;
63 };
64 
65 struct v4l2_m2m_ctx {
66 /* private: internal use only */
67 	struct v4l2_m2m_dev		*m2m_dev;
68 
69 	/* Capture (output to memory) queue context */
70 	struct v4l2_m2m_queue_ctx	cap_q_ctx;
71 
72 	/* Output (input from memory) queue context */
73 	struct v4l2_m2m_queue_ctx	out_q_ctx;
74 
75 	/* For device job queue */
76 	struct list_head		queue;
77 	unsigned long			job_flags;
78 	wait_queue_head_t		finished;
79 
80 	/* Instance private data */
81 	void				*priv;
82 };
83 
84 struct v4l2_m2m_buffer {
85 	struct vb2_buffer	vb;
86 	struct list_head	list;
87 };
88 
89 void *v4l2_m2m_get_curr_priv(struct v4l2_m2m_dev *m2m_dev);
90 
91 struct vb2_queue *v4l2_m2m_get_vq(struct v4l2_m2m_ctx *m2m_ctx,
92 				       enum v4l2_buf_type type);
93 
94 void v4l2_m2m_job_finish(struct v4l2_m2m_dev *m2m_dev,
95 			 struct v4l2_m2m_ctx *m2m_ctx);
96 
97 static inline void
98 v4l2_m2m_buf_done(struct vb2_buffer *buf, enum vb2_buffer_state state)
99 {
100 	vb2_buffer_done(buf, state);
101 }
102 
103 int v4l2_m2m_reqbufs(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
104 		     struct v4l2_requestbuffers *reqbufs);
105 
106 int v4l2_m2m_querybuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
107 		      struct v4l2_buffer *buf);
108 
109 int v4l2_m2m_qbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
110 		  struct v4l2_buffer *buf);
111 int v4l2_m2m_dqbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
112 		   struct v4l2_buffer *buf);
113 
114 int v4l2_m2m_expbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
115 		   struct v4l2_exportbuffer *eb);
116 
117 int v4l2_m2m_streamon(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
118 		      enum v4l2_buf_type type);
119 int v4l2_m2m_streamoff(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
120 		       enum v4l2_buf_type type);
121 
122 unsigned int v4l2_m2m_poll(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
123 			   struct poll_table_struct *wait);
124 
125 int v4l2_m2m_mmap(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
126 		  struct vm_area_struct *vma);
127 
128 struct v4l2_m2m_dev *v4l2_m2m_init(struct v4l2_m2m_ops *m2m_ops);
129 void v4l2_m2m_release(struct v4l2_m2m_dev *m2m_dev);
130 
131 struct v4l2_m2m_ctx *v4l2_m2m_ctx_init(struct v4l2_m2m_dev *m2m_dev,
132 		void *drv_priv,
133 		int (*queue_init)(void *priv, struct vb2_queue *src_vq, struct vb2_queue *dst_vq));
134 
135 void v4l2_m2m_ctx_release(struct v4l2_m2m_ctx *m2m_ctx);
136 
137 void v4l2_m2m_buf_queue(struct v4l2_m2m_ctx *m2m_ctx, struct vb2_buffer *vb);
138 
139 /**
140  * v4l2_m2m_num_src_bufs_ready() - return the number of source buffers ready for
141  * use
142  */
143 static inline
144 unsigned int v4l2_m2m_num_src_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx)
145 {
146 	return m2m_ctx->out_q_ctx.num_rdy;
147 }
148 
149 /**
150  * v4l2_m2m_num_src_bufs_ready() - return the number of destination buffers
151  * ready for use
152  */
153 static inline
154 unsigned int v4l2_m2m_num_dst_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx)
155 {
156 	return m2m_ctx->cap_q_ctx.num_rdy;
157 }
158 
159 void *v4l2_m2m_next_buf(struct v4l2_m2m_queue_ctx *q_ctx);
160 
161 /**
162  * v4l2_m2m_next_src_buf() - return next source buffer from the list of ready
163  * buffers
164  */
165 static inline void *v4l2_m2m_next_src_buf(struct v4l2_m2m_ctx *m2m_ctx)
166 {
167 	return v4l2_m2m_next_buf(&m2m_ctx->out_q_ctx);
168 }
169 
170 /**
171  * v4l2_m2m_next_dst_buf() - return next destination buffer from the list of
172  * ready buffers
173  */
174 static inline void *v4l2_m2m_next_dst_buf(struct v4l2_m2m_ctx *m2m_ctx)
175 {
176 	return v4l2_m2m_next_buf(&m2m_ctx->cap_q_ctx);
177 }
178 
179 /**
180  * v4l2_m2m_get_src_vq() - return vb2_queue for source buffers
181  */
182 static inline
183 struct vb2_queue *v4l2_m2m_get_src_vq(struct v4l2_m2m_ctx *m2m_ctx)
184 {
185 	return &m2m_ctx->out_q_ctx.q;
186 }
187 
188 /**
189  * v4l2_m2m_get_dst_vq() - return vb2_queue for destination buffers
190  */
191 static inline
192 struct vb2_queue *v4l2_m2m_get_dst_vq(struct v4l2_m2m_ctx *m2m_ctx)
193 {
194 	return &m2m_ctx->cap_q_ctx.q;
195 }
196 
197 void *v4l2_m2m_buf_remove(struct v4l2_m2m_queue_ctx *q_ctx);
198 
199 /**
200  * v4l2_m2m_src_buf_remove() - take off a source buffer from the list of ready
201  * buffers and return it
202  */
203 static inline void *v4l2_m2m_src_buf_remove(struct v4l2_m2m_ctx *m2m_ctx)
204 {
205 	return v4l2_m2m_buf_remove(&m2m_ctx->out_q_ctx);
206 }
207 
208 /**
209  * v4l2_m2m_dst_buf_remove() - take off a destination buffer from the list of
210  * ready buffers and return it
211  */
212 static inline void *v4l2_m2m_dst_buf_remove(struct v4l2_m2m_ctx *m2m_ctx)
213 {
214 	return v4l2_m2m_buf_remove(&m2m_ctx->cap_q_ctx);
215 }
216 
217 #endif /* _MEDIA_V4L2_MEM2MEM_H */
218 
219