[GitHub/moto-9609/android_kernel_motorola_exynos9610.git] / drivers / acpi / device_sysfs.c

/*
 * drivers/acpi/device_sysfs.c - ACPI device sysfs attributes and modalias.
 *
 * Copyright (C) 2015, Intel Corp.
 * Author: Mika Westerberg <mika.westerberg@linux.intel.com>
 * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2 as published
 *  by the Free Software Foundation.
 *
 *  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.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */

#include <linux/acpi.h>
#include <linux/device.h>
#include <linux/export.h>
#include <linux/nls.h>

#include "internal.h"

static ssize_t acpi_object_path(acpi_handle handle, char *buf)
{
	struct acpi_buffer path = {ACPI_ALLOCATE_BUFFER, NULL};
	int result;

	result = acpi_get_name(handle, ACPI_FULL_PATHNAME, &path);
	if (result)
		return result;

	result = sprintf(buf, "%s\n", (char *)path.pointer);
	kfree(path.pointer);
	return result;
}

struct acpi_data_node_attr {
	struct attribute attr;
	ssize_t (*show)(struct acpi_data_node *, char *);
	ssize_t (*store)(struct acpi_data_node *, const char *, size_t count);
};

#define DATA_NODE_ATTR(_name)			\
	static struct acpi_data_node_attr data_node_##_name =	\
		__ATTR(_name, 0444, data_node_show_##_name, NULL)

static ssize_t data_node_show_path(struct acpi_data_node *dn, char *buf)
{
	return dn->handle ? acpi_object_path(dn->handle, buf) : 0;
}

DATA_NODE_ATTR(path);

static struct attribute *acpi_data_node_default_attrs[] = {
	&data_node_path.attr,
	NULL
};

#define to_data_node(k) container_of(k, struct acpi_data_node, kobj)
#define to_attr(a) container_of(a, struct acpi_data_node_attr, attr)

static ssize_t acpi_data_node_attr_show(struct kobject *kobj,
					struct attribute *attr, char *buf)
{
	struct acpi_data_node *dn = to_data_node(kobj);
	struct acpi_data_node_attr *dn_attr = to_attr(attr);

	return dn_attr->show ? dn_attr->show(dn, buf) : -ENXIO;
}

static const struct sysfs_ops acpi_data_node_sysfs_ops = {
	.show	= acpi_data_node_attr_show,
};

static void acpi_data_node_release(struct kobject *kobj)
{
	struct acpi_data_node *dn = to_data_node(kobj);
	complete(&dn->kobj_done);
}

static struct kobj_type acpi_data_node_ktype = {
	.sysfs_ops = &acpi_data_node_sysfs_ops,
	.default_attrs = acpi_data_node_default_attrs,
	.release = acpi_data_node_release,
};

static void acpi_expose_nondev_subnodes(struct kobject *kobj,
					struct acpi_device_data *data)
{
	struct list_head *list = &data->subnodes;
	struct acpi_data_node *dn;

	if (list_empty(list))
		return;

	list_for_each_entry(dn, list, sibling) {
		int ret;

		init_completion(&dn->kobj_done);
		ret = kobject_init_and_add(&dn->kobj, &acpi_data_node_ktype,
					   kobj, "%s", dn->name);
		if (!ret)
			acpi_expose_nondev_subnodes(&dn->kobj, &dn->data);
		else if (dn->handle)
			acpi_handle_err(dn->handle, "Failed to expose (%d)\n", ret);
	}
}

static void acpi_hide_nondev_subnodes(struct acpi_device_data *data)
{
	struct list_head *list = &data->subnodes;
	struct acpi_data_node *dn;

	if (list_empty(list))
		return;

	list_for_each_entry_reverse(dn, list, sibling) {
		acpi_hide_nondev_subnodes(&dn->data);
		kobject_put(&dn->kobj);
	}
}

/**
 * create_pnp_modalias - Create hid/cid(s) string for modalias and uevent
 * @acpi_dev: ACPI device object.
 * @modalias: Buffer to print into.
 * @size: Size of the buffer.
 *
 * Creates hid/cid(s) string needed for modalias and uevent
 * e.g. on a device with hid:IBM0001 and cid:ACPI0001 you get:
 * char *modalias: "acpi:IBM0001:ACPI0001"
 * Return: 0: no _HID and no _CID
 *         -EINVAL: output error
 *         -ENOMEM: output is truncated
*/
static int create_pnp_modalias(struct acpi_device *acpi_dev, char *modalias,
			       int size)
{
	int len;
	int count;
	struct acpi_hardware_id *id;

	/* Avoid unnecessarily loading modules for non present devices. */
	if (!acpi_device_is_present(acpi_dev))
		return 0;

	/*
	 * Since we skip ACPI_DT_NAMESPACE_HID from the modalias below, 0 should
	 * be returned if ACPI_DT_NAMESPACE_HID is the only ACPI/PNP ID in the
	 * device's list.
	 */
	count = 0;
	list_for_each_entry(id, &acpi_dev->pnp.ids, list)
		if (strcmp(id->id, ACPI_DT_NAMESPACE_HID))
			count++;

	if (!count)
		return 0;

	len = snprintf(modalias, size, "acpi:");
	if (len <= 0)
		return len;

	size -= len;

	list_for_each_entry(id, &acpi_dev->pnp.ids, list) {
		if (!strcmp(id->id, ACPI_DT_NAMESPACE_HID))
			continue;

		count = snprintf(&modalias[len], size, "%s:", id->id);
		if (count < 0)
			return -EINVAL;

		if (count >= size)
			return -ENOMEM;

		len += count;
		size -= count;
	}
	modalias[len] = '\0';
	return len;
}

/**
 * create_of_modalias - Creates DT compatible string for modalias and uevent
 * @acpi_dev: ACPI device object.
 * @modalias: Buffer to print into.
 * @size: Size of the buffer.
 *
 * Expose DT compatible modalias as of:NnameTCcompatible.  This function should
 * only be called for devices having ACPI_DT_NAMESPACE_HID in their list of
 * ACPI/PNP IDs.
 */
static int create_of_modalias(struct acpi_device *acpi_dev, char *modalias,
			      int size)
{
	struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER };
	const union acpi_object *of_compatible, *obj;
	acpi_status status;
	int len, count;
	int i, nval;
	char *c;

	status = acpi_get_name(acpi_dev->handle, ACPI_SINGLE_NAME, &buf);
	if (ACPI_FAILURE(status))
		return -ENODEV;

	/* DT strings are all in lower case */
	for (c = buf.pointer; *c != '\0'; c++)
		*c = tolower(*c);

	len = snprintf(modalias, size, "of:N%sT", (char *)buf.pointer);
	ACPI_FREE(buf.pointer);

	if (len <= 0)
		return len;

	of_compatible = acpi_dev->data.of_compatible;
	if (of_compatible->type == ACPI_TYPE_PACKAGE) {
		nval = of_compatible->package.count;
		obj = of_compatible->package.elements;
	} else { /* Must be ACPI_TYPE_STRING. */
		nval = 1;
		obj = of_compatible;
	}
	for (i = 0; i < nval; i++, obj++) {
		count = snprintf(&modalias[len], size, "C%s",
				 obj->string.pointer);
		if (count < 0)
			return -EINVAL;

		if (count >= size)
			return -ENOMEM;

		len += count;
		size -= count;
	}
	modalias[len] = '\0';
	return len;
}

