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