hid-lenovo.c 13.2 KB
Newer Older
1
/*
2 3
 *  HID driver for Lenovo:
 *  - ThinkPad USB Keyboard with TrackPoint (tpkbd)
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 *
 *  Copyright (c) 2012 Bernhard Seibold
 */

/*
 * 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"

24
struct lenovo_drvdata_tpkbd {
25 26 27 28 29 30 31 32 33 34 35 36 37
	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;
};

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

38
static int lenovo_input_mapping_tpkbd(struct hid_device *hdev,
39 40 41
		struct hid_input *hi, struct hid_field *field,
		struct hid_usage *usage, unsigned long **bit, int *max)
{
42
	if (usage->hid == (HID_UP_BUTTON | 0x0010)) {
43
		/* This sub-device contains trackpoint, mark it */
44
		hid_set_drvdata(hdev, (void *)1);
45 46 47 48 49 50
		map_key_clear(KEY_MICMUTE);
		return 1;
	}
	return 0;
}

51 52 53 54 55 56 57 58 59 60 61 62 63
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);
	default:
		return 0;
	}
}

64 65
#undef map_key_clear

66
static int lenovo_features_set_tpkbd(struct hid_device *hdev)
67 68
{
	struct hid_report *report;
69
	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
70 71 72 73 74 75 76 77 78 79 80

	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;

81
	hid_hw_request(hdev, report, HID_REQ_SET_REPORT);
82 83 84
	return 0;
}

