[mirror_ubuntu-bionic-kernel.git] / include / media / drv-intf / saa7146_vv.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __SAA7146_VV__
#define __SAA7146_VV__

#include <media/v4l2-common.h>
#include <media/v4l2-ioctl.h>
#include <media/v4l2-fh.h>
#include <media/drv-intf/saa7146.h>
#include <media/videobuf-dma-sg.h>

#define MAX_SAA7146_CAPTURE_BUFFERS	32	/* arbitrary */
#define BUFFER_TIMEOUT     (HZ/2)  /* 0.5 seconds */

#define WRITE_RPS0(x) do { \
	dev->d_rps0.cpu_addr[ count++ ] = cpu_to_le32(x); \
	} while (0);

#define WRITE_RPS1(x) do { \
	dev->d_rps1.cpu_addr[ count++ ] = cpu_to_le32(x); \
	} while (0);

struct	saa7146_video_dma {
	u32 base_odd;
	u32 base_even;
	u32 prot_addr;
	u32 pitch;
	u32 base_page;
	u32 num_line_byte;
};

#define FORMAT_BYTE_SWAP	0x1
#define FORMAT_IS_PLANAR	0x2

struct saa7146_format {
	char	*name;
	u32	pixelformat;
	u32	trans;
	u8	depth;
	u8	flags;
	u8	swap;
};

struct saa7146_standard
{
	char          *name;
	v4l2_std_id   id;

	int v_offset;	/* number of lines of vertical offset before processing */
	int v_field;	/* number of lines in a field for HPS to process */

	int h_offset;	/* horizontal offset of processing window */
	int h_pixels;	/* number of horizontal pixels to process */

	int v_max_out;
	int h_max_out;
};

/* buffer for one video/vbi frame */
struct saa7146_buf {
	/* common v4l buffer stuff -- must be first */
	struct videobuf_buffer vb;

	/* saa7146 specific */
	struct v4l2_pix_format  *fmt;
	int (*activate)(struct saa7146_dev *dev,
			struct saa7146_buf *buf,
			struct saa7146_buf *next);

	/* page tables */
	struct saa7146_pgtable  pt[3];
};

struct saa7146_dmaqueue {
	struct saa7146_dev	*dev;
	struct saa7146_buf	*curr;
	struct list_head	queue;
	struct timer_list	timeout;
};

struct saa7146_overlay {
	struct saa7146_fh	*fh;
	struct v4l2_window	win;
	struct v4l2_clip	clips[16];
	int			nclips;
};

/* per open data */
struct saa7146_fh {
	/* Must be the first field! */
	struct v4l2_fh		fh;
	struct saa7146_dev	*dev;

	/* video capture */
	struct videobuf_queue	video_q;

	/* vbi capture */
	struct videobuf_queue	vbi_q;

	unsigned int resources;	/* resource management for device open */
};

#define STATUS_OVERLAY	0x01
#define STATUS_CAPTURE	0x02

struct saa7146_vv
{
	/* vbi capture */
	struct saa7146_dmaqueue		vbi_dmaq;
	struct v4l2_vbi_format		vbi_fmt;
	struct timer_list		vbi_read_timeout;
	struct file			*vbi_read_timeout_file;
	/* vbi workaround interrupt queue */
	wait_queue_head_t		vbi_wq;
	int				vbi_fieldcount;
	struct saa7146_fh		*vbi_streaming;

	int				video_status;
	struct saa7146_fh		*video_fh;

	/* video overlay */
	struct saa7146_overlay		ov;
	struct v4l2_framebuffer		ov_fb;
	struct saa7146_format		*ov_fmt;
	struct saa7146_fh		*ov_suspend;

	/* video capture */
	struct saa7146_dmaqueue		video_dmaq;
	struct v4l2_pix_format		video_fmt;
	enum v4l2_field			last_field;

	/* common: fixme? shouldn't this be in saa7146_fh?
	   (this leads to a more complicated question: shall the driver
	   store the different settings (for example S_INPUT) for every open
	   and restore it appropriately, or should all settings be common for
	   all opens? currently, we do the latter, like all other
	   drivers do... */
	struct saa7146_standard	*standard;

	int	vflip;
	int	hflip;
	int	current_hps_source;
	int	current_hps_sync;

	struct saa7146_dma	d_clipping;	/* pointer to clipping memory */

	unsigned int resources;	/* resource management for device */
};

/* flags */
#define SAA7146_USE_PORT_B_FOR_VBI	0x2     /* use input port b for vbi hardware bug workaround */

