[mirror_ubuntu-artful-kernel.git] / drivers / acpi / button.c

/*
 *  button.c - ACPI Button Driver
 *
 *  Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
 *  Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.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.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  General Public License for more details.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */

#define pr_fmt(fmt) "ACPI : button: " fmt

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/types.h>
#include <linux/proc_fs.h>
#include <linux/seq_file.h>
#include <linux/input.h>
#include <linux/slab.h>
#include <linux/acpi.h>
#include <acpi/button.h>

#define PREFIX "ACPI: "

#define ACPI_BUTTON_CLASS		"button"
#define ACPI_BUTTON_FILE_INFO		"info"
#define ACPI_BUTTON_FILE_STATE		"state"
#define ACPI_BUTTON_TYPE_UNKNOWN	0x00
#define ACPI_BUTTON_NOTIFY_STATUS	0x80

#define ACPI_BUTTON_SUBCLASS_POWER	"power"
#define ACPI_BUTTON_HID_POWER		"PNP0C0C"
#define ACPI_BUTTON_DEVICE_NAME_POWER	"Power Button"
#define ACPI_BUTTON_TYPE_POWER		0x01

#define ACPI_BUTTON_SUBCLASS_SLEEP	"sleep"
#define ACPI_BUTTON_HID_SLEEP		"PNP0C0E"
#define ACPI_BUTTON_DEVICE_NAME_SLEEP	"Sleep Button"
#define ACPI_BUTTON_TYPE_SLEEP		0x03

#define ACPI_BUTTON_SUBCLASS_LID	"lid"
#define ACPI_BUTTON_HID_LID		"PNP0C0D"
#define ACPI_BUTTON_DEVICE_NAME_LID	"Lid Switch"
#define ACPI_BUTTON_TYPE_LID		0x05

#define ACPI_BUTTON_LID_INIT_IGNORE	0x00
#define ACPI_BUTTON_LID_INIT_OPEN	0x01

#define _COMPONENT		ACPI_BUTTON_COMPONENT
ACPI_MODULE_NAME("button");

MODULE_AUTHOR("Paul Diefenbaugh");
MODULE_DESCRIPTION("ACPI Button Driver");
MODULE_LICENSE("GPL");

static const struct acpi_device_id button_device_ids[] = {
	{ACPI_BUTTON_HID_LID,    0},
	{ACPI_BUTTON_HID_SLEEP,  0},
	{ACPI_BUTTON_HID_SLEEPF, 0},
	{ACPI_BUTTON_HID_POWER,  0},
	{ACPI_BUTTON_HID_POWERF, 0},
	{"", 0},
};
MODULE_DEVICE_TABLE(acpi, button_device_ids);

static int acpi_button_add(struct acpi_device *device);
static int acpi_button_remove(struct acpi_device *device);
static void acpi_button_notify(struct acpi_device *device, u32 event);

#ifdef CONFIG_PM_SLEEP
static int acpi_button_suspend(struct device *dev);
static int acpi_button_resume(struct device *dev);
#else
#define acpi_button_suspend NULL
#define acpi_button_resume NULL
#endif
static SIMPLE_DEV_PM_OPS(acpi_button_pm, acpi_button_suspend, acpi_button_resume);

static struct acpi_driver acpi_button_driver = {
	.name = "button",
	.class = ACPI_BUTTON_CLASS,
	.ids = button_device_ids,
	.ops = {
		.add = acpi_button_add,
		.remove = acpi_button_remove,
		.notify = acpi_button_notify,
	},
	.drv.pm = &acpi_button_pm,
};

struct acpi_button {
	unsigned int type;
	struct input_dev *input;
	char phys[32];			/* for input device */
	unsigned long pushed;
	int last_state;
	ktime_t last_time;
	bool suspended;
};

static BLOCKING_NOTIFIER_HEAD(acpi_lid_notifier);
static struct acpi_device *lid_device;
static u8 lid_init_state = ACPI_BUTTON_LID_INIT_OPEN;

static unsigned long lid_report_interval __read_mostly = 500;
module_param(lid_report_interval, ulong, 0644);
MODULE_PARM_DESC(lid_report_interval, "Interval (ms) between lid key events");

/* --------------------------------------------------------------------------
                              FS Interface (/proc)
   -------------------------------------------------------------------------- */

static struct proc_dir_entry *acpi_button_dir;
static struct proc_dir_entry *acpi_lid_dir;

static int acpi_lid_evaluate_state(struct acpi_device *device)
{
	unsigned long long lid_state;
	acpi_status status;

	status = acpi_evaluate_integer(device->handle, "_LID", NULL, &lid_state);
	if (ACPI_FAILURE(status))
		return -ENODEV;

	return lid_state ? 1 : 0;
}

