2 * device driver for Telegent tlg2300 based TV cards
5 * Kang Yong <kangyong@telegent.com>
6 * Zhang Xiaobing <xbzhang@telegent.com>
7 * Huang Shijie <zyziii@telegent.com> or <shijie8@gmail.com>
9 * (c) 2009 Telegent Systems
10 * (c) 2010 Telegent Systems
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27 #include <linux/kernel.h>
28 #include <linux/errno.h>
29 #include <linux/init.h>
30 #include <linux/slab.h>
31 #include <linux/module.h>
32 #include <linux/kref.h>
33 #include <linux/suspend.h>
34 #include <linux/usb/quirks.h>
35 #include <linux/ctype.h>
36 #include <linux/string.h>
37 #include <linux/types.h>
38 #include <linux/firmware.h>
40 #include "vendorcmds.h"
41 #include "pd-common.h"
43 #define VENDOR_ID 0x1B24
44 #define PRODUCT_ID 0x4001
45 static struct usb_device_id id_table[] = {
46 { USB_DEVICE_AND_INTERFACE_INFO(VENDOR_ID, PRODUCT_ID, 255, 1, 0) },
47 { USB_DEVICE_AND_INTERFACE_INFO(VENDOR_ID, PRODUCT_ID, 255, 1, 1) },
50 MODULE_DEVICE_TABLE(usb, id_table);
53 module_param(debug_mode, int, 0644);
54 MODULE_PARM_DESC(debug_mode, "0 = disable, 1 = enable, 2 = verbose");
56 #define TLG2300_FIRMWARE "tlg2300_firmware.bin"
57 static const char *firmware_name = TLG2300_FIRMWARE;
58 static struct usb_driver poseidon_driver;
59 static LIST_HEAD(pd_device_list);
62 * send set request to USB firmware.
64 s32 send_set_req(struct poseidon *pd, u8 cmdid, s32 param, s32 *cmd_status)
68 u16 lower_16, upper_16;
70 if (pd->state & POSEIDON_STATE_DISCONNECT)
76 upper_16 = lower_16 = 0;
78 /* send 32 bit param as two 16 bit param,little endian */
79 lower_16 = (unsigned short)(param & 0xffff);
80 upper_16 = (unsigned short)((param >> 16) & 0xffff);
82 ret = usb_control_msg(pd->udev,
83 usb_rcvctrlpipe(pd->udev, 0),
85 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
90 USB_CTRL_GET_TIMEOUT);
95 /* 1st 4 bytes into cmd_status */
96 memcpy((char *)cmd_status, &(data[0]), sizeof(*cmd_status));
102 * send get request to Poseidon firmware.
104 s32 send_get_req(struct poseidon *pd, u8 cmdid, s32 param,
105 void *buf, s32 *cmd_status, s32 datalen)
109 u16 lower_16, upper_16;
111 if (pd->state & POSEIDON_STATE_DISCONNECT)
116 upper_16 = lower_16 = 0;
118 /*send 32 bit param as two 16 bit param, little endian */
119 lower_16 = (unsigned short)(param & 0xffff);
120 upper_16 = (unsigned short)((param >> 16) & 0xffff);
122 ret = usb_control_msg(pd->udev,
123 usb_rcvctrlpipe(pd->udev, 0),
125 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
129 (datalen + sizeof(*cmd_status)),
130 USB_CTRL_GET_TIMEOUT);
135 /* 1st 4 bytes into cmd_status, remaining data into cmd_data */
136 memcpy((char *)cmd_status, &data[0], sizeof(*cmd_status));
137 memcpy((char *)buf, &data[sizeof(*cmd_status)], datalen);
142 static int pm_notifier_block(struct notifier_block *nb,
143 unsigned long event, void *dummy)
145 struct poseidon *pd = NULL;
146 struct list_head *node, *next;
149 case PM_POST_HIBERNATION:
150 list_for_each_safe(node, next, &pd_device_list) {
151 struct usb_device *udev;
152 struct usb_interface *iface;
155 pd = container_of(node, struct poseidon, device_list);
157 iface = pd->interface;
159 /* It will cause the system to reload the firmware */
160 rc = usb_lock_device_for_reset(udev, iface);
162 usb_reset_device(udev);
163 usb_unlock_device(udev);
170 log("event :%ld\n", event);
174 static struct notifier_block pm_notifer = {
175 .notifier_call = pm_notifier_block,
178 int set_tuner_mode(struct poseidon *pd, unsigned char mode)
182 if (pd->state & POSEIDON_STATE_DISCONNECT)
185 ret = send_set_req(pd, TUNE_MODE_SELECT, mode, &cmd_status);
186 if (ret || cmd_status)
191 void poseidon_delete(struct kref *kref)
193 struct poseidon *pd = container_of(kref, struct poseidon, kref);
197 list_del_init(&pd->device_list);
199 pd_dvb_usb_device_cleanup(pd);
200 /* clean_audio_data(&pd->audio_data);*/
203 usb_put_dev(pd->udev);
207 usb_put_intf(pd->interface);
208 pd->interface = NULL;
214 static int firmware_download(struct usb_device *udev)
216 int ret = 0, actual_length;
217 const struct firmware *fw = NULL;
219 size_t fwlength = 0, offset;
220 size_t max_packet_size;
222 ret = request_firmware(&fw, firmware_name, &udev->dev);
224 log("download err : %d", ret);
230 fwbuf = kmemdup(fw->data, fwlength, GFP_KERNEL);
236 max_packet_size = udev->ep_out[0x1]->desc.wMaxPacketSize;
237 log("\t\t download size : %d", (int)max_packet_size);
239 for (offset = 0; offset < fwlength; offset += max_packet_size) {
241 ret = usb_bulk_msg(udev,
242 usb_sndbulkpipe(udev, 0x01), /* ep 1 */
244 min(max_packet_size, fwlength - offset),
252 release_firmware(fw);
256 static inline struct poseidon *get_pd(struct usb_interface *intf)
258 return usb_get_intfdata(intf);
262 /* one-to-one map : poseidon{} <----> usb_device{}'s port */
263 static inline void set_map_flags(struct poseidon *pd, struct usb_device *udev)
265 pd->portnum = udev->portnum;
268 static inline int get_autopm_ref(struct poseidon *pd)
270 return pd->video_data.users + pd->vbi_data.users + pd->audio.users
271 + atomic_read(&pd->dvb_data.users) + pd->radio_data.users;
274 /* fixup something for poseidon */
275 static inline struct poseidon *fixup(struct poseidon *pd)
279 /* old udev and interface have gone, so put back reference . */
280 count = get_autopm_ref(pd);
281 log("count : %d, ref count : %d", count, get_pm_count(pd));
283 usb_autopm_put_interface(pd->interface);
284 /*usb_autopm_set_interface(pd->interface); */
286 usb_put_dev(pd->udev);
287 usb_put_intf(pd->interface);
288 log("event : %d\n", pd->msg.event);
292 static struct poseidon *find_old_poseidon(struct usb_device *udev)
296 list_for_each_entry(pd, &pd_device_list, device_list) {
297 if (pd->portnum == udev->portnum && in_hibernation(pd))
303 /* Is the card working now ? */
304 static inline int is_working(struct poseidon *pd)
306 return get_pm_count(pd) > 0;
309 static int poseidon_suspend(struct usb_interface *intf, pm_message_t msg)
311 struct poseidon *pd = get_pd(intf);
315 if (!is_working(pd)) {
316 if (get_pm_count(pd) <= 0 && !in_hibernation(pd)) {
317 pd->msg.event = PM_EVENT_AUTO_SUSPEND;
318 pd->pm_resume = NULL; /* a good guard */
319 printk(KERN_DEBUG "\n\t+ TLG2300 auto suspend +\n\n");
323 pd->msg = msg; /* save it here */
325 return pd->pm_suspend ? pd->pm_suspend(pd) : 0;
328 static int poseidon_resume(struct usb_interface *intf)
330 struct poseidon *pd = get_pd(intf);
334 printk(KERN_DEBUG "\n\t ++ TLG2300 resume ++\n\n");
336 if (!is_working(pd)) {
337 if (PM_EVENT_AUTO_SUSPEND == pd->msg.event)
341 if (in_hibernation(pd)) {
346 return pd->pm_resume ? pd->pm_resume(pd) : 0;
349 static void hibernation_resume(struct work_struct *w)
351 struct poseidon *pd = container_of(w, struct poseidon, pm_work);
354 pd->msg.event = 0; /* clear it here */
355 pd->state &= ~POSEIDON_STATE_DISCONNECT;
357 /* set the new interface's reference */
358 count = get_autopm_ref(pd);
360 usb_autopm_get_interface(pd->interface);
362 /* resume the context */
367 #else /* CONFIG_PM is not enabled: */
368 static inline struct poseidon *find_old_poseidon(struct usb_device *udev)
373 static inline void set_map_flags(struct poseidon *pd, struct usb_device *udev)
378 static int check_firmware(struct usb_device *udev, int *down_firmware)
382 struct cmd_firmware_vers_s *cmd_firm;
384 buf = kzalloc(sizeof(*cmd_firm) + sizeof(u32), GFP_KERNEL);
387 ret = usb_control_msg(udev,
388 usb_rcvctrlpipe(udev, 0),
389 REQ_GET_CMD | GET_FW_ID,
390 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
394 sizeof(*cmd_firm) + sizeof(u32),
395 USB_CTRL_GET_TIMEOUT);
400 return firmware_download(udev);
405 static int poseidon_probe(struct usb_interface *interface,
406 const struct usb_device_id *id)
408 struct usb_device *udev = interface_to_usbdev(interface);
409 struct poseidon *pd = NULL;
413 /* download firmware */
414 check_firmware(udev, &ret);
418 /* Do I recovery from the hibernate ? */
419 pd = find_old_poseidon(udev);
421 pd = kzalloc(sizeof(*pd), GFP_KERNEL);
424 kref_init(&pd->kref);
425 set_map_flags(pd, udev);
429 pd->udev = usb_get_dev(udev);
430 pd->interface = usb_get_intf(interface);
431 usb_set_intfdata(interface, pd);
434 struct device *dev = &interface->dev;
437 mutex_init(&pd->lock);
439 /* register v4l2 device */
440 snprintf(pd->v4l2_dev.name, sizeof(pd->v4l2_dev.name), "%s %s",
441 dev->driver->name, dev_name(dev));
442 ret = v4l2_device_register(NULL, &pd->v4l2_dev);
444 /* register devices in directory /dev */
445 ret = pd_video_init(pd);
446 poseidon_audio_init(pd);
447 poseidon_fm_init(pd);
448 pd_dvb_usb_device_init(pd);
450 INIT_LIST_HEAD(&pd->device_list);
451 list_add_tail(&pd->device_list, &pd_device_list);
454 device_init_wakeup(&udev->dev, 1);
456 pm_runtime_set_autosuspend_delay(&pd->udev->dev,
457 1000 * PM_SUSPEND_DELAY);
458 usb_enable_autosuspend(pd->udev);
460 if (in_hibernation(pd)) {
461 INIT_WORK(&pd->pm_work, hibernation_resume);
462 schedule_work(&pd->pm_work);
468 static void poseidon_disconnect(struct usb_interface *interface)
470 struct poseidon *pd = get_pd(interface);
475 if (in_hibernation(pd))
478 mutex_lock(&pd->lock);
479 pd->state |= POSEIDON_STATE_DISCONNECT;
480 mutex_unlock(&pd->lock);
482 /* stop urb transferring */
483 stop_all_video_stream(pd);
484 dvb_stop_streaming(&pd->dvb_data);
486 /*unregister v4l2 device */
487 v4l2_device_unregister(&pd->v4l2_dev);
489 pd_dvb_usb_device_exit(pd);
490 poseidon_fm_exit(pd);
492 poseidon_audio_free(pd);
495 usb_set_intfdata(interface, NULL);
496 kref_put(&pd->kref, poseidon_delete);
499 static struct usb_driver poseidon_driver = {
501 .probe = poseidon_probe,
502 .disconnect = poseidon_disconnect,
503 .id_table = id_table,
505 .suspend = poseidon_suspend,
506 .resume = poseidon_resume,
508 .supports_autosuspend = 1,
511 static int __init poseidon_init(void)
515 ret = usb_register(&poseidon_driver);
518 register_pm_notifier(&pm_notifer);
522 static void __exit poseidon_exit(void)
525 unregister_pm_notifier(&pm_notifer);
526 usb_deregister(&poseidon_driver);
529 module_init(poseidon_init);
530 module_exit(poseidon_exit);
532 MODULE_AUTHOR("Telegent Systems");
533 MODULE_DESCRIPTION("For tlg2300-based USB device ");
534 MODULE_LICENSE("GPL");
535 MODULE_VERSION("0.0.2");
536 MODULE_FIRMWARE(TLG2300_FIRMWARE);