V4L/DVB (10544): v4l2-common: add comments warning that about the sort order
[linux-3.10.git] / drivers / media / video / saa7134 / saa7134-empress.c
1 /*
2  *
3  * (c) 2004 Gerd Knorr <kraxel@bytesex.org> [SuSE Labs]
4  *
5  *  This program is free software; you can redistribute it and/or modify
6  *  it under the terms of the GNU General Public License as published by
7  *  the Free Software Foundation; either version 2 of the License, or
8  *  (at your option) any later version.
9  *
10  *  This program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *  GNU General Public License for more details.
14  *
15  *  You should have received a copy of the GNU General Public License
16  *  along with this program; if not, write to the Free Software
17  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18  */
19
20 #include <linux/init.h>
21 #include <linux/list.h>
22 #include <linux/module.h>
23 #include <linux/kernel.h>
24 #include <linux/slab.h>
25 #include <linux/delay.h>
26
27 #include "saa7134-reg.h"
28 #include "saa7134.h"
29
30 #include <media/saa6752hs.h>
31 #include <media/v4l2-common.h>
32 #include <media/v4l2-chip-ident.h>
33
34 /* ------------------------------------------------------------------ */
35
36 MODULE_AUTHOR("Gerd Knorr <kraxel@bytesex.org> [SuSE Labs]");
37 MODULE_LICENSE("GPL");
38
39 static unsigned int empress_nr[] = {[0 ... (SAA7134_MAXBOARDS - 1)] = UNSET };
40
41 module_param_array(empress_nr, int, NULL, 0444);
42 MODULE_PARM_DESC(empress_nr,"ts device number");
43
44 static unsigned int debug;
45 module_param(debug, int, 0644);
46 MODULE_PARM_DESC(debug,"enable debug messages");
47
48 #define dprintk(fmt, arg...)    if (debug)                      \
49         printk(KERN_DEBUG "%s/empress: " fmt, dev->name , ## arg)
50
51 /* ------------------------------------------------------------------ */
52
53 static void ts_reset_encoder(struct saa7134_dev* dev)
54 {
55         if (!dev->empress_started)
56                 return;
57
58         saa_writeb(SAA7134_SPECIAL_MODE, 0x00);
59         msleep(10);
60         saa_writeb(SAA7134_SPECIAL_MODE, 0x01);
61         msleep(100);
62         dev->empress_started = 0;
63 }
64
65 static int ts_init_encoder(struct saa7134_dev* dev)
66 {
67         u32 leading_null_bytes = 0;
68
69         /* If more cards start to need this, then this
70            should probably be added to the card definitions. */
71         switch (dev->board) {
72         case SAA7134_BOARD_BEHOLD_M6:
73         case SAA7134_BOARD_BEHOLD_M63:
74         case SAA7134_BOARD_BEHOLD_M6_EXTRA:
75                 leading_null_bytes = 1;
76                 break;
77         }
78         ts_reset_encoder(dev);
79         saa_call_all(dev, core, init, leading_null_bytes);
80         dev->empress_started = 1;
81         return 0;
82 }
83
84 /* ------------------------------------------------------------------ */
85
86 static int ts_open(struct file *file)
87 {
88         int minor = video_devdata(file)->minor;
89         struct saa7134_dev *dev;
90         int err;
91
92         lock_kernel();
93         list_for_each_entry(dev, &saa7134_devlist, devlist)
94                 if (dev->empress_dev && dev->empress_dev->minor == minor)
95                         goto found;
96         unlock_kernel();
97         return -ENODEV;
98  found:
99
100         dprintk("open minor=%d\n",minor);
101         err = -EBUSY;
102         if (!mutex_trylock(&dev->empress_tsq.vb_lock))
103                 goto done;
104         if (atomic_read(&dev->empress_users))
105                 goto done_up;
106
107         /* Unmute audio */
108         saa_writeb(SAA7134_AUDIO_MUTE_CTRL,
109                 saa_readb(SAA7134_AUDIO_MUTE_CTRL) & ~(1 << 6));
110
111         atomic_inc(&dev->empress_users);
112         file->private_data = dev;
113         err = 0;
114
115 done_up:
116         mutex_unlock(&dev->empress_tsq.vb_lock);
117 done:
118         unlock_kernel();
119         return err;
120 }
121
122 static int ts_release(struct file *file)
123 {
124         struct saa7134_dev *dev = file->private_data;
125
126         videobuf_stop(&dev->empress_tsq);
127         videobuf_mmap_free(&dev->empress_tsq);
128
129         /* stop the encoder */
130         ts_reset_encoder(dev);
131
132         /* Mute audio */
133         saa_writeb(SAA7134_AUDIO_MUTE_CTRL,
134                 saa_readb(SAA7134_AUDIO_MUTE_CTRL) | (1 << 6));
135
136         atomic_dec(&dev->empress_users);
137
138         return 0;
139 }
140
141 static ssize_t
142 ts_read(struct file *file, char __user *data, size_t count, loff_t *ppos)
143 {
144         struct saa7134_dev *dev = file->private_data;
145
146         if (!dev->empress_started)
147                 ts_init_encoder(dev);
148
149         return videobuf_read_stream(&dev->empress_tsq,
150                                     data, count, ppos, 0,
151                                     file->f_flags & O_NONBLOCK);
152 }
153
154 static unsigned int
155 ts_poll(struct file *file, struct poll_table_struct *wait)
156 {
157         struct saa7134_dev *dev = file->private_data;
158
159         return videobuf_poll_stream(file, &dev->empress_tsq, wait);
160 }
161
162
163 static int
164 ts_mmap(struct file *file, struct vm_area_struct * vma)
165 {
166         struct saa7134_dev *dev = file->private_data;
167
168         return videobuf_mmap_mapper(&dev->empress_tsq, vma);
169 }
170
171 /*
172  * This function is _not_ called directly, but from
173  * video_generic_ioctl (and maybe others).  userspace
174  * copying is done already, arg is a kernel pointer.
175  */
176
177 static int empress_querycap(struct file *file, void  *priv,
178                                         struct v4l2_capability *cap)
179 {
180         struct saa7134_dev *dev = file->private_data;
181
182         strcpy(cap->driver, "saa7134");
183         strlcpy(cap->card, saa7134_boards[dev->board].name,
184                 sizeof(cap->card));
185         sprintf(cap->bus_info, "PCI:%s", pci_name(dev->pci));
186         cap->version = SAA7134_VERSION_CODE;
187         cap->capabilities =
188                 V4L2_CAP_VIDEO_CAPTURE |
189                 V4L2_CAP_READWRITE |
190                 V4L2_CAP_STREAMING;
191         return 0;
192 }
193
194 static int empress_enum_input(struct file *file, void *priv,
195                                         struct v4l2_input *i)
196 {
197         if (i->index != 0)
198                 return -EINVAL;
199
200         i->type = V4L2_INPUT_TYPE_CAMERA;
201         strcpy(i->name, "CCIR656");
202
203         return 0;
204 }
205
206 static int empress_g_input(struct file *file, void *priv, unsigned int *i)
207 {
208         *i = 0;
209         return 0;
210 }
211
212 static int empress_s_input(struct file *file, void *priv, unsigned int i)
213 {
214         if (i != 0)
215                 return -EINVAL;
216
217         return 0;
218 }
219
220 static int empress_enum_fmt_vid_cap(struct file *file, void  *priv,
221                                         struct v4l2_fmtdesc *f)
222 {
223         if (f->index != 0)
224                 return -EINVAL;
225
226         strlcpy(f->description, "MPEG TS", sizeof(f->description));
227         f->pixelformat = V4L2_PIX_FMT_MPEG;
228
229         return 0;
230 }
231
232 static int empress_g_fmt_vid_cap(struct file *file, void *priv,
233                                 struct v4l2_format *f)
234 {
235         struct saa7134_dev *dev = file->private_data;
236
237         saa_call_all(dev, video, g_fmt, f);
238
239         f->fmt.pix.pixelformat  = V4L2_PIX_FMT_MPEG;
240         f->fmt.pix.sizeimage    = TS_PACKET_SIZE * dev->ts.nr_packets;
241
242         return 0;
243 }
244
245 static int empress_s_fmt_vid_cap(struct file *file, void *priv,
246                                 struct v4l2_format *f)
247 {
248         struct saa7134_dev *dev = file->private_data;
249
250         saa_call_all(dev, video, s_fmt, f);
251
252         f->fmt.pix.pixelformat  = V4L2_PIX_FMT_MPEG;
253         f->fmt.pix.sizeimage    = TS_PACKET_SIZE * dev->ts.nr_packets;
254
255         return 0;
256 }
257
258
259 static int empress_reqbufs(struct file *file, void *priv,
260                                         struct v4l2_requestbuffers *p)
261 {
262         struct saa7134_dev *dev = file->private_data;
263
264         return videobuf_reqbufs(&dev->empress_tsq, p);
265 }
266
267 static int empress_querybuf(struct file *file, void *priv,
268                                         struct v4l2_buffer *b)
269 {
270         struct saa7134_dev *dev = file->private_data;
271
272         return videobuf_querybuf(&dev->empress_tsq, b);
273 }
274
275 static int empress_qbuf(struct file *file, void *priv, struct v4l2_buffer *b)
276 {
277         struct saa7134_dev *dev = file->private_data;
278
279         return videobuf_qbuf(&dev->empress_tsq, b);
280 }
281
282 static int empress_dqbuf(struct file *file, void *priv, struct v4l2_buffer *b)
283 {
284         struct saa7134_dev *dev = file->private_data;
285
286         return videobuf_dqbuf(&dev->empress_tsq, b,
287                                 file->f_flags & O_NONBLOCK);
288 }
289
290 static int empress_streamon(struct file *file, void *priv,
291                                         enum v4l2_buf_type type)
292 {
293         struct saa7134_dev *dev = file->private_data;
294
295         return videobuf_streamon(&dev->empress_tsq);
296 }
297
298 static int empress_streamoff(struct file *file, void *priv,
299                                         enum v4l2_buf_type type)
300 {
301         struct saa7134_dev *dev = file->private_data;
302
303         return videobuf_streamoff(&dev->empress_tsq);
304 }
305
306 static int empress_s_ext_ctrls(struct file *file, void *priv,
307                                struct v4l2_ext_controls *ctrls)
308 {
309         struct saa7134_dev *dev = file->private_data;
310         int err;
311
312         /* count == 0 is abused in saa6752hs.c, so that special
313                 case is handled here explicitly. */
314         if (ctrls->count == 0)
315                 return 0;
316
317         if (ctrls->ctrl_class != V4L2_CTRL_CLASS_MPEG)
318                 return -EINVAL;
319
320         err = saa_call_empress(dev, core, s_ext_ctrls, ctrls);
321         ts_init_encoder(dev);
322
323         return err;
324 }
325
326 static int empress_g_ext_ctrls(struct file *file, void *priv,
327                                struct v4l2_ext_controls *ctrls)
328 {
329         struct saa7134_dev *dev = file->private_data;
330
331         if (ctrls->ctrl_class != V4L2_CTRL_CLASS_MPEG)
332                 return -EINVAL;
333         return saa_call_empress(dev, core, g_ext_ctrls, ctrls);
334 }
335
336 static int empress_g_ctrl(struct file *file, void *priv,
337                                         struct v4l2_control *c)
338 {
339         struct saa7134_dev *dev = file->private_data;
340
341         return saa7134_g_ctrl_internal(dev, NULL, c);
342 }
343
344 static int empress_s_ctrl(struct file *file, void *priv,
345                                         struct v4l2_control *c)
346 {
347         struct saa7134_dev *dev = file->private_data;
348
349         return saa7134_s_ctrl_internal(dev, NULL, c);
350 }
351
352 static int empress_queryctrl(struct file *file, void *priv,
353                                         struct v4l2_queryctrl *c)
354 {
355         /* Must be sorted from low to high control ID! */
356         static const u32 user_ctrls[] = {
357                 V4L2_CID_USER_CLASS,
358                 V4L2_CID_BRIGHTNESS,
359                 V4L2_CID_CONTRAST,
360                 V4L2_CID_SATURATION,
361                 V4L2_CID_HUE,
362                 V4L2_CID_AUDIO_VOLUME,
363                 V4L2_CID_AUDIO_MUTE,
364                 V4L2_CID_HFLIP,
365                 0
366         };
367
368         /* Must be sorted from low to high control ID! */
369         static const u32 mpeg_ctrls[] = {
370                 V4L2_CID_MPEG_CLASS,
371                 V4L2_CID_MPEG_STREAM_TYPE,
372                 V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ,
373                 V4L2_CID_MPEG_AUDIO_ENCODING,
374                 V4L2_CID_MPEG_AUDIO_L2_BITRATE,
375                 V4L2_CID_MPEG_VIDEO_ENCODING,
376                 V4L2_CID_MPEG_VIDEO_ASPECT,
377                 V4L2_CID_MPEG_VIDEO_BITRATE_MODE,
378                 V4L2_CID_MPEG_VIDEO_BITRATE,
379                 V4L2_CID_MPEG_VIDEO_BITRATE_PEAK,
380                 0
381         };
382         static const u32 *ctrl_classes[] = {
383                 user_ctrls,
384                 mpeg_ctrls,
385                 NULL
386         };
387         struct saa7134_dev *dev = file->private_data;
388
389         c->id = v4l2_ctrl_next(ctrl_classes, c->id);
390         if (c->id == 0)
391                 return -EINVAL;
392         if (c->id == V4L2_CID_USER_CLASS || c->id == V4L2_CID_MPEG_CLASS)
393                 return v4l2_ctrl_query_fill_std(c);
394         if (V4L2_CTRL_ID2CLASS(c->id) != V4L2_CTRL_CLASS_MPEG)
395                 return saa7134_queryctrl(file, priv, c);
396         return saa_call_empress(dev, core, queryctrl, c);
397 }
398
399 static int empress_querymenu(struct file *file, void *priv,
400                                         struct v4l2_querymenu *c)
401 {
402         struct saa7134_dev *dev = file->private_data;
403
404         if (V4L2_CTRL_ID2CLASS(c->id) != V4L2_CTRL_CLASS_MPEG)
405                 return -EINVAL;
406         return saa_call_empress(dev, core, querymenu, c);
407 }
408
409 static int empress_g_chip_ident(struct file *file, void *fh,
410                struct v4l2_dbg_chip_ident *chip)
411 {
412         struct saa7134_dev *dev = file->private_data;
413
414         chip->ident = V4L2_IDENT_NONE;
415         chip->revision = 0;
416         if (chip->match.type == V4L2_CHIP_MATCH_I2C_DRIVER &&
417             !strcmp(chip->match.name, "saa6752hs"))
418                 return saa_call_empress(dev, core, g_chip_ident, chip);
419         if (chip->match.type == V4L2_CHIP_MATCH_I2C_ADDR &&
420             chip->match.addr == 0x20)
421                 return saa_call_empress(dev, core, g_chip_ident, chip);
422         return -EINVAL;
423 }
424
425 static int empress_s_std(struct file *file, void *priv, v4l2_std_id *id)
426 {
427         struct saa7134_dev *dev = file->private_data;
428
429         return saa7134_s_std_internal(dev, NULL, id);
430 }
431
432 static int empress_g_std(struct file *file, void *priv, v4l2_std_id *id)
433 {
434         struct saa7134_dev *dev = file->private_data;
435
436         *id = dev->tvnorm->id;
437         return 0;
438 }
439
440 static const struct v4l2_file_operations ts_fops =
441 {
442         .owner    = THIS_MODULE,
443         .open     = ts_open,
444         .release  = ts_release,
445         .read     = ts_read,
446         .poll     = ts_poll,
447         .mmap     = ts_mmap,
448         .ioctl    = video_ioctl2,
449 };
450
451 static const struct v4l2_ioctl_ops ts_ioctl_ops = {
452         .vidioc_querycap                = empress_querycap,
453         .vidioc_enum_fmt_vid_cap        = empress_enum_fmt_vid_cap,
454         .vidioc_s_fmt_vid_cap           = empress_s_fmt_vid_cap,
455         .vidioc_g_fmt_vid_cap           = empress_g_fmt_vid_cap,
456         .vidioc_reqbufs                 = empress_reqbufs,
457         .vidioc_querybuf                = empress_querybuf,
458         .vidioc_qbuf                    = empress_qbuf,
459         .vidioc_dqbuf                   = empress_dqbuf,
460         .vidioc_streamon                = empress_streamon,
461         .vidioc_streamoff               = empress_streamoff,
462         .vidioc_s_ext_ctrls             = empress_s_ext_ctrls,
463         .vidioc_g_ext_ctrls             = empress_g_ext_ctrls,
464         .vidioc_enum_input              = empress_enum_input,
465         .vidioc_g_input                 = empress_g_input,
466         .vidioc_s_input                 = empress_s_input,
467         .vidioc_queryctrl               = empress_queryctrl,
468         .vidioc_querymenu               = empress_querymenu,
469         .vidioc_g_ctrl                  = empress_g_ctrl,
470         .vidioc_s_ctrl                  = empress_s_ctrl,
471         .vidioc_g_chip_ident            = empress_g_chip_ident,
472         .vidioc_s_std                   = empress_s_std,
473         .vidioc_g_std                   = empress_g_std,
474 };
475
476 /* ----------------------------------------------------------- */
477
478 static struct video_device saa7134_empress_template = {
479         .name          = "saa7134-empress",
480         .fops          = &ts_fops,
481         .minor         = -1,
482         .ioctl_ops     = &ts_ioctl_ops,
483
484         .tvnorms                        = SAA7134_NORMS,
485         .current_norm                   = V4L2_STD_PAL,
486 };
487
488 static void empress_signal_update(struct work_struct *work)
489 {
490         struct saa7134_dev* dev =
491                 container_of(work, struct saa7134_dev, empress_workqueue);
492
493         if (dev->nosignal) {
494                 dprintk("no video signal\n");
495                 ts_reset_encoder(dev);
496         } else {
497                 dprintk("video signal acquired\n");
498                 if (atomic_read(&dev->empress_users))
499                         ts_init_encoder(dev);
500         }
501 }
502
503 static void empress_signal_change(struct saa7134_dev *dev)
504 {
505         schedule_work(&dev->empress_workqueue);
506 }
507
508
509 static int empress_init(struct saa7134_dev *dev)
510 {
511         int err;
512
513         dprintk("%s: %s\n",dev->name,__func__);
514         dev->empress_dev = video_device_alloc();
515         if (NULL == dev->empress_dev)
516                 return -ENOMEM;
517         *(dev->empress_dev) = saa7134_empress_template;
518         dev->empress_dev->parent  = &dev->pci->dev;
519         dev->empress_dev->release = video_device_release;
520         snprintf(dev->empress_dev->name, sizeof(dev->empress_dev->name),
521                  "%s empress (%s)", dev->name,
522                  saa7134_boards[dev->board].name);
523
524         INIT_WORK(&dev->empress_workqueue, empress_signal_update);
525
526         err = video_register_device(dev->empress_dev,VFL_TYPE_GRABBER,
527                                     empress_nr[dev->nr]);
528         if (err < 0) {
529                 printk(KERN_INFO "%s: can't register video device\n",
530                        dev->name);
531                 video_device_release(dev->empress_dev);
532                 dev->empress_dev = NULL;
533                 return err;
534         }
535         printk(KERN_INFO "%s: registered device video%d [mpeg]\n",
536                dev->name, dev->empress_dev->num);
537
538         videobuf_queue_sg_init(&dev->empress_tsq, &saa7134_ts_qops,
539                             &dev->pci->dev, &dev->slock,
540                             V4L2_BUF_TYPE_VIDEO_CAPTURE,
541                             V4L2_FIELD_ALTERNATE,
542                             sizeof(struct saa7134_buf),
543                             dev);
544
545         empress_signal_update(&dev->empress_workqueue);
546         return 0;
547 }
548
549 static int empress_fini(struct saa7134_dev *dev)
550 {
551         dprintk("%s: %s\n",dev->name,__func__);
552
553         if (NULL == dev->empress_dev)
554                 return 0;
555         flush_scheduled_work();
556         video_unregister_device(dev->empress_dev);
557         dev->empress_dev = NULL;
558         return 0;
559 }
560
561 static struct saa7134_mpeg_ops empress_ops = {
562         .type          = SAA7134_MPEG_EMPRESS,
563         .init          = empress_init,
564         .fini          = empress_fini,
565         .signal_change = empress_signal_change,
566 };
567
568 static int __init empress_register(void)
569 {
570         return saa7134_ts_register(&empress_ops);
571 }
572
573 static void __exit empress_unregister(void)
574 {
575         saa7134_ts_unregister(&empress_ops);
576 }
577
578 module_init(empress_register);
579 module_exit(empress_unregister);
580
581 /* ----------------------------------------------------------- */
582 /*
583  * Local variables:
584  * c-basic-offset: 8
585  * End:
586  */