static int acpi_lid_notify_state(struct acpi_device *device, int state)
{
	struct acpi_button *button = acpi_driver_data(device);
	int ret;
	ktime_t next_report;
	bool do_update;

	/*
	 * In lid_init_state=ignore mode, if user opens/closes lid
	 * frequently with "open" missing, and "last_time" is also updated
	 * frequently, "close" cannot be delivered to the userspace.
	 * So "last_time" is only updated after a timeout or an actual
	 * switch.
	 */
	if (lid_init_state != ACPI_BUTTON_LID_INIT_IGNORE ||
	    button->last_state != !!state)
		do_update = true;
	else
		do_update = false;

	next_report = ktime_add(button->last_time,
				ms_to_ktime(lid_report_interval));
	if (button->last_state == !!state &&
	    ktime_after(ktime_get(), next_report)) {
		/* Complain the buggy firmware */
		pr_warn_once("The lid device is not compliant to SW_LID.\n");

		/*
		 * Send the unreliable complement switch event:
		 *
		 * On most platforms, the lid device is reliable. However
		 * there are exceptions:
		 * 1. Platforms returning initial lid state as "close" by
		 *    default after booting/resuming:
		 *     https://bugzilla.kernel.org/show_bug.cgi?id=89211
		 *     https://bugzilla.kernel.org/show_bug.cgi?id=106151
		 * 2. Platforms never reporting "open" events:
		 *     https://bugzilla.kernel.org/show_bug.cgi?id=106941
		 * On these buggy platforms, the usage model of the ACPI
		 * lid device actually is:
		 * 1. The initial returning value of _LID may not be
		 *    reliable.
		 * 2. The open event may not be reliable.
		 * 3. The close event is reliable.
		 *
		 * But SW_LID is typed as input switch event, the input
		 * layer checks if the event is redundant. Hence if the
		 * state is not switched, the userspace cannot see this
		 * platform triggered reliable event. By inserting a
		 * complement switch event, it then is guaranteed that the
		 * platform triggered reliable one can always be seen by
		 * the userspace.
		 */
		if (lid_init_state == ACPI_BUTTON_LID_INIT_IGNORE) {
			do_update = true;
			/*
			 * Do generate complement switch event for "close"
			 * as "close" is reliable and wrong "open" won't
			 * trigger unexpected behaviors.
			 * Do not generate complement switch event for
			 * "open" as "open" is not reliable and wrong
			 * "close" will trigger unexpected behaviors.
			 */
			if (!state) {
				input_report_switch(button->input,
						    SW_LID, state);
				input_sync(button->input);
			}
		}
	}
	/* Send the platform triggered reliable event */
	if (do_update) {
		input_report_switch(button->input, SW_LID, !state);
		input_sync(button->input);
		button->last_state = !!state;
		button->last_time = ktime_get();
	}

	if (state)
		pm_wakeup_hard_event(&device->dev);

	ret = blocking_notifier_call_chain(&acpi_lid_notifier, state, device);
	if (ret == NOTIFY_DONE)
		ret = blocking_notifier_call_chain(&acpi_lid_notifier, state,
						   device);
	if (ret == NOTIFY_DONE || ret == NOTIFY_OK) {
		/*
		 * It is also regarded as success if the notifier_chain
		 * returns NOTIFY_OK or NOTIFY_DONE.
		 */
		ret = 0;
	}
	return ret;
}

static int acpi_button_state_seq_show(struct seq_file *seq, void *offset)
{
	struct acpi_device *device = seq->private;
	int state;

	state = acpi_lid_evaluate_state(device);
	seq_printf(seq, "state:      %s\n",
		   state < 0 ? "unsupported" : (state ? "open" : "closed"));
	return 0;
}

static int acpi_button_state_open_fs(struct inode *inode, struct file *file)
{
	return single_open(file, acpi_button_state_seq_show, PDE_DATA(inode));
}

static const struct file_operations acpi_button_state_fops = {
	.owner = THIS_MODULE,
	.open = acpi_button_state_open_fs,
	.read = seq_read,
	.llseek = seq_lseek,
	.release = single_release,
};

static int acpi_button_add_fs(struct acpi_device *device)
{
	struct acpi_button *button = acpi_driver_data(device);
	struct proc_dir_entry *entry = NULL;
	int ret = 0;

	/* procfs I/F for ACPI lid device only */
	if (button->type != ACPI_BUTTON_TYPE_LID)
		return 0;

	if (acpi_button_dir || acpi_lid_dir) {
		printk(KERN_ERR PREFIX "More than one Lid device found!\n");
		return -EEXIST;
	}

	/* create /proc/acpi/button */
	acpi_button_dir = proc_mkdir(ACPI_BUTTON_CLASS, acpi_root_dir);
	if (!acpi_button_dir)
		return -ENODEV;

	/* create /proc/acpi/button/lid */
	acpi_lid_dir = proc_mkdir(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
	if (!acpi_lid_dir) {
		ret = -ENODEV;
		goto remove_button_dir;
	}

	/* create /proc/acpi/button/lid/LID/ */
	acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device), acpi_lid_dir);
	if (!acpi_device_dir(device)) {
		ret = -ENODEV;
		goto remove_lid_dir;
	}

	/* create /proc/acpi/button/lid/LID/state */
	entry = proc_create_data(ACPI_BUTTON_FILE_STATE,
				 S_IRUGO, acpi_device_dir(device),
				 &acpi_button_state_fops, device);
	if (!entry) {
		ret = -ENODEV;
		goto remove_dev_dir;
	}

done:
	return ret;

remove_dev_dir:
	remove_proc_entry(acpi_device_bid(device),
			  acpi_lid_dir);
	acpi_device_dir(device) = NULL;
remove_lid_dir:
	remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
	acpi_lid_dir = NULL;
remove_button_dir:
	remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
	acpi_button_dir = NULL;
	goto done;
}

static int acpi_button_remove_fs(struct acpi_device *device)
{
	struct acpi_button *button = acpi_driver_data(device);

	if (button->type != ACPI_BUTTON_TYPE_LID)
		return 0;

	remove_proc_entry(ACPI_BUTTON_FILE_STATE,
			  acpi_device_dir(device));
	remove_proc_entry(acpi_device_bid(device),
			  acpi_lid_dir);
	acpi_device_dir(device) = NULL;
	remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
	acpi_lid_dir = NULL;
	remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
	acpi_button_dir = NULL;

	return 0;
}

/* --------------------------------------------------------------------------
                                Driver Interface
   -------------------------------------------------------------------------- */
int acpi_lid_notifier_register(struct notifier_block *nb)
{
	return blocking_notifier_chain_register(&acpi_lid_notifier, nb);
}
EXPORT_SYMBOL(acpi_lid_notifier_register);

int acpi_lid_notifier_unregister(struct notifier_block *nb)
{
	return blocking_notifier_chain_unregister(&acpi_lid_notifier, nb);
}
EXPORT_SYMBOL(acpi_lid_notifier_unregister);

