[deliverable/linux.git] / drivers / media / platform / exynos4-is / fimc-lite.h

/*
 * Copyright (C) 2012 Samsung Electronics Co., Ltd.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#ifndef FIMC_LITE_H_
#define FIMC_LITE_H_

#include <linux/sizes.h>
#include <linux/io.h>
#include <linux/irqreturn.h>
#include <linux/platform_device.h>
#include <linux/sched.h>
#include <linux/spinlock.h>
#include <linux/types.h>
#include <linux/videodev2.h>

#include <media/media-entity.h>
#include <media/videobuf2-v4l2.h>
#include <media/v4l2-ctrls.h>
#include <media/v4l2-device.h>
#include <media/v4l2-mediabus.h>
#include <media/drv-intf/exynos-fimc.h>

#define FIMC_LITE_DRV_NAME	"exynos-fimc-lite"
#define FLITE_CLK_NAME		"flite"
#define FIMC_LITE_MAX_DEVS	3
#define FLITE_REQ_BUFS_MIN	2
#define FLITE_DEFAULT_WIDTH	640
#define FLITE_DEFAULT_HEIGHT	480

/* Bit index definitions for struct fimc_lite::state */
enum {
	ST_FLITE_LPM,
	ST_FLITE_PENDING,
	ST_FLITE_RUN,
	ST_FLITE_STREAM,
	ST_FLITE_SUSPENDED,
	ST_FLITE_OFF,
	ST_FLITE_IN_USE,
	ST_FLITE_CONFIG,
	ST_SENSOR_STREAM,
};

#define FLITE_SD_PAD_SINK	0
#define FLITE_SD_PAD_SOURCE_DMA	1
#define FLITE_SD_PAD_SOURCE_ISP	2
#define FLITE_SD_PADS_NUM	3

/**
 * struct flite_drvdata - FIMC-LITE IP variant data structure
 * @max_width: maximum camera interface input width in pixels
 * @max_height: maximum camera interface input height in pixels
 * @out_width_align: minimum output width alignment in pixels
 * @win_hor_offs_align: minimum camera interface crop window horizontal
 * 			offset alignment in pixels
 * @out_hor_offs_align: minimum output DMA compose rectangle horizontal
 * 			offset alignment in pixels
 * @max_dma_bufs: number of output DMA buffer start address registers
 * @num_instances: total number of FIMC-LITE IP instances available
 */
struct flite_drvdata {
	unsigned short max_width;
	unsigned short max_height;
	unsigned short out_width_align;
	unsigned short win_hor_offs_align;
	unsigned short out_hor_offs_align;
	unsigned short max_dma_bufs;
	unsigned short num_instances;
};

struct fimc_lite_events {
	unsigned int data_overflow;
};

#define FLITE_MAX_PLANES	1

/**
 * struct flite_frame - source/target frame properties
 * @f_width: full pixel width
 * @f_height: full pixel height
 * @rect: crop/composition rectangle
 * @fmt: pointer to pixel format description data structure
 */
struct flite_frame {
	u16 f_width;
	u16 f_height;
	struct v4l2_rect rect;
	const struct fimc_fmt *fmt;
};

/**
 * struct flite_buffer - video buffer structure
 * @vb:    vb2 buffer
 * @list:  list head for the buffers queue
 * @paddr: DMA buffer start address
 * @index: DMA start address register's index
 */
struct flite_buffer {
	struct vb2_v4l2_buffer vb;
	struct list_head list;
	dma_addr_t paddr;
	unsigned short index;
};

/**
 * struct fimc_lite - fimc lite structure
 * @pdev: pointer to FIMC-LITE platform device
 * @dd: SoC specific driver data structure
 * @ve: exynos video device entity structure
 * @v4l2_dev: pointer to top the level v4l2_device
 * @fh: v4l2 file handle
 * @subdev: FIMC-LITE subdev
 * @vd_pad: media (sink) pad for the capture video node
 * @subdev_pads: the subdev media pads
 * @sensor: sensor subdev attached to FIMC-LITE directly or through MIPI-CSIS
 * @ctrl_handler: v4l2 control handler
 * @test_pattern: test pattern controls
 * @index: FIMC-LITE platform device index
 * @pipeline: video capture pipeline data structure
 * @pipeline_ops: media pipeline ops for the video node driver
 * @slock: spinlock protecting this data structure and the hw registers
 * @lock: mutex serializing video device and the subdev operations
 * @clock: FIMC-LITE gate clock
 * @regs: memory mapped io registers
 * @irq_queue: interrupt handler waitqueue
 * @payload: image size in bytes (w x h x bpp)
 * @inp_frame: camera input frame structure
 * @out_frame: DMA output frame structure
 * @out_path: output data path (DMA or FIFO)
 * @source_subdev_grp_id: source subdev group id
 * @state: driver state flags
 * @pending_buf_q: pending buffers queue head
 * @active_buf_q: the queue head of buffers scheduled in hardware
 * @vb_queue: vb2 buffers queue
 * @buf_index: helps to keep track of the DMA start address register index
 * @active_buf_count: number of video buffers scheduled in hardware
 * @frame_count: the captured frames counter
 * @reqbufs_count: the number of buffers requested with REQBUFS ioctl
 */
