2 * Linux driver for Technisat DVB-S/S2 USB 2.0 device
4 * Copyright (C) 2010 Patrick Boettcher,
5 * Kernel Labs Inc. PO Box 745, St James, NY 11780
7 * Development was sponsored by Technisat Digital UK Limited, whose
8 * registered office is Witan Gate House 500 - 600 Witan Gate West,
9 * Milton Keynes, MK9 1SH
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License as
13 * published by the Free Software Foundation; either version 2 of the
14 * License, or (at your option) any later version.
17 * THIS PROGRAM IS PROVIDED "AS IS" AND BOTH THE COPYRIGHT HOLDER AND
18 * TECHNISAT DIGITAL UK LTD DISCLAIM ALL WARRANTIES WITH REGARD TO
19 * THIS PROGRAM INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY OR
20 * FITNESS FOR A PARTICULAR PURPOSE. NEITHER THE COPYRIGHT HOLDER
21 * NOR TECHNISAT DIGITAL UK LIMITED SHALL BE LIABLE FOR ANY SPECIAL,
22 * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
23 * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
24 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
25 * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS PROGRAM. See the
26 * GNU General Public License for more details.
29 #define DVB_USB_LOG_PREFIX "technisat-usb2"
35 /* module parameters */
36 DVB_DEFINE_MOD_OPT_ADAPTER_NR(adapter_nr);
39 module_param(debug, int, 0644);
40 MODULE_PARM_DESC(debug,
41 "set debugging level (bit-mask: 1=info,2=eeprom,4=i2c,8=rc)." \
42 DVB_USB_DEBUG_STATUS);
44 /* disables all LED control command and
45 * also does not start the signal polling thread */
46 static int disable_led_control;
47 module_param(disable_led_control, int, 0444);
48 MODULE_PARM_DESC(disable_led_control,
49 "disable LED control of the device (default: 0 - LED control is active).");
51 /* device private data */
52 struct technisat_usb2_state {
53 struct dvb_usb_device *dev;
54 struct delayed_work green_led_work;
62 /* debug print helpers */
63 #define deb_info(args...) dprintk(debug, 0x01, args)
64 #define deb_eeprom(args...) dprintk(debug, 0x02, args)
65 #define deb_i2c(args...) dprintk(debug, 0x04, args)
66 #define deb_rc(args...) dprintk(debug, 0x08, args)
69 #define SET_IFCLK_TO_EXTERNAL_TSCLK_VENDOR_REQUEST 0xB3
70 #define SET_FRONT_END_RESET_VENDOR_REQUEST 0xB4
71 #define GET_VERSION_INFO_VENDOR_REQUEST 0xB5
72 #define SET_GREEN_LED_VENDOR_REQUEST 0xB6
73 #define SET_RED_LED_VENDOR_REQUEST 0xB7
74 #define GET_IR_DATA_VENDOR_REQUEST 0xB8
75 #define SET_LED_TIMER_DIVIDER_VENDOR_REQUEST 0xB9
76 #define SET_USB_REENUMERATION 0xBA
78 /* i2c-access methods */
79 #define I2C_SPEED_100KHZ_BIT 0x40
81 #define I2C_STATUS_NAK 7
82 #define I2C_STATUS_OK 8
84 static int technisat_usb2_i2c_access(struct usb_device *udev,
85 u8 device_addr, u8 *tx, u8 txlen, u8 *rx, u8 rxlen)
88 int ret, actual_length;
90 b = kmalloc(64, GFP_KERNEL);
94 deb_i2c("i2c-access: %02x, tx: ", device_addr);
95 debug_dump(tx, txlen, deb_i2c);
99 err("i2c TX buffer can't exceed 62 bytes (dev 0x%02x)",
104 err("i2c RX buffer can't exceed 62 bytes (dev 0x%02x)",
109 b[0] = I2C_SPEED_100KHZ_BIT;
110 b[1] = device_addr << 1;
117 memcpy(&b[2], tx, txlen);
118 ret = usb_bulk_msg(udev,
119 usb_sndbulkpipe(udev, 0x01),
124 err("i2c-error: out failed %02x = %d", device_addr, ret);
128 ret = usb_bulk_msg(udev,
129 usb_rcvbulkpipe(udev, 0x01),
130 b, 64, &actual_length, 1000);
132 err("i2c-error: in failed %02x = %d", device_addr, ret);
136 if (b[0] != I2C_STATUS_OK) {
137 err("i2c-error: %02x = %d", device_addr, b[0]);
138 /* handle tuner-i2c-nak */
139 if (!(b[0] == I2C_STATUS_NAK &&
141 /* && device_is_technisat_usb2 */))
145 deb_i2c("status: %d, ", b[0]);
148 memcpy(rx, &b[2], rxlen);
150 deb_i2c("rx (%d): ", rxlen);
151 debug_dump(rx, rxlen, deb_i2c);
161 static int technisat_usb2_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg *msg,
165 struct dvb_usb_device *d = i2c_get_adapdata(adap);
167 /* Ensure nobody else hits the i2c bus while we're sending our
168 sequence of messages, (such as the remote control thread) */
169 if (mutex_lock_interruptible(&d->i2c_mutex) < 0)
172 for (i = 0; i < num; i++) {
173 if (i+1 < num && msg[i+1].flags & I2C_M_RD) {
174 ret = technisat_usb2_i2c_access(d->udev, msg[i+1].addr,
175 msg[i].buf, msg[i].len,
176 msg[i+1].buf, msg[i+1].len);
181 ret = technisat_usb2_i2c_access(d->udev, msg[i].addr,
182 msg[i].buf, msg[i].len,
192 mutex_unlock(&d->i2c_mutex);
197 static u32 technisat_usb2_i2c_func(struct i2c_adapter *adapter)
202 static struct i2c_algorithm technisat_usb2_i2c_algo = {
203 .master_xfer = technisat_usb2_i2c_xfer,
204 .functionality = technisat_usb2_i2c_func,
208 static void technisat_usb2_frontend_reset(struct usb_device *udev)
210 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
211 SET_FRONT_END_RESET_VENDOR_REQUEST,
212 USB_TYPE_VENDOR | USB_DIR_OUT,
219 enum technisat_usb2_led_state {
226 static int technisat_usb2_set_led(struct dvb_usb_device *d, int red,
227 enum technisat_usb2_led_state st)
229 struct technisat_usb2_state *state = d->priv;
230 u8 *led = state->buf;
233 led[0] = red ? SET_RED_LED_VENDOR_REQUEST : SET_GREEN_LED_VENDOR_REQUEST;
235 if (disable_led_control && st != TECH_LED_OFF)
262 if (mutex_lock_interruptible(&d->i2c_mutex) < 0)
265 ret = usb_control_msg(d->udev, usb_sndctrlpipe(d->udev, 0),
266 red ? SET_RED_LED_VENDOR_REQUEST : SET_GREEN_LED_VENDOR_REQUEST,
267 USB_TYPE_VENDOR | USB_DIR_OUT,
271 mutex_unlock(&d->i2c_mutex);
275 static int technisat_usb2_set_led_timer(struct dvb_usb_device *d, u8 red, u8 green)
277 struct technisat_usb2_state *state = d->priv;
283 if (mutex_lock_interruptible(&d->i2c_mutex) < 0)
286 ret = usb_control_msg(d->udev, usb_sndctrlpipe(d->udev, 0),
287 SET_LED_TIMER_DIVIDER_VENDOR_REQUEST,
288 USB_TYPE_VENDOR | USB_DIR_OUT,
289 (red << 8) | green, 0,
292 mutex_unlock(&d->i2c_mutex);
297 static void technisat_usb2_green_led_control(struct work_struct *work)
299 struct technisat_usb2_state *state =
300 container_of(work, struct technisat_usb2_state, green_led_work.work);
301 struct dvb_frontend *fe = state->dev->adapter[0].fe_adap[0].fe;
303 if (state->power_state == 0)
307 enum fe_status status;
309 if (fe->ops.read_status(fe, &status) != 0)
312 if (status & FE_HAS_LOCK) {
315 if (fe->ops.read_ber(fe, &ber) != 0)
319 technisat_usb2_set_led(state->dev, 0, TECH_LED_BLINK);
321 technisat_usb2_set_led(state->dev, 0, TECH_LED_ON);
323 technisat_usb2_set_led(state->dev, 0, TECH_LED_OFF);
327 schedule_delayed_work(&state->green_led_work,
328 msecs_to_jiffies(500));
331 /* method to find out whether the firmware has to be downloaded or not */
332 static int technisat_usb2_identify_state(struct usb_device *udev,
333 const struct dvb_usb_device_properties *props,
334 const struct dvb_usb_device_description **desc, int *cold)
339 version = kmalloc(3, GFP_KERNEL);
343 /* first select the interface */
344 if (usb_set_interface(udev, 0, 1) != 0)
345 err("could not set alternate setting to 0");
347 info("set alternate setting");
349 *cold = 0; /* by default do not download a firmware - just in case something is wrong */
351 ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
352 GET_VERSION_INFO_VENDOR_REQUEST,
353 USB_TYPE_VENDOR | USB_DIR_IN,
360 info("firmware version: %d.%d", version[1], version[2]);
370 static int technisat_usb2_power_ctrl(struct dvb_usb_device *d, int level)
372 struct technisat_usb2_state *state = d->priv;
374 state->power_state = level;
376 if (disable_led_control)
379 /* green led is turned off in any case - will be turned on when tuning */
380 technisat_usb2_set_led(d, 0, TECH_LED_OFF);
381 /* red led is turned on all the time */
382 technisat_usb2_set_led(d, 1, TECH_LED_ON);
386 /* mac address reading - from the eeprom */
388 static void technisat_usb2_eeprom_dump(struct dvb_usb_device *d)
394 /* full EEPROM dump */
395 for (j = 0; j < 256 * 4; j += 16) {
397 if (technisat_usb2_i2c_access(d->udev, 0x50 + j / 256, ®, 1, b, 16) != 0)
400 deb_eeprom("EEPROM: %01x%02x: ", j / 256, reg);
401 for (i = 0; i < 16; i++)
402 deb_eeprom("%02x ", b[i]);
408 static u8 technisat_usb2_calc_lrc(const u8 *b, u16 length)
416 static int technisat_usb2_eeprom_lrc_read(struct dvb_usb_device *d,
417 u16 offset, u8 *b, u16 length, u8 tries)
419 u8 bo = offset & 0xff;
420 struct i2c_msg msg[] = {
422 .addr = 0x50 | ((offset >> 8) & 0x3),
426 .addr = 0x50 | ((offset >> 8) & 0x3),
436 if (i2c_transfer(&d->i2c_adap, msg, 2) != 2)
440 technisat_usb2_calc_lrc(b, length - 1) == b[length - 1];
449 #define EEPROM_MAC_START 0x3f8
450 #define EEPROM_MAC_TOTAL 8
451 static int technisat_usb2_read_mac_address(struct dvb_usb_device *d,
454 u8 buf[EEPROM_MAC_TOTAL];
456 if (technisat_usb2_eeprom_lrc_read(d, EEPROM_MAC_START,
457 buf, EEPROM_MAC_TOTAL, 4) != 0)
464 static struct stv090x_config technisat_usb2_stv090x_config;
466 /* frontend attach */
467 static int technisat_usb2_set_voltage(struct dvb_frontend *fe,
468 enum fe_sec_voltage voltage)
471 u8 gpio[3] = { 0 }; /* 0 = 2, 1 = 3, 2 = 4 */
473 gpio[2] = 1; /* high - voltage ? */
484 case SEC_VOLTAGE_OFF:
488 for (i = 0; i < 3; i++)
489 if (technisat_usb2_stv090x_config.set_gpio(fe, i+2, 0,
495 static struct stv090x_config technisat_usb2_stv090x_config = {
497 .demod_mode = STV090x_SINGLE,
498 .clk_mode = STV090x_CLK_EXT,
503 .ts1_mode = STV090x_TSMODE_DVBCI,
507 .repeater_level = STV090x_RPTLEVEL_64,
512 static struct stv6110x_config technisat_usb2_stv6110x_config = {
518 static int technisat_usb2_frontend_attach(struct dvb_usb_adapter *a)
520 struct usb_device *udev = a->dev->udev;
523 a->fe_adap[0].fe = dvb_attach(stv090x_attach, &technisat_usb2_stv090x_config,
524 &a->dev->i2c_adap, STV090x_DEMODULATOR_0);
526 if (a->fe_adap[0].fe) {
527 const struct stv6110x_devctl *ctl;
529 ctl = dvb_attach(stv6110x_attach,
531 &technisat_usb2_stv6110x_config,
535 technisat_usb2_stv090x_config.tuner_init = ctl->tuner_init;
536 technisat_usb2_stv090x_config.tuner_sleep = ctl->tuner_sleep;
537 technisat_usb2_stv090x_config.tuner_set_mode = ctl->tuner_set_mode;
538 technisat_usb2_stv090x_config.tuner_set_frequency = ctl->tuner_set_frequency;
539 technisat_usb2_stv090x_config.tuner_get_frequency = ctl->tuner_get_frequency;
540 technisat_usb2_stv090x_config.tuner_set_bandwidth = ctl->tuner_set_bandwidth;
541 technisat_usb2_stv090x_config.tuner_get_bandwidth = ctl->tuner_get_bandwidth;
542 technisat_usb2_stv090x_config.tuner_set_bbgain = ctl->tuner_set_bbgain;
543 technisat_usb2_stv090x_config.tuner_get_bbgain = ctl->tuner_get_bbgain;
544 technisat_usb2_stv090x_config.tuner_set_refclk = ctl->tuner_set_refclk;
545 technisat_usb2_stv090x_config.tuner_get_status = ctl->tuner_get_status;
547 /* call the init function once to initialize
548 tuner's clock output divider and demod's
550 if (a->fe_adap[0].fe->ops.init)
551 a->fe_adap[0].fe->ops.init(a->fe_adap[0].fe);
553 if (mutex_lock_interruptible(&a->dev->i2c_mutex) < 0)
556 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
557 SET_IFCLK_TO_EXTERNAL_TSCLK_VENDOR_REQUEST,
558 USB_TYPE_VENDOR | USB_DIR_OUT,
561 mutex_unlock(&a->dev->i2c_mutex);
564 err("could not set IF_CLK to external");
566 a->fe_adap[0].fe->ops.set_voltage = technisat_usb2_set_voltage;
568 /* if everything was successful assign a nice name to the frontend */
569 strscpy(a->fe_adap[0].fe->ops.info.name,
571 sizeof(a->fe_adap[0].fe->ops.info.name));
573 dvb_frontend_detach(a->fe_adap[0].fe);
574 a->fe_adap[0].fe = NULL;
578 technisat_usb2_set_led_timer(a->dev, 1, 1);
580 return a->fe_adap[0].fe == NULL ? -ENODEV : 0;
585 /* the device is giving providing raw IR-signals to the host mapping
586 * it only to one remote control is just the default implementation
588 #define NOMINAL_IR_BIT_TRANSITION_TIME_US 889
589 #define NOMINAL_IR_BIT_TIME_US (2 * NOMINAL_IR_BIT_TRANSITION_TIME_US)
591 #define FIRMWARE_CLOCK_TICK 83333
592 #define FIRMWARE_CLOCK_DIVISOR 256
594 #define IR_PERCENT_TOLERANCE 15
596 #define NOMINAL_IR_BIT_TRANSITION_TICKS ((NOMINAL_IR_BIT_TRANSITION_TIME_US * 1000 * 1000) / FIRMWARE_CLOCK_TICK)
597 #define NOMINAL_IR_BIT_TRANSITION_TICK_COUNT (NOMINAL_IR_BIT_TRANSITION_TICKS / FIRMWARE_CLOCK_DIVISOR)
599 #define NOMINAL_IR_BIT_TIME_TICKS ((NOMINAL_IR_BIT_TIME_US * 1000 * 1000) / FIRMWARE_CLOCK_TICK)
600 #define NOMINAL_IR_BIT_TIME_TICK_COUNT (NOMINAL_IR_BIT_TIME_TICKS / FIRMWARE_CLOCK_DIVISOR)
602 #define MINIMUM_IR_BIT_TRANSITION_TICK_COUNT (NOMINAL_IR_BIT_TRANSITION_TICK_COUNT - ((NOMINAL_IR_BIT_TRANSITION_TICK_COUNT * IR_PERCENT_TOLERANCE) / 100))
603 #define MAXIMUM_IR_BIT_TRANSITION_TICK_COUNT (NOMINAL_IR_BIT_TRANSITION_TICK_COUNT + ((NOMINAL_IR_BIT_TRANSITION_TICK_COUNT * IR_PERCENT_TOLERANCE) / 100))
605 #define MINIMUM_IR_BIT_TIME_TICK_COUNT (NOMINAL_IR_BIT_TIME_TICK_COUNT - ((NOMINAL_IR_BIT_TIME_TICK_COUNT * IR_PERCENT_TOLERANCE) / 100))
606 #define MAXIMUM_IR_BIT_TIME_TICK_COUNT (NOMINAL_IR_BIT_TIME_TICK_COUNT + ((NOMINAL_IR_BIT_TIME_TICK_COUNT * IR_PERCENT_TOLERANCE) / 100))
608 static int technisat_usb2_get_ir(struct dvb_usb_device *d)
610 struct technisat_usb2_state *state = d->priv;
611 struct ir_raw_event ev;
612 u8 *buf = state->buf;
615 buf[0] = GET_IR_DATA_VENDOR_REQUEST;
618 buf[3] = MINIMUM_IR_BIT_TRANSITION_TICK_COUNT;
619 buf[4] = MAXIMUM_IR_BIT_TIME_TICK_COUNT;
621 if (mutex_lock_interruptible(&d->i2c_mutex) < 0)
623 ret = usb_control_msg(d->udev, usb_sndctrlpipe(d->udev, 0),
624 GET_IR_DATA_VENDOR_REQUEST,
625 USB_TYPE_VENDOR | USB_DIR_OUT,
633 ret = usb_control_msg(d->udev, usb_rcvctrlpipe(d->udev, 0),
634 GET_IR_DATA_VENDOR_REQUEST,
635 USB_TYPE_VENDOR | USB_DIR_IN,
640 mutex_unlock(&d->i2c_mutex);
646 return 0; /* no key pressed */
651 deb_rc("RC: %d ", ret);
652 debug_dump(buf + 1, ret, deb_rc);
656 for (i = 1; i < ARRAY_SIZE(state->buf); i++) {
657 if (buf[i] == 0xff) {
659 ev.duration = 889 * 2;
660 ir_raw_event_store(d->rc_dev, &ev);
664 ev.pulse = !ev.pulse;
665 ev.duration = (buf[i] * FIRMWARE_CLOCK_DIVISOR *
666 FIRMWARE_CLOCK_TICK) / (1000 * 1000);
667 ir_raw_event_store(d->rc_dev, &ev);
670 ir_raw_event_handle(d->rc_dev);
675 static int technisat_usb2_rc_query(struct dvb_usb_device *d)
677 int ret = technisat_usb2_get_ir(d);
685 if (!disable_led_control)
686 technisat_usb2_set_led(d, 1, TECH_LED_BLINK);
691 /* DVB-USB and USB stuff follows */
693 TECHNISAT_USB2_DVB_S2,
696 static struct usb_device_id technisat_usb2_id_table[] = {
697 DVB_USB_DEV(TECHNISAT, TECHNISAT_USB2_DVB_S2),
701 MODULE_DEVICE_TABLE(usb, technisat_usb2_id_table);
703 /* device description */
704 static struct dvb_usb_device_properties technisat_usb2_devices = {
705 .caps = DVB_USB_IS_AN_I2C_ADAPTER,
707 .usb_ctrl = CYPRESS_FX2,
709 .identify_state = technisat_usb2_identify_state,
710 .firmware = "dvb-usb-SkyStar_USB_HD_FW_v17_63.HEX.fw",
712 .size_of_priv = sizeof(struct technisat_usb2_state),
714 .i2c_algo = &technisat_usb2_i2c_algo,
716 .power_ctrl = technisat_usb2_power_ctrl,
717 .read_mac_address = technisat_usb2_read_mac_address,
724 .frontend_attach = technisat_usb2_frontend_attach,
743 .num_device_descs = 1,
745 { "Technisat SkyStar USB HD (DVB-S/S2)",
746 { &technisat_usb2_id_table[TECHNISAT_USB2_DVB_S2], NULL },
753 .rc_codes = RC_MAP_TECHNISAT_USB2,
754 .module_name = "technisat-usb2",
755 .rc_query = technisat_usb2_rc_query,
756 .allowed_protos = RC_PROTO_BIT_ALL_IR_DECODER,
757 .driver_type = RC_DRIVER_IR_RAW,
761 static int technisat_usb2_probe(struct usb_interface *intf,
762 const struct usb_device_id *id)
764 struct dvb_usb_device *dev;
766 if (dvb_usb_device_init(intf, &technisat_usb2_devices, THIS_MODULE,
767 &dev, adapter_nr) != 0)
771 struct technisat_usb2_state *state = dev->priv;
774 if (!disable_led_control) {
775 INIT_DELAYED_WORK(&state->green_led_work,
776 technisat_usb2_green_led_control);
777 schedule_delayed_work(&state->green_led_work,
778 msecs_to_jiffies(500));
785 static void technisat_usb2_disconnect(struct usb_interface *intf)
787 struct dvb_usb_device *dev = usb_get_intfdata(intf);
789 /* work and stuff was only created when the device is hot-state */
791 struct technisat_usb2_state *state = dev->priv;
793 cancel_delayed_work_sync(&state->green_led_work);
796 dvb_usb_device_exit(intf);
799 static struct usb_driver technisat_usb2_driver = {
800 .name = "dvb_usb_technisat_usb2",
801 .probe = technisat_usb2_probe,
802 .disconnect = technisat_usb2_disconnect,
803 .id_table = technisat_usb2_id_table,
806 module_usb_driver(technisat_usb2_driver);
809 MODULE_DESCRIPTION("Driver for Technisat DVB-S/S2 USB 2.0 device");
810 MODULE_VERSION("1.0");
811 MODULE_LICENSE("GPL");