Hans de Goede | 8e2ce73 | 2012-05-21 15:24:50 -0300 | [diff] [blame] | 1 | /* |
| 2 | * Linux V4L2 radio driver for the Griffin radioSHARK USB radio receiver |
| 3 | * |
| 4 | * Note the radioSHARK offers the audio through a regular USB audio device, |
| 5 | * this driver only handles the tuning. |
| 6 | * |
| 7 | * The info necessary to drive the shark was taken from the small userspace |
| 8 | * shark.c program by Michael Rolig, 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 | |
| 28 | #include <linux/init.h> |
| 29 | #include <linux/kernel.h> |
| 30 | #include <linux/leds.h> |
| 31 | #include <linux/module.h> |
| 32 | #include <linux/slab.h> |
| 33 | #include <linux/usb.h> |
| 34 | #include <linux/workqueue.h> |
| 35 | #include <media/v4l2-device.h> |
| 36 | #include <sound/tea575x-tuner.h> |
| 37 | |
| 38 | /* |
| 39 | * Version Information |
| 40 | */ |
| 41 | MODULE_AUTHOR("Hans de Goede <hdegoede@redhat.com>"); |
| 42 | MODULE_DESCRIPTION("Griffin radioSHARK, USB radio receiver driver"); |
| 43 | MODULE_LICENSE("GPL"); |
| 44 | |
| 45 | #define SHARK_IN_EP 0x83 |
| 46 | #define SHARK_OUT_EP 0x05 |
| 47 | |
| 48 | #define TEA575X_BIT_MONO (1<<22) /* 0 = stereo, 1 = mono */ |
| 49 | #define TEA575X_BIT_BAND_MASK (3<<20) |
| 50 | #define TEA575X_BIT_BAND_FM (0<<20) |
| 51 | |
| 52 | #define TB_LEN 6 |
| 53 | #define DRV_NAME "radioshark" |
| 54 | |
| 55 | #define v4l2_dev_to_shark(d) container_of(d, struct shark_device, v4l2_dev) |
| 56 | |
| 57 | enum { BLUE_LED, BLUE_PULSE_LED, RED_LED, NO_LEDS }; |
| 58 | |
| 59 | static void shark_led_set_blue(struct led_classdev *led_cdev, |
| 60 | enum led_brightness value); |
| 61 | static void shark_led_set_blue_pulse(struct led_classdev *led_cdev, |
| 62 | enum led_brightness value); |
| 63 | static void shark_led_set_red(struct led_classdev *led_cdev, |
| 64 | enum led_brightness value); |
| 65 | |
| 66 | static const struct led_classdev shark_led_templates[NO_LEDS] = { |
| 67 | [BLUE_LED] = { |
| 68 | .name = "%s:blue:", |
| 69 | .brightness = LED_OFF, |
| 70 | .max_brightness = 127, |
| 71 | .brightness_set = shark_led_set_blue, |
| 72 | }, |
| 73 | [BLUE_PULSE_LED] = { |
| 74 | .name = "%s:blue-pulse:", |
| 75 | .brightness = LED_OFF, |
| 76 | .max_brightness = 255, |
| 77 | .brightness_set = shark_led_set_blue_pulse, |
| 78 | }, |
| 79 | [RED_LED] = { |
| 80 | .name = "%s:red:", |
| 81 | .brightness = LED_OFF, |
| 82 | .max_brightness = 1, |
| 83 | .brightness_set = shark_led_set_red, |
| 84 | }, |
| 85 | }; |
| 86 | |
| 87 | struct shark_device { |
| 88 | struct usb_device *usbdev; |
| 89 | struct v4l2_device v4l2_dev; |
| 90 | struct snd_tea575x tea; |
| 91 | |
| 92 | struct work_struct led_work; |
| 93 | struct led_classdev leds[NO_LEDS]; |
| 94 | char led_names[NO_LEDS][32]; |
| 95 | atomic_t brightness[NO_LEDS]; |
| 96 | unsigned long brightness_new; |
| 97 | |
| 98 | u8 *transfer_buffer; |
| 99 | u32 last_val; |
| 100 | }; |
| 101 | |
| 102 | static atomic_t shark_instance = ATOMIC_INIT(0); |
| 103 | |
| 104 | static void shark_write_val(struct snd_tea575x *tea, u32 val) |
| 105 | { |
| 106 | struct shark_device *shark = tea->private_data; |
| 107 | int i, res, actual_len; |
| 108 | |
| 109 | /* Avoid unnecessary (slow) USB transfers */ |
| 110 | if (shark->last_val == val) |
| 111 | return; |
| 112 | |
| 113 | memset(shark->transfer_buffer, 0, TB_LEN); |
| 114 | shark->transfer_buffer[0] = 0xc0; /* Write shift register command */ |
| 115 | for (i = 0; i < 4; i++) |
| 116 | shark->transfer_buffer[i] |= (val >> (24 - i * 8)) & 0xff; |
| 117 | |
| 118 | res = usb_interrupt_msg(shark->usbdev, |
| 119 | usb_sndintpipe(shark->usbdev, SHARK_OUT_EP), |
| 120 | shark->transfer_buffer, TB_LEN, |
| 121 | &actual_len, 1000); |
| 122 | if (res >= 0) |
| 123 | shark->last_val = val; |
| 124 | else |
| 125 | v4l2_err(&shark->v4l2_dev, "set-freq error: %d\n", res); |
| 126 | } |
| 127 | |
| 128 | static u32 shark_read_val(struct snd_tea575x *tea) |
| 129 | { |
| 130 | struct shark_device *shark = tea->private_data; |
| 131 | int i, res, actual_len; |
| 132 | u32 val = 0; |
| 133 | |
| 134 | memset(shark->transfer_buffer, 0, TB_LEN); |
| 135 | shark->transfer_buffer[0] = 0x80; |
| 136 | res = usb_interrupt_msg(shark->usbdev, |
| 137 | usb_sndintpipe(shark->usbdev, SHARK_OUT_EP), |
| 138 | shark->transfer_buffer, TB_LEN, |
| 139 | &actual_len, 1000); |
| 140 | if (res < 0) { |
| 141 | v4l2_err(&shark->v4l2_dev, "request-status error: %d\n", res); |
| 142 | return shark->last_val; |
| 143 | } |
| 144 | |
| 145 | res = usb_interrupt_msg(shark->usbdev, |
| 146 | usb_rcvintpipe(shark->usbdev, SHARK_IN_EP), |
| 147 | shark->transfer_buffer, TB_LEN, |
| 148 | &actual_len, 1000); |
| 149 | if (res < 0) { |
| 150 | v4l2_err(&shark->v4l2_dev, "get-status error: %d\n", res); |
| 151 | return shark->last_val; |
| 152 | } |
| 153 | |
| 154 | for (i = 0; i < 4; i++) |
| 155 | val |= shark->transfer_buffer[i] << (24 - i * 8); |
| 156 | |
| 157 | shark->last_val = val; |
| 158 | |
| 159 | /* |
| 160 | * The shark does not allow actually reading the stereo / mono pin :( |
| 161 | * So assume that when we're tuned to an FM station and mono has not |
| 162 | * been requested, that we're receiving stereo. |
| 163 | */ |
| 164 | if (((val & TEA575X_BIT_BAND_MASK) == TEA575X_BIT_BAND_FM) && |
| 165 | !(val & TEA575X_BIT_MONO)) |
| 166 | shark->tea.stereo = true; |
| 167 | else |
| 168 | shark->tea.stereo = false; |
| 169 | |
| 170 | return val; |
| 171 | } |
| 172 | |
| 173 | static struct snd_tea575x_ops shark_tea_ops = { |
| 174 | .write_val = shark_write_val, |
| 175 | .read_val = shark_read_val, |
| 176 | }; |
| 177 | |
| 178 | static void shark_led_work(struct work_struct *work) |
| 179 | { |
| 180 | struct shark_device *shark = |
| 181 | container_of(work, struct shark_device, led_work); |
| 182 | int i, res, brightness, actual_len; |
| 183 | |
Hans de Goede | 8e2ce73 | 2012-05-21 15:24:50 -0300 | [diff] [blame] | 184 | for (i = 0; i < 3; i++) { |
| 185 | if (!test_and_clear_bit(i, &shark->brightness_new)) |
| 186 | continue; |
| 187 | |
| 188 | brightness = atomic_read(&shark->brightness[i]); |
| 189 | memset(shark->transfer_buffer, 0, TB_LEN); |
| 190 | if (i != RED_LED) { |
| 191 | shark->transfer_buffer[0] = 0xA0 + i; |
| 192 | shark->transfer_buffer[1] = brightness; |
| 193 | } else |
| 194 | shark->transfer_buffer[0] = brightness ? 0xA9 : 0xA8; |
| 195 | res = usb_interrupt_msg(shark->usbdev, |
| 196 | usb_sndintpipe(shark->usbdev, 0x05), |
| 197 | shark->transfer_buffer, TB_LEN, |
| 198 | &actual_len, 1000); |
| 199 | if (res < 0) |
| 200 | v4l2_err(&shark->v4l2_dev, "set LED %s error: %d\n", |
| 201 | shark->led_names[i], res); |
| 202 | } |
Hans de Goede | 8e2ce73 | 2012-05-21 15:24:50 -0300 | [diff] [blame] | 203 | } |
| 204 | |
| 205 | static void shark_led_set_blue(struct led_classdev *led_cdev, |
| 206 | enum led_brightness value) |
| 207 | { |
| 208 | struct shark_device *shark = |
| 209 | container_of(led_cdev, struct shark_device, leds[BLUE_LED]); |
| 210 | |
| 211 | atomic_set(&shark->brightness[BLUE_LED], value); |
| 212 | set_bit(BLUE_LED, &shark->brightness_new); |
| 213 | schedule_work(&shark->led_work); |
| 214 | } |
| 215 | |
| 216 | static void shark_led_set_blue_pulse(struct led_classdev *led_cdev, |
| 217 | enum led_brightness value) |
| 218 | { |
| 219 | struct shark_device *shark = container_of(led_cdev, |
| 220 | struct shark_device, leds[BLUE_PULSE_LED]); |
| 221 | |
| 222 | atomic_set(&shark->brightness[BLUE_PULSE_LED], 256 - value); |
| 223 | set_bit(BLUE_PULSE_LED, &shark->brightness_new); |
| 224 | schedule_work(&shark->led_work); |
| 225 | } |
| 226 | |
| 227 | static void shark_led_set_red(struct led_classdev *led_cdev, |
| 228 | enum led_brightness value) |
| 229 | { |
| 230 | struct shark_device *shark = |
| 231 | container_of(led_cdev, struct shark_device, leds[RED_LED]); |
| 232 | |
| 233 | atomic_set(&shark->brightness[RED_LED], value); |
| 234 | set_bit(RED_LED, &shark->brightness_new); |
| 235 | schedule_work(&shark->led_work); |
| 236 | } |
| 237 | |
| 238 | static void usb_shark_disconnect(struct usb_interface *intf) |
| 239 | { |
| 240 | struct v4l2_device *v4l2_dev = usb_get_intfdata(intf); |
| 241 | struct shark_device *shark = v4l2_dev_to_shark(v4l2_dev); |
| 242 | int i; |
| 243 | |
| 244 | mutex_lock(&shark->tea.mutex); |
| 245 | v4l2_device_disconnect(&shark->v4l2_dev); |
| 246 | snd_tea575x_exit(&shark->tea); |
| 247 | mutex_unlock(&shark->tea.mutex); |
| 248 | |
| 249 | for (i = 0; i < NO_LEDS; i++) |
| 250 | led_classdev_unregister(&shark->leds[i]); |
| 251 | |
Hans de Goede | cfc1b2a | 2012-08-11 06:34:53 -0300 | [diff] [blame^] | 252 | cancel_work_sync(&shark->led_work); |
| 253 | |
Hans de Goede | 8e2ce73 | 2012-05-21 15:24:50 -0300 | [diff] [blame] | 254 | v4l2_device_put(&shark->v4l2_dev); |
| 255 | } |
| 256 | |
| 257 | static void usb_shark_release(struct v4l2_device *v4l2_dev) |
| 258 | { |
| 259 | struct shark_device *shark = v4l2_dev_to_shark(v4l2_dev); |
| 260 | |
Hans de Goede | 8e2ce73 | 2012-05-21 15:24:50 -0300 | [diff] [blame] | 261 | v4l2_device_unregister(&shark->v4l2_dev); |
| 262 | kfree(shark->transfer_buffer); |
| 263 | kfree(shark); |
| 264 | } |
| 265 | |
| 266 | static int usb_shark_probe(struct usb_interface *intf, |
| 267 | const struct usb_device_id *id) |
| 268 | { |
| 269 | struct shark_device *shark; |
| 270 | int i, retval = -ENOMEM; |
| 271 | |
| 272 | shark = kzalloc(sizeof(struct shark_device), GFP_KERNEL); |
| 273 | if (!shark) |
| 274 | return retval; |
| 275 | |
| 276 | shark->transfer_buffer = kmalloc(TB_LEN, GFP_KERNEL); |
| 277 | if (!shark->transfer_buffer) |
| 278 | goto err_alloc_buffer; |
| 279 | |
Hans de Goede | 8e2ce73 | 2012-05-21 15:24:50 -0300 | [diff] [blame] | 280 | shark->v4l2_dev.release = usb_shark_release; |
| 281 | v4l2_device_set_name(&shark->v4l2_dev, DRV_NAME, &shark_instance); |
| 282 | retval = v4l2_device_register(&intf->dev, &shark->v4l2_dev); |
| 283 | if (retval) { |
| 284 | v4l2_err(&shark->v4l2_dev, "couldn't register v4l2_device\n"); |
| 285 | goto err_reg_dev; |
| 286 | } |
| 287 | |
| 288 | shark->usbdev = interface_to_usbdev(intf); |
| 289 | shark->tea.v4l2_dev = &shark->v4l2_dev; |
| 290 | shark->tea.private_data = shark; |
| 291 | shark->tea.radio_nr = -1; |
| 292 | shark->tea.ops = &shark_tea_ops; |
| 293 | shark->tea.cannot_mute = true; |
| 294 | strlcpy(shark->tea.card, "Griffin radioSHARK", |
| 295 | sizeof(shark->tea.card)); |
| 296 | usb_make_path(shark->usbdev, shark->tea.bus_info, |
| 297 | sizeof(shark->tea.bus_info)); |
| 298 | |
| 299 | retval = snd_tea575x_init(&shark->tea, THIS_MODULE); |
| 300 | if (retval) { |
| 301 | v4l2_err(&shark->v4l2_dev, "couldn't init tea5757\n"); |
| 302 | goto err_init_tea; |
| 303 | } |
| 304 | |
| 305 | INIT_WORK(&shark->led_work, shark_led_work); |
| 306 | for (i = 0; i < NO_LEDS; i++) { |
| 307 | shark->leds[i] = shark_led_templates[i]; |
| 308 | snprintf(shark->led_names[i], sizeof(shark->led_names[0]), |
| 309 | shark->leds[i].name, shark->v4l2_dev.name); |
| 310 | shark->leds[i].name = shark->led_names[i]; |
| 311 | /* |
| 312 | * We don't fail the probe if we fail to register the leds, |
| 313 | * because once we've called snd_tea575x_init, the /dev/radio0 |
| 314 | * node may be opened from userspace holding a reference to us! |
| 315 | * |
| 316 | * Note we cannot register the leds first instead as |
| 317 | * shark_led_work depends on the v4l2 mutex and registered bit. |
| 318 | */ |
| 319 | retval = led_classdev_register(&intf->dev, &shark->leds[i]); |
| 320 | if (retval) |
| 321 | v4l2_err(&shark->v4l2_dev, |
| 322 | "couldn't register led: %s\n", |
| 323 | shark->led_names[i]); |
| 324 | } |
| 325 | |
| 326 | return 0; |
| 327 | |
| 328 | err_init_tea: |
| 329 | v4l2_device_unregister(&shark->v4l2_dev); |
| 330 | err_reg_dev: |
| 331 | kfree(shark->transfer_buffer); |
| 332 | err_alloc_buffer: |
| 333 | kfree(shark); |
| 334 | |
| 335 | return retval; |
| 336 | } |
| 337 | |
| 338 | /* Specify the bcdDevice value, as the radioSHARK and radioSHARK2 share ids */ |
| 339 | static struct usb_device_id usb_shark_device_table[] = { |
| 340 | { .match_flags = USB_DEVICE_ID_MATCH_DEVICE_AND_VERSION | |
| 341 | USB_DEVICE_ID_MATCH_INT_CLASS, |
| 342 | .idVendor = 0x077d, |
| 343 | .idProduct = 0x627a, |
| 344 | .bcdDevice_lo = 0x0001, |
| 345 | .bcdDevice_hi = 0x0001, |
| 346 | .bInterfaceClass = 3, |
| 347 | }, |
| 348 | { } |
| 349 | }; |
| 350 | MODULE_DEVICE_TABLE(usb, usb_shark_device_table); |
| 351 | |
| 352 | static struct usb_driver usb_shark_driver = { |
| 353 | .name = DRV_NAME, |
| 354 | .probe = usb_shark_probe, |
| 355 | .disconnect = usb_shark_disconnect, |
| 356 | .id_table = usb_shark_device_table, |
| 357 | }; |
| 358 | module_usb_driver(usb_shark_driver); |