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

   1 /* DVB USB compliant linux driver for MSI Mega Sky 580 DVB-T USB2.0 receiver
   2  *
   3  * Copyright (C) 2006 Aapo Tahkola (aet@rasterburn.org)
   4  *
   5  *      This program is free software; you can redistribute it and/or modify it
   6  *      under the terms of the GNU General Public License as published by the Free
   7  *      Software Foundation, version 2.
   8  *
   9  * see Documentation/dvb/README.dvb-usb for more information
  10  */
  11
  12 #include "m920x.h"
  13
  14 #include "mt352.h"
  15 #include "mt352_priv.h"
  16 #include "qt1010.h"
  17
  18 /* debug */
  19 static int dvb_usb_m920x_debug;
  20 module_param_named(debug,dvb_usb_m920x_debug, int, 0644);
  21 MODULE_PARM_DESC(debug, "set debugging level (1=rc (or-able))." DVB_USB_DEBUG_STATUS);
  22
  23 static struct dvb_usb_rc_key megasky_rc_keys [] = {
  24         { 0x0, 0x12, KEY_POWER },
  25         { 0x0, 0x1e, KEY_CYCLEWINDOWS }, /* min/max */
  26         { 0x0, 0x02, KEY_CHANNELUP },
  27         { 0x0, 0x05, KEY_CHANNELDOWN },
  28         { 0x0, 0x03, KEY_VOLUMEUP },
  29         { 0x0, 0x06, KEY_VOLUMEDOWN },
  30         { 0x0, 0x04, KEY_MUTE },
  31         { 0x0, 0x07, KEY_OK }, /* TS */
  32         { 0x0, 0x08, KEY_STOP },
  33         { 0x0, 0x09, KEY_MENU }, /* swap */
  34         { 0x0, 0x0a, KEY_REWIND },
  35         { 0x0, 0x1b, KEY_PAUSE },
  36         { 0x0, 0x1f, KEY_FASTFORWARD },
  37         { 0x0, 0x0c, KEY_RECORD },
  38         { 0x0, 0x0d, KEY_CAMERA }, /* screenshot */
  39         { 0x0, 0x0e, KEY_COFFEE }, /* "MTS" */
  40 };
  41
  42 static inline int m9206_read(struct usb_device *udev, u8 request, u16 value,\
  43                              u16 index, void *data, int size)
  44 {
  45         int ret;
  46
  47         ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
  48                               request, USB_TYPE_VENDOR | USB_DIR_IN,
  49                               value, index, data, size, 2000);
  50         if (ret < 0)
  51                 return ret;
  52
  53         if (ret != size)
  54                 return -EIO;
  55
  56         return 0;
  57 }
  58
  59 static inline int m9206_write(struct usb_device *udev, u8 request,
  60                               u16 value, u16 index)
  61 {
  62         int ret;
  63
  64         ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
  65                               request, USB_TYPE_VENDOR | USB_DIR_OUT,
  66                               value, index, NULL, 0, 2000);
  67         return ret;
  68 }
  69
  70 static int m9206_rc_init(struct usb_device *udev)
  71 {
  72         int ret = 0;
  73
  74         /* Remote controller init. */
  75         if ((ret = m9206_write(udev, M9206_CORE, 0xa8, M9206_RC_INIT2)) != 0)
  76                 return ret;
  77
  78         if ((ret = m9206_write(udev, M9206_CORE, 0x51, M9206_RC_INIT1)) != 0)
  79                 return ret;
  80
  81         return ret;
  82 }
  83
  84 static int m9206_rc_query(struct dvb_usb_device *d, u32 *event, int *state)
  85 {
  86         struct m9206_state *m = d->priv;
  87         int i, ret = 0;
  88         u8 rc_state[2];
  89
  90
  91         if ((ret = m9206_read(d->udev, M9206_CORE, 0x0, M9206_RC_STATE, rc_state, 1)) != 0)
  92                 goto unlock;
  93
  94         if ((ret = m9206_read(d->udev, M9206_CORE, 0x0, M9206_RC_KEY, rc_state + 1, 1)) != 0)
  95                 goto unlock;
  96
  97         for (i = 0; i < ARRAY_SIZE(megasky_rc_keys); i++)
  98                 if (megasky_rc_keys[i].data == rc_state[1]) {
  99                         *event = megasky_rc_keys[i].event;
 100
 101                         switch(rc_state[0]) {
 102                         case 0x80:
 103                                 *state = REMOTE_NO_KEY_PRESSED;
 104                                 goto unlock;
 105
 106                         case 0x93:
 107                         case 0x92:
 108                                 m->rep_count = 0;
 109                                 *state = REMOTE_KEY_PRESSED;
 110                                 goto unlock;
 111
 112                         case 0x91:
 113                                 /* For comfort. */
 114                                 if (++m->rep_count > 2)
 115                                         *state = REMOTE_KEY_REPEAT;
 116                                 goto unlock;
 117
 118                         default:
 119                                 deb_rc("Unexpected rc response %x\n", rc_state[0]);
 120                                 *state = REMOTE_NO_KEY_PRESSED;
 121                                 goto unlock;
 122                         }
 123                 }
 124
 125         if (rc_state[1] != 0)
 126                 deb_rc("Unknown rc key %x\n", rc_state[1]);
 127
 128         *state = REMOTE_NO_KEY_PRESSED;
 129
 130         unlock:
 131
 132         return ret;
 133 }
 134
 135 /* I2C */
 136 static int m9206_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg msg[],
 137                           int num)
 138 {
 139         struct dvb_usb_device *d = i2c_get_adapdata(adap);
 140         struct m9206_state *m = d->priv;
 141         int i;
 142         int ret = 0;
 143
 144         if (mutex_lock_interruptible(&d->i2c_mutex) < 0)
 145                 return -EAGAIN;
 146
 147         if (num > 2)
 148                 return -EINVAL;
 149
 150         for (i = 0; i < num; i++) {
 151                 if ((ret = m9206_write(d->udev, M9206_I2C, msg[i].addr, 0x80)) != 0)
 152                         goto unlock;
 153
 154                 if ((ret = m9206_write(d->udev, M9206_I2C, msg[i].buf[0], 0x0)) != 0)
 155                         goto unlock;
 156
 157                 if (i + 1 < num && msg[i + 1].flags & I2C_M_RD) {
 158                         int i2c_i;
 159
 160                         for (i2c_i = 0; i2c_i < M9206_I2C_MAX; i2c_i++)
 161                                 if (msg[i].addr == m->i2c_r[i2c_i].addr)
 162                                         break;
 163
 164                         if (i2c_i >= M9206_I2C_MAX) {
 165                                 deb_rc("No magic for i2c addr!\n");
 166                                 ret = -EINVAL;
 167                                 goto unlock;
 168                         }
 169
 170                         if ((ret = m9206_write(d->udev, M9206_I2C, m->i2c_r[i2c_i].magic, 0x80)) != 0)
 171                                 goto unlock;
 172
 173                         if ((ret = m9206_read(d->udev, M9206_I2C, 0x0, 0x60, msg[i + 1].buf, msg[i + 1].len)) != 0)
 174                                 goto unlock;
 175
 176                         i++;
 177                 } else {
 178                         if (msg[i].len != 2)
 179                                 return -EINVAL;
 180
 181                         if ((ret = m9206_write(d->udev, M9206_I2C, msg[i].buf[1], 0x40)) != 0)
 182                                 goto unlock;
 183                 }
 184         }
 185         ret = i;
 186         unlock:
 187         mutex_unlock(&d->i2c_mutex);
 188
 189         return ret;
 190 }
 191
 192 static u32 m9206_i2c_func(struct i2c_adapter *adapter)
 193 {
 194         return I2C_FUNC_I2C;
 195 }
 196
 197 static struct i2c_algorithm m9206_i2c_algo = {
 198         .master_xfer   = m9206_i2c_xfer,
 199         .functionality = m9206_i2c_func,
 200 };
 201
 202
 203 static int m9206_set_filter(struct dvb_usb_adapter *adap, int type, int idx,
 204                             int pid)
 205 {
 206         int ret = 0;
 207
 208         if (pid >= 0x8000)
 209                 return -EINVAL;
 210
 211         pid |= 0x8000;
 212
 213         if ((ret = m9206_write(adap->dev->udev, M9206_FILTER, pid, (type << 8) | (idx * 4) )) != 0)
 214                 return ret;
 215
 216         if ((ret = m9206_write(adap->dev->udev, M9206_FILTER, 0, (type << 8) | (idx * 4) )) != 0)
 217                 return ret;
 218
 219         return ret;
 220 }
 221
 222 static int m9206_update_filters(struct dvb_usb_adapter *adap)
 223 {
 224         struct m9206_state *m = adap->dev->priv;
 225         int enabled = m->filtering_enabled;
 226         int i, ret = 0, filter = 0;
 227
 228         for (i = 0; i < M9206_MAX_FILTERS; i++)
 229                 if (m->filters[i] == 8192)
 230                         enabled = 0;
 231
 232         /* Disable all filters */
 233         if ((ret = m9206_set_filter(adap, 0x81, 1, enabled)) != 0)
 234                 return ret;
 235
 236         for (i = 0; i < M9206_MAX_FILTERS; i++)
 237                 if ((ret = m9206_set_filter(adap, 0x81, i + 2, 0)) != 0)
 238                         return ret;
 239
 240         if ((ret = m9206_set_filter(adap, 0x82, 0, 0x0)) != 0)
 241                 return ret;
 242
 243         /* Set */
 244         if (enabled) {
 245                 for (i = 0; i < M9206_MAX_FILTERS; i++) {
 246                         if (m->filters[i] == 0)
 247                                 continue;
 248
 249                         if ((ret = m9206_set_filter(adap, 0x81, filter + 2, m->filters[i])) != 0)
 250                                 return ret;
 251
 252                         filter++;
 253                 }
 254         }
 255
 256         if ((ret = m9206_set_filter(adap, 0x82, 0, 0x02f5)) != 0)
 257                 return ret;
 258
 259         return ret;
 260 }
 261
 262 static int m9206_pid_filter_ctrl(struct dvb_usb_adapter *adap, int onoff)
 263 {
 264         struct m9206_state *m = adap->dev->priv;
 265
 266         m->filtering_enabled = onoff ? 1 : 0;
 267
 268         return m9206_update_filters(adap);
 269 }
 270
 271 static int m9206_pid_filter(struct dvb_usb_adapter *adap, int index, u16 pid,
 272                             int onoff)
 273 {
 274         struct m9206_state *m = adap->dev->priv;
 275
 276         m->filters[index] = onoff ? pid : 0;
 277
 278         return m9206_update_filters(adap);
 279 }
 280
 281 static int m9206_firmware_download(struct usb_device *udev,
 282                                    const struct firmware *fw)
 283 {
 284         u16 value, index, size;
 285         u8 read[4], *buff;
 286         int i, pass, ret = 0;
 287
 288         buff = kmalloc(65536, GFP_KERNEL);
 289
 290         if ((ret = m9206_read(udev, M9206_FILTER, 0x0, 0x8000, read, 4)) != 0)
 291                 goto done;
 292         deb_rc("%x %x %x %x\n", read[0], read[1], read[2], read[3]);
 293
 294         if ((ret = m9206_read(udev, M9206_FW, 0x0, 0x0, read, 1)) != 0)
 295                 goto done;
 296         deb_rc("%x\n", read[0]);
 297
 298         for (pass = 0; pass < 2; pass++) {
 299                 for (i = 0; i + (sizeof(u16) * 3) < fw->size;) {
 300                         value = le16_to_cpu(*(u16 *)(fw->data + i));
 301                         i += sizeof(u16);
 302
 303                         index = le16_to_cpu(*(u16 *)(fw->data + i));
 304                         i += sizeof(u16);
 305
 306                         size = le16_to_cpu(*(u16 *)(fw->data + i));
 307                         i += sizeof(u16);
 308
 309                         if (pass == 1) {
 310                                 /* Will stall if using fw->data ... */
 311                                 memcpy(buff, fw->data + i, size);
 312
 313                                 ret = usb_control_msg(udev, usb_sndctrlpipe(udev,0),
 314                                             M9206_FW,
 315                                             USB_TYPE_VENDOR | USB_DIR_OUT,
 316                                             value, index, buff, size, 20);
 317                                 if (ret != size) {
 318                                         deb_rc("error while uploading fw!\n");
 319                                         ret = -EIO;
 320                                         goto done;
 321                                 }
 322                                 msleep(3);
 323                         }
 324                         i += size;
 325                 }
 326                 if (i != fw->size) {
 327                         ret = -EINVAL;
 328                         goto done;
 329                 }
 330         }
 331
 332         msleep(36);
 333
 334         /* m9206 will disconnect itself from the bus after this. */
 335         (void) m9206_write(udev, M9206_CORE, 0x01, M9206_FW_GO);
 336         deb_rc("firmware uploaded!\n");
 337
 338         done:
 339         kfree(buff);
 340
 341         return ret;
 342 }
 343
 344 /* Callbacks for DVB USB */
 345 static int megasky_identify_state(struct usb_device *udev,
 346                                   struct dvb_usb_device_properties *props,
 347                                   struct dvb_usb_device_description **desc,
 348                                   int *cold)
 349 {
 350         struct usb_host_interface *alt;
 351
 352         alt = usb_altnum_to_altsetting(usb_ifnum_to_if(udev, 0), 1);
 353         *cold = (alt == NULL) ? 1 : 0;
 354
 355         return 0;
 356 }
 357
 358 static int megasky_mt352_demod_init(struct dvb_frontend *fe)
 359 {
 360         u8 config[] = { CONFIG, 0x3d };
 361         u8 clock[] = { CLOCK_CTL, 0x30 };
 362         u8 reset[] = { RESET, 0x80 };
 363         u8 adc_ctl[] = { ADC_CTL_1, 0x40 };
 364         u8 agc[] = { AGC_TARGET, 0x1c, 0x20 };
 365         u8 sec_agc[] = { 0x69, 0x00, 0xff, 0xff, 0x40, 0xff, 0x00, 0x40, 0x40 };
 366         u8 unk1[] = { 0x93, 0x1a };
 367         u8 unk2[] = { 0xb5, 0x7a };
 368
 369         mt352_write(fe, config, ARRAY_SIZE(config));
 370         mt352_write(fe, clock, ARRAY_SIZE(clock));
 371         mt352_write(fe, reset, ARRAY_SIZE(reset));
 372         mt352_write(fe, adc_ctl, ARRAY_SIZE(adc_ctl));
 373         mt352_write(fe, agc, ARRAY_SIZE(agc));
 374         mt352_write(fe, sec_agc, ARRAY_SIZE(sec_agc));
 375         mt352_write(fe, unk1, ARRAY_SIZE(unk1));
 376         mt352_write(fe, unk2, ARRAY_SIZE(unk2));
 377
 378         deb_rc("Demod init!\n");
 379
 380         return 0;
 381 }
 382
 383 static struct mt352_config megasky_mt352_config = {
 384         .demod_address = 0x1e,
 385         .no_tuner = 1,
 386         .demod_init = megasky_mt352_demod_init,
 387 };
 388
 389 static int megasky_mt352_frontend_attach(struct dvb_usb_adapter *adap)
 390 {
 391         struct m9206_state *m = adap->dev->priv;
 392
 393         deb_rc("megasky_frontend_attach!\n");
 394
 395         m->i2c_r[M9206_I2C_DEMOD].addr = megasky_mt352_config.demod_address;
 396         m->i2c_r[M9206_I2C_DEMOD].magic = 0x1f;
 397
 398         if ((adap->fe = dvb_attach(mt352_attach, &megasky_mt352_config, &adap->dev->i2c_adap)) == NULL)
 399                 return -EIO;
 400
 401         return 0;
 402 }
 403
 404 static struct qt1010_config megasky_qt1010_config = {
 405         .i2c_address = 0xc4
 406 };
 407
 408 static int megasky_qt1010_tuner_attach(struct dvb_usb_adapter *adap)
 409 {
 410         struct m9206_state *m = adap->dev->priv;
 411
 412         m->i2c_r[M9206_I2C_TUNER].addr = megasky_qt1010_config.i2c_address;
 413         m->i2c_r[M9206_I2C_TUNER].magic = 0xc5;
 414
 415         if (dvb_attach(qt1010_attach, adap->fe, &adap->dev->i2c_adap,
 416                        &megasky_qt1010_config) == NULL)
 417                 return -ENODEV;
 418
 419         return 0;
 420 }
 421
 422 /* DVB USB Driver stuff */
 423 static struct dvb_usb_device_properties megasky_properties;
 424
 425 static int m920x_probe(struct usb_interface *intf,
 426                        const struct usb_device_id *id)
 427 {
 428         struct dvb_usb_device *d;
 429         struct usb_host_interface *alt;
 430         int ret;
 431
 432         if ((ret = dvb_usb_device_init(intf, &megasky_properties, THIS_MODULE, &d)) == 0) {
 433                 deb_rc("probed!\n");
 434
 435                 alt = usb_altnum_to_altsetting(intf, 1);
 436                 if (alt == NULL) {
 437                         deb_rc("not alt found!\n");
 438                         return -ENODEV;
 439                 }
 440
 441                 ret = usb_set_interface(d->udev, alt->desc.bInterfaceNumber,
 442                                         alt->desc.bAlternateSetting);
 443                 if (ret < 0)
 444                         return ret;
 445
 446                 deb_rc("Changed to alternate setting!\n");
 447
 448                 if ((ret = m9206_rc_init(d->udev)) != 0)
 449                         return ret;
 450         }
 451         return ret;
 452 }
 453
 454 static struct usb_device_id m920x_table [] = {
 455                 { USB_DEVICE(USB_VID_MSI, USB_PID_MSI_MEGASKY580) },
 456                 { }             /* Terminating entry */
 457 };
 458 MODULE_DEVICE_TABLE (usb, m920x_table);
 459
 460 static struct dvb_usb_device_properties megasky_properties = {
 461         .caps = DVB_USB_IS_AN_I2C_ADAPTER,
 462
 463         .usb_ctrl = DEVICE_SPECIFIC,
 464         .firmware = "dvb-usb-megasky-02.fw",
 465         .download_firmware = m9206_firmware_download,
 466
 467         .rc_interval      = 100,
 468         .rc_key_map       = megasky_rc_keys,
 469         .rc_key_map_size  = ARRAY_SIZE(megasky_rc_keys),
 470         .rc_query         = m9206_rc_query,
 471
 472         .size_of_priv     = sizeof(struct m9206_state),
 473
 474         .identify_state   = megasky_identify_state,
 475         .num_adapters = 1,
 476         .adapter = {{
 477                 .caps = DVB_USB_ADAP_HAS_PID_FILTER |
 478                         DVB_USB_ADAP_PID_FILTER_CAN_BE_TURNED_OFF,
 479
 480                 .pid_filter_count = 8,
 481                 .pid_filter       = m9206_pid_filter,
 482                 .pid_filter_ctrl  = m9206_pid_filter_ctrl,
 483
 484                 .frontend_attach  = megasky_mt352_frontend_attach,
 485                 .tuner_attach     = megasky_qt1010_tuner_attach,
 486
 487                 .stream = {
 488                         .type = USB_BULK,
 489                         .count = 8,
 490                         .endpoint = 0x81,
 491                         .u = {
 492                                 .bulk = {
 493                                         .buffersize = 512,
 494                                 }
 495                         }
 496                 },
 497         }},
 498         .i2c_algo         = &m9206_i2c_algo,
 499
 500         .num_device_descs = 1,
 501         .devices = {
 502                 {   "MSI Mega Sky 580 DVB-T USB2.0",
 503                         { &m920x_table[0], NULL },
 504                         { NULL },
 505                 },
 506         }
 507 };
 508
 509 static struct usb_driver m920x_driver = {
 510         .name           = "dvb_usb_m920x",
 511         .probe          = m920x_probe,
 512         .disconnect     = dvb_usb_device_exit,
 513         .id_table       = m920x_table,
 514 };
 515
 516 /* module stuff */
 517 static int __init m920x_module_init(void)
 518 {
 519         int ret;
 520
 521         if ((ret = usb_register(&m920x_driver))) {
 522                 err("usb_register failed. Error number %d", ret);
 523                 return ret;
 524         }
 525
 526         return 0;
 527 }
 528
 529 static void __exit m920x_module_exit(void)
 530 {
 531         /* deregister this driver from the USB subsystem */
 532         usb_deregister(&m920x_driver);
 533 }
 534
 535 module_init (m920x_module_init);
 536 module_exit (m920x_module_exit);
 537
 538 MODULE_AUTHOR("Aapo Tahkola <aet@rasterburn.org>");
 539 MODULE_DESCRIPTION("Driver MSI Mega Sky 580 DVB-T USB2.0 / Uli m920x");
 540 MODULE_VERSION("0.1");
 541 MODULE_LICENSE("GPL");