14faba767SHans de Goede /* 24faba767SHans de Goede * Linux V4L2 radio driver for the Griffin radioSHARK2 USB radio receiver 34faba767SHans de Goede * 44faba767SHans de Goede * Note the radioSHARK2 offers the audio through a regular USB audio device, 54faba767SHans de Goede * this driver only handles the tuning. 64faba767SHans de Goede * 74faba767SHans de Goede * The info necessary to drive the shark2 was taken from the small userspace 84faba767SHans de Goede * shark2.c program by Hisaaki Shibata, which he kindly placed in the Public 94faba767SHans de Goede * Domain. 104faba767SHans de Goede * 114faba767SHans de Goede * Copyright (c) 2012 Hans de Goede <hdegoede@redhat.com> 124faba767SHans de Goede * 134faba767SHans de Goede * This program is free software; you can redistribute it and/or modify 144faba767SHans de Goede * it under the terms of the GNU General Public License as published by 154faba767SHans de Goede * the Free Software Foundation; either version 2 of the License, or 164faba767SHans de Goede * (at your option) any later version. 174faba767SHans de Goede * 184faba767SHans de Goede * This program is distributed in the hope that it will be useful, 194faba767SHans de Goede * but WITHOUT ANY WARRANTY; without even the implied warranty of 204faba767SHans de Goede * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 214faba767SHans de Goede * GNU General Public License for more details. 224faba767SHans de Goede * 234faba767SHans de Goede * You should have received a copy of the GNU General Public License 244faba767SHans de Goede * along with this program; if not, write to the Free Software 254faba767SHans de Goede * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 264faba767SHans de Goede */ 274faba767SHans de Goede 284faba767SHans de Goede #include <linux/init.h> 294faba767SHans de Goede #include <linux/kernel.h> 304faba767SHans de Goede #include <linux/leds.h> 314faba767SHans de Goede #include <linux/module.h> 324faba767SHans de Goede #include <linux/slab.h> 334faba767SHans de Goede #include <linux/usb.h> 344faba767SHans de Goede #include <linux/workqueue.h> 354faba767SHans de Goede #include <media/v4l2-device.h> 364faba767SHans de Goede #include "radio-tea5777.h" 374faba767SHans de Goede 38be0c44fbSHans de Goede #if defined(CONFIG_LEDS_CLASS) || \ 39be0c44fbSHans de Goede (defined(CONFIG_LEDS_CLASS_MODULE) && defined(CONFIG_RADIO_SHARK2_MODULE)) 40be0c44fbSHans de Goede #define SHARK_USE_LEDS 1 41be0c44fbSHans de Goede #endif 42be0c44fbSHans de Goede 434faba767SHans de Goede MODULE_AUTHOR("Hans de Goede <hdegoede@redhat.com>"); 444faba767SHans de Goede MODULE_DESCRIPTION("Griffin radioSHARK2, USB radio receiver driver"); 454faba767SHans de Goede MODULE_LICENSE("GPL"); 464faba767SHans de Goede 474faba767SHans de Goede static int debug; 484faba767SHans de Goede module_param(debug, int, 0); 494faba767SHans de Goede MODULE_PARM_DESC(debug, "Debug level (0-1)"); 504faba767SHans de Goede 514faba767SHans de Goede #define SHARK_IN_EP 0x83 524faba767SHans de Goede #define SHARK_OUT_EP 0x05 534faba767SHans de Goede 544faba767SHans de Goede #define TB_LEN 7 554faba767SHans de Goede #define DRV_NAME "radioshark2" 564faba767SHans de Goede 574faba767SHans de Goede #define v4l2_dev_to_shark(d) container_of(d, struct shark_device, v4l2_dev) 584faba767SHans de Goede 594faba767SHans de Goede enum { BLUE_LED, RED_LED, NO_LEDS }; 604faba767SHans de Goede 614faba767SHans de Goede struct shark_device { 624faba767SHans de Goede struct usb_device *usbdev; 634faba767SHans de Goede struct v4l2_device v4l2_dev; 644faba767SHans de Goede struct radio_tea5777 tea; 654faba767SHans de Goede 66be0c44fbSHans de Goede #ifdef SHARK_USE_LEDS 674faba767SHans de Goede struct work_struct led_work; 684faba767SHans de Goede struct led_classdev leds[NO_LEDS]; 694faba767SHans de Goede char led_names[NO_LEDS][32]; 704faba767SHans de Goede atomic_t brightness[NO_LEDS]; 714faba767SHans de Goede unsigned long brightness_new; 72be0c44fbSHans de Goede #endif 734faba767SHans de Goede 744faba767SHans de Goede u8 *transfer_buffer; 754faba767SHans de Goede }; 764faba767SHans de Goede 774faba767SHans de Goede static atomic_t shark_instance = ATOMIC_INIT(0); 784faba767SHans de Goede 794faba767SHans de Goede static int shark_write_reg(struct radio_tea5777 *tea, u64 reg) 804faba767SHans de Goede { 814faba767SHans de Goede struct shark_device *shark = tea->private_data; 824faba767SHans de Goede int i, res, actual_len; 834faba767SHans de Goede 844faba767SHans de Goede memset(shark->transfer_buffer, 0, TB_LEN); 854faba767SHans de Goede shark->transfer_buffer[0] = 0x81; /* Write register command */ 864faba767SHans de Goede for (i = 0; i < 6; i++) 874faba767SHans de Goede shark->transfer_buffer[i + 1] = (reg >> (40 - i * 8)) & 0xff; 884faba767SHans de Goede 899697b54fSAndy Shevchenko v4l2_dbg(1, debug, tea->v4l2_dev, "shark2-write: %*ph\n", 909697b54fSAndy Shevchenko 7, shark->transfer_buffer); 914faba767SHans de Goede 924faba767SHans de Goede res = usb_interrupt_msg(shark->usbdev, 934faba767SHans de Goede usb_sndintpipe(shark->usbdev, SHARK_OUT_EP), 944faba767SHans de Goede shark->transfer_buffer, TB_LEN, 954faba767SHans de Goede &actual_len, 1000); 964faba767SHans de Goede if (res < 0) { 974faba767SHans de Goede v4l2_err(tea->v4l2_dev, "write error: %d\n", res); 984faba767SHans de Goede return res; 994faba767SHans de Goede } 1004faba767SHans de Goede 1014faba767SHans de Goede return 0; 1024faba767SHans de Goede } 1034faba767SHans de Goede 1044faba767SHans de Goede static int shark_read_reg(struct radio_tea5777 *tea, u32 *reg_ret) 1054faba767SHans de Goede { 1064faba767SHans de Goede struct shark_device *shark = tea->private_data; 1074faba767SHans de Goede int i, res, actual_len; 1084faba767SHans de Goede u32 reg = 0; 1094faba767SHans de Goede 1104faba767SHans de Goede memset(shark->transfer_buffer, 0, TB_LEN); 1114faba767SHans de Goede shark->transfer_buffer[0] = 0x82; 1124faba767SHans de Goede res = usb_interrupt_msg(shark->usbdev, 1134faba767SHans de Goede usb_sndintpipe(shark->usbdev, SHARK_OUT_EP), 1144faba767SHans de Goede shark->transfer_buffer, TB_LEN, 1154faba767SHans de Goede &actual_len, 1000); 1164faba767SHans de Goede if (res < 0) { 1174faba767SHans de Goede v4l2_err(tea->v4l2_dev, "request-read error: %d\n", res); 1184faba767SHans de Goede return res; 1194faba767SHans de Goede } 1204faba767SHans de Goede 1214faba767SHans de Goede res = usb_interrupt_msg(shark->usbdev, 1224faba767SHans de Goede usb_rcvintpipe(shark->usbdev, SHARK_IN_EP), 1234faba767SHans de Goede shark->transfer_buffer, TB_LEN, 1244faba767SHans de Goede &actual_len, 1000); 1254faba767SHans de Goede if (res < 0) { 1264faba767SHans de Goede v4l2_err(tea->v4l2_dev, "read error: %d\n", res); 1274faba767SHans de Goede return res; 1284faba767SHans de Goede } 1294faba767SHans de Goede 1304faba767SHans de Goede for (i = 0; i < 3; i++) 1314faba767SHans de Goede reg |= shark->transfer_buffer[i] << (16 - i * 8); 1324faba767SHans de Goede 1339697b54fSAndy Shevchenko v4l2_dbg(1, debug, tea->v4l2_dev, "shark2-read: %*ph\n", 1349697b54fSAndy Shevchenko 3, shark->transfer_buffer); 1354faba767SHans de Goede 1364faba767SHans de Goede *reg_ret = reg; 1374faba767SHans de Goede return 0; 1384faba767SHans de Goede } 1394faba767SHans de Goede 1404faba767SHans de Goede static struct radio_tea5777_ops shark_tea_ops = { 1414faba767SHans de Goede .write_reg = shark_write_reg, 1424faba767SHans de Goede .read_reg = shark_read_reg, 1434faba767SHans de Goede }; 1444faba767SHans de Goede 145be0c44fbSHans de Goede #ifdef SHARK_USE_LEDS 1464faba767SHans de Goede static void shark_led_work(struct work_struct *work) 1474faba767SHans de Goede { 1484faba767SHans de Goede struct shark_device *shark = 1494faba767SHans de Goede container_of(work, struct shark_device, led_work); 1504faba767SHans de Goede int i, res, brightness, actual_len; 1514faba767SHans de Goede 1524faba767SHans de Goede for (i = 0; i < 2; i++) { 1534faba767SHans de Goede if (!test_and_clear_bit(i, &shark->brightness_new)) 1544faba767SHans de Goede continue; 1554faba767SHans de Goede 1564faba767SHans de Goede brightness = atomic_read(&shark->brightness[i]); 1574faba767SHans de Goede memset(shark->transfer_buffer, 0, TB_LEN); 1584faba767SHans de Goede shark->transfer_buffer[0] = 0x83 + i; 1594faba767SHans de Goede shark->transfer_buffer[1] = brightness; 1604faba767SHans de Goede res = usb_interrupt_msg(shark->usbdev, 1614faba767SHans de Goede usb_sndintpipe(shark->usbdev, 1624faba767SHans de Goede SHARK_OUT_EP), 1634faba767SHans de Goede shark->transfer_buffer, TB_LEN, 1644faba767SHans de Goede &actual_len, 1000); 1654faba767SHans de Goede if (res < 0) 1664faba767SHans de Goede v4l2_err(&shark->v4l2_dev, "set LED %s error: %d\n", 1674faba767SHans de Goede shark->led_names[i], res); 1684faba767SHans de Goede } 1694faba767SHans de Goede } 1704faba767SHans de Goede 1714faba767SHans de Goede static void shark_led_set_blue(struct led_classdev *led_cdev, 1724faba767SHans de Goede enum led_brightness value) 1734faba767SHans de Goede { 1744faba767SHans de Goede struct shark_device *shark = 1754faba767SHans de Goede container_of(led_cdev, struct shark_device, leds[BLUE_LED]); 1764faba767SHans de Goede 1774faba767SHans de Goede atomic_set(&shark->brightness[BLUE_LED], value); 1784faba767SHans de Goede set_bit(BLUE_LED, &shark->brightness_new); 1794faba767SHans de Goede schedule_work(&shark->led_work); 1804faba767SHans de Goede } 1814faba767SHans de Goede 1824faba767SHans de Goede static void shark_led_set_red(struct led_classdev *led_cdev, 1834faba767SHans de Goede enum led_brightness value) 1844faba767SHans de Goede { 1854faba767SHans de Goede struct shark_device *shark = 1864faba767SHans de Goede container_of(led_cdev, struct shark_device, leds[RED_LED]); 1874faba767SHans de Goede 1884faba767SHans de Goede atomic_set(&shark->brightness[RED_LED], value); 1894faba767SHans de Goede set_bit(RED_LED, &shark->brightness_new); 1904faba767SHans de Goede schedule_work(&shark->led_work); 1914faba767SHans de Goede } 1924faba767SHans de Goede 193be0c44fbSHans de Goede static const struct led_classdev shark_led_templates[NO_LEDS] = { 194be0c44fbSHans de Goede [BLUE_LED] = { 195be0c44fbSHans de Goede .name = "%s:blue:", 196be0c44fbSHans de Goede .brightness = LED_OFF, 197be0c44fbSHans de Goede .max_brightness = 127, 198be0c44fbSHans de Goede .brightness_set = shark_led_set_blue, 199be0c44fbSHans de Goede }, 200be0c44fbSHans de Goede [RED_LED] = { 201be0c44fbSHans de Goede .name = "%s:red:", 202be0c44fbSHans de Goede .brightness = LED_OFF, 203be0c44fbSHans de Goede .max_brightness = 1, 204be0c44fbSHans de Goede .brightness_set = shark_led_set_red, 205be0c44fbSHans de Goede }, 206be0c44fbSHans de Goede }; 207be0c44fbSHans de Goede 208be0c44fbSHans de Goede static int shark_register_leds(struct shark_device *shark, struct device *dev) 209be0c44fbSHans de Goede { 210be0c44fbSHans de Goede int i, retval; 211be0c44fbSHans de Goede 212d1f280d6SHans de Goede atomic_set(&shark->brightness[BLUE_LED], 127); 213be0c44fbSHans de Goede INIT_WORK(&shark->led_work, shark_led_work); 214be0c44fbSHans de Goede for (i = 0; i < NO_LEDS; i++) { 215be0c44fbSHans de Goede shark->leds[i] = shark_led_templates[i]; 216be0c44fbSHans de Goede snprintf(shark->led_names[i], sizeof(shark->led_names[0]), 217be0c44fbSHans de Goede shark->leds[i].name, shark->v4l2_dev.name); 218be0c44fbSHans de Goede shark->leds[i].name = shark->led_names[i]; 219be0c44fbSHans de Goede retval = led_classdev_register(dev, &shark->leds[i]); 220be0c44fbSHans de Goede if (retval) { 221be0c44fbSHans de Goede v4l2_err(&shark->v4l2_dev, 222be0c44fbSHans de Goede "couldn't register led: %s\n", 223be0c44fbSHans de Goede shark->led_names[i]); 224be0c44fbSHans de Goede return retval; 225be0c44fbSHans de Goede } 226be0c44fbSHans de Goede } 227be0c44fbSHans de Goede return 0; 228be0c44fbSHans de Goede } 229be0c44fbSHans de Goede 230be0c44fbSHans de Goede static void shark_unregister_leds(struct shark_device *shark) 231be0c44fbSHans de Goede { 232be0c44fbSHans de Goede int i; 233be0c44fbSHans de Goede 234be0c44fbSHans de Goede for (i = 0; i < NO_LEDS; i++) 235be0c44fbSHans de Goede led_classdev_unregister(&shark->leds[i]); 236be0c44fbSHans de Goede 237be0c44fbSHans de Goede cancel_work_sync(&shark->led_work); 238be0c44fbSHans de Goede } 239d1f280d6SHans de Goede 240d1f280d6SHans de Goede static void shark_resume_leds(struct shark_device *shark) 241d1f280d6SHans de Goede { 242d1f280d6SHans de Goede int i; 243d1f280d6SHans de Goede 244d1f280d6SHans de Goede for (i = 0; i < NO_LEDS; i++) 245d1f280d6SHans de Goede set_bit(i, &shark->brightness_new); 246d1f280d6SHans de Goede 247d1f280d6SHans de Goede schedule_work(&shark->led_work); 248d1f280d6SHans de Goede } 249be0c44fbSHans de Goede #else 250be0c44fbSHans de Goede static int shark_register_leds(struct shark_device *shark, struct device *dev) 251be0c44fbSHans de Goede { 252be0c44fbSHans de Goede v4l2_warn(&shark->v4l2_dev, 253be0c44fbSHans de Goede "CONFIG_LED_CLASS not enabled, LED support disabled\n"); 254be0c44fbSHans de Goede return 0; 255be0c44fbSHans de Goede } 256be0c44fbSHans de Goede static inline void shark_unregister_leds(struct shark_device *shark) { } 257d1f280d6SHans de Goede static inline void shark_resume_leds(struct shark_device *shark) { } 258be0c44fbSHans de Goede #endif 259be0c44fbSHans de Goede 2604faba767SHans de Goede static void usb_shark_disconnect(struct usb_interface *intf) 2614faba767SHans de Goede { 2624faba767SHans de Goede struct v4l2_device *v4l2_dev = usb_get_intfdata(intf); 2634faba767SHans de Goede struct shark_device *shark = v4l2_dev_to_shark(v4l2_dev); 2644faba767SHans de Goede 2654faba767SHans de Goede mutex_lock(&shark->tea.mutex); 2664faba767SHans de Goede v4l2_device_disconnect(&shark->v4l2_dev); 2674faba767SHans de Goede radio_tea5777_exit(&shark->tea); 2684faba767SHans de Goede mutex_unlock(&shark->tea.mutex); 2694faba767SHans de Goede 270be0c44fbSHans de Goede shark_unregister_leds(shark); 2714faba767SHans de Goede 2724faba767SHans de Goede v4l2_device_put(&shark->v4l2_dev); 2734faba767SHans de Goede } 2744faba767SHans de Goede 2754faba767SHans de Goede static void usb_shark_release(struct v4l2_device *v4l2_dev) 2764faba767SHans de Goede { 2774faba767SHans de Goede struct shark_device *shark = v4l2_dev_to_shark(v4l2_dev); 2784faba767SHans de Goede 2794faba767SHans de Goede v4l2_device_unregister(&shark->v4l2_dev); 2804faba767SHans de Goede kfree(shark->transfer_buffer); 2814faba767SHans de Goede kfree(shark); 2824faba767SHans de Goede } 2834faba767SHans de Goede 2844faba767SHans de Goede static int usb_shark_probe(struct usb_interface *intf, 2854faba767SHans de Goede const struct usb_device_id *id) 2864faba767SHans de Goede { 2874faba767SHans de Goede struct shark_device *shark; 288be0c44fbSHans de Goede int retval = -ENOMEM; 2894faba767SHans de Goede 2904faba767SHans de Goede shark = kzalloc(sizeof(struct shark_device), GFP_KERNEL); 2914faba767SHans de Goede if (!shark) 2924faba767SHans de Goede return retval; 2934faba767SHans de Goede 2944faba767SHans de Goede shark->transfer_buffer = kmalloc(TB_LEN, GFP_KERNEL); 2954faba767SHans de Goede if (!shark->transfer_buffer) 2964faba767SHans de Goede goto err_alloc_buffer; 2974faba767SHans de Goede 2984faba767SHans de Goede v4l2_device_set_name(&shark->v4l2_dev, DRV_NAME, &shark_instance); 299be0c44fbSHans de Goede 300be0c44fbSHans de Goede retval = shark_register_leds(shark, &intf->dev); 301be0c44fbSHans de Goede if (retval) 302be0c44fbSHans de Goede goto err_reg_leds; 3034faba767SHans de Goede 3044faba767SHans de Goede shark->v4l2_dev.release = usb_shark_release; 3054faba767SHans de Goede retval = v4l2_device_register(&intf->dev, &shark->v4l2_dev); 3064faba767SHans de Goede if (retval) { 3074faba767SHans de Goede v4l2_err(&shark->v4l2_dev, "couldn't register v4l2_device\n"); 3084faba767SHans de Goede goto err_reg_dev; 3094faba767SHans de Goede } 3104faba767SHans de Goede 3114faba767SHans de Goede shark->usbdev = interface_to_usbdev(intf); 3124faba767SHans de Goede shark->tea.v4l2_dev = &shark->v4l2_dev; 3134faba767SHans de Goede shark->tea.private_data = shark; 3144faba767SHans de Goede shark->tea.ops = &shark_tea_ops; 3154faba767SHans de Goede shark->tea.has_am = true; 3164faba767SHans de Goede shark->tea.write_before_read = true; 3174faba767SHans de Goede strlcpy(shark->tea.card, "Griffin radioSHARK2", 3184faba767SHans de Goede sizeof(shark->tea.card)); 3194faba767SHans de Goede usb_make_path(shark->usbdev, shark->tea.bus_info, 3204faba767SHans de Goede sizeof(shark->tea.bus_info)); 3214faba767SHans de Goede 3224faba767SHans de Goede retval = radio_tea5777_init(&shark->tea, THIS_MODULE); 3234faba767SHans de Goede if (retval) { 3244faba767SHans de Goede v4l2_err(&shark->v4l2_dev, "couldn't init tea5777\n"); 3254faba767SHans de Goede goto err_init_tea; 3264faba767SHans de Goede } 3274faba767SHans de Goede 3284faba767SHans de Goede return 0; 3294faba767SHans de Goede 3304faba767SHans de Goede err_init_tea: 3314faba767SHans de Goede v4l2_device_unregister(&shark->v4l2_dev); 3324faba767SHans de Goede err_reg_dev: 333be0c44fbSHans de Goede shark_unregister_leds(shark); 334be0c44fbSHans de Goede err_reg_leds: 3354faba767SHans de Goede kfree(shark->transfer_buffer); 3364faba767SHans de Goede err_alloc_buffer: 3374faba767SHans de Goede kfree(shark); 3384faba767SHans de Goede 3394faba767SHans de Goede return retval; 3404faba767SHans de Goede } 3414faba767SHans de Goede 342d1f280d6SHans de Goede #ifdef CONFIG_PM 343d1f280d6SHans de Goede int usb_shark_suspend(struct usb_interface *intf, pm_message_t message) 344d1f280d6SHans de Goede { 345d1f280d6SHans de Goede return 0; 346d1f280d6SHans de Goede } 347d1f280d6SHans de Goede 348d1f280d6SHans de Goede int usb_shark_resume(struct usb_interface *intf) 349d1f280d6SHans de Goede { 350d1f280d6SHans de Goede struct v4l2_device *v4l2_dev = usb_get_intfdata(intf); 351d1f280d6SHans de Goede struct shark_device *shark = v4l2_dev_to_shark(v4l2_dev); 352d1f280d6SHans de Goede int ret; 353d1f280d6SHans de Goede 354d1f280d6SHans de Goede mutex_lock(&shark->tea.mutex); 355d1f280d6SHans de Goede ret = radio_tea5777_set_freq(&shark->tea); 356d1f280d6SHans de Goede mutex_unlock(&shark->tea.mutex); 357d1f280d6SHans de Goede 358d1f280d6SHans de Goede shark_resume_leds(shark); 359d1f280d6SHans de Goede 360d1f280d6SHans de Goede return ret; 361d1f280d6SHans de Goede } 362d1f280d6SHans de Goede #endif 363d1f280d6SHans de Goede 3644faba767SHans de Goede /* Specify the bcdDevice value, as the radioSHARK and radioSHARK2 share ids */ 3654faba767SHans de Goede static struct usb_device_id usb_shark_device_table[] = { 3664faba767SHans de Goede { .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION | 3674faba767SHans de Goede USB_DEVICE_ID_MATCH_INT_CLASS, 3684faba767SHans de Goede .idVendor = 0x077d, 3694faba767SHans de Goede .idProduct = 0x627a, 3704faba767SHans de Goede .bcdDevice_lo = 0x0010, 3714faba767SHans de Goede .bcdDevice_hi = 0x0010, 3724faba767SHans de Goede .bInterfaceClass = 3, 3734faba767SHans de Goede }, 3744faba767SHans de Goede { } 3754faba767SHans de Goede }; 3764faba767SHans de Goede MODULE_DEVICE_TABLE(usb, usb_shark_device_table); 3774faba767SHans de Goede 3784faba767SHans de Goede static struct usb_driver usb_shark_driver = { 3794faba767SHans de Goede .name = DRV_NAME, 3804faba767SHans de Goede .probe = usb_shark_probe, 3814faba767SHans de Goede .disconnect = usb_shark_disconnect, 3824faba767SHans de Goede .id_table = usb_shark_device_table, 383d1f280d6SHans de Goede #ifdef CONFIG_PM 384d1f280d6SHans de Goede .suspend = usb_shark_suspend, 385d1f280d6SHans de Goede .resume = usb_shark_resume, 386d1f280d6SHans de Goede .reset_resume = usb_shark_resume, 387d1f280d6SHans de Goede #endif 3884faba767SHans de Goede }; 3894faba767SHans de Goede module_usb_driver(usb_shark_driver); 390