2 * Copyright (c) 2010 Samsung Electronics
4 * Sylwester Nawrocki, <s.nawrocki@samsung.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
16 #include <linux/sched.h>
17 #include <linux/types.h>
18 #include <linux/videodev2.h>
20 #include <media/videobuf2-core.h>
21 #include <media/v4l2-device.h>
22 #include <media/v4l2-mem2mem.h>
23 #include <media/v4l2-mediabus.h>
24 #include <media/s5p_fimc.h>
26 #include "regs-fimc.h"
28 #define err(fmt, args...) \
29 printk(KERN_ERR "%s:%d: " fmt "\n", __func__, __LINE__, ##args)
32 #define dbg(fmt, args...) \
33 printk(KERN_DEBUG "%s:%d: " fmt "\n", __func__, __LINE__, ##args)
35 #define dbg(fmt, args...)
38 /* Time to wait for next frame VSYNC interrupt while stopping operation. */
39 #define FIMC_SHUTDOWN_TIMEOUT ((100*HZ)/1000)
40 #define MAX_FIMC_CLOCKS 3
41 #define MODULE_NAME "s5p-fimc"
42 #define FIMC_MAX_DEVS 4
43 #define FIMC_MAX_OUT_BUFS 4
44 #define SCALER_MAX_HRATIO 64
45 #define SCALER_MAX_VRATIO 64
46 #define DMA_MIN_SIZE 8
48 /* indices to the clocks array */
60 /* for capture node */
67 #define fimc_m2m_active(dev) test_bit(ST_OUTDMA_RUN, &(dev)->state)
68 #define fimc_m2m_pending(dev) test_bit(ST_M2M_PEND, &(dev)->state)
70 #define fimc_capture_running(dev) test_bit(ST_CAPT_RUN, &(dev)->state)
71 #define fimc_capture_pending(dev) test_bit(ST_CAPT_PEND, &(dev)->state)
73 #define fimc_capture_active(dev) \
74 (test_bit(ST_CAPT_RUN, &(dev)->state) || \
75 test_bit(ST_CAPT_PEND, &(dev)->state))
77 #define fimc_capture_streaming(dev) \
78 test_bit(ST_CAPT_STREAM, &(dev)->state)
88 S5P_FIMC_RGB565 = 0x10,
92 S5P_FIMC_YCBCR420 = 0x20,
97 S5P_FIMC_YCBCR444_LOCAL,
100 #define fimc_fmt_is_rgb(x) ((x) & 0x10)
102 /* Cb/Cr chrominance components order for 2 plane Y/CbCr 4:2:2 formats. */
103 #define S5P_FIMC_LSB_CRCB S5P_CIOCTRL_ORDER422_2P_LSB_CRCB
105 /* The embedded image effect selection */
106 #define S5P_FIMC_EFFECT_ORIGINAL S5P_CIIMGEFF_FIN_BYPASS
107 #define S5P_FIMC_EFFECT_ARBITRARY S5P_CIIMGEFF_FIN_ARBITRARY
108 #define S5P_FIMC_EFFECT_NEGATIVE S5P_CIIMGEFF_FIN_NEGATIVE
109 #define S5P_FIMC_EFFECT_ARTFREEZE S5P_CIIMGEFF_FIN_ARTFREEZE
110 #define S5P_FIMC_EFFECT_EMBOSSING S5P_CIIMGEFF_FIN_EMBOSSING
111 #define S5P_FIMC_EFFECT_SIKHOUETTE S5P_CIIMGEFF_FIN_SILHOUETTE
113 /* The hardware context state. */
114 #define FIMC_PARAMS (1 << 0)
115 #define FIMC_SRC_ADDR (1 << 1)
116 #define FIMC_DST_ADDR (1 << 2)
117 #define FIMC_SRC_FMT (1 << 3)
118 #define FIMC_DST_FMT (1 << 4)
119 #define FIMC_CTX_M2M (1 << 5)
120 #define FIMC_CTX_CAP (1 << 6)
122 /* Image conversion flags */
123 #define FIMC_IN_DMA_ACCESS_TILED (1 << 0)
124 #define FIMC_IN_DMA_ACCESS_LINEAR (0 << 0)
125 #define FIMC_OUT_DMA_ACCESS_TILED (1 << 1)
126 #define FIMC_OUT_DMA_ACCESS_LINEAR (0 << 1)
127 #define FIMC_SCAN_MODE_PROGRESSIVE (0 << 2)
128 #define FIMC_SCAN_MODE_INTERLACED (1 << 2)
130 * YCbCr data dynamic range for RGB-YUV color conversion.
131 * Y/Cb/Cr: (0 ~ 255) */
132 #define FIMC_COLOR_RANGE_WIDE (0 << 3)
133 /* Y (16 ~ 235), Cb/Cr (16 ~ 240) */
134 #define FIMC_COLOR_RANGE_NARROW (1 << 3)
137 #define FLIP_X_AXIS 1
138 #define FLIP_Y_AXIS 2
139 #define FLIP_XY_AXIS (FLIP_X_AXIS | FLIP_Y_AXIS)
142 * struct fimc_fmt - the driver's internal color format data
143 * @mbus_code: Media Bus pixel code, -1 if not applicable
144 * @name: format description
145 * @fourcc: the fourcc code for this format, 0 if not applicable
146 * @color: the corresponding fimc_color_fmt
147 * @depth: per plane driver's private 'number of bits per pixel'
148 * @memplanes: number of physically non-contiguous data planes
149 * @colplanes: number of physically contiguous data planes
152 enum v4l2_mbus_pixelcode mbus_code;
158 u8 depth[VIDEO_MAX_PLANES];
160 #define FMT_FLAGS_CAM (1 << 0)
161 #define FMT_FLAGS_M2M (1 << 1)
165 * struct fimc_dma_offset - pixel offset information for DMA
166 * @y_h: y value horizontal offset
167 * @y_v: y value vertical offset
168 * @cb_h: cb value horizontal offset
169 * @cb_v: cb value vertical offset
170 * @cr_h: cr value horizontal offset
171 * @cr_v: cr value vertical offset
173 struct fimc_dma_offset {
183 * struct fimc_effect - the configuration data for the "Arbitrary" image effect
185 * @pat_cb: cr value when type is "arbitrary"
186 * @pat_cr: cr value when type is "arbitrary"
195 * struct fimc_scaler - the configuration data for FIMC inetrnal scaler
197 * @scaleup_h: flag indicating scaling up horizontally
198 * @scaleup_v: flag indicating scaling up vertically
199 * @copy_mode: flag indicating transparent DMA transfer (no scaling
200 * and color format conversion)
201 * @enabled: flag indicating if the scaler is used
202 * @hfactor: horizontal shift factor
203 * @vfactor: vertical shift factor
204 * @pre_hratio: horizontal ratio of the prescaler
205 * @pre_vratio: vertical ratio of the prescaler
206 * @pre_dst_width: the prescaler's destination width
207 * @pre_dst_height: the prescaler's destination height
208 * @main_hratio: the main scaler's horizontal ratio
209 * @main_vratio: the main scaler's vertical ratio
210 * @real_width: source pixel (width - offset)
211 * @real_height: source pixel (height - offset)
214 unsigned int scaleup_h:1;
215 unsigned int scaleup_v:1;
216 unsigned int copy_mode:1;
217 unsigned int enabled:1;
231 * struct fimc_addr - the FIMC physical address set for DMA
233 * @y: luminance plane physical address
234 * @cb: Cb plane physical address
235 * @cr: Cr plane physical address
244 * struct fimc_vid_buffer - the driver's video buffer
245 * @vb: v4l videobuf buffer
246 * @paddr: precalculated physical address set
247 * @index: buffer index for the output DMA engine
249 struct fimc_vid_buffer {
250 struct vb2_buffer vb;
251 struct list_head list;
252 struct fimc_addr paddr;
257 * struct fimc_frame - source/target frame properties
258 * @f_width: image full width (virtual screen size)
259 * @f_height: image full height (virtual screen size)
260 * @o_width: original image width as set by S_FMT
261 * @o_height: original image height as set by S_FMT
262 * @offs_h: image horizontal pixel offset
263 * @offs_v: image vertical pixel offset
264 * @width: image pixel width
265 * @height: image pixel weight
266 * @paddr: image frame buffer physical addresses
267 * @buf_cnt: number of buffers depending on a color format
268 * @payload: image size in bytes (w x h x bpp)
269 * @color: color format
270 * @dma_offset: DMA offset in bytes
281 unsigned long payload[VIDEO_MAX_PLANES];
282 struct fimc_addr paddr;
283 struct fimc_dma_offset dma_offset;
284 struct fimc_fmt *fmt;
288 * struct fimc_m2m_device - v4l2 memory-to-memory device data
289 * @vfd: the video device node for v4l2 m2m mode
290 * @v4l2_dev: v4l2 device for m2m mode
291 * @m2m_dev: v4l2 memory-to-memory device data
292 * @ctx: hardware context data
293 * @refcnt: the reference counter
295 struct fimc_m2m_device {
296 struct video_device *vfd;
297 struct v4l2_device v4l2_dev;
298 struct v4l2_m2m_dev *m2m_dev;
299 struct fimc_ctx *ctx;
304 * struct fimc_vid_cap - camera capture device information
305 * @ctx: hardware context data
306 * @vfd: video device node for camera capture mode
307 * @v4l2_dev: v4l2_device struct to manage subdevs
308 * @sd: pointer to camera sensor subdevice currently in use
309 * @fmt: Media Bus format configured at selected image sensor
310 * @pending_buf_q: the pending buffer queue head
311 * @active_buf_q: the queue head of buffers scheduled in hardware
312 * @vbq: the capture am video buffer queue
313 * @active_buf_cnt: number of video buffers scheduled in hardware
314 * @buf_index: index for managing the output DMA buffers
315 * @frame_count: the frame counter for statistics
316 * @reqbufs_count: the number of buffers requested in REQBUFS ioctl
317 * @input_index: input (camera sensor) index
318 * @refcnt: driver's private reference counter
320 struct fimc_vid_cap {
321 struct fimc_ctx *ctx;
322 struct vb2_alloc_ctx *alloc_ctx;
323 struct video_device *vfd;
324 struct v4l2_device v4l2_dev;
325 struct v4l2_subdev *sd;;
326 struct v4l2_mbus_framefmt fmt;
327 struct list_head pending_buf_q;
328 struct list_head active_buf_q;
329 struct vb2_queue vbq;
332 unsigned int frame_count;
333 unsigned int reqbufs_count;
339 * struct fimc_pix_limit - image pixel size limits in various IP configurations
341 * @scaler_en_w: max input pixel width when the scaler is enabled
342 * @scaler_dis_w: max input pixel width when the scaler is disabled
343 * @in_rot_en_h: max input width with the input rotator is on
344 * @in_rot_dis_w: max input width with the input rotator is off
345 * @out_rot_en_w: max output width with the output rotator on
346 * @out_rot_dis_w: max output width with the output rotator off
348 struct fimc_pix_limit {
358 * struct samsung_fimc_variant - camera interface variant information
360 * @pix_hoff: indicate whether horizontal offset is in pixels or in bytes
361 * @has_inp_rot: set if has input rotator
362 * @has_out_rot: set if has output rotator
363 * @has_cistatus2: 1 if CISTATUS2 register is present in this IP revision
364 * @pix_limit: pixel size constraints for the scaler
365 * @min_inp_pixsize: minimum input pixel size
366 * @min_out_pixsize: minimum output pixel size
367 * @hor_offs_align: horizontal pixel offset aligment
368 * @out_buf_count: the number of buffers in output DMA sequence
370 struct samsung_fimc_variant {
371 unsigned int pix_hoff:1;
372 unsigned int has_inp_rot:1;
373 unsigned int has_out_rot:1;
374 unsigned int has_cistatus2:1;
375 struct fimc_pix_limit *pix_limit;
383 * struct samsung_fimc_driverdata - per device type driver data for init time.
385 * @variant: the variant information for this driver.
386 * @dev_cnt: number of fimc sub-devices available in SoC
387 * @lclk_frequency: fimc bus clock frequency
389 struct samsung_fimc_driverdata {
390 struct samsung_fimc_variant *variant[FIMC_MAX_DEVS];
391 unsigned long lclk_frequency;
398 * struct fimc_dev - abstraction for FIMC entity
400 * @slock: the spinlock protecting this data structure
401 * @lock: the mutex protecting this data structure
402 * @pdev: pointer to the FIMC platform device
403 * @pdata: pointer to the device platform data
404 * @id: FIMC device index (0..FIMC_MAX_DEVS)
405 * @num_clocks: the number of clocks managed by this device instance
406 * @clock[]: the clocks required for FIMC operation
407 * @regs: the mapped hardware registers
408 * @regs_res: the resource claimed for IO registers
409 * @irq: interrupt number of the FIMC subdevice
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 samsung_fimc_variant *variant;
423 struct clk *clock[MAX_FIMC_CLOCKS];
425 struct resource *regs_res;
427 wait_queue_head_t irq_queue;
428 struct fimc_m2m_device m2m;
429 struct fimc_vid_cap vid_cap;
431 struct vb2_alloc_ctx *alloc_ctx;
435 * fimc_ctx - the device context data
437 * @lock: mutex protecting this data structure
438 * @s_frame: source frame properties
439 * @d_frame: destination frame properties
440 * @out_order_1p: output 1-plane YCBCR order
441 * @out_order_2p: output 2-plane YCBCR order
442 * @in_order_1p input 1-plane YCBCR order
443 * @in_order_2p: input 2-plane YCBCR order
444 * @in_path: input mode (DMA or camera)
445 * @out_path: output mode (DMA or FIFO)
446 * @scaler: image scaler properties
447 * @effect: image effect
448 * @rotation: image clockwise rotation in degrees
449 * @flip: image flip mode
450 * @flags: additional flags for image conversion
451 * @state: flags to keep track of user configuration
452 * @fimc_dev: the FIMC device this context applies to
453 * @m2m_ctx: memory-to-memory device context
457 struct fimc_frame s_frame;
458 struct fimc_frame d_frame;
463 enum fimc_datapath in_path;
464 enum fimc_datapath out_path;
465 struct fimc_scaler scaler;
466 struct fimc_effect effect;
471 struct fimc_dev *fimc_dev;
472 struct v4l2_m2m_ctx *m2m_ctx;
475 static inline int tiled_fmt(struct fimc_fmt *fmt)
477 return fmt->fourcc == V4L2_PIX_FMT_NV12MT;
480 static inline void fimc_hw_clear_irq(struct fimc_dev *dev)
482 u32 cfg = readl(dev->regs + S5P_CIGCTRL);
483 cfg |= S5P_CIGCTRL_IRQ_CLR;
484 writel(cfg, dev->regs + S5P_CIGCTRL);
487 static inline void fimc_hw_enable_scaler(struct fimc_dev *dev, bool on)
489 u32 cfg = readl(dev->regs + S5P_CISCCTRL);
491 cfg |= S5P_CISCCTRL_SCALERSTART;
493 cfg &= ~S5P_CISCCTRL_SCALERSTART;
494 writel(cfg, dev->regs + S5P_CISCCTRL);
497 static inline void fimc_hw_activate_input_dma(struct fimc_dev *dev, bool on)
499 u32 cfg = readl(dev->regs + S5P_MSCTRL);
501 cfg |= S5P_MSCTRL_ENVID;
503 cfg &= ~S5P_MSCTRL_ENVID;
504 writel(cfg, dev->regs + S5P_MSCTRL);
507 static inline void fimc_hw_dis_capture(struct fimc_dev *dev)
509 u32 cfg = readl(dev->regs + S5P_CIIMGCPT);
510 cfg &= ~(S5P_CIIMGCPT_IMGCPTEN | S5P_CIIMGCPT_IMGCPTEN_SC);
511 writel(cfg, dev->regs + S5P_CIIMGCPT);
515 * fimc_hw_set_dma_seq - configure output DMA buffer sequence
516 * @mask: each bit corresponds to one of 32 output buffer registers set
517 * 1 to include buffer in the sequence, 0 to disable
519 * This function mask output DMA ring buffers, i.e. it allows to configure
520 * which of the output buffer address registers will be used by the DMA
523 static inline void fimc_hw_set_dma_seq(struct fimc_dev *dev, u32 mask)
525 writel(mask, dev->regs + S5P_CIFCNTSEQ);
528 static inline struct fimc_frame *ctx_get_frame(struct fimc_ctx *ctx,
529 enum v4l2_buf_type type)
531 struct fimc_frame *frame;
533 if (V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE == type) {
534 if (ctx->state & FIMC_CTX_M2M)
535 frame = &ctx->s_frame;
537 return ERR_PTR(-EINVAL);
538 } else if (V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE == type) {
539 frame = &ctx->d_frame;
541 v4l2_err(&ctx->fimc_dev->m2m.v4l2_dev,
542 "Wrong buffer/video queue type (%d)\n", type);
543 return ERR_PTR(-EINVAL);
549 /* Return an index to the buffer actually being written. */
550 static inline u32 fimc_hw_get_frame_index(struct fimc_dev *dev)
554 if (dev->variant->has_cistatus2) {
555 reg = readl(dev->regs + S5P_CISTATUS2) & 0x3F;
556 return reg > 0 ? --reg : reg;
558 reg = readl(dev->regs + S5P_CISTATUS);
559 return (reg & S5P_CISTATUS_FRAMECNT_MASK) >>
560 S5P_CISTATUS_FRAMECNT_SHIFT;
564 /* -----------------------------------------------------*/
566 void fimc_hw_reset(struct fimc_dev *fimc);
567 void fimc_hw_set_rotation(struct fimc_ctx *ctx);
568 void fimc_hw_set_target_format(struct fimc_ctx *ctx);
569 void fimc_hw_set_out_dma(struct fimc_ctx *ctx);
570 void fimc_hw_en_lastirq(struct fimc_dev *fimc, int enable);
571 void fimc_hw_en_irq(struct fimc_dev *fimc, int enable);
572 void fimc_hw_set_scaler(struct fimc_ctx *ctx);
573 void fimc_hw_en_capture(struct fimc_ctx *ctx);
574 void fimc_hw_set_effect(struct fimc_ctx *ctx);
575 void fimc_hw_set_in_dma(struct fimc_ctx *ctx);
576 void fimc_hw_set_input_path(struct fimc_ctx *ctx);
577 void fimc_hw_set_output_path(struct fimc_ctx *ctx);
578 void fimc_hw_set_input_addr(struct fimc_dev *fimc, struct fimc_addr *paddr);
579 void fimc_hw_set_output_addr(struct fimc_dev *fimc, struct fimc_addr *paddr,
581 int fimc_hw_set_camera_source(struct fimc_dev *fimc,
582 struct s5p_fimc_isp_info *cam);
583 int fimc_hw_set_camera_offset(struct fimc_dev *fimc, struct fimc_frame *f);
584 int fimc_hw_set_camera_polarity(struct fimc_dev *fimc,
585 struct s5p_fimc_isp_info *cam);
586 int fimc_hw_set_camera_type(struct fimc_dev *fimc,
587 struct s5p_fimc_isp_info *cam);
589 /* -----------------------------------------------------*/
591 int fimc_vidioc_enum_fmt_mplane(struct file *file, void *priv,
592 struct v4l2_fmtdesc *f);
593 int fimc_vidioc_g_fmt_mplane(struct file *file, void *priv,
594 struct v4l2_format *f);
595 int fimc_vidioc_try_fmt_mplane(struct file *file, void *priv,
596 struct v4l2_format *f);
597 int fimc_vidioc_queryctrl(struct file *file, void *priv,
598 struct v4l2_queryctrl *qc);
599 int fimc_vidioc_g_ctrl(struct file *file, void *priv,
600 struct v4l2_control *ctrl);
602 int fimc_try_crop(struct fimc_ctx *ctx, struct v4l2_crop *cr);
603 int check_ctrl_val(struct fimc_ctx *ctx, struct v4l2_control *ctrl);
604 int fimc_s_ctrl(struct fimc_ctx *ctx, struct v4l2_control *ctrl);
606 struct fimc_fmt *find_format(struct v4l2_format *f, unsigned int mask);
607 struct fimc_fmt *find_mbus_format(struct v4l2_mbus_framefmt *f,
610 int fimc_check_scaler_ratio(struct v4l2_rect *r, struct fimc_frame *f);
611 int fimc_set_scaler_info(struct fimc_ctx *ctx);
612 int fimc_prepare_config(struct fimc_ctx *ctx, u32 flags);
613 int fimc_prepare_addr(struct fimc_ctx *ctx, struct vb2_buffer *vb,
614 struct fimc_frame *frame, struct fimc_addr *paddr);
616 /* -----------------------------------------------------*/
618 int fimc_register_capture_device(struct fimc_dev *fimc);
619 void fimc_unregister_capture_device(struct fimc_dev *fimc);
620 int fimc_sensor_sd_init(struct fimc_dev *fimc, int index);
621 int fimc_vid_cap_buf_queue(struct fimc_dev *fimc,
622 struct fimc_vid_buffer *fimc_vb);
624 /* Locking: the caller holds fimc->slock */
625 static inline void fimc_activate_capture(struct fimc_ctx *ctx)
627 fimc_hw_enable_scaler(ctx->fimc_dev, ctx->scaler.enabled);
628 fimc_hw_en_capture(ctx);
631 static inline void fimc_deactivate_capture(struct fimc_dev *fimc)
633 fimc_hw_en_lastirq(fimc, true);
634 fimc_hw_dis_capture(fimc);
635 fimc_hw_enable_scaler(fimc, false);
636 fimc_hw_en_lastirq(fimc, false);
640 * Add buf to the capture active buffers queue.
641 * Locking: Need to be called with fimc_dev::slock held.
643 static inline void active_queue_add(struct fimc_vid_cap *vid_cap,
644 struct fimc_vid_buffer *buf)
646 list_add_tail(&buf->list, &vid_cap->active_buf_q);
647 vid_cap->active_buf_cnt++;
651 * Pop a video buffer from the capture active buffers queue
652 * Locking: Need to be called with fimc_dev::slock held.
654 static inline struct fimc_vid_buffer *
655 active_queue_pop(struct fimc_vid_cap *vid_cap)
657 struct fimc_vid_buffer *buf;
658 buf = list_entry(vid_cap->active_buf_q.next,
659 struct fimc_vid_buffer, list);
660 list_del(&buf->list);
661 vid_cap->active_buf_cnt--;
665 /* Add video buffer to the capture pending buffers queue */
666 static inline void fimc_pending_queue_add(struct fimc_vid_cap *vid_cap,
667 struct fimc_vid_buffer *buf)
669 list_add_tail(&buf->list, &vid_cap->pending_buf_q);
672 /* Add video buffer to the capture pending buffers queue */
673 static inline struct fimc_vid_buffer *
674 pending_queue_pop(struct fimc_vid_cap *vid_cap)
676 struct fimc_vid_buffer *buf;
677 buf = list_entry(vid_cap->pending_buf_q.next,
678 struct fimc_vid_buffer, list);
679 list_del(&buf->list);
683 #endif /* FIMC_CORE_H_ */