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

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