int acpi_lid_open(void)
{
	if (!lid_device)
		return -ENODEV;

	return acpi_lid_evaluate_state(lid_device);
}
EXPORT_SYMBOL(acpi_lid_open);

static int acpi_lid_update_state(struct acpi_device *device)
{
	int state;

	state = acpi_lid_evaluate_state(device);
	if (state < 0)
		return state;

	return acpi_lid_notify_state(device, state);
}

static void acpi_lid_initialize_state(struct acpi_device *device)
{
	switch (lid_init_state) {
	case ACPI_BUTTON_LID_INIT_OPEN:
		(void)acpi_lid_notify_state(device, 1);
		break;
	case ACPI_BUTTON_LID_INIT_IGNORE:
	default:
		break;
	}
}

static void acpi_button_notify(struct acpi_device *device, u32 event)
{
	struct acpi_button *button = acpi_driver_data(device);
	struct input_dev *input;

	switch (event) {
	case ACPI_FIXED_HARDWARE_EVENT:
		event = ACPI_BUTTON_NOTIFY_STATUS;
		/* fall through */
	case ACPI_BUTTON_NOTIFY_STATUS:
		input = button->input;
		if (button->type == ACPI_BUTTON_TYPE_LID) {
			acpi_lid_update_state(device);
		} else {
			int keycode;

			pm_wakeup_hard_event(&device->dev);
			if (button->suspended)
				break;

			keycode = test_bit(KEY_SLEEP, input->keybit) ?
						KEY_SLEEP : KEY_POWER;
			input_report_key(input, keycode, 1);
			input_sync(input);
			input_report_key(input, keycode, 0);
			input_sync(input);

			acpi_bus_generate_netlink_event(
					device->pnp.device_class,
					dev_name(&device->dev),
					event, ++button->pushed);
		}
		break;
	default:
		ACPI_DEBUG_PRINT((ACPI_DB_INFO,
				  "Unsupported event [0x%x]\n", event));
		break;
	}
}

#ifdef CONFIG_PM_SLEEP
static int acpi_button_suspend(struct device *dev)
{
	struct acpi_device *device = to_acpi_device(dev);
	struct acpi_button *button = acpi_driver_data(device);

	button->suspended = true;
	return 0;
}

static int acpi_button_resume(struct device *dev)
{
	struct acpi_device *device = to_acpi_device(dev);
	struct acpi_button *button = acpi_driver_data(device);

	button->suspended = false;
	if (button->type == ACPI_BUTTON_TYPE_LID)
		acpi_lid_initialize_state(device);
	return 0;
}
#endif

static int acpi_button_add(struct acpi_device *device)
{
	struct acpi_button *button;
	struct input_dev *input;
	const char *hid = acpi_device_hid(device);
	char *name, *class;
	int error;

	button = kzalloc(sizeof(struct acpi_button), GFP_KERNEL);
	if (!button)
		return -ENOMEM;

	device->driver_data = button;

	button->input = input = input_allocate_device();
	if (!input) {
		error = -ENOMEM;
		goto err_free_button;
	}

	name = acpi_device_name(device);
	class = acpi_device_class(device);

	if (!strcmp(hid, ACPI_BUTTON_HID_POWER) ||
	    !strcmp(hid, ACPI_BUTTON_HID_POWERF)) {
		button->type = ACPI_BUTTON_TYPE_POWER;
		strcpy(name, ACPI_BUTTON_DEVICE_NAME_POWER);
		sprintf(class, "%s/%s",
			ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_POWER);
	} else if (!strcmp(hid, ACPI_BUTTON_HID_SLEEP) ||
		   !strcmp(hid, ACPI_BUTTON_HID_SLEEPF)) {
		button->type = ACPI_BUTTON_TYPE_SLEEP;
		strcpy(name, ACPI_BUTTON_DEVICE_NAME_SLEEP);
		sprintf(class, "%s/%s",
			ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_SLEEP);
	} else if (!strcmp(hid, ACPI_BUTTON_HID_LID)) {
		button->type = ACPI_BUTTON_TYPE_LID;
		strcpy(name, ACPI_BUTTON_DEVICE_NAME_LID);
		sprintf(class, "%s/%s",
			ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_LID);
		button->last_state = !!acpi_lid_evaluate_state(device);
		button->last_time = ktime_get();
	} else {
		printk(KERN_ERR PREFIX "Unsupported hid [%s]\n", hid);
		error = -ENODEV;
		goto err_free_input;
	}

	error = acpi_button_add_fs(device);
	if (error)
		goto err_free_input;

	snprintf(button->phys, sizeof(button->phys), "%s/button/input0", hid);

	input->name = name;
	input->phys = button->phys;
	input->id.bustype = BUS_HOST;
	input->id.product = button->type;
	input->dev.parent = &device->dev;

	switch (button->type) {
	case ACPI_BUTTON_TYPE_POWER:
		input_set_capability(input, EV_KEY, KEY_POWER);
		break;

	case ACPI_BUTTON_TYPE_SLEEP:
		input_set_capability(input, EV_KEY, KEY_SLEEP);
		break;

	case ACPI_BUTTON_TYPE_LID:
		input_set_capability(input, EV_SW, SW_LID);
		break;
	}

	error = input_register_device(input);
	if (error)
		goto err_remove_fs;
	if (button->type == ACPI_BUTTON_TYPE_LID) {
		acpi_lid_initialize_state(device);
		/*
		 * This assumes there's only one lid device, or if there are
		 * more we only care about the last one...
		 */
		lid_device = device;
	}

	device_init_wakeup(&device->dev, true);
	printk(KERN_INFO PREFIX "%s [%s]\n", name, acpi_device_bid(device));
	return 0;

 err_remove_fs:
	acpi_button_remove_fs(device);
 err_free_input:
	input_free_device(input);
 err_free_button:
	kfree(button);
	return error;
}