int __acpi_device_uevent_modalias(struct acpi_device *adev,
				  struct kobj_uevent_env *env)
{
	int len;

	if (!adev)
		return -ENODEV;

	if (list_empty(&adev->pnp.ids))
		return 0;

	if (add_uevent_var(env, "MODALIAS="))
		return -ENOMEM;

	len = create_pnp_modalias(adev, &env->buf[env->buflen - 1],
				  sizeof(env->buf) - env->buflen);
	if (len < 0)
		return len;

	env->buflen += len;
	if (!adev->data.of_compatible)
		return 0;

	if (len > 0 && add_uevent_var(env, "MODALIAS="))
		return -ENOMEM;

	len = create_of_modalias(adev, &env->buf[env->buflen - 1],
				 sizeof(env->buf) - env->buflen);
	if (len < 0)
		return len;

	env->buflen += len;

	return 0;
}

/**
 * acpi_device_uevent_modalias - uevent modalias for ACPI-enumerated devices.
 *
 * Create the uevent modalias field for ACPI-enumerated devices.
 *
 * Because other buses do not support ACPI HIDs & CIDs, e.g. for a device with
 * hid:IBM0001 and cid:ACPI0001 you get: "acpi:IBM0001:ACPI0001".
 */
int acpi_device_uevent_modalias(struct device *dev, struct kobj_uevent_env *env)
{
	return __acpi_device_uevent_modalias(acpi_companion_match(dev), env);
}
EXPORT_SYMBOL_GPL(acpi_device_uevent_modalias);

static int __acpi_device_modalias(struct acpi_device *adev, char *buf, int size)
{
	int len, count;

	if (!adev)
		return -ENODEV;

	if (list_empty(&adev->pnp.ids))
		return 0;

	len = create_pnp_modalias(adev, buf, size - 1);
	if (len < 0) {
		return len;
	} else if (len > 0) {
		buf[len++] = '\n';
		size -= len;
	}
	if (!adev->data.of_compatible)
		return len;

	count = create_of_modalias(adev, buf + len, size - 1);
	if (count < 0) {
		return count;
	} else if (count > 0) {
		len += count;
		buf[len++] = '\n';
	}

	return len;
}

/**
 * acpi_device_modalias - modalias sysfs attribute for ACPI-enumerated devices.
 *
 * Create the modalias sysfs attribute for ACPI-enumerated devices.
 *
 * Because other buses do not support ACPI HIDs & CIDs, e.g. for a device with
 * hid:IBM0001 and cid:ACPI0001 you get: "acpi:IBM0001:ACPI0001".
 */
int acpi_device_modalias(struct device *dev, char *buf, int size)
{
	return __acpi_device_modalias(acpi_companion_match(dev), buf, size);
}
EXPORT_SYMBOL_GPL(acpi_device_modalias);

static ssize_t
acpi_device_modalias_show(struct device *dev, struct device_attribute *attr, char *buf)
{
	return __acpi_device_modalias(to_acpi_device(dev), buf, 1024);
}
static DEVICE_ATTR(modalias, 0444, acpi_device_modalias_show, NULL);

static ssize_t real_power_state_show(struct device *dev,
				     struct device_attribute *attr, char *buf)
{
	struct acpi_device *adev = to_acpi_device(dev);
	int state;
	int ret;

	ret = acpi_device_get_power(adev, &state);
	if (ret)
		return ret;

	return sprintf(buf, "%s\n", acpi_power_state_string(state));
}

static DEVICE_ATTR(real_power_state, 0444, real_power_state_show, NULL);

static ssize_t power_state_show(struct device *dev,
				struct device_attribute *attr, char *buf)
{
	struct acpi_device *adev = to_acpi_device(dev);

	return sprintf(buf, "%s\n", acpi_power_state_string(adev->power.state));
}

static DEVICE_ATTR(power_state, 0444, power_state_show, NULL);

