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