static int acpi_button_remove(struct acpi_device *device)
{
	struct acpi_button *button = acpi_driver_data(device);

	acpi_button_remove_fs(device);
	input_unregister_device(button->input);
	kfree(button);
	return 0;
}

static int param_set_lid_init_state(const char *val, struct kernel_param *kp)
{
	int result = 0;

	if (!strncmp(val, "open", sizeof("open") - 1)) {
		lid_init_state = ACPI_BUTTON_LID_INIT_OPEN;
		pr_info("Notify initial lid state as open\n");
	} else if (!strncmp(val, "ignore", sizeof("ignore") - 1)) {
		lid_init_state = ACPI_BUTTON_LID_INIT_IGNORE;
		pr_info("Do not notify initial lid state\n");
	} else
		result = -EINVAL;
	return result;
}

static int param_get_lid_init_state(char *buffer, struct kernel_param *kp)
{
	switch (lid_init_state) {
	case ACPI_BUTTON_LID_INIT_OPEN:
		return sprintf(buffer, "open");
	case ACPI_BUTTON_LID_INIT_IGNORE:
		return sprintf(buffer, "ignore");
	default:
		return sprintf(buffer, "invalid");
	}
	return 0;
}

module_param_call(lid_init_state,
		  param_set_lid_init_state, param_get_lid_init_state,
		  NULL, 0644);
MODULE_PARM_DESC(lid_init_state, "Behavior for reporting LID initial state");

module_acpi_driver(acpi_button_driver);
Commit	Line	Data
1da177e4	1	/*
50a4da89	2	* button.c - ACPI Button Driver
1da177e4 LT	3	*
	4	* Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
	5	* Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
	6	*
	7	* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation; either version 2 of the License, or (at
	12	* your option) any later version.
	13	*
	14	* This program is distributed in the hope that it will be useful, but
	15	* WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	17	* General Public License for more details.
	18	*
1da177e4 LT	19	* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	20	*/
	21
dfa46c50 LZ	22	#define pr_fmt(fmt) "ACPI : button: " fmt
dfa46c50 LZ	23
1da177e4 LT	24	#include <linux/kernel.h>
	25	#include <linux/module.h>
	26	#include <linux/init.h>
b34a8030 AS	27	#include <linux/types.h>
	28	#include <linux/proc_fs.h>
	29	#include <linux/seq_file.h>
c0968f0e	30	#include <linux/input.h>
5a0e3ad6	31	#include <linux/slab.h>
8b48463f	32	#include <linux/acpi.h>
6270da6f	33	#include <acpi/button.h>
1da177e4	34
a192a958 LB	35	#define PREFIX "ACPI: "
a192a958 LB	36
1da177e4	37	#define ACPI_BUTTON_CLASS "button"
b34a8030 AS	38	#define ACPI_BUTTON_FILE_INFO "info"
	39	#define ACPI_BUTTON_FILE_STATE "state"
	40	#define ACPI_BUTTON_TYPE_UNKNOWN 0x00
1da177e4 LT	41	#define ACPI_BUTTON_NOTIFY_STATUS 0x80
	42
	43	#define ACPI_BUTTON_SUBCLASS_POWER "power"
4be44fcd	44	#define ACPI_BUTTON_HID_POWER "PNP0C0C"
d68b597c	45	#define ACPI_BUTTON_DEVICE_NAME_POWER "Power Button"
1da177e4	46	#define ACPI_BUTTON_TYPE_POWER 0x01
1da177e4 LT	47
	48	#define ACPI_BUTTON_SUBCLASS_SLEEP "sleep"
	49	#define ACPI_BUTTON_HID_SLEEP "PNP0C0E"
d68b597c	50	#define ACPI_BUTTON_DEVICE_NAME_SLEEP "Sleep Button"
1da177e4	51	#define ACPI_BUTTON_TYPE_SLEEP 0x03
1da177e4 LT	52
	53	#define ACPI_BUTTON_SUBCLASS_LID "lid"
	54	#define ACPI_BUTTON_HID_LID "PNP0C0D"
	55	#define ACPI_BUTTON_DEVICE_NAME_LID "Lid Switch"
	56	#define ACPI_BUTTON_TYPE_LID 0x05
	57
3540c32a LZ	58	#define ACPI_BUTTON_LID_INIT_IGNORE 0x00
3540c32a LZ	59	#define ACPI_BUTTON_LID_INIT_OPEN 0x01
3540c32a	60
1da177e4	61	#define _COMPONENT ACPI_BUTTON_COMPONENT
f52fd66d	62	ACPI_MODULE_NAME("button");
1da177e4	63
c0968f0e	64	MODULE_AUTHOR("Paul Diefenbaugh");
7cda93e0	65	MODULE_DESCRIPTION("ACPI Button Driver");
1da177e4 LT	66	MODULE_LICENSE("GPL");
1da177e4 LT	67
1ba90e3a TR	68	static const struct acpi_device_id button_device_ids[] = {
	69	{ACPI_BUTTON_HID_LID, 0},
	70	{ACPI_BUTTON_HID_SLEEP, 0},
	71	{ACPI_BUTTON_HID_SLEEPF, 0},
	72	{ACPI_BUTTON_HID_POWER, 0},
	73	{ACPI_BUTTON_HID_POWERF, 0},
	74	{"", 0},
	75	};
	76	MODULE_DEVICE_TABLE(acpi, button_device_ids);
	77