static ssize_t
acpi_eject_store(struct device *d, struct device_attribute *attr,
		const char *buf, size_t count)
{
	struct acpi_device *acpi_device = to_acpi_device(d);
	acpi_object_type not_used;
	acpi_status status;

	if (!count || buf[0] != '1')
		return -EINVAL;

	if ((!acpi_device->handler || !acpi_device->handler->hotplug.enabled)
	    && !acpi_device->driver)
		return -ENODEV;

	status = acpi_get_type(acpi_device->handle, &not_used);
	if (ACPI_FAILURE(status) || !acpi_device->flags.ejectable)
		return -ENODEV;

	get_device(&acpi_device->dev);
	status = acpi_hotplug_schedule(acpi_device, ACPI_OST_EC_OSPM_EJECT);
	if (ACPI_SUCCESS(status))
		return count;

	put_device(&acpi_device->dev);
	acpi_evaluate_ost(acpi_device->handle, ACPI_OST_EC_OSPM_EJECT,
			  ACPI_OST_SC_NON_SPECIFIC_FAILURE, NULL);
	return status == AE_NO_MEMORY ? -ENOMEM : -EAGAIN;
}

static DEVICE_ATTR(eject, 0200, NULL, acpi_eject_store);

static ssize_t
acpi_device_hid_show(struct device *dev, struct device_attribute *attr, char *buf)
{
	struct acpi_device *acpi_dev = to_acpi_device(dev);

	return sprintf(buf, "%s\n", acpi_device_hid(acpi_dev));
}
static DEVICE_ATTR(hid, 0444, acpi_device_hid_show, NULL);

static ssize_t acpi_device_uid_show(struct device *dev,
				    struct device_attribute *attr, char *buf)
{
	struct acpi_device *acpi_dev = to_acpi_device(dev);

	return sprintf(buf, "%s\n", acpi_dev->pnp.unique_id);
}
static DEVICE_ATTR(uid, 0444, acpi_device_uid_show, NULL);

static ssize_t acpi_device_adr_show(struct device *dev,
				    struct device_attribute *attr, char *buf)
{
	struct acpi_device *acpi_dev = to_acpi_device(dev);

	return sprintf(buf, "0x%08x\n",
		       (unsigned int)(acpi_dev->pnp.bus_address));
}
static DEVICE_ATTR(adr, 0444, acpi_device_adr_show, NULL);

static ssize_t acpi_device_path_show(struct device *dev,
				     struct device_attribute *attr, char *buf)
{
	struct acpi_device *acpi_dev = to_acpi_device(dev);

	return acpi_object_path(acpi_dev->handle, buf);
}
static DEVICE_ATTR(path, 0444, acpi_device_path_show, NULL);

/* sysfs file that shows description text from the ACPI _STR method */
static ssize_t description_show(struct device *dev,
				struct device_attribute *attr,
				char *buf) {
	struct acpi_device *acpi_dev = to_acpi_device(dev);
	int result;

	if (acpi_dev->pnp.str_obj == NULL)
		return 0;

	/*
	 * The _STR object contains a Unicode identifier for a device.
	 * We need to convert to utf-8 so it can be displayed.
	 */
	result = utf16s_to_utf8s(
		(wchar_t *)acpi_dev->pnp.str_obj->buffer.pointer,
		acpi_dev->pnp.str_obj->buffer.length,
		UTF16_LITTLE_ENDIAN, buf,
		PAGE_SIZE);

	buf[result++] = '\n';

	return result;
}
static DEVICE_ATTR(description, 0444, description_show, NULL);

static ssize_t
acpi_device_sun_show(struct device *dev, struct device_attribute *attr,
		     char *buf) {
	struct acpi_device *acpi_dev = to_acpi_device(dev);
	acpi_status status;
	unsigned long long sun;

	status = acpi_evaluate_integer(acpi_dev->handle, "_SUN", NULL, &sun);
	if (ACPI_FAILURE(status))
		return -EIO;

	return sprintf(buf, "%llu\n", sun);
}
static DEVICE_ATTR(sun, 0444, acpi_device_sun_show, NULL);

static ssize_t
acpi_device_hrv_show(struct device *dev, struct device_attribute *attr,
		     char *buf) {
	struct acpi_device *acpi_dev = to_acpi_device(dev);
	acpi_status status;
	unsigned long long hrv;

	status = acpi_evaluate_integer(acpi_dev->handle, "_HRV", NULL, &hrv);
	if (ACPI_FAILURE(status))
		return -EIO;

	return sprintf(buf, "%llu\n", hrv);
}
static DEVICE_ATTR(hrv, 0444, acpi_device_hrv_show, NULL);

static ssize_t status_show(struct device *dev, struct device_attribute *attr,
				char *buf) {
	struct acpi_device *acpi_dev = to_acpi_device(dev);
	acpi_status status;
	unsigned long long sta;

	status = acpi_evaluate_integer(acpi_dev->handle, "_STA", NULL, &sta);
	if (ACPI_FAILURE(status))
		return -EIO;

	return sprintf(buf, "%llu\n", sta);
}
static DEVICE_ATTR_RO(status);

/**
 * acpi_device_setup_files - Create sysfs attributes of an ACPI device.
 * @dev: ACPI device object.
 */