struct saa7146_ext_vv
{
	/* informations about the video capabilities of the device */
	int	inputs;
	int	audios;
	u32	capabilities;
	int	flags;

	/* additionally supported transmission standards */
	struct saa7146_standard *stds;
	int num_stds;
	int (*std_callback)(struct saa7146_dev*, struct saa7146_standard *);

	/* the extension can override this */
	struct v4l2_ioctl_ops vid_ops;
	struct v4l2_ioctl_ops vbi_ops;
	/* pointer to the saa7146 core ops */
	const struct v4l2_ioctl_ops *core_ops;

	struct v4l2_file_operations vbi_fops;
};

struct saa7146_use_ops  {
	void (*init)(struct saa7146_dev *, struct saa7146_vv *);
	int(*open)(struct saa7146_dev *, struct file *);
	void (*release)(struct saa7146_dev *, struct file *);
	void (*irq_done)(struct saa7146_dev *, unsigned long status);
	ssize_t (*read)(struct file *, char __user *, size_t, loff_t *);
};

/* from saa7146_fops.c */
int saa7146_register_device(struct video_device *vid, struct saa7146_dev *dev, char *name, int type);
int saa7146_unregister_device(struct video_device *vid, struct saa7146_dev *dev);
void saa7146_buffer_finish(struct saa7146_dev *dev, struct saa7146_dmaqueue *q, int state);
void saa7146_buffer_next(struct saa7146_dev *dev, struct saa7146_dmaqueue *q,int vbi);
int saa7146_buffer_queue(struct saa7146_dev *dev, struct saa7146_dmaqueue *q, struct saa7146_buf *buf);
void saa7146_buffer_timeout(struct timer_list *t);
void saa7146_dma_free(struct saa7146_dev* dev,struct videobuf_queue *q,
						struct saa7146_buf *buf);

int saa7146_vv_init(struct saa7146_dev* dev, struct saa7146_ext_vv *ext_vv);
int saa7146_vv_release(struct saa7146_dev* dev);

/* from saa7146_hlp.c */
int saa7146_enable_overlay(struct saa7146_fh *fh);
void saa7146_disable_overlay(struct saa7146_fh *fh);

void saa7146_set_capture(struct saa7146_dev *dev, struct saa7146_buf *buf, struct saa7146_buf *next);
void saa7146_write_out_dma(struct saa7146_dev* dev, int which, struct saa7146_video_dma* vdma) ;
void saa7146_set_hps_source_and_sync(struct saa7146_dev *saa, int source, int sync);
void saa7146_set_gpio(struct saa7146_dev *saa, u8 pin, u8 data);

/* from saa7146_video.c */
extern const struct v4l2_ioctl_ops saa7146_video_ioctl_ops;
extern const struct v4l2_ioctl_ops saa7146_vbi_ioctl_ops;
extern const struct saa7146_use_ops saa7146_video_uops;
int saa7146_start_preview(struct saa7146_fh *fh);
int saa7146_stop_preview(struct saa7146_fh *fh);
long saa7146_video_do_ioctl(struct file *file, unsigned int cmd, void *arg);
int saa7146_s_ctrl(struct v4l2_ctrl *ctrl);

/* from saa7146_vbi.c */
extern const struct saa7146_use_ops saa7146_vbi_uops;

/* resource management functions */
int saa7146_res_get(struct saa7146_fh *fh, unsigned int bit);
void saa7146_res_free(struct saa7146_fh *fh, unsigned int bits);

#define RESOURCE_DMA1_HPS	0x1
#define RESOURCE_DMA2_CLP	0x2
#define RESOURCE_DMA3_BRS	0x4

/* saa7146 source inputs */
#define SAA7146_HPS_SOURCE_PORT_A	0x00
#define SAA7146_HPS_SOURCE_PORT_B	0x01
#define SAA7146_HPS_SOURCE_YPB_CPA	0x02
#define SAA7146_HPS_SOURCE_YPA_CPB	0x03

/* sync inputs */
#define SAA7146_HPS_SYNC_PORT_A		0x00
#define SAA7146_HPS_SYNC_PORT_B		0x01

/* some memory sizes */
/* max. 16 clipping rectangles */
#define SAA7146_CLIPPING_MEM	(16 * 4 * sizeof(u32))

/* some defines for the various clipping-modes */
#define SAA7146_CLIPPING_RECT		0x4
#define SAA7146_CLIPPING_RECT_INVERTED	0x5
#define SAA7146_CLIPPING_MASK		0x6
#define SAA7146_CLIPPING_MASK_INVERTED	0x7