4be44fcd	78	static int acpi_button_add(struct acpi_device *device);
51fac838	79	static int acpi_button_remove(struct acpi_device *device);
373cfc36	80	static void acpi_button_notify(struct acpi_device *device, u32 event);
1da177e4	81
90692404	82	#ifdef CONFIG_PM_SLEEP
e71eeb2a	83	static int acpi_button_suspend(struct device *dev);
1be532de	84	static int acpi_button_resume(struct device *dev);
2de9fd17	85	#else
e71eeb2a	86	#define acpi_button_suspend NULL
2de9fd17	87	#define acpi_button_resume NULL
90692404	88	#endif
e71eeb2a	89	static SIMPLE_DEV_PM_OPS(acpi_button_pm, acpi_button_suspend, acpi_button_resume);
1be532de	90
1da177e4	91	static struct acpi_driver acpi_button_driver = {
c2b6705b	92	.name = "button",
4be44fcd	93	.class = ACPI_BUTTON_CLASS,
1ba90e3a	94	.ids = button_device_ids,
4be44fcd LB	95	.ops = {
	96	.add = acpi_button_add,
	97	.remove = acpi_button_remove,
373cfc36	98	.notify = acpi_button_notify,
c0968f0e	99	},
1be532de	100	.drv.pm = &acpi_button_pm,
1da177e4 LT	101	};
	102
	103	struct acpi_button {
c0968f0e DT	104	unsigned int type;
	105	struct input_dev *input;
	106	char phys[32]; /* for input device */
4be44fcd	107	unsigned long pushed;
dfa46c50 LZ	108	int last_state;
dfa46c50 LZ	109	ktime_t last_time;
e71eeb2a	110	bool suspended;
1da177e4 LT	111	};
1da177e4 LT	112
7e12715e JB	113	static BLOCKING_NOTIFIER_HEAD(acpi_lid_notifier);
7e12715e JB	114	static struct acpi_device *lid_device;
77e9a4aa	115	static u8 lid_init_state = ACPI_BUTTON_LID_INIT_OPEN;
7e12715e	116
dfa46c50 LZ	117	static unsigned long lid_report_interval __read_mostly = 500;
	118	module_param(lid_report_interval, ulong, 0644);
	119	MODULE_PARM_DESC(lid_report_interval, "Interval (ms) between lid key events");
	120
b34a8030 AS	121	/* --------------------------------------------------------------------------
	122	FS Interface (/proc)
	123	-------------------------------------------------------------------------- */
	124
4be44fcd	125	static struct proc_dir_entry *acpi_button_dir;
912b7427	126	static struct proc_dir_entry *acpi_lid_dir;
4be44fcd	127
ee7e2265 LZ	128	static int acpi_lid_evaluate_state(struct acpi_device *device)
	129	{
	130	unsigned long long lid_state;
	131	acpi_status status;
	132
	133	status = acpi_evaluate_integer(device->handle, "_LID", NULL, &lid_state);
	134	if (ACPI_FAILURE(status))
	135	return -ENODEV;
	136
	137	return lid_state ? 1 : 0;
	138	}
	139
	140	static int acpi_lid_notify_state(struct acpi_device *device, int state)
	141	{
	142	struct acpi_button *button = acpi_driver_data(device);
	143	int ret;
dfa46c50 LZ	144	ktime_t next_report;
	145	bool do_update;
	146
	147	/*
	148	* In lid_init_state=ignore mode, if user opens/closes lid
	149	* frequently with "open" missing, and "last_time" is also updated
	150	* frequently, "close" cannot be delivered to the userspace.
	151	* So "last_time" is only updated after a timeout or an actual
	152	* switch.
	153	*/
	154	if (lid_init_state != ACPI_BUTTON_LID_INIT_IGNORE \|\|
	155	button->last_state != !!state)
	156	do_update = true;
	157	else
	158	do_update = false;
	159
	160	next_report = ktime_add(button->last_time,
	161	ms_to_ktime(lid_report_interval));
	162	if (button->last_state == !!state &&
	163	ktime_after(ktime_get(), next_report)) {
	164	/* Complain the buggy firmware */
	165	pr_warn_once("The lid device is not compliant to SW_LID.\n");
ee7e2265	166
dfa46c50 LZ	167	/*
	168	* Send the unreliable complement switch event:
	169	*
	170	* On most platforms, the lid device is reliable. However
	171	* there are exceptions:
	172	* 1. Platforms returning initial lid state as "close" by
	173	* default after booting/resuming:
	174	* https://bugzilla.kernel.org/show_bug.cgi?id=89211
	175	* https://bugzilla.kernel.org/show_bug.cgi?id=106151
	176	* 2. Platforms never reporting "open" events:
	177	* https://bugzilla.kernel.org/show_bug.cgi?id=106941
	178	* On these buggy platforms, the usage model of the ACPI
	179	* lid device actually is:
	180	* 1. The initial returning value of _LID may not be
	181	* reliable.
	182	* 2. The open event may not be reliable.
	183	* 3. The close event is reliable.
	184	*
	185	* But SW_LID is typed as input switch event, the input
	186	* layer checks if the event is redundant. Hence if the
	187	* state is not switched, the userspace cannot see this
	188	* platform triggered reliable event. By inserting a
	189	* complement switch event, it then is guaranteed that the
	190	* platform triggered reliable one can always be seen by
	191	* the userspace.
	192	*/
	193	if (lid_init_state == ACPI_BUTTON_LID_INIT_IGNORE) {
	194	do_update = true;
	195	/*
	196	* Do generate complement switch event for "close"
	197	* as "close" is reliable and wrong "open" won't
	198	* trigger unexpected behaviors.
	199	* Do not generate complement switch event for
	200	* "open" as "open" is not reliable and wrong
	201	* "close" will trigger unexpected behaviors.
	202	*/
	203	if (!state) {
	204	input_report_switch(button->input,
	205	SW_LID, state);
	206	input_sync(button->input);
	207	}
	208	}
	209	}
	210	/* Send the platform triggered reliable event */
	211	if (do_update) {
	212	input_report_switch(button->input, SW_LID, !state);
	213	input_sync(button->input);
	214	button->last_state = !!state;
	215	button->last_time = ktime_get();
	216	}
ee7e2265 LZ	217
ee7e2265 LZ	218	if (state)
eed4d47e	219	pm_wakeup_hard_event(&device->dev);
ee7e2265 LZ	220
	221	ret = blocking_notifier_call_chain(&acpi_lid_notifier, state, device);
	222	if (ret == NOTIFY_DONE)
	223	ret = blocking_notifier_call_chain(&acpi_lid_notifier, state,
	224	device);
	225	if (ret == NOTIFY_DONE \|\| ret == NOTIFY_OK) {
	226	/*
	227	* It is also regarded as success if the notifier_chain
	228	* returns NOTIFY_OK or NOTIFY_DONE.
	229	*/
	230	ret = 0;
	231	}
	232	return ret;
	233	}
	234