int acpi_device_setup_files(struct acpi_device *dev)
{
	struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
	acpi_status status;
	int result = 0;

	/*
	 * Devices gotten from FADT don't have a "path" attribute
	 */
	if (dev->handle) {
		result = device_create_file(&dev->dev, &dev_attr_path);
		if (result)
			goto end;
	}

	if (!list_empty(&dev->pnp.ids)) {
		result = device_create_file(&dev->dev, &dev_attr_hid);
		if (result)
			goto end;

		result = device_create_file(&dev->dev, &dev_attr_modalias);
		if (result)
			goto end;
	}

	/*
	 * If device has _STR, 'description' file is created
	 */
	if (acpi_has_method(dev->handle, "_STR")) {
		status = acpi_evaluate_object(dev->handle, "_STR",
					NULL, &buffer);
		if (ACPI_FAILURE(status))
			buffer.pointer = NULL;
		dev->pnp.str_obj = buffer.pointer;
		result = device_create_file(&dev->dev, &dev_attr_description);
		if (result)
			goto end;
	}

	if (dev->pnp.type.bus_address)
		result = device_create_file(&dev->dev, &dev_attr_adr);
	if (dev->pnp.unique_id)
		result = device_create_file(&dev->dev, &dev_attr_uid);

	if (acpi_has_method(dev->handle, "_SUN")) {
		result = device_create_file(&dev->dev, &dev_attr_sun);
		if (result)
			goto end;
	}

	if (acpi_has_method(dev->handle, "_HRV")) {
		result = device_create_file(&dev->dev, &dev_attr_hrv);
		if (result)
			goto end;
	}

	if (acpi_has_method(dev->handle, "_STA")) {
		result = device_create_file(&dev->dev, &dev_attr_status);
		if (result)
			goto end;
	}

	/*
	 * If device has _EJ0, 'eject' file is created that is used to trigger
	 * hot-removal function from userland.
	 */
	if (acpi_has_method(dev->handle, "_EJ0")) {
		result = device_create_file(&dev->dev, &dev_attr_eject);
		if (result)
			return result;
	}

	if (dev->flags.power_manageable) {
		result = device_create_file(&dev->dev, &dev_attr_power_state);
		if (result)
			return result;

		if (dev->power.flags.power_resources)
			result = device_create_file(&dev->dev,
						    &dev_attr_real_power_state);
	}

	acpi_expose_nondev_subnodes(&dev->dev.kobj, &dev->data);

end:
	return result;
}

/**
 * acpi_device_remove_files - Remove sysfs attributes of an ACPI device.
 * @dev: ACPI device object.
 */
void acpi_device_remove_files(struct acpi_device *dev)
{
	acpi_hide_nondev_subnodes(&dev->data);

	if (dev->flags.power_manageable) {
		device_remove_file(&dev->dev, &dev_attr_power_state);
		if (dev->power.flags.power_resources)
			device_remove_file(&dev->dev,
					   &dev_attr_real_power_state);
	}

	/*
	 * If device has _STR, remove 'description' file
	 */
	if (acpi_has_method(dev->handle, "_STR")) {
		kfree(dev->pnp.str_obj);
		device_remove_file(&dev->dev, &dev_attr_description);
	}
	/*
	 * If device has _EJ0, remove 'eject' file.
	 */
	if (acpi_has_method(dev->handle, "_EJ0"))
		device_remove_file(&dev->dev, &dev_attr_eject);

	if (acpi_has_method(dev->handle, "_SUN"))
		device_remove_file(&dev->dev, &dev_attr_sun);

	if (acpi_has_method(dev->handle, "_HRV"))
		device_remove_file(&dev->dev, &dev_attr_hrv);

	if (dev->pnp.unique_id)
		device_remove_file(&dev->dev, &dev_attr_uid);
	if (dev->pnp.type.bus_address)
		device_remove_file(&dev->dev, &dev_attr_adr);
	device_remove_file(&dev->dev, &dev_attr_modalias);
	device_remove_file(&dev->dev, &dev_attr_hid);
	if (acpi_has_method(dev->handle, "_STA"))
		device_remove_file(&dev->dev, &dev_attr_status);
	if (dev->handle)
		device_remove_file(&dev->dev, &dev_attr_path);
}
Commit	Line	Data
c2efefb3 RW	1	/*
	2	* drivers/acpi/device_sysfs.c - ACPI device sysfs attributes and modalias.
	3	*
	4	* Copyright (C) 2015, Intel Corp.
	5	* Author: Mika Westerberg <mika.westerberg@linux.intel.com>
	6	* Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
	7	*
	8	* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	9	*
	10	* This program is free software; you can redistribute it and/or modify
	11	* it under the terms of the GNU General Public License version 2 as published
	12	* by the Free Software Foundation.
	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	*
	19	* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	20	*/
	21
	22	#include <linux/acpi.h>
	23	#include <linux/device.h>
	24	#include <linux/export.h>
	25	#include <linux/nls.h>
	26
	27	#include "internal.h"
	28
