HID: roccat: cleanup of pyra module

Partially removed unneeded informations and data caching.
Moved code nearer to format of newer drivers.
Added "info" sysfs attribute to support device reset and deprecate
"firmware_version" attribute.

Signed-off-by: Stefan Achatz <erazor_de@users.sourceforge.net>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>

1 files changed, 144 insertions, 196 deletions

diff --git a/drivers/hid/hid-roccat-pyra.c b/drivers/hid/hid-roccat-pyra.c
index 1317c177a3e2..76199fa727ed 100644
--- a/drivers/hid/hid-roccat-pyra.c
+++ b/drivers/hid/hid-roccat-pyra.c
@@ -66,48 +66,14 @@ static int pyra_get_profile_settings(struct usb_device *usb_dev,
         if (retval)
                 return retval;
         return roccat_common2_receive(usb_dev, PYRA_COMMAND_PROFILE_SETTINGS,
-                        buf, sizeof(struct pyra_profile_settings));
-}
-
-static int pyra_get_profile_buttons(struct usb_device *usb_dev,
-                struct pyra_profile_buttons *buf, int number)
-{
-        int retval;
-        retval = pyra_send_control(usb_dev, number,
-                        PYRA_CONTROL_REQUEST_PROFILE_BUTTONS);
-        if (retval)
-                return retval;
-        return roccat_common2_receive(usb_dev, PYRA_COMMAND_PROFILE_BUTTONS,
-                        buf, sizeof(struct pyra_profile_buttons));
+                        buf, PYRA_SIZE_PROFILE_SETTINGS);
 }
 
 static int pyra_get_settings(struct usb_device *usb_dev,
                 struct pyra_settings *buf)
 {
         return roccat_common2_receive(usb_dev, PYRA_COMMAND_SETTINGS,
-                        buf, sizeof(struct pyra_settings));
-}
-
-static int pyra_get_info(struct usb_device *usb_dev, struct pyra_info *buf)
-{
-        return roccat_common2_receive(usb_dev, PYRA_COMMAND_INFO,
-                        buf, sizeof(struct pyra_info));
-}
-
-static int pyra_set_profile_settings(struct usb_device *usb_dev,
-                struct pyra_profile_settings const *settings)
-{
-        return roccat_common2_send_with_status(usb_dev,
-                        PYRA_COMMAND_PROFILE_SETTINGS, settings,
-                        sizeof(struct pyra_profile_settings));
-}
-
-static int pyra_set_profile_buttons(struct usb_device *usb_dev,
-                struct pyra_profile_buttons const *buttons)
-{
-        return roccat_common2_send_with_status(usb_dev,
-                        PYRA_COMMAND_PROFILE_BUTTONS, buttons,
-                        sizeof(struct pyra_profile_buttons));
+                        buf, PYRA_SIZE_SETTINGS);
 }
 
 static int pyra_set_settings(struct usb_device *usb_dev,
@@ -115,146 +81,143 @@ static int pyra_set_settings(struct usb_device *usb_dev,
 {
         return roccat_common2_send_with_status(usb_dev,
                         PYRA_COMMAND_SETTINGS, settings,
-                        sizeof(struct pyra_settings));
+                        PYRA_SIZE_SETTINGS);
 }
 
-static ssize_t pyra_sysfs_read_profilex_settings(struct file *fp,
-                struct kobject *kobj, struct bin_attribute *attr, char *buf,
-                loff_t off, size_t count)
+static ssize_t pyra_sysfs_read(struct file *fp, struct kobject *kobj,
+                char *buf, loff_t off, size_t count,
+                size_t real_size, uint command)
 {
         struct device *dev =
                         container_of(kobj, struct device, kobj)->parent->parent;
         struct pyra_device *pyra = hid_get_drvdata(dev_get_drvdata(dev));
+        struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
+        int retval;
 
-        if (off >= sizeof(struct pyra_profile_settings))
+        if (off >= real_size)
                 return 0;
 
-        if (off + count > sizeof(struct pyra_profile_settings))
-                count = sizeof(struct pyra_profile_settings) - off;
+        if (off != 0 || count != real_size)
+                return -EINVAL;
 
         mutex_lock(&pyra->pyra_lock);
-        memcpy(buf, ((char const *)&pyra->profile_settings[*(uint *)(attr->private)]) + off,
-                        count);
+        retval = roccat_common2_receive(usb_dev, command, buf, real_size);
         mutex_unlock(&pyra->pyra_lock);
 
-        return count;
+        if (retval)
+                return retval;
+
+        return real_size;
 }
 
-static ssize_t pyra_sysfs_read_profilex_buttons(struct file *fp,
-                struct kobject *kobj, struct bin_attribute *attr, char *buf,
-                loff_t off, size_t count)
+static ssize_t pyra_sysfs_write(struct file *fp, struct kobject *kobj,
+                void const *buf, loff_t off, size_t count,
+                size_t real_size, uint command)
 {
         struct device *dev =
                         container_of(kobj, struct device, kobj)->parent->parent;
         struct pyra_device *pyra = hid_get_drvdata(dev_get_drvdata(dev));
+        struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
+        int retval;
 
-        if (off >= sizeof(struct pyra_profile_buttons))
-                return 0;
-
-        if (off + count > sizeof(struct pyra_profile_buttons))
-                count = sizeof(struct pyra_profile_buttons) - off;
+        if (off != 0 || count != real_size)
+                return -EINVAL;
 
         mutex_lock(&pyra->pyra_lock);
-        memcpy(buf, ((char const *)&pyra->profile_buttons[*(uint *)(attr->private)]) + off,
-                        count);
+        retval = roccat_common2_send_with_status(usb_dev, command, (void *)buf, real_size);
         mutex_unlock(&pyra->pyra_lock);
 
-        return count;
+        if (retval)
+                return retval;
+
+        return real_size;
 }
 
-static ssize_t pyra_sysfs_write_profile_settings(struct file *fp,
-                struct kobject *kobj, struct bin_attribute *attr, char *buf,
-                loff_t off, size_t count)
-{
-        struct device *dev =
-                        container_of(kobj, struct device, kobj)->parent->parent;
-        struct pyra_device *pyra = hid_get_drvdata(dev_get_drvdata(dev));
-        struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
-        int retval = 0;
-        int difference;
-        int profile_number;
-        struct pyra_profile_settings *profile_settings;
+#define PYRA_SYSFS_W(thingy, THINGY) \
+static ssize_t pyra_sysfs_write_ ## thingy(struct file *fp, \
+                struct kobject *kobj, struct bin_attribute *attr, char *buf, \
+                loff_t off, size_t count) \
+{ \
+        return pyra_sysfs_write(fp, kobj, buf, off, count, \
+                        PYRA_SIZE_ ## THINGY, PYRA_COMMAND_ ## THINGY); \
+}
 
-        if (off != 0 || count != sizeof(struct pyra_profile_settings))
-                return -EINVAL;
+#define PYRA_SYSFS_R(thingy, THINGY) \
+static ssize_t pyra_sysfs_read_ ## thingy(struct file *fp, \
+                struct kobject *kobj, struct bin_attribute *attr, char *buf, \
+                loff_t off, size_t count) \
+{ \
+        return pyra_sysfs_read(fp, kobj, buf, off, count, \
+                        PYRA_SIZE_ ## THINGY, PYRA_COMMAND_ ## THINGY); \
+}
 
-        profile_number = ((struct pyra_profile_settings const *)buf)->number;
-        profile_settings = &pyra->profile_settings[profile_number];
+#define PYRA_SYSFS_RW(thingy, THINGY) \
+PYRA_SYSFS_W(thingy, THINGY) \
+PYRA_SYSFS_R(thingy, THINGY)
 
-        mutex_lock(&pyra->pyra_lock);
-        difference = memcmp(buf, profile_settings,
-                        sizeof(struct pyra_profile_settings));
-        if (difference) {
-                retval = pyra_set_profile_settings(usb_dev,
-                                (struct pyra_profile_settings const *)buf);
-                if (!retval)
-                        memcpy(profile_settings, buf,
-                                        sizeof(struct pyra_profile_settings));
-        }
-        mutex_unlock(&pyra->pyra_lock);
+#define PYRA_BIN_ATTRIBUTE_RW(thingy, THINGY) \
+{ \
+        .attr = { .name = #thingy, .mode = 0660 }, \
+        .size = PYRA_SIZE_ ## THINGY, \
+        .read = pyra_sysfs_read_ ## thingy, \
+        .write = pyra_sysfs_write_ ## thingy \
+}
 
-        if (retval)
-                return retval;
+#define PYRA_BIN_ATTRIBUTE_R(thingy, THINGY) \
+{ \
+        .attr = { .name = #thingy, .mode = 0440 }, \
+        .size = PYRA_SIZE_ ## THINGY, \
+        .read = pyra_sysfs_read_ ## thingy, \
+}
 
-        return sizeof(struct pyra_profile_settings);
+#define PYRA_BIN_ATTRIBUTE_W(thingy, THINGY) \
+{ \
+        .attr = { .name = #thingy, .mode = 0220 }, \
+        .size = PYRA_SIZE_ ## THINGY, \
+        .write = pyra_sysfs_write_ ## thingy \
 }
 
-static ssize_t pyra_sysfs_write_profile_buttons(struct file *fp,
+PYRA_SYSFS_RW(info, INFO)
+PYRA_SYSFS_W(profile_settings, PROFILE_SETTINGS)
+PYRA_SYSFS_W(profile_buttons, PROFILE_BUTTONS)
+PYRA_SYSFS_R(settings, SETTINGS)
+
+static ssize_t pyra_sysfs_read_profilex_settings(struct file *fp,
                 struct kobject *kobj, struct bin_attribute *attr, char *buf,
                 loff_t off, size_t count)
 {
         struct device *dev =
                         container_of(kobj, struct device, kobj)->parent->parent;
-        struct pyra_device *pyra = hid_get_drvdata(dev_get_drvdata(dev));
         struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
-        int retval = 0;
-        int difference;
-        int profile_number;
-        struct pyra_profile_buttons *profile_buttons;
-
-        if (off != 0 || count != sizeof(struct pyra_profile_buttons))
-                return -EINVAL;
-
-        profile_number = ((struct pyra_profile_buttons const *)buf)->number;
-        profile_buttons = &pyra->profile_buttons[profile_number];
-
-        mutex_lock(&pyra->pyra_lock);
-        difference = memcmp(buf, profile_buttons,
-                        sizeof(struct pyra_profile_buttons));
-        if (difference) {
-                retval = pyra_set_profile_buttons(usb_dev,
-                                (struct pyra_profile_buttons const *)buf);
-                if (!retval)
-                        memcpy(profile_buttons, buf,
-                                        sizeof(struct pyra_profile_buttons));
-        }
-        mutex_unlock(&pyra->pyra_lock);
+        ssize_t retval;
 
+        retval = pyra_send_control(usb_dev, *(uint *)(attr->private),
+                        PYRA_CONTROL_REQUEST_PROFILE_SETTINGS);
         if (retval)
                 return retval;
 
-        return sizeof(struct pyra_profile_buttons);
+        return pyra_sysfs_read(fp, kobj, buf, off, count,
+                        PYRA_SIZE_PROFILE_SETTINGS,
+                        PYRA_COMMAND_PROFILE_SETTINGS);
 }
 
-static ssize_t pyra_sysfs_read_settings(struct file *fp,
+static ssize_t pyra_sysfs_read_profilex_buttons(struct file *fp,
                 struct kobject *kobj, struct bin_attribute *attr, char *buf,
                 loff_t off, size_t count)
 {
         struct device *dev =
                         container_of(kobj, struct device, kobj)->parent->parent;
-        struct pyra_device *pyra = hid_get_drvdata(dev_get_drvdata(dev));
-
-        if (off >= sizeof(struct pyra_settings))
-                return 0;
-
-        if (off + count > sizeof(struct pyra_settings))
-                count = sizeof(struct pyra_settings) - off;
+        struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
+        ssize_t retval;
 
-        mutex_lock(&pyra->pyra_lock);
-        memcpy(buf, ((char const *)&pyra->settings) + off, count);
-        mutex_unlock(&pyra->pyra_lock);
+        retval = pyra_send_control(usb_dev, *(uint *)(attr->private),
+                        PYRA_CONTROL_REQUEST_PROFILE_BUTTONS);
+        if (retval)
+                return retval;
 
-        return count;
+        return pyra_sysfs_read(fp, kobj, buf, off, count,
+                        PYRA_SIZE_PROFILE_BUTTONS,
+                        PYRA_COMMAND_PROFILE_BUTTONS);
 }
 
 static ssize_t pyra_sysfs_write_settings(struct file *fp,
@@ -266,35 +229,32 @@ static ssize_t pyra_sysfs_write_settings(struct file *fp,
         struct pyra_device *pyra = hid_get_drvdata(dev_get_drvdata(dev));
         struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
         int retval = 0;
-        int difference;
         struct pyra_roccat_report roccat_report;
+        struct pyra_settings const *settings;
 
-        if (off != 0 || count != sizeof(struct pyra_settings))
+        if (off != 0 || count != PYRA_SIZE_SETTINGS)
                 return -EINVAL;
 
         mutex_lock(&pyra->pyra_lock);
-        difference = memcmp(buf, &pyra->settings, sizeof(struct pyra_settings));
-        if (difference) {
-                retval = pyra_set_settings(usb_dev,
-                                (struct pyra_settings const *)buf);
-                if (retval) {
-                        mutex_unlock(&pyra->pyra_lock);
-                        return retval;
-                }
-
-                memcpy(&pyra->settings, buf,
-                                sizeof(struct pyra_settings));
 
-                profile_activated(pyra, pyra->settings.startup_profile);
+        settings = (struct pyra_settings const *)buf;
 
-                roccat_report.type = PYRA_MOUSE_EVENT_BUTTON_TYPE_PROFILE_2;
-                roccat_report.value = pyra->settings.startup_profile + 1;
-                roccat_report.key = 0;
-                roccat_report_event(pyra->chrdev_minor,
-                                (uint8_t const *)&roccat_report);
+        retval = pyra_set_settings(usb_dev, settings);
+        if (retval) {
+                mutex_unlock(&pyra->pyra_lock);
+                return retval;
         }
+
+        profile_activated(pyra, settings->startup_profile);
+
+        roccat_report.type = PYRA_MOUSE_EVENT_BUTTON_TYPE_PROFILE_2;
+        roccat_report.value = settings->startup_profile + 1;
+        roccat_report.key = 0;
+        roccat_report_event(pyra->chrdev_minor,
+                        (uint8_t const *)&roccat_report);
+
         mutex_unlock(&pyra->pyra_lock);
-        return sizeof(struct pyra_settings);
+        return PYRA_SIZE_SETTINGS;
 }
 
 
@@ -311,23 +271,34 @@ static ssize_t pyra_sysfs_show_actual_profile(struct device *dev,
 {
         struct pyra_device *pyra =
                         hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
-        return snprintf(buf, PAGE_SIZE, "%d\n", pyra->actual_profile);
+        struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
+        struct pyra_settings settings;
+
+        mutex_lock(&pyra->pyra_lock);
+        roccat_common2_receive(usb_dev, PYRA_COMMAND_SETTINGS,
+                        &settings, PYRA_SIZE_SETTINGS);
+        mutex_unlock(&pyra->pyra_lock);
+
+        return snprintf(buf, PAGE_SIZE, "%d\n", settings.startup_profile);
 }
 
 static ssize_t pyra_sysfs_show_firmware_version(struct device *dev,
                 struct device_attribute *attr, char *buf)
 {
-        struct pyra_device *pyra =
-                        hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
-        return snprintf(buf, PAGE_SIZE, "%d\n", pyra->firmware_version);
-}
+        struct pyra_device *pyra;
+        struct usb_device *usb_dev;
+        struct pyra_info info;
 
-static ssize_t pyra_sysfs_show_startup_profile(struct device *dev,
-                struct device_attribute *attr, char *buf)
-{
-        struct pyra_device *pyra =
-                        hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
-        return snprintf(buf, PAGE_SIZE, "%d\n", pyra->settings.startup_profile);
+        dev = dev->parent->parent;
+        pyra = hid_get_drvdata(dev_get_drvdata(dev));
+        usb_dev = interface_to_usbdev(to_usb_interface(dev));
+
+        mutex_lock(&pyra->pyra_lock);
+        roccat_common2_receive(usb_dev, PYRA_COMMAND_INFO,
+                        &info, PYRA_SIZE_INFO);
+        mutex_unlock(&pyra->pyra_lock);
+
+        return snprintf(buf, PAGE_SIZE, "%d\n", info.firmware_version);
 }
 
 static struct device_attribute pyra_attributes[] = {
@@ -336,105 +307,87 @@ static struct device_attribute pyra_attributes[] = {
         __ATTR(firmware_version, 0440,
                         pyra_sysfs_show_firmware_version, NULL),
         __ATTR(startup_profile, 0440,
-                        pyra_sysfs_show_startup_profile, NULL),
+                        pyra_sysfs_show_actual_profile, NULL),
         __ATTR_NULL
 };
 
 static struct bin_attribute pyra_bin_attributes[] = {
-        {
-                .attr = { .name = "profile_settings", .mode = 0220 },
-                .size = sizeof(struct pyra_profile_settings),
-                .write = pyra_sysfs_write_profile_settings
-        },
+        PYRA_BIN_ATTRIBUTE_RW(info, INFO),
+        PYRA_BIN_ATTRIBUTE_W(profile_settings, PROFILE_SETTINGS),
+        PYRA_BIN_ATTRIBUTE_W(profile_buttons, PROFILE_BUTTONS),
+        PYRA_BIN_ATTRIBUTE_RW(settings, SETTINGS),
         {
                 .attr = { .name = "profile1_settings", .mode = 0440 },
-                .size = sizeof(struct pyra_profile_settings),
+                .size = PYRA_SIZE_PROFILE_SETTINGS,
                 .read = pyra_sysfs_read_profilex_settings,
                 .private = &profile_numbers[0]
         },
         {
                 .attr = { .name = "profile2_settings", .mode = 0440 },
-                .size = sizeof(struct pyra_profile_settings),
+                .size = PYRA_SIZE_PROFILE_SETTINGS,
                 .read = pyra_sysfs_read_profilex_settings,
                 .private = &profile_numbers[1]
         },
         {
                 .attr = { .name = "profile3_settings", .mode = 0440 },
-                .size = sizeof(struct pyra_profile_settings),
+                .size = PYRA_SIZE_PROFILE_SETTINGS,
                 .read = pyra_sysfs_read_profilex_settings,
                 .private = &profile_numbers[2]
         },
         {
                 .attr = { .name = "profile4_settings", .mode = 0440 },
-                .size = sizeof(struct pyra_profile_settings),
+                .size = PYRA_SIZE_PROFILE_SETTINGS,
                 .read = pyra_sysfs_read_profilex_settings,
                 .private = &profile_numbers[3]
         },
         {
                 .attr = { .name = "profile5_settings", .mode = 0440 },
-                .size = sizeof(struct pyra_profile_settings),
+                .size = PYRA_SIZE_PROFILE_SETTINGS,
                 .read = pyra_sysfs_read_profilex_settings,
                 .private = &profile_numbers[4]
         },
         {
-                .attr = { .name = "profile_buttons", .mode = 0220 },
-                .size = sizeof(struct pyra_profile_buttons),
-                .write = pyra_sysfs_write_profile_buttons
-        },
-        {
                 .attr = { .name = "profile1_buttons", .mode = 0440 },
-                .size = sizeof(struct pyra_profile_buttons),
+                .size = PYRA_SIZE_PROFILE_BUTTONS,
                 .read = pyra_sysfs_read_profilex_buttons,
                 .private = &profile_numbers[0]
         },
         {
                 .attr = { .name = "profile2_buttons", .mode = 0440 },
-                .size = sizeof(struct pyra_profile_buttons),
+                .size = PYRA_SIZE_PROFILE_BUTTONS,
                 .read = pyra_sysfs_read_profilex_buttons,
                 .private = &profile_numbers[1]
         },
         {
                 .attr = { .name = "profile3_buttons", .mode = 0440 },
-                .size = sizeof(struct pyra_profile_buttons),
+                .size = PYRA_SIZE_PROFILE_BUTTONS,
                 .read = pyra_sysfs_read_profilex_buttons,
                 .private = &profile_numbers[2]
         },
         {
                 .attr = { .name = "profile4_buttons", .mode = 0440 },
-                .size = sizeof(struct pyra_profile_buttons),
+                .size = PYRA_SIZE_PROFILE_BUTTONS,
                 .read = pyra_sysfs_read_profilex_buttons,
                 .private = &profile_numbers[3]
         },
         {
                 .attr = { .name = "profile5_buttons", .mode = 0440 },
-                .size = sizeof(struct pyra_profile_buttons),
+                .size = PYRA_SIZE_PROFILE_BUTTONS,
                 .read = pyra_sysfs_read_profilex_buttons,
                 .private = &profile_numbers[4]
         },
-        {
-                .attr = { .name = "settings", .mode = 0660 },
-                .size = sizeof(struct pyra_settings),
-                .read = pyra_sysfs_read_settings,
-                .write = pyra_sysfs_write_settings
-        },
         __ATTR_NULL
 };
 
 static int pyra_init_pyra_device_struct(struct usb_device *usb_dev,
                 struct pyra_device *pyra)
 {
-        struct pyra_info info;
+        struct pyra_settings settings;
         int retval, i;
 
         mutex_init(&pyra->pyra_lock);
 
-        retval = pyra_get_info(usb_dev, &info);
-        if (retval)
-                return retval;
-
-        pyra->firmware_version = info.firmware_version;
-
-        retval = pyra_get_settings(usb_dev, &pyra->settings);
+        retval = pyra_get_settings(usb_dev, &settings);
         if (retval)
                 return retval;
 
@@ -443,14 +396,9 @@ static int pyra_init_pyra_device_struct(struct usb_device *usb_dev,
                                 &pyra->profile_settings[i], i);
                 if (retval)
                         return retval;
-
-                retval = pyra_get_profile_buttons(usb_dev,
-                                &pyra->profile_buttons[i], i);
-                if (retval)
-                        return retval;
         }
 
-        profile_activated(pyra, pyra->settings.startup_profile);
+        profile_activated(pyra, settings.startup_profile);
 
         return 0;
 }