/* output formats: each entry holds four informations */
#define RGB08_COMPOSED	0x0217 /* composed is used in the sense of "not-planar" */
/* this means: planar?=0, yuv2rgb-conversation-mode=2, dither=yes(=1), format-mode = 7 */
#define RGB15_COMPOSED	0x0213
#define RGB16_COMPOSED	0x0210
#define RGB24_COMPOSED	0x0201
#define RGB32_COMPOSED	0x0202

#define Y8			0x0006
#define YUV411_COMPOSED		0x0003
#define YUV422_COMPOSED		0x0000
/* this means: planar?=1, yuv2rgb-conversion-mode=0, dither=no(=0), format-mode = b */
#define YUV411_DECOMPOSED	0x100b
#define YUV422_DECOMPOSED	0x1009
#define YUV420_DECOMPOSED	0x100a

#define IS_PLANAR(x) (x & 0xf000)

/* misc defines */
#define SAA7146_NO_SWAP		(0x0)
#define SAA7146_TWO_BYTE_SWAP	(0x1)
#define SAA7146_FOUR_BYTE_SWAP	(0x2)

#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	#ifndef __SAA7146_VV__
	3	#define __SAA7146_VV__
	4
5e87efa3	5	#include <media/v4l2-common.h>
35ea11ff	6	#include <media/v4l2-ioctl.h>
537fa492	7	#include <media/v4l2-fh.h>
d647f0b7	8	#include <media/drv-intf/saa7146.h>
c1accaa2	9	#include <media/videobuf-dma-sg.h>
1da177e4 LT	10
	11	#define MAX_SAA7146_CAPTURE_BUFFERS 32 /* arbitrary */
	12	#define BUFFER_TIMEOUT (HZ/2) /* 0.5 seconds */
	13
	14	#define WRITE_RPS0(x) do { \
	15	dev->d_rps0.cpu_addr[ count++ ] = cpu_to_le32(x); \
	16	} while (0);
	17
	18	#define WRITE_RPS1(x) do { \
	19	dev->d_rps1.cpu_addr[ count++ ] = cpu_to_le32(x); \
	20	} while (0);
	21
	22	struct saa7146_video_dma {
	23	u32 base_odd;
	24	u32 base_even;
	25	u32 prot_addr;
	26	u32 pitch;
	27	u32 base_page;
	28	u32 num_line_byte;
	29	};
	30
	31	#define FORMAT_BYTE_SWAP 0x1
	32	#define FORMAT_IS_PLANAR 0x2
	33
	34	struct saa7146_format {
	35	char *name;
	36	u32 pixelformat;
	37	u32 trans;
	38	u8 depth;
	39	u8 flags;
	40	u8 swap;
	41	};
	42
	43	struct saa7146_standard
	44	{
	45	char *name;
	46	v4l2_std_id id;
	47
	48	int v_offset; /* number of lines of vertical offset before processing */
	49	int v_field; /* number of lines in a field for HPS to process */
	50
	51	int h_offset; /* horizontal offset of processing window */
	52	int h_pixels; /* number of horizontal pixels to process */
	53
	54	int v_max_out;
	55	int h_max_out;
	56	};
	57
	58	/* buffer for one video/vbi frame */
	59	struct saa7146_buf {
	60	/* common v4l buffer stuff -- must be first */
	61	struct videobuf_buffer vb;
	62
	63	/* saa7146 specific */
	64	struct v4l2_pix_format *fmt;
	65	int (activate)(struct saa7146_dev dev,
	66	struct saa7146_buf *buf,
	67	struct saa7146_buf *next);
	68
	69	/* page tables */
	70	struct saa7146_pgtable pt[3];
	71	};
	72
	73	struct saa7146_dmaqueue {
74	struct saa7146_dev *dev;
75	struct saa7146_buf *curr;
76	struct list_head queue;
77	struct timer_list timeout;
78	};
79
80	struct saa7146_overlay {
81	struct saa7146_fh *fh;
82	struct v4l2_window win;
83	struct v4l2_clip clips[16];
84	int nclips;
85	};
86
87	/* per open data */
88	struct saa7146_fh {
537fa492 HV	89	/* Must be the first field! */
537fa492 HV	90	struct v4l2_fh fh;
1da177e4	91	struct saa7146_dev *dev;
1da177e4	92
1da177e4 LT	93	/* video capture */
1da177e4 LT	94	struct videobuf_queue video_q;
1da177e4 LT	95
	96	/* vbi capture */
	97	struct videobuf_queue vbi_q;
1da177e4 LT	98
	99	unsigned int resources; /* resource management for device open */
	100	};
	101
	102	#define STATUS_OVERLAY 0x01
	103	#define STATUS_CAPTURE 0x02
	104
	105	struct saa7146_vv
	106	{
1da177e4	107	/* vbi capture */
9bb60193	108	struct saa7146_dmaqueue vbi_dmaq;
fca3469a HV	109	struct v4l2_vbi_format vbi_fmt;
fca3469a HV	110	struct timer_list vbi_read_timeout;
3e314917	111	struct file *vbi_read_timeout_file;
1da177e4	112	/* vbi workaround interrupt queue */
afd1a0c9	113	wait_queue_head_t vbi_wq;
1da177e4 LT	114	int vbi_fieldcount;
	115	struct saa7146_fh *vbi_streaming;
	116
1da177e4 LT	117	int video_status;
	118	struct saa7146_fh *video_fh;
	119
	120	/* video overlay */
5da545ad	121	struct saa7146_overlay ov;
1da177e4 LT	122	struct v4l2_framebuffer ov_fb;
1da177e4 LT	123	struct saa7146_format *ov_fmt;
1da177e4 LT	124	struct saa7146_fh *ov_suspend;
	125
	126	/* video capture */
9bb60193	127	struct saa7146_dmaqueue video_dmaq;
fd74d6eb	128	struct v4l2_pix_format video_fmt;
1da177e4 LT	129	enum v4l2_field last_field;
	130
	131	/* common: fixme? shouldn't this be in saa7146_fh?
	132	(this leads to a more complicated question: shall the driver
	133	store the different settings (for example S_INPUT) for every open
	134	and restore it appropriately, or should all settings be common for
	135	all opens? currently, we do the latter, like all other
	136	drivers do... */
	137	struct saa7146_standard *standard;
	138
	139	int vflip;
	140	int hflip;
	141	int current_hps_source;
	142	int current_hps_sync;
	143
	144	struct saa7146_dma d_clipping; /* pointer to clipping memory */
	145
	146	unsigned int resources; /* resource management for device */
	147	};
	148