263b4c1a RW	29	static ssize_t acpi_object_path(acpi_handle handle, char *buf)
	30	{
	31	struct acpi_buffer path = {ACPI_ALLOCATE_BUFFER, NULL};
	32	int result;
	33
	34	result = acpi_get_name(handle, ACPI_FULL_PATHNAME, &path);
	35	if (result)
	36	return result;
	37
a508d954	38	result = sprintf(buf, "%s\n", (char *)path.pointer);
263b4c1a RW	39	kfree(path.pointer);
	40	return result;
	41	}
	42
	43	struct acpi_data_node_attr {
	44	struct attribute attr;
	45	ssize_t (show)(struct acpi_data_node , char *);
	46	ssize_t (store)(struct acpi_data_node , const char *, size_t count);
	47	};
	48
	49	#define DATA_NODE_ATTR(_name) \
	50	static struct acpi_data_node_attr data_node_##_name = \
	51	__ATTR(_name, 0444, data_node_show_##_name, NULL)
	52
	53	static ssize_t data_node_show_path(struct acpi_data_node dn, char buf)
	54	{
99db5ff7	55	return dn->handle ? acpi_object_path(dn->handle, buf) : 0;
263b4c1a RW	56	}
	57
	58	DATA_NODE_ATTR(path);
	59
	60	static struct attribute *acpi_data_node_default_attrs[] = {
	61	&data_node_path.attr,
	62	NULL
	63	};
	64
	65	#define to_data_node(k) container_of(k, struct acpi_data_node, kobj)
	66	#define to_attr(a) container_of(a, struct acpi_data_node_attr, attr)
	67
	68	static ssize_t acpi_data_node_attr_show(struct kobject *kobj,
	69	struct attribute attr, char buf)
	70	{
	71	struct acpi_data_node *dn = to_data_node(kobj);
	72	struct acpi_data_node_attr *dn_attr = to_attr(attr);
	73
	74	return dn_attr->show ? dn_attr->show(dn, buf) : -ENXIO;
	75	}
	76
	77	static const struct sysfs_ops acpi_data_node_sysfs_ops = {
	78	.show = acpi_data_node_attr_show,
	79	};
	80
	81	static void acpi_data_node_release(struct kobject *kobj)
	82	{
	83	struct acpi_data_node *dn = to_data_node(kobj);
	84	complete(&dn->kobj_done);
	85	}
	86
	87	static struct kobj_type acpi_data_node_ktype = {
	88	.sysfs_ops = &acpi_data_node_sysfs_ops,
	89	.default_attrs = acpi_data_node_default_attrs,
	90	.release = acpi_data_node_release,
	91	};
	92
	93	static void acpi_expose_nondev_subnodes(struct kobject *kobj,
	94	struct acpi_device_data *data)
	95	{
	96	struct list_head *list = &data->subnodes;
	97	struct acpi_data_node *dn;
	98
	99	if (list_empty(list))
	100	return;
	101
	102	list_for_each_entry(dn, list, sibling) {
	103	int ret;
	104
	105	init_completion(&dn->kobj_done);
	106	ret = kobject_init_and_add(&dn->kobj, &acpi_data_node_ktype,
9db22d92	107	kobj, "%s", dn->name);
99db5ff7	108	if (!ret)
263b4c1a	109	acpi_expose_nondev_subnodes(&dn->kobj, &dn->data);
99db5ff7 RW	110	else if (dn->handle)
99db5ff7 RW	111	acpi_handle_err(dn->handle, "Failed to expose (%d)\n", ret);
263b4c1a RW	112	}
	113	}
	114
	115	static void acpi_hide_nondev_subnodes(struct acpi_device_data *data)
	116	{
	117	struct list_head *list = &data->subnodes;
	118	struct acpi_data_node *dn;
	119
	120	if (list_empty(list))
	121	return;
	122
	123	list_for_each_entry_reverse(dn, list, sibling) {
	124	acpi_hide_nondev_subnodes(&dn->data);
	125	kobject_put(&dn->kobj);
	126	}
	127	}
	128
c2efefb3 RW	129	/**
	130	* create_pnp_modalias - Create hid/cid(s) string for modalias and uevent
	131	* @acpi_dev: ACPI device object.
	132	* @modalias: Buffer to print into.
	133	* @size: Size of the buffer.
	134	*
	135	* Creates hid/cid(s) string needed for modalias and uevent
	136	* e.g. on a device with hid:IBM0001 and cid:ACPI0001 you get:
	137	* char *modalias: "acpi:IBM0001:ACPI0001"
	138	* Return: 0: no _HID and no _CID
	139	* -EINVAL: output error
	140	* -ENOMEM: output is truncated
	141	*/
	142	static int create_pnp_modalias(struct acpi_device acpi_dev, char modalias,
	143	int size)
	144	{
	145	int len;
	146	int count;
	147	struct acpi_hardware_id *id;
	148
cb78d818 HG	149	/* Avoid unnecessarily loading modules for non present devices. */
	150	if (!acpi_device_is_present(acpi_dev))
	151	return 0;
	152
c2efefb3 RW	153	/*
	154	* Since we skip ACPI_DT_NAMESPACE_HID from the modalias below, 0 should
	155	* be returned if ACPI_DT_NAMESPACE_HID is the only ACPI/PNP ID in the
	156	* device's list.
	157	*/
	158	count = 0;
	159	list_for_each_entry(id, &acpi_dev->pnp.ids, list)
	160	if (strcmp(id->id, ACPI_DT_NAMESPACE_HID))
	161	count++;
	162
	163	if (!count)
	164	return 0;
	165
	166	len = snprintf(modalias, size, "acpi:");
	167	if (len <= 0)
	168	return len;
	169
	170	size -= len;
	171
	172	list_for_each_entry(id, &acpi_dev->pnp.ids, list) {
	173	if (!strcmp(id->id, ACPI_DT_NAMESPACE_HID))
	174	continue;
	175
	176	count = snprintf(&modalias[len], size, "%s:", id->id);
	177	if (count < 0)
	178	return -EINVAL;
	179
	180	if (count >= size)
	181	return -ENOMEM;
	182
	183	len += count;
	184	size -= count;
	185	}
	186	modalias[len] = '\0';
	187	return len;
	188	}
	189
	190	/**
	191	* create_of_modalias - Creates DT compatible string for modalias and uevent
	192	* @acpi_dev: ACPI device object.
	193	* @modalias: Buffer to print into.
	194	* @size: Size of the buffer.
	195	*
	196	* Expose DT compatible modalias as of:NnameTCcompatible. This function should
	197	* only be called for devices having ACPI_DT_NAMESPACE_HID in their list of
	198	* ACPI/PNP IDs.
	199	*/
	200	static int create_of_modalias(struct acpi_device acpi_dev, char modalias,
	201	int size)
	202	{
	203	struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER };
	204	const union acpi_object of_compatible, obj;
5b25ec3a	205	acpi_status status;
c2efefb3 RW	206	int len, count;
	207	int i, nval;
	208	char *c;
	209
5b25ec3a AS	210	status = acpi_get_name(acpi_dev->handle, ACPI_SINGLE_NAME, &buf);
	211	if (ACPI_FAILURE(status))
	212	return -ENODEV;
	213
c2efefb3 RW	214	/* DT strings are all in lower case */
	215	for (c = buf.pointer; *c != '\0'; c++)
	216	c = tolower(c);
	217
	218	len = snprintf(modalias, size, "of:N%sT", (char *)buf.pointer);
	219	ACPI_FREE(buf.pointer);
	220
	221	if (len <= 0)
	222	return len;
	223
	224	of_compatible = acpi_dev->data.of_compatible;
	225	if (of_compatible->type == ACPI_TYPE_PACKAGE) {
	226	nval = of_compatible->package.count;
	227	obj = of_compatible->package.elements;
	228	} else { /* Must be ACPI_TYPE_STRING. */
	229	nval = 1;
	230	obj = of_compatible;
	231	}
	232	for (i = 0; i < nval; i++, obj++) {
	233	count = snprintf(&modalias[len], size, "C%s",
	234	obj->string.pointer);
	235	if (count < 0)
	236	return -EINVAL;
	237
	238	if (count >= size)
	239	return -ENOMEM;
	240
	241	len += count;
	242	size -= count;
	243	}
	244	modalias[len] = '\0';
	245	return len;
	246	}
	247
	248	int __acpi_device_uevent_modalias(struct acpi_device *adev,
	249	struct kobj_uevent_env *env)
	250	{
	251	int len;
	252
	253	if (!adev)
	254	return -ENODEV;
	255
	256	if (list_empty(&adev->pnp.ids))
	257	return 0;
	258
	259	if (add_uevent_var(env, "MODALIAS="))
	260	return -ENOMEM;
	261
	262	len = create_pnp_modalias(adev, &env->buf[env->buflen - 1],
	263	sizeof(env->buf) - env->buflen);
	264	if (len < 0)
	265	return len;
	266
	267	env->buflen += len;
	268	if (!adev->data.of_compatible)
	269	return 0;
	270
	271	if (len > 0 && add_uevent_var(env, "MODALIAS="))
	272	return -ENOMEM;
	273
	274	len = create_of_modalias(adev, &env->buf[env->buflen - 1],
	275	sizeof(env->buf) - env->buflen);
	276	if (len < 0)
	277	return len;
278
279	env->buflen += len;
280
281	return 0;
282	}
283
284	/**
285	* acpi_device_uevent_modalias - uevent modalias for ACPI-enumerated devices.
286	*
287	* Create the uevent modalias field for ACPI-enumerated devices.
288	*
289	* Because other buses do not support ACPI HIDs & CIDs, e.g. for a device with
290	* hid:IBM0001 and cid:ACPI0001 you get: "acpi:IBM0001:ACPI0001".
291	*/
292	int acpi_device_uevent_modalias(struct device dev, struct kobj_uevent_env env)
293	{
294	return __acpi_device_uevent_modalias(acpi_companion_match(dev), env);
295	}
296	EXPORT_SYMBOL_GPL(acpi_device_uevent_modalias);
297
298	static int __acpi_device_modalias(struct acpi_device adev, char buf, int size)
299	{
300	int len, count;
301
302	if (!adev)
303	return -ENODEV;
304
305	if (list_empty(&adev->pnp.ids))
306	return 0;
307
308	len = create_pnp_modalias(adev, buf, size - 1);
309	if (len < 0) {
310	return len;
311	} else if (len > 0) {
312	buf[len++] = '\n';
313	size -= len;
314	}
315	if (!adev->data.of_compatible)
316	return len;
317
318	count = create_of_modalias(adev, buf + len, size - 1);
319	if (count < 0) {
320	return count;
321	} else if (count > 0) {
322	len += count;
323	buf[len++] = '\n';
324	}
325
326	return len;
327	}
328
329	/**
330	* acpi_device_modalias - modalias sysfs attribute for ACPI-enumerated devices.
331	*
332	* Create the modalias sysfs attribute for ACPI-enumerated devices.
333	*
334	* Because other buses do not support ACPI HIDs & CIDs, e.g. for a device with
335	* hid:IBM0001 and cid:ACPI0001 you get: "acpi:IBM0001:ACPI0001".
336	*/
337	int acpi_device_modalias(struct device dev, char buf, int size)
338	{
339	return __acpi_device_modalias(acpi_companion_match(dev), buf, size);
340	}
341	EXPORT_SYMBOL_GPL(acpi_device_modalias);
342
343	static ssize_t
a508d954 BD	344	acpi_device_modalias_show(struct device dev, struct device_attribute attr, char *buf)
a508d954 BD	345	{
c2efefb3 RW	346	return __acpi_device_modalias(to_acpi_device(dev), buf, 1024);
	347	}
	348	static DEVICE_ATTR(modalias, 0444, acpi_device_modalias_show, NULL);
	349
	350	static ssize_t real_power_state_show(struct device *dev,
	351	struct device_attribute attr, char buf)
	352	{
	353	struct acpi_device *adev = to_acpi_device(dev);
	354	int state;
	355	int ret;
	356
	357	ret = acpi_device_get_power(adev, &state);
	358	if (ret)
	359	return ret;
	360
	361	return sprintf(buf, "%s\n", acpi_power_state_string(state));
	362	}
	363
	364	static DEVICE_ATTR(real_power_state, 0444, real_power_state_show, NULL);
	365
	366	static ssize_t power_state_show(struct device *dev,
	367	struct device_attribute attr, char buf)
	368	{
	369	struct acpi_device *adev = to_acpi_device(dev);
	370
	371	return sprintf(buf, "%s\n", acpi_power_state_string(adev->power.state));
	372	}
	373
	374	static DEVICE_ATTR(power_state, 0444, power_state_show, NULL);
	375
	376	static ssize_t
	377	acpi_eject_store(struct device d, struct device_attribute attr,
	378	const char *buf, size_t count)
	379	{
	380	struct acpi_device *acpi_device = to_acpi_device(d);
	381	acpi_object_type not_used;
	382	acpi_status status;
	383
	384	if (!count \|\| buf[0] != '1')
	385	return -EINVAL;
	386
	387	if ((!acpi_device->handler \|\| !acpi_device->handler->hotplug.enabled)
	388	&& !acpi_device->driver)
	389	return -ENODEV;
	390
	391	status = acpi_get_type(acpi_device->handle, &not_used);
	392	if (ACPI_FAILURE(status) \|\| !acpi_device->flags.ejectable)
	393	return -ENODEV;
	394
	395	get_device(&acpi_device->dev);
	396	status = acpi_hotplug_schedule(acpi_device, ACPI_OST_EC_OSPM_EJECT);
	397	if (ACPI_SUCCESS(status))
	398	return count;
	399
	400	put_device(&acpi_device->dev);
	401	acpi_evaluate_ost(acpi_device->handle, ACPI_OST_EC_OSPM_EJECT,
	402	ACPI_OST_SC_NON_SPECIFIC_FAILURE, NULL);
	403	return status == AE_NO_MEMORY ? -ENOMEM : -EAGAIN;
	404	}
	405
	406	static DEVICE_ATTR(eject, 0200, NULL, acpi_eject_store);
	407
	408	static ssize_t
