2 * HID driver for the Prodikeys PC-MIDI Keyboard
3 * providing midi & extra multimedia keys functionality
5 * Copyright (c) 2009 Don Prince <dhprince.devel@yahoo.co.uk>
7 * Controls for Octave Shift Up/Down, Channel, and
8 * Sustain Duration available via sysfs.
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)
19 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
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>
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)
42 struct hid_device
*hdev
;
43 struct pcmidi_snd
*pm
; /* pcmidi device context */
46 struct pcmidi_sustain
{
48 struct pcmidi_snd
*pm
;
49 struct timer_list timer
;
52 unsigned char velocity
;
55 #define PCMIDI_SUSTAINED_MAX 32
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
;
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
;
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
87 static const char shortname
[] = "PC-MIDI";
88 static const char longname
[] = "Prodikeys PC-MIDI Keyboard";
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
;
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");
102 /* Output routine for the sysfs channel file */
103 static ssize_t
show_channel(struct device
*dev
,
104 struct device_attribute
*attr
, char *buf
)
106 struct hid_device
*hdev
= to_hid_device(dev
);
107 struct pk_device
*pk
= hid_get_drvdata(hdev
);
109 dbg_hid("pcmidi sysfs read channel=%u\n", pk
->pm
->midi_channel
);
111 return sprintf(buf
, "%u (min:%u, max:%u)\n", pk
->pm
->midi_channel
,
112 PCMIDI_CHANNEL_MIN
, PCMIDI_CHANNEL_MAX
);
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
)
119 struct hid_device
*hdev
= to_hid_device(dev
);
120 struct pk_device
*pk
= hid_get_drvdata(hdev
);
122 unsigned channel
= 0;
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
;
132 static DEVICE_ATTR(channel
, S_IRUGO
| S_IWUSR
| S_IWGRP
, show_channel
,
135 static struct device_attribute
*sysfs_device_attr_channel
= {
139 /* Output routine for the sysfs sustain file */
140 static ssize_t
show_sustain(struct device
*dev
,
141 struct device_attribute
*attr
, char *buf
)
143 struct hid_device
*hdev
= to_hid_device(dev
);
144 struct pk_device
*pk
= hid_get_drvdata(hdev
);
146 dbg_hid("pcmidi sysfs read sustain=%u\n", pk
->pm
->midi_sustain
);
148 return sprintf(buf
, "%u (off:%u, max:%u (ms))\n", pk
->pm
->midi_sustain
,
149 PCMIDI_SUSTAIN_MIN
, PCMIDI_SUSTAIN_MAX
);
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
)
156 struct hid_device
*hdev
= to_hid_device(dev
);
157 struct pk_device
*pk
= hid_get_drvdata(hdev
);
159 unsigned sustain
= 0;
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;
171 static DEVICE_ATTR(sustain
, S_IRUGO
| S_IWUSR
| S_IWGRP
, show_sustain
,
174 static struct device_attribute
*sysfs_device_attr_sustain
= {
178 /* Output routine for the sysfs octave file */
179 static ssize_t
show_octave(struct device
*dev
,
180 struct device_attribute
*attr
, char *buf
)
182 struct hid_device
*hdev
= to_hid_device(dev
);
183 struct pk_device
*pk
= hid_get_drvdata(hdev
);
185 dbg_hid("pcmidi sysfs read octave=%d\n", pk
->pm
->midi_octave
);
187 return sprintf(buf
, "%d (min:%d, max:%d)\n", pk
->pm
->midi_octave
,
188 PCMIDI_OCTAVE_MIN
, PCMIDI_OCTAVE_MAX
);
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
)
195 struct hid_device
*hdev
= to_hid_device(dev
);
196 struct pk_device
*pk
= hid_get_drvdata(hdev
);
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
;
209 static DEVICE_ATTR(octave
, S_IRUGO
| S_IWUSR
| S_IWGRP
, show_octave
,
212 static struct device_attribute
*sysfs_device_attr_octave
= {
217 static void pcmidi_send_note(struct pcmidi_snd
*pm
,
218 unsigned char status
, unsigned char note
, unsigned char velocity
)
221 unsigned char buffer
[3];
225 buffer
[2] = velocity
;
227 spin_lock_irqsave(&pm
->rawmidi_in_lock
, flags
);
229 if (!pm
->in_substream
)
231 if (!test_bit(pm
->in_substream
->number
, &pm
->in_triggered
))
234 snd_rawmidi_receive(pm
->in_substream
, buffer
, 3);
237 spin_unlock_irqrestore(&pm
->rawmidi_in_lock
, flags
);
242 static void pcmidi_sustained_note_release(unsigned long data
)
244 struct pcmidi_sustain
*pms
= (struct pcmidi_sustain
*)data
;
246 pcmidi_send_note(pms
->pm
, pms
->status
, pms
->note
, pms
->velocity
);
250 static void init_sustain_timers(struct pcmidi_snd
*pm
)
252 struct pcmidi_sustain
*pms
;
255 for (i
= 0; i
< PCMIDI_SUSTAINED_MAX
; i
++) {
256 pms
= &pm
->sustained_notes
[i
];
259 setup_timer(&pms
->timer
, pcmidi_sustained_note_release
,
264 static void stop_sustain_timers(struct pcmidi_snd
*pm
)
266 struct pcmidi_sustain
*pms
;
269 for (i
= 0; i
< PCMIDI_SUSTAINED_MAX
; i
++) {
270 pms
= &pm
->sustained_notes
[i
];
272 del_timer_sync(&pms
->timer
);
276 static int pcmidi_get_output_report(struct pcmidi_snd
*pm
)
278 struct hid_device
*hdev
= pm
->pk
->hdev
;
279 struct hid_report
*report
;
281 list_for_each_entry(report
,
282 &hdev
->report_enum
[HID_OUTPUT_REPORT
].report_list
, list
) {
283 if (!(6 == report
->id
))
286 if (report
->maxfield
< 1) {
287 hid_err(hdev
, "output report is empty\n");
290 if (report
->field
[0]->report_count
!= 2) {
291 hid_err(hdev
, "field count too low\n");
294 pm
->pcmidi_report6
= report
;
297 /* should never get here */
301 static void pcmidi_submit_output_report(struct pcmidi_snd
*pm
, int state
)
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
;
308 hid_hw_request(hdev
, report
, HID_REQ_SET_REPORT
);
311 static int pcmidi_handle_report1(struct pcmidi_snd
*pm
, u8
*data
)
316 bit_mask
= (bit_mask
<< 8) | data
[2];
317 bit_mask
= (bit_mask
<< 8) | data
[3];
319 dbg_hid("pcmidi mode: %d\n", pm
->midi_mode
);
321 /*KEY_MAIL or octave down*/
322 if (pm
->midi_mode
&& bit_mask
== 0x004000) {
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
);
331 /*KEY_WWW or sustain*/
332 else if (pm
->midi_mode
&& bit_mask
== 0x000004) {
334 pm
->midi_sustain_mode
^= 0x1;
338 return 0; /* continue key processing */
341 static int pcmidi_handle_report3(struct pcmidi_snd
*pm
, u8
*data
, int size
)
343 struct pcmidi_sustain
*pms
;
345 unsigned char status
, note
, velocity
;
347 unsigned num_notes
= (size
-1)/2;
348 for (j
= 0; j
< num_notes
; j
++) {
350 velocity
= data
[j
*2+2];
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);
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);
363 if (pm
->midi_sustain_mode
) {
364 for (i
= 0; i
< PCMIDI_SUSTAINED_MAX
; i
++) {
365 pms
= &pm
->sustained_notes
[i
];
367 pms
->status
= status
;
369 pms
->velocity
= velocity
;
372 mod_timer(&pms
->timer
,
374 msecs_to_jiffies(pm
->midi_sustain
));
380 pcmidi_send_note(pm
, status
, note
, velocity
);
386 static int pcmidi_handle_report4(struct pcmidi_snd
*pm
, u8
*data
)
393 bit_mask
= (bit_mask
<< 8) | data
[2];
394 bit_mask
= (bit_mask
<< 8) | data
[3];
397 for (bit_index
= 0; bit_index
< 24; bit_index
++) {
398 if (!((0x01 << bit_index
) & bit_mask
)) {
399 input_event(pm
->input_ep82
, EV_KEY
,
400 pm
->last_key
[bit_index
], 0);
401 pm
->last_key
[bit_index
] = 0;
406 for (bit_index
= 0; bit_index
< 24; bit_index
++) {
408 switch ((0x01 << bit_index
) & bit_mask
) {
409 case 0x000010: /* Fn lock*/
410 pm
->fn_state
^= 0x000010;
412 pcmidi_submit_output_report(pm
, 0xc5);
414 pcmidi_submit_output_report(pm
, 0xc6);
416 case 0x020000: /* midi launcher..send a key (qwerty) or not? */
417 pcmidi_submit_output_report(pm
, 0xc1);
418 pm
->midi_mode
^= 0x01;
420 dbg_hid("pcmidi mode: %d\n", pm
->midi_mode
);
422 case 0x100000: /* KEY_MESSENGER or octave up */
423 dbg_hid("pcmidi mode: %d\n", pm
->midi_mode
);
426 if (pm
->midi_octave
> 2)
428 dbg_hid("pcmidi mode: %d octave: %d\n",
429 pm
->midi_mode
, pm
->midi_octave
);
438 key
= KEY_ADDRESSBOOK
;
444 key
= KEY_WORDPROCESSOR
;
447 key
= KEY_SPREADSHEET
;
462 key
= KEY_FORWARDMAIL
;
483 key
= KEY_SPELLCHECK
;
490 input_event(pm
->input_ep82
, EV_KEY
, key
, 1);
491 pm
->last_key
[bit_index
] = key
;
498 static int pcmidi_handle_report(
499 struct pcmidi_snd
*pm
, unsigned report_id
, u8
*data
, int size
)
504 case 0x01: /* midi keys (qwerty)*/
505 ret
= pcmidi_handle_report1(pm
, data
);
507 case 0x03: /* midi keyboard (musical)*/
508 ret
= pcmidi_handle_report3(pm
, data
, size
);
510 case 0x04: /* multimedia/midi keys (qwerty)*/
511 ret
= pcmidi_handle_report4(pm
, data
);
517 static void pcmidi_setup_extra_keys(
518 struct pcmidi_snd
*pm
, struct input_dev
*input
)
520 /* reassigned functionality for N/A keys
521 MY PICTURES => KEY_WORDPROCESSOR
522 MY MUSIC=> KEY_SPREADSHEET
524 unsigned int keys
[] = {
526 KEY_MESSENGER
, KEY_CALENDAR
,
527 KEY_ADDRESSBOOK
, KEY_DOCUMENTS
,
532 KEY_REPLY
, KEY_FORWARDMAIL
,
536 KEY_SPELLCHECK
, KEY_PRINT
,
540 unsigned int *pkeys
= &keys
[0];
543 if (pm
->ifnum
!= 1) /* only set up ONCE for interace 1 */
546 pm
->input_ep82
= input
;
548 for (i
= 0; i
< 24; i
++)
551 while (*pkeys
!= 0) {
552 set_bit(*pkeys
, pm
->input_ep82
->keybit
);
557 static int pcmidi_set_operational(struct pcmidi_snd
*pm
)
560 return 0; /* only set up ONCE for interace 1 */
562 pcmidi_get_output_report(pm
);
563 pcmidi_submit_output_report(pm
, 0xc1);
567 static int pcmidi_snd_free(struct snd_device
*dev
)
572 static int pcmidi_in_open(struct snd_rawmidi_substream
*substream
)
574 struct pcmidi_snd
*pm
= substream
->rmidi
->private_data
;
576 dbg_hid("pcmidi in open\n");
577 pm
->in_substream
= substream
;
581 static int pcmidi_in_close(struct snd_rawmidi_substream
*substream
)
583 dbg_hid("pcmidi in close\n");
587 static void pcmidi_in_trigger(struct snd_rawmidi_substream
*substream
, int up
)
589 struct pcmidi_snd
*pm
= substream
->rmidi
->private_data
;
591 dbg_hid("pcmidi in trigger %d\n", up
);
593 pm
->in_triggered
= up
;
596 static const struct snd_rawmidi_ops pcmidi_in_ops
= {
597 .open
= pcmidi_in_open
,
598 .close
= pcmidi_in_close
,
599 .trigger
= pcmidi_in_trigger
602 static int pcmidi_snd_initialise(struct pcmidi_snd
*pm
)
605 struct snd_card
*card
;
606 struct snd_rawmidi
*rwmidi
;
609 static struct snd_device_ops ops
= {
610 .dev_free
= pcmidi_snd_free
,
614 return 0; /* only set up midi device ONCE for interace 1 */
616 if (dev
>= SNDRV_CARDS
)
624 /* Setup sound card */
626 err
= snd_card_new(&pm
->pk
->hdev
->dev
, index
[dev
], id
[dev
],
627 THIS_MODULE
, 0, &card
);
629 pk_error("failed to create pc-midi sound card\n");
635 /* Setup sound device */
636 err
= snd_device_new(card
, SNDRV_DEV_LOWLEVEL
, pm
, &ops
);
638 pk_error("failed to create pc-midi sound device: error %d\n",
643 strncpy(card
->driver
, shortname
, sizeof(card
->driver
));
644 strncpy(card
->shortname
, shortname
, sizeof(card
->shortname
));
645 strncpy(card
->longname
, longname
, sizeof(card
->longname
));
648 err
= snd_rawmidi_new(card
, card
->shortname
, 0,
651 pk_error("failed to create pc-midi rawmidi device: error %d\n",
656 strncpy(rwmidi
->name
, card
->shortname
, sizeof(rwmidi
->name
));
657 rwmidi
->info_flags
= SNDRV_RAWMIDI_INFO_INPUT
;
658 rwmidi
->private_data
= pm
;
660 snd_rawmidi_set_ops(rwmidi
, SNDRV_RAWMIDI_STREAM_INPUT
,
663 /* create sysfs variables */
664 err
= device_create_file(&pm
->pk
->hdev
->dev
,
665 sysfs_device_attr_channel
);
667 pk_error("failed to create sysfs attribute channel: error %d\n",
672 err
= device_create_file(&pm
->pk
->hdev
->dev
,
673 sysfs_device_attr_sustain
);
675 pk_error("failed to create sysfs attribute sustain: error %d\n",
677 goto fail_attr_sustain
;
680 err
= device_create_file(&pm
->pk
->hdev
->dev
,
681 sysfs_device_attr_octave
);
683 pk_error("failed to create sysfs attribute octave: error %d\n",
685 goto fail_attr_octave
;
688 spin_lock_init(&pm
->rawmidi_in_lock
);
690 init_sustain_timers(pm
);
691 pcmidi_set_operational(pm
);
694 err
= snd_card_register(card
);
696 pk_error("failed to register pc-midi sound card: error %d\n",
701 dbg_hid("pcmidi_snd_initialise finished ok\n");
705 stop_sustain_timers(pm
);
706 device_remove_file(&pm
->pk
->hdev
->dev
, sysfs_device_attr_octave
);
708 device_remove_file(&pm
->pk
->hdev
->dev
, sysfs_device_attr_sustain
);
710 device_remove_file(&pm
->pk
->hdev
->dev
, sysfs_device_attr_channel
);
713 snd_card_free(pm
->card
);
719 static int pcmidi_snd_terminate(struct pcmidi_snd
*pm
)
722 stop_sustain_timers(pm
);
724 device_remove_file(&pm
->pk
->hdev
->dev
,
725 sysfs_device_attr_channel
);
726 device_remove_file(&pm
->pk
->hdev
->dev
,
727 sysfs_device_attr_sustain
);
728 device_remove_file(&pm
->pk
->hdev
->dev
,
729 sysfs_device_attr_octave
);
731 snd_card_disconnect(pm
->card
);
732 snd_card_free_when_closed(pm
->card
);
739 * PC-MIDI report descriptor for report id is wrong.
741 static __u8
*pk_report_fixup(struct hid_device
*hdev
, __u8
*rdesc
,
745 rdesc
[111] == 0x06 && rdesc
[112] == 0x00 &&
746 rdesc
[113] == 0xff) {
748 "fixing up pc-midi keyboard report descriptor\n");
750 rdesc
[144] = 0x18; /* report 4: was 0x10 report count */
755 static int pk_input_mapping(struct hid_device
*hdev
, struct hid_input
*hi
,
756 struct hid_field
*field
, struct hid_usage
*usage
,
757 unsigned long **bit
, int *max
)
759 struct pk_device
*pk
= hid_get_drvdata(hdev
);
760 struct pcmidi_snd
*pm
;
764 if (HID_UP_MSVENDOR
== (usage
->hid
& HID_USAGE_PAGE
) &&
766 pcmidi_setup_extra_keys(pm
, hi
->input
);
774 static int pk_raw_event(struct hid_device
*hdev
, struct hid_report
*report
,
777 struct pk_device
*pk
= hid_get_drvdata(hdev
);
780 if (1 == pk
->pm
->ifnum
) {
781 if (report
->id
== data
[0])
782 switch (report
->id
) {
783 case 0x01: /* midi keys (qwerty)*/
784 case 0x03: /* midi keyboard (musical)*/
785 case 0x04: /* extra/midi keys (qwerty)*/
786 ret
= pcmidi_handle_report(pk
->pm
,
787 report
->id
, data
, size
);
795 static int pk_probe(struct hid_device
*hdev
, const struct hid_device_id
*id
)
798 struct usb_interface
*intf
= to_usb_interface(hdev
->dev
.parent
);
799 unsigned short ifnum
= intf
->cur_altsetting
->desc
.bInterfaceNumber
;
800 unsigned long quirks
= id
->driver_data
;
801 struct pk_device
*pk
;
802 struct pcmidi_snd
*pm
= NULL
;
804 pk
= kzalloc(sizeof(*pk
), GFP_KERNEL
);
806 hid_err(hdev
, "can't alloc descriptor\n");
812 pm
= kzalloc(sizeof(*pm
), GFP_KERNEL
);
814 hid_err(hdev
, "can't alloc descriptor\n");
823 hid_set_drvdata(hdev
, pk
);
825 ret
= hid_parse(hdev
);
827 hid_err(hdev
, "hid parse failed\n");
831 if (quirks
& PK_QUIRK_NOGET
) { /* hid_parse cleared all the quirks */
832 hdev
->quirks
|= HID_QUIRK_NOGET
;
835 ret
= hid_hw_start(hdev
, HID_CONNECT_DEFAULT
);
837 hid_err(hdev
, "hw start failed\n");
841 ret
= pcmidi_snd_initialise(pm
);
856 static void pk_remove(struct hid_device
*hdev
)
858 struct pk_device
*pk
= hid_get_drvdata(hdev
);
859 struct pcmidi_snd
*pm
;
863 pcmidi_snd_terminate(pm
);
872 static const struct hid_device_id pk_devices
[] = {
873 {HID_USB_DEVICE(USB_VENDOR_ID_CREATIVELABS
,
874 USB_DEVICE_ID_PRODIKEYS_PCMIDI
),
875 .driver_data
= PK_QUIRK_NOGET
},
878 MODULE_DEVICE_TABLE(hid
, pk_devices
);
880 static struct hid_driver pk_driver
= {
882 .id_table
= pk_devices
,
883 .report_fixup
= pk_report_fixup
,
884 .input_mapping
= pk_input_mapping
,
885 .raw_event
= pk_raw_event
,
889 module_hid_driver(pk_driver
);
891 MODULE_LICENSE("GPL");