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