Version:  2.0.40 2.2.26 2.4.37 3.0 3.1 3.2 3.3 3.4 3.5 3.6 3.7 3.8 3.9 3.10 3.11 3.12 3.13 3.14 3.15 3.16

Linux/drivers/hid/hid-prodikeys.c

  1 /*
  2  *  HID driver for the Prodikeys PC-MIDI Keyboard
  3  *  providing midi & extra multimedia keys functionality
  4  *
  5  *  Copyright (c) 2009 Don Prince <dhprince.devel@yahoo.co.uk>
  6  *
  7  *  Controls for Octave Shift Up/Down, Channel, and
  8  *  Sustain Duration available via sysfs.
  9  *
 10  */
 11 
 12 /*
 13  * This program is free software; you can redistribute it and/or modify it
 14  * under the terms of the GNU General Public License as published by the Free
 15  * Software Foundation; either version 2 of the License, or (at your option)
 16  * any later version.
 17  */
 18 
 19 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
 20 
 21 #include <linux/device.h>
 22 #include <linux/module.h>
 23 #include <linux/usb.h>
 24 #include <linux/mutex.h>
 25 #include <linux/hid.h>
 26 #include <sound/core.h>
 27 #include <sound/initval.h>
 28 #include <sound/rawmidi.h>
 29 #include "hid-ids.h"
 30 
 31 
 32 #define pk_debug(format, arg...) \
 33         pr_debug("hid-prodikeys: " format "\n" , ## arg)
 34 #define pk_error(format, arg...) \
 35         pr_err("hid-prodikeys: " format "\n" , ## arg)
 36 
 37 struct pcmidi_snd;
 38 
 39 struct pk_device {
 40         unsigned long           quirks;
 41 
 42         struct hid_device       *hdev;
 43         struct pcmidi_snd       *pm; /* pcmidi device context */
 44 };
 45 
 46 struct pcmidi_sustain {
 47         unsigned long           in_use;
 48         struct pcmidi_snd       *pm;
 49         struct timer_list       timer;
 50         unsigned char           status;
 51         unsigned char           note;
 52         unsigned char           velocity;
 53 };
 54 
 55 #define PCMIDI_SUSTAINED_MAX    32
 56 struct pcmidi_snd {
 57         struct pk_device                *pk;
 58         unsigned short                  ifnum;
 59         struct hid_report               *pcmidi_report6;
 60         struct input_dev                *input_ep82;
 61         unsigned short                  midi_mode;
 62         unsigned short                  midi_sustain_mode;
 63         unsigned short                  midi_sustain;
 64         unsigned short                  midi_channel;
 65         short                           midi_octave;
 66         struct pcmidi_sustain           sustained_notes[PCMIDI_SUSTAINED_MAX];
 67         unsigned short                  fn_state;
 68         unsigned short                  last_key[24];
 69         spinlock_t                      rawmidi_in_lock;
 70         struct snd_card                 *card;
 71         struct snd_rawmidi              *rwmidi;
 72         struct snd_rawmidi_substream    *in_substream;
 73         struct snd_rawmidi_substream    *out_substream;
 74         unsigned long                   in_triggered;
 75         unsigned long                   out_active;
 76 };
 77 
 78 #define PK_QUIRK_NOGET  0x00010000
 79 #define PCMIDI_MIDDLE_C 60
 80 #define PCMIDI_CHANNEL_MIN 0
 81 #define PCMIDI_CHANNEL_MAX 15
 82 #define PCMIDI_OCTAVE_MIN (-2)
 83 #define PCMIDI_OCTAVE_MAX 2
 84 #define PCMIDI_SUSTAIN_MIN 0
 85 #define PCMIDI_SUSTAIN_MAX 5000
 86 
 87 static const char shortname[] = "PC-MIDI";
 88 static const char longname[] = "Prodikeys PC-MIDI Keyboard";
 89 
 90 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
 91 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;
 92 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;
 93 
 94 module_param_array(index, int, NULL, 0444);
 95 module_param_array(id, charp, NULL, 0444);
 96 module_param_array(enable, bool, NULL, 0444);
 97 MODULE_PARM_DESC(index, "Index value for the PC-MIDI virtual audio driver");
 98 MODULE_PARM_DESC(id, "ID string for the PC-MIDI virtual audio driver");
 99 MODULE_PARM_DESC(enable, "Enable for the PC-MIDI virtual audio driver");
100 
101 
102 /* Output routine for the sysfs channel file */
103 static ssize_t show_channel(struct device *dev,
104         struct device_attribute *attr, char *buf)
105 {
106         struct hid_device *hdev = container_of(dev, struct hid_device, dev);
107         struct pk_device *pk = hid_get_drvdata(hdev);
108 
109         dbg_hid("pcmidi sysfs read channel=%u\n", pk->pm->midi_channel);
110 
111         return sprintf(buf, "%u (min:%u, max:%u)\n", pk->pm->midi_channel,
112                 PCMIDI_CHANNEL_MIN, PCMIDI_CHANNEL_MAX);
113 }
114 
115 /* Input routine for the sysfs channel file */
116 static ssize_t store_channel(struct device *dev,
117         struct device_attribute *attr, const char *buf, size_t count)
118 {
119         struct hid_device *hdev = container_of(dev, struct hid_device, dev);
120         struct pk_device *pk = hid_get_drvdata(hdev);
121 
122         unsigned channel = 0;
123 
124         if (sscanf(buf, "%u", &channel) > 0 && channel <= PCMIDI_CHANNEL_MAX) {
125                 dbg_hid("pcmidi sysfs write channel=%u\n", channel);
126                 pk->pm->midi_channel = channel;
127                 return strlen(buf);
128         }
129         return -EINVAL;
130 }
131 
132 static DEVICE_ATTR(channel, S_IRUGO | S_IWUSR | S_IWGRP , show_channel,
133                 store_channel);
134 
135 static struct device_attribute *sysfs_device_attr_channel = {
136                 &dev_attr_channel,
137                 };
138 
139 /* Output routine for the sysfs sustain file */
140 static ssize_t show_sustain(struct device *dev,
141  struct device_attribute *attr, char *buf)
142 {
143         struct hid_device *hdev = container_of(dev, struct hid_device, dev);
144         struct pk_device *pk = hid_get_drvdata(hdev);
145 
146         dbg_hid("pcmidi sysfs read sustain=%u\n", pk->pm->midi_sustain);
147 
148         return sprintf(buf, "%u (off:%u, max:%u (ms))\n", pk->pm->midi_sustain,
149                 PCMIDI_SUSTAIN_MIN, PCMIDI_SUSTAIN_MAX);
150 }
151 
152 /* Input routine for the sysfs sustain file */
153 static ssize_t store_sustain(struct device *dev,
154         struct device_attribute *attr, const char *buf, size_t count)
155 {
156         struct hid_device *hdev = container_of(dev, struct hid_device, dev);
157         struct pk_device *pk = hid_get_drvdata(hdev);
158 
159         unsigned sustain = 0;
160 
161         if (sscanf(buf, "%u", &sustain) > 0 && sustain <= PCMIDI_SUSTAIN_MAX) {
162                 dbg_hid("pcmidi sysfs write sustain=%u\n", sustain);
163                 pk->pm->midi_sustain = sustain;
164                 pk->pm->midi_sustain_mode =
165                         (0 == sustain || !pk->pm->midi_mode) ? 0 : 1;
166                 return strlen(buf);
167         }
168         return -EINVAL;
169 }
170 
171 static DEVICE_ATTR(sustain, S_IRUGO | S_IWUSR | S_IWGRP, show_sustain,
172                 store_sustain);
173 
174 static struct device_attribute *sysfs_device_attr_sustain = {
175                 &dev_attr_sustain,
176                 };
177 
178 /* Output routine for the sysfs octave file */
179 static ssize_t show_octave(struct device *dev,
180         struct device_attribute *attr, char *buf)
181 {
182         struct hid_device *hdev = container_of(dev, struct hid_device, dev);
183         struct pk_device *pk = hid_get_drvdata(hdev);
184 
185         dbg_hid("pcmidi sysfs read octave=%d\n", pk->pm->midi_octave);
186 
187         return sprintf(buf, "%d (min:%d, max:%d)\n", pk->pm->midi_octave,
188                 PCMIDI_OCTAVE_MIN, PCMIDI_OCTAVE_MAX);
189 }
190 
191 /* Input routine for the sysfs octave file */
192 static ssize_t store_octave(struct device *dev,
193         struct device_attribute *attr, const char *buf, size_t count)
194 {
195         struct hid_device *hdev = container_of(dev, struct hid_device, dev);
196         struct pk_device *pk = hid_get_drvdata(hdev);
197 
198         int octave = 0;
199 
200         if (sscanf(buf, "%d", &octave) > 0 &&
201                 octave >= PCMIDI_OCTAVE_MIN && octave <= PCMIDI_OCTAVE_MAX) {
202                 dbg_hid("pcmidi sysfs write octave=%d\n", octave);
203                 pk->pm->midi_octave = octave;
204                 return strlen(buf);
205         }
206         return -EINVAL;
207 }
208 
209 static DEVICE_ATTR(octave, S_IRUGO | S_IWUSR | S_IWGRP, show_octave,
210                 store_octave);
211 
212 static struct device_attribute *sysfs_device_attr_octave = {
213                 &dev_attr_octave,
214                 };
215 
216 
217 static void pcmidi_send_note(struct pcmidi_snd *pm,
218         unsigned char status, unsigned char note, unsigned char velocity)
219 {
220         unsigned long flags;
221         unsigned char buffer[3];
222 
223         buffer[0] = status;
224         buffer[1] = note;
225         buffer[2] = velocity;
226 
227         spin_lock_irqsave(&pm->rawmidi_in_lock, flags);
228 
229         if (!pm->in_substream)
230                 goto drop_note;
231         if (!test_bit(pm->in_substream->number, &pm->in_triggered))
232                 goto drop_note;
233 
234         snd_rawmidi_receive(pm->in_substream, buffer, 3);
235 
236 drop_note:
237         spin_unlock_irqrestore(&pm->rawmidi_in_lock, flags);
238 
239         return;
240 }
241 
242 static void pcmidi_sustained_note_release(unsigned long data)
243 {
244         struct pcmidi_sustain *pms = (struct pcmidi_sustain *)data;
245 
246         pcmidi_send_note(pms->pm, pms->status, pms->note, pms->velocity);
247         pms->in_use = 0;
248 }
249 
250 static void init_sustain_timers(struct pcmidi_snd *pm)
251 {
252         struct pcmidi_sustain *pms;
253         unsigned i;
254 
255         for (i = 0; i < PCMIDI_SUSTAINED_MAX; i++) {
256                 pms = &pm->sustained_notes[i];
257                 pms->in_use = 0;
258                 pms->pm = pm;
259                 setup_timer(&pms->timer, pcmidi_sustained_note_release,
260                         (unsigned long)pms);
261         }
262 }
263 
264 static void stop_sustain_timers(struct pcmidi_snd *pm)
265 {
266         struct pcmidi_sustain *pms;
267         unsigned i;
268 
269         for (i = 0; i < PCMIDI_SUSTAINED_MAX; i++) {
270                 pms = &pm->sustained_notes[i];
271                 pms->in_use = 1;
272                 del_timer_sync(&pms->timer);
273         }
274 }
275 
276 static int pcmidi_get_output_report(struct pcmidi_snd *pm)
277 {
278         struct hid_device *hdev = pm->pk->hdev;
279         struct hid_report *report;
280 
281         list_for_each_entry(report,
282                 &hdev->report_enum[HID_OUTPUT_REPORT].report_list, list) {
283                 if (!(6 == report->id))
284                         continue;
285 
286                 if (report->maxfield < 1) {
287                         hid_err(hdev, "output report is empty\n");
288                         break;
289                 }
290                 if (report->field[0]->report_count != 2) {
291                         hid_err(hdev, "field count too low\n");
292                         break;
293                 }
294                 pm->pcmidi_report6 = report;
295                 return 0;
296         }
297         /* should never get here */
298         return -ENODEV;
299 }
300 
301 static void pcmidi_submit_output_report(struct pcmidi_snd *pm, int state)
302 {
303         struct hid_device *hdev = pm->pk->hdev;
304         struct hid_report *report = pm->pcmidi_report6;
305         report->field[0]->value[0] = 0x01;
306         report->field[0]->value[1] = state;
307 
308         hid_hw_request(hdev, report, HID_REQ_SET_REPORT);
309 }
310 
311 static int pcmidi_handle_report1(struct pcmidi_snd *pm, u8 *data)
312 {
313         u32 bit_mask;
314 
315         bit_mask = data[1];
316         bit_mask = (bit_mask << 8) | data[2];
317         bit_mask = (bit_mask << 8) | data[3];
318 
319         dbg_hid("pcmidi mode: %d\n", pm->midi_mode);
320 
321         /*KEY_MAIL or octave down*/
322         if (pm->midi_mode && bit_mask == 0x004000) {
323                 /* octave down */
324                 pm->midi_octave--;
325                 if (pm->midi_octave < -2)
326                         pm->midi_octave = -2;
327                 dbg_hid("pcmidi mode: %d octave: %d\n",
328                         pm->midi_mode, pm->midi_octave);
329                 return 1;
330         }
331         /*KEY_WWW or sustain*/
332         else if (pm->midi_mode && bit_mask == 0x000004) {
333                 /* sustain on/off*/
334                 pm->midi_sustain_mode ^= 0x1;
335                 return 1;
336         }
337 
338         return 0; /* continue key processing */
339 }
340 
341 static int pcmidi_handle_report3(struct pcmidi_snd *pm, u8 *data, int size)
342 {
343         struct pcmidi_sustain *pms;
344         unsigned i, j;
345         unsigned char status, note, velocity;
346 
347         unsigned num_notes = (size-1)/2;
348         for (j = 0; j < num_notes; j++) {
349                 note = data[j*2+1];
350                 velocity = data[j*2+2];
351 
352                 if (note < 0x81) { /* note on */
353                         status = 128 + 16 + pm->midi_channel; /* 1001nnnn */
354                         note = note - 0x54 + PCMIDI_MIDDLE_C +
355                                 (pm->midi_octave * 12);
356                         if (0 == velocity)
357                                 velocity = 1; /* force note on */
358                 } else { /* note off */
359                         status = 128 + pm->midi_channel; /* 1000nnnn */
360                         note = note - 0x94 + PCMIDI_MIDDLE_C +
361                                 (pm->midi_octave*12);
362 
363                         if (pm->midi_sustain_mode) {
364                                 for (i = 0; i < PCMIDI_SUSTAINED_MAX; i++) {
365                                         pms = &pm->sustained_notes[i];
366                                         if (!pms->in_use) {
367                                                 pms->status = status;
368                                                 pms->note = note;
369                                                 pms->velocity = velocity;
370                                                 pms->in_use = 1;
371 
372                                                 mod_timer(&pms->timer,
373                                                         jiffies +
374                                         msecs_to_jiffies(pm->midi_sustain));
375                                                 return 1;
376                                         }
377                                 }
378                         }
379                 }
380                 pcmidi_send_note(pm, status, note, velocity);
381         }
382 
383         return 1;
384 }
385 
386 static int pcmidi_handle_report4(struct pcmidi_snd *pm, u8 *data)
387 {
388         unsigned        key;
389         u32             bit_mask;
390         u32             bit_index;
391 
392         bit_mask = data[1];
393         bit_mask = (bit_mask << 8) | data[2];
394         bit_mask = (bit_mask << 8) | data[3];
395 
396         /* break keys */
397         for (bit_index = 0; bit_index < 24; bit_index++) {
398                 key = pm->last_key[bit_index];
399                 if (!((0x01 << bit_index) & bit_mask)) {
400                         input_event(pm->input_ep82, EV_KEY,
401                                 pm->last_key[bit_index], 0);
402                                 pm->last_key[bit_index] = 0;
403                 }
404         }
405 
406         /* make keys */
407         for (bit_index = 0; bit_index < 24; bit_index++) {
408                 key = 0;
409                 switch ((0x01 << bit_index) & bit_mask) {
410                 case 0x000010: /* Fn lock*/
411                         pm->fn_state ^= 0x000010;
412                         if (pm->fn_state)
413                                 pcmidi_submit_output_report(pm, 0xc5);
414                         else
415                                 pcmidi_submit_output_report(pm, 0xc6);
416                         continue;
417                 case 0x020000: /* midi launcher..send a key (qwerty) or not? */
418                         pcmidi_submit_output_report(pm, 0xc1);
419                         pm->midi_mode ^= 0x01;
420 
421                         dbg_hid("pcmidi mode: %d\n", pm->midi_mode);
422                         continue;
423                 case 0x100000: /* KEY_MESSENGER or octave up */
424                         dbg_hid("pcmidi mode: %d\n", pm->midi_mode);
425                         if (pm->midi_mode) {
426                                 pm->midi_octave++;
427                                 if (pm->midi_octave > 2)
428                                         pm->midi_octave = 2;
429                                 dbg_hid("pcmidi mode: %d octave: %d\n",
430                                         pm->midi_mode, pm->midi_octave);
431                             continue;
432                         } else
433                                 key = KEY_MESSENGER;
434                         break;
435                 case 0x400000:
436                         key = KEY_CALENDAR;
437                         break;
438                 case 0x080000:
439                         key = KEY_ADDRESSBOOK;
440                         break;
441                 case 0x040000:
442                         key = KEY_DOCUMENTS;
443                         break;
444                 case 0x800000:
445                         key = KEY_WORDPROCESSOR;
446                         break;
447                 case 0x200000:
448                         key = KEY_SPREADSHEET;
449                         break;
450                 case 0x010000:
451                         key = KEY_COFFEE;
452                         break;
453                 case 0x000100:
454                         key = KEY_HELP;
455                         break;
456                 case 0x000200:
457                         key = KEY_SEND;
458                         break;
459                 case 0x000400:
460                         key = KEY_REPLY;
461                         break;
462                 case 0x000800:
463                         key = KEY_FORWARDMAIL;
464                         break;
465                 case 0x001000:
466                         key = KEY_NEW;
467                         break;
468                 case 0x002000:
469                         key = KEY_OPEN;
470                         break;
471                 case 0x004000:
472                         key = KEY_CLOSE;
473                         break;
474                 case 0x008000:
475                         key = KEY_SAVE;
476                         break;
477                 case 0x000001:
478                         key = KEY_UNDO;
479                         break;
480                 case 0x000002:
481                         key = KEY_REDO;
482                         break;
483                 case 0x000004:
484                         key = KEY_SPELLCHECK;
485                         break;
486                 case 0x000008:
487                         key = KEY_PRINT;
488                         break;
489                 }
490                 if (key) {
491                         input_event(pm->input_ep82, EV_KEY, key, 1);
492                         pm->last_key[bit_index] = key;
493                 }
494         }
495 
496         return 1;
497 }
498 
499 static int pcmidi_handle_report(
500         struct pcmidi_snd *pm, unsigned report_id, u8 *data, int size)
501 {
502         int ret = 0;
503 
504         switch (report_id) {
505         case 0x01: /* midi keys (qwerty)*/
506                 ret = pcmidi_handle_report1(pm, data);
507                 break;
508         case 0x03: /* midi keyboard (musical)*/
509                 ret = pcmidi_handle_report3(pm, data, size);
510                 break;
511         case 0x04: /* multimedia/midi keys (qwerty)*/
512                 ret = pcmidi_handle_report4(pm, data);
513                 break;
514         }
515         return ret;
516 }
517 
518 static void pcmidi_setup_extra_keys(
519         struct pcmidi_snd *pm, struct input_dev *input)
520 {
521         /* reassigned functionality for N/A keys
522                 MY PICTURES =>  KEY_WORDPROCESSOR
523                 MY MUSIC=>      KEY_SPREADSHEET
524         */
525         unsigned int keys[] = {
526                 KEY_FN,
527                 KEY_MESSENGER, KEY_CALENDAR,
528                 KEY_ADDRESSBOOK, KEY_DOCUMENTS,
529                 KEY_WORDPROCESSOR,
530                 KEY_SPREADSHEET,
531                 KEY_COFFEE,
532                 KEY_HELP, KEY_SEND,
533                 KEY_REPLY, KEY_FORWARDMAIL,
534                 KEY_NEW, KEY_OPEN,
535                 KEY_CLOSE, KEY_SAVE,
536                 KEY_UNDO, KEY_REDO,
537                 KEY_SPELLCHECK, KEY_PRINT,
538                 0
539         };
540 
541         unsigned int *pkeys = &keys[0];
542         unsigned short i;
543 
544         if (pm->ifnum != 1)  /* only set up ONCE for interace 1 */
545                 return;
546 
547         pm->input_ep82 = input;
548 
549         for (i = 0; i < 24; i++)
550                 pm->last_key[i] = 0;
551 
552         while (*pkeys != 0) {
553                 set_bit(*pkeys, pm->input_ep82->keybit);
554                 ++pkeys;
555         }
556 }
557 
558 static int pcmidi_set_operational(struct pcmidi_snd *pm)
559 {
560         if (pm->ifnum != 1)
561                 return 0; /* only set up ONCE for interace 1 */
562 
563         pcmidi_get_output_report(pm);
564         pcmidi_submit_output_report(pm, 0xc1);
565         return 0;
566 }
567 
568 static int pcmidi_snd_free(struct snd_device *dev)
569 {
570         return 0;
571 }
572 
573 static int pcmidi_in_open(struct snd_rawmidi_substream *substream)
574 {
575         struct pcmidi_snd *pm = substream->rmidi->private_data;
576 
577         dbg_hid("pcmidi in open\n");
578         pm->in_substream = substream;
579         return 0;
580 }
581 
582 static int pcmidi_in_close(struct snd_rawmidi_substream *substream)
583 {
584         dbg_hid("pcmidi in close\n");
585         return 0;
586 }
587 
588 static void pcmidi_in_trigger(struct snd_rawmidi_substream *substream, int up)
589 {
590         struct pcmidi_snd *pm = substream->rmidi->private_data;
591 
592         dbg_hid("pcmidi in trigger %d\n", up);
593 
594         pm->in_triggered = up;
595 }
596 
597 static struct snd_rawmidi_ops pcmidi_in_ops = {
598         .open = pcmidi_in_open,
599         .close = pcmidi_in_close,
600         .trigger = pcmidi_in_trigger
601 };
602 
603 static int pcmidi_snd_initialise(struct pcmidi_snd *pm)
604 {
605         static int dev;
606         struct snd_card *card;
607         struct snd_rawmidi *rwmidi;
608         int err;
609 
610         static struct snd_device_ops ops = {
611                 .dev_free = pcmidi_snd_free,
612         };
613 
614         if (pm->ifnum != 1)
615                 return 0; /* only set up midi device ONCE for interace 1 */
616 
617         if (dev >= SNDRV_CARDS)
618                 return -ENODEV;
619 
620         if (!enable[dev]) {
621                 dev++;
622                 return -ENOENT;
623         }
624 
625         /* Setup sound card */
626 
627         err = snd_card_new(&pm->pk->hdev->dev, index[dev], id[dev],
628                            THIS_MODULE, 0, &card);
629         if (err < 0) {
630                 pk_error("failed to create pc-midi sound card\n");
631                 err = -ENOMEM;
632                 goto fail;
633         }
634         pm->card = card;
635 
636         /* Setup sound device */
637         err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, pm, &ops);
638         if (err < 0) {
639                 pk_error("failed to create pc-midi sound device: error %d\n",
640                         err);
641                 goto fail;
642         }
643 
644         strncpy(card->driver, shortname, sizeof(card->driver));
645         strncpy(card->shortname, shortname, sizeof(card->shortname));
646         strncpy(card->longname, longname, sizeof(card->longname));
647 
648         /* Set up rawmidi */
649         err = snd_rawmidi_new(card, card->shortname, 0,
650                               0, 1, &rwmidi);
651         if (err < 0) {
652                 pk_error("failed to create pc-midi rawmidi device: error %d\n",
653                         err);
654                 goto fail;
655         }
656         pm->rwmidi = rwmidi;
657         strncpy(rwmidi->name, card->shortname, sizeof(rwmidi->name));
658         rwmidi->info_flags = SNDRV_RAWMIDI_INFO_INPUT;
659         rwmidi->private_data = pm;
660 
661         snd_rawmidi_set_ops(rwmidi, SNDRV_RAWMIDI_STREAM_INPUT,
662                 &pcmidi_in_ops);
663 
664         /* create sysfs variables */
665         err = device_create_file(&pm->pk->hdev->dev,
666                                  sysfs_device_attr_channel);
667         if (err < 0) {
668                 pk_error("failed to create sysfs attribute channel: error %d\n",
669                         err);
670                 goto fail;
671         }
672 
673         err = device_create_file(&pm->pk->hdev->dev,
674                                 sysfs_device_attr_sustain);
675         if (err < 0) {
676                 pk_error("failed to create sysfs attribute sustain: error %d\n",
677                         err);
678                 goto fail_attr_sustain;
679         }
680 
681         err = device_create_file(&pm->pk->hdev->dev,
682                          sysfs_device_attr_octave);
683         if (err < 0) {
684                 pk_error("failed to create sysfs attribute octave: error %d\n",
685                         err);
686                 goto fail_attr_octave;
687         }
688 
689         spin_lock_init(&pm->rawmidi_in_lock);
690 
691         init_sustain_timers(pm);
692         pcmidi_set_operational(pm);
693 
694         /* register it */
695         err = snd_card_register(card);
696         if (err < 0) {
697                 pk_error("failed to register pc-midi sound card: error %d\n",
698                          err);
699                          goto fail_register;
700         }
701 
702         dbg_hid("pcmidi_snd_initialise finished ok\n");
703         return 0;
704 
705 fail_register:
706         stop_sustain_timers(pm);
707         device_remove_file(&pm->pk->hdev->dev, sysfs_device_attr_octave);
708 fail_attr_octave:
709         device_remove_file(&pm->pk->hdev->dev, sysfs_device_attr_sustain);
710 fail_attr_sustain:
711         device_remove_file(&pm->pk->hdev->dev, sysfs_device_attr_channel);
712 fail:
713         if (pm->card) {
714                 snd_card_free(pm->card);
715                 pm->card = NULL;
716         }
717         return err;
718 }
719 
720 static int pcmidi_snd_terminate(struct pcmidi_snd *pm)
721 {
722         if (pm->card) {
723                 stop_sustain_timers(pm);
724 
725                 device_remove_file(&pm->pk->hdev->dev,
726                         sysfs_device_attr_channel);
727                 device_remove_file(&pm->pk->hdev->dev,
728                         sysfs_device_attr_sustain);
729                 device_remove_file(&pm->pk->hdev->dev,
730                         sysfs_device_attr_octave);
731 
732                 snd_card_disconnect(pm->card);
733                 snd_card_free_when_closed(pm->card);
734         }
735 
736         return 0;
737 }
738 
739 /*
740  * PC-MIDI report descriptor for report id is wrong.
741  */
742 static __u8 *pk_report_fixup(struct hid_device *hdev, __u8 *rdesc,
743                 unsigned int *rsize)
744 {
745         if (*rsize == 178 &&
746               rdesc[111] == 0x06 && rdesc[112] == 0x00 &&
747               rdesc[113] == 0xff) {
748                 hid_info(hdev,
749                          "fixing up pc-midi keyboard report descriptor\n");
750 
751                 rdesc[144] = 0x18; /* report 4: was 0x10 report count */
752         }
753         return rdesc;
754 }
755 
756 static int pk_input_mapping(struct hid_device *hdev, struct hid_input *hi,
757                 struct hid_field *field, struct hid_usage *usage,
758                 unsigned long **bit, int *max)
759 {
760         struct pk_device *pk = hid_get_drvdata(hdev);
761         struct pcmidi_snd *pm;
762 
763         pm = pk->pm;
764 
765         if (HID_UP_MSVENDOR == (usage->hid & HID_USAGE_PAGE) &&
766                 1 == pm->ifnum) {
767                 pcmidi_setup_extra_keys(pm, hi->input);
768                 return 0;
769         }
770 
771         return 0;
772 }
773 
774 
775 static int pk_raw_event(struct hid_device *hdev, struct hid_report *report,
776         u8 *data, int size)
777 {
778         struct pk_device *pk = hid_get_drvdata(hdev);
779         int ret = 0;
780 
781         if (1 == pk->pm->ifnum) {
782                 if (report->id == data[0])
783                         switch (report->id) {
784                         case 0x01: /* midi keys (qwerty)*/
785                         case 0x03: /* midi keyboard (musical)*/
786                         case 0x04: /* extra/midi keys (qwerty)*/
787                                 ret = pcmidi_handle_report(pk->pm,
788                                                 report->id, data, size);
789                                 break;
790                         }
791         }
792 
793         return ret;
794 }
795 
796 static int pk_probe(struct hid_device *hdev, const struct hid_device_id *id)
797 {
798         int ret;
799         struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
800         unsigned short ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
801         unsigned long quirks = id->driver_data;
802         struct pk_device *pk;
803         struct pcmidi_snd *pm = NULL;
804 
805         pk = kzalloc(sizeof(*pk), GFP_KERNEL);
806         if (pk == NULL) {
807                 hid_err(hdev, "can't alloc descriptor\n");
808                 return -ENOMEM;
809         }
810 
811         pk->hdev = hdev;
812 
813         pm = kzalloc(sizeof(*pm), GFP_KERNEL);
814         if (pm == NULL) {
815                 hid_err(hdev, "can't alloc descriptor\n");
816                 ret = -ENOMEM;
817                 goto err_free_pk;
818         }
819 
820         pm->pk = pk;
821         pk->pm = pm;
822         pm->ifnum = ifnum;
823 
824         hid_set_drvdata(hdev, pk);
825 
826         ret = hid_parse(hdev);
827         if (ret) {
828                 hid_err(hdev, "hid parse failed\n");
829                 goto err_free;
830         }
831 
832         if (quirks & PK_QUIRK_NOGET) { /* hid_parse cleared all the quirks */
833                 hdev->quirks |= HID_QUIRK_NOGET;
834         }
835 
836         ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
837         if (ret) {
838                 hid_err(hdev, "hw start failed\n");
839                 goto err_free;
840         }
841 
842         ret = pcmidi_snd_initialise(pm);
843         if (ret < 0)
844                 goto err_stop;
845 
846         return 0;
847 err_stop:
848         hid_hw_stop(hdev);
849 err_free:
850         kfree(pm);
851 err_free_pk:
852         kfree(pk);
853 
854         return ret;
855 }
856 
857 static void pk_remove(struct hid_device *hdev)
858 {
859         struct pk_device *pk = hid_get_drvdata(hdev);
860         struct pcmidi_snd *pm;
861 
862         pm = pk->pm;
863         if (pm) {
864                 pcmidi_snd_terminate(pm);
865                 kfree(pm);
866         }
867 
868         hid_hw_stop(hdev);
869 
870         kfree(pk);
871 }
872 
873 static const struct hid_device_id pk_devices[] = {
874         {HID_USB_DEVICE(USB_VENDOR_ID_CREATIVELABS,
875                 USB_DEVICE_ID_PRODIKEYS_PCMIDI),
876             .driver_data = PK_QUIRK_NOGET},
877         { }
878 };
879 MODULE_DEVICE_TABLE(hid, pk_devices);
880 
881 static struct hid_driver pk_driver = {
882         .name = "prodikeys",
883         .id_table = pk_devices,
884         .report_fixup = pk_report_fixup,
885         .input_mapping = pk_input_mapping,
886         .raw_event = pk_raw_event,
887         .probe = pk_probe,
888         .remove = pk_remove,
889 };
890 module_hid_driver(pk_driver);
891 
892 MODULE_LICENSE("GPL");
893 

This page was automatically generated by LXR 0.3.1 (source).  •  Linux is a registered trademark of Linus Torvalds  •  Contact us