a508d954 BD	409	acpi_device_hid_show(struct device dev, struct device_attribute attr, char *buf)
a508d954 BD	410	{
c2efefb3 RW	411	struct acpi_device *acpi_dev = to_acpi_device(dev);
	412
	413	return sprintf(buf, "%s\n", acpi_device_hid(acpi_dev));
	414	}
	415	static DEVICE_ATTR(hid, 0444, acpi_device_hid_show, NULL);
	416
	417	static ssize_t acpi_device_uid_show(struct device *dev,
	418	struct device_attribute attr, char buf)
	419	{
	420	struct acpi_device *acpi_dev = to_acpi_device(dev);
	421
	422	return sprintf(buf, "%s\n", acpi_dev->pnp.unique_id);
	423	}
	424	static DEVICE_ATTR(uid, 0444, acpi_device_uid_show, NULL);
	425
	426	static ssize_t acpi_device_adr_show(struct device *dev,
	427	struct device_attribute attr, char buf)
	428	{
	429	struct acpi_device *acpi_dev = to_acpi_device(dev);
	430
	431	return sprintf(buf, "0x%08x\n",
	432	(unsigned int)(acpi_dev->pnp.bus_address));
	433	}
	434	static DEVICE_ATTR(adr, 0444, acpi_device_adr_show, NULL);
	435
