drivers/media/usb/dvb-usb/digitv.c

   1 /* DVB USB compliant linux driver for Nebula Electronics uDigiTV DVB-T USB2.0
   2  * receiver
   3  *
   4  * Copyright (C) 2005 Patrick Boettcher (patrick.boettcher@posteo.de)
   5  *
   6  * partly based on the SDK published by Nebula Electronics
   7  *
   8  *      This program is free software; you can redistribute it and/or modify it
   9  *      under the terms of the GNU General Public License as published by the Free
  10  *      Software Foundation, version 2.
  11  *
  12  * see Documentation/media/dvb-drivers/dvb-usb.rst for more information
  13  */
  14 #include "digitv.h"
  15
  16 #include "mt352.h"
  17 #include "nxt6000.h"
  18
  19 /* debug */
  20 static int dvb_usb_digitv_debug;
  21 module_param_named(debug,dvb_usb_digitv_debug, int, 0644);
  22 MODULE_PARM_DESC(debug, "set debugging level (1=rc (or-able))." DVB_USB_DEBUG_STATUS);
  23
  24 DVB_DEFINE_MOD_OPT_ADAPTER_NR(adapter_nr);
  25
  26 #define deb_rc(args...)   dprintk(dvb_usb_digitv_debug,0x01,args)
  27
  28 static int digitv_ctrl_msg(struct dvb_usb_device *d,
  29                 u8 cmd, u8 vv, u8 *wbuf, int wlen, u8 *rbuf, int rlen)
  30 {
  31         struct digitv_state *st = d->priv;
  32         int ret, wo;
  33
  34         wo = (rbuf == NULL || rlen == 0); /* write-only */
  35
  36         if (wlen > 4 || rlen > 4)
  37                 return -EIO;
  38
  39         memset(st->sndbuf, 0, 7);
  40         memset(st->rcvbuf, 0, 7);
  41
  42         st->sndbuf[0] = cmd;
  43         st->sndbuf[1] = vv;
  44         st->sndbuf[2] = wo ? wlen : rlen;
  45
  46         if (wo) {
  47                 memcpy(&st->sndbuf[3], wbuf, wlen);
  48                 ret = dvb_usb_generic_write(d, st->sndbuf, 7);
  49         } else {
  50                 ret = dvb_usb_generic_rw(d, st->sndbuf, 7, st->rcvbuf, 7, 10);
  51                 memcpy(rbuf, &st->rcvbuf[3], rlen);
  52         }
  53         return ret;
  54 }
  55
  56 /* I2C */
  57 static int digitv_i2c_xfer(struct i2c_adapter *adap,struct i2c_msg msg[],int num)
  58 {
  59         struct dvb_usb_device *d = i2c_get_adapdata(adap);
  60         int i;
  61
  62         if (mutex_lock_interruptible(&d->i2c_mutex) < 0)
  63                 return -EAGAIN;
  64
  65         if (num > 2)
  66                 warn("more than 2 i2c messages at a time is not handled yet. TODO.");
  67
  68         for (i = 0; i < num; i++) {
  69                 if (msg[i].len < 1) {
  70                         i = -EOPNOTSUPP;
  71                         break;
  72                 }
  73                 /* write/read request */
  74                 if (i+1 < num && (msg[i+1].flags & I2C_M_RD)) {
  75                         if (digitv_ctrl_msg(d, USB_READ_COFDM, msg[i].buf[0], NULL, 0,
  76                                                 msg[i+1].buf,msg[i+1].len) < 0)
  77                                 break;
  78                         i++;
  79                 } else
  80                         if (digitv_ctrl_msg(d,USB_WRITE_COFDM, msg[i].buf[0],
  81                                                 &msg[i].buf[1],msg[i].len-1,NULL,0) < 0)
  82                                 break;
  83         }
  84
  85         mutex_unlock(&d->i2c_mutex);
  86         return i;
  87 }
  88
  89 static u32 digitv_i2c_func(struct i2c_adapter *adapter)
  90 {
  91         return I2C_FUNC_I2C;
  92 }
  93
  94 static struct i2c_algorithm digitv_i2c_algo = {
  95         .master_xfer   = digitv_i2c_xfer,
  96         .functionality = digitv_i2c_func,
  97 };
  98
  99 /* Callbacks for DVB USB */
 100 static int digitv_identify_state (struct usb_device *udev, struct
 101                 dvb_usb_device_properties *props, struct dvb_usb_device_description **desc,
 102                 int *cold)
 103 {
 104         *cold = udev->descriptor.iManufacturer == 0 && udev->descriptor.iProduct == 0;
 105         return 0;
 106 }
 107
 108 static int digitv_mt352_demod_init(struct dvb_frontend *fe)
 109 {
 110         static u8 reset_buf[] = { 0x89, 0x38,  0x8a, 0x2d, 0x50, 0x80 };
 111         static u8 init_buf[] = { 0x68, 0xa0,  0x8e, 0x40,  0x53, 0x50,
 112                         0x67, 0x20,  0x7d, 0x01,  0x7c, 0x00,  0x7a, 0x00,
 113                         0x79, 0x20,  0x57, 0x05,  0x56, 0x31,  0x88, 0x0f,
 114                         0x75, 0x32 };
 115         int i;
 116
 117         for (i = 0; i < ARRAY_SIZE(reset_buf); i += 2)
 118                 mt352_write(fe, &reset_buf[i], 2);
 119
 120         msleep(1);
 121
 122         for (i = 0; i < ARRAY_SIZE(init_buf); i += 2)
 123                 mt352_write(fe, &init_buf[i], 2);
 124
 125         return 0;
 126 }
 127
 128 static struct mt352_config digitv_mt352_config = {
 129         .demod_init = digitv_mt352_demod_init,
 130 };
 131
 132 static int digitv_nxt6000_tuner_set_params(struct dvb_frontend *fe)
 133 {
 134         struct dvb_usb_adapter *adap = fe->dvb->priv;
 135         u8 b[5];
 136
 137         fe->ops.tuner_ops.calc_regs(fe, b, sizeof(b));
 138         if (fe->ops.i2c_gate_ctrl)
 139                 fe->ops.i2c_gate_ctrl(fe, 1);
 140         return digitv_ctrl_msg(adap->dev, USB_WRITE_TUNER, 0, &b[1], 4, NULL, 0);
 141 }
 142
 143 static struct nxt6000_config digitv_nxt6000_config = {
 144         .clock_inversion = 1,
 145 };
 146
 147 static int digitv_frontend_attach(struct dvb_usb_adapter *adap)
 148 {
 149         struct digitv_state *st = adap->dev->priv;
 150
 151         adap->fe_adap[0].fe = dvb_attach(mt352_attach, &digitv_mt352_config,
 152                                          &adap->dev->i2c_adap);
 153         if ((adap->fe_adap[0].fe) != NULL) {
 154                 st->is_nxt6000 = 0;
 155                 return 0;
 156         }
 157         adap->fe_adap[0].fe = dvb_attach(nxt6000_attach,
 158                                          &digitv_nxt6000_config,
 159                                          &adap->dev->i2c_adap);
 160         if ((adap->fe_adap[0].fe) != NULL) {
 161                 st->is_nxt6000 = 1;
 162                 return 0;
 163         }
 164         return -EIO;
 165 }
 166
 167 static int digitv_tuner_attach(struct dvb_usb_adapter *adap)
 168 {
 169         struct digitv_state *st = adap->dev->priv;
 170
 171         if (!dvb_attach(dvb_pll_attach, adap->fe_adap[0].fe, 0x60, NULL, DVB_PLL_TDED4))
 172                 return -ENODEV;
 173
 174         if (st->is_nxt6000)
 175                 adap->fe_adap[0].fe->ops.tuner_ops.set_params = digitv_nxt6000_tuner_set_params;
 176
 177         return 0;
 178 }
 179
 180 static struct rc_map_table rc_map_digitv_table[] = {
 181         { 0x5f55, KEY_0 },
 182         { 0x6f55, KEY_1 },
 183         { 0x9f55, KEY_2 },
 184         { 0xaf55, KEY_3 },
 185         { 0x5f56, KEY_4 },
 186         { 0x6f56, KEY_5 },
 187         { 0x9f56, KEY_6 },
 188         { 0xaf56, KEY_7 },
 189         { 0x5f59, KEY_8 },
 190         { 0x6f59, KEY_9 },
 191         { 0x9f59, KEY_TV },
 192         { 0xaf59, KEY_AUX },
 193         { 0x5f5a, KEY_DVD },
 194         { 0x6f5a, KEY_POWER },
 195         { 0x9f5a, KEY_CAMERA },     /* labelled 'Picture' */
 196         { 0xaf5a, KEY_AUDIO },
 197         { 0x5f65, KEY_INFO },
 198         { 0x6f65, KEY_F13 },     /* 16:9 */
 199         { 0x9f65, KEY_F14 },     /* 14:9 */
 200         { 0xaf65, KEY_EPG },
 201         { 0x5f66, KEY_EXIT },
 202         { 0x6f66, KEY_MENU },
 203         { 0x9f66, KEY_UP },
 204         { 0xaf66, KEY_DOWN },
 205         { 0x5f69, KEY_LEFT },
 206         { 0x6f69, KEY_RIGHT },
 207         { 0x9f69, KEY_ENTER },
 208         { 0xaf69, KEY_CHANNELUP },
 209         { 0x5f6a, KEY_CHANNELDOWN },
 210         { 0x6f6a, KEY_VOLUMEUP },
 211         { 0x9f6a, KEY_VOLUMEDOWN },
 212         { 0xaf6a, KEY_RED },
 213         { 0x5f95, KEY_GREEN },
 214         { 0x6f95, KEY_YELLOW },
 215         { 0x9f95, KEY_BLUE },
 216         { 0xaf95, KEY_SUBTITLE },
 217         { 0x5f96, KEY_F15 },     /* AD */
 218         { 0x6f96, KEY_TEXT },
 219         { 0x9f96, KEY_MUTE },
 220         { 0xaf96, KEY_REWIND },
 221         { 0x5f99, KEY_STOP },
 222         { 0x6f99, KEY_PLAY },
 223         { 0x9f99, KEY_FASTFORWARD },
 224         { 0xaf99, KEY_F16 },     /* chapter */
 225         { 0x5f9a, KEY_PAUSE },
 226         { 0x6f9a, KEY_PLAY },
 227         { 0x9f9a, KEY_RECORD },
 228         { 0xaf9a, KEY_F17 },     /* picture in picture */
 229         { 0x5fa5, KEY_KPPLUS },  /* zoom in */
 230         { 0x6fa5, KEY_KPMINUS }, /* zoom out */
 231         { 0x9fa5, KEY_F18 },     /* capture */
 232         { 0xafa5, KEY_F19 },     /* web */
 233         { 0x5fa6, KEY_EMAIL },
 234         { 0x6fa6, KEY_PHONE },
 235         { 0x9fa6, KEY_PC },
 236 };
 237
 238 static int digitv_rc_query(struct dvb_usb_device *d, u32 *event, int *state)
 239 {
 240         int ret, i;
 241         u8 key[5];
 242         u8 b[4] = { 0 };
 243
 244         *event = 0;
 245         *state = REMOTE_NO_KEY_PRESSED;
 246
 247         ret = digitv_ctrl_msg(d, USB_READ_REMOTE, 0, NULL, 0, &key[1], 4);
 248         if (ret)
 249                 return ret;
 250
 251         /* Tell the device we've read the remote. Not sure how necessary
 252            this is, but the Nebula SDK does it. */
 253         ret = digitv_ctrl_msg(d, USB_WRITE_REMOTE, 0, b, 4, NULL, 0);
 254         if (ret)
 255                 return ret;
 256
 257         /* if something is inside the buffer, simulate key press */
 258         if (key[1] != 0)
 259         {
 260                   for (i = 0; i < d->props.rc.legacy.rc_map_size; i++) {
 261                         if (rc5_custom(&d->props.rc.legacy.rc_map_table[i]) == key[1] &&
 262                             rc5_data(&d->props.rc.legacy.rc_map_table[i]) == key[2]) {
 263                                 *event = d->props.rc.legacy.rc_map_table[i].keycode;
 264                                 *state = REMOTE_KEY_PRESSED;
 265                                 return 0;
 266                         }
 267                 }
 268         }
 269
 270         if (key[0] != 0)
 271                 deb_rc("key: %*ph\n", 5, key);
 272         return 0;
 273 }
 274
 275 /* DVB USB Driver stuff */
 276 static struct dvb_usb_device_properties digitv_properties;
 277
 278 static int digitv_probe(struct usb_interface *intf,
 279                 const struct usb_device_id *id)
 280 {
 281         struct dvb_usb_device *d;
 282         int ret = dvb_usb_device_init(intf, &digitv_properties, THIS_MODULE, &d,
 283                                       adapter_nr);
 284         if (ret == 0) {
 285                 u8 b[4] = { 0 };
 286
 287                 if (d != NULL) { /* do that only when the firmware is loaded */
 288                         b[0] = 1;
 289                         digitv_ctrl_msg(d,USB_WRITE_REMOTE_TYPE,0,b,4,NULL,0);
 290
 291                         b[0] = 0;
 292                         digitv_ctrl_msg(d,USB_WRITE_REMOTE,0,b,4,NULL,0);
 293                 }
 294         }
 295         return ret;
 296 }
 297
 298 static struct usb_device_id digitv_table [] = {
 299                 { USB_DEVICE(USB_VID_ANCHOR, USB_PID_NEBULA_DIGITV) },
 300                 { }             /* Terminating entry */
 301 };
 302 MODULE_DEVICE_TABLE (usb, digitv_table);
 303
 304 static struct dvb_usb_device_properties digitv_properties = {
 305         .caps = DVB_USB_IS_AN_I2C_ADAPTER,
 306
 307         .usb_ctrl = CYPRESS_FX2,
 308         .firmware = "/*(DEBLOBBED)*/",
 309
 310         .size_of_priv = sizeof(struct digitv_state),
 311
 312         .num_adapters = 1,
 313         .adapter = {
 314                 {
 315                 .num_frontends = 1,
 316                 .fe = {{
 317                         .frontend_attach  = digitv_frontend_attach,
 318                         .tuner_attach     = digitv_tuner_attach,
 319
 320                         /* parameter for the MPEG2-data transfer */
 321                         .stream = {
 322                                 .type = USB_BULK,
 323                                 .count = 7,
 324                                 .endpoint = 0x02,
 325                                 .u = {
 326                                         .bulk = {
 327                                                 .buffersize = 4096,
 328                                         }
 329                                 }
 330                         },
 331                 }},
 332                 }
 333         },
 334         .identify_state   = digitv_identify_state,
 335
 336         .rc.legacy = {
 337                 .rc_interval      = 1000,
 338                 .rc_map_table     = rc_map_digitv_table,
 339                 .rc_map_size      = ARRAY_SIZE(rc_map_digitv_table),
 340                 .rc_query         = digitv_rc_query,
 341         },
 342
 343         .i2c_algo         = &digitv_i2c_algo,
 344
 345         .generic_bulk_ctrl_endpoint = 0x01,
 346
 347         .num_device_descs = 1,
 348         .devices = {
 349                 {   "Nebula Electronics uDigiTV DVB-T USB2.0)",
 350                         { &digitv_table[0], NULL },
 351                         { NULL },
 352                 },
 353                 { NULL },
 354         }
 355 };
 356
 357 static struct usb_driver digitv_driver = {
 358         .name           = "dvb_usb_digitv",
 359         .probe          = digitv_probe,
 360         .disconnect = dvb_usb_device_exit,
 361         .id_table       = digitv_table,
 362 };
 363
 364 module_usb_driver(digitv_driver);
 365
 366 MODULE_AUTHOR("Patrick Boettcher <patrick.boettcher@posteo.de>");
 367 MODULE_DESCRIPTION("Driver for Nebula Electronics uDigiTV DVB-T USB2.0");
 368 MODULE_VERSION("1.0-alpha");
 369 MODULE_LICENSE("GPL");