1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * This is the driver for the STA2x11 Video Input Port.
4  *
5  * Copyright (C) 2012       ST Microelectronics
6  *     author: Federico Vaga <federico.vaga@gmail.com>
7  * Copyright (C) 2010       WindRiver Systems, Inc.
8  *     authors: Andreas Kies <andreas.kies@windriver.com>
9  *              Vlad Lungu   <vlad.lungu@windriver.com>
10  */
11 
12 #include <linux/types.h>
13 #include <linux/kernel.h>
14 #include <linux/module.h>
15 #include <linux/init.h>
16 #include <linux/videodev2.h>
17 #include <linux/kmod.h>
18 #include <linux/pci.h>
19 #include <linux/interrupt.h>
20 #include <linux/io.h>
21 #include <linux/gpio.h>
22 #include <linux/i2c.h>
23 #include <linux/delay.h>
24 #include <media/v4l2-common.h>
25 #include <media/v4l2-device.h>
26 #include <media/v4l2-ctrls.h>
27 #include <media/v4l2-ioctl.h>
28 #include <media/v4l2-fh.h>
29 #include <media/v4l2-event.h>
30 #include <media/videobuf2-dma-contig.h>
31 
32 #include "sta2x11_vip.h"
33 
34 #define DRV_VERSION "1.3"
35 
36 #ifndef PCI_DEVICE_ID_STMICRO_VIP
37 #define PCI_DEVICE_ID_STMICRO_VIP 0xCC0D
38 #endif
39 
40 #define MAX_FRAMES 4
41 
42 /*Register offsets*/
43 #define DVP_CTL		0x00
44 #define DVP_TFO		0x04
45 #define DVP_TFS		0x08
46 #define DVP_BFO		0x0C
47 #define DVP_BFS		0x10
48 #define DVP_VTP		0x14
49 #define DVP_VBP		0x18
50 #define DVP_VMP		0x1C
51 #define DVP_ITM		0x98
52 #define DVP_ITS		0x9C
53 #define DVP_STA		0xA0
54 #define DVP_HLFLN	0xA8
55 #define DVP_RGB		0xC0
56 #define DVP_PKZ		0xF0
57 
58 /*Register fields*/
59 #define DVP_CTL_ENA	0x00000001
60 #define DVP_CTL_RST	0x80000000
61 #define DVP_CTL_DIS	(~0x00040001)
62 
63 #define DVP_IT_VSB	0x00000008
64 #define DVP_IT_VST	0x00000010
65 #define DVP_IT_FIFO	0x00000020
66 
67 #define DVP_HLFLN_SD	0x00000001
68 
69 #define SAVE_COUNT 8
70 #define AUX_COUNT 3
71 #define IRQ_COUNT 1
72 
73 
74 struct vip_buffer {
75 	struct vb2_v4l2_buffer vb;
76 	struct list_head	list;
77 	dma_addr_t		dma;
78 };
79 static inline struct vip_buffer *to_vip_buffer(struct vb2_v4l2_buffer *vb2)
80 {
81 	return container_of(vb2, struct vip_buffer, vb);
82 }
83 
84 /**
85  * struct sta2x11_vip - All internal data for one instance of device
86  * @v4l2_dev: device registered in v4l layer
87  * @video_dev: properties of our device
88  * @pdev: PCI device
89  * @adapter: contains I2C adapter information
90  * @register_save_area: All relevant register are saved here during suspend
91  * @decoder: contains information about video DAC
92  * @ctrl_hdl: handler for control framework
93  * @format: pixel format, fixed UYVY
94  * @std: video standard (e.g. PAL/NTSC)
95  * @input: input line for video signal ( 0 or 1 )
96  * @disabled: Device is in power down state
97  * @slock: for excluse access of registers
98  * @vb_vidq: queue maintained by videobuf2 layer
99  * @buffer_list: list of buffer in use
100  * @sequence: sequence number of acquired buffer
101  * @active: current active buffer
102  * @lock: used in videobuf2 callback
103  * @v4l_lock: serialize its video4linux ioctls
104  * @tcount: Number of top frames
105  * @bcount: Number of bottom frames
106  * @overflow: Number of FIFO overflows
107  * @iomem: hardware base address
108  * @config: I2C and gpio config from platform
109  *
110  * All non-local data is accessed via this structure.
111  */
112 struct sta2x11_vip {
113 	struct v4l2_device v4l2_dev;
114 	struct video_device video_dev;
115 	struct pci_dev *pdev;
116 	struct i2c_adapter *adapter;
117 	unsigned int register_save_area[IRQ_COUNT + SAVE_COUNT + AUX_COUNT];
118 	struct v4l2_subdev *decoder;
119 	struct v4l2_ctrl_handler ctrl_hdl;
120 
121 
122 	struct v4l2_pix_format format;
123 	v4l2_std_id std;
124 	unsigned int input;
125 	int disabled;
126 	spinlock_t slock;
127 
128 	struct vb2_queue vb_vidq;
129 	struct list_head buffer_list;
130 	unsigned int sequence;
131 	struct vip_buffer *active; /* current active buffer */
132 	spinlock_t lock; /* Used in videobuf2 callback */
133 	struct mutex v4l_lock;
134 
135 	/* Interrupt counters */
136 	int tcount, bcount;
137 	int overflow;
138 
139 	void __iomem *iomem;	/* I/O Memory */
140 	struct vip_config *config;
141 };
142 
143 static const unsigned int registers_to_save[AUX_COUNT] = {
144 	DVP_HLFLN, DVP_RGB, DVP_PKZ
145 };
146 
147 static struct v4l2_pix_format formats_50[] = {
148 	{			/*PAL interlaced */
149 	 .width = 720,
150 	 .height = 576,
151 	 .pixelformat = V4L2_PIX_FMT_UYVY,
152 	 .field = V4L2_FIELD_INTERLACED,
153 	 .bytesperline = 720 * 2,
154 	 .sizeimage = 720 * 2 * 576,
155 	 .colorspace = V4L2_COLORSPACE_SMPTE170M},
156 	{			/*PAL top */
157 	 .width = 720,
158 	 .height = 288,
159 	 .pixelformat = V4L2_PIX_FMT_UYVY,
160 	 .field = V4L2_FIELD_TOP,
161 	 .bytesperline = 720 * 2,
162 	 .sizeimage = 720 * 2 * 288,
163 	 .colorspace = V4L2_COLORSPACE_SMPTE170M},
164 	{			/*PAL bottom */
165 	 .width = 720,
166 	 .height = 288,
167 	 .pixelformat = V4L2_PIX_FMT_UYVY,
168 	 .field = V4L2_FIELD_BOTTOM,
169 	 .bytesperline = 720 * 2,
170 	 .sizeimage = 720 * 2 * 288,
171 	 .colorspace = V4L2_COLORSPACE_SMPTE170M},
172 
173 };
174 
175 static struct v4l2_pix_format formats_60[] = {
176 	{			/*NTSC interlaced */
177 	 .width = 720,
178 	 .height = 480,
179 	 .pixelformat = V4L2_PIX_FMT_UYVY,
180 	 .field = V4L2_FIELD_INTERLACED,
181 	 .bytesperline = 720 * 2,
182 	 .sizeimage = 720 * 2 * 480,
183 	 .colorspace = V4L2_COLORSPACE_SMPTE170M},
184 	{			/*NTSC top */
185 	 .width = 720,
186 	 .height = 240,
187 	 .pixelformat = V4L2_PIX_FMT_UYVY,
188 	 .field = V4L2_FIELD_TOP,
189 	 .bytesperline = 720 * 2,
190 	 .sizeimage = 720 * 2 * 240,
191 	 .colorspace = V4L2_COLORSPACE_SMPTE170M},
192 	{			/*NTSC bottom */
193 	 .width = 720,
194 	 .height = 240,
195 	 .pixelformat = V4L2_PIX_FMT_UYVY,
196 	 .field = V4L2_FIELD_BOTTOM,
197 	 .bytesperline = 720 * 2,
198 	 .sizeimage = 720 * 2 * 240,
199 	 .colorspace = V4L2_COLORSPACE_SMPTE170M},
200 };
201 
202 /* Write VIP register */
203 static inline void reg_write(struct sta2x11_vip *vip, unsigned int reg, u32 val)
204 {
205 	iowrite32((val), (vip->iomem)+(reg));
206 }
207 /* Read VIP register */
208 static inline u32 reg_read(struct sta2x11_vip *vip, unsigned int reg)
209 {
210 	return  ioread32((vip->iomem)+(reg));
211 }
212 /* Start DMA acquisition */
213 static void start_dma(struct sta2x11_vip *vip, struct vip_buffer *vip_buf)
214 {
215 	unsigned long offset = 0;
216 
217 	if (vip->format.field == V4L2_FIELD_INTERLACED)
218 		offset = vip->format.width * 2;
219 
220 	spin_lock_irq(&vip->slock);
221 	/* Enable acquisition */
222 	reg_write(vip, DVP_CTL, reg_read(vip, DVP_CTL) | DVP_CTL_ENA);
223 	/* Set Top and Bottom Field memory address */
224 	reg_write(vip, DVP_VTP, (u32)vip_buf->dma);
225 	reg_write(vip, DVP_VBP, (u32)vip_buf->dma + offset);
226 	spin_unlock_irq(&vip->slock);
227 }
228 
229 /* Fetch the next buffer to activate */
230 static void vip_active_buf_next(struct sta2x11_vip *vip)
231 {
232 	/* Get the next buffer */
233 	spin_lock(&vip->lock);
234 	if (list_empty(&vip->buffer_list)) {/* No available buffer */
235 		spin_unlock(&vip->lock);
236 		return;
237 	}
238 	vip->active = list_first_entry(&vip->buffer_list,
239 				       struct vip_buffer,
240 				       list);
241 	/* Reset Top and Bottom counter */
242 	vip->tcount = 0;
243 	vip->bcount = 0;
244 	spin_unlock(&vip->lock);
245 	if (vb2_is_streaming(&vip->vb_vidq)) {	/* streaming is on */
246 		start_dma(vip, vip->active);	/* start dma capture */
247 	}
248 }
249 
250 
251 /* Videobuf2 Operations */
252 static int queue_setup(struct vb2_queue *vq,
253 		       unsigned int *nbuffers, unsigned int *nplanes,
254 		       unsigned int sizes[], struct device *alloc_devs[])
255 {
256 	struct sta2x11_vip *vip = vb2_get_drv_priv(vq);
257 
258 	if (!(*nbuffers) || *nbuffers < MAX_FRAMES)
259 		*nbuffers = MAX_FRAMES;
260 
261 	*nplanes = 1;
262 	sizes[0] = vip->format.sizeimage;
263 
264 	vip->sequence = 0;
265 	vip->active = NULL;
266 	vip->tcount = 0;
267 	vip->bcount = 0;
268 
269 	return 0;
270 };
271 static int buffer_init(struct vb2_buffer *vb)
272 {
273 	struct vb2_v4l2_buffer *vbuf = to_vb2_v4l2_buffer(vb);
274 	struct vip_buffer *vip_buf = to_vip_buffer(vbuf);
275 
276 	vip_buf->dma = vb2_dma_contig_plane_dma_addr(vb, 0);
277 	INIT_LIST_HEAD(&vip_buf->list);
278 	return 0;
279 }
280 
281 static int buffer_prepare(struct vb2_buffer *vb)
282 {
283 	struct vb2_v4l2_buffer *vbuf = to_vb2_v4l2_buffer(vb);
284 	struct sta2x11_vip *vip = vb2_get_drv_priv(vb->vb2_queue);
285 	struct vip_buffer *vip_buf = to_vip_buffer(vbuf);
286 	unsigned long size;
287 
288 	size = vip->format.sizeimage;
289 	if (vb2_plane_size(vb, 0) < size) {
290 		v4l2_err(&vip->v4l2_dev, "buffer too small (%lu < %lu)\n",
291 			 vb2_plane_size(vb, 0), size);
292 		return -EINVAL;
293 	}
294 
295 	vb2_set_plane_payload(&vip_buf->vb.vb2_buf, 0, size);
296 
297 	return 0;
298 }
299 static void buffer_queue(struct vb2_buffer *vb)
300 {
301 	struct vb2_v4l2_buffer *vbuf = to_vb2_v4l2_buffer(vb);
302 	struct sta2x11_vip *vip = vb2_get_drv_priv(vb->vb2_queue);
303 	struct vip_buffer *vip_buf = to_vip_buffer(vbuf);
304 
305 	spin_lock(&vip->lock);
306 	list_add_tail(&vip_buf->list, &vip->buffer_list);
307 	if (!vip->active) {	/* No active buffer, active the first one */
308 		vip->active = list_first_entry(&vip->buffer_list,
309 					       struct vip_buffer,
310 					       list);
311 		if (vb2_is_streaming(&vip->vb_vidq))	/* streaming is on */
312 			start_dma(vip, vip_buf);	/* start dma capture */
313 	}
314 	spin_unlock(&vip->lock);
315 }
316 static void buffer_finish(struct vb2_buffer *vb)
317 {
318 	struct vb2_v4l2_buffer *vbuf = to_vb2_v4l2_buffer(vb);
319 	struct sta2x11_vip *vip = vb2_get_drv_priv(vb->vb2_queue);
320 	struct vip_buffer *vip_buf = to_vip_buffer(vbuf);
321 
322 	/* Buffer handled, remove it from the list */
323 	spin_lock(&vip->lock);
324 	list_del_init(&vip_buf->list);
325 	spin_unlock(&vip->lock);
326 
327 	if (vb2_is_streaming(vb->vb2_queue))
328 		vip_active_buf_next(vip);
329 }
330 
331 static int start_streaming(struct vb2_queue *vq, unsigned int count)
332 {
333 	struct sta2x11_vip *vip = vb2_get_drv_priv(vq);
334 
335 	spin_lock_irq(&vip->slock);
336 	/* Enable interrupt VSYNC Top and Bottom*/
337 	reg_write(vip, DVP_ITM, DVP_IT_VSB | DVP_IT_VST);
338 	spin_unlock_irq(&vip->slock);
339 
340 	if (count)
341 		start_dma(vip, vip->active);
342 
343 	return 0;
344 }
345 
346 /* abort streaming and wait for last buffer */
347 static void stop_streaming(struct vb2_queue *vq)
348 {
349 	struct sta2x11_vip *vip = vb2_get_drv_priv(vq);
350 	struct vip_buffer *vip_buf, *node;
351 
352 	/* Disable acquisition */
353 	reg_write(vip, DVP_CTL, reg_read(vip, DVP_CTL) & ~DVP_CTL_ENA);
354 	/* Disable all interrupts */
355 	reg_write(vip, DVP_ITM, 0);
356 
357 	/* Release all active buffers */
358 	spin_lock(&vip->lock);
359 	list_for_each_entry_safe(vip_buf, node, &vip->buffer_list, list) {
360 		vb2_buffer_done(&vip_buf->vb.vb2_buf, VB2_BUF_STATE_ERROR);
361 		list_del(&vip_buf->list);
362 	}
363 	spin_unlock(&vip->lock);
364 }
365 
366 static const struct vb2_ops vip_video_qops = {
367 	.queue_setup		= queue_setup,
368 	.buf_init		= buffer_init,
369 	.buf_prepare		= buffer_prepare,
370 	.buf_finish		= buffer_finish,
371 	.buf_queue		= buffer_queue,
372 	.start_streaming	= start_streaming,
373 	.stop_streaming		= stop_streaming,
374 	.wait_prepare		= vb2_ops_wait_prepare,
375 	.wait_finish		= vb2_ops_wait_finish,
376 };
377 
378 
379 /* File Operations */
380 static const struct v4l2_file_operations vip_fops = {
381 	.owner = THIS_MODULE,
382 	.open = v4l2_fh_open,
383 	.release = vb2_fop_release,
384 	.unlocked_ioctl = video_ioctl2,
385 	.read = vb2_fop_read,
386 	.mmap = vb2_fop_mmap,
387 	.poll = vb2_fop_poll
388 };
389 
390 
391 /**
392  * vidioc_querycap - return capabilities of device
393  * @file: descriptor of device
394  * @cap: contains return values
395  * @priv: unused
396  *
397  * the capabilities of the device are returned
398  *
399  * return value: 0, no error.
400  */
401 static int vidioc_querycap(struct file *file, void *priv,
402 			   struct v4l2_capability *cap)
403 {
404 	struct sta2x11_vip *vip = video_drvdata(file);
405 
406 	strscpy(cap->driver, KBUILD_MODNAME, sizeof(cap->driver));
407 	strscpy(cap->card, KBUILD_MODNAME, sizeof(cap->card));
408 	snprintf(cap->bus_info, sizeof(cap->bus_info), "PCI:%s",
409 		 pci_name(vip->pdev));
410 	return 0;
411 }
412 
413 /**
414  * vidioc_s_std - set video standard
415  * @file: descriptor of device
416  * @std: contains standard to be set
417  * @priv: unused
418  *
419  * the video standard is set
420  *
421  * return value: 0, no error.
422  *
423  * -EIO, no input signal detected
424  *
425  * other, returned from video DAC.
426  */
427 static int vidioc_s_std(struct file *file, void *priv, v4l2_std_id std)
428 {
429 	struct sta2x11_vip *vip = video_drvdata(file);
430 
431 	/*
432 	 * This is here for backwards compatibility only.
433 	 * The use of V4L2_STD_ALL to trigger a querystd is non-standard.
434 	 */
435 	if (std == V4L2_STD_ALL) {
436 		v4l2_subdev_call(vip->decoder, video, querystd, &std);
437 		if (std == V4L2_STD_UNKNOWN)
438 			return -EIO;
439 	}
440 
441 	if (vip->std != std) {
442 		vip->std = std;
443 		if (V4L2_STD_525_60 & std)
444 			vip->format = formats_60[0];
445 		else
446 			vip->format = formats_50[0];
447 	}
448 
449 	return v4l2_subdev_call(vip->decoder, video, s_std, std);
450 }
451 
452 /**
453  * vidioc_g_std - get video standard
454  * @file: descriptor of device
455  * @priv: unused
456  * @std: contains return values
457  *
458  * the current video standard is returned
459  *
460  * return value: 0, no error.
461  */
462 static int vidioc_g_std(struct file *file, void *priv, v4l2_std_id *std)
463 {
464 	struct sta2x11_vip *vip = video_drvdata(file);
465 
466 	*std = vip->std;
467 	return 0;
468 }
469 
470 /**
471  * vidioc_querystd - get possible video standards
472  * @file: descriptor of device
473  * @priv: unused
474  * @std: contains return values
475  *
476  * all possible video standards are returned
477  *
478  * return value: delivered by video DAC routine.
479  */
480 static int vidioc_querystd(struct file *file, void *priv, v4l2_std_id *std)
481 {
482 	struct sta2x11_vip *vip = video_drvdata(file);
483 
484 	return v4l2_subdev_call(vip->decoder, video, querystd, std);
485 }
486 
487 static int vidioc_enum_input(struct file *file, void *priv,
488 			     struct v4l2_input *inp)
489 {
490 	if (inp->index > 1)
491 		return -EINVAL;
492 
493 	inp->type = V4L2_INPUT_TYPE_CAMERA;
494 	inp->std = V4L2_STD_ALL;
495 	sprintf(inp->name, "Camera %u", inp->index);
496 
497 	return 0;
498 }
499 
500 /**
501  * vidioc_s_input - set input line
502  * @file: descriptor of device
503  * @priv: unused
504  * @i: new input line number
505  *
506  * the current active input line is set
507  *
508  * return value: 0, no error.
509  *
510  * -EINVAL, line number out of range
511  */
512 static int vidioc_s_input(struct file *file, void *priv, unsigned int i)
513 {
514 	struct sta2x11_vip *vip = video_drvdata(file);
515 	int ret;
516 
517 	if (i > 1)
518 		return -EINVAL;
519 	ret = v4l2_subdev_call(vip->decoder, video, s_routing, i, 0, 0);
520 
521 	if (!ret)
522 		vip->input = i;
523 
524 	return 0;
525 }
526 
527 /**
528  * vidioc_g_input - return input line
529  * @file: descriptor of device
530  * @priv: unused
531  * @i: returned input line number
532  *
533  * the current active input line is returned
534  *
535  * return value: always 0.
536  */
537 static int vidioc_g_input(struct file *file, void *priv, unsigned int *i)
538 {
539 	struct sta2x11_vip *vip = video_drvdata(file);
540 
541 	*i = vip->input;
542 	return 0;
543 }
544 
545 /**
546  * vidioc_enum_fmt_vid_cap - return video capture format
547  * @file: descriptor of device
548  * @priv: unused
549  * @f: returned format information
550  *
551  * returns name and format of video capture
552  * Only UYVY is supported by hardware.
553  *
554  * return value: always 0.
555  */
556 static int vidioc_enum_fmt_vid_cap(struct file *file, void *priv,
557 				   struct v4l2_fmtdesc *f)
558 {
559 
560 	if (f->index != 0)
561 		return -EINVAL;
562 
563 	f->pixelformat = V4L2_PIX_FMT_UYVY;
564 	return 0;
565 }
566 
567 /**
568  * vidioc_try_fmt_vid_cap - set video capture format
569  * @file: descriptor of device
570  * @priv: unused
571  * @f: new format
572  *
573  * new video format is set which includes width and
574  * field type. width is fixed to 720, no scaling.
575  * Only UYVY is supported by this hardware.
576  * the minimum height is 200, the maximum is 576 (PAL)
577  *
578  * return value: 0, no error
579  *
580  * -EINVAL, pixel or field format not supported
581  *
582  */
583 static int vidioc_try_fmt_vid_cap(struct file *file, void *priv,
584 				  struct v4l2_format *f)
585 {
586 	struct sta2x11_vip *vip = video_drvdata(file);
587 	int interlace_lim;
588 
589 	if (V4L2_PIX_FMT_UYVY != f->fmt.pix.pixelformat) {
590 		v4l2_warn(&vip->v4l2_dev, "Invalid format, only UYVY supported\n");
591 		return -EINVAL;
592 	}
593 
594 	if (V4L2_STD_525_60 & vip->std)
595 		interlace_lim = 240;
596 	else
597 		interlace_lim = 288;
598 
599 	switch (f->fmt.pix.field) {
600 	default:
601 	case V4L2_FIELD_ANY:
602 		if (interlace_lim < f->fmt.pix.height)
603 			f->fmt.pix.field = V4L2_FIELD_INTERLACED;
604 		else
605 			f->fmt.pix.field = V4L2_FIELD_BOTTOM;
606 		break;
607 	case V4L2_FIELD_TOP:
608 	case V4L2_FIELD_BOTTOM:
609 		if (interlace_lim < f->fmt.pix.height)
610 			f->fmt.pix.height = interlace_lim;
611 		break;
612 	case V4L2_FIELD_INTERLACED:
613 		break;
614 	}
615 
616 	/* It is the only supported format */
617 	f->fmt.pix.pixelformat = V4L2_PIX_FMT_UYVY;
618 	f->fmt.pix.height &= ~1;
619 	if (2 * interlace_lim < f->fmt.pix.height)
620 		f->fmt.pix.height = 2 * interlace_lim;
621 	if (200 > f->fmt.pix.height)
622 		f->fmt.pix.height = 200;
623 	f->fmt.pix.width = 720;
624 	f->fmt.pix.bytesperline = f->fmt.pix.width * 2;
625 	f->fmt.pix.sizeimage = f->fmt.pix.width * 2 * f->fmt.pix.height;
626 	f->fmt.pix.colorspace = V4L2_COLORSPACE_SMPTE170M;
627 	return 0;
628 }
629 
630 /**
631  * vidioc_s_fmt_vid_cap - set current video format parameters
632  * @file: descriptor of device
633  * @priv: unused
634  * @f: returned format information
635  *
636  * set new capture format
637  * return value: 0, no error
638  *
639  * other, delivered by video DAC routine.
640  */
641 static int vidioc_s_fmt_vid_cap(struct file *file, void *priv,
642 				struct v4l2_format *f)
643 {
644 	struct sta2x11_vip *vip = video_drvdata(file);
645 	unsigned int t_stop, b_stop, pitch;
646 	int ret;
647 
648 	ret = vidioc_try_fmt_vid_cap(file, priv, f);
649 	if (ret)
650 		return ret;
651 
652 	if (vb2_is_busy(&vip->vb_vidq)) {
653 		/* Can't change format during acquisition */
654 		v4l2_err(&vip->v4l2_dev, "device busy\n");
655 		return -EBUSY;
656 	}
657 	vip->format = f->fmt.pix;
658 	switch (vip->format.field) {
659 	case V4L2_FIELD_INTERLACED:
660 		t_stop = ((vip->format.height / 2 - 1) << 16) |
661 			 (2 * vip->format.width - 1);
662 		b_stop = t_stop;
663 		pitch = 4 * vip->format.width;
664 		break;
665 	case V4L2_FIELD_TOP:
666 		t_stop = ((vip->format.height - 1) << 16) |
667 			 (2 * vip->format.width - 1);
668 		b_stop = (0 << 16) | (2 * vip->format.width - 1);
669 		pitch = 2 * vip->format.width;
670 		break;
671 	case V4L2_FIELD_BOTTOM:
672 		t_stop = (0 << 16) | (2 * vip->format.width - 1);
673 		b_stop = (vip->format.height << 16) |
674 			 (2 * vip->format.width - 1);
675 		pitch = 2 * vip->format.width;
676 		break;
677 	default:
678 		v4l2_err(&vip->v4l2_dev, "unknown field format\n");
679 		return -EINVAL;
680 	}
681 
682 	spin_lock_irq(&vip->slock);
683 	/* Y-X Top Field Offset */
684 	reg_write(vip, DVP_TFO, 0);
685 	/* Y-X Bottom Field Offset */
686 	reg_write(vip, DVP_BFO, 0);
687 	/* Y-X Top Field Stop*/
688 	reg_write(vip, DVP_TFS, t_stop);
689 	/* Y-X Bottom Field Stop */
690 	reg_write(vip, DVP_BFS, b_stop);
691 	/* Video Memory Pitch */
692 	reg_write(vip, DVP_VMP, pitch);
693 	spin_unlock_irq(&vip->slock);
694 
695 	return 0;
696 }
697 
698 /**
699  * vidioc_g_fmt_vid_cap - get current video format parameters
700  * @file: descriptor of device
701  * @priv: unused
702  * @f: contains format information
703  *
704  * returns current video format parameters
705  *
706  * return value: 0, always successful
707  */
708 static int vidioc_g_fmt_vid_cap(struct file *file, void *priv,
709 				struct v4l2_format *f)
710 {
711 	struct sta2x11_vip *vip = video_drvdata(file);
712 
713 	f->fmt.pix = vip->format;
714 
715 	return 0;
716 }
717 
718 static const struct v4l2_ioctl_ops vip_ioctl_ops = {
719 	.vidioc_querycap = vidioc_querycap,
720 	/* FMT handling */
721 	.vidioc_enum_fmt_vid_cap = vidioc_enum_fmt_vid_cap,
722 	.vidioc_g_fmt_vid_cap = vidioc_g_fmt_vid_cap,
723 	.vidioc_s_fmt_vid_cap = vidioc_s_fmt_vid_cap,
724 	.vidioc_try_fmt_vid_cap = vidioc_try_fmt_vid_cap,
725 	/* Buffer handlers */
726 	.vidioc_create_bufs = vb2_ioctl_create_bufs,
727 	.vidioc_prepare_buf = vb2_ioctl_prepare_buf,
728 	.vidioc_reqbufs = vb2_ioctl_reqbufs,
729 	.vidioc_querybuf = vb2_ioctl_querybuf,
730 	.vidioc_qbuf = vb2_ioctl_qbuf,
731 	.vidioc_dqbuf = vb2_ioctl_dqbuf,
732 	/* Stream on/off */
733 	.vidioc_streamon = vb2_ioctl_streamon,
734 	.vidioc_streamoff = vb2_ioctl_streamoff,
735 	/* Standard handling */
736 	.vidioc_g_std = vidioc_g_std,
737 	.vidioc_s_std = vidioc_s_std,
738 	.vidioc_querystd = vidioc_querystd,
739 	/* Input handling */
740 	.vidioc_enum_input = vidioc_enum_input,
741 	.vidioc_g_input = vidioc_g_input,
742 	.vidioc_s_input = vidioc_s_input,
743 	/* Log status ioctl */
744 	.vidioc_log_status = v4l2_ctrl_log_status,
745 	/* Event handling */
746 	.vidioc_subscribe_event = v4l2_ctrl_subscribe_event,
747 	.vidioc_unsubscribe_event = v4l2_event_unsubscribe,
748 };
749 
750 static const struct video_device video_dev_template = {
751 	.name = KBUILD_MODNAME,
752 	.release = video_device_release_empty,
753 	.fops = &vip_fops,
754 	.ioctl_ops = &vip_ioctl_ops,
755 	.tvnorms = V4L2_STD_ALL,
756 	.device_caps = V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_READWRITE |
757 		       V4L2_CAP_STREAMING,
758 };
759 
760 /**
761  * vip_irq - interrupt routine
762  * @irq: Number of interrupt ( not used, correct number is assumed )
763  * @vip: local data structure containing all information
764  *
765  * check for both frame interrupts set ( top and bottom ).
766  * check FIFO overflow, but limit number of log messages after open.
767  * signal a complete buffer if done
768  *
769  * return value: IRQ_NONE, interrupt was not generated by VIP
770  *
771  * IRQ_HANDLED, interrupt done.
772  */
773 static irqreturn_t vip_irq(int irq, struct sta2x11_vip *vip)
774 {
775 	unsigned int status;
776 
777 	status = reg_read(vip, DVP_ITS);
778 
779 	if (!status)		/* No interrupt to handle */
780 		return IRQ_NONE;
781 
782 	if (status & DVP_IT_FIFO)
783 		if (vip->overflow++ > 5)
784 			pr_info("VIP: fifo overflow\n");
785 
786 	if ((status & DVP_IT_VST) && (status & DVP_IT_VSB)) {
787 		/* this is bad, we are too slow, hope the condition is gone
788 		 * on the next frame */
789 		return IRQ_HANDLED;
790 	}
791 
792 	if (status & DVP_IT_VST)
793 		if ((++vip->tcount) < 2)
794 			return IRQ_HANDLED;
795 	if (status & DVP_IT_VSB) {
796 		vip->bcount++;
797 		return IRQ_HANDLED;
798 	}
799 
800 	if (vip->active) { /* Acquisition is over on this buffer */
801 		/* Disable acquisition */
802 		reg_write(vip, DVP_CTL, reg_read(vip, DVP_CTL) & ~DVP_CTL_ENA);
803 		/* Remove the active buffer from the list */
804 		vip->active->vb.vb2_buf.timestamp = ktime_get_ns();
805 		vip->active->vb.sequence = vip->sequence++;
806 		vb2_buffer_done(&vip->active->vb.vb2_buf, VB2_BUF_STATE_DONE);
807 	}
808 
809 	return IRQ_HANDLED;
810 }
811 
812 static void sta2x11_vip_init_register(struct sta2x11_vip *vip)
813 {
814 	/* Register initialization */
815 	spin_lock_irq(&vip->slock);
816 	/* Clean interrupt */
817 	reg_read(vip, DVP_ITS);
818 	/* Enable Half Line per vertical */
819 	reg_write(vip, DVP_HLFLN, DVP_HLFLN_SD);
820 	/* Reset VIP control */
821 	reg_write(vip, DVP_CTL, DVP_CTL_RST);
822 	/* Clear VIP control */
823 	reg_write(vip, DVP_CTL, 0);
824 	spin_unlock_irq(&vip->slock);
825 }
826 static void sta2x11_vip_clear_register(struct sta2x11_vip *vip)
827 {
828 	spin_lock_irq(&vip->slock);
829 	/* Disable interrupt */
830 	reg_write(vip, DVP_ITM, 0);
831 	/* Reset VIP Control */
832 	reg_write(vip, DVP_CTL, DVP_CTL_RST);
833 	/* Clear VIP Control */
834 	reg_write(vip, DVP_CTL, 0);
835 	/* Clean VIP Interrupt */
836 	reg_read(vip, DVP_ITS);
837 	spin_unlock_irq(&vip->slock);
838 }
839 static int sta2x11_vip_init_buffer(struct sta2x11_vip *vip)
840 {
841 	int err;
842 
843 	err = dma_set_coherent_mask(&vip->pdev->dev, DMA_BIT_MASK(29));
844 	if (err) {
845 		v4l2_err(&vip->v4l2_dev, "Cannot configure coherent mask");
846 		return err;
847 	}
848 	memset(&vip->vb_vidq, 0, sizeof(struct vb2_queue));
849 	vip->vb_vidq.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
850 	vip->vb_vidq.io_modes = VB2_MMAP | VB2_READ;
851 	vip->vb_vidq.drv_priv = vip;
852 	vip->vb_vidq.buf_struct_size = sizeof(struct vip_buffer);
853 	vip->vb_vidq.ops = &vip_video_qops;
854 	vip->vb_vidq.mem_ops = &vb2_dma_contig_memops;
855 	vip->vb_vidq.timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC;
856 	vip->vb_vidq.dev = &vip->pdev->dev;
857 	vip->vb_vidq.lock = &vip->v4l_lock;
858 	err = vb2_queue_init(&vip->vb_vidq);
859 	if (err)
860 		return err;
861 	INIT_LIST_HEAD(&vip->buffer_list);
862 	spin_lock_init(&vip->lock);
863 	return 0;
864 }
865 
866 static int sta2x11_vip_init_controls(struct sta2x11_vip *vip)
867 {
868 	/*
869 	 * Inititialize an empty control so VIP can inerithing controls
870 	 * from ADV7180
871 	 */
872 	v4l2_ctrl_handler_init(&vip->ctrl_hdl, 0);
873 
874 	vip->v4l2_dev.ctrl_handler = &vip->ctrl_hdl;
875 	if (vip->ctrl_hdl.error) {
876 		int err = vip->ctrl_hdl.error;
877 
878 		v4l2_ctrl_handler_free(&vip->ctrl_hdl);
879 		return err;
880 	}
881 
882 	return 0;
883 }
884 
885 /**
886  * vip_gpio_reserve - reserve gpio pin
887  * @dev: device
888  * @pin: GPIO pin number
889  * @dir: direction, input or output
890  * @name: GPIO pin name
891  *
892  */
893 static int vip_gpio_reserve(struct device *dev, int pin, int dir,
894 			    const char *name)
895 {
896 	int ret = -ENODEV;
897 
898 	if (!gpio_is_valid(pin))
899 		return ret;
900 
901 	ret = gpio_request(pin, name);
902 	if (ret) {
903 		dev_err(dev, "Failed to allocate pin %d (%s)\n", pin, name);
904 		return ret;
905 	}
906 
907 	ret = gpio_direction_output(pin, dir);
908 	if (ret) {
909 		dev_err(dev, "Failed to set direction for pin %d (%s)\n",
910 			pin, name);
911 		gpio_free(pin);
912 		return ret;
913 	}
914 
915 	ret = gpio_export(pin, false);
916 	if (ret) {
917 		dev_err(dev, "Failed to export pin %d (%s)\n", pin, name);
918 		gpio_free(pin);
919 		return ret;
920 	}
921 
922 	return 0;
923 }
924 
925 /**
926  * vip_gpio_release - release gpio pin
927  * @dev: device
928  * @pin: GPIO pin number
929  * @name: GPIO pin name
930  *
931  */
932 static void vip_gpio_release(struct device *dev, int pin, const char *name)
933 {
934 	if (gpio_is_valid(pin)) {
935 		dev_dbg(dev, "releasing pin %d (%s)\n",	pin, name);
936 		gpio_unexport(pin);
937 		gpio_free(pin);
938 	}
939 }
940 
941 /**
942  * sta2x11_vip_init_one - init one instance of video device
943  * @pdev: PCI device
944  * @ent: (not used)
945  *
946  * allocate reset pins for DAC.
947  * Reset video DAC, this is done via reset line.
948  * allocate memory for managing device
949  * request interrupt
950  * map IO region
951  * register device
952  * find and initialize video DAC
953  *
954  * return value: 0, no error
955  *
956  * -ENOMEM, no memory
957  *
958  * -ENODEV, device could not be detected or registered
959  */
960 static int sta2x11_vip_init_one(struct pci_dev *pdev,
961 				const struct pci_device_id *ent)
962 {
963 	int ret;
964 	struct sta2x11_vip *vip;
965 	struct vip_config *config;
966 
967 	/* Check if hardware support 26-bit DMA */
968 	if (dma_set_mask(&pdev->dev, DMA_BIT_MASK(26))) {
969 		dev_err(&pdev->dev, "26-bit DMA addressing not available\n");
970 		return -EINVAL;
971 	}
972 	/* Enable PCI */
973 	ret = pci_enable_device(pdev);
974 	if (ret)
975 		return ret;
976 
977 	/* Get VIP platform data */
978 	config = dev_get_platdata(&pdev->dev);
979 	if (!config) {
980 		dev_info(&pdev->dev, "VIP slot disabled\n");
981 		ret = -EINVAL;
982 		goto disable;
983 	}
984 
985 	/* Power configuration */
986 	ret = vip_gpio_reserve(&pdev->dev, config->pwr_pin, 0,
987 			       config->pwr_name);
988 	if (ret)
989 		goto disable;
990 
991 	ret = vip_gpio_reserve(&pdev->dev, config->reset_pin, 0,
992 			       config->reset_name);
993 	if (ret) {
994 		vip_gpio_release(&pdev->dev, config->pwr_pin,
995 				 config->pwr_name);
996 		goto disable;
997 	}
998 
999 	if (gpio_is_valid(config->pwr_pin)) {
1000 		/* Datasheet says 5ms between PWR and RST */
1001 		usleep_range(5000, 25000);
1002 		gpio_direction_output(config->pwr_pin, 1);
1003 	}
1004 
1005 	if (gpio_is_valid(config->reset_pin)) {
1006 		/* Datasheet says 5ms between PWR and RST */
1007 		usleep_range(5000, 25000);
1008 		gpio_direction_output(config->reset_pin, 1);
1009 	}
1010 	usleep_range(5000, 25000);
1011 
1012 	/* Allocate a new VIP instance */
1013 	vip = kzalloc(sizeof(struct sta2x11_vip), GFP_KERNEL);
1014 	if (!vip) {
1015 		ret = -ENOMEM;
1016 		goto release_gpios;
1017 	}
1018 	vip->pdev = pdev;
1019 	vip->std = V4L2_STD_PAL;
1020 	vip->format = formats_50[0];
1021 	vip->config = config;
1022 	mutex_init(&vip->v4l_lock);
1023 
1024 	ret = sta2x11_vip_init_controls(vip);
1025 	if (ret)
1026 		goto free_mem;
1027 	ret = v4l2_device_register(&pdev->dev, &vip->v4l2_dev);
1028 	if (ret)
1029 		goto free_mem;
1030 
1031 	dev_dbg(&pdev->dev, "BAR #0 at 0x%lx 0x%lx irq %d\n",
1032 		(unsigned long)pci_resource_start(pdev, 0),
1033 		(unsigned long)pci_resource_len(pdev, 0), pdev->irq);
1034 
1035 	pci_set_master(pdev);
1036 
1037 	ret = pci_request_regions(pdev, KBUILD_MODNAME);
1038 	if (ret)
1039 		goto unreg;
1040 
1041 	vip->iomem = pci_iomap(pdev, 0, 0x100);
1042 	if (!vip->iomem) {
1043 		ret = -ENOMEM;
1044 		goto release;
1045 	}
1046 
1047 	pci_enable_msi(pdev);
1048 
1049 	/* Initialize buffer */
1050 	ret = sta2x11_vip_init_buffer(vip);
1051 	if (ret)
1052 		goto unmap;
1053 
1054 	spin_lock_init(&vip->slock);
1055 
1056 	ret = request_irq(pdev->irq,
1057 			  (irq_handler_t) vip_irq,
1058 			  IRQF_SHARED, KBUILD_MODNAME, vip);
1059 	if (ret) {
1060 		dev_err(&pdev->dev, "request_irq failed\n");
1061 		ret = -ENODEV;
1062 		goto release_buf;
1063 	}
1064 
1065 	/* Initialize and register video device */
1066 	vip->video_dev = video_dev_template;
1067 	vip->video_dev.v4l2_dev = &vip->v4l2_dev;
1068 	vip->video_dev.queue = &vip->vb_vidq;
1069 	vip->video_dev.lock = &vip->v4l_lock;
1070 	video_set_drvdata(&vip->video_dev, vip);
1071 
1072 	ret = video_register_device(&vip->video_dev, VFL_TYPE_VIDEO, -1);
1073 	if (ret)
1074 		goto vrelease;
1075 
1076 	/* Get ADV7180 subdevice */
1077 	vip->adapter = i2c_get_adapter(vip->config->i2c_id);
1078 	if (!vip->adapter) {
1079 		ret = -ENODEV;
1080 		dev_err(&pdev->dev, "no I2C adapter found\n");
1081 		goto vunreg;
1082 	}
1083 
1084 	vip->decoder = v4l2_i2c_new_subdev(&vip->v4l2_dev, vip->adapter,
1085 					   "adv7180", vip->config->i2c_addr,
1086 					   NULL);
1087 	if (!vip->decoder) {
1088 		ret = -ENODEV;
1089 		dev_err(&pdev->dev, "no decoder found\n");
1090 		goto vunreg;
1091 	}
1092 
1093 	i2c_put_adapter(vip->adapter);
1094 	v4l2_subdev_call(vip->decoder, core, init, 0);
1095 
1096 	sta2x11_vip_init_register(vip);
1097 
1098 	dev_info(&pdev->dev, "STA2X11 Video Input Port (VIP) loaded\n");
1099 	return 0;
1100 
1101 vunreg:
1102 	video_set_drvdata(&vip->video_dev, NULL);
1103 vrelease:
1104 	vb2_video_unregister_device(&vip->video_dev);
1105 	free_irq(pdev->irq, vip);
1106 release_buf:
1107 	pci_disable_msi(pdev);
1108 unmap:
1109 	pci_iounmap(pdev, vip->iomem);
1110 release:
1111 	pci_release_regions(pdev);
1112 unreg:
1113 	v4l2_device_unregister(&vip->v4l2_dev);
1114 free_mem:
1115 	kfree(vip);
1116 release_gpios:
1117 	vip_gpio_release(&pdev->dev, config->reset_pin, config->reset_name);
1118 	vip_gpio_release(&pdev->dev, config->pwr_pin, config->pwr_name);
1119 disable:
1120 	/*
1121 	 * do not call pci_disable_device on sta2x11 because it break all
1122 	 * other Bus masters on this EP
1123 	 */
1124 	return ret;
1125 }
1126 
1127 /**
1128  * sta2x11_vip_remove_one - release device
1129  * @pdev: PCI device
1130  *
1131  * Undo everything done in .._init_one
1132  *
1133  * unregister video device
1134  * free interrupt
1135  * unmap ioadresses
1136  * free memory
1137  * free GPIO pins
1138  */
1139 static void sta2x11_vip_remove_one(struct pci_dev *pdev)
1140 {
1141 	struct v4l2_device *v4l2_dev = pci_get_drvdata(pdev);
1142 	struct sta2x11_vip *vip =
1143 	    container_of(v4l2_dev, struct sta2x11_vip, v4l2_dev);
1144 
1145 	sta2x11_vip_clear_register(vip);
1146 
1147 	video_set_drvdata(&vip->video_dev, NULL);
1148 	vb2_video_unregister_device(&vip->video_dev);
1149 	free_irq(pdev->irq, vip);
1150 	pci_disable_msi(pdev);
1151 	pci_iounmap(pdev, vip->iomem);
1152 	pci_release_regions(pdev);
1153 
1154 	v4l2_device_unregister(&vip->v4l2_dev);
1155 
1156 	vip_gpio_release(&pdev->dev, vip->config->pwr_pin,
1157 			 vip->config->pwr_name);
1158 	vip_gpio_release(&pdev->dev, vip->config->reset_pin,
1159 			 vip->config->reset_name);
1160 
1161 	kfree(vip);
1162 	/*
1163 	 * do not call pci_disable_device on sta2x11 because it break all
1164 	 * other Bus masters on this EP
1165 	 */
1166 }
1167 
1168 /**
1169  * sta2x11_vip_suspend - set device into power save mode
1170  * @dev_d: PCI device
1171  *
1172  * all relevant registers are saved and an attempt to set a new state is made.
1173  *
1174  * return value: 0 always indicate success,
1175  * even if device could not be disabled. (workaround for hardware problem)
1176  */
1177 static int __maybe_unused sta2x11_vip_suspend(struct device *dev_d)
1178 {
1179 	struct v4l2_device *v4l2_dev = dev_get_drvdata(dev_d);
1180 	struct sta2x11_vip *vip =
1181 	    container_of(v4l2_dev, struct sta2x11_vip, v4l2_dev);
1182 	unsigned long flags;
1183 	int i;
1184 
1185 	spin_lock_irqsave(&vip->slock, flags);
1186 	vip->register_save_area[0] = reg_read(vip, DVP_CTL);
1187 	reg_write(vip, DVP_CTL, vip->register_save_area[0] & DVP_CTL_DIS);
1188 	vip->register_save_area[SAVE_COUNT] = reg_read(vip, DVP_ITM);
1189 	reg_write(vip, DVP_ITM, 0);
1190 	for (i = 1; i < SAVE_COUNT; i++)
1191 		vip->register_save_area[i] = reg_read(vip, 4 * i);
1192 	for (i = 0; i < AUX_COUNT; i++)
1193 		vip->register_save_area[SAVE_COUNT + IRQ_COUNT + i] =
1194 		    reg_read(vip, registers_to_save[i]);
1195 	spin_unlock_irqrestore(&vip->slock, flags);
1196 
1197 	vip->disabled = 1;
1198 
1199 	pr_info("VIP: suspend\n");
1200 	return 0;
1201 }
1202 
1203 /**
1204  * sta2x11_vip_resume - resume device operation
1205  * @dev_d : PCI device
1206  *
1207  * return value: 0, no error.
1208  *
1209  * other, could not set device to power on state.
1210  */
1211 static int __maybe_unused sta2x11_vip_resume(struct device *dev_d)
1212 {
1213 	struct v4l2_device *v4l2_dev = dev_get_drvdata(dev_d);
1214 	struct sta2x11_vip *vip =
1215 	    container_of(v4l2_dev, struct sta2x11_vip, v4l2_dev);
1216 	unsigned long flags;
1217 	int i;
1218 
1219 	pr_info("VIP: resume\n");
1220 
1221 	vip->disabled = 0;
1222 
1223 	spin_lock_irqsave(&vip->slock, flags);
1224 	for (i = 1; i < SAVE_COUNT; i++)
1225 		reg_write(vip, 4 * i, vip->register_save_area[i]);
1226 	for (i = 0; i < AUX_COUNT; i++)
1227 		reg_write(vip, registers_to_save[i],
1228 			  vip->register_save_area[SAVE_COUNT + IRQ_COUNT + i]);
1229 	reg_write(vip, DVP_CTL, vip->register_save_area[0]);
1230 	reg_write(vip, DVP_ITM, vip->register_save_area[SAVE_COUNT]);
1231 	spin_unlock_irqrestore(&vip->slock, flags);
1232 	return 0;
1233 }
1234 
1235 static const struct pci_device_id sta2x11_vip_pci_tbl[] = {
1236 	{PCI_DEVICE(PCI_VENDOR_ID_STMICRO, PCI_DEVICE_ID_STMICRO_VIP)},
1237 	{0,}
1238 };
1239 
1240 static SIMPLE_DEV_PM_OPS(sta2x11_vip_pm_ops,
1241 			 sta2x11_vip_suspend,
1242 			 sta2x11_vip_resume);
1243 
1244 static struct pci_driver sta2x11_vip_driver = {
1245 	.name = KBUILD_MODNAME,
1246 	.probe = sta2x11_vip_init_one,
1247 	.remove = sta2x11_vip_remove_one,
1248 	.id_table = sta2x11_vip_pci_tbl,
1249 	.driver.pm = &sta2x11_vip_pm_ops,
1250 };
1251 
1252 static int __init sta2x11_vip_init_module(void)
1253 {
1254 	return pci_register_driver(&sta2x11_vip_driver);
1255 }
1256 
1257 static void __exit sta2x11_vip_exit_module(void)
1258 {
1259 	pci_unregister_driver(&sta2x11_vip_driver);
1260 }
1261 
1262 #ifdef MODULE
1263 module_init(sta2x11_vip_init_module);
1264 module_exit(sta2x11_vip_exit_module);
1265 #else
1266 late_initcall_sync(sta2x11_vip_init_module);
1267 #endif
1268 
1269 MODULE_DESCRIPTION("STA2X11 Video Input Port driver");
1270 MODULE_AUTHOR("Wind River");
1271 MODULE_LICENSE("GPL v2");
1272 MODULE_SUPPORTED_DEVICE("sta2x11 video input");
1273 MODULE_VERSION(DRV_VERSION);
1274 MODULE_DEVICE_TABLE(pci, sta2x11_vip_pci_tbl);
1275