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