struct fimc_lite {
	struct platform_device	*pdev;
	struct flite_drvdata	*dd;
	struct exynos_video_entity ve;
	struct v4l2_device	*v4l2_dev;
	struct v4l2_fh		fh;
	struct v4l2_subdev	subdev;
	struct media_pad	vd_pad;
	struct media_pad	subdev_pads[FLITE_SD_PADS_NUM];
	struct v4l2_subdev	*sensor;
	struct v4l2_ctrl_handler ctrl_handler;
	struct v4l2_ctrl	*test_pattern;
	int			index;

	struct mutex		lock;
	spinlock_t		slock;

	struct clk		*clock;
	void __iomem		*regs;
	wait_queue_head_t	irq_queue;

	unsigned long		payload[FLITE_MAX_PLANES];
	struct flite_frame	inp_frame;
	struct flite_frame	out_frame;
	atomic_t		out_path;
	unsigned int		source_subdev_grp_id;

	unsigned long		state;
	struct list_head	pending_buf_q;
	struct list_head	active_buf_q;
	struct vb2_queue	vb_queue;
	unsigned short		buf_index;
	unsigned int		frame_count;
	unsigned int		reqbufs_count;

	struct fimc_lite_events	events;
	bool			streaming;
};

static inline bool fimc_lite_active(struct fimc_lite *fimc)
{
	unsigned long flags;
	bool ret;

	spin_lock_irqsave(&fimc->slock, flags);
	ret = fimc->state & (1 << ST_FLITE_RUN) ||
		fimc->state & (1 << ST_FLITE_PENDING);
	spin_unlock_irqrestore(&fimc->slock, flags);
	return ret;
}

static inline void fimc_lite_active_queue_add(struct fimc_lite *dev,
					 struct flite_buffer *buf)
{
	list_add_tail(&buf->list, &dev->active_buf_q);
}

static inline struct flite_buffer *fimc_lite_active_queue_pop(
					struct fimc_lite *dev)
{
	struct flite_buffer *buf = list_entry(dev->active_buf_q.next,
					      struct flite_buffer, list);
	list_del(&buf->list);
	return buf;
}

static inline void fimc_lite_pending_queue_add(struct fimc_lite *dev,
					struct flite_buffer *buf)
{
	list_add_tail(&buf->list, &dev->pending_buf_q);
}

static inline struct flite_buffer *fimc_lite_pending_queue_pop(
					struct fimc_lite *dev)
{
	struct flite_buffer *buf = list_entry(dev->pending_buf_q.next,
					      struct flite_buffer, list);
	list_del(&buf->list);
	return buf;
}

#endif /* FIMC_LITE_H_ */
Commit	Line	Data
2b511edb SN	1	/*
	2	* Copyright (C) 2012 Samsung Electronics Co., Ltd.
	3	*
	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License version 2 as
	6	* published by the Free Software Foundation.
	7	*/
	8
	9	#ifndef FIMC_LITE_H_
	10	#define FIMC_LITE_H_
	11
25422781	12	#include <linux/sizes.h>
2b511edb SN	13	#include <linux/io.h>
	14	#include <linux/irqreturn.h>
	15	#include <linux/platform_device.h>
	16	#include <linux/sched.h>
	17	#include <linux/spinlock.h>
	18	#include <linux/types.h>
	19	#include <linux/videodev2.h>
	20
	21	#include <media/media-entity.h>
