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