radio-shark2.c 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389
  1. /*
  2. * Linux V4L2 radio driver for the Griffin radioSHARK2 USB radio receiver
  3. *
  4. * Note the radioSHARK2 offers the audio through a regular USB audio device,
  5. * this driver only handles the tuning.
  6. *
  7. * The info necessary to drive the shark2 was taken from the small userspace
  8. * shark2.c program by Hisaaki Shibata, which he kindly placed in the Public
  9. * Domain.
  10. *
  11. * Copyright (c) 2012 Hans de Goede <hdegoede@redhat.com>
  12. *
  13. * This program is free software; you can redistribute it and/or modify
  14. * it under the terms of the GNU General Public License as published by
  15. * the Free Software Foundation; either version 2 of the License, or
  16. * (at your option) any later version.
  17. *
  18. * This program is distributed in the hope that it will be useful,
  19. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  21. * GNU General Public License for more details.
  22. *
  23. * You should have received a copy of the GNU General Public License
  24. * along with this program; if not, write to the Free Software
  25. * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  26. */
  27. #include <linux/init.h>
  28. #include <linux/kernel.h>
  29. #include <linux/leds.h>
  30. #include <linux/module.h>
  31. #include <linux/slab.h>
  32. #include <linux/usb.h>
  33. #include <linux/workqueue.h>
  34. #include <media/v4l2-device.h>
  35. #include "radio-tea5777.h"
  36. #if defined(CONFIG_LEDS_CLASS) || \
  37. (defined(CONFIG_LEDS_CLASS_MODULE) && defined(CONFIG_RADIO_SHARK2_MODULE))
  38. #define SHARK_USE_LEDS 1
  39. #endif
  40. MODULE_AUTHOR("Hans de Goede <hdegoede@redhat.com>");
  41. MODULE_DESCRIPTION("Griffin radioSHARK2, USB radio receiver driver");
  42. MODULE_LICENSE("GPL");
  43. static int debug;
  44. module_param(debug, int, 0);
  45. MODULE_PARM_DESC(debug, "Debug level (0-1)");
  46. #define SHARK_IN_EP 0x83
  47. #define SHARK_OUT_EP 0x05
  48. #define TB_LEN 7
  49. #define DRV_NAME "radioshark2"
  50. #define v4l2_dev_to_shark(d) container_of(d, struct shark_device, v4l2_dev)
  51. enum { BLUE_LED, RED_LED, NO_LEDS };
  52. struct shark_device {
  53. struct usb_device *usbdev;
  54. struct v4l2_device v4l2_dev;
  55. struct radio_tea5777 tea;
  56. #ifdef SHARK_USE_LEDS
  57. struct work_struct led_work;
  58. struct led_classdev leds[NO_LEDS];
  59. char led_names[NO_LEDS][32];
  60. atomic_t brightness[NO_LEDS];
  61. unsigned long brightness_new;
  62. #endif
  63. u8 *transfer_buffer;
  64. };
  65. static atomic_t shark_instance = ATOMIC_INIT(0);
  66. static int shark_write_reg(struct radio_tea5777 *tea, u64 reg)
  67. {
  68. struct shark_device *shark = tea->private_data;
  69. int i, res, actual_len;
  70. memset(shark->transfer_buffer, 0, TB_LEN);
  71. shark->transfer_buffer[0] = 0x81; /* Write register command */
  72. for (i = 0; i < 6; i++)
  73. shark->transfer_buffer[i + 1] = (reg >> (40 - i * 8)) & 0xff;
  74. v4l2_dbg(1, debug, tea->v4l2_dev, "shark2-write: %*ph\n",
  75. 7, shark->transfer_buffer);
  76. res = usb_interrupt_msg(shark->usbdev,
  77. usb_sndintpipe(shark->usbdev, SHARK_OUT_EP),
  78. shark->transfer_buffer, TB_LEN,
  79. &actual_len, 1000);
  80. if (res < 0) {
  81. v4l2_err(tea->v4l2_dev, "write error: %d\n", res);
  82. return res;
  83. }
  84. return 0;
  85. }
  86. static int shark_read_reg(struct radio_tea5777 *tea, u32 *reg_ret)
  87. {
  88. struct shark_device *shark = tea->private_data;
  89. int i, res, actual_len;
  90. u32 reg = 0;
  91. memset(shark->transfer_buffer, 0, TB_LEN);
  92. shark->transfer_buffer[0] = 0x82;
  93. res = usb_interrupt_msg(shark->usbdev,
  94. usb_sndintpipe(shark->usbdev, SHARK_OUT_EP),
  95. shark->transfer_buffer, TB_LEN,
  96. &actual_len, 1000);
  97. if (res < 0) {
  98. v4l2_err(tea->v4l2_dev, "request-read error: %d\n", res);
  99. return res;
  100. }
  101. res = usb_interrupt_msg(shark->usbdev,
  102. usb_rcvintpipe(shark->usbdev, SHARK_IN_EP),
  103. shark->transfer_buffer, TB_LEN,
  104. &actual_len, 1000);
  105. if (res < 0) {
  106. v4l2_err(tea->v4l2_dev, "read error: %d\n", res);
  107. return res;
  108. }
  109. for (i = 0; i < 3; i++)
  110. reg |= shark->transfer_buffer[i] << (16 - i * 8);
  111. v4l2_dbg(1, debug, tea->v4l2_dev, "shark2-read: %*ph\n",
  112. 3, shark->transfer_buffer);
  113. *reg_ret = reg;
  114. return 0;
  115. }
  116. static struct radio_tea5777_ops shark_tea_ops = {
  117. .write_reg = shark_write_reg,
  118. .read_reg = shark_read_reg,
  119. };
  120. #ifdef SHARK_USE_LEDS
  121. static void shark_led_work(struct work_struct *work)
  122. {
  123. struct shark_device *shark =
  124. container_of(work, struct shark_device, led_work);
  125. int i, res, brightness, actual_len;
  126. for (i = 0; i < 2; i++) {
  127. if (!test_and_clear_bit(i, &shark->brightness_new))
  128. continue;
  129. brightness = atomic_read(&shark->brightness[i]);
  130. memset(shark->transfer_buffer, 0, TB_LEN);
  131. shark->transfer_buffer[0] = 0x83 + i;
  132. shark->transfer_buffer[1] = brightness;
  133. res = usb_interrupt_msg(shark->usbdev,
  134. usb_sndintpipe(shark->usbdev,
  135. SHARK_OUT_EP),
  136. shark->transfer_buffer, TB_LEN,
  137. &actual_len, 1000);
  138. if (res < 0)
  139. v4l2_err(&shark->v4l2_dev, "set LED %s error: %d\n",
  140. shark->led_names[i], res);
  141. }
  142. }
  143. static void shark_led_set_blue(struct led_classdev *led_cdev,
  144. enum led_brightness value)
  145. {
  146. struct shark_device *shark =
  147. container_of(led_cdev, struct shark_device, leds[BLUE_LED]);
  148. atomic_set(&shark->brightness[BLUE_LED], value);
  149. set_bit(BLUE_LED, &shark->brightness_new);
  150. schedule_work(&shark->led_work);
  151. }
  152. static void shark_led_set_red(struct led_classdev *led_cdev,
  153. enum led_brightness value)
  154. {
  155. struct shark_device *shark =
  156. container_of(led_cdev, struct shark_device, leds[RED_LED]);
  157. atomic_set(&shark->brightness[RED_LED], value);
  158. set_bit(RED_LED, &shark->brightness_new);
  159. schedule_work(&shark->led_work);
  160. }
  161. static const struct led_classdev shark_led_templates[NO_LEDS] = {
  162. [BLUE_LED] = {
  163. .name = "%s:blue:",
  164. .brightness = LED_OFF,
  165. .max_brightness = 127,
  166. .brightness_set = shark_led_set_blue,
  167. },
  168. [RED_LED] = {
  169. .name = "%s:red:",
  170. .brightness = LED_OFF,
  171. .max_brightness = 1,
  172. .brightness_set = shark_led_set_red,
  173. },
  174. };
  175. static int shark_register_leds(struct shark_device *shark, struct device *dev)
  176. {
  177. int i, retval;
  178. atomic_set(&shark->brightness[BLUE_LED], 127);
  179. INIT_WORK(&shark->led_work, shark_led_work);
  180. for (i = 0; i < NO_LEDS; i++) {
  181. shark->leds[i] = shark_led_templates[i];
  182. snprintf(shark->led_names[i], sizeof(shark->led_names[0]),
  183. shark->leds[i].name, shark->v4l2_dev.name);
  184. shark->leds[i].name = shark->led_names[i];
  185. retval = led_classdev_register(dev, &shark->leds[i]);
  186. if (retval) {
  187. v4l2_err(&shark->v4l2_dev,
  188. "couldn't register led: %s\n",
  189. shark->led_names[i]);
  190. return retval;
  191. }
  192. }
  193. return 0;
  194. }
  195. static void shark_unregister_leds(struct shark_device *shark)
  196. {
  197. int i;
  198. for (i = 0; i < NO_LEDS; i++)
  199. led_classdev_unregister(&shark->leds[i]);
  200. cancel_work_sync(&shark->led_work);
  201. }
  202. static inline void shark_resume_leds(struct shark_device *shark)
  203. {
  204. int i;
  205. for (i = 0; i < NO_LEDS; i++)
  206. set_bit(i, &shark->brightness_new);
  207. schedule_work(&shark->led_work);
  208. }
  209. #else
  210. static int shark_register_leds(struct shark_device *shark, struct device *dev)
  211. {
  212. v4l2_warn(&shark->v4l2_dev,
  213. "CONFIG_LEDS_CLASS not enabled, LED support disabled\n");
  214. return 0;
  215. }
  216. static inline void shark_unregister_leds(struct shark_device *shark) { }
  217. static inline void shark_resume_leds(struct shark_device *shark) { }
  218. #endif
  219. static void usb_shark_disconnect(struct usb_interface *intf)
  220. {
  221. struct v4l2_device *v4l2_dev = usb_get_intfdata(intf);
  222. struct shark_device *shark = v4l2_dev_to_shark(v4l2_dev);
  223. mutex_lock(&shark->tea.mutex);
  224. v4l2_device_disconnect(&shark->v4l2_dev);
  225. radio_tea5777_exit(&shark->tea);
  226. mutex_unlock(&shark->tea.mutex);
  227. shark_unregister_leds(shark);
  228. v4l2_device_put(&shark->v4l2_dev);
  229. }
  230. static void usb_shark_release(struct v4l2_device *v4l2_dev)
  231. {
  232. struct shark_device *shark = v4l2_dev_to_shark(v4l2_dev);
  233. v4l2_device_unregister(&shark->v4l2_dev);
  234. kfree(shark->transfer_buffer);
  235. kfree(shark);
  236. }
  237. static int usb_shark_probe(struct usb_interface *intf,
  238. const struct usb_device_id *id)
  239. {
  240. struct shark_device *shark;
  241. int retval = -ENOMEM;
  242. shark = kzalloc(sizeof(struct shark_device), GFP_KERNEL);
  243. if (!shark)
  244. return retval;
  245. shark->transfer_buffer = kmalloc(TB_LEN, GFP_KERNEL);
  246. if (!shark->transfer_buffer)
  247. goto err_alloc_buffer;
  248. v4l2_device_set_name(&shark->v4l2_dev, DRV_NAME, &shark_instance);
  249. retval = shark_register_leds(shark, &intf->dev);
  250. if (retval)
  251. goto err_reg_leds;
  252. shark->v4l2_dev.release = usb_shark_release;
  253. retval = v4l2_device_register(&intf->dev, &shark->v4l2_dev);
  254. if (retval) {
  255. v4l2_err(&shark->v4l2_dev, "couldn't register v4l2_device\n");
  256. goto err_reg_dev;
  257. }
  258. shark->usbdev = interface_to_usbdev(intf);
  259. shark->tea.v4l2_dev = &shark->v4l2_dev;
  260. shark->tea.private_data = shark;
  261. shark->tea.ops = &shark_tea_ops;
  262. shark->tea.has_am = true;
  263. shark->tea.write_before_read = true;
  264. strlcpy(shark->tea.card, "Griffin radioSHARK2",
  265. sizeof(shark->tea.card));
  266. usb_make_path(shark->usbdev, shark->tea.bus_info,
  267. sizeof(shark->tea.bus_info));
  268. retval = radio_tea5777_init(&shark->tea, THIS_MODULE);
  269. if (retval) {
  270. v4l2_err(&shark->v4l2_dev, "couldn't init tea5777\n");
  271. goto err_init_tea;
  272. }
  273. return 0;
  274. err_init_tea:
  275. v4l2_device_unregister(&shark->v4l2_dev);
  276. err_reg_dev:
  277. shark_unregister_leds(shark);
  278. err_reg_leds:
  279. kfree(shark->transfer_buffer);
  280. err_alloc_buffer:
  281. kfree(shark);
  282. return retval;
  283. }
  284. #ifdef CONFIG_PM
  285. static int usb_shark_suspend(struct usb_interface *intf, pm_message_t message)
  286. {
  287. return 0;
  288. }
  289. static int usb_shark_resume(struct usb_interface *intf)
  290. {
  291. struct v4l2_device *v4l2_dev = usb_get_intfdata(intf);
  292. struct shark_device *shark = v4l2_dev_to_shark(v4l2_dev);
  293. int ret;
  294. mutex_lock(&shark->tea.mutex);
  295. ret = radio_tea5777_set_freq(&shark->tea);
  296. mutex_unlock(&shark->tea.mutex);
  297. shark_resume_leds(shark);
  298. return ret;
  299. }
  300. #endif
  301. /* Specify the bcdDevice value, as the radioSHARK and radioSHARK2 share ids */
  302. static struct usb_device_id usb_shark_device_table[] = {
  303. { .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION |
  304. USB_DEVICE_ID_MATCH_INT_CLASS,
  305. .idVendor = 0x077d,
  306. .idProduct = 0x627a,
  307. .bcdDevice_lo = 0x0010,
  308. .bcdDevice_hi = 0x0010,
  309. .bInterfaceClass = 3,
  310. },
  311. { }
  312. };
  313. MODULE_DEVICE_TABLE(usb, usb_shark_device_table);
  314. static struct usb_driver usb_shark_driver = {
  315. .name = DRV_NAME,
  316. .probe = usb_shark_probe,
  317. .disconnect = usb_shark_disconnect,
  318. .id_table = usb_shark_device_table,
  319. #ifdef CONFIG_PM
  320. .suspend = usb_shark_suspend,
  321. .resume = usb_shark_resume,
  322. .reset_resume = usb_shark_resume,
  323. #endif
  324. };
  325. module_usb_driver(usb_shark_driver);