c139990e	22	#include <media/videobuf2-v4l2.h>
80f958f4	23	#include <media/v4l2-ctrls.h>
2b511edb SN	24	#include <media/v4l2-device.h>
2b511edb SN	25	#include <media/v4l2-mediabus.h>
d647f0b7	26	#include <media/drv-intf/exynos-fimc.h>
2b511edb	27
2b511edb SN	28	#define FIMC_LITE_DRV_NAME "exynos-fimc-lite"
2b511edb SN	29	#define FLITE_CLK_NAME "flite"
086eca29	30	#define FIMC_LITE_MAX_DEVS 3
2b511edb	31	#define FLITE_REQ_BUFS_MIN 2
a055d970 SN	32	#define FLITE_DEFAULT_WIDTH 640
a055d970 SN	33	#define FLITE_DEFAULT_HEIGHT 480
2b511edb SN	34
	35	/* Bit index definitions for struct fimc_lite::state */
	36	enum {
	37	ST_FLITE_LPM,
	38	ST_FLITE_PENDING,
	39	ST_FLITE_RUN,
	40	ST_FLITE_STREAM,
	41	ST_FLITE_SUSPENDED,
	42	ST_FLITE_OFF,
	43	ST_FLITE_IN_USE,
	44	ST_FLITE_CONFIG,
	45	ST_SENSOR_STREAM,
	46	};
	47
	48	#define FLITE_SD_PAD_SINK 0
6319d6a0 SN	49	#define FLITE_SD_PAD_SOURCE_DMA 1
	50	#define FLITE_SD_PAD_SOURCE_ISP 2
	51	#define FLITE_SD_PADS_NUM 3
2b511edb	52
086eca29 SN	53	/**
	54	* struct flite_drvdata - FIMC-LITE IP variant data structure
	55	* @max_width: maximum camera interface input width in pixels
	56	* @max_height: maximum camera interface input height in pixels
	57	* @out_width_align: minimum output width alignment in pixels
	58	* @win_hor_offs_align: minimum camera interface crop window horizontal
	59	* offset alignment in pixels
	60	* @out_hor_offs_align: minimum output DMA compose rectangle horizontal
	61	* offset alignment in pixels
	62	* @max_dma_bufs: number of output DMA buffer start address registers
	63	* @num_instances: total number of FIMC-LITE IP instances available
	64	*/