85
static ssize_t attr_press_to_select_show_tpkbd(struct device *dev,
86 87 88
		struct device_attribute *attr,
		char *buf)
{
89
	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
90
	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
91 92 93 94

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

95
static ssize_t attr_press_to_select_store_tpkbd(struct device *dev,
96 97 98 99
		struct device_attribute *attr,
		const char *buf,
		size_t count)
{
100
	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
101
	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
102 103 104 105 106 107 108 109
	int value;

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

	data_pointer->press_to_select = value;
110
	lenovo_features_set_tpkbd(hdev);
111 112 113 114

	return count;
}

115
static ssize_t attr_dragging_show_tpkbd(struct device *dev,
116 117 118
		struct device_attribute *attr,
		char *buf)
{
119
	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
120
	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
121 122 123 124

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

125
static ssize_t attr_dragging_store_tpkbd(struct device *dev,
126 127 128 129
		struct device_attribute *attr,
		const char *buf,
		size_t count)
{
130
	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
131
	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
132 133 134 135 136 137 138 139
	int value;

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

	data_pointer->dragging = value;
140
	lenovo_features_set_tpkbd(hdev);
141 142 143 144

	return count;
}

145
static ssize_t attr_release_to_select_show_tpkbd(struct device *dev,
146 147 148
		struct device_attribute *attr,
		char *buf)
{
149
	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
150
	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
151 152 153 154

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

155
static ssize_t attr_release_to_select_store_tpkbd(struct device *dev,
156 157 158 159
		struct device_attribute *attr,
		const char *buf,
		size_t count)
{
160
	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
161
	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
162 163 164 165 166 167 168 169
	int value;

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

	data_pointer->release_to_select = value;
170
	lenovo_features_set_tpkbd(hdev);
171 172 173 174

	return count;
}

175
static ssize_t attr_select_right_show_tpkbd(struct device *dev,
176 177 178
		struct device_attribute *attr,
		char *buf)
{
179
	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
180
	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
181 182 183 184

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

185
static ssize_t attr_select_right_store_tpkbd(struct device *dev,
186 187 188 189
		struct device_attribute *attr,
		const char *buf,
		size_t count)
{
190
	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
191
	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
192 193 194 195 196 197 198 199
	int value;

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

	data_pointer->select_right = value;
200
	lenovo_features_set_tpkbd(hdev);
201 202 203 204

	return count;
}

205
static ssize_t attr_sensitivity_show_tpkbd(struct device *dev,
206 207 208
		struct device_attribute *attr,
		char *buf)
{
209
	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
210
	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
211 212 213 214 215

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

216
static ssize_t attr_sensitivity_store_tpkbd(struct device *dev,
217 218 219 220
		struct device_attribute *attr,
		const char *buf,
		size_t count)
{
221
	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
222
	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
223 224 225 226 227 228
	int value;

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

	data_pointer->sensitivity = value;
229
	lenovo_features_set_tpkbd(hdev);
230 231 232 233

	return count;
}

234
static ssize_t attr_press_speed_show_tpkbd(struct device *dev,
235 236 237
		struct device_attribute *attr,
		char *buf)
{
238
	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
239
	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
240 241 242 243 244

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

245
static ssize_t attr_press_speed_store_tpkbd(struct device *dev,
246 247 248 249
		struct device_attribute *attr,
		const char *buf,
		size_t count)
{
250
	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
251
	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
252 253 254 255 256 257
	int value;

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

	data_pointer->press_speed = value;
258
	lenovo_features_set_tpkbd(hdev);
259 260 261 262

	return count;
}

263
static struct device_attribute dev_attr_press_to_select_tpkbd =
264
	__ATTR(press_to_select, S_IWUSR | S_IRUGO,
265 266
			attr_press_to_select_show_tpkbd,
			attr_press_to_select_store_tpkbd);
267

268
static struct device_attribute dev_attr_dragging_tpkbd =
269
	__ATTR(dragging, S_IWUSR | S_IRUGO,
270 271
			attr_dragging_show_tpkbd,
			attr_dragging_store_tpkbd);
272

273
static struct device_attribute dev_attr_release_to_select_tpkbd =
274
	__ATTR(release_to_select, S_IWUSR | S_IRUGO,
275 276
			attr_release_to_select_show_tpkbd,
			attr_release_to_select_store_tpkbd);
277

278
static struct device_attribute dev_attr_select_right_tpkbd =
279
	__ATTR(select_right, S_IWUSR | S_IRUGO,
280 281
			attr_select_right_show_tpkbd,
			attr_select_right_store_tpkbd);
282

283
static struct device_attribute dev_attr_sensitivity_tpkbd =
284
	__ATTR(sensitivity, S_IWUSR | S_IRUGO,
285 286
			attr_sensitivity_show_tpkbd,
			attr_sensitivity_store_tpkbd);
287

288
static struct device_attribute dev_attr_press_speed_tpkbd =
289
	__ATTR(press_speed, S_IWUSR | S_IRUGO,
290 291 292 293 294 295 296 297 298 299
			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,
300 301 302
	NULL
};

303 304
static const struct attribute_group lenovo_attr_group_tpkbd = {
	.attrs = lenovo_attributes_tpkbd,
305 306
};

307
static enum led_brightness lenovo_led_brightness_get_tpkbd(
308 309
			struct led_classdev *led_cdev)
{
310 311
	struct device *dev = led_cdev->dev->parent;
	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
312
	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
313 314 315 316 317 318 319 320 321 322
	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;
}

323
static void lenovo_led_brightness_set_tpkbd(struct led_classdev *led_cdev,
324 325
			enum led_brightness value)
{
326 327
	struct device *dev = led_cdev->dev->parent;
	struct hid_device *hdev = container_of(dev, struct hid_device, dev);
328
	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
329 330 331 332 333 334 335 336 337 338 339 340 341 342
	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;
343
	hid_hw_request(hdev, report, HID_REQ_SET_REPORT);
344 345
}

346
static int lenovo_probe_tpkbd(struct hid_device *hdev)
347 348
{
	struct device *dev = &hdev->dev;
349
	struct lenovo_drvdata_tpkbd *data_pointer;
350 351
	size_t name_sz = strlen(dev_name(dev)) + 16;
	char *name_mute, *name_micmute;
352
	int i;
353

354 355 356 357 358 359 360 361 362
	/*
	 * 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);

363 364 365 366 367 368 369
	/* 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;
370 371

	if (sysfs_create_group(&hdev->dev.kobj,
372
				&lenovo_attr_group_tpkbd)) {
373 374 375
		hid_warn(hdev, "Could not create sysfs group\n");
	}

376
	data_pointer = devm_kzalloc(&hdev->dev,
377
				    sizeof(struct lenovo_drvdata_tpkbd),
378
				    GFP_KERNEL);
379 380 381 382 383 384 385 386 387
	if (data_pointer == NULL) {
		hid_err(hdev, "Could not allocate memory for driver data\n");
		return -ENOMEM;
	}

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

388 389 390
	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) {
391
		hid_err(hdev, "Could not allocate memory for led data\n");
392
		return -ENOMEM;
393 394 395 396 397 398 399
	}
	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;
400 401
	data_pointer->led_mute.brightness_get = lenovo_led_brightness_get_tpkbd;
	data_pointer->led_mute.brightness_set = lenovo_led_brightness_set_tpkbd;
402 403 404 405
	data_pointer->led_mute.dev = dev;
	led_classdev_register(dev, &data_pointer->led_mute);

	data_pointer->led_micmute.name = name_micmute;
406 407 408 409
	data_pointer->led_micmute.brightness_get =
		lenovo_led_brightness_get_tpkbd;
	data_pointer->led_micmute.brightness_set =
		lenovo_led_brightness_set_tpkbd;
410 411 412
	data_pointer->led_micmute.dev = dev;
	led_classdev_register(dev, &data_pointer->led_micmute);

413
	lenovo_features_set_tpkbd(hdev);
414 415 416 417

	return 0;
}

418
static int lenovo_probe(struct hid_device *hdev,
419 420 421 422 423 424 425
		const struct hid_device_id *id)
{
	int ret;

	ret = hid_parse(hdev);
	if (ret) {
		hid_err(hdev, "hid_parse failed\n");
426
		goto err;
427 428 429 430 431
	}

	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
	if (ret) {
		hid_err(hdev, "hid_hw_start failed\n");
432
		goto err;
433 434
	}

435 436
	switch (hdev->product) {
	case USB_DEVICE_ID_LENOVO_TPKBD:
437
		ret = lenovo_probe_tpkbd(hdev);
438 439 440 441
		break;
	default:
		ret = 0;
		break;
442
	}
443 444
	if (ret)
		goto err_hid;
445 446

	return 0;
447 448 449
err_hid:
	hid_hw_stop(hdev);
err:
450 451 452
	return ret;
}

453
static void lenovo_remove_tpkbd(struct hid_device *hdev)
454
{
455
	struct lenovo_drvdata_tpkbd *data_pointer = hid_get_drvdata(hdev);
456

457 458 459 460 461 462 463
	/*
	 * Only the trackpoint half of the keyboard has drvdata and stuff that
	 * needs unregistering.
	 */
	if (data_pointer == NULL)
		return;

464
	sysfs_remove_group(&hdev->dev.kobj,
465
			&lenovo_attr_group_tpkbd);
466 467 468 469 470 471 472

	led_classdev_unregister(&data_pointer->led_micmute);
	led_classdev_unregister(&data_pointer->led_mute);

	hid_set_drvdata(hdev, NULL);
}

473
static void lenovo_remove(struct hid_device *hdev)
474
{
475 476
	switch (hdev->product) {
	case USB_DEVICE_ID_LENOVO_TPKBD:
477
		lenovo_remove_tpkbd(hdev);
478 479
		break;
	}
480 481 482 483

	hid_hw_stop(hdev);
}

484
static const struct hid_device_id lenovo_devices[] = {
485 486 487 488
	{ HID_USB_DEVICE(USB_VENDOR_ID_LENOVO, USB_DEVICE_ID_LENOVO_TPKBD) },
	{ }
};

489
MODULE_DEVICE_TABLE(hid, lenovo_devices);
490

491 492 493
static struct hid_driver lenovo_driver = {
	.name = "lenovo",
	.id_table = lenovo_devices,
494
	.input_mapping = lenovo_input_mapping,
495 496
	.probe = lenovo_probe,
	.remove = lenovo_remove,
497
};
498
module_hid_driver(lenovo_driver);
499 500

MODULE_LICENSE("GPL");