1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * Copyright (C) 2010 - 2012 Samsung Electronics Co., Ltd.
11 #include <linux/platform_device.h>
12 #include <linux/regmap.h>
13 #include <linux/sched.h>
14 #include <linux/spinlock.h>
15 #include <linux/mfd/syscon.h>
16 #include <linux/types.h>
17 #include <linux/videodev2.h>
19 #include <linux/sizes.h>
21 #include <media/media-entity.h>
22 #include <media/videobuf2-v4l2.h>
23 #include <media/v4l2-ctrls.h>
24 #include <media/v4l2-device.h>
25 #include <media/v4l2-mem2mem.h>
26 #include <media/v4l2-mediabus.h>
27 #include <media/drv-intf/exynos-fimc.h>
29 #define dbg(fmt, args...) \
30 pr_debug("%s:%d: " fmt "\n", __func__, __LINE__, ##args)
32 /* Time to wait for next frame VSYNC interrupt while stopping operation. */
33 #define FIMC_SHUTDOWN_TIMEOUT ((100*HZ)/1000)
34 #define MAX_FIMC_CLOCKS 2
35 #define FIMC_DRIVER_NAME "exynos4-fimc"
36 #define FIMC_MAX_DEVS 4
37 #define FIMC_MAX_OUT_BUFS 4
38 #define SCALER_MAX_HRATIO 64
39 #define SCALER_MAX_VRATIO 64
40 #define DMA_MIN_SIZE 8
41 #define FIMC_CAMIF_MAX_HEIGHT 0x2000
42 #define FIMC_MAX_JPEG_BUF_SIZE (10 * SZ_1M)
43 #define FIMC_MAX_PLANES 3
44 #define FIMC_PIX_LIMITS_MAX 4
45 #define FIMC_DEF_MIN_SIZE 16
46 #define FIMC_DEF_HEIGHT_ALIGN 2
47 #define FIMC_DEF_HOR_OFFS_ALIGN 1
48 #define FIMC_DEFAULT_WIDTH 640
49 #define FIMC_DEFAULT_HEIGHT 480
51 /* indices to the clocks array */
76 #define fimc_m2m_active(dev) test_bit(ST_M2M_RUN, &(dev)->state)
77 #define fimc_m2m_pending(dev) test_bit(ST_M2M_PEND, &(dev)->state)
79 #define fimc_capture_running(dev) test_bit(ST_CAPT_RUN, &(dev)->state)
80 #define fimc_capture_pending(dev) test_bit(ST_CAPT_PEND, &(dev)->state)
81 #define fimc_capture_busy(dev) test_bit(ST_CAPT_BUSY, &(dev)->state)
93 FIMC_FMT_RGB444 = 0x10,
99 FIMC_FMT_YCBCR420 = 0x20,
104 FIMC_FMT_YCBCR444_LOCAL,
105 FIMC_FMT_RAW8 = 0x40,
108 FIMC_FMT_JPEG = 0x80,
109 FIMC_FMT_YUYV_JPEG = 0x100,
112 #define fimc_fmt_is_user_defined(x) (!!((x) & 0x180))
113 #define fimc_fmt_is_rgb(x) (!!((x) & 0x10))
115 #define IS_M2M(__strt) ((__strt) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE || \
116 __strt == V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE)
118 /* The hardware context state. */
119 #define FIMC_PARAMS (1 << 0)
120 #define FIMC_COMPOSE (1 << 1)
121 #define FIMC_CTX_M2M (1 << 16)
122 #define FIMC_CTX_CAP (1 << 17)
123 #define FIMC_CTX_SHUT (1 << 18)
125 /* Image conversion flags */
126 #define FIMC_IN_DMA_ACCESS_TILED (1 << 0)
127 #define FIMC_IN_DMA_ACCESS_LINEAR (0 << 0)
128 #define FIMC_OUT_DMA_ACCESS_TILED (1 << 1)
129 #define FIMC_OUT_DMA_ACCESS_LINEAR (0 << 1)
130 #define FIMC_SCAN_MODE_PROGRESSIVE (0 << 2)
131 #define FIMC_SCAN_MODE_INTERLACED (1 << 2)
133 * YCbCr data dynamic range for RGB-YUV color conversion.
134 * Y/Cb/Cr: (0 ~ 255) */
135 #define FIMC_COLOR_RANGE_WIDE (0 << 3)
136 /* Y (16 ~ 235), Cb/Cr (16 ~ 240) */
137 #define FIMC_COLOR_RANGE_NARROW (1 << 3)
140 * struct fimc_dma_offset - pixel offset information for DMA
141 * @y_h: y value horizontal offset
142 * @y_v: y value vertical offset
143 * @cb_h: cb value horizontal offset
144 * @cb_v: cb value vertical offset
145 * @cr_h: cr value horizontal offset
146 * @cr_v: cr value vertical offset
148 struct fimc_dma_offset {
158 * struct fimc_effect - color effect information
160 * @pat_cb: cr value when type is "arbitrary"
161 * @pat_cr: cr value when type is "arbitrary"
170 * struct fimc_scaler - the configuration data for FIMC inetrnal scaler
171 * @scaleup_h: flag indicating scaling up horizontally
172 * @scaleup_v: flag indicating scaling up vertically
173 * @copy_mode: flag indicating transparent DMA transfer (no scaling
174 * and color format conversion)
175 * @enabled: flag indicating if the scaler is used
176 * @hfactor: horizontal shift factor
177 * @vfactor: vertical shift factor
178 * @pre_hratio: horizontal ratio of the prescaler
179 * @pre_vratio: vertical ratio of the prescaler
180 * @pre_dst_width: the prescaler's destination width
181 * @pre_dst_height: the prescaler's destination height
182 * @main_hratio: the main scaler's horizontal ratio
183 * @main_vratio: the main scaler's vertical ratio
184 * @real_width: source pixel (width - offset)
185 * @real_height: source pixel (height - offset)
188 unsigned int scaleup_h:1;
189 unsigned int scaleup_v:1;
190 unsigned int copy_mode:1;
191 unsigned int enabled:1;
205 * struct fimc_addr - the FIMC address set for DMA
206 * @y: luminance plane address
207 * @cb: Cb plane address
208 * @cr: Cr plane address
217 * struct fimc_vid_buffer - the driver's video buffer
218 * @vb: v4l videobuf buffer
219 * @list: linked list structure for buffer queue
220 * @addr: precalculated DMA address set
221 * @index: buffer index for the output DMA engine
223 struct fimc_vid_buffer {
224 struct vb2_v4l2_buffer vb;
225 struct list_head list;
226 struct fimc_addr addr;
231 * struct fimc_frame - source/target frame properties
232 * @f_width: image full width (virtual screen size)
233 * @f_height: image full height (virtual screen size)
234 * @o_width: original image width as set by S_FMT
235 * @o_height: original image height as set by S_FMT
236 * @offs_h: image horizontal pixel offset
237 * @offs_v: image vertical pixel offset
238 * @width: image pixel width
239 * @height: image pixel weight
240 * @payload: image size in bytes (w x h x bpp)
241 * @bytesperline: bytesperline value for each plane
242 * @addr: image frame buffer DMA addresses
243 * @dma_offset: DMA offset in bytes
244 * @fmt: fimc color format pointer
245 * @alpha: alpha value
256 unsigned int payload[VIDEO_MAX_PLANES];
257 unsigned int bytesperline[VIDEO_MAX_PLANES];
258 struct fimc_addr addr;
259 struct fimc_dma_offset dma_offset;
260 struct fimc_fmt *fmt;
265 * struct fimc_m2m_device - v4l2 memory-to-memory device data
266 * @vfd: the video device node for v4l2 m2m mode
267 * @m2m_dev: v4l2 memory-to-memory device data
268 * @ctx: hardware context data
269 * @refcnt: the reference counter
271 struct fimc_m2m_device {
272 struct video_device vfd;
273 struct v4l2_m2m_dev *m2m_dev;
274 struct fimc_ctx *ctx;
278 #define FIMC_SD_PAD_SINK_CAM 0
279 #define FIMC_SD_PAD_SINK_FIFO 1
280 #define FIMC_SD_PAD_SOURCE 2
281 #define FIMC_SD_PADS_NUM 3
284 * struct fimc_vid_cap - camera capture device information
285 * @ctx: hardware context data
286 * @subdev: subdev exposing the FIMC processing block
287 * @ve: exynos video device entity structure
288 * @vd_pad: fimc video capture node pad
289 * @sd_pads: fimc video processing block pads
290 * @ci_fmt: image format at the FIMC camera input (and the scaler output)
291 * @wb_fmt: image format at the FIMC ISP Writeback input
292 * @source_config: external image source related configuration structure
293 * @pending_buf_q: the pending buffer queue head
294 * @active_buf_q: the queue head of buffers scheduled in hardware
295 * @vbq: the capture am video buffer queue
296 * @active_buf_cnt: number of video buffers scheduled in hardware
297 * @buf_index: index for managing the output DMA buffers
298 * @frame_count: the frame counter for statistics
299 * @reqbufs_count: the number of buffers requested in REQBUFS ioctl
300 * @streaming: is streaming in progress?
301 * @input: capture input type, grp_id of the attached subdev
302 * @user_subdev_api: true if subdevs are not configured by the host driver
304 struct fimc_vid_cap {
305 struct fimc_ctx *ctx;
306 struct v4l2_subdev subdev;
307 struct exynos_video_entity ve;
308 struct media_pad vd_pad;
309 struct media_pad sd_pads[FIMC_SD_PADS_NUM];
310 struct v4l2_mbus_framefmt ci_fmt;
311 struct v4l2_mbus_framefmt wb_fmt;
312 struct fimc_source_info source_config;
313 struct list_head pending_buf_q;
314 struct list_head active_buf_q;
315 struct vb2_queue vbq;
318 unsigned int frame_count;
319 unsigned int reqbufs_count;
322 bool user_subdev_api;
326 * struct fimc_pix_limit - image pixel size limits in various IP configurations
328 * @scaler_en_w: max input pixel width when the scaler is enabled
329 * @scaler_dis_w: max input pixel width when the scaler is disabled
330 * @in_rot_en_h: max input width with the input rotator is on
331 * @in_rot_dis_w: max input width with the input rotator is off
332 * @out_rot_en_w: max output width with the output rotator on
333 * @out_rot_dis_w: max output width with the output rotator off
335 struct fimc_pix_limit {
345 * struct fimc_variant - FIMC device variant information
346 * @has_inp_rot: set if has input rotator
347 * @has_out_rot: set if has output rotator
348 * @has_mainscaler_ext: 1 if extended mainscaler ratios in CIEXTEN register
349 * are present in this IP revision
350 * @has_cam_if: set if this instance has a camera input interface
351 * @has_isp_wb: set if this instance has ISP writeback input
352 * @pix_limit: pixel size constraints for the scaler
353 * @min_inp_pixsize: minimum input pixel size
354 * @min_out_pixsize: minimum output pixel size
355 * @hor_offs_align: horizontal pixel offset alignment
356 * @min_vsize_align: minimum vertical pixel size alignment
358 struct fimc_variant {
359 unsigned int has_inp_rot:1;
360 unsigned int has_out_rot:1;
361 unsigned int has_mainscaler_ext:1;
362 unsigned int has_cam_if:1;
363 unsigned int has_isp_wb:1;
364 const struct fimc_pix_limit *pix_limit;
372 * struct fimc_drvdata - per device type driver data
373 * @variant: variant information for this device
374 * @num_entities: number of fimc instances available in a SoC
375 * @lclk_frequency: local bus clock frequency
376 * @cistatus2: 1 if the FIMC IPs have CISTATUS2 register
377 * @dma_pix_hoff: the horizontal DMA offset unit: 1 - pixels, 0 - bytes
378 * @alpha_color: 1 if alpha color component is supported
379 * @out_buf_count: maximum number of output DMA buffers supported
381 struct fimc_drvdata {
382 const struct fimc_variant *variant[FIMC_MAX_DEVS];
384 unsigned long lclk_frequency;
385 /* Fields common to all FIMC IP instances */
392 #define fimc_get_drvdata(_pdev) \
393 ((struct fimc_drvdata *) platform_get_device_id(_pdev)->driver_data)
398 * struct fimc_dev - abstraction for FIMC entity
399 * @slock: the spinlock protecting this data structure
400 * @lock: the mutex protecting this data structure
401 * @pdev: pointer to the FIMC platform device
402 * @pdata: pointer to the device platform data
403 * @sysreg: pointer to the SYSREG regmap
404 * @variant: the IP variant information
405 * @drv_data: driver data
406 * @id: FIMC device index (0..FIMC_MAX_DEVS)
407 * @clock: clocks required for FIMC operation
408 * @regs: the mapped hardware registers
409 * @irq_queue: interrupt handler waitqueue
410 * @v4l2_dev: root v4l2_device
411 * @m2m: memory-to-memory V4L2 device information
412 * @vid_cap: camera capture device information
413 * @state: flags used to synchronize m2m and capture mode operation
418 struct platform_device *pdev;
419 struct s5p_platform_fimc *pdata;
420 struct regmap *sysreg;
421 const struct fimc_variant *variant;
422 const struct fimc_drvdata *drv_data;
424 struct clk *clock[MAX_FIMC_CLOCKS];
426 wait_queue_head_t irq_queue;
427 struct v4l2_device *v4l2_dev;
428 struct fimc_m2m_device m2m;
429 struct fimc_vid_cap vid_cap;
434 * struct fimc_ctrls - v4l2 controls structure
435 * @handler: the control handler
436 * @colorfx: image effect control
437 * @colorfx_cbcr: Cb/Cr coefficients control
438 * @rotate: image rotation control
439 * @hflip: horizontal flip control
440 * @vflip: vertical flip control
441 * @alpha: RGB alpha control
442 * @ready: true if @handler is initialized
445 struct v4l2_ctrl_handler handler;
447 struct v4l2_ctrl *colorfx;
448 struct v4l2_ctrl *colorfx_cbcr;
450 struct v4l2_ctrl *rotate;
451 struct v4l2_ctrl *hflip;
452 struct v4l2_ctrl *vflip;
453 struct v4l2_ctrl *alpha;
458 * struct fimc_ctx - the device context data
459 * @s_frame: source frame properties
460 * @d_frame: destination frame properties
461 * @out_order_1p: output 1-plane YCBCR order
462 * @out_order_2p: output 2-plane YCBCR order
463 * @in_order_1p: input 1-plane YCBCR order
464 * @in_order_2p: input 2-plane YCBCR order
465 * @in_path: input mode (DMA or camera)
466 * @out_path: output mode (DMA or FIFO)
467 * @scaler: image scaler properties
468 * @effect: image effect
469 * @rotation: image clockwise rotation in degrees
470 * @hflip: indicates image horizontal flip if set
471 * @vflip: indicates image vertical flip if set
472 * @flags: additional flags for image conversion
473 * @state: flags to keep track of user configuration
474 * @fimc_dev: the FIMC device this context applies to
475 * @fh: v4l2 file handle
476 * @ctrls: v4l2 controls structure
479 struct fimc_frame s_frame;
480 struct fimc_frame d_frame;
485 enum fimc_datapath in_path;
486 enum fimc_datapath out_path;
487 struct fimc_scaler scaler;
488 struct fimc_effect effect;
490 unsigned int hflip:1;
491 unsigned int vflip:1;
494 struct fimc_dev *fimc_dev;
496 struct fimc_ctrls ctrls;
499 #define fh_to_ctx(__fh) container_of(__fh, struct fimc_ctx, fh)
501 static inline void set_frame_bounds(struct fimc_frame *f, u32 width, u32 height)
504 f->o_height = height;
506 f->f_height = height;
509 static inline void set_frame_crop(struct fimc_frame *f,
510 u32 left, u32 top, u32 width, u32 height)
518 static inline u32 fimc_get_format_depth(struct fimc_fmt *ff)
523 for (i = 0; i < ff->colplanes; i++)
524 depth += ff->depth[i];
528 static inline bool fimc_capture_active(struct fimc_dev *fimc)
533 spin_lock_irqsave(&fimc->slock, flags);
534 ret = !!(fimc->state & (1 << ST_CAPT_RUN) ||
535 fimc->state & (1 << ST_CAPT_PEND));
536 spin_unlock_irqrestore(&fimc->slock, flags);
540 static inline void fimc_ctx_state_set(u32 state, struct fimc_ctx *ctx)
544 spin_lock_irqsave(&ctx->fimc_dev->slock, flags);
546 spin_unlock_irqrestore(&ctx->fimc_dev->slock, flags);
549 static inline bool fimc_ctx_state_is_set(u32 mask, struct fimc_ctx *ctx)
554 spin_lock_irqsave(&ctx->fimc_dev->slock, flags);
555 ret = (ctx->state & mask) == mask;
556 spin_unlock_irqrestore(&ctx->fimc_dev->slock, flags);
560 static inline int tiled_fmt(struct fimc_fmt *fmt)
562 return fmt->fourcc == V4L2_PIX_FMT_NV12MT;
565 static inline bool fimc_jpeg_fourcc(u32 pixelformat)
567 return (pixelformat == V4L2_PIX_FMT_JPEG ||
568 pixelformat == V4L2_PIX_FMT_S5C_UYVY_JPG);
571 static inline bool fimc_user_defined_mbus_fmt(u32 code)
573 return (code == MEDIA_BUS_FMT_JPEG_1X8 ||
574 code == MEDIA_BUS_FMT_S5C_UYVY_JPEG_1X8);
577 /* Return the alpha component bit mask */
578 static inline int fimc_get_alpha_mask(struct fimc_fmt *fmt)
580 switch (fmt->color) {
581 case FIMC_FMT_RGB444: return 0x0f;
582 case FIMC_FMT_RGB555: return 0x01;
583 case FIMC_FMT_RGB888: return 0xff;
588 static inline struct fimc_frame *ctx_get_frame(struct fimc_ctx *ctx,
589 enum v4l2_buf_type type)
591 struct fimc_frame *frame;
593 if (type == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE ||
594 type == V4L2_BUF_TYPE_VIDEO_OUTPUT) {
595 if (fimc_ctx_state_is_set(FIMC_CTX_M2M, ctx))
596 frame = &ctx->s_frame;
598 return ERR_PTR(-EINVAL);
599 } else if (type == V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE ||
600 type == V4L2_BUF_TYPE_VIDEO_CAPTURE) {
601 frame = &ctx->d_frame;
603 v4l2_err(ctx->fimc_dev->v4l2_dev,
604 "Wrong buffer/video queue type (%d)\n", type);
605 return ERR_PTR(-EINVAL);
611 /* -----------------------------------------------------*/
613 int fimc_vidioc_enum_fmt_mplane(struct file *file, void *priv,
614 struct v4l2_fmtdesc *f);
615 int fimc_ctrls_create(struct fimc_ctx *ctx);
616 void fimc_ctrls_delete(struct fimc_ctx *ctx);
617 void fimc_ctrls_activate(struct fimc_ctx *ctx, bool active);
618 void fimc_alpha_ctrl_update(struct fimc_ctx *ctx);
619 void __fimc_get_format(struct fimc_frame *frame, struct v4l2_format *f);
620 void fimc_adjust_mplane_format(struct fimc_fmt *fmt, u32 width, u32 height,
621 struct v4l2_pix_format_mplane *pix);
622 struct fimc_fmt *fimc_find_format(const u32 *pixelformat, const u32 *mbus_code,
623 unsigned int mask, int index);
624 struct fimc_fmt *fimc_get_format(unsigned int index);
626 int fimc_check_scaler_ratio(struct fimc_ctx *ctx, int sw, int sh,
627 int dw, int dh, int rotation);
628 int fimc_set_scaler_info(struct fimc_ctx *ctx);
629 int fimc_prepare_config(struct fimc_ctx *ctx, u32 flags);
630 int fimc_prepare_addr(struct fimc_ctx *ctx, struct vb2_buffer *vb,
631 struct fimc_frame *frame, struct fimc_addr *addr);
632 void fimc_prepare_dma_offset(struct fimc_ctx *ctx, struct fimc_frame *f);
633 void fimc_set_yuv_order(struct fimc_ctx *ctx);
634 void fimc_capture_irq_handler(struct fimc_dev *fimc, int deq_buf);
636 int fimc_register_m2m_device(struct fimc_dev *fimc,
637 struct v4l2_device *v4l2_dev);
638 void fimc_unregister_m2m_device(struct fimc_dev *fimc);
639 int fimc_register_driver(void);
640 void fimc_unregister_driver(void);
642 #ifdef CONFIG_MFD_SYSCON
643 static inline struct regmap * fimc_get_sysreg_regmap(struct device_node *node)
645 return syscon_regmap_lookup_by_phandle(node, "samsung,sysreg");
648 #define fimc_get_sysreg_regmap(node) (NULL)
651 /* -----------------------------------------------------*/
653 void fimc_m2m_job_finish(struct fimc_ctx *ctx, int vb_state);
655 /* -----------------------------------------------------*/
657 int fimc_initialize_capture_subdev(struct fimc_dev *fimc);
658 void fimc_unregister_capture_subdev(struct fimc_dev *fimc);
659 int fimc_capture_ctrls_create(struct fimc_dev *fimc);
660 void fimc_sensor_notify(struct v4l2_subdev *sd, unsigned int notification,
662 int fimc_capture_suspend(struct fimc_dev *fimc);
663 int fimc_capture_resume(struct fimc_dev *fimc);
666 * Buffer list manipulation functions. Must be called with fimc.slock held.
670 * fimc_active_queue_add - add buffer to the capture active buffers queue
671 * @vid_cap: camera capture device information
672 * @buf: buffer to add to the active buffers list
674 static inline void fimc_active_queue_add(struct fimc_vid_cap *vid_cap,
675 struct fimc_vid_buffer *buf)
677 list_add_tail(&buf->list, &vid_cap->active_buf_q);
678 vid_cap->active_buf_cnt++;
682 * fimc_active_queue_pop - pop buffer from the capture active buffers queue
683 * @vid_cap: camera capture device information
685 * The caller must assure the active_buf_q list is not empty.
687 static inline struct fimc_vid_buffer *fimc_active_queue_pop(
688 struct fimc_vid_cap *vid_cap)
690 struct fimc_vid_buffer *buf;
691 buf = list_entry(vid_cap->active_buf_q.next,
692 struct fimc_vid_buffer, list);
693 list_del(&buf->list);
694 vid_cap->active_buf_cnt--;
699 * fimc_pending_queue_add - add buffer to the capture pending buffers queue
700 * @vid_cap: camera capture device information
701 * @buf: buffer to add to the pending buffers list
703 static inline void fimc_pending_queue_add(struct fimc_vid_cap *vid_cap,
704 struct fimc_vid_buffer *buf)
706 list_add_tail(&buf->list, &vid_cap->pending_buf_q);
710 * fimc_pending_queue_pop - pop buffer from the capture pending buffers queue
711 * @vid_cap: camera capture device information
713 * The caller must assure the pending_buf_q list is not empty.
715 static inline struct fimc_vid_buffer *fimc_pending_queue_pop(
716 struct fimc_vid_cap *vid_cap)
718 struct fimc_vid_buffer *buf;
719 buf = list_entry(vid_cap->pending_buf_q.next,
720 struct fimc_vid_buffer, list);
721 list_del(&buf->list);
725 #endif /* FIMC_CORE_H_ */