1da177e4 LT	149	/* flags */
	150	#define SAA7146_USE_PORT_B_FOR_VBI 0x2 /* use input port b for vbi hardware bug workaround */
	151
	152	struct saa7146_ext_vv
	153	{
	154	/* informations about the video capabilities of the device */
	155	int inputs;
	156	int audios;
	157	u32 capabilities;
	158	int flags;
	159
	160	/* additionally supported transmission standards */
	161	struct saa7146_standard *stds;
	162	int num_stds;
	163	int (std_callback)(struct saa7146_dev, struct saa7146_standard *);
	164
b960074f	165	/* the extension can override this */
ab49ae0f HV	166	struct v4l2_ioctl_ops vid_ops;
ab49ae0f HV	167	struct v4l2_ioctl_ops vbi_ops;
b960074f HV	168	/* pointer to the saa7146 core ops */
b960074f HV	169	const struct v4l2_ioctl_ops *core_ops;
5b0fa4ff	170
bec43661	171	struct v4l2_file_operations vbi_fops;
1da177e4 LT	172	};
	173
	174	struct saa7146_use_ops {
afd1a0c9 MCC	175	void (init)(struct saa7146_dev , struct saa7146_vv *);
	176	int(open)(struct saa7146_dev , struct file *);
	177	void (release)(struct saa7146_dev , struct file *);
	178	void (irq_done)(struct saa7146_dev , unsigned long status);
1da177e4 LT	179	ssize_t (read)(struct file , char __user , size_t, loff_t );
	180	};
	181
	182	/* from saa7146_fops.c */
3ae863e0 HV	183	int saa7146_register_device(struct video_device vid, struct saa7146_dev dev, char *name, int type);
3ae863e0 HV	184	int saa7146_unregister_device(struct video_device vid, struct saa7146_dev dev);
1da177e4 LT	185	void saa7146_buffer_finish(struct saa7146_dev dev, struct saa7146_dmaqueue q, int state);
	186	void saa7146_buffer_next(struct saa7146_dev dev, struct saa7146_dmaqueue q,int vbi);
	187	int saa7146_buffer_queue(struct saa7146_dev dev, struct saa7146_dmaqueue q, struct saa7146_buf *buf);
