1 /* Linux driver for devices based on the DiBcom DiB0700 USB bridge
3 * This program is free software; you can redistribute it and/or modify it
4 * under the terms of the GNU General Public License as published by the Free
5 * Software Foundation, version 2.
7 * Copyright (C) 2005-6 DiBcom, SA
12 int dvb_usb_dib0700_debug;
13 module_param_named(debug,dvb_usb_dib0700_debug, int, 0644);
14 MODULE_PARM_DESC(debug, "set debugging level (1=info,2=fw,4=fwdata,8=data (or-able))." DVB_USB_DEBUG_STATUS);
16 int dvb_usb_dib0700_ir_proto = 1;
17 module_param(dvb_usb_dib0700_ir_proto, int, 0644);
18 MODULE_PARM_DESC(dvb_usb_dib0700_ir_proto, "set ir protocol (0=NEC, 1=RC5 (default), 2=RC6).");
20 static int nb_packet_buffer_size = 21;
21 module_param(nb_packet_buffer_size, int, 0644);
22 MODULE_PARM_DESC(nb_packet_buffer_size,
23 "Set the dib0700 driver data buffer size. This parameter "
24 "corresponds to the number of TS packets. The actual size of "
25 "the data buffer corresponds to this parameter "
26 "multiplied by 188 (default: 21)");
28 DVB_DEFINE_MOD_OPT_ADAPTER_NR(adapter_nr);
31 int dib0700_get_version(struct dvb_usb_device *d, u32 *hwversion,
32 u32 *romversion, u32 *ramversion, u32 *fwtype)
35 int ret = usb_control_msg(d->udev, usb_rcvctrlpipe(d->udev, 0),
37 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
38 b, sizeof(b), USB_CTRL_GET_TIMEOUT);
39 if (hwversion != NULL)
40 *hwversion = (b[0] << 24) | (b[1] << 16) | (b[2] << 8) | b[3];
41 if (romversion != NULL)
42 *romversion = (b[4] << 24) | (b[5] << 16) | (b[6] << 8) | b[7];
43 if (ramversion != NULL)
44 *ramversion = (b[8] << 24) | (b[9] << 16) | (b[10] << 8) | b[11];
46 *fwtype = (b[12] << 24) | (b[13] << 16) | (b[14] << 8) | b[15];
50 /* expecting rx buffer: request data[0] data[1] ... data[2] */
51 static int dib0700_ctrl_wr(struct dvb_usb_device *d, u8 *tx, u8 txlen)
56 debug_dump(tx, txlen, deb_data);
58 status = usb_control_msg(d->udev, usb_sndctrlpipe(d->udev,0),
59 tx[0], USB_TYPE_VENDOR | USB_DIR_OUT, 0, 0, tx, txlen,
60 USB_CTRL_GET_TIMEOUT);
63 deb_data("ep 0 write error (status = %d, len: %d)\n",status,txlen);
65 return status < 0 ? status : 0;
68 /* expecting tx buffer: request data[0] ... data[n] (n <= 4) */
69 int dib0700_ctrl_rd(struct dvb_usb_device *d, u8 *tx, u8 txlen, u8 *rx, u8 rxlen)
75 err("tx buffer length is smaller than 2. Makes no sense.");
79 err("tx buffer length is larger than 4. Not supported.");
84 debug_dump(tx,txlen,deb_data);
86 value = ((txlen - 2) << 8) | tx[1];
89 index |= (tx[2] << 8);
93 status = usb_control_msg(d->udev, usb_rcvctrlpipe(d->udev,0), tx[0],
94 USB_TYPE_VENDOR | USB_DIR_IN, value, index, rx, rxlen,
95 USB_CTRL_GET_TIMEOUT);
98 deb_info("ep 0 read error (status = %d)\n",status);
101 debug_dump(rx, rxlen, deb_data);
103 return status; /* length in case of success */
106 int dib0700_set_gpio(struct dvb_usb_device *d, enum dib07x0_gpios gpio, u8 gpio_dir, u8 gpio_val)
108 u8 buf[3] = { REQUEST_SET_GPIO, gpio, ((gpio_dir & 0x01) << 7) | ((gpio_val & 0x01) << 6) };
109 return dib0700_ctrl_wr(d, buf, sizeof(buf));
112 static int dib0700_set_usb_xfer_len(struct dvb_usb_device *d, u16 nb_ts_packets)
114 struct dib0700_state *st = d->priv;
118 if (st->fw_version >= 0x10201) {
119 b[0] = REQUEST_SET_USB_XFER_LEN;
120 b[1] = (nb_ts_packets >> 8) & 0xff;
121 b[2] = nb_ts_packets & 0xff;
123 deb_info("set the USB xfer len to %i Ts packet\n", nb_ts_packets);
125 ret = dib0700_ctrl_wr(d, b, sizeof(b));
127 deb_info("this firmware does not allow to change the USB xfer len\n");
135 * I2C master xfer function (supported in 1.20 firmware)
137 static int dib0700_i2c_xfer_new(struct i2c_adapter *adap, struct i2c_msg *msg,
140 /* The new i2c firmware messages are more reliable and in particular
141 properly support i2c read calls not preceded by a write */
143 struct dvb_usb_device *d = i2c_get_adapdata(adap);
144 uint8_t bus_mode = 1; /* 0=eeprom bus, 1=frontend bus */
145 uint8_t gen_mode = 0; /* 0=master i2c, 1=gpio i2c */
146 uint8_t en_start = 0;
148 uint8_t buf[255]; /* TBV: malloc ? */
151 /* Ensure nobody else hits the i2c bus while we're sending our
152 sequence of messages, (such as the remote control thread) */
153 if (mutex_lock_interruptible(&d->i2c_mutex) < 0)
156 for (i = 0; i < num; i++) {
158 /* First message in the transaction */
160 } else if (!(msg[i].flags & I2C_M_NOSTART)) {
161 /* Device supports repeated-start */
164 /* Not the first packet and device doesn't support
168 if (i == (num - 1)) {
169 /* Last message in the transaction */
173 if (msg[i].flags & I2C_M_RD) {
178 i2c_dest = (msg[i].addr << 1);
179 value = ((en_start << 7) | (en_stop << 6) |
180 (msg[i].len & 0x3F)) << 8 | i2c_dest;
181 /* I2C ctrl + FE bus; */
182 index = ((gen_mode << 6) & 0xC0) |
183 ((bus_mode << 4) & 0x30);
185 result = usb_control_msg(d->udev,
186 usb_rcvctrlpipe(d->udev, 0),
187 REQUEST_NEW_I2C_READ,
188 USB_TYPE_VENDOR | USB_DIR_IN,
189 value, index, msg[i].buf,
191 USB_CTRL_GET_TIMEOUT);
193 err("i2c read error (status = %d)\n", result);
198 debug_dump(msg[i].buf, msg[i].len, deb_data);
202 buf[0] = REQUEST_NEW_I2C_WRITE;
203 buf[1] = msg[i].addr << 1;
204 buf[2] = (en_start << 7) | (en_stop << 6) |
206 /* I2C ctrl + FE bus; */
207 buf[3] = ((gen_mode << 6) & 0xC0) |
208 ((bus_mode << 4) & 0x30);
209 /* The Actual i2c payload */
210 memcpy(&buf[4], msg[i].buf, msg[i].len);
213 debug_dump(buf, msg[i].len + 4, deb_data);
215 result = usb_control_msg(d->udev,
216 usb_sndctrlpipe(d->udev, 0),
217 REQUEST_NEW_I2C_WRITE,
218 USB_TYPE_VENDOR | USB_DIR_OUT,
219 0, 0, buf, msg[i].len + 4,
220 USB_CTRL_GET_TIMEOUT);
222 err("i2c write error (status = %d)\n", result);
227 mutex_unlock(&d->i2c_mutex);
232 * I2C master xfer function (pre-1.20 firmware)
234 static int dib0700_i2c_xfer_legacy(struct i2c_adapter *adap,
235 struct i2c_msg *msg, int num)
237 struct dvb_usb_device *d = i2c_get_adapdata(adap);
241 if (mutex_lock_interruptible(&d->i2c_mutex) < 0)
244 for (i = 0; i < num; i++) {
245 /* fill in the address */
246 buf[1] = msg[i].addr << 1;
247 /* fill the buffer */
248 memcpy(&buf[2], msg[i].buf, msg[i].len);
250 /* write/read request */
251 if (i+1 < num && (msg[i+1].flags & I2C_M_RD)) {
252 buf[0] = REQUEST_I2C_READ;
255 /* special thing in the current firmware: when length is zero the read-failed */
256 if ((len = dib0700_ctrl_rd(d, buf, msg[i].len + 2, msg[i+1].buf, msg[i+1].len)) <= 0) {
257 deb_info("I2C read failed on address 0x%02x\n",
266 buf[0] = REQUEST_I2C_WRITE;
267 if (dib0700_ctrl_wr(d, buf, msg[i].len + 2) < 0)
272 mutex_unlock(&d->i2c_mutex);
276 static int dib0700_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg *msg,
279 struct dvb_usb_device *d = i2c_get_adapdata(adap);
280 struct dib0700_state *st = d->priv;
282 if (st->fw_use_new_i2c_api == 1) {
283 /* User running at least fw 1.20 */
284 return dib0700_i2c_xfer_new(adap, msg, num);
286 /* Use legacy calls */
287 return dib0700_i2c_xfer_legacy(adap, msg, num);
291 static u32 dib0700_i2c_func(struct i2c_adapter *adapter)
296 struct i2c_algorithm dib0700_i2c_algo = {
297 .master_xfer = dib0700_i2c_xfer,
298 .functionality = dib0700_i2c_func,
301 int dib0700_identify_state(struct usb_device *udev, struct dvb_usb_device_properties *props,
302 struct dvb_usb_device_description **desc, int *cold)
305 s16 ret = usb_control_msg(udev, usb_rcvctrlpipe(udev,0),
306 REQUEST_GET_VERSION, USB_TYPE_VENDOR | USB_DIR_IN, 0, 0, b, 16, USB_CTRL_GET_TIMEOUT);
308 deb_info("FW GET_VERSION length: %d\n",ret);
312 deb_info("cold: %d\n", *cold);
316 static int dib0700_set_clock(struct dvb_usb_device *d, u8 en_pll,
317 u8 pll_src, u8 pll_range, u8 clock_gpio3, u16 pll_prediv,
318 u16 pll_loopdiv, u16 free_div, u16 dsuScaler)
321 b[0] = REQUEST_SET_CLOCK;
322 b[1] = (en_pll << 7) | (pll_src << 6) | (pll_range << 5) | (clock_gpio3 << 4);
323 b[2] = (pll_prediv >> 8) & 0xff; // MSB
324 b[3] = pll_prediv & 0xff; // LSB
325 b[4] = (pll_loopdiv >> 8) & 0xff; // MSB
326 b[5] = pll_loopdiv & 0xff; // LSB
327 b[6] = (free_div >> 8) & 0xff; // MSB
328 b[7] = free_div & 0xff; // LSB
329 b[8] = (dsuScaler >> 8) & 0xff; // MSB
330 b[9] = dsuScaler & 0xff; // LSB
332 return dib0700_ctrl_wr(d, b, 10);
335 int dib0700_ctrl_clock(struct dvb_usb_device *d, u32 clk_MHz, u8 clock_out_gp3)
338 case 72: dib0700_set_clock(d, 1, 0, 1, clock_out_gp3, 2, 24, 0, 0x4c); break;
339 default: return -EINVAL;
344 static int dib0700_jumpram(struct usb_device *udev, u32 address)
347 u8 buf[8] = { REQUEST_JUMPRAM, 0, 0, 0,
348 (address >> 24) & 0xff,
349 (address >> 16) & 0xff,
350 (address >> 8) & 0xff,
353 if ((ret = usb_bulk_msg(udev, usb_sndbulkpipe(udev, 0x01),buf,8,&actlen,1000)) < 0) {
354 deb_fw("jumpram to 0x%x failed\n",address);
358 deb_fw("jumpram to 0x%x failed\n",address);
364 int dib0700_download_firmware(struct usb_device *udev, const struct firmware *fw)
367 int pos = 0, ret, act_len, i, adap_num;
373 while ((ret = dvb_usb_get_hexline(fw, &hx, &pos)) > 0) {
374 deb_fwdata("writing to address 0x%08x (buffer: 0x%02x %02x)\n",
375 hx.addr, hx.len, hx.chk);
378 buf[1] = (hx.addr >> 8) & 0xff;
379 buf[2] = hx.addr & 0xff;
381 memcpy(&buf[4],hx.data,hx.len);
382 buf[4+hx.len] = hx.chk;
384 ret = usb_bulk_msg(udev,
385 usb_sndbulkpipe(udev, 0x01),
392 err("firmware download failed at %d with %d",pos,ret);
398 /* start the firmware */
399 if ((ret = dib0700_jumpram(udev, 0x70000000)) == 0) {
400 info("firmware started successfully.");
406 /* the number of ts packet has to be at least 1 */
407 if (nb_packet_buffer_size < 1)
408 nb_packet_buffer_size = 1;
410 /* get the fimware version */
411 usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
413 USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
414 b, sizeof(b), USB_CTRL_GET_TIMEOUT);
415 fw_version = (b[8] << 24) | (b[9] << 16) | (b[10] << 8) | b[11];
417 /* set the buffer size - DVB-USB is allocating URB buffers
418 * only after the firwmare download was successful */
419 for (i = 0; i < dib0700_device_count; i++) {
420 for (adap_num = 0; adap_num < dib0700_devices[i].num_adapters;
422 if (fw_version >= 0x10201) {
423 dib0700_devices[i].adapter[adap_num].stream.u.bulk.buffersize = 188*nb_packet_buffer_size;
425 /* for fw version older than 1.20.1,
426 * the buffersize has to be n times 512 */
427 dib0700_devices[i].adapter[adap_num].stream.u.bulk.buffersize = ((188*nb_packet_buffer_size+188/2)/512)*512;
428 if (dib0700_devices[i].adapter[adap_num].stream.u.bulk.buffersize < 512)
429 dib0700_devices[i].adapter[adap_num].stream.u.bulk.buffersize = 512;
437 int dib0700_streaming_ctrl(struct dvb_usb_adapter *adap, int onoff)
439 struct dib0700_state *st = adap->dev->priv;
443 if ((onoff != 0) && (st->fw_version >= 0x10201)) {
444 /* for firmware later than 1.20.1,
445 * the USB xfer length can be set */
446 ret = dib0700_set_usb_xfer_len(adap->dev,
447 st->nb_packet_buffer_size);
449 deb_info("can not set the USB xfer len\n");
454 b[0] = REQUEST_ENABLE_VIDEO;
455 b[1] = (onoff << 4) | 0x00; /* this bit gives a kind of command, rather than enabling something or not */
457 if (st->disable_streaming_master_mode == 1)
460 b[2] = 0x01 << 4; /* Master mode */
464 deb_info("modifying (%d) streaming state for %d\n", onoff, adap->id);
467 st->channel_state |= 1 << adap->id;
469 st->channel_state &= ~(1 << adap->id);
471 b[2] |= st->channel_state;
473 deb_info("data for streaming: %x %x\n", b[1], b[2]);
475 return dib0700_ctrl_wr(adap->dev, b, 4);
478 /* Number of keypresses to ignore before start repeating */
479 #define RC_REPEAT_DELAY_V1_20 10
481 /* This is the structure of the RC response packet starting in firmware 1.20 */
482 struct dib0700_rc_response {
489 #define RC_MSG_SIZE_V1_20 6
491 static void dib0700_rc_urb_completion(struct urb *purb)
493 struct dvb_usb_device *d = purb->context;
494 struct dvb_usb_rc_key *keymap;
495 struct dib0700_state *st;
496 struct dib0700_rc_response poll_reply;
503 deb_info("%s()\n", __func__);
507 if (d->rc_input_dev == NULL) {
508 /* This will occur if disable_rc_polling=1 */
513 keymap = d->props.rc_key_map;
515 buf = (u8 *)purb->transfer_buffer;
517 if (purb->status < 0) {
518 deb_info("discontinuing polling\n");
523 if (purb->actual_length != RC_MSG_SIZE_V1_20) {
524 deb_info("malformed rc msg size=%d\n", purb->actual_length);
528 /* Set initial results in case we exit the function early */
530 state = REMOTE_NO_KEY_PRESSED;
532 deb_data("IR raw %02X %02X %02X %02X %02X %02X (len %d)\n", buf[0],
533 buf[1], buf[2], buf[3], buf[4], buf[5], purb->actual_length);
535 switch (dvb_usb_dib0700_ir_proto) {
538 poll_reply.report_id = 0;
539 poll_reply.data_state = 1;
540 poll_reply.system = buf[2];
541 poll_reply.data = buf[4];
542 poll_reply.not_data = buf[5];
544 /* NEC protocol sends repeat code as 0 0 0 FF */
545 if ((poll_reply.system == 0x00) && (poll_reply.data == 0x00)
546 && (poll_reply.not_data == 0xff)) {
547 poll_reply.data_state = 2;
553 poll_reply.report_id = buf[0];
554 poll_reply.data_state = buf[1];
555 poll_reply.system = (buf[2] << 8) | buf[3];
556 poll_reply.data = buf[4];
557 poll_reply.not_data = buf[5];
561 if ((poll_reply.data + poll_reply.not_data) != 0xff) {
562 /* Key failed integrity check */
563 err("key failed integrity check: %04x %02x %02x",
565 poll_reply.data, poll_reply.not_data);
569 deb_data("rid=%02x ds=%02x sm=%04x d=%02x nd=%02x\n",
570 poll_reply.report_id, poll_reply.data_state,
571 poll_reply.system, poll_reply.data, poll_reply.not_data);
573 /* Find the key in the map */
574 for (i = 0; i < d->props.rc_key_map_size; i++) {
575 if (rc5_custom(&keymap[i]) == (poll_reply.system & 0xff) &&
576 rc5_data(&keymap[i]) == poll_reply.data) {
577 event = keymap[i].event;
584 err("Unknown remote controller key: %04x %02x %02x",
585 poll_reply.system, poll_reply.data, poll_reply.not_data);
590 if (poll_reply.data_state == 1) {
593 event = keymap[i].event;
594 state = REMOTE_KEY_PRESSED;
595 d->last_event = keymap[i].event;
596 } else if (poll_reply.data_state == 2) {
600 /* prevents unwanted double hits */
601 if (st->rc_counter > RC_REPEAT_DELAY_V1_20) {
602 event = d->last_event;
603 state = REMOTE_KEY_PRESSED;
604 st->rc_counter = RC_REPEAT_DELAY_V1_20;
607 err("Unknown data state [%d]", poll_reply.data_state);
611 case REMOTE_NO_KEY_PRESSED:
613 case REMOTE_KEY_PRESSED:
614 deb_info("key pressed\n");
615 d->last_event = event;
616 case REMOTE_KEY_REPEAT:
617 deb_info("key repeated\n");
618 input_event(d->rc_input_dev, EV_KEY, event, 1);
619 input_sync(d->rc_input_dev);
620 input_event(d->rc_input_dev, EV_KEY, d->last_event, 0);
621 input_sync(d->rc_input_dev);
628 /* Clean the buffer before we requeue */
629 memset(purb->transfer_buffer, 0, RC_MSG_SIZE_V1_20);
632 usb_submit_urb(purb, GFP_ATOMIC);
635 int dib0700_rc_setup(struct dvb_usb_device *d)
637 struct dib0700_state *st = d->priv;
638 u8 rc_setup[3] = { REQUEST_SET_RC, dvb_usb_dib0700_ir_proto, 0 };
643 if (d->props.rc_key_map == NULL)
646 /* Set the IR mode */
647 i = dib0700_ctrl_wr(d, rc_setup, sizeof(rc_setup));
649 err("ir protocol setup failed");
653 if (st->fw_version < 0x10200)
656 /* Starting in firmware 1.20, the RC info is provided on a bulk pipe */
657 purb = usb_alloc_urb(0, GFP_KERNEL);
659 err("rc usb alloc urb failed\n");
663 purb->transfer_buffer = kzalloc(RC_MSG_SIZE_V1_20, GFP_KERNEL);
664 if (purb->transfer_buffer == NULL) {
665 err("rc kzalloc failed\n");
670 purb->status = -EINPROGRESS;
671 usb_fill_bulk_urb(purb, d->udev, usb_rcvbulkpipe(d->udev, 1),
672 purb->transfer_buffer, RC_MSG_SIZE_V1_20,
673 dib0700_rc_urb_completion, d);
675 ret = usb_submit_urb(purb, GFP_ATOMIC);
677 err("rc submit urb failed\n");
682 static int dib0700_probe(struct usb_interface *intf,
683 const struct usb_device_id *id)
686 struct dvb_usb_device *dev;
688 for (i = 0; i < dib0700_device_count; i++)
689 if (dvb_usb_device_init(intf, &dib0700_devices[i], THIS_MODULE,
690 &dev, adapter_nr) == 0) {
691 struct dib0700_state *st = dev->priv;
692 u32 hwversion, romversion, fw_version, fwtype;
694 dib0700_get_version(dev, &hwversion, &romversion,
695 &fw_version, &fwtype);
697 deb_info("Firmware version: %x, %d, 0x%x, %d\n",
698 hwversion, romversion, fw_version, fwtype);
700 st->fw_version = fw_version;
701 st->nb_packet_buffer_size = (u32)nb_packet_buffer_size;
703 dib0700_rc_setup(dev);
711 static struct usb_driver dib0700_driver = {
712 .name = "dvb_usb_dib0700",
713 .probe = dib0700_probe,
714 .disconnect = dvb_usb_device_exit,
715 .id_table = dib0700_usb_id_table,
719 static int __init dib0700_module_init(void)
722 info("loaded with support for %d different device-types", dib0700_device_count);
723 if ((result = usb_register(&dib0700_driver))) {
724 err("usb_register failed. Error number %d",result);
731 static void __exit dib0700_module_exit(void)
733 /* deregister this driver from the USB subsystem */
734 usb_deregister(&dib0700_driver);
737 module_init (dib0700_module_init);
738 module_exit (dib0700_module_exit);
740 MODULE_AUTHOR("Patrick Boettcher <pboettcher@dibcom.fr>");
741 MODULE_DESCRIPTION("Driver for devices based on DiBcom DiB0700 - USB bridge");
742 MODULE_VERSION("1.0");
743 MODULE_LICENSE("GPL");