263b4c1a RW	436	static ssize_t acpi_device_path_show(struct device *dev,
	437	struct device_attribute attr, char buf)
	438	{
c2efefb3	439	struct acpi_device *acpi_dev = to_acpi_device(dev);
c2efefb3	440
263b4c1a	441	return acpi_object_path(acpi_dev->handle, buf);
c2efefb3 RW	442	}
	443	static DEVICE_ATTR(path, 0444, acpi_device_path_show, NULL);
	444
	445	/* sysfs file that shows description text from the ACPI _STR method */
	446	static ssize_t description_show(struct device *dev,
	447	struct device_attribute *attr,
	448	char *buf) {
	449	struct acpi_device *acpi_dev = to_acpi_device(dev);
	450	int result;
	451
	452	if (acpi_dev->pnp.str_obj == NULL)
	453	return 0;
	454
	455	/*
	456	* The _STR object contains a Unicode identifier for a device.
	457	* We need to convert to utf-8 so it can be displayed.
	458	*/
	459	result = utf16s_to_utf8s(
	460	(wchar_t *)acpi_dev->pnp.str_obj->buffer.pointer,
	461	acpi_dev->pnp.str_obj->buffer.length,
	462	UTF16_LITTLE_ENDIAN, buf,
	463	PAGE_SIZE);
	464
	465	buf[result++] = '\n';
	466
	467	return result;
	468	}
	469	static DEVICE_ATTR(description, 0444, description_show, NULL);
	470
	471	static ssize_t
	472	acpi_device_sun_show(struct device dev, struct device_attribute attr,
	473	char *buf) {
	474	struct acpi_device *acpi_dev = to_acpi_device(dev);
	475	acpi_status status;
	476	unsigned long long sun;
	477
	478	status = acpi_evaluate_integer(acpi_dev->handle, "_SUN", NULL, &sun);
	479	if (ACPI_FAILURE(status))
6c024409	480	return -EIO;
c2efefb3 RW	481
	482	return sprintf(buf, "%llu\n", sun);
	483	}
	484	static DEVICE_ATTR(sun, 0444, acpi_device_sun_show, NULL);
	485
6283f97d BD	486	static ssize_t
	487	acpi_device_hrv_show(struct device dev, struct device_attribute attr,
	488	char *buf) {
	489	struct acpi_device *acpi_dev = to_acpi_device(dev);
	490	acpi_status status;
	491	unsigned long long hrv;
	492
	493	status = acpi_evaluate_integer(acpi_dev->handle, "_HRV", NULL, &hrv);
	494	if (ACPI_FAILURE(status))
	495	return -EIO;
	496
	497	return sprintf(buf, "%llu\n", hrv);
	498	}
	499	static DEVICE_ATTR(hrv, 0444, acpi_device_hrv_show, NULL);
	500
