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