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 */
44struct 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
52struct v4l2_m2m_dev;
53
54struct 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	bool			buffered;
64};
65
66struct v4l2_m2m_ctx {
67	/* optional cap/out vb2 queues lock */
68	struct mutex			*q_lock;
69
70/* private: internal use only */
71	struct v4l2_m2m_dev		*m2m_dev;
72
73	/* Capture (output to memory) queue context */
74	struct v4l2_m2m_queue_ctx	cap_q_ctx;
75
76	/* Output (input from memory) queue context */
77	struct v4l2_m2m_queue_ctx	out_q_ctx;
78
79	/* For device job queue */
80	struct list_head		queue;
81	unsigned long			job_flags;
82	wait_queue_head_t		finished;
83
84	/* Instance private data */
85	void				*priv;
86};
87
88struct v4l2_m2m_buffer {
89	struct vb2_buffer	vb;
90	struct list_head	list;
91};
92
93void *v4l2_m2m_get_curr_priv(struct v4l2_m2m_dev *m2m_dev);
94
95struct vb2_queue *v4l2_m2m_get_vq(struct v4l2_m2m_ctx *m2m_ctx,
96				       enum v4l2_buf_type type);
97
98void v4l2_m2m_try_schedule(struct v4l2_m2m_ctx *m2m_ctx);
99
100void v4l2_m2m_job_finish(struct v4l2_m2m_dev *m2m_dev,
101			 struct v4l2_m2m_ctx *m2m_ctx);
102
103static inline void
104v4l2_m2m_buf_done(struct vb2_buffer *buf, enum vb2_buffer_state state)
105{
106	vb2_buffer_done(buf, state);
107}
108
109int v4l2_m2m_reqbufs(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
110		     struct v4l2_requestbuffers *reqbufs);
111
112int v4l2_m2m_querybuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
113		      struct v4l2_buffer *buf);
114
115int v4l2_m2m_qbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
116		  struct v4l2_buffer *buf);
117int v4l2_m2m_dqbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
118		   struct v4l2_buffer *buf);
119int v4l2_m2m_create_bufs(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
120			 struct v4l2_create_buffers *create);
121
122int v4l2_m2m_expbuf(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
123		   struct v4l2_exportbuffer *eb);
124
125int v4l2_m2m_streamon(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
126		      enum v4l2_buf_type type);
127int v4l2_m2m_streamoff(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
128		       enum v4l2_buf_type type);
129
130unsigned int v4l2_m2m_poll(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
131			   struct poll_table_struct *wait);
132
133int v4l2_m2m_mmap(struct file *file, struct v4l2_m2m_ctx *m2m_ctx,
134		  struct vm_area_struct *vma);
135
136struct v4l2_m2m_dev *v4l2_m2m_init(const struct v4l2_m2m_ops *m2m_ops);
137void v4l2_m2m_release(struct v4l2_m2m_dev *m2m_dev);
138
139struct v4l2_m2m_ctx *v4l2_m2m_ctx_init(struct v4l2_m2m_dev *m2m_dev,
140		void *drv_priv,
141		int (*queue_init)(void *priv, struct vb2_queue *src_vq, struct vb2_queue *dst_vq));
142
143static inline void v4l2_m2m_set_src_buffered(struct v4l2_m2m_ctx *m2m_ctx,
144					     bool buffered)
145{
146	m2m_ctx->out_q_ctx.buffered = buffered;
147}
148
149static inline void v4l2_m2m_set_dst_buffered(struct v4l2_m2m_ctx *m2m_ctx,
150					     bool buffered)
151{
152	m2m_ctx->cap_q_ctx.buffered = buffered;
153}
154
155void v4l2_m2m_ctx_release(struct v4l2_m2m_ctx *m2m_ctx);
156
157void v4l2_m2m_buf_queue(struct v4l2_m2m_ctx *m2m_ctx, struct vb2_buffer *vb);
158
159/**
160 * v4l2_m2m_num_src_bufs_ready() - return the number of source buffers ready for
161 * use
162 */
163static inline
164unsigned int v4l2_m2m_num_src_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx)
165{
166	return m2m_ctx->out_q_ctx.num_rdy;
167}
168
169/**
170 * v4l2_m2m_num_src_bufs_ready() - return the number of destination buffers
171 * ready for use
172 */
173static inline
174unsigned int v4l2_m2m_num_dst_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx)
175{
176	return m2m_ctx->cap_q_ctx.num_rdy;
177}
178
179void *v4l2_m2m_next_buf(struct v4l2_m2m_queue_ctx *q_ctx);
180
181/**
182 * v4l2_m2m_next_src_buf() - return next source buffer from the list of ready
183 * buffers
184 */
185static inline void *v4l2_m2m_next_src_buf(struct v4l2_m2m_ctx *m2m_ctx)
186{
187	return v4l2_m2m_next_buf(&m2m_ctx->out_q_ctx);
188}
189
190/**
191 * v4l2_m2m_next_dst_buf() - return next destination buffer from the list of
192 * ready buffers
193 */
194static inline void *v4l2_m2m_next_dst_buf(struct v4l2_m2m_ctx *m2m_ctx)
195{
196	return v4l2_m2m_next_buf(&m2m_ctx->cap_q_ctx);
197}
198
199/**
200 * v4l2_m2m_get_src_vq() - return vb2_queue for source buffers
201 */
202static inline
203struct vb2_queue *v4l2_m2m_get_src_vq(struct v4l2_m2m_ctx *m2m_ctx)
204{
205	return &m2m_ctx->out_q_ctx.q;
206}
207
208/**
209 * v4l2_m2m_get_dst_vq() - return vb2_queue for destination buffers
210 */
211static inline
212struct vb2_queue *v4l2_m2m_get_dst_vq(struct v4l2_m2m_ctx *m2m_ctx)
213{
214	return &m2m_ctx->cap_q_ctx.q;
215}
216
217void *v4l2_m2m_buf_remove(struct v4l2_m2m_queue_ctx *q_ctx);
218
219/**
220 * v4l2_m2m_src_buf_remove() - take off a source buffer from the list of ready
221 * buffers and return it
222 */
223static inline void *v4l2_m2m_src_buf_remove(struct v4l2_m2m_ctx *m2m_ctx)
224{
225	return v4l2_m2m_buf_remove(&m2m_ctx->out_q_ctx);
226}
227
228/**
229 * v4l2_m2m_dst_buf_remove() - take off a destination buffer from the list of
230 * ready buffers and return it
231 */
232static inline void *v4l2_m2m_dst_buf_remove(struct v4l2_m2m_ctx *m2m_ctx)
233{
234	return v4l2_m2m_buf_remove(&m2m_ctx->cap_q_ctx);
235}
236
237/* v4l2 ioctl helpers */
238
239int v4l2_m2m_ioctl_reqbufs(struct file *file, void *priv,
240				struct v4l2_requestbuffers *rb);
241int v4l2_m2m_ioctl_create_bufs(struct file *file, void *fh,
242				struct v4l2_create_buffers *create);
243int v4l2_m2m_ioctl_querybuf(struct file *file, void *fh,
244				struct v4l2_buffer *buf);
245int v4l2_m2m_ioctl_expbuf(struct file *file, void *fh,
246				struct v4l2_exportbuffer *eb);
247int v4l2_m2m_ioctl_qbuf(struct file *file, void *fh,
248				struct v4l2_buffer *buf);
249int v4l2_m2m_ioctl_dqbuf(struct file *file, void *fh,
250				struct v4l2_buffer *buf);
251int v4l2_m2m_ioctl_streamon(struct file *file, void *fh,
252				enum v4l2_buf_type type);
253int v4l2_m2m_ioctl_streamoff(struct file *file, void *fh,
254				enum v4l2_buf_type type);
255int v4l2_m2m_fop_mmap(struct file *file, struct vm_area_struct *vma);
256unsigned int v4l2_m2m_fop_poll(struct file *file, poll_table *wait);
257
258#endif /* _MEDIA_V4L2_MEM2MEM_H */
259
260