b34a8030 AS	235	static int acpi_button_state_seq_show(struct seq_file seq, void offset)
b34a8030 AS	236	{
106c19e7	237	struct acpi_device *device = seq->private;
ee7e2265	238	int state;
b34a8030	239
ee7e2265	240	state = acpi_lid_evaluate_state(device);
c0968f0e	241	seq_printf(seq, "state: %s\n",
ee7e2265	242	state < 0 ? "unsupported" : (state ? "open" : "closed"));
d550d98d	243	return 0;
b34a8030 AS	244	}
	245
	246	static int acpi_button_state_open_fs(struct inode inode, struct file file)
	247	{
d9dda78b	248	return single_open(file, acpi_button_state_seq_show, PDE_DATA(inode));
b34a8030 AS	249	}
b34a8030 AS	250
912b7427 ZR	251	static const struct file_operations acpi_button_state_fops = {
	252	.owner = THIS_MODULE,
	253	.open = acpi_button_state_open_fs,
	254	.read = seq_read,
	255	.llseek = seq_lseek,
	256	.release = single_release,
	257	};
b34a8030	258
4be44fcd	259	static int acpi_button_add_fs(struct acpi_device *device)
b34a8030	260	{
1bce8113	261	struct acpi_button *button = acpi_driver_data(device);
4be44fcd	262	struct proc_dir_entry *entry = NULL;
912b7427	263	int ret = 0;
b34a8030	264
912b7427 ZR	265	/* procfs I/F for ACPI lid device only */
	266	if (button->type != ACPI_BUTTON_TYPE_LID)
	267	return 0;
	268
	269	if (acpi_button_dir \|\| acpi_lid_dir) {
	270	printk(KERN_ERR PREFIX "More than one Lid device found!\n");
	271	return -EEXIST;
b34a8030 AS	272	}
b34a8030 AS	273
912b7427 ZR	274	/* create /proc/acpi/button */
	275	acpi_button_dir = proc_mkdir(ACPI_BUTTON_CLASS, acpi_root_dir);
	276	if (!acpi_button_dir)
d550d98d	277	return -ENODEV;
b34a8030	278
912b7427 ZR	279	/* create /proc/acpi/button/lid */
	280	acpi_lid_dir = proc_mkdir(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
	281	if (!acpi_lid_dir) {
	282	ret = -ENODEV;
	283	goto remove_button_dir;
	284	}
b34a8030	285
912b7427 ZR	286	/* create /proc/acpi/button/lid/LID/ */
	287	acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device), acpi_lid_dir);
	288	if (!acpi_device_dir(device)) {
	289	ret = -ENODEV;
	290	goto remove_lid_dir;
	291	}
b34a8030	292
912b7427 ZR	293	/* create /proc/acpi/button/lid/LID/state */
	294	entry = proc_create_data(ACPI_BUTTON_FILE_STATE,
	295	S_IRUGO, acpi_device_dir(device),
	296	&acpi_button_state_fops, device);
	297	if (!entry) {
	298	ret = -ENODEV;
	299	goto remove_dev_dir;
b34a8030 AS	300	}
b34a8030 AS	301
912b7427 ZR	302	done:
	303	return ret;
	304
	305	remove_dev_dir:
	306	remove_proc_entry(acpi_device_bid(device),
	307	acpi_lid_dir);
	308	acpi_device_dir(device) = NULL;
	309	remove_lid_dir:
	310	remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
e370cc86	311	acpi_lid_dir = NULL;
912b7427 ZR	312	remove_button_dir:
912b7427 ZR	313	remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
e370cc86	314	acpi_button_dir = NULL;
912b7427	315	goto done;
b34a8030 AS	316	}
b34a8030 AS	317
4be44fcd	318	static int acpi_button_remove_fs(struct acpi_device *device)
b34a8030	319	{
c0968f0e	320	struct acpi_button *button = acpi_driver_data(device);
b34a8030	321
912b7427 ZR	322	if (button->type != ACPI_BUTTON_TYPE_LID)
912b7427 ZR	323	return 0;
b34a8030	324
912b7427 ZR	325	remove_proc_entry(ACPI_BUTTON_FILE_STATE,
	326	acpi_device_dir(device));
	327	remove_proc_entry(acpi_device_bid(device),
	328	acpi_lid_dir);
	329	acpi_device_dir(device) = NULL;
	330	remove_proc_entry(ACPI_BUTTON_SUBCLASS_LID, acpi_button_dir);
e370cc86	331	acpi_lid_dir = NULL;
912b7427	332	remove_proc_entry(ACPI_BUTTON_CLASS, acpi_root_dir);
e370cc86	333	acpi_button_dir = NULL;
b34a8030	334
d550d98d	335	return 0;
b34a8030 AS	336	}
b34a8030 AS	337
1da177e4 LT	338	/* --------------------------------------------------------------------------
	339	Driver Interface
	340	-------------------------------------------------------------------------- */