9c8399c8	65	struct flite_drvdata {
2b511edb SN	66	unsigned short max_width;
	67	unsigned short max_height;
	68	unsigned short out_width_align;
	69	unsigned short win_hor_offs_align;
	70	unsigned short out_hor_offs_align;
086eca29 SN	71	unsigned short max_dma_bufs;
086eca29 SN	72	unsigned short num_instances;
2b511edb SN	73	};
2b511edb SN	74
2b511edb SN	75	struct fimc_lite_events {
	76	unsigned int data_overflow;
	77	};
	78
	79	#define FLITE_MAX_PLANES 1
	80
	81	/**
	82	* struct flite_frame - source/target frame properties
	83	* @f_width: full pixel width
	84	* @f_height: full pixel height
	85	* @rect: crop/composition rectangle
e90ad659	86	* @fmt: pointer to pixel format description data structure
2b511edb SN	87	*/
	88	struct flite_frame {
	89	u16 f_width;
	90	u16 f_height;
	91	struct v4l2_rect rect;
e90ad659	92	const struct fimc_fmt *fmt;
2b511edb SN	93	};
	94
	95	/**
	96	* struct flite_buffer - video buffer structure
	97	* @vb: vb2 buffer
	98	* @list: list head for the buffers queue
086eca29 SN	99	* @paddr: DMA buffer start address
086eca29 SN	100	* @index: DMA start address register's index
2b511edb SN	101	*/
2b511edb SN	102	struct flite_buffer {
2d700715	103	struct vb2_v4l2_buffer vb;
2b511edb SN	104	struct list_head list;
2b511edb SN	105	dma_addr_t paddr;
086eca29	106	unsigned short index;
2b511edb SN	107	};
	108
	109	/**
	110	* struct fimc_lite - fimc lite structure
	111	* @pdev: pointer to FIMC-LITE platform device
9c8399c8	112	* @dd: SoC specific driver data structure
bc7584b0	113	* @ve: exynos video device entity structure
2b511edb	114	* @v4l2_dev: pointer to top the level v4l2_device
2b511edb	115	* @fh: v4l2 file handle
2b511edb SN	116	* @subdev: FIMC-LITE subdev
	117	* @vd_pad: media (sink) pad for the capture video node
	118	* @subdev_pads: the subdev media pads
6319d6a0	119	* @sensor: sensor subdev attached to FIMC-LITE directly or through MIPI-CSIS
2b511edb SN	120	* @ctrl_handler: v4l2 control handler
	121	* @test_pattern: test pattern controls
	122	* @index: FIMC-LITE platform device index
	123	* @pipeline: video capture pipeline data structure
b9ee31e6	124	* @pipeline_ops: media pipeline ops for the video node driver
2b511edb SN	125	* @slock: spinlock protecting this data structure and the hw registers
	126	* @lock: mutex serializing video device and the subdev operations
	127	* @clock: FIMC-LITE gate clock
	128	* @regs: memory mapped io registers
	129	* @irq_queue: interrupt handler waitqueue
2b511edb SN	130	* @payload: image size in bytes (w x h x bpp)
	131	* @inp_frame: camera input frame structure
	132	* @out_frame: DMA output frame structure
	133	* @out_path: output data path (DMA or FIFO)
	134	* @source_subdev_grp_id: source subdev group id
	135	* @state: driver state flags
	136	* @pending_buf_q: pending buffers queue head
	137	* @active_buf_q: the queue head of buffers scheduled in hardware
	138	* @vb_queue: vb2 buffers queue
086eca29	139	* @buf_index: helps to keep track of the DMA start address register index
2b511edb SN	140	* @active_buf_count: number of video buffers scheduled in hardware
	141	* @frame_count: the captured frames counter
	142	* @reqbufs_count: the number of buffers requested with REQBUFS ioctl
2b511edb SN	143	*/
	144	struct fimc_lite {
	145	struct platform_device *pdev;
9c8399c8	146	struct flite_drvdata *dd;
bc7584b0	147	struct exynos_video_entity ve;
2b511edb	148	struct v4l2_device *v4l2_dev;
2b511edb	149	struct v4l2_fh fh;
2b511edb SN	150	struct v4l2_subdev subdev;
	151	struct media_pad vd_pad;
	152	struct media_pad subdev_pads[FLITE_SD_PADS_NUM];
6319d6a0	153	struct v4l2_subdev *sensor;
2b511edb SN	154	struct v4l2_ctrl_handler ctrl_handler;
2b511edb SN	155	struct v4l2_ctrl *test_pattern;
068b16b6	156	int index;
2b511edb SN	157
	158	struct mutex lock;
	159	spinlock_t slock;
	160
	161	struct clk *clock;
	162	void __iomem *regs;
	163	wait_queue_head_t irq_queue;
	164
2b511edb SN	165	unsigned long payload[FLITE_MAX_PLANES];
	166	struct flite_frame inp_frame;
	167	struct flite_frame out_frame;
03878bb4	168	atomic_t out_path;
2b511edb SN	169	unsigned int source_subdev_grp_id;
	170
	171	unsigned long state;
	172	struct list_head pending_buf_q;
	173	struct list_head active_buf_q;
	174	struct vb2_queue vb_queue;
086eca29	175	unsigned short buf_index;
2b511edb SN	176	unsigned int frame_count;
2b511edb SN	177	unsigned int reqbufs_count;
2b511edb SN	178
2b511edb SN	179	struct fimc_lite_events events;
9ea89e2b	180	bool streaming;
2b511edb SN	181	};
	182
	183	static inline bool fimc_lite_active(struct fimc_lite *fimc)
	184	{
	185	unsigned long flags;
	186	bool ret;
	187
	188	spin_lock_irqsave(&fimc->slock, flags);
	189	ret = fimc->state & (1 << ST_FLITE_RUN) \|\|
	190	fimc->state & (1 << ST_FLITE_PENDING);
	191	spin_unlock_irqrestore(&fimc->slock, flags);
	192	return ret;
	193	}
	194
	195	static inline void fimc_lite_active_queue_add(struct fimc_lite *dev,
	196	struct flite_buffer *buf)
	197	{
	198	list_add_tail(&buf->list, &dev->active_buf_q);
	199	}
	200
	201	static inline struct flite_buffer *fimc_lite_active_queue_pop(
	202	struct fimc_lite *dev)
	203	{
	204	struct flite_buffer *buf = list_entry(dev->active_buf_q.next,
	205	struct flite_buffer, list);
	206	list_del(&buf->list);
	207	return buf;
	208	}
	209
	210	static inline void fimc_lite_pending_queue_add(struct fimc_lite *dev,
	211	struct flite_buffer *buf)
	212	{
	213	list_add_tail(&buf->list, &dev->pending_buf_q);
	214	}
	215
	216	static inline struct flite_buffer *fimc_lite_pending_queue_pop(
	217	struct fimc_lite *dev)
	218	{
	219	struct flite_buffer *buf = list_entry(dev->pending_buf_q.next,
	220	struct flite_buffer, list);
	221	list_del(&buf->list);
	222	return buf;
	223	}
	224
	225	#endif /* FIMC_LITE_H_ */