linux/drivers/hid/hid-prodikeys.c
<<
>>
Prefs
   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
  37struct pcmidi_snd;
  38
  39struct pk_device {
  40        unsigned long           quirks;
  41
  42        struct hid_device       *hdev;
  43        struct pcmidi_snd       *pm; /* pcmidi device context */
  44};
  45
  46struct 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
  56struct 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
  87static const char shortname[] = "PC-MIDI";
  88static const char longname[] = "Prodikeys PC-MIDI Keyboard";
  89
  90static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
  91static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;
  92static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;
  93
  94module_param_array(index, int, NULL, 0444);
  95module_param_array(id, charp, NULL, 0444);
  96module_param_array(enable, bool, NULL, 0444);
  97MODULE_PARM_DESC(index, "Index value for the PC-MIDI virtual audio driver");
  98MODULE_PARM_DESC(id, "ID string for the PC-MIDI virtual audio driver");
  99MODULE_PARM_DESC(enable, "Enable for the PC-MIDI virtual audio driver");
 100
 101
 102/* Output routine for the sysfs channel file */
 103static 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 */
 116static 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
 132static DEVICE_ATTR(channel, S_IRUGO | S_IWUSR | S_IWGRP , show_channel,
 133                store_channel);
 134
 135static struct device_attribute *sysfs_device_attr_channel = {
 136                &dev_attr_channel,
 137                };
 138
 139/* Output routine for the sysfs sustain file */
 140static 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 */
 153static 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
 171static DEVICE_ATTR(sustain, S_IRUGO | S_IWUSR | S_IWGRP, show_sustain,
 172                store_sustain);
 173
 174static struct device_attribute *sysfs_device_attr_sustain = {
 175                &dev_attr_sustain,
 176                };
 177
 178/* Output routine for the sysfs octave file */
 179static 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 */
 192static 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
 209static DEVICE_ATTR(octave, S_IRUGO | S_IWUSR | S_IWGRP, show_octave,
 210                store_octave);
 211
 212static struct device_attribute *sysfs_device_attr_octave = {
 213                &dev_attr_octave,
 214                };
 215
 216
 217static 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
 236drop_note:
 237        spin_unlock_irqrestore(&pm->rawmidi_in_lock, flags);
 238
 239        return;
 240}
 241
 242static 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
 250static 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
 264static 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
 276static 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
 301static 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
 311static 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
 341static 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
 386static 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
 499static 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
 518static 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
 558static 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
 568static int pcmidi_snd_free(struct snd_device *dev)
 569{
 570        return 0;
 571}
 572
 573static 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
 582static int pcmidi_in_close(struct snd_rawmidi_substream *substream)
 583{
 584        dbg_hid("pcmidi in close\n");
 585        return 0;
 586}
 587
 588static 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
 597static struct snd_rawmidi_ops pcmidi_in_ops = {
 598        .open = pcmidi_in_open,
 599        .close = pcmidi_in_close,
 600        .trigger = pcmidi_in_trigger
 601};
 602
 603static 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_create(index[dev], id[dev], THIS_MODULE, 0, &card);
 628        if (err < 0) {
 629                pk_error("failed to create pc-midi sound card\n");
 630                err = -ENOMEM;
 631                goto fail;
 632        }
 633        pm->card = card;
 634
 635        /* Setup sound device */
 636        err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, pm, &ops);
 637        if (err < 0) {
 638                pk_error("failed to create pc-midi sound device: error %d\n",
 639                        err);
 640                goto fail;
 641        }
 642
 643        strncpy(card->driver, shortname, sizeof(card->driver));
 644        strncpy(card->shortname, shortname, sizeof(card->shortname));
 645        strncpy(card->longname, longname, sizeof(card->longname));
 646
 647        /* Set up rawmidi */
 648        err = snd_rawmidi_new(card, card->shortname, 0,
 649                              0, 1, &rwmidi);
 650        if (err < 0) {
 651                pk_error("failed to create pc-midi rawmidi device: error %d\n",
 652                        err);
 653                goto fail;
 654        }
 655        pm->rwmidi = rwmidi;
 656        strncpy(rwmidi->name, card->shortname, sizeof(rwmidi->name));
 657        rwmidi->info_flags = SNDRV_RAWMIDI_INFO_INPUT;
 658        rwmidi->private_data = pm;
 659
 660        snd_rawmidi_set_ops(rwmidi, SNDRV_RAWMIDI_STREAM_INPUT,
 661                &pcmidi_in_ops);
 662
 663        snd_card_set_dev(card, &pm->pk->hdev->dev);
 664
 665        /* create sysfs variables */
 666        err = device_create_file(&pm->pk->hdev->dev,
 667                                 sysfs_device_attr_channel);
 668        if (err < 0) {
 669                pk_error("failed to create sysfs attribute channel: error %d\n",
 670                        err);
 671                goto fail;
 672        }
 673
 674        err = device_create_file(&pm->pk->hdev->dev,
 675                                sysfs_device_attr_sustain);
 676        if (err < 0) {
 677                pk_error("failed to create sysfs attribute sustain: error %d\n",
 678                        err);
 679                goto fail_attr_sustain;
 680        }
 681
 682        err = device_create_file(&pm->pk->hdev->dev,
 683                         sysfs_device_attr_octave);
 684        if (err < 0) {
 685                pk_error("failed to create sysfs attribute octave: error %d\n",
 686                        err);
 687                goto fail_attr_octave;
 688        }
 689
 690        spin_lock_init(&pm->rawmidi_in_lock);
 691
 692        init_sustain_timers(pm);
 693        pcmidi_set_operational(pm);
 694
 695        /* register it */
 696        err = snd_card_register(card);
 697        if (err < 0) {
 698                pk_error("failed to register pc-midi sound card: error %d\n",
 699                         err);
 700                         goto fail_register;
 701        }
 702
 703        dbg_hid("pcmidi_snd_initialise finished ok\n");
 704        return 0;
 705
 706fail_register:
 707        stop_sustain_timers(pm);
 708        device_remove_file(&pm->pk->hdev->dev, sysfs_device_attr_octave);
 709fail_attr_octave:
 710        device_remove_file(&pm->pk->hdev->dev, sysfs_device_attr_sustain);
 711fail_attr_sustain:
 712        device_remove_file(&pm->pk->hdev->dev, sysfs_device_attr_channel);
 713fail:
 714        if (pm->card) {
 715                snd_card_free(pm->card);
 716                pm->card = NULL;
 717        }
 718        return err;
 719}
 720
 721static int pcmidi_snd_terminate(struct pcmidi_snd *pm)
 722{
 723        if (pm->card) {
 724                stop_sustain_timers(pm);
 725
 726                device_remove_file(&pm->pk->hdev->dev,
 727                        sysfs_device_attr_channel);
 728                device_remove_file(&pm->pk->hdev->dev,
 729                        sysfs_device_attr_sustain);
 730                device_remove_file(&pm->pk->hdev->dev,
 731                        sysfs_device_attr_octave);
 732
 733                snd_card_disconnect(pm->card);
 734                snd_card_free_when_closed(pm->card);
 735        }
 736
 737        return 0;
 738}
 739
 740/*
 741 * PC-MIDI report descriptor for report id is wrong.
 742 */
 743static __u8 *pk_report_fixup(struct hid_device *hdev, __u8 *rdesc,
 744                unsigned int *rsize)
 745{
 746        if (*rsize == 178 &&
 747              rdesc[111] == 0x06 && rdesc[112] == 0x00 &&
 748              rdesc[113] == 0xff) {
 749                hid_info(hdev,
 750                         "fixing up pc-midi keyboard report descriptor\n");
 751
 752                rdesc[144] = 0x18; /* report 4: was 0x10 report count */
 753        }
 754        return rdesc;
 755}
 756
 757static int pk_input_mapping(struct hid_device *hdev, struct hid_input *hi,
 758                struct hid_field *field, struct hid_usage *usage,
 759                unsigned long **bit, int *max)
 760{
 761        struct pk_device *pk = hid_get_drvdata(hdev);
 762        struct pcmidi_snd *pm;
 763
 764        pm = pk->pm;
 765
 766        if (HID_UP_MSVENDOR == (usage->hid & HID_USAGE_PAGE) &&
 767                1 == pm->ifnum) {
 768                pcmidi_setup_extra_keys(pm, hi->input);
 769                return 0;
 770        }
 771
 772        return 0;
 773}
 774
 775
 776static int pk_raw_event(struct hid_device *hdev, struct hid_report *report,
 777        u8 *data, int size)
 778{
 779        struct pk_device *pk = hid_get_drvdata(hdev);
 780        int ret = 0;
 781
 782        if (1 == pk->pm->ifnum) {
 783                if (report->id == data[0])
 784                        switch (report->id) {
 785                        case 0x01: /* midi keys (qwerty)*/
 786                        case 0x03: /* midi keyboard (musical)*/
 787                        case 0x04: /* extra/midi keys (qwerty)*/
 788                                ret = pcmidi_handle_report(pk->pm,
 789                                                report->id, data, size);
 790                                break;
 791                        }
 792        }
 793
 794        return ret;
 795}
 796
 797static int pk_probe(struct hid_device *hdev, const struct hid_device_id *id)
 798{
 799        int ret;
 800        struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
 801        unsigned short ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
 802        unsigned long quirks = id->driver_data;
 803        struct pk_device *pk;
 804        struct pcmidi_snd *pm = NULL;
 805
 806        pk = kzalloc(sizeof(*pk), GFP_KERNEL);
 807        if (pk == NULL) {
 808                hid_err(hdev, "can't alloc descriptor\n");
 809                return -ENOMEM;
 810        }
 811
 812        pk->hdev = hdev;
 813
 814        pm = kzalloc(sizeof(*pm), GFP_KERNEL);
 815        if (pm == NULL) {
 816                hid_err(hdev, "can't alloc descriptor\n");
 817                ret = -ENOMEM;
 818                goto err_free_pk;
 819        }
 820
 821        pm->pk = pk;
 822        pk->pm = pm;
 823        pm->ifnum = ifnum;
 824
 825        hid_set_drvdata(hdev, pk);
 826
 827        ret = hid_parse(hdev);
 828        if (ret) {
 829                hid_err(hdev, "hid parse failed\n");
 830                goto err_free;
 831        }
 832
 833        if (quirks & PK_QUIRK_NOGET) { /* hid_parse cleared all the quirks */
 834                hdev->quirks |= HID_QUIRK_NOGET;
 835        }
 836
 837        ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
 838        if (ret) {
 839                hid_err(hdev, "hw start failed\n");
 840                goto err_free;
 841        }
 842
 843        ret = pcmidi_snd_initialise(pm);
 844        if (ret < 0)
 845                goto err_stop;
 846
 847        return 0;
 848err_stop:
 849        hid_hw_stop(hdev);
 850err_free:
 851        kfree(pm);
 852err_free_pk:
 853        kfree(pk);
 854
 855        return ret;
 856}
 857
 858static void pk_remove(struct hid_device *hdev)
 859{
 860        struct pk_device *pk = hid_get_drvdata(hdev);
 861        struct pcmidi_snd *pm;
 862
 863        pm = pk->pm;
 864        if (pm) {
 865                pcmidi_snd_terminate(pm);
 866                kfree(pm);
 867        }
 868
 869        hid_hw_stop(hdev);
 870
 871        kfree(pk);
 872}
 873
 874static const struct hid_device_id pk_devices[] = {
 875        {HID_USB_DEVICE(USB_VENDOR_ID_CREATIVELABS,
 876                USB_DEVICE_ID_PRODIKEYS_PCMIDI),
 877            .driver_data = PK_QUIRK_NOGET},
 878        { }
 879};
 880MODULE_DEVICE_TABLE(hid, pk_devices);
 881
 882static struct hid_driver pk_driver = {
 883        .name = "prodikeys",
 884        .id_table = pk_devices,
 885        .report_fixup = pk_report_fixup,
 886        .input_mapping = pk_input_mapping,
 887        .raw_event = pk_raw_event,
 888        .probe = pk_probe,
 889        .remove = pk_remove,
 890};
 891module_hid_driver(pk_driver);
 892
 893MODULE_LICENSE("GPL");
 894
lxr.linux.no kindly hosted by Redpill Linpro AS, provider of Linux consulting and operations services since 1995.