drivers/media/video/omap3isp/ispvideo.h

   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 struct isp_pipeline {
  89         struct media_pipeline pipe;
  90         spinlock_t lock;                /* Pipeline state and queue flags */
  91         unsigned int state;
  92         enum isp_pipeline_stream_state stream_state;
  93         struct isp_video *input;
  94         struct isp_video *output;
  95         unsigned long l3_ick;
  96         unsigned int max_rate;
  97         atomic_t frame_number;
  98         bool do_propagation; /* of frame number */
  99         struct v4l2_fract max_timeperframe;
 100 };
 101
 102 #define to_isp_pipeline(__e) \
 103         container_of((__e)->pipe, struct isp_pipeline, pipe)
 104
 105 static inline int isp_pipeline_ready(struct isp_pipeline *pipe)
 106 {
 107         return pipe->state == (ISP_PIPELINE_STREAM_INPUT |
 108                                ISP_PIPELINE_STREAM_OUTPUT |
 109                                ISP_PIPELINE_QUEUE_INPUT |
 110                                ISP_PIPELINE_QUEUE_OUTPUT |
 111                                ISP_PIPELINE_IDLE_INPUT |
 112                                ISP_PIPELINE_IDLE_OUTPUT);
 113 }
 114
 115 /*
 116  * struct isp_buffer - ISP buffer
 117  * @buffer: ISP video buffer
 118  * @isp_addr: MMU mapped address (a.k.a. device address) of the buffer.
 119  */
 120 struct isp_buffer {
 121         struct isp_video_buffer buffer;
 122         dma_addr_t isp_addr;
 123 };
 124
 125 #define to_isp_buffer(buf)      container_of(buf, struct isp_buffer, buffer)
 126
 127 enum isp_video_dmaqueue_flags {
 128         /* Set if DMA queue becomes empty when ISP_PIPELINE_STREAM_CONTINUOUS */
 129         ISP_VIDEO_DMAQUEUE_UNDERRUN = (1 << 0),
 130         /* Set when queuing buffer to an empty DMA queue */
 131         ISP_VIDEO_DMAQUEUE_QUEUED = (1 << 1),
 132 };
 133
 134 #define isp_video_dmaqueue_flags_clr(video)     \
 135                         ({ (video)->dmaqueue_flags = 0; })
 136
 137 /*
 138  * struct isp_video_operations - ISP video operations
 139  * @queue:      Resume streaming when a buffer is queued. Called on VIDIOC_QBUF
 140  *              if there was no buffer previously queued.
 141  */
 142 struct isp_video_operations {
 143         int(*queue)(struct isp_video *video, struct isp_buffer *buffer);
 144 };
 145
 146 struct isp_video {
 147         struct video_device video;
 148         enum v4l2_buf_type type;
 149         struct media_pad pad;
 150
 151         struct mutex mutex;             /* format and crop settings */
 152         atomic_t active;
 153
 154         struct isp_device *isp;
 155
 156         unsigned int capture_mem;
 157         unsigned int bpl_alignment;     /* alignment value */
 158         unsigned int bpl_zero_padding;  /* whether the alignment is optional */
 159         unsigned int bpl_max;           /* maximum bytes per line value */
 160         unsigned int bpl_value;         /* bytes per line value */
 161         unsigned int bpl_padding;       /* padding at end of line */
 162
 163         /* Entity video node streaming */
 164         unsigned int streaming:1;
 165
 166         /* Pipeline state */
 167         struct isp_pipeline pipe;
 168         struct mutex stream_lock;       /* pipeline and stream states */
 169
 170         /* Video buffers queue */
 171         struct isp_video_queue *queue;
 172         struct list_head dmaqueue;
 173         enum isp_video_dmaqueue_flags dmaqueue_flags;
 174
 175         const struct isp_video_operations *ops;
 176 };
 177
 178 #define to_isp_video(vdev)      container_of(vdev, struct isp_video, video)
 179
 180 struct isp_video_fh {
 181         struct v4l2_fh vfh;
 182         struct isp_video *video;
 183         struct isp_video_queue queue;
 184         struct v4l2_format format;
 185         struct v4l2_fract timeperframe;
 186 };
 187
 188 #define to_isp_video_fh(fh)     container_of(fh, struct isp_video_fh, vfh)
 189 #define isp_video_queue_to_isp_video_fh(q) \
 190                                 container_of(q, struct isp_video_fh, queue)
 191
 192 int omap3isp_video_init(struct isp_video *video, const char *name);
 193 int omap3isp_video_register(struct isp_video *video,
 194                             struct v4l2_device *vdev);
 195 void omap3isp_video_unregister(struct isp_video *video);
 196 struct isp_buffer *omap3isp_video_buffer_next(struct isp_video *video,
 197                                               unsigned int error);
 198 void omap3isp_video_resume(struct isp_video *video, int continuous);
 199 struct media_pad *omap3isp_video_remote_pad(struct isp_video *video);
 200
 201 const struct isp_format_info *
 202 omap3isp_video_format_info(enum v4l2_mbus_pixelcode code);
 203
 204 #endif /* OMAP3_ISP_VIDEO_H */