7e12715e JB	341	int acpi_lid_notifier_register(struct notifier_block *nb)
	342	{
	343	return blocking_notifier_chain_register(&acpi_lid_notifier, nb);
	344	}
	345	EXPORT_SYMBOL(acpi_lid_notifier_register);
	346
	347	int acpi_lid_notifier_unregister(struct notifier_block *nb)
	348	{
	349	return blocking_notifier_chain_unregister(&acpi_lid_notifier, nb);
	350	}
	351	EXPORT_SYMBOL(acpi_lid_notifier_unregister);
	352
	353	int acpi_lid_open(void)
	354	{
2c907b72 JB	355	if (!lid_device)
	356	return -ENODEV;
	357
ee7e2265	358	return acpi_lid_evaluate_state(lid_device);
7e12715e JB	359	}
	360	EXPORT_SYMBOL(acpi_lid_open);
	361
ee7e2265	362	static int acpi_lid_update_state(struct acpi_device *device)
23de5d9e	363	{
ee7e2265	364	int state;
50a4da89	365
ee7e2265 LZ	366	state = acpi_lid_evaluate_state(device);
	367	if (state < 0)
	368	return state;
7e12715e	369
ee7e2265	370	return acpi_lid_notify_state(device, state);
23de5d9e	371	}
1da177e4	372
3540c32a LZ	373	static void acpi_lid_initialize_state(struct acpi_device *device)
	374	{
	375	switch (lid_init_state) {
	376	case ACPI_BUTTON_LID_INIT_OPEN:
	377	(void)acpi_lid_notify_state(device, 1);
	378	break;
3540c32a LZ	379	case ACPI_BUTTON_LID_INIT_IGNORE:
	380	default:
	381	break;
	382	}
	383	}
	384
373cfc36	385	static void acpi_button_notify(struct acpi_device *device, u32 event)
1da177e4	386	{
373cfc36	387	struct acpi_button *button = acpi_driver_data(device);
c0968f0e	388	struct input_dev *input;
1da177e4	389
1da177e4	390	switch (event) {
373cfc36 BH	391	case ACPI_FIXED_HARDWARE_EVENT:
	392	event = ACPI_BUTTON_NOTIFY_STATUS;
	393	/* fall through */
1da177e4	394	case ACPI_BUTTON_NOTIFY_STATUS:
c0968f0e	395	input = button->input;
c0968f0e	396	if (button->type == ACPI_BUTTON_TYPE_LID) {
ee7e2265	397	acpi_lid_update_state(device);
c0968f0e	398	} else {
e71eeb2a RW	399	int keycode;
e71eeb2a RW	400
eed4d47e	401	pm_wakeup_hard_event(&device->dev);
e71eeb2a RW	402	if (button->suspended)
e71eeb2a RW	403	break;
c0968f0e	404
e71eeb2a RW	405	keycode = test_bit(KEY_SLEEP, input->keybit) ?
e71eeb2a RW	406	KEY_SLEEP : KEY_POWER;
c0968f0e DT	407	input_report_key(input, keycode, 1);
	408	input_sync(input);
	409	input_report_key(input, keycode, 0);
df316e93	410	input_sync(input);
1f83511b	411
0bf6368e LT	412	acpi_bus_generate_netlink_event(
	413	device->pnp.device_class,
	414	dev_name(&device->dev),
	415	event, ++button->pushed);
c0968f0e	416	}
1da177e4 LT	417	break;
	418	default:
	419	ACPI_DEBUG_PRINT((ACPI_DB_INFO,
4be44fcd	420	"Unsupported event [0x%x]\n", event));
1da177e4 LT	421	break;
1da177e4 LT	422	}
1da177e4 LT	423	}
1da177e4 LT	424
90692404	425	#ifdef CONFIG_PM_SLEEP
e71eeb2a RW	426	static int acpi_button_suspend(struct device *dev)
	427	{
	428	struct acpi_device *device = to_acpi_device(dev);
	429	struct acpi_button *button = acpi_driver_data(device);
	430
	431	button->suspended = true;
	432	return 0;
	433	}
	434
