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;
65
/* debug print helpers */
66
#define deb_info(args...) dprintk(debug, 0x01, args)
67
#define deb_eeprom(args...) dprintk(debug, 0x02, args)
68
#define deb_i2c(args...) dprintk(debug, 0x04, args)
69
#define deb_rc(args...) dprintk(debug, 0x08, args)
72
#define SET_IFCLK_TO_EXTERNAL_TSCLK_VENDOR_REQUEST 0xB3
73
#define SET_FRONT_END_RESET_VENDOR_REQUEST 0xB4
74
#define GET_VERSION_INFO_VENDOR_REQUEST 0xB5
75
#define SET_GREEN_LED_VENDOR_REQUEST 0xB6
76
#define SET_RED_LED_VENDOR_REQUEST 0xB7
77
#define GET_IR_DATA_VENDOR_REQUEST 0xB8
78
#define SET_LED_TIMER_DIVIDER_VENDOR_REQUEST 0xB9
79
#define SET_USB_REENUMERATION 0xBA
81
/* i2c-access methods */
82
#define I2C_SPEED_100KHZ_BIT 0x40
84
#define I2C_STATUS_NAK 7
85
#define I2C_STATUS_OK 8
87
static int technisat_usb2_i2c_access(struct usb_device *udev,
88
u8 device_addr, u8 *tx, u8 txlen, u8 *rx, u8 rxlen)
91
int ret, actual_length;
93
deb_i2c("i2c-access: %02x, tx: ", device_addr);
94
debug_dump(tx, txlen, deb_i2c);
98
err("i2c TX buffer can't exceed 62 bytes (dev 0x%02x)",
103
err("i2c RX buffer can't exceed 62 bytes (dev 0x%02x)",
108
b[0] = I2C_SPEED_100KHZ_BIT;
109
b[1] = device_addr << 1;
116
memcpy(&b[2], tx, txlen);
117
ret = usb_bulk_msg(udev,
118
usb_sndbulkpipe(udev, 0x01),
123
err("i2c-error: out failed %02x = %d", device_addr, ret);
127
ret = usb_bulk_msg(udev,
128
usb_rcvbulkpipe(udev, 0x01),
129
b, 64, &actual_length, 1000);
131
err("i2c-error: in failed %02x = %d", device_addr, ret);
135
if (b[0] != I2C_STATUS_OK) {
136
err("i2c-error: %02x = %d", device_addr, b[0]);
137
/* handle tuner-i2c-nak */
138
if (!(b[0] == I2C_STATUS_NAK &&
140
/* && device_is_technisat_usb2 */))
144
deb_i2c("status: %d, ", b[0]);
147
memcpy(rx, &b[2], rxlen);
149
deb_i2c("rx (%d): ", rxlen);
150
debug_dump(rx, rxlen, deb_i2c);
158
static int technisat_usb2_i2c_xfer(struct i2c_adapter *adap, struct i2c_msg *msg,
162
struct dvb_usb_device *d = i2c_get_adapdata(adap);
164
/* Ensure nobody else hits the i2c bus while we're sending our
165
sequence of messages, (such as the remote control thread) */
166
if (mutex_lock_interruptible(&d->i2c_mutex) < 0)
169
for (i = 0; i < num; i++) {
170
if (i+1 < num && msg[i+1].flags & I2C_M_RD) {
171
ret = technisat_usb2_i2c_access(d->udev, msg[i+1].addr,
172
msg[i].buf, msg[i].len,
173
msg[i+1].buf, msg[i+1].len);
178
ret = technisat_usb2_i2c_access(d->udev, msg[i].addr,
179
msg[i].buf, msg[i].len,
189
mutex_unlock(&d->i2c_mutex);
194
static u32 technisat_usb2_i2c_func(struct i2c_adapter *adapter)
199
static struct i2c_algorithm technisat_usb2_i2c_algo = {
200
.master_xfer = technisat_usb2_i2c_xfer,
201
.functionality = technisat_usb2_i2c_func,
205
static void technisat_usb2_frontend_reset(struct usb_device *udev)
207
usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
208
SET_FRONT_END_RESET_VENDOR_REQUEST,
209
USB_TYPE_VENDOR | USB_DIR_OUT,
216
enum technisat_usb2_led_state {
223
static int technisat_usb2_set_led(struct dvb_usb_device *d, int red, enum technisat_usb2_led_state state)
228
red ? SET_RED_LED_VENDOR_REQUEST : SET_GREEN_LED_VENDOR_REQUEST,
232
if (disable_led_control && state != LED_OFF)
259
if (mutex_lock_interruptible(&d->i2c_mutex) < 0)
262
ret = usb_control_msg(d->udev, usb_sndctrlpipe(d->udev, 0),
263
red ? SET_RED_LED_VENDOR_REQUEST : SET_GREEN_LED_VENDOR_REQUEST,
264
USB_TYPE_VENDOR | USB_DIR_OUT,
266
led, sizeof(led), 500);
268
mutex_unlock(&d->i2c_mutex);
272
static int technisat_usb2_set_led_timer(struct dvb_usb_device *d, u8 red, u8 green)
277
if (mutex_lock_interruptible(&d->i2c_mutex) < 0)
280
ret = usb_control_msg(d->udev, usb_sndctrlpipe(d->udev, 0),
281
SET_LED_TIMER_DIVIDER_VENDOR_REQUEST,
282
USB_TYPE_VENDOR | USB_DIR_OUT,
283
(red << 8) | green, 0,
286
mutex_unlock(&d->i2c_mutex);
291
static void technisat_usb2_green_led_control(struct work_struct *work)
293
struct technisat_usb2_state *state =
294
container_of(work, struct technisat_usb2_state, green_led_work.work);
295
struct dvb_frontend *fe = state->dev->adapter[0].fe;
297
if (state->power_state == 0)
301
enum fe_status status;
303
if (fe->ops.read_status(fe, &status) != 0)
306
if (status & FE_HAS_LOCK) {
309
if (fe->ops.read_ber(fe, &ber) != 0)
313
technisat_usb2_set_led(state->dev, 0, LED_BLINK);
315
technisat_usb2_set_led(state->dev, 0, LED_ON);
317
technisat_usb2_set_led(state->dev, 0, LED_OFF);
321
schedule_delayed_work(&state->green_led_work,
322
msecs_to_jiffies(500));
325
/* method to find out whether the firmware has to be downloaded or not */
326
static int technisat_usb2_identify_state(struct usb_device *udev,
327
struct dvb_usb_device_properties *props,
328
struct dvb_usb_device_description **desc, int *cold)
333
/* first select the interface */
334
if (usb_set_interface(udev, 0, 1) != 0)
335
err("could not set alternate setting to 0");
337
info("set alternate setting");
339
*cold = 0; /* by default do not download a firmware - just in case something is wrong */
341
ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
342
GET_VERSION_INFO_VENDOR_REQUEST,
343
USB_TYPE_VENDOR | USB_DIR_IN,
345
version, sizeof(version), 500);
350
info("firmware version: %d.%d", version[1], version[2]);
358
static int technisat_usb2_power_ctrl(struct dvb_usb_device *d, int level)
360
struct technisat_usb2_state *state = d->priv;
362
state->power_state = level;
364
if (disable_led_control)
367
/* green led is turned off in any case - will be turned on when tuning */
368
technisat_usb2_set_led(d, 0, LED_OFF);
369
/* red led is turned on all the time */
370
technisat_usb2_set_led(d, 1, LED_ON);
374
/* mac address reading - from the eeprom */
376
static void technisat_usb2_eeprom_dump(struct dvb_usb_device *d)
382
/* full EEPROM dump */
383
for (j = 0; j < 256 * 4; j += 16) {
385
if (technisat_usb2_i2c_access(d->udev, 0x50 + j / 256, ®, 1, b, 16) != 0)
388
deb_eeprom("EEPROM: %01x%02x: ", j / 256, reg);
389
for (i = 0; i < 16; i++)
390
deb_eeprom("%02x ", b[i]);
396
static u8 technisat_usb2_calc_lrc(const u8 *b, u16 length)
404
static int technisat_usb2_eeprom_lrc_read(struct dvb_usb_device *d,
405
u16 offset, u8 *b, u16 length, u8 tries)
407
u8 bo = offset & 0xff;
408
struct i2c_msg msg[] = {
410
.addr = 0x50 | ((offset >> 8) & 0x3),
414
.addr = 0x50 | ((offset >> 8) & 0x3),
424
if (i2c_transfer(&d->i2c_adap, msg, 2) != 2)
428
technisat_usb2_calc_lrc(b, length - 1) == b[length - 1];
437
#define EEPROM_MAC_START 0x3f8
438
#define EEPROM_MAC_TOTAL 8
439
static int technisat_usb2_read_mac_address(struct dvb_usb_device *d,
442
u8 buf[EEPROM_MAC_TOTAL];
444
if (technisat_usb2_eeprom_lrc_read(d, EEPROM_MAC_START,
445
buf, EEPROM_MAC_TOTAL, 4) != 0)
452
/* frontend attach */
453
static int technisat_usb2_set_voltage(struct dvb_frontend *fe,
454
fe_sec_voltage_t voltage)
457
u8 gpio[3] = { 0 }; /* 0 = 2, 1 = 3, 2 = 4 */
459
gpio[2] = 1; /* high - voltage ? */
470
case SEC_VOLTAGE_OFF:
474
for (i = 0; i < 3; i++)
475
if (stv090x_set_gpio(fe, i+2, 0, gpio[i], 0) != 0)
480
static struct stv090x_config technisat_usb2_stv090x_config = {
482
.demod_mode = STV090x_SINGLE,
483
.clk_mode = STV090x_CLK_EXT,
488
.ts1_mode = STV090x_TSMODE_DVBCI,
492
.repeater_level = STV090x_RPTLEVEL_64,
497
static struct stv6110x_config technisat_usb2_stv6110x_config = {
503
static int technisat_usb2_frontend_attach(struct dvb_usb_adapter *a)
505
struct usb_device *udev = a->dev->udev;
508
a->fe = dvb_attach(stv090x_attach, &technisat_usb2_stv090x_config,
509
&a->dev->i2c_adap, STV090x_DEMODULATOR_0);
512
struct stv6110x_devctl *ctl;
514
ctl = dvb_attach(stv6110x_attach,
516
&technisat_usb2_stv6110x_config,
520
technisat_usb2_stv090x_config.tuner_init = ctl->tuner_init;
521
technisat_usb2_stv090x_config.tuner_sleep = ctl->tuner_sleep;
522
technisat_usb2_stv090x_config.tuner_set_mode = ctl->tuner_set_mode;
523
technisat_usb2_stv090x_config.tuner_set_frequency = ctl->tuner_set_frequency;
524
technisat_usb2_stv090x_config.tuner_get_frequency = ctl->tuner_get_frequency;
525
technisat_usb2_stv090x_config.tuner_set_bandwidth = ctl->tuner_set_bandwidth;
526
technisat_usb2_stv090x_config.tuner_get_bandwidth = ctl->tuner_get_bandwidth;
527
technisat_usb2_stv090x_config.tuner_set_bbgain = ctl->tuner_set_bbgain;
528
technisat_usb2_stv090x_config.tuner_get_bbgain = ctl->tuner_get_bbgain;
529
technisat_usb2_stv090x_config.tuner_set_refclk = ctl->tuner_set_refclk;
530
technisat_usb2_stv090x_config.tuner_get_status = ctl->tuner_get_status;
532
/* call the init function once to initialize
533
tuner's clock output divider and demod's
536
a->fe->ops.init(a->fe);
538
if (mutex_lock_interruptible(&a->dev->i2c_mutex) < 0)
541
ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
542
SET_IFCLK_TO_EXTERNAL_TSCLK_VENDOR_REQUEST,
543
USB_TYPE_VENDOR | USB_DIR_OUT,
546
mutex_unlock(&a->dev->i2c_mutex);
549
err("could not set IF_CLK to external");
551
a->fe->ops.set_voltage = technisat_usb2_set_voltage;
553
/* if everything was successful assign a nice name to the frontend */
554
strlcpy(a->fe->ops.info.name, a->dev->desc->name,
555
sizeof(a->fe->ops.info.name));
557
dvb_frontend_detach(a->fe);
562
technisat_usb2_set_led_timer(a->dev, 1, 1);
564
return a->fe == NULL ? -ENODEV : 0;
569
/* the device is giving providing raw IR-signals to the host mapping
570
* it only to one remote control is just the default implementation
572
#define NOMINAL_IR_BIT_TRANSITION_TIME_US 889
573
#define NOMINAL_IR_BIT_TIME_US (2 * NOMINAL_IR_BIT_TRANSITION_TIME_US)
575
#define FIRMWARE_CLOCK_TICK 83333
576
#define FIRMWARE_CLOCK_DIVISOR 256
578
#define IR_PERCENT_TOLERANCE 15
580
#define NOMINAL_IR_BIT_TRANSITION_TICKS ((NOMINAL_IR_BIT_TRANSITION_TIME_US * 1000 * 1000) / FIRMWARE_CLOCK_TICK)
581
#define NOMINAL_IR_BIT_TRANSITION_TICK_COUNT (NOMINAL_IR_BIT_TRANSITION_TICKS / FIRMWARE_CLOCK_DIVISOR)
583
#define NOMINAL_IR_BIT_TIME_TICKS ((NOMINAL_IR_BIT_TIME_US * 1000 * 1000) / FIRMWARE_CLOCK_TICK)
584
#define NOMINAL_IR_BIT_TIME_TICK_COUNT (NOMINAL_IR_BIT_TIME_TICKS / FIRMWARE_CLOCK_DIVISOR)
586
#define MINIMUM_IR_BIT_TRANSITION_TICK_COUNT (NOMINAL_IR_BIT_TRANSITION_TICK_COUNT - ((NOMINAL_IR_BIT_TRANSITION_TICK_COUNT * IR_PERCENT_TOLERANCE) / 100))
587
#define MAXIMUM_IR_BIT_TRANSITION_TICK_COUNT (NOMINAL_IR_BIT_TRANSITION_TICK_COUNT + ((NOMINAL_IR_BIT_TRANSITION_TICK_COUNT * IR_PERCENT_TOLERANCE) / 100))
589
#define MINIMUM_IR_BIT_TIME_TICK_COUNT (NOMINAL_IR_BIT_TIME_TICK_COUNT - ((NOMINAL_IR_BIT_TIME_TICK_COUNT * IR_PERCENT_TOLERANCE) / 100))
590
#define MAXIMUM_IR_BIT_TIME_TICK_COUNT (NOMINAL_IR_BIT_TIME_TICK_COUNT + ((NOMINAL_IR_BIT_TIME_TICK_COUNT * IR_PERCENT_TOLERANCE) / 100))
592
static int technisat_usb2_get_ir(struct dvb_usb_device *d)
596
struct ir_raw_event ev;
598
buf[0] = GET_IR_DATA_VENDOR_REQUEST;
601
buf[3] = MINIMUM_IR_BIT_TRANSITION_TICK_COUNT;
602
buf[4] = MAXIMUM_IR_BIT_TIME_TICK_COUNT;
604
if (mutex_lock_interruptible(&d->i2c_mutex) < 0)
606
ret = usb_control_msg(d->udev, usb_sndctrlpipe(d->udev, 0),
607
GET_IR_DATA_VENDOR_REQUEST,
608
USB_TYPE_VENDOR | USB_DIR_OUT,
616
ret = usb_control_msg(d->udev, usb_rcvctrlpipe(d->udev, 0),
617
GET_IR_DATA_VENDOR_REQUEST,
618
USB_TYPE_VENDOR | USB_DIR_IN,
620
buf, sizeof(buf), 500);
623
mutex_unlock(&d->i2c_mutex);
629
return 0; /* no key pressed */
635
deb_rc("RC: %d ", ret);
636
debug_dump(b, ret, deb_rc);
641
ev.pulse = !ev.pulse;
642
ev.duration = (*b * FIRMWARE_CLOCK_DIVISOR * FIRMWARE_CLOCK_TICK) / 1000;
643
ir_raw_event_store(d->rc_dev, &ev);
648
ev.duration = 888888*2;
649
ir_raw_event_store(d->rc_dev, &ev);
654
ir_raw_event_handle(d->rc_dev);
659
static int technisat_usb2_rc_query(struct dvb_usb_device *d)
661
int ret = technisat_usb2_get_ir(d);
669
if (!disable_led_control)
670
technisat_usb2_set_led(d, 1, LED_BLINK);
675
/* DVB-USB and USB stuff follows */
676
static struct usb_device_id technisat_usb2_id_table[] = {
677
{ USB_DEVICE(USB_VID_TECHNISAT, USB_PID_TECHNISAT_USB2_DVB_S2) },
678
{ 0 } /* Terminating entry */
681
/* device description */
682
static struct dvb_usb_device_properties technisat_usb2_devices = {
683
.caps = DVB_USB_IS_AN_I2C_ADAPTER,
685
.usb_ctrl = CYPRESS_FX2,
687
.identify_state = technisat_usb2_identify_state,
688
.firmware = "dvb-usb-SkyStar_USB_HD_FW_v17_63.HEX.fw",
690
.size_of_priv = sizeof(struct technisat_usb2_state),
692
.i2c_algo = &technisat_usb2_i2c_algo,
694
.power_ctrl = technisat_usb2_power_ctrl,
695
.read_mac_address = technisat_usb2_read_mac_address,
700
.frontend_attach = technisat_usb2_frontend_attach,
719
.num_device_descs = 1,
721
{ "Technisat SkyStar USB HD (DVB-S/S2)",
722
{ &technisat_usb2_id_table[0], NULL },
729
.rc_codes = RC_MAP_TECHNISAT_USB2,
730
.module_name = "technisat-usb2",
731
.rc_query = technisat_usb2_rc_query,
732
.allowed_protos = RC_TYPE_ALL,
733
.driver_type = RC_DRIVER_IR_RAW,
737
static int technisat_usb2_probe(struct usb_interface *intf,
738
const struct usb_device_id *id)
740
struct dvb_usb_device *dev;
742
if (dvb_usb_device_init(intf, &technisat_usb2_devices, THIS_MODULE,
743
&dev, adapter_nr) != 0)
747
struct technisat_usb2_state *state = dev->priv;
750
if (!disable_led_control) {
751
INIT_DELAYED_WORK(&state->green_led_work,
752
technisat_usb2_green_led_control);
753
schedule_delayed_work(&state->green_led_work,
754
msecs_to_jiffies(500));
761
static void technisat_usb2_disconnect(struct usb_interface *intf)
763
struct dvb_usb_device *dev = usb_get_intfdata(intf);
765
/* work and stuff was only created when the device is is hot-state */
767
struct technisat_usb2_state *state = dev->priv;
769
cancel_delayed_work_sync(&state->green_led_work);
770
flush_scheduled_work();
774
dvb_usb_device_exit(intf);
777
static struct usb_driver technisat_usb2_driver = {
778
.name = "dvb_usb_technisat_usb2",
779
.probe = technisat_usb2_probe,
780
.disconnect = technisat_usb2_disconnect,
781
.id_table = technisat_usb2_id_table,
785
static int __init technisat_usb2_module_init(void)
787
int result = usb_register(&technisat_usb2_driver);
789
err("usb_register failed. Code %d", result);
796
static void __exit technisat_usb2_module_exit(void)
798
usb_deregister(&technisat_usb2_driver);
801
module_init(technisat_usb2_module_init);
802
module_exit(technisat_usb2_module_exit);
804
MODULE_AUTHOR("Patrick Boettcher <pboettcher@kernellabs.com>");
805
MODULE_DESCRIPTION("Driver for Technisat DVB-S/S2 USB 2.0 device");
806
MODULE_VERSION("1.0");
807
MODULE_LICENSE("GPL");