12a83612	188	void saa7146_buffer_timeout(struct timer_list *t);
c7b0ac05 MCC	189	void saa7146_dma_free(struct saa7146_dev* dev,struct videobuf_queue *q,
c7b0ac05 MCC	190	struct saa7146_buf *buf);
1da177e4 LT	191
	192	int saa7146_vv_init(struct saa7146_dev* dev, struct saa7146_ext_vv *ext_vv);
	193	int saa7146_vv_release(struct saa7146_dev* dev);
	194
	195	/* from saa7146_hlp.c */
	196	int saa7146_enable_overlay(struct saa7146_fh *fh);
	197	void saa7146_disable_overlay(struct saa7146_fh *fh);
	198
	199	void saa7146_set_capture(struct saa7146_dev dev, struct saa7146_buf buf, struct saa7146_buf *next);
	200	void saa7146_write_out_dma(struct saa7146_dev* dev, int which, struct saa7146_video_dma* vdma) ;
	201	void saa7146_set_hps_source_and_sync(struct saa7146_dev *saa, int source, int sync);
	202	void saa7146_set_gpio(struct saa7146_dev *saa, u8 pin, u8 data);
	203
	204	/* from saa7146_video.c */
b960074f	205	extern const struct v4l2_ioctl_ops saa7146_video_ioctl_ops;
ab49ae0f	206	extern const struct v4l2_ioctl_ops saa7146_vbi_ioctl_ops;
ad627017	207	extern const struct saa7146_use_ops saa7146_video_uops;
1da177e4 LT	208	int saa7146_start_preview(struct saa7146_fh *fh);
1da177e4 LT	209	int saa7146_stop_preview(struct saa7146_fh *fh);
069b7479	210	long saa7146_video_do_ioctl(struct file file, unsigned int cmd, void arg);
6e65ca94	211	int saa7146_s_ctrl(struct v4l2_ctrl *ctrl);
1da177e4 LT	212
1da177e4 LT	213	/* from saa7146_vbi.c */
ad627017	214	extern const struct saa7146_use_ops saa7146_vbi_uops;
1da177e4 LT	215
	216	/* resource management functions */
	217	int saa7146_res_get(struct saa7146_fh *fh, unsigned int bit);
	218	void saa7146_res_free(struct saa7146_fh *fh, unsigned int bits);
	219
	220	#define RESOURCE_DMA1_HPS 0x1
	221	#define RESOURCE_DMA2_CLP 0x2
	222	#define RESOURCE_DMA3_BRS 0x4
	223
	224	/* saa7146 source inputs */
	225	#define SAA7146_HPS_SOURCE_PORT_A 0x00
	226	#define SAA7146_HPS_SOURCE_PORT_B 0x01
	227	#define SAA7146_HPS_SOURCE_YPB_CPA 0x02
	228	#define SAA7146_HPS_SOURCE_YPA_CPB 0x03
	229
	230	/* sync inputs */
	231	#define SAA7146_HPS_SYNC_PORT_A 0x00
	232	#define SAA7146_HPS_SYNC_PORT_B 0x01
	233
	234	/* some memory sizes */
7a7cd192 OE	235	/* max. 16 clipping rectangles */
7a7cd192 OE	236	#define SAA7146_CLIPPING_MEM (16 * 4 * sizeof(u32))
1da177e4 LT	237
	238	/* some defines for the various clipping-modes */
	239	#define SAA7146_CLIPPING_RECT 0x4
	240	#define SAA7146_CLIPPING_RECT_INVERTED 0x5
	241	#define SAA7146_CLIPPING_MASK 0x6
	242	#define SAA7146_CLIPPING_MASK_INVERTED 0x7
	243
	244	/* output formats: each entry holds four informations */
	245	#define RGB08_COMPOSED 0x0217 /* composed is used in the sense of "not-planar" */
	246	/* this means: planar?=0, yuv2rgb-conversation-mode=2, dither=yes(=1), format-mode = 7 */
	247	#define RGB15_COMPOSED 0x0213
	248	#define RGB16_COMPOSED 0x0210
	249	#define RGB24_COMPOSED 0x0201
	250	#define RGB32_COMPOSED 0x0202
	251
	252	#define Y8 0x0006
	253	#define YUV411_COMPOSED 0x0003
	254	#define YUV422_COMPOSED 0x0000
	255	/* this means: planar?=1, yuv2rgb-conversion-mode=0, dither=no(=0), format-mode = b */
	256	#define YUV411_DECOMPOSED 0x100b
	257	#define YUV422_DECOMPOSED 0x1009
	258	#define YUV420_DECOMPOSED 0x100a
	259
	260	#define IS_PLANAR(x) (x & 0xf000)
	261
	262	/* misc defines */
	263	#define SAA7146_NO_SWAP (0x0)
	264	#define SAA7146_TWO_BYTE_SWAP (0x1)
	265	#define SAA7146_FOUR_BYTE_SWAP (0x2)
	266
	267	#endif