drivers/staging/tm6000/tm6000.h

   1 /*
   2  *  tm6000.h - driver for TM5600/TM6000/TM6010 USB video capture devices
   3  *
   4  *  Copyright (C) 2006-2007 Mauro Carvalho Chehab <mchehab@infradead.org>
   5  *
   6  *  Copyright (C) 2007 Michel Ludwig <michel.ludwig@gmail.com>
   7  *      - DVB-T support
   8  *
   9  *  This program is free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU General Public License as published by
  11  *  the Free Software Foundation version 2
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21  */
  22
  23 /* Use the tm6000-hack, instead of the proper initialization code i*/
  24 /* #define HACK 1 */
  25
  26 #include <linux/videodev2.h>
  27 #include <media/v4l2-common.h>
  28 #include <media/videobuf-vmalloc.h>
  29 #include "tm6000-usb-isoc.h"
  30 #include <linux/i2c.h>
  31 #include <linux/mutex.h>
  32 #include <media/v4l2-device.h>
  33
  34
  35 #include <linux/dvb/frontend.h>
  36 #include "dvb_demux.h"
  37 #include "dvb_frontend.h"
  38 #include "dmxdev.h"
  39
  40 #define TM6000_VERSION KERNEL_VERSION(0, 0, 2)
  41
  42 /* Inputs */
  43 enum tm6000_itype {
  44         TM6000_INPUT_TV = 1,
  45         TM6000_INPUT_COMPOSITE1,
  46         TM6000_INPUT_COMPOSITE2,
  47         TM6000_INPUT_SVIDEO,
  48         TM6000_INPUT_DVB,
  49         TM6000_INPUT_RADIO,
  50 };
  51
  52 enum tm6000_mux {
  53         TM6000_VMUX_VIDEO_A = 1,
  54         TM6000_VMUX_VIDEO_B,
  55         TM6000_VMUX_VIDEO_AB,
  56         TM6000_AMUX_ADC1,
  57         TM6000_AMUX_ADC2,
  58         TM6000_AMUX_SIF1,
  59         TM6000_AMUX_SIF2,
  60         TM6000_AMUX_I2S,
  61 };
  62
  63 enum tm6000_devtype {
  64         TM6000 = 0,
  65         TM5600,
  66         TM6010,
  67 };
  68
  69 struct tm6000_input {
  70         enum tm6000_itype       type;
  71         enum tm6000_mux         vmux;
  72         enum tm6000_mux         amux;
  73         unsigned int            v_gpio;
  74         unsigned int            a_gpio;
  75 };
  76
  77 /* ------------------------------------------------------------------
  78  *      Basic structures
  79  * ------------------------------------------------------------------
  80  */
  81
  82 struct tm6000_fmt {
  83         char  *name;
  84         u32   fourcc;          /* v4l2 format id */
  85         int   depth;
  86 };
  87
  88 /* buffer for one video frame */
  89 struct tm6000_buffer {
  90         /* common v4l buffer stuff -- must be first */
  91         struct videobuf_buffer vb;
  92
  93         struct tm6000_fmt      *fmt;
  94 };
  95
  96 struct tm6000_dmaqueue {
  97         struct list_head       active;
  98         struct list_head       queued;
  99
 100         /* thread for generating video stream*/
 101         struct task_struct         *kthread;
 102         wait_queue_head_t          wq;
 103         /* Counters to control fps rate */
 104         int                        frame;
 105         int                        ini_jiffies;
 106 };
 107
 108 /* device states */
 109 enum tm6000_core_state {
 110         DEV_INITIALIZED   = 0x01,
 111         DEV_DISCONNECTED  = 0x02,
 112         DEV_MISCONFIGURED = 0x04,
 113 };
 114
 115 /* io methods */
 116 enum tm6000_io_method {
 117         IO_NONE,
 118         IO_READ,
 119         IO_MMAP,
 120 };
 121
 122 enum tm6000_mode {
 123         TM6000_MODE_UNKNOWN = 0,
 124         TM6000_MODE_ANALOG,
 125         TM6000_MODE_DIGITAL,
 126 };
 127
 128 struct tm6000_gpio {
 129         int             tuner_reset;
 130         int             tuner_on;
 131         int             demod_reset;
 132         int             demod_on;
 133         int             power_led;
 134         int             dvb_led;
 135         int             ir;
 136 };
 137
 138 struct tm6000_capabilities {
 139         unsigned int    has_tuner:1;
 140         unsigned int    has_tda9874:1;
 141         unsigned int    has_dvb:1;
 142         unsigned int    has_zl10353:1;
 143         unsigned int    has_eeprom:1;
 144         unsigned int    has_remote:1;
 145         unsigned int    has_radio:1;
 146 };
 147
 148 struct tm6000_dvb {
 149         struct dvb_adapter      adapter;
 150         struct dvb_demux        demux;
 151         struct dvb_frontend     *frontend;
 152         struct dmxdev           dmxdev;
 153         unsigned int            streams;
 154         struct urb              *bulk_urb;
 155         struct mutex            mutex;
 156 };
 157
 158 struct snd_tm6000_card {
 159         struct snd_card                 *card;
 160         spinlock_t                      reg_lock;
 161         struct tm6000_core              *core;
 162         struct snd_pcm_substream        *substream;
 163
 164         /* temporary data for buffer fill processing */
 165         unsigned                        buf_pos;
 166         unsigned                        period_pos;
 167 };
 168
 169 struct tm6000_endpoint {
 170         struct usb_host_endpoint        *endp;
 171         __u8                            bInterfaceNumber;
 172         __u8                            bAlternateSetting;
 173         unsigned                        maxsize;
 174 };
 175
 176 struct tm6000_core {
 177         /* generic device properties */
 178         char                            name[30];       /* name (including minor) of the device */
 179         int                             model;          /* index in the device_data struct */
 180         int                             devno;          /* marks the number of this device */
 181         enum tm6000_devtype             dev_type;       /* type of device */
 182         unsigned char                   eedata[256];    /* Eeprom data */
 183         unsigned                        eedata_size;    /* Size of the eeprom info */
 184
 185         v4l2_std_id                     norm;           /* Current norm */
 186         int                             width, height;  /* Selected resolution */
 187
 188         enum tm6000_core_state          state;
 189
 190         /* Device Capabilities*/
 191         struct tm6000_capabilities      caps;
 192
 193         /* Tuner configuration */
 194         int                             tuner_type;             /* type of the tuner */
 195         int                             tuner_addr;             /* tuner address */
 196
 197         struct tm6000_gpio              gpio;
 198
 199         char                            *ir_codes;
 200
 201         __u8                            radio;
 202
 203         /* Demodulator configuration */
 204         int                             demod_addr;     /* demodulator address */
 205
 206         int                             audio_bitrate;
 207         /* i2c i/o */
 208         struct i2c_adapter              i2c_adap;
 209         struct i2c_client               i2c_client;
 210
 211
 212         /* extension */
 213         struct list_head                devlist;
 214
 215         /* video for linux */
 216         int                             users;
 217
 218         /* various device info */
 219         struct tm6000_fh                *resources;     /* Points to fh that is streaming */
 220         bool                            is_res_read;
 221
 222         struct video_device             *vfd;
 223         struct video_device             *radio_dev;
 224         struct tm6000_dmaqueue          vidq;
 225         struct v4l2_device              v4l2_dev;
 226
 227         int                             input;
 228         struct tm6000_input             vinput[3];      /* video input */
 229         struct tm6000_input             rinput;         /* radio input */
 230
 231         int                             freq;
 232         unsigned int                    fourcc;
 233
 234         enum tm6000_mode                mode;
 235
 236         int                             ctl_mute;             /* audio */
 237         int                             ctl_volume;
 238         int                             amode;
 239
 240         /* DVB-T support */
 241         struct tm6000_dvb               *dvb;
 242
 243         /* audio support */
 244         struct snd_tm6000_card          *adev;
 245         struct work_struct              wq_trigger;   /* Trigger to start/stop audio for alsa module */
 246         atomic_t                        stream_started;  /* stream should be running if true */
 247
 248         struct tm6000_IR                *ir;
 249
 250         /* locks */
 251         struct mutex                    lock;
 252
 253         /* usb transfer */
 254         struct usb_device               *udev;          /* the usb device */
 255
 256         struct tm6000_endpoint          bulk_in, bulk_out, isoc_in, isoc_out;
 257         struct tm6000_endpoint          int_in, int_out;
 258
 259         /* scaler!=0 if scaler is active*/
 260         int                             scaler;
 261
 262                 /* Isoc control struct */
 263         struct usb_isoc_ctl          isoc_ctl;
 264
 265         spinlock_t                   slock;
 266 };
 267
 268 enum tm6000_ops_type {
 269         TM6000_AUDIO = 0x10,
 270         TM6000_DVB = 0x20,
 271 };
 272
 273 struct tm6000_ops {
 274         struct list_head        next;
 275         char                    *name;
 276         enum tm6000_ops_type    type;
 277         int (*init)(struct tm6000_core *);
 278         int (*fini)(struct tm6000_core *);
 279         int (*fillbuf)(struct tm6000_core *, char *buf, int size);
 280 };
 281
 282 struct tm6000_fh {
 283         struct tm6000_core           *dev;
 284         unsigned int                 radio;
 285
 286         /* video capture */
 287         struct tm6000_fmt            *fmt;
 288         unsigned int                 width, height;
 289         struct videobuf_queue        vb_vidq;
 290
 291         enum v4l2_buf_type           type;
 292 };
 293
 294 #define TM6000_STD      (V4L2_STD_PAL|V4L2_STD_PAL_N|V4L2_STD_PAL_Nc|    \
 295                         V4L2_STD_PAL_M|V4L2_STD_PAL_60|V4L2_STD_NTSC_M| \
 296                         V4L2_STD_NTSC_M_JP|V4L2_STD_SECAM)
 297
 298 /* In tm6000-cards.c */
 299
 300 int tm6000_tuner_callback(void *ptr, int component, int command, int arg);
 301 int tm6000_xc5000_callback(void *ptr, int component, int command, int arg);
 302 int tm6000_cards_setup(struct tm6000_core *dev);
 303 void tm6000_flash_led(struct tm6000_core *dev, u8 state);
 304
 305 /* In tm6000-core.c */
 306
 307 int tm6000_read_write_usb(struct tm6000_core *dev, u8 reqtype, u8 req,
 308                            u16 value, u16 index, u8 *buf, u16 len);
 309 int tm6000_get_reg(struct tm6000_core *dev, u8 req, u16 value, u16 index);
 310 int tm6000_get_reg16(struct tm6000_core *dev, u8 req, u16 value, u16 index);
 311 int tm6000_get_reg32(struct tm6000_core *dev, u8 req, u16 value, u16 index);
 312 int tm6000_set_reg(struct tm6000_core *dev, u8 req, u16 value, u16 index);
 313 int tm6000_set_reg_mask(struct tm6000_core *dev, u8 req, u16 value,
 314                                                 u16 index, u16 mask);
 315 int tm6000_i2c_reset(struct tm6000_core *dev, u16 tsleep);
 316 int tm6000_init(struct tm6000_core *dev);
 317
 318 int tm6000_init_analog_mode(struct tm6000_core *dev);
 319 int tm6000_init_digital_mode(struct tm6000_core *dev);
 320 int tm6000_set_audio_bitrate(struct tm6000_core *dev, int bitrate);
 321 int tm6000_set_audio_rinput(struct tm6000_core *dev);
 322 int tm6000_tvaudio_set_mute(struct tm6000_core *dev, u8 mute);
 323 void tm6000_set_volume(struct tm6000_core *dev, int vol);
 324
 325 int tm6000_v4l2_register(struct tm6000_core *dev);
 326 int tm6000_v4l2_unregister(struct tm6000_core *dev);
 327 int tm6000_v4l2_exit(void);
 328 void tm6000_set_fourcc_format(struct tm6000_core *dev);
 329
 330 void tm6000_remove_from_devlist(struct tm6000_core *dev);
 331 void tm6000_add_into_devlist(struct tm6000_core *dev);
 332 int tm6000_register_extension(struct tm6000_ops *ops);
 333 void tm6000_unregister_extension(struct tm6000_ops *ops);
 334 void tm6000_init_extension(struct tm6000_core *dev);
 335 void tm6000_close_extension(struct tm6000_core *dev);
 336 int tm6000_call_fillbuf(struct tm6000_core *dev, enum tm6000_ops_type type,
 337                         char *buf, int size);
 338
 339
 340 /* In tm6000-stds.c */
 341 void tm6000_get_std_res(struct tm6000_core *dev);
 342 int tm6000_set_standard(struct tm6000_core *dev);
 343
 344 /* In tm6000-i2c.c */
 345 int tm6000_i2c_register(struct tm6000_core *dev);
 346 int tm6000_i2c_unregister(struct tm6000_core *dev);
 347
 348 /* In tm6000-queue.c */
 349
 350 int tm6000_v4l2_mmap(struct file *filp, struct vm_area_struct *vma);
 351
 352 int tm6000_vidioc_streamon(struct file *file, void *priv,
 353                            enum v4l2_buf_type i);
 354 int tm6000_vidioc_streamoff(struct file *file, void *priv,
 355                             enum v4l2_buf_type i);
 356 int tm6000_vidioc_reqbufs(struct file *file, void *priv,
 357                           struct v4l2_requestbuffers *rb);
 358 int tm6000_vidioc_querybuf(struct file *file, void *priv,
 359                            struct v4l2_buffer *b);
 360 int tm6000_vidioc_qbuf(struct file *file, void *priv, struct v4l2_buffer *b);
 361 int tm6000_vidioc_dqbuf(struct file *file, void *priv, struct v4l2_buffer *b);
 362 ssize_t tm6000_v4l2_read(struct file *filp, char __user * buf, size_t count,
 363                          loff_t *f_pos);
 364 unsigned int tm6000_v4l2_poll(struct file *file,
 365                               struct poll_table_struct *wait);
 366 int tm6000_queue_init(struct tm6000_core *dev);
 367
 368 /* In tm6000-alsa.c */
 369 /*int tm6000_audio_init(struct tm6000_core *dev, int idx);*/
 370
 371 /* In tm6000-input.c */
 372 int tm6000_ir_init(struct tm6000_core *dev);
 373 int tm6000_ir_fini(struct tm6000_core *dev);
 374 void tm6000_ir_wait(struct tm6000_core *dev, u8 state);
 375 int tm6000_ir_int_start(struct tm6000_core *dev);
 376 void tm6000_ir_int_stop(struct tm6000_core *dev);
 377
 378 /* Debug stuff */
 379
 380 extern int tm6000_debug;
 381
 382 #define dprintk(dev, level, fmt, arg...) do {\
 383         if (tm6000_debug & level) \
 384                 printk(KERN_INFO "(%lu) %s %s :"fmt, jiffies, \
 385                          dev->name, __FUNCTION__ , ##arg); } while (0)
 386
 387 #define V4L2_DEBUG_REG          0x0004
 388 #define V4L2_DEBUG_I2C          0x0008
 389 #define V4L2_DEBUG_QUEUE        0x0010
 390 #define V4L2_DEBUG_ISOC         0x0020
 391 #define V4L2_DEBUG_RES_LOCK     0x0040  /* Resource locking */
 392 #define V4L2_DEBUG_OPEN         0x0080  /* video open/close debug */
 393
 394 #define tm6000_err(fmt, arg...) do {\
 395         printk(KERN_ERR "tm6000 %s :"fmt, \
 396                 __FUNCTION__ , ##arg); } while (0)