1be532de	435	static int acpi_button_resume(struct device *dev)
23de5d9e	436	{
1be532de	437	struct acpi_device *device = to_acpi_device(dev);
1bce8113	438	struct acpi_button *button = acpi_driver_data(device);
50a4da89	439
e71eeb2a	440	button->suspended = false;
3540c32a LZ	441	if (button->type == ACPI_BUTTON_TYPE_LID)
3540c32a LZ	442	acpi_lid_initialize_state(device);
23de5d9e AS	443	return 0;
23de5d9e AS	444	}
90692404	445	#endif
23de5d9e	446
c0968f0e DT	447	static int acpi_button_add(struct acpi_device *device)
c0968f0e DT	448	{
c0968f0e DT	449	struct acpi_button *button;
c0968f0e DT	450	struct input_dev *input;
620e112c TR	451	const char *hid = acpi_device_hid(device);
620e112c TR	452	char name, class;
1bce8113	453	int error;
1da177e4	454
c0968f0e	455	button = kzalloc(sizeof(struct acpi_button), GFP_KERNEL);
1da177e4	456	if (!button)
d550d98d	457	return -ENOMEM;
1da177e4	458
db89b4f0	459	device->driver_data = button;
1da177e4	460
c0968f0e DT	461	button->input = input = input_allocate_device();
	462	if (!input) {
	463	error = -ENOMEM;
	464	goto err_free_button;
	465	}
	466
bf04a772 BH	467	name = acpi_device_name(device);
	468	class = acpi_device_class(device);
	469
d68b597c BH	470	if (!strcmp(hid, ACPI_BUTTON_HID_POWER) \|\|
d68b597c BH	471	!strcmp(hid, ACPI_BUTTON_HID_POWERF)) {
1da177e4	472	button->type = ACPI_BUTTON_TYPE_POWER;
bf04a772 BH	473	strcpy(name, ACPI_BUTTON_DEVICE_NAME_POWER);
bf04a772 BH	474	sprintf(class, "%s/%s",
1da177e4	475	ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_POWER);
d68b597c BH	476	} else if (!strcmp(hid, ACPI_BUTTON_HID_SLEEP) \|\|
d68b597c BH	477	!strcmp(hid, ACPI_BUTTON_HID_SLEEPF)) {
1da177e4	478	button->type = ACPI_BUTTON_TYPE_SLEEP;
bf04a772 BH	479	strcpy(name, ACPI_BUTTON_DEVICE_NAME_SLEEP);
bf04a772 BH	480	sprintf(class, "%s/%s",
1da177e4	481	ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_SLEEP);
bf04a772	482	} else if (!strcmp(hid, ACPI_BUTTON_HID_LID)) {
1da177e4	483	button->type = ACPI_BUTTON_TYPE_LID;
bf04a772 BH	484	strcpy(name, ACPI_BUTTON_DEVICE_NAME_LID);
bf04a772 BH	485	sprintf(class, "%s/%s",
1da177e4	486	ACPI_BUTTON_CLASS, ACPI_BUTTON_SUBCLASS_LID);
dfa46c50 LZ	487	button->last_state = !!acpi_lid_evaluate_state(device);
dfa46c50 LZ	488	button->last_time = ktime_get();
4be44fcd	489	} else {
bf04a772	490	printk(KERN_ERR PREFIX "Unsupported hid [%s]\n", hid);
c0968f0e DT	491	error = -ENODEV;
c0968f0e DT	492	goto err_free_input;
1da177e4 LT	493	}
1da177e4 LT	494
c0968f0e DT	495	error = acpi_button_add_fs(device);
	496	if (error)
	497	goto err_free_input;
	498
bf04a772	499	snprintf(button->phys, sizeof(button->phys), "%s/button/input0", hid);
c0968f0e	500
bf04a772	501	input->name = name;
c0968f0e DT	502	input->phys = button->phys;
	503	input->id.bustype = BUS_HOST;
	504	input->id.product = button->type;
3b34e523	505	input->dev.parent = &device->dev;
b34a8030	506
1da177e4	507	switch (button->type) {
c0968f0e	508	case ACPI_BUTTON_TYPE_POWER:
763f527b	509	input_set_capability(input, EV_KEY, KEY_POWER);
1da177e4	510	break;
c0968f0e DT	511
c0968f0e DT	512	case ACPI_BUTTON_TYPE_SLEEP:
763f527b	513	input_set_capability(input, EV_KEY, KEY_SLEEP);
1da177e4	514	break;
c0968f0e DT	515
c0968f0e DT	516	case ACPI_BUTTON_TYPE_LID:
763f527b	517	input_set_capability(input, EV_SW, SW_LID);
1da177e4 LT	518	break;
	519	}
	520
c0968f0e DT	521	error = input_register_device(input);
c0968f0e DT	522	if (error)
373cfc36	523	goto err_remove_fs;
7e12715e	524	if (button->type == ACPI_BUTTON_TYPE_LID) {
3540c32a	525	acpi_lid_initialize_state(device);
7e12715e JB	526	/*
	527	* This assumes there's only one lid device, or if there are
	528	* more we only care about the last one...
	529	*/
	530	lid_device = device;
	531	}
1da177e4	532
eed4d47e	533	device_init_wakeup(&device->dev, true);
bf04a772	534	printk(KERN_INFO PREFIX "%s [%s]\n", name, acpi_device_bid(device));
c0968f0e	535	return 0;
1da177e4	536
c0968f0e DT	537	err_remove_fs:
	538	acpi_button_remove_fs(device);
	539	err_free_input:
	540	input_free_device(input);
	541	err_free_button:
	542	kfree(button);
	543	return error;
1da177e4 LT	544	}
1da177e4 LT	545
51fac838	546	static int acpi_button_remove(struct acpi_device *device)
1da177e4	547	{
1bce8113	548	struct acpi_button *button = acpi_driver_data(device);
1da177e4	549
4be44fcd	550	acpi_button_remove_fs(device);
c0968f0e	551	input_unregister_device(button->input);
1da177e4	552	kfree(button);
d550d98d	553	return 0;
1da177e4 LT	554	}
1da177e4 LT	555
3540c32a LZ	556	static int param_set_lid_init_state(const char val, struct kernel_param kp)
	557	{
	558	int result = 0;
	559
	560	if (!strncmp(val, "open", sizeof("open") - 1)) {
	561	lid_init_state = ACPI_BUTTON_LID_INIT_OPEN;
	562	pr_info("Notify initial lid state as open\n");
3540c32a LZ	563	} else if (!strncmp(val, "ignore", sizeof("ignore") - 1)) {
	564	lid_init_state = ACPI_BUTTON_LID_INIT_IGNORE;
	565	pr_info("Do not notify initial lid state\n");
	566	} else
	567	result = -EINVAL;
	568	return result;
	569	}
	570
	571	static int param_get_lid_init_state(char buffer, struct kernel_param kp)
	572	{
	573	switch (lid_init_state) {
	574	case ACPI_BUTTON_LID_INIT_OPEN:
	575	return sprintf(buffer, "open");
3540c32a LZ	576	case ACPI_BUTTON_LID_INIT_IGNORE:
	577	return sprintf(buffer, "ignore");
	578	default:
	579	return sprintf(buffer, "invalid");
	580	}
	581	return 0;
	582	}
	583
	584	module_param_call(lid_init_state,
	585	param_set_lid_init_state, param_get_lid_init_state,
	586	NULL, 0644);
	587	MODULE_PARM_DESC(lid_init_state, "Behavior for reporting LID initial state");
	588
466e78f7	589	module_acpi_driver(acpi_button_driver);