/*

   *  HID driver for Lenovo:
   *  - ThinkPad USB Keyboard with TrackPoint (tpkbd)

   *  - ThinkPad Compact Bluetooth Keyboard with TrackPoint (cptkbd)
   *  - ThinkPad Compact USB Keyboard with TrackPoint (cptkbd)

   *
   *  Copyright (c) 2012 Bernhard Seibold

   *  Copyright (c) 2014 Jamie Lentin <jm@lentin.co.uk>

   *
   * Linux IBM/Lenovo Scrollpoint mouse driver:
   * - IBM Scrollpoint III
   * - IBM Scrollpoint Pro
   * - IBM Scrollpoint Optical
   * - IBM Scrollpoint Optical 800dpi
   * - IBM Scrollpoint Optical 800dpi Pro
   * - Lenovo Scrollpoint Optical
   *
   *  Copyright (c) 2012 Peter De Wachter <pdewacht@gmail.com>
   *  Copyright (c) 2018 Peter Ganzhorn <peter.ganzhorn@gmail.com>

   */
  
  /*
   * This program is free software; you can redistribute it and/or modify it
   * under the terms of the GNU General Public License as published by the Free
   * Software Foundation; either version 2 of the License, or (at your option)
   * any later version.
   */
  
  #include <linux/module.h>
  #include <linux/sysfs.h>
  #include <linux/device.h>

  #include <linux/hid.h>
  #include <linux/input.h>
  #include <linux/leds.h>

  
  #include "hid-ids.h"

  struct lenovo_drvdata_tpkbd {

  	int led_state;
  	struct led_classdev led_mute;
  	struct led_classdev led_micmute;
  	int press_to_select;
  	int dragging;
  	int release_to_select;
  	int select_right;
  	int sensitivity;
  	int press_speed;
  };

  struct lenovo_drvdata_cptkbd {

  	u8 middlebutton_state; /* 0:Up, 1:Down (undecided), 2:Scrolling */

  	bool fn_lock;

  	int sensitivity;

  };

  #define map_key_clear(c) hid_map_usage_clear(hi, usage, bit, max, EV_KEY, (c))

  static const __u8 lenovo_pro_dock_need_fixup_collection[] = {
  	0x05, 0x88,		/* Usage Page (Vendor Usage Page 0x88)	*/
  	0x09, 0x01,		/* Usage (Vendor Usage 0x01)		*/
  	0xa1, 0x01,		/* Collection (Application)		*/
  	0x85, 0x04,		/*  Report ID (4)			*/
  	0x19, 0x00,		/*  Usage Minimum (0)			*/
  	0x2a, 0xff, 0xff,	/*  Usage Maximum (65535)		*/
  };
  
  static __u8 *lenovo_report_fixup(struct hid_device *hdev, __u8 *rdesc,
  		unsigned int *rsize)
  {
  	switch (hdev->product) {
  	case USB_DEVICE_ID_LENOVO_TPPRODOCK:
  		/* the fixups that need to be done:
  		 *   - get a reasonable usage max for the vendor collection
  		 *     0x8801 from the report ID 4
  		 */
  		if (*rsize >= 153 &&
  		    memcmp(&rdesc[140], lenovo_pro_dock_need_fixup_collection,
  			  sizeof(lenovo_pro_dock_need_fixup_collection)) == 0) {
  			rdesc[151] = 0x01;
  			rdesc[152] = 0x00;
  		}
  		break;
  	}
  	return rdesc;
  }

  static int lenovo_input_mapping_tpkbd(struct hid_device *hdev,

  		struct hid_input *hi, struct hid_field *field,
  		struct hid_usage *usage, unsigned long **bit, int *max)
  {

  	if (usage->hid == (HID_UP_BUTTON | 0x0010)) {

  		/* This sub-device contains trackpoint, mark it */

  		hid_set_drvdata(hdev, (void *)1);

  		map_key_clear(KEY_MICMUTE);
  		return 1;
  	}
  	return 0;
  }

  static int lenovo_input_mapping_cptkbd(struct hid_device *hdev,
  		struct hid_input *hi, struct hid_field *field,
  		struct hid_usage *usage, unsigned long **bit, int *max)
  {
  	/* HID_UP_LNVENDOR = USB, HID_UP_MSVENDOR = BT */
  	if ((usage->hid & HID_USAGE_PAGE) == HID_UP_MSVENDOR ||
  	    (usage->hid & HID_USAGE_PAGE) == HID_UP_LNVENDOR) {

  		switch (usage->hid & HID_USAGE) {
  		case 0x00f1: /* Fn-F4: Mic mute */
  			map_key_clear(KEY_MICMUTE);
  			return 1;
  		case 0x00f2: /* Fn-F5: Brightness down */
  			map_key_clear(KEY_BRIGHTNESSDOWN);
  			return 1;
  		case 0x00f3: /* Fn-F6: Brightness up */
  			map_key_clear(KEY_BRIGHTNESSUP);
  			return 1;
  		case 0x00f4: /* Fn-F7: External display (projector) */
  			map_key_clear(KEY_SWITCHVIDEOMODE);
  			return 1;
  		case 0x00f5: /* Fn-F8: Wireless */
  			map_key_clear(KEY_WLAN);
  			return 1;
  		case 0x00f6: /* Fn-F9: Control panel */
  			map_key_clear(KEY_CONFIG);
  			return 1;
  		case 0x00f8: /* Fn-F11: View open applications (3 boxes) */
  			map_key_clear(KEY_SCALE);
  			return 1;

  		case 0x00f9: /* Fn-F12: Open My computer (6 boxes) USB-only */

  			/* NB: This mapping is invented in raw_event below */
  			map_key_clear(KEY_FILE);
  			return 1;

  		case 0x00fa: /* Fn-Esc: Fn-lock toggle */
  			map_key_clear(KEY_FN_ESC);
  			return 1;

  		case 0x00fb: /* Middle mouse button (in native mode) */
  			map_key_clear(BTN_MIDDLE);
  			return 1;
  		}
  	}
  
  	/* Compatibility middle/wheel mappings should be ignored */
  	if (usage->hid == HID_GD_WHEEL)
  		return -1;
  	if ((usage->hid & HID_USAGE_PAGE) == HID_UP_BUTTON &&
  			(usage->hid & HID_USAGE) == 0x003)
  		return -1;
  	if ((usage->hid & HID_USAGE_PAGE) == HID_UP_CONSUMER &&
  			(usage->hid & HID_USAGE) == 0x238)
  		return -1;
  
  	/* Map wheel emulation reports: 0xffa1 = USB, 0xff10 = BT */
  	if ((usage->hid & HID_USAGE_PAGE) == 0xff100000 ||
  	    (usage->hid & HID_USAGE_PAGE) == 0xffa10000) {
  		field->flags |= HID_MAIN_ITEM_RELATIVE | HID_MAIN_ITEM_VARIABLE;
  		field->logical_minimum = -127;
  		field->logical_maximum = 127;
  
  		switch (usage->hid & HID_USAGE) {
  		case 0x0000:

  			hid_map_usage(hi, usage, bit, max, EV_REL, REL_HWHEEL);

  			return 1;
  		case 0x0001:

  			hid_map_usage(hi, usage, bit, max, EV_REL, REL_WHEEL);

  			return 1;
  		default:
  			return -1;

  		}
  	}
  
  	return 0;
  }

  static int lenovo_input_mapping_scrollpoint(struct hid_device *hdev,
  		struct hid_input *hi, struct hid_field *field,
  		struct hid_usage *usage, unsigned long **bit, int *max)
  {
  	if (usage->hid == HID_GD_Z) {
  		hid_map_usage(hi, usage, bit, max, EV_REL, REL_HWHEEL);
  		return 1;
  	}
  	return 0;
  }

  static int lenovo_input_mapping(struct hid_device *hdev,
  		struct hid_input *hi, struct hid_field *field,
  		struct hid_usage *usage, unsigned long **bit, int *max)
  {
  	switch (hdev->product) {
  	case USB_DEVICE_ID_LENOVO_TPKBD:
  		return lenovo_input_mapping_tpkbd(hdev, hi, field,
  							usage, bit, max);

  	case USB_DEVICE_ID_LENOVO_CUSBKBD:
  	case USB_DEVICE_ID_LENOVO_CBTKBD:
  		return lenovo_input_mapping_cptkbd(hdev, hi, field,
  							usage, bit, max);

  	case USB_DEVICE_ID_IBM_SCROLLPOINT_III:
  	case USB_DEVICE_ID_IBM_SCROLLPOINT_PRO:
  	case USB_DEVICE_ID_IBM_SCROLLPOINT_OPTICAL:
  	case USB_DEVICE_ID_IBM_SCROLLPOINT_800DPI_OPTICAL:
  	case USB_DEVICE_ID_IBM_SCROLLPOINT_800DPI_OPTICAL_PRO:
  	case USB_DEVICE_ID_LENOVO_SCROLLPOINT_OPTICAL:
  		return lenovo_input_mapping_scrollpoint(hdev, hi, field,
  							usage, bit, max);

  	default:
  		return 0;
  	}
  }

  #undef map_key_clear

  /* Send a config command to the keyboard */
  static int lenovo_send_cmd_cptkbd(struct hid_device *hdev,
  			unsigned char byte2, unsigned char byte3)
  {
  	int ret;

  	unsigned char *buf;
  
  	buf = kzalloc(3, GFP_KERNEL);
  	if (!buf)
  		return -ENOMEM;
  
  	buf[0] = 0x18;
  	buf[1] = byte2;
  	buf[2] = byte3;

  
  	switch (hdev->product) {
  	case USB_DEVICE_ID_LENOVO_CUSBKBD:

  		ret = hid_hw_raw_request(hdev, 0x13, buf, 3,

  					HID_FEATURE_REPORT, HID_REQ_SET_REPORT);
  		break;
  	case USB_DEVICE_ID_LENOVO_CBTKBD:

  		ret = hid_hw_output_report(hdev, buf, 3);

  		break;
  	default:
  		ret = -EINVAL;
  		break;
  	}

  	kfree(buf);

  	return ret < 0 ? ret : 0; /* BT returns 0, USB returns sizeof(buf) */
  }
  
  static void lenovo_features_set_cptkbd(struct hid_device *hdev)
  {
  	int ret;
  	struct lenovo_drvdata_cptkbd *cptkbd_data = hid_get_drvdata(hdev);
  
  	ret = lenovo_send_cmd_cptkbd(hdev, 0x05, cptkbd_data->fn_lock);
  	if (ret)
  		hid_err(hdev, "Fn-lock setting failed: %d
  ", ret);

  
  	ret = lenovo_send_cmd_cptkbd(hdev, 0x02, cptkbd_data->sensitivity);
  	if (ret)
  		hid_err(hdev, "Sensitivity setting failed: %d
  ", ret);

  }
  
  static ssize_t attr_fn_lock_show_cptkbd(struct device *dev,
  		struct device_attribute *attr,
  		char *buf)
  {

  	struct hid_device *hdev = to_hid_device(dev);

  	struct lenovo_drvdata_cptkbd *cptkbd_data = hid_get_drvdata(hdev);
  
  	return snprintf(buf, PAGE_SIZE, "%u
  ", cptkbd_data->fn_lock);
  }
  
  static ssize_t attr_fn_lock_store_cptkbd(struct device *dev,
  		struct device_attribute *attr,
  		const char *buf,
  		size_t count)
  {

  	struct hid_device *hdev = to_hid_device(dev);

  	struct lenovo_drvdata_cptkbd *cptkbd_data = hid_get_drvdata(hdev);
  	int value;
  
  	if (kstrtoint(buf, 10, &value))
  		return -EINVAL;
  	if (value < 0 || value > 1)
  		return -EINVAL;
  
  	cptkbd_data->fn_lock = !!value;
  	lenovo_features_set_cptkbd(hdev);
  
  	return count;
  }

  static ssize_t attr_sensitivity_show_cptkbd(struct device *dev,
  		struct device_attribute *attr,
  		char *buf)
  {

  	struct hid_device *hdev = to_hid_device(dev);

  	struct lenovo_drvdata_cptkbd *cptkbd_data = hid_get_drvdata(hdev);
  
  	return snprintf(buf, PAGE_SIZE, "%u
  ",
  		cptkbd_data->sensitivity);
  }
  
  static ssize_t attr_sensitivity_store_cptkbd(struct device *dev,
  		struct device_attribute *attr,
  		const char *buf,
  		size_t count)
  {

  	struct hid_device *hdev = to_hid_device(dev);

  	struct lenovo_drvdata_cptkbd *cptkbd_data = hid_get_drvdata(hdev);
  	int value;
  
  	if (kstrtoint(buf, 10, &value) || value < 1 || value > 255)
  		return -EINVAL;
  
  	cptkbd_data->sensitivity = value;
  	lenovo_features_set_cptkbd(hdev);
  
  	return count;
  }

  static struct device_attribute dev_attr_fn_lock_cptkbd =
  	__ATTR(fn_lock, S_IWUSR | S_IRUGO,
  			attr_fn_lock_show_cptkbd,
  			attr_fn_lock_store_cptkbd);

  static struct device_attribute dev_attr_sensitivity_cptkbd =
  	__ATTR(sensitivity, S_IWUSR | S_IRUGO,
  			attr_sensitivity_show_cptkbd,
  			attr_sensitivity_store_cptkbd);

  static struct attribute *lenovo_attributes_cptkbd[] = {
  	&dev_attr_fn_lock_cptkbd.attr,

  	&dev_attr_sensitivity_cptkbd.attr,

  	NULL
  };
  
  static const struct attribute_group lenovo_attr_group_cptkbd = {
  	.attrs = lenovo_attributes_cptkbd,
  };
  
  static int lenovo_raw_event(struct hid_device *hdev,
  			struct hid_report *report, u8 *data, int size)
  {
  	/*
  	 * Compact USB keyboard's Fn-F12 report holds down many other keys, and
  	 * its own key is outside the usage page range. Remove extra
  	 * keypresses and remap to inside usage page.
  	 */
  	if (unlikely(hdev->product == USB_DEVICE_ID_LENOVO_CUSBKBD
  			&& size == 3
  			&& data[0] == 0x15
  			&& data[1] == 0x94
  			&& data[2] == 0x01)) {

  		data[1] = 0x00;
  		data[2] = 0x01;

  	}
  
  	return 0;
  }

  static int lenovo_event_cptkbd(struct hid_device *hdev,
  		struct hid_field *field, struct hid_usage *usage, __s32 value)
  {
  	struct lenovo_drvdata_cptkbd *cptkbd_data = hid_get_drvdata(hdev);
  
  	/* "wheel" scroll events */
  	if (usage->type == EV_REL && (usage->code == REL_WHEEL ||
  			usage->code == REL_HWHEEL)) {
  		/* Scroll events disable middle-click event */
  		cptkbd_data->middlebutton_state = 2;
  		return 0;
  	}
  
  	/* Middle click events */
  	if (usage->type == EV_KEY && usage->code == BTN_MIDDLE) {
  		if (value == 1) {
  			cptkbd_data->middlebutton_state = 1;
  		} else if (value == 0) {
  			if (cptkbd_data->middlebutton_state == 1) {
  				/* No scrolling inbetween, send middle-click */
  				input_event(field->hidinput->input,
  					EV_KEY, BTN_MIDDLE, 1);
  				input_sync(field->hidinput->input);
  				input_event(field->hidinput->input,
  					EV_KEY, BTN_MIDDLE, 0);
  				input_sync(field->hidinput->input);
  			}
  			cptkbd_data->middlebutton_state = 0;
  		}
  		return 1;
  	}
  
  	return 0;
  }
  
  static int lenovo_event(struct hid_device *hdev, struct hid_field *field,
  		struct hid_usage *usage, __s32 value)
  {
  	switch (hdev->product) {
  	case USB_DEVICE_ID_LENOVO_CUSBKBD:
  	case USB_DEVICE_ID_LENOVO_CBTKBD:
  		return lenovo_event_cptkbd(hdev, field, usage, value);
  	default:
  		return 0;
  	}
  }

  static int lenovo_features_set_tpkbd(struct hid_device *hdev)

  {
  	struct hid_report *report;

  	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);

  	report = hdev->report_enum[HID_FEATURE_REPORT].report_id_hash[4];
  
  	report->field[0]->value[0]  = data_pointer->press_to_select   ? 0x01 : 0x02;
  	report->field[0]->value[0] |= data_pointer->dragging          ? 0x04 : 0x08;
  	report->field[0]->value[0] |= data_pointer->release_to_select ? 0x10 : 0x20;
  	report->field[0]->value[0] |= data_pointer->select_right      ? 0x80 : 0x40;
  	report->field[1]->value[0] = 0x03; // unknown setting, imitate windows driver
  	report->field[2]->value[0] = data_pointer->sensitivity;
  	report->field[3]->value[0] = data_pointer->press_speed;

  	hid_hw_request(hdev, report, HID_REQ_SET_REPORT);

  	return 0;
  }

  static ssize_t attr_press_to_select_show_tpkbd(struct device *dev,

  		struct device_attribute *attr,
  		char *buf)
  {

  	struct hid_device *hdev = to_hid_device(dev);

  	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);

  
  	return snprintf(buf, PAGE_SIZE, "%u
  ", data_pointer->press_to_select);
  }

  static ssize_t attr_press_to_select_store_tpkbd(struct device *dev,

  		struct device_attribute *attr,
  		const char *buf,
  		size_t count)
  {

  	struct hid_device *hdev = to_hid_device(dev);

  	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);

  	int value;

  	if (kstrtoint(buf, 10, &value))
  		return -EINVAL;
  	if (value < 0 || value > 1)
  		return -EINVAL;
  
  	data_pointer->press_to_select = value;

  	lenovo_features_set_tpkbd(hdev);

  
  	return count;
  }

  static ssize_t attr_dragging_show_tpkbd(struct device *dev,

  		struct device_attribute *attr,
  		char *buf)
  {

  	struct hid_device *hdev = to_hid_device(dev);

  	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);

  
  	return snprintf(buf, PAGE_SIZE, "%u
  ", data_pointer->dragging);
  }

  static ssize_t attr_dragging_store_tpkbd(struct device *dev,

  		struct device_attribute *attr,
  		const char *buf,
  		size_t count)
  {

  	struct hid_device *hdev = to_hid_device(dev);

  	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);

  	int value;

  	if (kstrtoint(buf, 10, &value))
  		return -EINVAL;
  	if (value < 0 || value > 1)
  		return -EINVAL;
  
  	data_pointer->dragging = value;

  	lenovo_features_set_tpkbd(hdev);

  
  	return count;
  }

  static ssize_t attr_release_to_select_show_tpkbd(struct device *dev,

  		struct device_attribute *attr,
  		char *buf)
  {

  	struct hid_device *hdev = to_hid_device(dev);

  	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);

  
  	return snprintf(buf, PAGE_SIZE, "%u
  ", data_pointer->release_to_select);
  }

  static ssize_t attr_release_to_select_store_tpkbd(struct device *dev,

  		struct device_attribute *attr,
  		const char *buf,
  		size_t count)
  {

  	struct hid_device *hdev = to_hid_device(dev);

  	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);

  	int value;

  	if (kstrtoint(buf, 10, &value))
  		return -EINVAL;
  	if (value < 0 || value > 1)
  		return -EINVAL;
  
  	data_pointer->release_to_select = value;

  	lenovo_features_set_tpkbd(hdev);

  
  	return count;
  }

  static ssize_t attr_select_right_show_tpkbd(struct device *dev,

  		struct device_attribute *attr,
  		char *buf)
  {

  	struct hid_device *hdev = to_hid_device(dev);

  	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);

  
  	return snprintf(buf, PAGE_SIZE, "%u
  ", data_pointer->select_right);
  }

  static ssize_t attr_select_right_store_tpkbd(struct device *dev,

  		struct device_attribute *attr,
  		const char *buf,
  		size_t count)
  {

  	struct hid_device *hdev = to_hid_device(dev);

  	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);

  	int value;

  	if (kstrtoint(buf, 10, &value))
  		return -EINVAL;
  	if (value < 0 || value > 1)
  		return -EINVAL;
  
  	data_pointer->select_right = value;

  	lenovo_features_set_tpkbd(hdev);

  
  	return count;
  }

  static ssize_t attr_sensitivity_show_tpkbd(struct device *dev,

  		struct device_attribute *attr,
  		char *buf)
  {

  	struct hid_device *hdev = to_hid_device(dev);

  	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);

  
  	return snprintf(buf, PAGE_SIZE, "%u
  ",
  		data_pointer->sensitivity);
  }

  static ssize_t attr_sensitivity_store_tpkbd(struct device *dev,

  		struct device_attribute *attr,
  		const char *buf,
  		size_t count)
  {

  	struct hid_device *hdev = to_hid_device(dev);

  	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);

  	int value;

  	if (kstrtoint(buf, 10, &value) || value < 1 || value > 255)
  		return -EINVAL;
  
  	data_pointer->sensitivity = value;

  	lenovo_features_set_tpkbd(hdev);

  
  	return count;
  }

  static ssize_t attr_press_speed_show_tpkbd(struct device *dev,

  		struct device_attribute *attr,
  		char *buf)
  {

  	struct hid_device *hdev = to_hid_device(dev);

  	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);

  	return snprintf(buf, PAGE_SIZE, "%u
  ",
  		data_pointer->press_speed);
  }

  static ssize_t attr_press_speed_store_tpkbd(struct device *dev,

  		struct device_attribute *attr,
  		const char *buf,
  		size_t count)
  {

  	struct hid_device *hdev = to_hid_device(dev);

  	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);

  	int value;

  	if (kstrtoint(buf, 10, &value) || value < 1 || value > 255)
  		return -EINVAL;
  
  	data_pointer->press_speed = value;

  	lenovo_features_set_tpkbd(hdev);

  
  	return count;
  }

  static struct device_attribute dev_attr_press_to_select_tpkbd =

  	__ATTR(press_to_select, S_IWUSR | S_IRUGO,

  			attr_press_to_select_show_tpkbd,
  			attr_press_to_select_store_tpkbd);

  static struct device_attribute dev_attr_dragging_tpkbd =

  	__ATTR(dragging, S_IWUSR | S_IRUGO,

  			attr_dragging_show_tpkbd,
  			attr_dragging_store_tpkbd);

  static struct device_attribute dev_attr_release_to_select_tpkbd =

  	__ATTR(release_to_select, S_IWUSR | S_IRUGO,

  			attr_release_to_select_show_tpkbd,
  			attr_release_to_select_store_tpkbd);

  static struct device_attribute dev_attr_select_right_tpkbd =

  	__ATTR(select_right, S_IWUSR | S_IRUGO,

  			attr_select_right_show_tpkbd,
  			attr_select_right_store_tpkbd);

  static struct device_attribute dev_attr_sensitivity_tpkbd =

  	__ATTR(sensitivity, S_IWUSR | S_IRUGO,

  			attr_sensitivity_show_tpkbd,
  			attr_sensitivity_store_tpkbd);

  static struct device_attribute dev_attr_press_speed_tpkbd =

  	__ATTR(press_speed, S_IWUSR | S_IRUGO,

  			attr_press_speed_show_tpkbd,
  			attr_press_speed_store_tpkbd);
  
  static struct attribute *lenovo_attributes_tpkbd[] = {
  	&dev_attr_press_to_select_tpkbd.attr,
  	&dev_attr_dragging_tpkbd.attr,
  	&dev_attr_release_to_select_tpkbd.attr,
  	&dev_attr_select_right_tpkbd.attr,
  	&dev_attr_sensitivity_tpkbd.attr,
  	&dev_attr_press_speed_tpkbd.attr,

  	NULL
  };

  static const struct attribute_group lenovo_attr_group_tpkbd = {
  	.attrs = lenovo_attributes_tpkbd,

  };

  static enum led_brightness lenovo_led_brightness_get_tpkbd(

  			struct led_classdev *led_cdev)
  {

  	struct device *dev = led_cdev->dev->parent;

  	struct hid_device *hdev = to_hid_device(dev);

  	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);

  	int led_nr = 0;

  	if (led_cdev == &data_pointer->led_micmute)
  		led_nr = 1;
  
  	return data_pointer->led_state & (1 << led_nr)
  				? LED_FULL
  				: LED_OFF;
  }

  static void lenovo_led_brightness_set_tpkbd(struct led_classdev *led_cdev,

  			enum led_brightness value)
  {

  	struct device *dev = led_cdev->dev->parent;

  	struct hid_device *hdev = to_hid_device(dev);

  	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);

  	struct hid_report *report;

  	int led_nr = 0;

  	if (led_cdev == &data_pointer->led_micmute)
  		led_nr = 1;
  
  	if (value == LED_OFF)
  		data_pointer->led_state &= ~(1 << led_nr);
  	else
  		data_pointer->led_state |= 1 << led_nr;
  
  	report = hdev->report_enum[HID_OUTPUT_REPORT].report_id_hash[3];
  	report->field[0]->value[0] = (data_pointer->led_state >> 0) & 1;
  	report->field[0]->value[1] = (data_pointer->led_state >> 1) & 1;

  	hid_hw_request(hdev, report, HID_REQ_SET_REPORT);

  }

  static int lenovo_probe_tpkbd(struct hid_device *hdev)

  {
  	struct device *dev = &hdev->dev;

  	struct lenovo_drvdata_tpkbd *data_pointer;

  	size_t name_sz = strlen(dev_name(dev)) + 16;
  	char *name_mute, *name_micmute;

  	int i;

  	int ret;

  	/*
  	 * Only register extra settings against subdevice where input_mapping
  	 * set drvdata to 1, i.e. the trackpoint.
  	 */
  	if (!hid_get_drvdata(hdev))
  		return 0;
  
  	hid_set_drvdata(hdev, NULL);

  	/* Validate required reports. */
  	for (i = 0; i < 4; i++) {
  		if (!hid_validate_values(hdev, HID_FEATURE_REPORT, 4, i, 1))
  			return -ENODEV;
  	}
  	if (!hid_validate_values(hdev, HID_OUTPUT_REPORT, 3, 0, 2))
  		return -ENODEV;

  	ret = sysfs_create_group(&hdev->dev.kobj, &lenovo_attr_group_tpkbd);
  	if (ret)
  		hid_warn(hdev, "Could not create sysfs group: %d
  ", ret);

  	data_pointer = devm_kzalloc(&hdev->dev,

  				    sizeof(struct lenovo_drvdata_tpkbd),

  				    GFP_KERNEL);

  	if (data_pointer == NULL) {
  		hid_err(hdev, "Could not allocate memory for driver data
  ");

  		ret = -ENOMEM;
  		goto err;

  	}
  
  	// set same default values as windows driver
  	data_pointer->sensitivity = 0xa0;
  	data_pointer->press_speed = 0x38;

  	name_mute = devm_kzalloc(&hdev->dev, name_sz, GFP_KERNEL);
  	name_micmute = devm_kzalloc(&hdev->dev, name_sz, GFP_KERNEL);
  	if (name_mute == NULL || name_micmute == NULL) {

  		hid_err(hdev, "Could not allocate memory for led data
  ");

  		ret = -ENOMEM;
  		goto err;

  	}
  	snprintf(name_mute, name_sz, "%s:amber:mute", dev_name(dev));

  	snprintf(name_micmute, name_sz, "%s:amber:micmute", dev_name(dev));
  
  	hid_set_drvdata(hdev, data_pointer);
  
  	data_pointer->led_mute.name = name_mute;

  	data_pointer->led_mute.brightness_get = lenovo_led_brightness_get_tpkbd;
  	data_pointer->led_mute.brightness_set = lenovo_led_brightness_set_tpkbd;

  	data_pointer->led_mute.dev = dev;
  	led_classdev_register(dev, &data_pointer->led_mute);
  
  	data_pointer->led_micmute.name = name_micmute;

  	data_pointer->led_micmute.brightness_get =
  		lenovo_led_brightness_get_tpkbd;
  	data_pointer->led_micmute.brightness_set =
  		lenovo_led_brightness_set_tpkbd;

  	data_pointer->led_micmute.dev = dev;
  	led_classdev_register(dev, &data_pointer->led_micmute);

  	lenovo_features_set_tpkbd(hdev);

  
  	return 0;

  err:
  	sysfs_remove_group(&hdev->dev.kobj, &lenovo_attr_group_tpkbd);
  	return ret;

  }

  static int lenovo_probe_cptkbd(struct hid_device *hdev)
  {
  	int ret;
  	struct lenovo_drvdata_cptkbd *cptkbd_data;
  
  	/* All the custom action happens on the USBMOUSE device for USB */
  	if (hdev->product == USB_DEVICE_ID_LENOVO_CUSBKBD
  			&& hdev->type != HID_TYPE_USBMOUSE) {
  		hid_dbg(hdev, "Ignoring keyboard half of device
  ");
  		return 0;
  	}
  
  	cptkbd_data = devm_kzalloc(&hdev->dev,
  					sizeof(*cptkbd_data),
  					GFP_KERNEL);
  	if (cptkbd_data == NULL) {
  		hid_err(hdev, "can't alloc keyboard descriptor
  ");
  		return -ENOMEM;
  	}
  	hid_set_drvdata(hdev, cptkbd_data);
  
  	/*
  	 * Tell the keyboard a driver understands it, and turn F7, F9, F11 into
  	 * regular keys
  	 */
  	ret = lenovo_send_cmd_cptkbd(hdev, 0x01, 0x03);
  	if (ret)
  		hid_warn(hdev, "Failed to switch F7/9/11 mode: %d
  ", ret);

  	/* Switch middle button to native mode */
  	ret = lenovo_send_cmd_cptkbd(hdev, 0x09, 0x01);
  	if (ret)
  		hid_warn(hdev, "Failed to switch middle button: %d
  ", ret);

  	/* Set keyboard settings to known state */

  	cptkbd_data->middlebutton_state = 0;

  	cptkbd_data->fn_lock = true;

  	cptkbd_data->sensitivity = 0x05;

  	lenovo_features_set_cptkbd(hdev);
  
  	ret = sysfs_create_group(&hdev->dev.kobj, &lenovo_attr_group_cptkbd);
  	if (ret)
  		hid_warn(hdev, "Could not create sysfs group: %d
  ", ret);
  
  	return 0;
  }

  static int lenovo_probe(struct hid_device *hdev,

  		const struct hid_device_id *id)
  {
  	int ret;

  
  	ret = hid_parse(hdev);
  	if (ret) {
  		hid_err(hdev, "hid_parse failed
  ");

  		goto err;

  	}
  
  	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
  	if (ret) {
  		hid_err(hdev, "hid_hw_start failed
  ");

  		goto err;

  	}

  	switch (hdev->product) {
  	case USB_DEVICE_ID_LENOVO_TPKBD:

  		ret = lenovo_probe_tpkbd(hdev);

  		break;

  	case USB_DEVICE_ID_LENOVO_CUSBKBD:
  	case USB_DEVICE_ID_LENOVO_CBTKBD:
  		ret = lenovo_probe_cptkbd(hdev);
  		break;

  	default:
  		ret = 0;
  		break;

  	}

  	if (ret)
  		goto err_hid;

  
  	return 0;

  err_hid:
  	hid_hw_stop(hdev);
  err:

  	return ret;
  }

  static void lenovo_remove_tpkbd(struct hid_device *hdev)

  {

  	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);

  	/*
  	 * Only the trackpoint half of the keyboard has drvdata and stuff that
  	 * needs unregistering.
  	 */
  	if (data_pointer == NULL)
  		return;

  	sysfs_remove_group(&hdev->dev.kobj,

  			&lenovo_attr_group_tpkbd);

  	led_classdev_unregister(&data_pointer->led_micmute);
  	led_classdev_unregister(&data_pointer->led_mute);
  
  	hid_set_drvdata(hdev, NULL);

  }

  static void lenovo_remove_cptkbd(struct hid_device *hdev)
  {
  	sysfs_remove_group(&hdev->dev.kobj,
  			&lenovo_attr_group_cptkbd);
  }

  static void lenovo_remove(struct hid_device *hdev)

  {

  	switch (hdev->product) {
  	case USB_DEVICE_ID_LENOVO_TPKBD:

  		lenovo_remove_tpkbd(hdev);

  		break;

  	case USB_DEVICE_ID_LENOVO_CUSBKBD:
  	case USB_DEVICE_ID_LENOVO_CBTKBD:
  		lenovo_remove_cptkbd(hdev);
  		break;

  	}

  
  	hid_hw_stop(hdev);
  }

  static int lenovo_input_configured(struct hid_device *hdev,

  		struct hid_input *hi)
  {
  	switch (hdev->product) {
  		case USB_DEVICE_ID_LENOVO_TPKBD:
  		case USB_DEVICE_ID_LENOVO_CUSBKBD:
  		case USB_DEVICE_ID_LENOVO_CBTKBD:
  			if (test_bit(EV_REL, hi->input->evbit)) {
  				/* set only for trackpoint device */
  				__set_bit(INPUT_PROP_POINTER, hi->input->propbit);
  				__set_bit(INPUT_PROP_POINTING_STICK,
  						hi->input->propbit);
  			}
  			break;
  	}

  
  	return 0;

  }

  static const struct hid_device_id lenovo_devices[] = {

  	{ HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_TPKBD) },

  	{ HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_CUSBKBD) },
  	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_CBTKBD) },

  	{ HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_TPPRODOCK) },

  	{ HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_III) },
  	{ HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_PRO) },
  	{ HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_OPTICAL) },
  	{ HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_800DPI_OPTICAL) },
  	{ HID_USB_DEVICE(USB_VENDOR_ID_IBM, USB_DEVICE_ID_IBM_SCROLLPOINT_800DPI_OPTICAL_PRO) },
  	{ HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_SCROLLPOINT_OPTICAL) },

  	{ }
  };

  MODULE_DEVICE_TABLE(hid, lenovo_devices);

  static struct hid_driver lenovo_driver = {
  	.name = "lenovo",
  	.id_table = lenovo_devices,

  	.input_configured = lenovo_input_configured,

  	.input_mapping = lenovo_input_mapping,

  	.probe = lenovo_probe,
  	.remove = lenovo_remove,

  	.raw_event = lenovo_raw_event,

  	.event = lenovo_event,

  	.report_fixup = lenovo_report_fixup,

  };

  module_hid_driver(lenovo_driver);

  
  MODULE_LICENSE("GPL");