linux/drivers/hid/hid-roccat-kone.c
<<
>>
Prefs
   1/*
   2 * Roccat Kone driver for Linux
   3 *
   4 * Copyright (c) 2010 Stefan Achatz <erazor_de@users.sourceforge.net>
   5 */
   6
   7/*
   8 * This program is free software; you can redistribute it and/or modify it
   9 * under the terms of the GNU General Public License as published by the Free
  10 * Software Foundation; either version 2 of the License, or (at your option)
  11 * any later version.
  12 */
  13
  14/*
  15 * Roccat Kone is a gamer mouse which consists of a mouse part and a keyboard
  16 * part. The keyboard part enables the mouse to execute stored macros with mixed
  17 * key- and button-events.
  18 *
  19 * TODO implement on-the-fly polling-rate change
  20 *      The windows driver has the ability to change the polling rate of the
  21 *      device on the press of a mousebutton.
  22 *      Is it possible to remove and reinstall the urb in raw-event- or any
  23 *      other handler, or to defer this action to be executed somewhere else?
  24 *
  25 * TODO is it possible to overwrite group for sysfs attributes via udev?
  26 */
  27
  28#include <linux/device.h>
  29#include <linux/input.h>
  30#include <linux/hid.h>
  31#include <linux/module.h>
  32#include <linux/slab.h>
  33#include <linux/hid-roccat.h>
  34#include "hid-ids.h"
  35#include "hid-roccat-common.h"
  36#include "hid-roccat-kone.h"
  37
  38static uint profile_numbers[5] = {0, 1, 2, 3, 4};
  39
  40static void kone_profile_activated(struct kone_device *kone, uint new_profile)
  41{
  42        kone->actual_profile = new_profile;
  43        kone->actual_dpi = kone->profiles[new_profile - 1].startup_dpi;
  44}
  45
  46static void kone_profile_report(struct kone_device *kone, uint new_profile)
  47{
  48        struct kone_roccat_report roccat_report;
  49
  50        roccat_report.event = kone_mouse_event_switch_profile;
  51        roccat_report.value = new_profile;
  52        roccat_report.key = 0;
  53        roccat_report_event(kone->chrdev_minor, (uint8_t *)&roccat_report);
  54}
  55
  56static int kone_receive(struct usb_device *usb_dev, uint usb_command,
  57                void *data, uint size)
  58{
  59        char *buf;
  60        int len;
  61
  62        buf = kmalloc(size, GFP_KERNEL);
  63        if (buf == NULL)
  64                return -ENOMEM;
  65
  66        len = usb_control_msg(usb_dev, usb_rcvctrlpipe(usb_dev, 0),
  67                        HID_REQ_GET_REPORT,
  68                        USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
  69                        usb_command, 0, buf, size, USB_CTRL_SET_TIMEOUT);
  70
  71        memcpy(data, buf, size);
  72        kfree(buf);
  73        return ((len < 0) ? len : ((len != size) ? -EIO : 0));
  74}
  75
  76static int kone_send(struct usb_device *usb_dev, uint usb_command,
  77                void const *data, uint size)
  78{
  79        char *buf;
  80        int len;
  81
  82        buf = kmemdup(data, size, GFP_KERNEL);
  83        if (buf == NULL)
  84                return -ENOMEM;
  85
  86        len = usb_control_msg(usb_dev, usb_sndctrlpipe(usb_dev, 0),
  87                        HID_REQ_SET_REPORT,
  88                        USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_OUT,
  89                        usb_command, 0, buf, size, USB_CTRL_SET_TIMEOUT);
  90
  91        kfree(buf);
  92        return ((len < 0) ? len : ((len != size) ? -EIO : 0));
  93}
  94
  95/* kone_class is used for creating sysfs attributes via roccat char device */
  96static struct class *kone_class;
  97
  98static void kone_set_settings_checksum(struct kone_settings *settings)
  99{
 100        uint16_t checksum = 0;
 101        unsigned char *address = (unsigned char *)settings;
 102        int i;
 103
 104        for (i = 0; i < sizeof(struct kone_settings) - 2; ++i, ++address)
 105                checksum += *address;
 106        settings->checksum = cpu_to_le16(checksum);
 107}
 108
 109/*
 110 * Checks success after writing data to mouse
 111 * On success returns 0
 112 * On failure returns errno
 113 */
 114static int kone_check_write(struct usb_device *usb_dev)
 115{
 116        int retval;
 117        uint8_t data;
 118
 119        do {
 120                /*
 121                 * Mouse needs 50 msecs until it says ok, but there are
 122                 * 30 more msecs needed for next write to work.
 123                 */
 124                msleep(80);
 125
 126                retval = kone_receive(usb_dev,
 127                                kone_command_confirm_write, &data, 1);
 128                if (retval)
 129                        return retval;
 130
 131                /*
 132                 * value of 3 seems to mean something like
 133                 * "not finished yet, but it looks good"
 134                 * So check again after a moment.
 135                 */
 136        } while (data == 3);
 137
 138        if (data == 1) /* everything alright */
 139                return 0;
 140
 141        /* unknown answer */
 142        dev_err(&usb_dev->dev, "got retval %d when checking write\n", data);
 143        return -EIO;
 144}
 145
 146/*
 147 * Reads settings from mouse and stores it in @buf
 148 * On success returns 0
 149 * On failure returns errno
 150 */
 151static int kone_get_settings(struct usb_device *usb_dev,
 152                struct kone_settings *buf)
 153{
 154        return kone_receive(usb_dev, kone_command_settings, buf,
 155                        sizeof(struct kone_settings));
 156}
 157
 158/*
 159 * Writes settings from @buf to mouse
 160 * On success returns 0
 161 * On failure returns errno
 162 */
 163static int kone_set_settings(struct usb_device *usb_dev,
 164                struct kone_settings const *settings)
 165{
 166        int retval;
 167
 168        retval = kone_send(usb_dev, kone_command_settings,
 169                        settings, sizeof(struct kone_settings));
 170        if (retval)
 171                return retval;
 172        return kone_check_write(usb_dev);
 173}
 174
 175/*
 176 * Reads profile data from mouse and stores it in @buf
 177 * @number: profile number to read
 178 * On success returns 0
 179 * On failure returns errno
 180 */
 181static int kone_get_profile(struct usb_device *usb_dev,
 182                struct kone_profile *buf, int number)
 183{
 184        int len;
 185
 186        if (number < 1 || number > 5)
 187                return -EINVAL;
 188
 189        len = usb_control_msg(usb_dev, usb_rcvctrlpipe(usb_dev, 0),
 190                        USB_REQ_CLEAR_FEATURE,
 191                        USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
 192                        kone_command_profile, number, buf,
 193                        sizeof(struct kone_profile), USB_CTRL_SET_TIMEOUT);
 194
 195        if (len != sizeof(struct kone_profile))
 196                return -EIO;
 197
 198        return 0;
 199}
 200
 201/*
 202 * Writes profile data to mouse.
 203 * @number: profile number to write
 204 * On success returns 0
 205 * On failure returns errno
 206 */
 207static int kone_set_profile(struct usb_device *usb_dev,
 208                struct kone_profile const *profile, int number)
 209{
 210        int len;
 211
 212        if (number < 1 || number > 5)
 213                return -EINVAL;
 214
 215        len = usb_control_msg(usb_dev, usb_sndctrlpipe(usb_dev, 0),
 216                        USB_REQ_SET_CONFIGURATION,
 217                        USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_OUT,
 218                        kone_command_profile, number, (void *)profile,
 219                        sizeof(struct kone_profile),
 220                        USB_CTRL_SET_TIMEOUT);
 221
 222        if (len != sizeof(struct kone_profile))
 223                return len;
 224
 225        if (kone_check_write(usb_dev))
 226                return -EIO;
 227
 228        return 0;
 229}
 230
 231/*
 232 * Reads value of "fast-clip-weight" and stores it in @result
 233 * On success returns 0
 234 * On failure returns errno
 235 */
 236static int kone_get_weight(struct usb_device *usb_dev, int *result)
 237{
 238        int retval;
 239        uint8_t data;
 240
 241        retval = kone_receive(usb_dev, kone_command_weight, &data, 1);
 242
 243        if (retval)
 244                return retval;
 245
 246        *result = (int)data;
 247        return 0;
 248}
 249
 250/*
 251 * Reads firmware_version of mouse and stores it in @result
 252 * On success returns 0
 253 * On failure returns errno
 254 */
 255static int kone_get_firmware_version(struct usb_device *usb_dev, int *result)
 256{
 257        int retval;
 258        uint16_t data;
 259
 260        retval = kone_receive(usb_dev, kone_command_firmware_version,
 261                        &data, 2);
 262        if (retval)
 263                return retval;
 264
 265        *result = le16_to_cpu(data);
 266        return 0;
 267}
 268
 269static ssize_t kone_sysfs_read_settings(struct file *fp, struct kobject *kobj,
 270                struct bin_attribute *attr, char *buf,
 271                loff_t off, size_t count) {
 272        struct device *dev =
 273                        container_of(kobj, struct device, kobj)->parent->parent;
 274        struct kone_device *kone = hid_get_drvdata(dev_get_drvdata(dev));
 275
 276        if (off >= sizeof(struct kone_settings))
 277                return 0;
 278
 279        if (off + count > sizeof(struct kone_settings))
 280                count = sizeof(struct kone_settings) - off;
 281
 282        mutex_lock(&kone->kone_lock);
 283        memcpy(buf, ((char const *)&kone->settings) + off, count);
 284        mutex_unlock(&kone->kone_lock);
 285
 286        return count;
 287}
 288
 289/*
 290 * Writing settings automatically activates startup_profile.
 291 * This function keeps values in kone_device up to date and assumes that in
 292 * case of error the old data is still valid
 293 */
 294static ssize_t kone_sysfs_write_settings(struct file *fp, struct kobject *kobj,
 295                struct bin_attribute *attr, char *buf,
 296                loff_t off, size_t count) {
 297        struct device *dev =
 298                        container_of(kobj, struct device, kobj)->parent->parent;
 299        struct kone_device *kone = hid_get_drvdata(dev_get_drvdata(dev));
 300        struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
 301        int retval = 0, difference, old_profile;
 302
 303        /* I need to get my data in one piece */
 304        if (off != 0 || count != sizeof(struct kone_settings))
 305                return -EINVAL;
 306
 307        mutex_lock(&kone->kone_lock);
 308        difference = memcmp(buf, &kone->settings, sizeof(struct kone_settings));
 309        if (difference) {
 310                retval = kone_set_settings(usb_dev,
 311                                (struct kone_settings const *)buf);
 312                if (retval) {
 313                        mutex_unlock(&kone->kone_lock);
 314                        return retval;
 315                }
 316
 317                old_profile = kone->settings.startup_profile;
 318                memcpy(&kone->settings, buf, sizeof(struct kone_settings));
 319
 320                kone_profile_activated(kone, kone->settings.startup_profile);
 321
 322                if (kone->settings.startup_profile != old_profile)
 323                        kone_profile_report(kone, kone->settings.startup_profile);
 324        }
 325        mutex_unlock(&kone->kone_lock);
 326
 327        return sizeof(struct kone_settings);
 328}
 329static BIN_ATTR(settings, 0660, kone_sysfs_read_settings,
 330                kone_sysfs_write_settings, sizeof(struct kone_settings));
 331
 332static ssize_t kone_sysfs_read_profilex(struct file *fp,
 333                struct kobject *kobj, struct bin_attribute *attr,
 334                char *buf, loff_t off, size_t count) {
 335        struct device *dev =
 336                        container_of(kobj, struct device, kobj)->parent->parent;
 337        struct kone_device *kone = hid_get_drvdata(dev_get_drvdata(dev));
 338
 339        if (off >= sizeof(struct kone_profile))
 340                return 0;
 341
 342        if (off + count > sizeof(struct kone_profile))
 343                count = sizeof(struct kone_profile) - off;
 344
 345        mutex_lock(&kone->kone_lock);
 346        memcpy(buf, ((char const *)&kone->profiles[*(uint *)(attr->private)]) + off, count);
 347        mutex_unlock(&kone->kone_lock);
 348
 349        return count;
 350}
 351
 352/* Writes data only if different to stored data */
 353static ssize_t kone_sysfs_write_profilex(struct file *fp,
 354                struct kobject *kobj, struct bin_attribute *attr,
 355                char *buf, loff_t off, size_t count) {
 356        struct device *dev =
 357                        container_of(kobj, struct device, kobj)->parent->parent;
 358        struct kone_device *kone = hid_get_drvdata(dev_get_drvdata(dev));
 359        struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
 360        struct kone_profile *profile;
 361        int retval = 0, difference;
 362
 363        /* I need to get my data in one piece */
 364        if (off != 0 || count != sizeof(struct kone_profile))
 365                return -EINVAL;
 366
 367        profile = &kone->profiles[*(uint *)(attr->private)];
 368
 369        mutex_lock(&kone->kone_lock);
 370        difference = memcmp(buf, profile, sizeof(struct kone_profile));
 371        if (difference) {
 372                retval = kone_set_profile(usb_dev,
 373                                (struct kone_profile const *)buf,
 374                                *(uint *)(attr->private) + 1);
 375                if (!retval)
 376                        memcpy(profile, buf, sizeof(struct kone_profile));
 377        }
 378        mutex_unlock(&kone->kone_lock);
 379
 380        if (retval)
 381                return retval;
 382
 383        return sizeof(struct kone_profile);
 384}
 385#define PROFILE_ATTR(number)                                    \
 386static struct bin_attribute bin_attr_profile##number = {        \
 387        .attr = { .name = "profile" #number, .mode = 0660 },    \
 388        .size = sizeof(struct kone_profile),                    \
 389        .read = kone_sysfs_read_profilex,                       \
 390        .write = kone_sysfs_write_profilex,                     \
 391        .private = &profile_numbers[number-1],                  \
 392}
 393PROFILE_ATTR(1);
 394PROFILE_ATTR(2);
 395PROFILE_ATTR(3);
 396PROFILE_ATTR(4);
 397PROFILE_ATTR(5);
 398
 399static ssize_t kone_sysfs_show_actual_profile(struct device *dev,
 400                struct device_attribute *attr, char *buf)
 401{
 402        struct kone_device *kone =
 403                        hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
 404        return snprintf(buf, PAGE_SIZE, "%d\n", kone->actual_profile);
 405}
 406static DEVICE_ATTR(actual_profile, 0440, kone_sysfs_show_actual_profile, NULL);
 407
 408static ssize_t kone_sysfs_show_actual_dpi(struct device *dev,
 409                struct device_attribute *attr, char *buf)
 410{
 411        struct kone_device *kone =
 412                        hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
 413        return snprintf(buf, PAGE_SIZE, "%d\n", kone->actual_dpi);
 414}
 415static DEVICE_ATTR(actual_dpi, 0440, kone_sysfs_show_actual_dpi, NULL);
 416
 417/* weight is read each time, since we don't get informed when it's changed */
 418static ssize_t kone_sysfs_show_weight(struct device *dev,
 419                struct device_attribute *attr, char *buf)
 420{
 421        struct kone_device *kone;
 422        struct usb_device *usb_dev;
 423        int weight = 0;
 424        int retval;
 425
 426        dev = dev->parent->parent;
 427        kone = hid_get_drvdata(dev_get_drvdata(dev));
 428        usb_dev = interface_to_usbdev(to_usb_interface(dev));
 429
 430        mutex_lock(&kone->kone_lock);
 431        retval = kone_get_weight(usb_dev, &weight);
 432        mutex_unlock(&kone->kone_lock);
 433
 434        if (retval)
 435                return retval;
 436        return snprintf(buf, PAGE_SIZE, "%d\n", weight);
 437}
 438static DEVICE_ATTR(weight, 0440, kone_sysfs_show_weight, NULL);
 439
 440static ssize_t kone_sysfs_show_firmware_version(struct device *dev,
 441                struct device_attribute *attr, char *buf)
 442{
 443        struct kone_device *kone =
 444                        hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
 445        return snprintf(buf, PAGE_SIZE, "%d\n", kone->firmware_version);
 446}
 447static DEVICE_ATTR(firmware_version, 0440, kone_sysfs_show_firmware_version,
 448                   NULL);
 449
 450static ssize_t kone_sysfs_show_tcu(struct device *dev,
 451                struct device_attribute *attr, char *buf)
 452{
 453        struct kone_device *kone =
 454                        hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
 455        return snprintf(buf, PAGE_SIZE, "%d\n", kone->settings.tcu);
 456}
 457
 458static int kone_tcu_command(struct usb_device *usb_dev, int number)
 459{
 460        unsigned char value;
 461
 462        value = number;
 463        return kone_send(usb_dev, kone_command_calibrate, &value, 1);
 464}
 465
 466/*
 467 * Calibrating the tcu is the only action that changes settings data inside the
 468 * mouse, so this data needs to be reread
 469 */
 470static ssize_t kone_sysfs_set_tcu(struct device *dev,
 471                struct device_attribute *attr, char const *buf, size_t size)
 472{
 473        struct kone_device *kone;
 474        struct usb_device *usb_dev;
 475        int retval;
 476        unsigned long state;
 477
 478        dev = dev->parent->parent;
 479        kone = hid_get_drvdata(dev_get_drvdata(dev));
 480        usb_dev = interface_to_usbdev(to_usb_interface(dev));
 481
 482        retval = kstrtoul(buf, 10, &state);
 483        if (retval)
 484                return retval;
 485
 486        if (state != 0 && state != 1)
 487                return -EINVAL;
 488
 489        mutex_lock(&kone->kone_lock);
 490
 491        if (state == 1) { /* state activate */
 492                retval = kone_tcu_command(usb_dev, 1);
 493                if (retval)
 494                        goto exit_unlock;
 495                retval = kone_tcu_command(usb_dev, 2);
 496                if (retval)
 497                        goto exit_unlock;
 498                ssleep(5); /* tcu needs this time for calibration */
 499                retval = kone_tcu_command(usb_dev, 3);
 500                if (retval)
 501                        goto exit_unlock;
 502                retval = kone_tcu_command(usb_dev, 0);
 503                if (retval)
 504                        goto exit_unlock;
 505                retval = kone_tcu_command(usb_dev, 4);
 506                if (retval)
 507                        goto exit_unlock;
 508                /*
 509                 * Kone needs this time to settle things.
 510                 * Reading settings too early will result in invalid data.
 511                 * Roccat's driver waits 1 sec, maybe this time could be
 512                 * shortened.
 513                 */
 514                ssleep(1);
 515        }
 516
 517        /* calibration changes values in settings, so reread */
 518        retval = kone_get_settings(usb_dev, &kone->settings);
 519        if (retval)
 520                goto exit_no_settings;
 521
 522        /* only write settings back if activation state is different */
 523        if (kone->settings.tcu != state) {
 524                kone->settings.tcu = state;
 525                kone_set_settings_checksum(&kone->settings);
 526
 527                retval = kone_set_settings(usb_dev, &kone->settings);
 528                if (retval) {
 529                        dev_err(&usb_dev->dev, "couldn't set tcu state\n");
 530                        /*
 531                         * try to reread valid settings into buffer overwriting
 532                         * first error code
 533                         */
 534                        retval = kone_get_settings(usb_dev, &kone->settings);
 535                        if (retval)
 536                                goto exit_no_settings;
 537                        goto exit_unlock;
 538                }
 539                /* calibration resets profile */
 540                kone_profile_activated(kone, kone->settings.startup_profile);
 541        }
 542
 543        retval = size;
 544exit_no_settings:
 545        dev_err(&usb_dev->dev, "couldn't read settings\n");
 546exit_unlock:
 547        mutex_unlock(&kone->kone_lock);
 548        return retval;
 549}
 550static DEVICE_ATTR(tcu, 0660, kone_sysfs_show_tcu, kone_sysfs_set_tcu);
 551
 552static ssize_t kone_sysfs_show_startup_profile(struct device *dev,
 553                struct device_attribute *attr, char *buf)
 554{
 555        struct kone_device *kone =
 556                        hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
 557        return snprintf(buf, PAGE_SIZE, "%d\n", kone->settings.startup_profile);
 558}
 559
 560static ssize_t kone_sysfs_set_startup_profile(struct device *dev,
 561                struct device_attribute *attr, char const *buf, size_t size)
 562{
 563        struct kone_device *kone;
 564        struct usb_device *usb_dev;
 565        int retval;
 566        unsigned long new_startup_profile;
 567
 568        dev = dev->parent->parent;
 569        kone = hid_get_drvdata(dev_get_drvdata(dev));
 570        usb_dev = interface_to_usbdev(to_usb_interface(dev));
 571
 572        retval = kstrtoul(buf, 10, &new_startup_profile);
 573        if (retval)
 574                return retval;
 575
 576        if (new_startup_profile  < 1 || new_startup_profile > 5)
 577                return -EINVAL;
 578
 579        mutex_lock(&kone->kone_lock);
 580
 581        kone->settings.startup_profile = new_startup_profile;
 582        kone_set_settings_checksum(&kone->settings);
 583
 584        retval = kone_set_settings(usb_dev, &kone->settings);
 585        if (retval) {
 586                mutex_unlock(&kone->kone_lock);
 587                return retval;
 588        }
 589
 590        /* changing the startup profile immediately activates this profile */
 591        kone_profile_activated(kone, new_startup_profile);
 592        kone_profile_report(kone, new_startup_profile);
 593
 594        mutex_unlock(&kone->kone_lock);
 595        return size;
 596}
 597static DEVICE_ATTR(startup_profile, 0660, kone_sysfs_show_startup_profile,
 598                   kone_sysfs_set_startup_profile);
 599
 600static struct attribute *kone_attrs[] = {
 601        /*
 602         * Read actual dpi settings.
 603         * Returns raw value for further processing. Refer to enum
 604         * kone_polling_rates to get real value.
 605         */
 606        &dev_attr_actual_dpi.attr,
 607        &dev_attr_actual_profile.attr,
 608
 609        /*
 610         * The mouse can be equipped with one of four supplied weights from 5
 611         * to 20 grams which are recognized and its value can be read out.
 612         * This returns the raw value reported by the mouse for easy evaluation
 613         * by software. Refer to enum kone_weights to get corresponding real
 614         * weight.
 615         */
 616        &dev_attr_weight.attr,
 617
 618        /*
 619         * Prints firmware version stored in mouse as integer.
 620         * The raw value reported by the mouse is returned for easy evaluation,
 621         * to get the real version number the decimal point has to be shifted 2
 622         * positions to the left. E.g. a value of 138 means 1.38.
 623         */
 624        &dev_attr_firmware_version.attr,
 625
 626        /*
 627         * Prints state of Tracking Control Unit as number where 0 = off and
 628         * 1 = on. Writing 0 deactivates tcu and writing 1 calibrates and
 629         * activates the tcu
 630         */
 631        &dev_attr_tcu.attr,
 632
 633        /* Prints and takes the number of the profile the mouse starts with */
 634        &dev_attr_startup_profile.attr,
 635        NULL,
 636};
 637
 638static struct bin_attribute *kone_bin_attributes[] = {
 639        &bin_attr_settings,
 640        &bin_attr_profile1,
 641        &bin_attr_profile2,
 642        &bin_attr_profile3,
 643        &bin_attr_profile4,
 644        &bin_attr_profile5,
 645        NULL,
 646};
 647
 648static const struct attribute_group kone_group = {
 649        .attrs = kone_attrs,
 650        .bin_attrs = kone_bin_attributes,
 651};
 652
 653static const struct attribute_group *kone_groups[] = {
 654        &kone_group,
 655        NULL,
 656};
 657
 658static int kone_init_kone_device_struct(struct usb_device *usb_dev,
 659                struct kone_device *kone)
 660{
 661        uint i;
 662        int retval;
 663
 664        mutex_init(&kone->kone_lock);
 665
 666        for (i = 0; i < 5; ++i) {
 667                retval = kone_get_profile(usb_dev, &kone->profiles[i], i + 1);
 668                if (retval)
 669                        return retval;
 670        }
 671
 672        retval = kone_get_settings(usb_dev, &kone->settings);
 673        if (retval)
 674                return retval;
 675
 676        retval = kone_get_firmware_version(usb_dev, &kone->firmware_version);
 677        if (retval)
 678                return retval;
 679
 680        kone_profile_activated(kone, kone->settings.startup_profile);
 681
 682        return 0;
 683}
 684
 685/*
 686 * Since IGNORE_MOUSE quirk moved to hid-apple, there is no way to bind only to
 687 * mousepart if usb_hid is compiled into the kernel and kone is compiled as
 688 * module.
 689 * Secial behaviour is bound only to mousepart since only mouseevents contain
 690 * additional notifications.
 691 */
 692static int kone_init_specials(struct hid_device *hdev)
 693{
 694        struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
 695        struct usb_device *usb_dev = interface_to_usbdev(intf);
 696        struct kone_device *kone;
 697        int retval;
 698
 699        if (intf->cur_altsetting->desc.bInterfaceProtocol
 700                        == USB_INTERFACE_PROTOCOL_MOUSE) {
 701
 702                kone = kzalloc(sizeof(*kone), GFP_KERNEL);
 703                if (!kone)
 704                        return -ENOMEM;
 705                hid_set_drvdata(hdev, kone);
 706
 707                retval = kone_init_kone_device_struct(usb_dev, kone);
 708                if (retval) {
 709                        hid_err(hdev, "couldn't init struct kone_device\n");
 710                        goto exit_free;
 711                }
 712
 713                retval = roccat_connect(kone_class, hdev,
 714                                sizeof(struct kone_roccat_report));
 715                if (retval < 0) {
 716                        hid_err(hdev, "couldn't init char dev\n");
 717                        /* be tolerant about not getting chrdev */
 718                } else {
 719                        kone->roccat_claimed = 1;
 720                        kone->chrdev_minor = retval;
 721                }
 722        } else {
 723                hid_set_drvdata(hdev, NULL);
 724        }
 725
 726        return 0;
 727exit_free:
 728        kfree(kone);
 729        return retval;
 730}
 731
 732static void kone_remove_specials(struct hid_device *hdev)
 733{
 734        struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
 735        struct kone_device *kone;
 736
 737        if (intf->cur_altsetting->desc.bInterfaceProtocol
 738                        == USB_INTERFACE_PROTOCOL_MOUSE) {
 739                kone = hid_get_drvdata(hdev);
 740                if (kone->roccat_claimed)
 741                        roccat_disconnect(kone->chrdev_minor);
 742                kfree(hid_get_drvdata(hdev));
 743        }
 744}
 745
 746static int kone_probe(struct hid_device *hdev, const struct hid_device_id *id)
 747{
 748        int retval;
 749
 750        retval = hid_parse(hdev);
 751        if (retval) {
 752                hid_err(hdev, "parse failed\n");
 753                goto exit;
 754        }
 755
 756        retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
 757        if (retval) {
 758                hid_err(hdev, "hw start failed\n");
 759                goto exit;
 760        }
 761
 762        retval = kone_init_specials(hdev);
 763        if (retval) {
 764                hid_err(hdev, "couldn't install mouse\n");
 765                goto exit_stop;
 766        }
 767
 768        return 0;
 769
 770exit_stop:
 771        hid_hw_stop(hdev);
 772exit:
 773        return retval;
 774}
 775
 776static void kone_remove(struct hid_device *hdev)
 777{
 778        kone_remove_specials(hdev);
 779        hid_hw_stop(hdev);
 780}
 781
 782/* handle special events and keep actual profile and dpi values up to date */
 783static void kone_keep_values_up_to_date(struct kone_device *kone,
 784                struct kone_mouse_event const *event)
 785{
 786        switch (event->event) {
 787        case kone_mouse_event_switch_profile:
 788                kone->actual_dpi = kone->profiles[event->value - 1].
 789                                startup_dpi;
 790        case kone_mouse_event_osd_profile:
 791                kone->actual_profile = event->value;
 792                break;
 793        case kone_mouse_event_switch_dpi:
 794        case kone_mouse_event_osd_dpi:
 795                kone->actual_dpi = event->value;
 796                break;
 797        }
 798}
 799
 800static void kone_report_to_chrdev(struct kone_device const *kone,
 801                struct kone_mouse_event const *event)
 802{
 803        struct kone_roccat_report roccat_report;
 804
 805        switch (event->event) {
 806        case kone_mouse_event_switch_profile:
 807        case kone_mouse_event_switch_dpi:
 808        case kone_mouse_event_osd_profile:
 809        case kone_mouse_event_osd_dpi:
 810                roccat_report.event = event->event;
 811                roccat_report.value = event->value;
 812                roccat_report.key = 0;
 813                roccat_report_event(kone->chrdev_minor,
 814                                (uint8_t *)&roccat_report);
 815                break;
 816        case kone_mouse_event_call_overlong_macro:
 817        case kone_mouse_event_multimedia:
 818                if (event->value == kone_keystroke_action_press) {
 819                        roccat_report.event = event->event;
 820                        roccat_report.value = kone->actual_profile;
 821                        roccat_report.key = event->macro_key;
 822                        roccat_report_event(kone->chrdev_minor,
 823                                        (uint8_t *)&roccat_report);
 824                }
 825                break;
 826        }
 827
 828}
 829
 830/*
 831 * Is called for keyboard- and mousepart.
 832 * Only mousepart gets informations about special events in its extended event
 833 * structure.
 834 */
 835static int kone_raw_event(struct hid_device *hdev, struct hid_report *report,
 836                u8 *data, int size)
 837{
 838        struct kone_device *kone = hid_get_drvdata(hdev);
 839        struct kone_mouse_event *event = (struct kone_mouse_event *)data;
 840
 841        /* keyboard events are always processed by default handler */
 842        if (size != sizeof(struct kone_mouse_event))
 843                return 0;
 844
 845        if (kone == NULL)
 846                return 0;
 847
 848        /*
 849         * Firmware 1.38 introduced new behaviour for tilt and special buttons.
 850         * Pressed button is reported in each movement event.
 851         * Workaround sends only one event per press.
 852         */
 853        if (memcmp(&kone->last_mouse_event.tilt, &event->tilt, 5))
 854                memcpy(&kone->last_mouse_event, event,
 855                                sizeof(struct kone_mouse_event));
 856        else
 857                memset(&event->tilt, 0, 5);
 858
 859        kone_keep_values_up_to_date(kone, event);
 860
 861        if (kone->roccat_claimed)
 862                kone_report_to_chrdev(kone, event);
 863
 864        return 0; /* always do further processing */
 865}
 866
 867static const struct hid_device_id kone_devices[] = {
 868        { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_KONE) },
 869        { }
 870};
 871
 872MODULE_DEVICE_TABLE(hid, kone_devices);
 873
 874static struct hid_driver kone_driver = {
 875                .name = "kone",
 876                .id_table = kone_devices,
 877                .probe = kone_probe,
 878                .remove = kone_remove,
 879                .raw_event = kone_raw_event
 880};
 881
 882static int __init kone_init(void)
 883{
 884        int retval;
 885
 886        /* class name has to be same as driver name */
 887        kone_class = class_create(THIS_MODULE, "kone");
 888        if (IS_ERR(kone_class))
 889                return PTR_ERR(kone_class);
 890        kone_class->dev_groups = kone_groups;
 891
 892        retval = hid_register_driver(&kone_driver);
 893        if (retval)
 894                class_destroy(kone_class);
 895        return retval;
 896}
 897
 898static void __exit kone_exit(void)
 899{
 900        hid_unregister_driver(&kone_driver);
 901        class_destroy(kone_class);
 902}
 903
 904module_init(kone_init);
 905module_exit(kone_exit);
 906
 907MODULE_AUTHOR("Stefan Achatz");
 908MODULE_DESCRIPTION("USB Roccat Kone driver");
 909MODULE_LICENSE("GPL v2");
 910
lxr.linux.no kindly hosted by Redpill Linpro AS, provider of Linux consulting and operations services since 1995.