[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-core.h>
#include <media/v4l2-ctrls.h>
#include <media/v4l2-device.h>
#include <media/v4l2-mediabus.h>
#include <media/s5p_fimc.h>

#define FIMC_LITE_DRV_NAME	"exynos-fimc-lite"
#define FLITE_CLK_NAME		"flite"
#define FIMC_LITE_MAX_DEVS	2
#define FLITE_REQ_BUFS_MIN	2

/* 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_variant {
	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;
};

struct flite_drvdata {
	struct flite_variant *variant[FIMC_LITE_MAX_DEVS];
};

#define fimc_lite_get_drvdata(_pdev) \
	((struct flite_drvdata *) platform_get_device_id(_pdev)->driver_data)

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
 */
struct flite_frame {
	u16 f_width;
	u16 f_height;
	struct v4l2_rect rect;
};

/**
 * struct flite_buffer - video buffer structure
 * @vb:    vb2 buffer
 * @list:  list head for the buffers queue
 * @paddr: precalculated physical address
 */
struct flite_buffer {
	struct vb2_buffer vb;
	struct list_head list;
	dma_addr_t paddr;
};

/**
 * struct fimc_lite - fimc lite structure
 * @pdev: pointer to FIMC-LITE platform device
 * @variant: variant information for this IP
 * @v4l2_dev: pointer to top the level v4l2_device
 * @vfd: video device node
 * @fh: v4l2 file handle
 * @alloc_ctx: videobuf2 memory allocator context
 * @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
 * @fmt: pointer to color format description structure
 * @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
 * @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
 * @ref_count: driver's private reference counter
 */
struct fimc_lite {
	struct platform_device	*pdev;
	struct flite_variant	*variant;
	struct v4l2_device	*v4l2_dev;
	struct video_device	vfd;
	struct v4l2_fh		fh;
	struct vb2_alloc_ctx	*alloc_ctx;
	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;
	u32			index;
	struct fimc_pipeline	pipeline;
	const struct fimc_pipeline_ops *pipeline_ops;

	struct mutex		lock;
	spinlock_t		slock;

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

	const struct fimc_fmt	*fmt;
	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 int		frame_count;
	unsigned int		reqbufs_count;
	int			ref_count;

	struct fimc_lite_events	events;
};

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>
	22	#include <media/videobuf2-core.h>
80f958f4	23	#include <media/v4l2-ctrls.h>
2b511edb SN	24	#include <media/v4l2-device.h>
	25	#include <media/v4l2-mediabus.h>
	26	#include <media/s5p_fimc.h>
	27
2b511edb SN	28	#define FIMC_LITE_DRV_NAME "exynos-fimc-lite"
	29	#define FLITE_CLK_NAME "flite"
	30	#define FIMC_LITE_MAX_DEVS 2
	31	#define FLITE_REQ_BUFS_MIN 2
	32
	33	/* Bit index definitions for struct fimc_lite::state */
	34	enum {
	35	ST_FLITE_LPM,
	36	ST_FLITE_PENDING,
	37	ST_FLITE_RUN,
	38	ST_FLITE_STREAM,
	39	ST_FLITE_SUSPENDED,
	40	ST_FLITE_OFF,
	41	ST_FLITE_IN_USE,
	42	ST_FLITE_CONFIG,
	43	ST_SENSOR_STREAM,
	44	};
	45
	46	#define FLITE_SD_PAD_SINK 0
6319d6a0 SN	47	#define FLITE_SD_PAD_SOURCE_DMA 1
	48	#define FLITE_SD_PAD_SOURCE_ISP 2
	49	#define FLITE_SD_PADS_NUM 3
2b511edb SN	50
	51	struct flite_variant {
	52	unsigned short max_width;
	53	unsigned short max_height;
	54	unsigned short out_width_align;
	55	unsigned short win_hor_offs_align;
	56	unsigned short out_hor_offs_align;
	57	};
	58
	59	struct flite_drvdata {
	60	struct flite_variant *variant[FIMC_LITE_MAX_DEVS];
	61	};
	62
	63	#define fimc_lite_get_drvdata(_pdev) \
	64	((struct flite_drvdata *) platform_get_device_id(_pdev)->driver_data)
	65
	66	struct fimc_lite_events {
	67	unsigned int data_overflow;
	68	};
	69
	70	#define FLITE_MAX_PLANES 1
	71
	72	/**
	73	* struct flite_frame - source/target frame properties
	74	* @f_width: full pixel width
	75	* @f_height: full pixel height
	76	* @rect: crop/composition rectangle
	77	*/
	78	struct flite_frame {
	79	u16 f_width;
	80	u16 f_height;
	81	struct v4l2_rect rect;
	82	};
	83
	84	/**
	85	* struct flite_buffer - video buffer structure
	86	* @vb: vb2 buffer
	87	* @list: list head for the buffers queue
	88	* @paddr: precalculated physical address
	89	*/
	90	struct flite_buffer {
	91	struct vb2_buffer vb;
	92	struct list_head list;
	93	dma_addr_t paddr;
	94	};
	95
	96	/**
	97	* struct fimc_lite - fimc lite structure
	98	* @pdev: pointer to FIMC-LITE platform device
	99	* @variant: variant information for this IP
	100	* @v4l2_dev: pointer to top the level v4l2_device
	101	* @vfd: video device node
	102	* @fh: v4l2 file handle
	103	* @alloc_ctx: videobuf2 memory allocator context
	104	* @subdev: FIMC-LITE subdev
	105	* @vd_pad: media (sink) pad for the capture video node
	106	* @subdev_pads: the subdev media pads
6319d6a0	107	* @sensor: sensor subdev attached to FIMC-LITE directly or through MIPI-CSIS
2b511edb SN	108	* @ctrl_handler: v4l2 control handler
	109	* @test_pattern: test pattern controls
	110	* @index: FIMC-LITE platform device index
	111	* @pipeline: video capture pipeline data structure
b9ee31e6	112	* @pipeline_ops: media pipeline ops for the video node driver
2b511edb SN	113	* @slock: spinlock protecting this data structure and the hw registers
	114	* @lock: mutex serializing video device and the subdev operations
	115	* @clock: FIMC-LITE gate clock
	116	* @regs: memory mapped io registers
	117	* @irq_queue: interrupt handler waitqueue
	118	* @fmt: pointer to color format description structure
	119	* @payload: image size in bytes (w x h x bpp)
	120	* @inp_frame: camera input frame structure
	121	* @out_frame: DMA output frame structure
	122	* @out_path: output data path (DMA or FIFO)
	123	* @source_subdev_grp_id: source subdev group id
	124	* @state: driver state flags
	125	* @pending_buf_q: pending buffers queue head
	126	* @active_buf_q: the queue head of buffers scheduled in hardware
	127	* @vb_queue: vb2 buffers queue
	128	* @active_buf_count: number of video buffers scheduled in hardware
	129	* @frame_count: the captured frames counter
	130	* @reqbufs_count: the number of buffers requested with REQBUFS ioctl
	131	* @ref_count: driver's private reference counter
	132	*/
	133	struct fimc_lite {
	134	struct platform_device *pdev;
	135	struct flite_variant *variant;
	136	struct v4l2_device *v4l2_dev;
1bcd7041	137	struct video_device vfd;
2b511edb SN	138	struct v4l2_fh fh;
	139	struct vb2_alloc_ctx *alloc_ctx;
	140	struct v4l2_subdev subdev;
	141	struct media_pad vd_pad;
	142	struct media_pad subdev_pads[FLITE_SD_PADS_NUM];
6319d6a0	143	struct v4l2_subdev *sensor;
2b511edb SN	144	struct v4l2_ctrl_handler ctrl_handler;
	145	struct v4l2_ctrl *test_pattern;
	146	u32 index;
	147	struct fimc_pipeline pipeline;
b9ee31e6	148	const struct fimc_pipeline_ops *pipeline_ops;
2b511edb SN	149
	150	struct mutex lock;
	151	spinlock_t slock;
	152
	153	struct clk *clock;
	154	void __iomem *regs;
	155	wait_queue_head_t irq_queue;
	156
	157	const struct fimc_fmt *fmt;
	158	unsigned long payload[FLITE_MAX_PLANES];
	159	struct flite_frame inp_frame;
	160	struct flite_frame out_frame;
03878bb4	161	atomic_t out_path;
2b511edb SN	162	unsigned int source_subdev_grp_id;
	163
	164	unsigned long state;
	165	struct list_head pending_buf_q;
	166	struct list_head active_buf_q;
	167	struct vb2_queue vb_queue;
	168	unsigned int frame_count;
	169	unsigned int reqbufs_count;
	170	int ref_count;
	171
	172	struct fimc_lite_events events;
	173	};
	174
	175	static inline bool fimc_lite_active(struct fimc_lite *fimc)
	176	{
	177	unsigned long flags;
	178	bool ret;
	179
	180	spin_lock_irqsave(&fimc->slock, flags);
	181	ret = fimc->state & (1 << ST_FLITE_RUN) \|\|
	182	fimc->state & (1 << ST_FLITE_PENDING);
	183	spin_unlock_irqrestore(&fimc->slock, flags);
	184	return ret;
	185	}
	186
	187	static inline void fimc_lite_active_queue_add(struct fimc_lite *dev,
	188	struct flite_buffer *buf)
	189	{
	190	list_add_tail(&buf->list, &dev->active_buf_q);
	191	}
	192
	193	static inline struct flite_buffer *fimc_lite_active_queue_pop(
	194	struct fimc_lite *dev)
	195	{
	196	struct flite_buffer *buf = list_entry(dev->active_buf_q.next,
	197	struct flite_buffer, list);
	198	list_del(&buf->list);
	199	return buf;
	200	}
	201
	202	static inline void fimc_lite_pending_queue_add(struct fimc_lite *dev,
	203	struct flite_buffer *buf)
	204	{
	205	list_add_tail(&buf->list, &dev->pending_buf_q);
	206	}
	207
	208	static inline struct flite_buffer *fimc_lite_pending_queue_pop(
	209	struct fimc_lite *dev)
	210	{
	211	struct flite_buffer *buf = list_entry(dev->pending_buf_q.next,
	212	struct flite_buffer, list);
	213	list_del(&buf->list);
	214	return buf;
	215	}
	216
	217	#endif /* FIMC_LITE_H_ */