c2efefb3 RW	501	static ssize_t status_show(struct device dev, struct device_attribute attr,
	502	char *buf) {
	503	struct acpi_device *acpi_dev = to_acpi_device(dev);
	504	acpi_status status;
	505	unsigned long long sta;
	506
	507	status = acpi_evaluate_integer(acpi_dev->handle, "_STA", NULL, &sta);
	508	if (ACPI_FAILURE(status))
6c024409	509	return -EIO;
c2efefb3 RW	510
	511	return sprintf(buf, "%llu\n", sta);
	512	}
	513	static DEVICE_ATTR_RO(status);
	514
	515	/**
	516	* acpi_device_setup_files - Create sysfs attributes of an ACPI device.
	517	* @dev: ACPI device object.
	518	*/
	519	int acpi_device_setup_files(struct acpi_device *dev)
	520	{
	521	struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
	522	acpi_status status;
	523	int result = 0;
	524
	525	/*
	526	* Devices gotten from FADT don't have a "path" attribute
	527	*/
	528	if (dev->handle) {
	529	result = device_create_file(&dev->dev, &dev_attr_path);
	530	if (result)
	531	goto end;
	532	}
	533
	534	if (!list_empty(&dev->pnp.ids)) {
	535	result = device_create_file(&dev->dev, &dev_attr_hid);
	536	if (result)
	537	goto end;
	538
	539	result = device_create_file(&dev->dev, &dev_attr_modalias);
	540	if (result)
	541	goto end;
	542	}
	543
	544	/*
	545	* If device has _STR, 'description' file is created
	546	*/
	547	if (acpi_has_method(dev->handle, "_STR")) {
	548	status = acpi_evaluate_object(dev->handle, "_STR",
	549	NULL, &buffer);
	550	if (ACPI_FAILURE(status))
	551	buffer.pointer = NULL;
	552	dev->pnp.str_obj = buffer.pointer;
	553	result = device_create_file(&dev->dev, &dev_attr_description);
	554	if (result)
	555	goto end;
	556	}
	557
	558	if (dev->pnp.type.bus_address)
	559	result = device_create_file(&dev->dev, &dev_attr_adr);
	560	if (dev->pnp.unique_id)
	561	result = device_create_file(&dev->dev, &dev_attr_uid);
	562
	563	if (acpi_has_method(dev->handle, "_SUN")) {
	564	result = device_create_file(&dev->dev, &dev_attr_sun);
	565	if (result)
	566	goto end;
	567	}
	568
6283f97d BD	569	if (acpi_has_method(dev->handle, "_HRV")) {
	570	result = device_create_file(&dev->dev, &dev_attr_hrv);
	571	if (result)
	572	goto end;
	573	}
	574
c2efefb3 RW	575	if (acpi_has_method(dev->handle, "_STA")) {
	576	result = device_create_file(&dev->dev, &dev_attr_status);
	577	if (result)
	578	goto end;
	579	}
	580
a508d954 BD	581	/*
	582	* If device has _EJ0, 'eject' file is created that is used to trigger
	583	* hot-removal function from userland.
	584	*/
c2efefb3 RW	585	if (acpi_has_method(dev->handle, "_EJ0")) {
	586	result = device_create_file(&dev->dev, &dev_attr_eject);
	587	if (result)
	588	return result;
	589	}
	590
	591	if (dev->flags.power_manageable) {
	592	result = device_create_file(&dev->dev, &dev_attr_power_state);
	593	if (result)
	594	return result;
	595
	596	if (dev->power.flags.power_resources)
	597	result = device_create_file(&dev->dev,
	598	&dev_attr_real_power_state);
	599	}
	600
263b4c1a RW	601	acpi_expose_nondev_subnodes(&dev->dev.kobj, &dev->data);
263b4c1a RW	602
c2efefb3 RW	603	end:
	604	return result;
	605	}
	606
	607	/**
	608	* acpi_device_remove_files - Remove sysfs attributes of an ACPI device.
	609	* @dev: ACPI device object.
	610	*/
	611	void acpi_device_remove_files(struct acpi_device *dev)
	612	{
263b4c1a RW	613	acpi_hide_nondev_subnodes(&dev->data);
263b4c1a RW	614
c2efefb3 RW	615	if (dev->flags.power_manageable) {
	616	device_remove_file(&dev->dev, &dev_attr_power_state);
	617	if (dev->power.flags.power_resources)
	618	device_remove_file(&dev->dev,
	619	&dev_attr_real_power_state);
	620	}
	621
	622	/*
	623	* If device has _STR, remove 'description' file
	624	*/
	625	if (acpi_has_method(dev->handle, "_STR")) {
	626	kfree(dev->pnp.str_obj);
	627	device_remove_file(&dev->dev, &dev_attr_description);
	628	}
	629	/*
	630	* If device has _EJ0, remove 'eject' file.
	631	*/
	632	if (acpi_has_method(dev->handle, "_EJ0"))
	633	device_remove_file(&dev->dev, &dev_attr_eject);
	634
	635	if (acpi_has_method(dev->handle, "_SUN"))
	636	device_remove_file(&dev->dev, &dev_attr_sun);
	637
6283f97d BD	638	if (acpi_has_method(dev->handle, "_HRV"))
	639	device_remove_file(&dev->dev, &dev_attr_hrv);
	640
c2efefb3 RW	641	if (dev->pnp.unique_id)
	642	device_remove_file(&dev->dev, &dev_attr_uid);
	643	if (dev->pnp.type.bus_address)
	644	device_remove_file(&dev->dev, &dev_attr_adr);
	645	device_remove_file(&dev->dev, &dev_attr_modalias);
	646	device_remove_file(&dev->dev, &dev_attr_hid);
	647	if (acpi_has_method(dev->handle, "_STA"))
	648	device_remove_file(&dev->dev, &dev_attr_status);
	649	if (dev->handle)
	650	device_remove_file(&dev->dev, &dev_attr_path);
	651	}