1 /* DVB USB compliant linux driver for IT9137
3 * Copyright (C) 2011 Malcolm Priestley (tvboxspy@gmail.com)
4 * IT9137 (C) ITE Tech Inc.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License Version 2, as
8 * published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 * see Documentation/dvb/README.dvb-usb for more information
21 * see Documentation/dvb/it9137.txt for firmware information
24 #define DVB_USB_LOG_PREFIX "it913x"
26 #include <linux/usb.h>
27 #include <linux/usb/input.h>
28 #include <media/rc-core.h>
31 #include "it913x-fe.h"
34 static int dvb_usb_it913x_debug
;
35 #define l_dprintk(var, level, args...) do { \
37 printk(KERN_DEBUG DVB_USB_LOG_PREFIX ": " args); \
40 #define deb_info(level, args...) l_dprintk(dvb_usb_it913x_debug, level, args)
41 #define debug_data_snipet(level, name, p) \
42 deb_info(level, name" (%02x%02x%02x%02x%02x%02x%02x%02x)", \
43 *p, *(p+1), *(p+2), *(p+3), *(p+4), \
44 *(p+5), *(p+6), *(p+7));
47 module_param_named(debug
, dvb_usb_it913x_debug
, int, 0644);
48 MODULE_PARM_DESC(debug
, "set debugging level (1=info (or-able))."
49 DVB_USB_DEBUG_STATUS
);
51 static int pid_filter
;
52 module_param_named(pid
, pid_filter
, int, 0644);
53 MODULE_PARM_DESC(pid
, "set default 0=on 1=off");
57 DVB_DEFINE_MOD_OPT_ADAPTER_NR(adapter_nr
);
72 struct ite_config it913x_config
;
74 static int it913x_bulk_write(struct usb_device
*dev
,
75 u8
*snd
, int len
, u8 pipe
)
79 ret
= usb_bulk_msg(dev
, usb_sndbulkpipe(dev
, pipe
),
80 snd
, len
, &actual_l
, 100);
84 static int it913x_bulk_read(struct usb_device
*dev
,
85 u8
*rev
, int len
, u8 pipe
)
89 ret
= usb_bulk_msg(dev
, usb_rcvbulkpipe(dev
, pipe
),
90 rev
, len
, &actual_l
, 200);
94 static u16
check_sum(u8
*p
, u8 len
)
99 sum
+= (i
++ & 1) ? (*p
++) << 8 : *p
++;
103 static int it913x_io(struct usb_device
*udev
, u8 mode
, u8 pro
,
104 u8 cmd
, u32 reg
, u8 addr
, u8
*data
, u8 len
)
106 int ret
= 0, i
, buf_size
= 1;
111 buff
= kzalloc(256, GFP_KERNEL
);
113 info("USB Buffer Failed");
117 buff
[buf_size
++] = pro
;
118 buff
[buf_size
++] = cmd
;
119 buff
[buf_size
++] = cmd_counter
;
124 buff
[buf_size
++] = len
;
125 buff
[buf_size
++] = 2;
126 buff
[buf_size
++] = (reg
>> 24);
127 buff
[buf_size
++] = (reg
>> 16) & 0xff;
128 buff
[buf_size
++] = (reg
>> 8) & 0xff;
129 buff
[buf_size
++] = reg
& 0xff;
132 buff
[buf_size
++] = addr
;
135 buff
[buf_size
++] = len
;
136 buff
[buf_size
++] = addr
;
137 buff
[buf_size
++] = (reg
>> 8) & 0xff;
138 buff
[buf_size
++] = reg
& 0xff;
152 for (i
= 0; i
< len
; i
++)
153 buff
[buf_size
++] = data
[i
];
155 chk_sum
= check_sum(&buff
[1], buf_size
);
157 buff
[buf_size
++] = chk_sum
>> 8;
159 buff
[buf_size
++] = (chk_sum
& 0xff);
161 ret
= it913x_bulk_write(udev
, buff
, buf_size
, 0x02);
163 ret
|= it913x_bulk_read(udev
, buff
, (mode
& 1) ?
166 rlen
= (mode
& 0x1) ? 0x1 : len
;
171 memcpy(data
, &buff
[3], rlen
);
177 return (ret
< 0) ? -ENODEV
: 0;
180 static int it913x_wr_reg(struct usb_device
*udev
, u8 pro
, u32 reg
, u8 data
)
185 ret
= it913x_io(udev
, WRITE_LONG
, pro
,
186 CMD_DEMOD_WRITE
, reg
, 0, b
, sizeof(b
));
191 static int it913x_read_reg(struct usb_device
*udev
, u32 reg
)
196 ret
= it913x_io(udev
, READ_LONG
, DEV_0
,
197 CMD_DEMOD_READ
, reg
, 0, &data
[0], 1);
199 return (ret
< 0) ? ret
: data
[0];
202 static u32
it913x_query(struct usb_device
*udev
, u8 pro
)
206 ret
= it913x_io(udev
, READ_LONG
, pro
, CMD_DEMOD_READ
,
207 0x1222, 0, &data
[0], 3);
209 it913x_config
.chip_ver
= data
[0];
210 it913x_config
.chip_type
= (u16
)(data
[2] << 8) + data
[1];
212 info("Chip Version=%02x Chip Type=%04x", it913x_config
.chip_ver
,
213 it913x_config
.chip_type
);
215 ret
|= it913x_io(udev
, READ_SHORT
, pro
,
216 CMD_QUERYINFO
, 0, 0x1, &data
[0], 4);
218 it913x_config
.firmware
= (data
[0] << 24) + (data
[1] << 16) +
219 (data
[2] << 8) + data
[3];
221 return (ret
< 0) ? 0 : it913x_config
.firmware
;
224 static int it913x_pid_filter_ctrl(struct dvb_usb_adapter
*adap
, int onoff
)
227 u8 pro
= (adap
->id
== 0) ? DEV_0_DMOD
: DEV_1_DMOD
;
229 if (mutex_lock_interruptible(&adap
->dev
->i2c_mutex
) < 0)
231 deb_info(1, "PID_C (%02x)", onoff
);
234 ret
= it913x_wr_reg(adap
->dev
->udev
, pro
, PID_RST
, 0x1);
236 mutex_unlock(&adap
->dev
->i2c_mutex
);
240 static int it913x_pid_filter(struct dvb_usb_adapter
*adap
,
241 int index
, u16 pid
, int onoff
)
243 struct usb_device
*udev
= adap
->dev
->udev
;
245 u8 pro
= (adap
->id
== 0) ? DEV_0_DMOD
: DEV_1_DMOD
;
250 if (mutex_lock_interruptible(&adap
->dev
->i2c_mutex
) < 0)
252 deb_info(1, "PID_F (%02x)", onoff
);
254 ret
= it913x_wr_reg(udev
, pro
, PID_EN
, 0x1);
256 ret
|= it913x_wr_reg(udev
, pro
, PID_LSB
, (u8
)(pid
& 0xff));
258 ret
|= it913x_wr_reg(udev
, pro
, PID_MSB
, (u8
)(pid
>> 8));
260 ret
|= it913x_wr_reg(udev
, pro
, PID_INX_EN
, (u8
)onoff
);
262 ret
|= it913x_wr_reg(udev
, pro
, PID_INX
, (u8
)(index
& 0x1f));
266 mutex_unlock(&adap
->dev
->i2c_mutex
);
271 static int it913x_return_status(struct usb_device
*udev
)
275 firm
= it913x_query(udev
, DEV_0
);
277 info("Firmware Version %d", firm
);
279 return (firm
> 0) ? firm
: 0;
282 static int it913x_i2c_xfer(struct i2c_adapter
*adap
, struct i2c_msg msg
[],
285 struct dvb_usb_device
*d
= i2c_get_adapdata(adap
);
290 if (mutex_lock_interruptible(&d
->i2c_mutex
) < 0)
293 debug_data_snipet(1, "Message out", msg
[0].buf
);
294 deb_info(2, "num of messages %d address %02x", num
, msg
[0].addr
);
296 pro
= (msg
[0].addr
& 0x2) ? DEV_0_DMOD
: 0x0;
297 pro
|= (msg
[0].addr
& 0x20) ? DEV_1
: DEV_0
;
298 memcpy(data
, msg
[0].buf
, msg
[0].len
);
299 reg
= (data
[0] << 24) + (data
[1] << 16) +
300 (data
[2] << 8) + data
[3];
302 ret
= it913x_io(d
->udev
, READ_LONG
, pro
,
303 CMD_DEMOD_READ
, reg
, 0, data
, msg
[1].len
);
304 memcpy(msg
[1].buf
, data
, msg
[1].len
);
306 ret
= it913x_io(d
->udev
, WRITE_LONG
, pro
, CMD_DEMOD_WRITE
,
307 reg
, 0, &data
[4], msg
[0].len
- 4);
309 mutex_unlock(&d
->i2c_mutex
);
314 static u32
it913x_i2c_func(struct i2c_adapter
*adapter
)
319 static struct i2c_algorithm it913x_i2c_algo
= {
320 .master_xfer
= it913x_i2c_xfer
,
321 .functionality
= it913x_i2c_func
,
324 /* Callbacks for DVB USB */
325 #define IT913X_POLL 250
326 static int it913x_rc_query(struct dvb_usb_device
*d
)
331 /* Avoid conflict with frontends*/
332 if (mutex_lock_interruptible(&d
->i2c_mutex
) < 0)
335 ret
= it913x_io(d
->udev
, READ_LONG
, PRO_LINK
, CMD_IR_GET
,
336 0, 0, &ibuf
[0], sizeof(ibuf
));
338 if ((ibuf
[2] + ibuf
[3]) == 0xff) {
341 deb_info(1, "INT Key =%08x", key
);
342 if (d
->rc_dev
!= NULL
)
343 rc_keydown(d
->rc_dev
, key
, 0);
345 mutex_unlock(&d
->i2c_mutex
);
349 static int it913x_identify_state(struct usb_device
*udev
,
350 struct dvb_usb_device_properties
*props
,
351 struct dvb_usb_device_description
**desc
,
354 int ret
= 0, firm_no
;
357 firm_no
= it913x_return_status(udev
);
359 /* checnk for dual mode */
360 it913x_config
.dual_mode
= it913x_read_reg(udev
, 0x49c5);
362 /* TODO different remotes */
363 remote
= it913x_read_reg(udev
, 0x49ac); /* Remote */
365 props
->rc
.core
.rc_codes
= NULL
;
367 /* TODO at the moment tuner_id is always assigned to 0x38 */
368 it913x_config
.tuner_id_0
= it913x_read_reg(udev
, 0x49d0);
370 info("Dual mode=%x Remote=%x Tuner Type=%x", it913x_config
.dual_mode
371 , remote
, it913x_config
.tuner_id_0
);
378 if (it913x_config
.dual_mode
) {
379 it913x_config
.tuner_id_1
= it913x_read_reg(udev
, 0x49e0);
380 ret
= it913x_wr_reg(udev
, DEV_0
, GPIOH1_EN
, 0x1);
381 ret
|= it913x_wr_reg(udev
, DEV_0
, GPIOH1_ON
, 0x1);
382 ret
|= it913x_wr_reg(udev
, DEV_0
, GPIOH1_O
, 0x1);
384 ret
|= it913x_wr_reg(udev
, DEV_0
, GPIOH1_O
, 0x0);
386 reg
= it913x_read_reg(udev
, GPIOH1_O
);
388 ret
|= it913x_wr_reg(udev
, DEV_0
, GPIOH1_O
, 0x1);
389 ret
|= it913x_return_status(udev
);
391 ret
= it913x_wr_reg(udev
, DEV_0
,
394 props
->num_adapters
= 2;
396 props
->num_adapters
= 1;
398 reg
= it913x_read_reg(udev
, IO_MUX_POWER_CLK
);
400 if (it913x_config
.dual_mode
) {
401 ret
|= it913x_wr_reg(udev
, DEV_0
, 0x4bfb, CHIP2_I2C_ADDR
);
402 ret
|= it913x_wr_reg(udev
, DEV_0
, CLK_O_EN
, 0x1);
404 ret
|= it913x_wr_reg(udev
, DEV_0
, 0x4bfb, 0x0);
405 ret
|= it913x_wr_reg(udev
, DEV_0
, CLK_O_EN
, 0x0);
410 return (ret
< 0) ? -ENODEV
: 0;
413 static int it913x_streaming_ctrl(struct dvb_usb_adapter
*adap
, int onoff
)
416 u8 pro
= (adap
->id
== 0) ? DEV_0_DMOD
: DEV_1_DMOD
;
418 if (mutex_lock_interruptible(&adap
->dev
->i2c_mutex
) < 0)
420 deb_info(1, "STM (%02x)", onoff
);
423 ret
= it913x_wr_reg(adap
->dev
->udev
, pro
, PID_RST
, 0x1);
426 mutex_unlock(&adap
->dev
->i2c_mutex
);
432 static int it913x_download_firmware(struct usb_device
*udev
,
433 const struct firmware
*fw
)
436 u8 packet_size
, dlen
;
441 ret
= it913x_wr_reg(udev
, DEV_0
, I2C_CLK
, I2C_CLK_100
);
443 info("FRM Starting Firmware Download");
444 /* This uses scatter write firmware headers follow */
445 /* 03 XX 00 XX = chip number? */
447 for (i
= 0; i
< fw
->size
; i
+= packet_size
) {
450 fw_data
= (u8
*)(fw
->data
+ i
);
451 dlen
= ((i
+ packet_size
) > fw
->size
)
452 ? (fw
->size
- i
) : packet_size
;
453 ret
|= it913x_io(udev
, WRITE_DATA
, DEV_0
,
454 CMD_SCATTER_WRITE
, 0, 0, fw_data
, dlen
);
458 ret
|= it913x_io(udev
, WRITE_CMD
, DEV_0
,
459 CMD_BOOT
, 0, 0, NULL
, 0);
464 info("FRM Firmware Download Failed (%04x)" , ret
);
466 info("FRM Firmware Download Completed - Resetting Device");
468 ret
|= it913x_return_status(udev
);
472 ret
|= it913x_wr_reg(udev
, DEV_0
, I2C_CLK
, I2C_CLK_400
);
475 if (it913x_config
.dual_mode
)
476 ret
|= it913x_wr_reg(udev
, DEV_0_DMOD
, 0xec4c, 0xa0);
478 ret
|= it913x_wr_reg(udev
, DEV_0
, PADODPU
, 0x0);
479 ret
|= it913x_wr_reg(udev
, DEV_0
, AGC_O_D
, 0x0);
480 if (it913x_config
.dual_mode
) {
481 ret
|= it913x_wr_reg(udev
, DEV_1
, PADODPU
, 0x0);
482 ret
|= it913x_wr_reg(udev
, DEV_1
, AGC_O_D
, 0x0);
485 return (ret
< 0) ? -ENODEV
: 0;
488 static int it913x_name(struct dvb_usb_adapter
*adap
)
490 const char *desc
= adap
->dev
->desc
->name
;
491 char *fe_name
[] = {"_1", "_2", "_3", "_4"};
492 char *name
= adap
->fe_adap
[0].fe
->ops
.info
.name
;
494 strlcpy(name
, desc
, 128);
495 strlcat(name
, fe_name
[adap
->id
], 128);
500 static int it913x_frontend_attach(struct dvb_usb_adapter
*adap
)
502 struct usb_device
*udev
= adap
->dev
->udev
;
504 u8 adf
= it913x_read_reg(udev
, IO_MUX_POWER_CLK
);
505 u8 adap_addr
= I2C_BASE_ADDR
+ (adap
->id
<< 5);
506 u16 ep_size
= adap
->props
.fe
[0].stream
.u
.bulk
.buffersize
;
507 u8 tuner_id
, tuner_type
;
510 tuner_id
= it913x_config
.tuner_id_0
;
512 tuner_id
= it913x_config
.tuner_id_1
;
514 /* TODO we always use IT9137 possible references here*/
515 /* Documentation suggests don't care */
527 adap
->fe_adap
[0].fe
= dvb_attach(it913x_fe_attach
,
528 &adap
->dev
->i2c_adap
, adap_addr
, adf
, tuner_type
);
530 if (adap
->id
== 0 && adap
->fe_adap
[0].fe
) {
531 ret
= it913x_wr_reg(udev
, DEV_0_DMOD
, MP2_SW_RST
, 0x1);
532 ret
= it913x_wr_reg(udev
, DEV_0_DMOD
, MP2IF2_SW_RST
, 0x1);
533 ret
= it913x_wr_reg(udev
, DEV_0
, EP0_TX_EN
, 0x0f);
534 ret
= it913x_wr_reg(udev
, DEV_0
, EP0_TX_NAK
, 0x1b);
535 ret
= it913x_wr_reg(udev
, DEV_0
, EP0_TX_EN
, 0x2f);
536 ret
= it913x_wr_reg(udev
, DEV_0
, EP4_TX_LEN_LSB
,
538 ret
= it913x_wr_reg(udev
, DEV_0
, EP4_TX_LEN_MSB
, ep_size
>> 8);
539 ret
= it913x_wr_reg(udev
, DEV_0
, EP4_MAX_PKT
, 0x80);
540 } else if (adap
->id
== 1 && adap
->fe_adap
[0].fe
) {
541 ret
= it913x_wr_reg(udev
, DEV_0
, EP0_TX_EN
, 0x6f);
542 ret
= it913x_wr_reg(udev
, DEV_0
, EP5_TX_LEN_LSB
,
544 ret
= it913x_wr_reg(udev
, DEV_0
, EP5_TX_LEN_MSB
, ep_size
>> 8);
545 ret
= it913x_wr_reg(udev
, DEV_0
, EP5_MAX_PKT
, 0x80);
546 ret
= it913x_wr_reg(udev
, DEV_0_DMOD
, MP2IF2_EN
, 0x1);
547 ret
= it913x_wr_reg(udev
, DEV_1_DMOD
, MP2IF_SERIAL
, 0x1);
548 ret
= it913x_wr_reg(udev
, DEV_1
, TOP_HOSTB_SER_MODE
, 0x1);
549 ret
= it913x_wr_reg(udev
, DEV_0_DMOD
, TSIS_ENABLE
, 0x1);
550 ret
= it913x_wr_reg(udev
, DEV_0_DMOD
, MP2_SW_RST
, 0x0);
551 ret
= it913x_wr_reg(udev
, DEV_0_DMOD
, MP2IF2_SW_RST
, 0x0);
552 ret
= it913x_wr_reg(udev
, DEV_0_DMOD
, MP2IF2_HALF_PSB
, 0x0);
553 ret
= it913x_wr_reg(udev
, DEV_0_DMOD
, MP2IF_STOP_EN
, 0x1);
554 ret
= it913x_wr_reg(udev
, DEV_1_DMOD
, MPEG_FULL_SPEED
, 0x0);
555 ret
= it913x_wr_reg(udev
, DEV_1_DMOD
, MP2IF_STOP_EN
, 0x0);
559 ret
= it913x_name(adap
);
565 static struct dvb_usb_device_properties it913x_properties
;
567 static int it913x_probe(struct usb_interface
*intf
,
568 const struct usb_device_id
*id
)
571 if (0 == dvb_usb_device_init(intf
, &it913x_properties
,
572 THIS_MODULE
, NULL
, adapter_nr
)) {
573 info("DEV registering device driver");
577 info("DEV it913x Error");
582 static struct usb_device_id it913x_table
[] = {
583 { USB_DEVICE(USB_VID_KWORLD_2
, USB_PID_KWORLD_UB499_2T_T09
) },
584 { USB_DEVICE(USB_VID_ITETECH
, USB_PID_ITETECH_IT9135
) },
585 {} /* Terminating entry */
588 MODULE_DEVICE_TABLE(usb
, it913x_table
);
590 static struct dvb_usb_device_properties it913x_properties
= {
591 .caps
= DVB_USB_IS_AN_I2C_ADAPTER
,
592 .usb_ctrl
= DEVICE_SPECIFIC
,
593 .download_firmware
= it913x_download_firmware
,
594 .firmware
= "dvb-usb-it9137-01.fw",
596 .size_of_priv
= sizeof(struct it913x_state
),
602 .caps
= DVB_USB_ADAP_HAS_PID_FILTER
|
603 DVB_USB_ADAP_NEED_PID_FILTERING
|
604 DVB_USB_ADAP_PID_FILTER_CAN_BE_TURNED_OFF
,
605 .streaming_ctrl
= it913x_streaming_ctrl
,
606 .pid_filter_count
= 31,
607 .pid_filter
= it913x_pid_filter
,
608 .pid_filter_ctrl
= it913x_pid_filter_ctrl
,
609 .frontend_attach
= it913x_frontend_attach
,
610 /* parameter for the MPEG2-data transfer */
615 .u
= {/* Keep Low if PID filter on */
627 .caps
= DVB_USB_ADAP_HAS_PID_FILTER
|
628 DVB_USB_ADAP_NEED_PID_FILTERING
|
629 DVB_USB_ADAP_PID_FILTER_CAN_BE_TURNED_OFF
,
630 .streaming_ctrl
= it913x_streaming_ctrl
,
631 .pid_filter_count
= 31,
632 .pid_filter
= it913x_pid_filter
,
633 .pid_filter_ctrl
= it913x_pid_filter_ctrl
,
634 .frontend_attach
= it913x_frontend_attach
,
635 /* parameter for the MPEG2-data transfer */
650 .identify_state
= it913x_identify_state
,
652 .protocol
= RC_TYPE_NEC
,
653 .module_name
= "it913x",
654 .rc_query
= it913x_rc_query
,
655 .rc_interval
= IT913X_POLL
,
656 .allowed_protos
= RC_TYPE_NEC
,
657 .rc_codes
= RC_MAP_KWORLD_315U
,
659 .i2c_algo
= &it913x_i2c_algo
,
660 .num_device_descs
= 2,
662 { "Kworld UB499-2T T09(IT9137)",
663 { &it913x_table
[0], NULL
},
665 { "ITE 9135 Generic",
666 { &it913x_table
[1], NULL
},
671 static struct usb_driver it913x_driver
= {
673 .probe
= it913x_probe
,
674 .disconnect
= dvb_usb_device_exit
,
675 .id_table
= it913x_table
,
678 module_usb_driver(it913x_driver
);
680 MODULE_AUTHOR("Malcolm Priestley <tvboxspy@gmail.com>");
681 MODULE_DESCRIPTION("it913x USB 2 Driver");
682 MODULE_VERSION("1.07");
683 MODULE_LICENSE("GPL");