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 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * THIS PROGRAM IS PROVIDED "AS IS" AND BOTH THE COPYRIGHT HOLDER AND
22 * TECHNISAT DIGITAL UK LTD DISCLAIM ALL WARRANTIES WITH REGARD TO
23 * THIS PROGRAM INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY OR
24 * FITNESS FOR A PARTICULAR PURPOSE. NEITHER THE COPYRIGHT HOLDER
25 * NOR TECHNISAT DIGITAL UK LIMITED SHALL BE LIABLE FOR ANY SPECIAL,
26 * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
27 * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
28 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
29 * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS PROGRAM. See the
30 * GNU General Public License for more details.
33 #define DVB_USB_LOG_PREFIX "technisat-usb2"
39 /* module parameters */
40 DVB_DEFINE_MOD_OPT_ADAPTER_NR(adapter_nr);
43 module_param(debug, int, 0644);
44 MODULE_PARM_DESC(debug,
45 "set debugging level (bit-mask: 1=info,2=eeprom,4=i2c,8=rc)." \
46 DVB_USB_DEBUG_STATUS);
48 /* disables all LED control command and
49 * also does not start the signal polling thread */
50 static int disable_led_control;
51 module_param(disable_led_control, int, 0444);
52 MODULE_PARM_DESC(disable_led_control,
53 "disable LED control of the device "
54 "(default: 0 - LED control is active).");
56 /* device private data */
57 struct technisat_usb2_state {
58 struct dvb_usb_device *dev;
59 struct delayed_work green_led_work;
67 /* debug print helpers */
68 #define deb_info(args...) dprintk(debug, 0x01, args)
69 #define deb_eeprom(args...) dprintk(debug, 0x02, args)
70 #define deb_i2c(args...) dprintk(debug, 0x04, args)
71 #define deb_rc(args...) dprintk(debug, 0x08, args)
74 #define SET_IFCLK_TO_EXTERNAL_TSCLK_VENDOR_REQUEST 0xB3
75 #define SET_FRONT_END_RESET_VENDOR_REQUEST 0xB4
76 #define GET_VERSION_INFO_VENDOR_REQUEST 0xB5
77 #define SET_GREEN_LED_VENDOR_REQUEST 0xB6
78 #define SET_RED_LED_VENDOR_REQUEST 0xB7
79 #define GET_IR_DATA_VENDOR_REQUEST 0xB8
80 #define SET_LED_TIMER_DIVIDER_VENDOR_REQUEST 0xB9
81 #define SET_USB_REENUMERATION 0xBA
83 /* i2c-access methods */
84 #define I2C_SPEED_100KHZ_BIT 0x40
86 #define I2C_STATUS_NAK 7
87 #define I2C_STATUS_OK 8
89 static int technisat_usb2_i2c_access(struct usb_device *udev,
90 u8 device_addr, u8 *tx, u8 txlen, u8 *rx, u8 rxlen)
93 int ret, actual_length;
95 b = kmalloc(64, GFP_KERNEL);
99 deb_i2c("i2c-access: %02x, tx: ", device_addr);
100 debug_dump(tx, txlen, deb_i2c);
104 err("i2c TX buffer can't exceed 62 bytes (dev 0x%02x)",
109 err("i2c RX buffer can't exceed 62 bytes (dev 0x%02x)",
114 b[0] = I2C_SPEED_100KHZ_BIT;
115 b[1] = device_addr << 1;
122 memcpy(&b[2], tx, txlen);
123 ret = usb_bulk_msg(udev,
124 usb_sndbulkpipe(udev, 0x01),
129 err("i2c-error: out failed %02x = %d", device_addr, ret);
133 ret = usb_bulk_msg(udev,
134 usb_rcvbulkpipe(udev, 0x01),
135 b, 64, &actual_length, 1000);
137 err("i2c-error: in failed %02x = %d", device_addr, ret);
141 if (b[0] != I2C_STATUS_OK) {
142 err("i2c-error: %02x = %d", device_addr, b[0]);
143 /* handle tuner-i2c-nak */
144 if (!(b[0] == I2C_STATUS_NAK &&
146 /* && device_is_technisat_usb2 */))
150 deb_i2c("status: %d, ", b[0]);
153 memcpy(rx, &b[2], rxlen);
155 deb_i2c("rx (%d): ", rxlen);
156 debug_dump(rx, rxlen, deb_i2c);
166 static int technisat_usb2_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg *msg,
170 struct dvb_usb_device *d = i2c_get_adapdata(adap);
172 /* Ensure nobody else hits the i2c bus while we're sending our
173 sequence of messages, (such as the remote control thread) */
174 if (mutex_lock_interruptible(&d->i2c_mutex) < 0)
177 for (i = 0; i < num; i++) {
178 if (i+1 < num && msg[i+1].flags & I2C_M_RD) {
179 ret = technisat_usb2_i2c_access(d->udev, msg[i+1].addr,
180 msg[i].buf, msg[i].len,
181 msg[i+1].buf, msg[i+1].len);
186 ret = technisat_usb2_i2c_access(d->udev, msg[i].addr,
187 msg[i].buf, msg[i].len,
197 mutex_unlock(&d->i2c_mutex);
202 static u32 technisat_usb2_i2c_func(struct i2c_adapter *adapter)
207 static struct i2c_algorithm technisat_usb2_i2c_algo = {
208 .master_xfer = technisat_usb2_i2c_xfer,
209 .functionality = technisat_usb2_i2c_func,
213 static void technisat_usb2_frontend_reset(struct usb_device *udev)
215 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
216 SET_FRONT_END_RESET_VENDOR_REQUEST,
217 USB_TYPE_VENDOR | USB_DIR_OUT,
224 enum technisat_usb2_led_state {
231 static int technisat_usb2_set_led(struct dvb_usb_device *d, int red,
232 enum technisat_usb2_led_state st)
234 struct technisat_usb2_state *state = d->priv;
235 u8 *led = state->buf;
238 led[0] = red ? SET_RED_LED_VENDOR_REQUEST : SET_GREEN_LED_VENDOR_REQUEST;
240 if (disable_led_control && st != TECH_LED_OFF)
267 if (mutex_lock_interruptible(&d->i2c_mutex) < 0)
270 ret = usb_control_msg(d->udev, usb_sndctrlpipe(d->udev, 0),
271 red ? SET_RED_LED_VENDOR_REQUEST : SET_GREEN_LED_VENDOR_REQUEST,
272 USB_TYPE_VENDOR | USB_DIR_OUT,
276 mutex_unlock(&d->i2c_mutex);
280 static int technisat_usb2_set_led_timer(struct dvb_usb_device *d, u8 red, u8 green)
282 struct technisat_usb2_state *state = d->priv;
288 if (mutex_lock_interruptible(&d->i2c_mutex) < 0)
291 ret = usb_control_msg(d->udev, usb_sndctrlpipe(d->udev, 0),
292 SET_LED_TIMER_DIVIDER_VENDOR_REQUEST,
293 USB_TYPE_VENDOR | USB_DIR_OUT,
294 (red << 8) | green, 0,
297 mutex_unlock(&d->i2c_mutex);
302 static void technisat_usb2_green_led_control(struct work_struct *work)
304 struct technisat_usb2_state *state =
305 container_of(work, struct technisat_usb2_state, green_led_work.work);
306 struct dvb_frontend *fe = state->dev->adapter[0].fe_adap[0].fe;
308 if (state->power_state == 0)
312 enum fe_status status;
314 if (fe->ops.read_status(fe, &status) != 0)
317 if (status & FE_HAS_LOCK) {
320 if (fe->ops.read_ber(fe, &ber) != 0)
324 technisat_usb2_set_led(state->dev, 0, TECH_LED_BLINK);
326 technisat_usb2_set_led(state->dev, 0, TECH_LED_ON);
328 technisat_usb2_set_led(state->dev, 0, TECH_LED_OFF);
332 schedule_delayed_work(&state->green_led_work,
333 msecs_to_jiffies(500));
336 /* method to find out whether the firmware has to be downloaded or not */
337 static int technisat_usb2_identify_state(struct usb_device *udev,
338 struct dvb_usb_device_properties *props,
339 struct dvb_usb_device_description **desc, int *cold)
344 version = kmalloc(3, GFP_KERNEL);
348 /* first select the interface */
349 if (usb_set_interface(udev, 0, 1) != 0)
350 err("could not set alternate setting to 0");
352 info("set alternate setting");
354 *cold = 0; /* by default do not download a firmware - just in case something is wrong */
356 ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
357 GET_VERSION_INFO_VENDOR_REQUEST,
358 USB_TYPE_VENDOR | USB_DIR_IN,
365 info("firmware version: %d.%d", version[1], version[2]);
375 static int technisat_usb2_power_ctrl(struct dvb_usb_device *d, int level)
377 struct technisat_usb2_state *state = d->priv;
379 state->power_state = level;
381 if (disable_led_control)
384 /* green led is turned off in any case - will be turned on when tuning */
385 technisat_usb2_set_led(d, 0, TECH_LED_OFF);
386 /* red led is turned on all the time */
387 technisat_usb2_set_led(d, 1, TECH_LED_ON);
391 /* mac address reading - from the eeprom */
393 static void technisat_usb2_eeprom_dump(struct dvb_usb_device *d)
399 /* full EEPROM dump */
400 for (j = 0; j < 256 * 4; j += 16) {
402 if (technisat_usb2_i2c_access(d->udev, 0x50 + j / 256, ®, 1, b, 16) != 0)
405 deb_eeprom("EEPROM: %01x%02x: ", j / 256, reg);
406 for (i = 0; i < 16; i++)
407 deb_eeprom("%02x ", b[i]);
413 static u8 technisat_usb2_calc_lrc(const u8 *b, u16 length)
421 static int technisat_usb2_eeprom_lrc_read(struct dvb_usb_device *d,
422 u16 offset, u8 *b, u16 length, u8 tries)
424 u8 bo = offset & 0xff;
425 struct i2c_msg msg[] = {
427 .addr = 0x50 | ((offset >> 8) & 0x3),
431 .addr = 0x50 | ((offset >> 8) & 0x3),
441 if (i2c_transfer(&d->i2c_adap, msg, 2) != 2)
445 technisat_usb2_calc_lrc(b, length - 1) == b[length - 1];
454 #define EEPROM_MAC_START 0x3f8
455 #define EEPROM_MAC_TOTAL 8
456 static int technisat_usb2_read_mac_address(struct dvb_usb_device *d,
459 u8 buf[EEPROM_MAC_TOTAL];
461 if (technisat_usb2_eeprom_lrc_read(d, EEPROM_MAC_START,
462 buf, EEPROM_MAC_TOTAL, 4) != 0)
469 static struct stv090x_config technisat_usb2_stv090x_config;
471 /* frontend attach */
472 static int technisat_usb2_set_voltage(struct dvb_frontend *fe,
473 enum fe_sec_voltage voltage)
476 u8 gpio[3] = { 0 }; /* 0 = 2, 1 = 3, 2 = 4 */
478 gpio[2] = 1; /* high - voltage ? */
489 case SEC_VOLTAGE_OFF:
493 for (i = 0; i < 3; i++)
494 if (technisat_usb2_stv090x_config.set_gpio(fe, i+2, 0,
500 static struct stv090x_config technisat_usb2_stv090x_config = {
502 .demod_mode = STV090x_SINGLE,
503 .clk_mode = STV090x_CLK_EXT,
508 .ts1_mode = STV090x_TSMODE_DVBCI,
512 .repeater_level = STV090x_RPTLEVEL_64,
517 static struct stv6110x_config technisat_usb2_stv6110x_config = {
523 static int technisat_usb2_frontend_attach(struct dvb_usb_adapter *a)
525 struct usb_device *udev = a->dev->udev;
528 a->fe_adap[0].fe = dvb_attach(stv090x_attach, &technisat_usb2_stv090x_config,
529 &a->dev->i2c_adap, STV090x_DEMODULATOR_0);
531 if (a->fe_adap[0].fe) {
532 const struct stv6110x_devctl *ctl;
534 ctl = dvb_attach(stv6110x_attach,
536 &technisat_usb2_stv6110x_config,
540 technisat_usb2_stv090x_config.tuner_init = ctl->tuner_init;
541 technisat_usb2_stv090x_config.tuner_sleep = ctl->tuner_sleep;
542 technisat_usb2_stv090x_config.tuner_set_mode = ctl->tuner_set_mode;
543 technisat_usb2_stv090x_config.tuner_set_frequency = ctl->tuner_set_frequency;
544 technisat_usb2_stv090x_config.tuner_get_frequency = ctl->tuner_get_frequency;
545 technisat_usb2_stv090x_config.tuner_set_bandwidth = ctl->tuner_set_bandwidth;
546 technisat_usb2_stv090x_config.tuner_get_bandwidth = ctl->tuner_get_bandwidth;
547 technisat_usb2_stv090x_config.tuner_set_bbgain = ctl->tuner_set_bbgain;
548 technisat_usb2_stv090x_config.tuner_get_bbgain = ctl->tuner_get_bbgain;
549 technisat_usb2_stv090x_config.tuner_set_refclk = ctl->tuner_set_refclk;
550 technisat_usb2_stv090x_config.tuner_get_status = ctl->tuner_get_status;
552 /* call the init function once to initialize
553 tuner's clock output divider and demod's
555 if (a->fe_adap[0].fe->ops.init)
556 a->fe_adap[0].fe->ops.init(a->fe_adap[0].fe);
558 if (mutex_lock_interruptible(&a->dev->i2c_mutex) < 0)
561 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
562 SET_IFCLK_TO_EXTERNAL_TSCLK_VENDOR_REQUEST,
563 USB_TYPE_VENDOR | USB_DIR_OUT,
566 mutex_unlock(&a->dev->i2c_mutex);
569 err("could not set IF_CLK to external");
571 a->fe_adap[0].fe->ops.set_voltage = technisat_usb2_set_voltage;
573 /* if everything was successful assign a nice name to the frontend */
574 strlcpy(a->fe_adap[0].fe->ops.info.name, a->dev->desc->name,
575 sizeof(a->fe_adap[0].fe->ops.info.name));
577 dvb_frontend_detach(a->fe_adap[0].fe);
578 a->fe_adap[0].fe = NULL;
582 technisat_usb2_set_led_timer(a->dev, 1, 1);
584 return a->fe_adap[0].fe == NULL ? -ENODEV : 0;
589 /* the device is giving providing raw IR-signals to the host mapping
590 * it only to one remote control is just the default implementation
592 #define NOMINAL_IR_BIT_TRANSITION_TIME_US 889
593 #define NOMINAL_IR_BIT_TIME_US (2 * NOMINAL_IR_BIT_TRANSITION_TIME_US)
595 #define FIRMWARE_CLOCK_TICK 83333
596 #define FIRMWARE_CLOCK_DIVISOR 256
598 #define IR_PERCENT_TOLERANCE 15
600 #define NOMINAL_IR_BIT_TRANSITION_TICKS ((NOMINAL_IR_BIT_TRANSITION_TIME_US * 1000 * 1000) / FIRMWARE_CLOCK_TICK)
601 #define NOMINAL_IR_BIT_TRANSITION_TICK_COUNT (NOMINAL_IR_BIT_TRANSITION_TICKS / FIRMWARE_CLOCK_DIVISOR)
603 #define NOMINAL_IR_BIT_TIME_TICKS ((NOMINAL_IR_BIT_TIME_US * 1000 * 1000) / FIRMWARE_CLOCK_TICK)
604 #define NOMINAL_IR_BIT_TIME_TICK_COUNT (NOMINAL_IR_BIT_TIME_TICKS / FIRMWARE_CLOCK_DIVISOR)
606 #define MINIMUM_IR_BIT_TRANSITION_TICK_COUNT (NOMINAL_IR_BIT_TRANSITION_TICK_COUNT - ((NOMINAL_IR_BIT_TRANSITION_TICK_COUNT * IR_PERCENT_TOLERANCE) / 100))
607 #define MAXIMUM_IR_BIT_TRANSITION_TICK_COUNT (NOMINAL_IR_BIT_TRANSITION_TICK_COUNT + ((NOMINAL_IR_BIT_TRANSITION_TICK_COUNT * IR_PERCENT_TOLERANCE) / 100))
609 #define MINIMUM_IR_BIT_TIME_TICK_COUNT (NOMINAL_IR_BIT_TIME_TICK_COUNT - ((NOMINAL_IR_BIT_TIME_TICK_COUNT * IR_PERCENT_TOLERANCE) / 100))
610 #define MAXIMUM_IR_BIT_TIME_TICK_COUNT (NOMINAL_IR_BIT_TIME_TICK_COUNT + ((NOMINAL_IR_BIT_TIME_TICK_COUNT * IR_PERCENT_TOLERANCE) / 100))
612 static int technisat_usb2_get_ir(struct dvb_usb_device *d)
614 struct technisat_usb2_state *state = d->priv;
615 struct ir_raw_event ev;
616 u8 *buf = state->buf;
619 buf[0] = GET_IR_DATA_VENDOR_REQUEST;
622 buf[3] = MINIMUM_IR_BIT_TRANSITION_TICK_COUNT;
623 buf[4] = MAXIMUM_IR_BIT_TIME_TICK_COUNT;
625 if (mutex_lock_interruptible(&d->i2c_mutex) < 0)
627 ret = usb_control_msg(d->udev, usb_sndctrlpipe(d->udev, 0),
628 GET_IR_DATA_VENDOR_REQUEST,
629 USB_TYPE_VENDOR | USB_DIR_OUT,
637 ret = usb_control_msg(d->udev, usb_rcvctrlpipe(d->udev, 0),
638 GET_IR_DATA_VENDOR_REQUEST,
639 USB_TYPE_VENDOR | USB_DIR_IN,
644 mutex_unlock(&d->i2c_mutex);
650 return 0; /* no key pressed */
655 deb_rc("RC: %d ", ret);
656 debug_dump(buf + 1, ret, deb_rc);
660 for (i = 1; i < ARRAY_SIZE(state->buf); i++) {
661 if (buf[i] == 0xff) {
663 ev.duration = 888888*2;
664 ir_raw_event_store(d->rc_dev, &ev);
668 ev.pulse = !ev.pulse;
669 ev.duration = (buf[i] * FIRMWARE_CLOCK_DIVISOR *
670 FIRMWARE_CLOCK_TICK) / 1000;
671 ir_raw_event_store(d->rc_dev, &ev);
674 ir_raw_event_handle(d->rc_dev);
679 static int technisat_usb2_rc_query(struct dvb_usb_device *d)
681 int ret = technisat_usb2_get_ir(d);
689 if (!disable_led_control)
690 technisat_usb2_set_led(d, 1, TECH_LED_BLINK);
695 /* DVB-USB and USB stuff follows */
696 static struct usb_device_id technisat_usb2_id_table[] = {
697 { USB_DEVICE(USB_VID_TECHNISAT, USB_PID_TECHNISAT_USB2_DVB_S2) },
698 { 0 } /* Terminating entry */
700 MODULE_DEVICE_TABLE(usb, technisat_usb2_id_table);
702 /* device description */
703 static struct dvb_usb_device_properties technisat_usb2_devices = {
704 .caps = DVB_USB_IS_AN_I2C_ADAPTER,
706 .usb_ctrl = CYPRESS_FX2,
708 .identify_state = technisat_usb2_identify_state,
709 .firmware = "/*(DEBLOBBED)*/",
711 .size_of_priv = sizeof(struct technisat_usb2_state),
713 .i2c_algo = &technisat_usb2_i2c_algo,
715 .power_ctrl = technisat_usb2_power_ctrl,
716 .read_mac_address = technisat_usb2_read_mac_address,
723 .frontend_attach = technisat_usb2_frontend_attach,
742 .num_device_descs = 1,
744 { "Technisat SkyStar USB HD (DVB-S/S2)",
745 { &technisat_usb2_id_table[0], NULL },
752 .rc_codes = RC_MAP_TECHNISAT_USB2,
753 .module_name = "technisat-usb2",
754 .rc_query = technisat_usb2_rc_query,
755 .allowed_protos = RC_BIT_ALL,
756 .driver_type = RC_DRIVER_IR_RAW,
760 static int technisat_usb2_probe(struct usb_interface *intf,
761 const struct usb_device_id *id)
763 struct dvb_usb_device *dev;
765 if (dvb_usb_device_init(intf, &technisat_usb2_devices, THIS_MODULE,
766 &dev, adapter_nr) != 0)
770 struct technisat_usb2_state *state = dev->priv;
773 if (!disable_led_control) {
774 INIT_DELAYED_WORK(&state->green_led_work,
775 technisat_usb2_green_led_control);
776 schedule_delayed_work(&state->green_led_work,
777 msecs_to_jiffies(500));
784 static void technisat_usb2_disconnect(struct usb_interface *intf)
786 struct dvb_usb_device *dev = usb_get_intfdata(intf);
788 /* work and stuff was only created when the device is is hot-state */
790 struct technisat_usb2_state *state = dev->priv;
792 cancel_delayed_work_sync(&state->green_led_work);
795 dvb_usb_device_exit(intf);
798 static struct usb_driver technisat_usb2_driver = {
799 .name = "dvb_usb_technisat_usb2",
800 .probe = technisat_usb2_probe,
801 .disconnect = technisat_usb2_disconnect,
802 .id_table = technisat_usb2_id_table,
805 module_usb_driver(technisat_usb2_driver);
807 MODULE_AUTHOR("Patrick Boettcher <pboettcher@kernellabs.com>");
808 MODULE_DESCRIPTION("Driver for Technisat DVB-S/S2 USB 2.0 device");
809 MODULE_VERSION("1.0");
810 MODULE_LICENSE("GPL");