blob: 4d41857946de0387e5505286c1a32b7dbdc802c7 [file] [log] [blame]
Thomas Gleixnerc942fdd2019-05-27 08:55:06 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Hans Verkuil1bf20c32012-02-02 08:44:40 -03002/*
3 * Copyright (c) 2012 Hans Verkuil <hverkuil@xs4all.nl>
Hans Verkuil1bf20c32012-02-02 08:44:40 -03004 */
5
6/* kernel includes */
7#include <linux/kernel.h>
8#include <linux/module.h>
9#include <linux/init.h>
10#include <linux/slab.h>
11#include <linux/input.h>
12#include <linux/videodev2.h>
13#include <media/v4l2-device.h>
14#include <media/v4l2-ioctl.h>
15#include <media/v4l2-ctrls.h>
16#include <media/v4l2-event.h>
17#include <linux/usb.h>
Hans Verkuil1bf20c32012-02-02 08:44:40 -030018#include <linux/mutex.h>
19
20/* driver and module definitions */
21MODULE_AUTHOR("Hans Verkuil <hverkuil@xs4all.nl>");
22MODULE_DESCRIPTION("Keene FM Transmitter driver");
23MODULE_LICENSE("GPL");
24
25/* Actually, it advertises itself as a Logitech */
26#define USB_KEENE_VENDOR 0x046d
27#define USB_KEENE_PRODUCT 0x0a0e
28
29/* Probably USB_TIMEOUT should be modified in module parameter */
30#define BUFFER_LENGTH 8
31#define USB_TIMEOUT 500
32
33/* Frequency limits in MHz */
34#define FREQ_MIN 76U
35#define FREQ_MAX 108U
36#define FREQ_MUL 16000U
37
38/* USB Device ID List */
Arvind Yadav1ab22342017-08-13 04:54:45 -040039static const struct usb_device_id usb_keene_device_table[] = {
Hans Verkuil1bf20c32012-02-02 08:44:40 -030040 {USB_DEVICE_AND_INTERFACE_INFO(USB_KEENE_VENDOR, USB_KEENE_PRODUCT,
41 USB_CLASS_HID, 0, 0) },
42 { } /* Terminating entry */
43};
44
45MODULE_DEVICE_TABLE(usb, usb_keene_device_table);
46
47struct keene_device {
48 struct usb_device *usbdev;
49 struct usb_interface *intf;
50 struct video_device vdev;
51 struct v4l2_device v4l2_dev;
52 struct v4l2_ctrl_handler hdl;
53 struct mutex lock;
54
55 u8 *buffer;
56 unsigned curfreq;
57 u8 tx;
58 u8 pa;
59 bool stereo;
60 bool muted;
61 bool preemph_75_us;
62};
63
64static inline struct keene_device *to_keene_dev(struct v4l2_device *v4l2_dev)
65{
66 return container_of(v4l2_dev, struct keene_device, v4l2_dev);
67}
68
69/* Set frequency (if non-0), PA, mute and turn on/off the FM transmitter. */
70static int keene_cmd_main(struct keene_device *radio, unsigned freq, bool play)
71{
72 unsigned short freq_send = freq ? (freq - 76 * 16000) / 800 : 0;
73 int ret;
74
75 radio->buffer[0] = 0x00;
76 radio->buffer[1] = 0x50;
77 radio->buffer[2] = (freq_send >> 8) & 0xff;
78 radio->buffer[3] = freq_send & 0xff;
79 radio->buffer[4] = radio->pa;
80 /* If bit 4 is set, then tune to the frequency.
81 If bit 3 is set, then unmute; if bit 2 is set, then mute.
82 If bit 1 is set, then enter idle mode; if bit 0 is set,
Hans Verkuil542d30f2013-06-02 19:41:45 -030083 then enter transmit mode.
Hans Verkuil1bf20c32012-02-02 08:44:40 -030084 */
85 radio->buffer[5] = (radio->muted ? 4 : 8) | (play ? 1 : 2) |
86 (freq ? 0x10 : 0);
87 radio->buffer[6] = 0x00;
88 radio->buffer[7] = 0x00;
89
90 ret = usb_control_msg(radio->usbdev, usb_sndctrlpipe(radio->usbdev, 0),
91 9, 0x21, 0x200, 2, radio->buffer, BUFFER_LENGTH, USB_TIMEOUT);
92
93 if (ret < 0) {
94 dev_warn(&radio->vdev.dev, "%s failed (%d)\n", __func__, ret);
95 return ret;
96 }
97 if (freq)
98 radio->curfreq = freq;
99 return 0;
100}
101
102/* Set TX, stereo and preemphasis mode (50 us vs 75 us). */
103static int keene_cmd_set(struct keene_device *radio)
104{
105 int ret;
106
107 radio->buffer[0] = 0x00;
108 radio->buffer[1] = 0x51;
109 radio->buffer[2] = radio->tx;
110 /* If bit 0 is set, then transmit mono, otherwise stereo.
111 If bit 2 is set, then enable 75 us preemphasis, otherwise
112 it is 50 us. */
Hans Verkuil437eb182013-10-04 11:01:47 -0300113 radio->buffer[3] = (radio->stereo ? 0 : 1) | (radio->preemph_75_us ? 4 : 0);
Hans Verkuil1bf20c32012-02-02 08:44:40 -0300114 radio->buffer[4] = 0x00;
115 radio->buffer[5] = 0x00;
116 radio->buffer[6] = 0x00;
117 radio->buffer[7] = 0x00;
118
119 ret = usb_control_msg(radio->usbdev, usb_sndctrlpipe(radio->usbdev, 0),
120 9, 0x21, 0x200, 2, radio->buffer, BUFFER_LENGTH, USB_TIMEOUT);
121
122 if (ret < 0) {
123 dev_warn(&radio->vdev.dev, "%s failed (%d)\n", __func__, ret);
124 return ret;
125 }
126 return 0;
127}
128
129/* Handle unplugging the device.
130 * We call video_unregister_device in any case.
131 * The last function called in this procedure is
132 * usb_keene_device_release.
133 */
134static void usb_keene_disconnect(struct usb_interface *intf)
135{
136 struct keene_device *radio = to_keene_dev(usb_get_intfdata(intf));
137
Hans Verkuil1bf20c32012-02-02 08:44:40 -0300138 mutex_lock(&radio->lock);
139 usb_set_intfdata(intf, NULL);
140 video_unregister_device(&radio->vdev);
141 v4l2_device_disconnect(&radio->v4l2_dev);
142 mutex_unlock(&radio->lock);
143 v4l2_device_put(&radio->v4l2_dev);
144}
145
Hans Verkuilff27cda2012-04-18 06:47:02 -0300146static int usb_keene_suspend(struct usb_interface *intf, pm_message_t message)
147{
148 struct keene_device *radio = to_keene_dev(usb_get_intfdata(intf));
149
150 return keene_cmd_main(radio, 0, false);
151}
152
153static int usb_keene_resume(struct usb_interface *intf)
154{
155 struct keene_device *radio = to_keene_dev(usb_get_intfdata(intf));
156
157 mdelay(50);
158 keene_cmd_set(radio);
159 keene_cmd_main(radio, radio->curfreq, true);
160 return 0;
161}
162
Hans Verkuil1bf20c32012-02-02 08:44:40 -0300163static int vidioc_querycap(struct file *file, void *priv,
164 struct v4l2_capability *v)
165{
166 struct keene_device *radio = video_drvdata(file);
167
Mauro Carvalho Chehabc0decac2018-09-10 08:19:14 -0400168 strscpy(v->driver, "radio-keene", sizeof(v->driver));
169 strscpy(v->card, "Keene FM Transmitter", sizeof(v->card));
Hans Verkuil1bf20c32012-02-02 08:44:40 -0300170 usb_make_path(radio->usbdev, v->bus_info, sizeof(v->bus_info));
171 v->device_caps = V4L2_CAP_RADIO | V4L2_CAP_MODULATOR;
172 v->capabilities = v->device_caps | V4L2_CAP_DEVICE_CAPS;
173 return 0;
174}
175
176static int vidioc_g_modulator(struct file *file, void *priv,
177 struct v4l2_modulator *v)
178{
179 struct keene_device *radio = video_drvdata(file);
180
181 if (v->index > 0)
182 return -EINVAL;
183
Mauro Carvalho Chehabc0decac2018-09-10 08:19:14 -0400184 strscpy(v->name, "FM", sizeof(v->name));
Hans Verkuil1bf20c32012-02-02 08:44:40 -0300185 v->rangelow = FREQ_MIN * FREQ_MUL;
186 v->rangehigh = FREQ_MAX * FREQ_MUL;
187 v->txsubchans = radio->stereo ? V4L2_TUNER_SUB_STEREO : V4L2_TUNER_SUB_MONO;
188 v->capability = V4L2_TUNER_CAP_LOW | V4L2_TUNER_CAP_STEREO;
189 return 0;
190}
191
192static int vidioc_s_modulator(struct file *file, void *priv,
Hans Verkuil3f70e1f2012-09-04 12:08:47 -0300193 const struct v4l2_modulator *v)
Hans Verkuil1bf20c32012-02-02 08:44:40 -0300194{
195 struct keene_device *radio = video_drvdata(file);
196
197 if (v->index > 0)
198 return -EINVAL;
199
200 radio->stereo = (v->txsubchans == V4L2_TUNER_SUB_STEREO);
201 return keene_cmd_set(radio);
202}
203
204static int vidioc_s_frequency(struct file *file, void *priv,
Hans Verkuilb530a442013-03-19 04:09:26 -0300205 const struct v4l2_frequency *f)
Hans Verkuil1bf20c32012-02-02 08:44:40 -0300206{
207 struct keene_device *radio = video_drvdata(file);
Hans Verkuilb530a442013-03-19 04:09:26 -0300208 unsigned freq = f->frequency;
Hans Verkuil1bf20c32012-02-02 08:44:40 -0300209
210 if (f->tuner != 0 || f->type != V4L2_TUNER_RADIO)
211 return -EINVAL;
Hans Verkuilb530a442013-03-19 04:09:26 -0300212 freq = clamp(freq, FREQ_MIN * FREQ_MUL, FREQ_MAX * FREQ_MUL);
213 return keene_cmd_main(radio, freq, true);
Hans Verkuil1bf20c32012-02-02 08:44:40 -0300214}
215
216static int vidioc_g_frequency(struct file *file, void *priv,
217 struct v4l2_frequency *f)
218{
219 struct keene_device *radio = video_drvdata(file);
220
221 if (f->tuner != 0)
222 return -EINVAL;
223 f->type = V4L2_TUNER_RADIO;
224 f->frequency = radio->curfreq;
225 return 0;
226}
227
228static int keene_s_ctrl(struct v4l2_ctrl *ctrl)
229{
230 static const u8 db2tx[] = {
231 /* -15, -12, -9, -6, -3, 0 dB */
232 0x03, 0x13, 0x02, 0x12, 0x22, 0x32,
233 /* 3, 6, 9, 12, 15, 18 dB */
234 0x21, 0x31, 0x20, 0x30, 0x40, 0x50
235 };
236 struct keene_device *radio =
237 container_of(ctrl->handler, struct keene_device, hdl);
238
239 switch (ctrl->id) {
240 case V4L2_CID_AUDIO_MUTE:
241 radio->muted = ctrl->val;
242 return keene_cmd_main(radio, 0, true);
243
244 case V4L2_CID_TUNE_POWER_LEVEL:
245 /* To go from dBuV to the register value we apply the
246 following formula: */
247 radio->pa = (ctrl->val - 71) * 100 / 62;
248 return keene_cmd_main(radio, 0, true);
249
250 case V4L2_CID_TUNE_PREEMPHASIS:
251 radio->preemph_75_us = ctrl->val == V4L2_PREEMPHASIS_75_uS;
252 return keene_cmd_set(radio);
253
254 case V4L2_CID_AUDIO_COMPRESSION_GAIN:
Hans Verkuil0d5e8c42014-07-17 12:31:23 -0300255 radio->tx = db2tx[(ctrl->val - (s32)ctrl->minimum) / (s32)ctrl->step];
Hans Verkuil1bf20c32012-02-02 08:44:40 -0300256 return keene_cmd_set(radio);
257 }
258 return -EINVAL;
259}
260
Hans Verkuil1bf20c32012-02-02 08:44:40 -0300261/* File system interface */
262static const struct v4l2_file_operations usb_keene_fops = {
263 .owner = THIS_MODULE,
264 .open = v4l2_fh_open,
265 .release = v4l2_fh_release,
266 .poll = v4l2_ctrl_poll,
267 .unlocked_ioctl = video_ioctl2,
268};
269
270static const struct v4l2_ctrl_ops keene_ctrl_ops = {
271 .s_ctrl = keene_s_ctrl,
272};
273
274static const struct v4l2_ioctl_ops usb_keene_ioctl_ops = {
275 .vidioc_querycap = vidioc_querycap,
276 .vidioc_g_modulator = vidioc_g_modulator,
277 .vidioc_s_modulator = vidioc_s_modulator,
278 .vidioc_g_frequency = vidioc_g_frequency,
279 .vidioc_s_frequency = vidioc_s_frequency,
280 .vidioc_log_status = v4l2_ctrl_log_status,
Hans de Goedea22d85f2012-04-08 12:59:45 -0300281 .vidioc_subscribe_event = v4l2_ctrl_subscribe_event,
Hans Verkuil1bf20c32012-02-02 08:44:40 -0300282 .vidioc_unsubscribe_event = v4l2_event_unsubscribe,
283};
284
285static void usb_keene_video_device_release(struct v4l2_device *v4l2_dev)
286{
287 struct keene_device *radio = to_keene_dev(v4l2_dev);
288
289 /* free rest memory */
290 v4l2_ctrl_handler_free(&radio->hdl);
291 kfree(radio->buffer);
292 kfree(radio);
293}
294
295/* check if the device is present and register with v4l and usb if it is */
296static int usb_keene_probe(struct usb_interface *intf,
297 const struct usb_device_id *id)
298{
299 struct usb_device *dev = interface_to_usbdev(intf);
300 struct keene_device *radio;
301 struct v4l2_ctrl_handler *hdl;
302 int retval = 0;
303
304 /*
305 * The Keene FM transmitter USB device has the same USB ID as
306 * the Logitech AudioHub Speaker, but it should ignore the hid.
307 * Check if the name is that of the Keene device.
308 * If not, then someone connected the AudioHub and we shouldn't
309 * attempt to handle this driver.
310 * For reference: the product name of the AudioHub is
311 * "AudioHub Speaker".
312 */
313 if (dev->product && strcmp(dev->product, "B-LINK USB Audio "))
314 return -ENODEV;
315
316 radio = kzalloc(sizeof(struct keene_device), GFP_KERNEL);
317 if (radio)
318 radio->buffer = kmalloc(BUFFER_LENGTH, GFP_KERNEL);
319
320 if (!radio || !radio->buffer) {
321 dev_err(&intf->dev, "kmalloc for keene_device failed\n");
322 kfree(radio);
323 retval = -ENOMEM;
324 goto err;
325 }
326
327 hdl = &radio->hdl;
328 v4l2_ctrl_handler_init(hdl, 4);
329 v4l2_ctrl_new_std(hdl, &keene_ctrl_ops, V4L2_CID_AUDIO_MUTE,
330 0, 1, 1, 0);
331 v4l2_ctrl_new_std_menu(hdl, &keene_ctrl_ops, V4L2_CID_TUNE_PREEMPHASIS,
332 V4L2_PREEMPHASIS_75_uS, 1, V4L2_PREEMPHASIS_50_uS);
333 v4l2_ctrl_new_std(hdl, &keene_ctrl_ops, V4L2_CID_TUNE_POWER_LEVEL,
334 84, 118, 1, 118);
335 v4l2_ctrl_new_std(hdl, &keene_ctrl_ops, V4L2_CID_AUDIO_COMPRESSION_GAIN,
336 -15, 18, 3, 0);
337 radio->pa = 118;
338 radio->tx = 0x32;
339 radio->stereo = true;
Hans Verkuil1bf20c32012-02-02 08:44:40 -0300340 if (hdl->error) {
341 retval = hdl->error;
342
343 v4l2_ctrl_handler_free(hdl);
344 goto err_v4l2;
345 }
346 retval = v4l2_device_register(&intf->dev, &radio->v4l2_dev);
347 if (retval < 0) {
348 dev_err(&intf->dev, "couldn't register v4l2_device\n");
349 goto err_v4l2;
350 }
351
352 mutex_init(&radio->lock);
353
354 radio->v4l2_dev.ctrl_handler = hdl;
355 radio->v4l2_dev.release = usb_keene_video_device_release;
Mauro Carvalho Chehabc0decac2018-09-10 08:19:14 -0400356 strscpy(radio->vdev.name, radio->v4l2_dev.name,
Hans Verkuil1bf20c32012-02-02 08:44:40 -0300357 sizeof(radio->vdev.name));
358 radio->vdev.v4l2_dev = &radio->v4l2_dev;
359 radio->vdev.fops = &usb_keene_fops;
360 radio->vdev.ioctl_ops = &usb_keene_ioctl_ops;
361 radio->vdev.lock = &radio->lock;
362 radio->vdev.release = video_device_release_empty;
Hans Verkuilce4a3d52013-01-05 08:52:12 -0300363 radio->vdev.vfl_dir = VFL_DIR_TX;
Hans Verkuil1bf20c32012-02-02 08:44:40 -0300364
365 radio->usbdev = interface_to_usbdev(intf);
366 radio->intf = intf;
367 usb_set_intfdata(intf, &radio->v4l2_dev);
368
369 video_set_drvdata(&radio->vdev, radio);
Hans Verkuil1bf20c32012-02-02 08:44:40 -0300370
Antti Palosaari4b9a4a62013-06-02 19:41:46 -0300371 /* at least 11ms is needed in order to settle hardware */
372 msleep(20);
Hans Verkuil542d30f2013-06-02 19:41:45 -0300373 keene_cmd_main(radio, 95.16 * FREQ_MUL, false);
374
Hans Verkuil1bf20c32012-02-02 08:44:40 -0300375 retval = video_register_device(&radio->vdev, VFL_TYPE_RADIO, -1);
376 if (retval < 0) {
377 dev_err(&intf->dev, "could not register video device\n");
378 goto err_vdev;
379 }
380 v4l2_ctrl_handler_setup(hdl);
381 dev_info(&intf->dev, "V4L2 device registered as %s\n",
382 video_device_node_name(&radio->vdev));
383 return 0;
384
385err_vdev:
386 v4l2_device_unregister(&radio->v4l2_dev);
387err_v4l2:
388 kfree(radio->buffer);
389 kfree(radio);
390err:
391 return retval;
392}
393
394/* USB subsystem interface */
395static struct usb_driver usb_keene_driver = {
396 .name = "radio-keene",
397 .probe = usb_keene_probe,
398 .disconnect = usb_keene_disconnect,
399 .id_table = usb_keene_device_table,
Hans Verkuilff27cda2012-04-18 06:47:02 -0300400 .suspend = usb_keene_suspend,
401 .resume = usb_keene_resume,
402 .reset_resume = usb_keene_resume,
Hans Verkuil1bf20c32012-02-02 08:44:40 -0300403};
404
Sachin Kamat2d27b372014-01-27 08:56:02 -0300405module_usb_driver(usb_keene_driver);
Hans Verkuil1bf20c32012-02-02 08:44:40 -0300406