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