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 (default: 0 - LED control is active).");
55 /* device private data */
56 struct technisat_usb2_state
{
57 struct dvb_usb_device
*dev
;
58 struct delayed_work green_led_work
;
66 /* debug print helpers */
67 #define deb_info(args...) dprintk(debug, 0x01, args)
68 #define deb_eeprom(args...) dprintk(debug, 0x02, args)
69 #define deb_i2c(args...) dprintk(debug, 0x04, args)
70 #define deb_rc(args...) dprintk(debug, 0x08, args)
73 #define SET_IFCLK_TO_EXTERNAL_TSCLK_VENDOR_REQUEST 0xB3
74 #define SET_FRONT_END_RESET_VENDOR_REQUEST 0xB4
75 #define GET_VERSION_INFO_VENDOR_REQUEST 0xB5
76 #define SET_GREEN_LED_VENDOR_REQUEST 0xB6
77 #define SET_RED_LED_VENDOR_REQUEST 0xB7
78 #define GET_IR_DATA_VENDOR_REQUEST 0xB8
79 #define SET_LED_TIMER_DIVIDER_VENDOR_REQUEST 0xB9
80 #define SET_USB_REENUMERATION 0xBA
82 /* i2c-access methods */
83 #define I2C_SPEED_100KHZ_BIT 0x40
85 #define I2C_STATUS_NAK 7
86 #define I2C_STATUS_OK 8
88 static int technisat_usb2_i2c_access(struct usb_device
*udev
,
89 u8 device_addr
, u8
*tx
, u8 txlen
, u8
*rx
, u8 rxlen
)
92 int ret
, actual_length
;
94 b
= kmalloc(64, GFP_KERNEL
);
98 deb_i2c("i2c-access: %02x, tx: ", device_addr
);
99 debug_dump(tx
, txlen
, deb_i2c
);
103 err("i2c TX buffer can't exceed 62 bytes (dev 0x%02x)",
108 err("i2c RX buffer can't exceed 62 bytes (dev 0x%02x)",
113 b
[0] = I2C_SPEED_100KHZ_BIT
;
114 b
[1] = device_addr
<< 1;
121 memcpy(&b
[2], tx
, txlen
);
122 ret
= usb_bulk_msg(udev
,
123 usb_sndbulkpipe(udev
, 0x01),
128 err("i2c-error: out failed %02x = %d", device_addr
, ret
);
132 ret
= usb_bulk_msg(udev
,
133 usb_rcvbulkpipe(udev
, 0x01),
134 b
, 64, &actual_length
, 1000);
136 err("i2c-error: in failed %02x = %d", device_addr
, ret
);
140 if (b
[0] != I2C_STATUS_OK
) {
141 err("i2c-error: %02x = %d", device_addr
, b
[0]);
142 /* handle tuner-i2c-nak */
143 if (!(b
[0] == I2C_STATUS_NAK
&&
145 /* && device_is_technisat_usb2 */))
149 deb_i2c("status: %d, ", b
[0]);
152 memcpy(rx
, &b
[2], rxlen
);
154 deb_i2c("rx (%d): ", rxlen
);
155 debug_dump(rx
, rxlen
, deb_i2c
);
165 static int technisat_usb2_i2c_xfer(struct i2c_adapter
*adap
, struct i2c_msg
*msg
,
169 struct dvb_usb_device
*d
= i2c_get_adapdata(adap
);
171 /* Ensure nobody else hits the i2c bus while we're sending our
172 sequence of messages, (such as the remote control thread) */
173 if (mutex_lock_interruptible(&d
->i2c_mutex
) < 0)
176 for (i
= 0; i
< num
; i
++) {
177 if (i
+1 < num
&& msg
[i
+1].flags
& I2C_M_RD
) {
178 ret
= technisat_usb2_i2c_access(d
->udev
, msg
[i
+1].addr
,
179 msg
[i
].buf
, msg
[i
].len
,
180 msg
[i
+1].buf
, msg
[i
+1].len
);
185 ret
= technisat_usb2_i2c_access(d
->udev
, msg
[i
].addr
,
186 msg
[i
].buf
, msg
[i
].len
,
196 mutex_unlock(&d
->i2c_mutex
);
201 static u32
technisat_usb2_i2c_func(struct i2c_adapter
*adapter
)
206 static struct i2c_algorithm technisat_usb2_i2c_algo
= {
207 .master_xfer
= technisat_usb2_i2c_xfer
,
208 .functionality
= technisat_usb2_i2c_func
,
212 static void technisat_usb2_frontend_reset(struct usb_device
*udev
)
214 usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
215 SET_FRONT_END_RESET_VENDOR_REQUEST
,
216 USB_TYPE_VENDOR
| USB_DIR_OUT
,
223 enum technisat_usb2_led_state
{
230 static int technisat_usb2_set_led(struct dvb_usb_device
*d
, int red
,
231 enum technisat_usb2_led_state st
)
233 struct technisat_usb2_state
*state
= d
->priv
;
234 u8
*led
= state
->buf
;
237 led
[0] = red
? SET_RED_LED_VENDOR_REQUEST
: SET_GREEN_LED_VENDOR_REQUEST
;
239 if (disable_led_control
&& st
!= TECH_LED_OFF
)
266 if (mutex_lock_interruptible(&d
->i2c_mutex
) < 0)
269 ret
= usb_control_msg(d
->udev
, usb_sndctrlpipe(d
->udev
, 0),
270 red
? SET_RED_LED_VENDOR_REQUEST
: SET_GREEN_LED_VENDOR_REQUEST
,
271 USB_TYPE_VENDOR
| USB_DIR_OUT
,
275 mutex_unlock(&d
->i2c_mutex
);
279 static int technisat_usb2_set_led_timer(struct dvb_usb_device
*d
, u8 red
, u8 green
)
281 struct technisat_usb2_state
*state
= d
->priv
;
287 if (mutex_lock_interruptible(&d
->i2c_mutex
) < 0)
290 ret
= usb_control_msg(d
->udev
, usb_sndctrlpipe(d
->udev
, 0),
291 SET_LED_TIMER_DIVIDER_VENDOR_REQUEST
,
292 USB_TYPE_VENDOR
| USB_DIR_OUT
,
293 (red
<< 8) | green
, 0,
296 mutex_unlock(&d
->i2c_mutex
);
301 static void technisat_usb2_green_led_control(struct work_struct
*work
)
303 struct technisat_usb2_state
*state
=
304 container_of(work
, struct technisat_usb2_state
, green_led_work
.work
);
305 struct dvb_frontend
*fe
= state
->dev
->adapter
[0].fe_adap
[0].fe
;
307 if (state
->power_state
== 0)
311 enum fe_status status
;
313 if (fe
->ops
.read_status(fe
, &status
) != 0)
316 if (status
& FE_HAS_LOCK
) {
319 if (fe
->ops
.read_ber(fe
, &ber
) != 0)
323 technisat_usb2_set_led(state
->dev
, 0, TECH_LED_BLINK
);
325 technisat_usb2_set_led(state
->dev
, 0, TECH_LED_ON
);
327 technisat_usb2_set_led(state
->dev
, 0, TECH_LED_OFF
);
331 schedule_delayed_work(&state
->green_led_work
,
332 msecs_to_jiffies(500));
335 /* method to find out whether the firmware has to be downloaded or not */
336 static int technisat_usb2_identify_state(struct usb_device
*udev
,
337 struct dvb_usb_device_properties
*props
,
338 struct dvb_usb_device_description
**desc
, int *cold
)
343 version
= kmalloc(3, GFP_KERNEL
);
347 /* first select the interface */
348 if (usb_set_interface(udev
, 0, 1) != 0)
349 err("could not set alternate setting to 0");
351 info("set alternate setting");
353 *cold
= 0; /* by default do not download a firmware - just in case something is wrong */
355 ret
= usb_control_msg(udev
, usb_rcvctrlpipe(udev
, 0),
356 GET_VERSION_INFO_VENDOR_REQUEST
,
357 USB_TYPE_VENDOR
| USB_DIR_IN
,
364 info("firmware version: %d.%d", version
[1], version
[2]);
374 static int technisat_usb2_power_ctrl(struct dvb_usb_device
*d
, int level
)
376 struct technisat_usb2_state
*state
= d
->priv
;
378 state
->power_state
= level
;
380 if (disable_led_control
)
383 /* green led is turned off in any case - will be turned on when tuning */
384 technisat_usb2_set_led(d
, 0, TECH_LED_OFF
);
385 /* red led is turned on all the time */
386 technisat_usb2_set_led(d
, 1, TECH_LED_ON
);
390 /* mac address reading - from the eeprom */
392 static void technisat_usb2_eeprom_dump(struct dvb_usb_device
*d
)
398 /* full EEPROM dump */
399 for (j
= 0; j
< 256 * 4; j
+= 16) {
401 if (technisat_usb2_i2c_access(d
->udev
, 0x50 + j
/ 256, ®
, 1, b
, 16) != 0)
404 deb_eeprom("EEPROM: %01x%02x: ", j
/ 256, reg
);
405 for (i
= 0; i
< 16; i
++)
406 deb_eeprom("%02x ", b
[i
]);
412 static u8
technisat_usb2_calc_lrc(const u8
*b
, u16 length
)
420 static int technisat_usb2_eeprom_lrc_read(struct dvb_usb_device
*d
,
421 u16 offset
, u8
*b
, u16 length
, u8 tries
)
423 u8 bo
= offset
& 0xff;
424 struct i2c_msg msg
[] = {
426 .addr
= 0x50 | ((offset
>> 8) & 0x3),
430 .addr
= 0x50 | ((offset
>> 8) & 0x3),
440 if (i2c_transfer(&d
->i2c_adap
, msg
, 2) != 2)
444 technisat_usb2_calc_lrc(b
, length
- 1) == b
[length
- 1];
453 #define EEPROM_MAC_START 0x3f8
454 #define EEPROM_MAC_TOTAL 8
455 static int technisat_usb2_read_mac_address(struct dvb_usb_device
*d
,
458 u8 buf
[EEPROM_MAC_TOTAL
];
460 if (technisat_usb2_eeprom_lrc_read(d
, EEPROM_MAC_START
,
461 buf
, EEPROM_MAC_TOTAL
, 4) != 0)
468 static struct stv090x_config technisat_usb2_stv090x_config
;
470 /* frontend attach */
471 static int technisat_usb2_set_voltage(struct dvb_frontend
*fe
,
472 enum fe_sec_voltage voltage
)
475 u8 gpio
[3] = { 0 }; /* 0 = 2, 1 = 3, 2 = 4 */
477 gpio
[2] = 1; /* high - voltage ? */
488 case SEC_VOLTAGE_OFF
:
492 for (i
= 0; i
< 3; i
++)
493 if (technisat_usb2_stv090x_config
.set_gpio(fe
, i
+2, 0,
499 static struct stv090x_config technisat_usb2_stv090x_config
= {
501 .demod_mode
= STV090x_SINGLE
,
502 .clk_mode
= STV090x_CLK_EXT
,
507 .ts1_mode
= STV090x_TSMODE_DVBCI
,
511 .repeater_level
= STV090x_RPTLEVEL_64
,
516 static struct stv6110x_config technisat_usb2_stv6110x_config
= {
522 static int technisat_usb2_frontend_attach(struct dvb_usb_adapter
*a
)
524 struct usb_device
*udev
= a
->dev
->udev
;
527 a
->fe_adap
[0].fe
= dvb_attach(stv090x_attach
, &technisat_usb2_stv090x_config
,
528 &a
->dev
->i2c_adap
, STV090x_DEMODULATOR_0
);
530 if (a
->fe_adap
[0].fe
) {
531 const struct stv6110x_devctl
*ctl
;
533 ctl
= dvb_attach(stv6110x_attach
,
535 &technisat_usb2_stv6110x_config
,
539 technisat_usb2_stv090x_config
.tuner_init
= ctl
->tuner_init
;
540 technisat_usb2_stv090x_config
.tuner_sleep
= ctl
->tuner_sleep
;
541 technisat_usb2_stv090x_config
.tuner_set_mode
= ctl
->tuner_set_mode
;
542 technisat_usb2_stv090x_config
.tuner_set_frequency
= ctl
->tuner_set_frequency
;
543 technisat_usb2_stv090x_config
.tuner_get_frequency
= ctl
->tuner_get_frequency
;
544 technisat_usb2_stv090x_config
.tuner_set_bandwidth
= ctl
->tuner_set_bandwidth
;
545 technisat_usb2_stv090x_config
.tuner_get_bandwidth
= ctl
->tuner_get_bandwidth
;
546 technisat_usb2_stv090x_config
.tuner_set_bbgain
= ctl
->tuner_set_bbgain
;
547 technisat_usb2_stv090x_config
.tuner_get_bbgain
= ctl
->tuner_get_bbgain
;
548 technisat_usb2_stv090x_config
.tuner_set_refclk
= ctl
->tuner_set_refclk
;
549 technisat_usb2_stv090x_config
.tuner_get_status
= ctl
->tuner_get_status
;
551 /* call the init function once to initialize
552 tuner's clock output divider and demod's
554 if (a
->fe_adap
[0].fe
->ops
.init
)
555 a
->fe_adap
[0].fe
->ops
.init(a
->fe_adap
[0].fe
);
557 if (mutex_lock_interruptible(&a
->dev
->i2c_mutex
) < 0)
560 ret
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
561 SET_IFCLK_TO_EXTERNAL_TSCLK_VENDOR_REQUEST
,
562 USB_TYPE_VENDOR
| USB_DIR_OUT
,
565 mutex_unlock(&a
->dev
->i2c_mutex
);
568 err("could not set IF_CLK to external");
570 a
->fe_adap
[0].fe
->ops
.set_voltage
= technisat_usb2_set_voltage
;
572 /* if everything was successful assign a nice name to the frontend */
573 strlcpy(a
->fe_adap
[0].fe
->ops
.info
.name
, a
->dev
->desc
->name
,
574 sizeof(a
->fe_adap
[0].fe
->ops
.info
.name
));
576 dvb_frontend_detach(a
->fe_adap
[0].fe
);
577 a
->fe_adap
[0].fe
= NULL
;
581 technisat_usb2_set_led_timer(a
->dev
, 1, 1);
583 return a
->fe_adap
[0].fe
== NULL
? -ENODEV
: 0;
588 /* the device is giving providing raw IR-signals to the host mapping
589 * it only to one remote control is just the default implementation
591 #define NOMINAL_IR_BIT_TRANSITION_TIME_US 889
592 #define NOMINAL_IR_BIT_TIME_US (2 * NOMINAL_IR_BIT_TRANSITION_TIME_US)
594 #define FIRMWARE_CLOCK_TICK 83333
595 #define FIRMWARE_CLOCK_DIVISOR 256
597 #define IR_PERCENT_TOLERANCE 15
599 #define NOMINAL_IR_BIT_TRANSITION_TICKS ((NOMINAL_IR_BIT_TRANSITION_TIME_US * 1000 * 1000) / FIRMWARE_CLOCK_TICK)
600 #define NOMINAL_IR_BIT_TRANSITION_TICK_COUNT (NOMINAL_IR_BIT_TRANSITION_TICKS / FIRMWARE_CLOCK_DIVISOR)
602 #define NOMINAL_IR_BIT_TIME_TICKS ((NOMINAL_IR_BIT_TIME_US * 1000 * 1000) / FIRMWARE_CLOCK_TICK)
603 #define NOMINAL_IR_BIT_TIME_TICK_COUNT (NOMINAL_IR_BIT_TIME_TICKS / FIRMWARE_CLOCK_DIVISOR)
605 #define MINIMUM_IR_BIT_TRANSITION_TICK_COUNT (NOMINAL_IR_BIT_TRANSITION_TICK_COUNT - ((NOMINAL_IR_BIT_TRANSITION_TICK_COUNT * IR_PERCENT_TOLERANCE) / 100))
606 #define MAXIMUM_IR_BIT_TRANSITION_TICK_COUNT (NOMINAL_IR_BIT_TRANSITION_TICK_COUNT + ((NOMINAL_IR_BIT_TRANSITION_TICK_COUNT * IR_PERCENT_TOLERANCE) / 100))
608 #define MINIMUM_IR_BIT_TIME_TICK_COUNT (NOMINAL_IR_BIT_TIME_TICK_COUNT - ((NOMINAL_IR_BIT_TIME_TICK_COUNT * IR_PERCENT_TOLERANCE) / 100))
609 #define MAXIMUM_IR_BIT_TIME_TICK_COUNT (NOMINAL_IR_BIT_TIME_TICK_COUNT + ((NOMINAL_IR_BIT_TIME_TICK_COUNT * IR_PERCENT_TOLERANCE) / 100))
611 static int technisat_usb2_get_ir(struct dvb_usb_device
*d
)
613 struct technisat_usb2_state
*state
= d
->priv
;
614 u8
*buf
= state
->buf
;
617 struct ir_raw_event ev
;
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 */
656 deb_rc("RC: %d ", ret
);
657 debug_dump(b
, ret
, deb_rc
);
662 ev
.pulse
= !ev
.pulse
;
663 ev
.duration
= (*b
* FIRMWARE_CLOCK_DIVISOR
* FIRMWARE_CLOCK_TICK
) / 1000;
664 ir_raw_event_store(d
->rc_dev
, &ev
);
669 ev
.duration
= 888888*2;
670 ir_raw_event_store(d
->rc_dev
, &ev
);
675 ir_raw_event_handle(d
->rc_dev
);
680 static int technisat_usb2_rc_query(struct dvb_usb_device
*d
)
682 int ret
= technisat_usb2_get_ir(d
);
690 if (!disable_led_control
)
691 technisat_usb2_set_led(d
, 1, TECH_LED_BLINK
);
696 /* DVB-USB and USB stuff follows */
697 static struct usb_device_id technisat_usb2_id_table
[] = {
698 { USB_DEVICE(USB_VID_TECHNISAT
, USB_PID_TECHNISAT_USB2_DVB_S2
) },
699 { 0 } /* Terminating entry */
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
[0], NULL
},
753 .rc_codes
= RC_MAP_TECHNISAT_USB2
,
754 .module_name
= "technisat-usb2",
755 .rc_query
= technisat_usb2_rc_query
,
756 .allowed_protos
= RC_BIT_ALL
,
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 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
);
808 MODULE_AUTHOR("Patrick Boettcher <pboettcher@kernellabs.com>");
809 MODULE_DESCRIPTION("Driver for Technisat DVB-S/S2 USB 2.0 device");
810 MODULE_VERSION("1.0");
811 MODULE_LICENSE("GPL");