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