1 /*
2 * ispvideo.h
3 *
4 * TI OMAP3 ISP - Generic video node
5 *
6 * Copyright (C) 2009-2010 Nokia Corporation
7 *
8 * Contacts: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
9 * Sakari Ailus <sakari.ailus@iki.fi>
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 version 2 as
13 * published by the Free Software Foundation.
14 *
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
23 * 02110-1301 USA
24 */
25
26 #ifndef OMAP3_ISP_VIDEO_H
27 #define OMAP3_ISP_VIDEO_H
28
29 #include <linux/v4l2-mediabus.h>
30 #include <media/media-entity.h>
31 #include <media/v4l2-dev.h>
32 #include <media/v4l2-fh.h>
33
34 #include "ispqueue.h"
35
36 #define ISP_VIDEO_DRIVER_NAME "ispvideo"
37 #define ISP_VIDEO_DRIVER_VERSION "0.0.2"
38
39 struct isp_device;
40 struct isp_video;
41 struct v4l2_mbus_framefmt;
42 struct v4l2_pix_format;
43
44 /*
45 * struct isp_format_info - ISP media bus format information
46 * @code: V4L2 media bus format code
47 * @truncated: V4L2 media bus format code for the same format truncated to 10
48 * bits. Identical to @code if the format is 10 bits wide or less.
49 * @uncompressed: V4L2 media bus format code for the corresponding uncompressed
50 * format. Identical to @code if the format is not DPCM compressed.
51 * @flavor: V4L2 media bus format code for the same pixel layout but
52 * shifted to be 8 bits per pixel. =0 if format is not shiftable.
53 * @pixelformat: V4L2 pixel format FCC identifier
54 * @bpp: Bits per pixel
55 */
56 struct isp_format_info {
57 enum v4l2_mbus_pixelcode code;
58 enum v4l2_mbus_pixelcode truncated;
59 enum v4l2_mbus_pixelcode uncompressed;
60 enum v4l2_mbus_pixelcode flavor;
61 u32 pixelformat;
62 unsigned int bpp;
63 };
64
65 enum isp_pipeline_stream_state {
66 ISP_PIPELINE_STREAM_STOPPED = 0,
67 ISP_PIPELINE_STREAM_CONTINUOUS = 1,
68 ISP_PIPELINE_STREAM_SINGLESHOT = 2,
69 };
70
71 enum isp_pipeline_state {
72 /* The stream has been started on the input video node. */
73 ISP_PIPELINE_STREAM_INPUT = 1,
74 /* The stream has been started on the output video node. */
75 ISP_PIPELINE_STREAM_OUTPUT = 2,
76 /* At least one buffer is queued on the input video node. */
77 ISP_PIPELINE_QUEUE_INPUT = 4,
78 /* At least one buffer is queued on the output video node. */
79 ISP_PIPELINE_QUEUE_OUTPUT = 8,
80 /* The input entity is idle, ready to be started. */
81 ISP_PIPELINE_IDLE_INPUT = 16,
82 /* The output entity is idle, ready to be started. */
83 ISP_PIPELINE_IDLE_OUTPUT = 32,
84 /* The pipeline is currently streaming. */
85 ISP_PIPELINE_STREAM = 64,
86 };
87
88 /*
89 * struct isp_pipeline - An ISP hardware pipeline
90 * @error: A hardware error occurred during capture
91 */
92 struct isp_pipeline {
93 struct media_pipeline pipe;
94 spinlock_t lock; /* Pipeline state and queue flags */
95 unsigned int state;
96 enum isp_pipeline_stream_state stream_state;
97 struct isp_video *input;
98 struct isp_video *output;
99 unsigned long l3_ick;
100 unsigned int max_rate;
101 atomic_t frame_number;
102 bool do_propagation; /* of frame number */
103 bool error;
104 struct v4l2_fract max_timeperframe;
105 };
106
107 #define to_isp_pipeline(__e) \
108 container_of((__e)->pipe, struct isp_pipeline, pipe)
109
isp_pipeline_ready(struct isp_pipeline * pipe)110 static inline int isp_pipeline_ready(struct isp_pipeline *pipe)
111 {
112 return pipe->state == (ISP_PIPELINE_STREAM_INPUT |
113 ISP_PIPELINE_STREAM_OUTPUT |
114 ISP_PIPELINE_QUEUE_INPUT |
115 ISP_PIPELINE_QUEUE_OUTPUT |
116 ISP_PIPELINE_IDLE_INPUT |
117 ISP_PIPELINE_IDLE_OUTPUT);
118 }
119
120 /*
121 * struct isp_buffer - ISP buffer
122 * @buffer: ISP video buffer
123 * @isp_addr: MMU mapped address (a.k.a. device address) of the buffer.
124 */
125 struct isp_buffer {
126 struct isp_video_buffer buffer;
127 dma_addr_t isp_addr;
128 };
129
130 #define to_isp_buffer(buf) container_of(buf, struct isp_buffer, buffer)
131
132 enum isp_video_dmaqueue_flags {
133 /* Set if DMA queue becomes empty when ISP_PIPELINE_STREAM_CONTINUOUS */
134 ISP_VIDEO_DMAQUEUE_UNDERRUN = (1 << 0),
135 /* Set when queuing buffer to an empty DMA queue */
136 ISP_VIDEO_DMAQUEUE_QUEUED = (1 << 1),
137 };
138
139 #define isp_video_dmaqueue_flags_clr(video) \
140 ({ (video)->dmaqueue_flags = 0; })
141
142 /*
143 * struct isp_video_operations - ISP video operations
144 * @queue: Resume streaming when a buffer is queued. Called on VIDIOC_QBUF
145 * if there was no buffer previously queued.
146 */
147 struct isp_video_operations {
148 int(*queue)(struct isp_video *video, struct isp_buffer *buffer);
149 };
150
151 struct isp_video {
152 struct video_device video;
153 enum v4l2_buf_type type;
154 struct media_pad pad;
155
156 struct mutex mutex; /* format and crop settings */
157 atomic_t active;
158
159 struct isp_device *isp;
160
161 unsigned int capture_mem;
162 unsigned int bpl_alignment; /* alignment value */
163 unsigned int bpl_zero_padding; /* whether the alignment is optional */
164 unsigned int bpl_max; /* maximum bytes per line value */
165 unsigned int bpl_value; /* bytes per line value */
166 unsigned int bpl_padding; /* padding at end of line */
167
168 /* Entity video node streaming */
169 unsigned int streaming:1;
170
171 /* Pipeline state */
172 struct isp_pipeline pipe;
173 struct mutex stream_lock; /* pipeline and stream states */
174
175 /* Video buffers queue */
176 struct isp_video_queue *queue;
177 struct list_head dmaqueue;
178 enum isp_video_dmaqueue_flags dmaqueue_flags;
179
180 const struct isp_video_operations *ops;
181 };
182
183 #define to_isp_video(vdev) container_of(vdev, struct isp_video, video)
184
185 struct isp_video_fh {
186 struct v4l2_fh vfh;
187 struct isp_video *video;
188 struct isp_video_queue queue;
189 struct v4l2_format format;
190 struct v4l2_fract timeperframe;
191 };
192
193 #define to_isp_video_fh(fh) container_of(fh, struct isp_video_fh, vfh)
194 #define isp_video_queue_to_isp_video_fh(q) \
195 container_of(q, struct isp_video_fh, queue)
196
197 int omap3isp_video_init(struct isp_video *video, const char *name);
198 void omap3isp_video_cleanup(struct isp_video *video);
199 int omap3isp_video_register(struct isp_video *video,
200 struct v4l2_device *vdev);
201 void omap3isp_video_unregister(struct isp_video *video);
202 struct isp_buffer *omap3isp_video_buffer_next(struct isp_video *video);
203 void omap3isp_video_resume(struct isp_video *video, int continuous);
204 struct media_pad *omap3isp_video_remote_pad(struct isp_video *video);
205
206 const struct isp_format_info *
207 omap3isp_video_format_info(enum v4l2_mbus_pixelcode code);
208
209 #endif /* OMAP3_ISP_VIDEO_H */
210