[deliverable/linux.git] / drivers / usb / core / usb-acpi.c

/*
 * USB-ACPI glue code
 *
 * Copyright 2012 Red Hat <mjg@redhat.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, version 2.
 *
 */
#include <linux/module.h>
#include <linux/usb.h>
#include <linux/device.h>
#include <linux/errno.h>
#include <linux/kernel.h>
#include <linux/acpi.h>
#include <linux/pci.h>
#include <linux/usb/hcd.h>

#include "usb.h"

/**
 * usb_acpi_power_manageable - check whether usb port has
 * acpi power resource.
 * @hdev: USB device belonging to the usb hub
 * @index: port index based zero
 *
 * Return true if the port has acpi power resource and false if no.
 */
bool usb_acpi_power_manageable(struct usb_device *hdev, int index)
{
	acpi_handle port_handle;
	int port1 = index + 1;

	port_handle = usb_get_hub_port_acpi_handle(hdev,
		port1);
	if (port_handle)
		return acpi_bus_power_manageable(port_handle);
	else
		return false;
}
EXPORT_SYMBOL_GPL(usb_acpi_power_manageable);

/**
 * usb_acpi_set_power_state - control usb port's power via acpi power
 * resource
 * @hdev: USB device belonging to the usb hub
 * @index: port index based zero
 * @enable: power state expected to be set
 *
 * Notice to use usb_acpi_power_manageable() to check whether the usb port
 * has acpi power resource before invoking this function.
 *
 * Returns 0 on success, else negative errno.
 */
int usb_acpi_set_power_state(struct usb_device *hdev, int index, bool enable)
{
	acpi_handle port_handle;
	unsigned char state;
	int port1 = index + 1;
	int error = -EINVAL;

	port_handle = (acpi_handle)usb_get_hub_port_acpi_handle(hdev,
		port1);
	if (!port_handle)
		return error;

	if (enable)
		state = ACPI_STATE_D0;
	else
		state = ACPI_STATE_D3_COLD;

	error = acpi_bus_set_power(port_handle, state);
	if (!error)
		dev_dbg(&hdev->dev, "The power of hub port %d was set to %d\n",
			port1, enable);
	else
		dev_dbg(&hdev->dev, "The power of hub port failed to be set\n");

	return error;
}
EXPORT_SYMBOL_GPL(usb_acpi_set_power_state);

static int usb_acpi_check_port_connect_type(struct usb_device *hdev,
	acpi_handle handle, int port1)
{
	acpi_status status;
	struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
	union acpi_object *upc;
	struct acpi_pld_info *pld;
	int ret = 0;

	/*
	 * According to ACPI Spec 9.13. PLD indicates whether usb port is
	 * user visible and _UPC indicates whether it is connectable. If
	 * the port was visible and connectable, it could be freely connected
	 * and disconnected with USB devices. If no visible and connectable,
	 * a usb device is directly hard-wired to the port. If no visible and
	 * no connectable, the port would be not used.
	 */
	status = acpi_get_physical_device_location(handle, &pld);
	if (ACPI_FAILURE(status))
		return -ENODEV;

	status = acpi_evaluate_object(handle, "_UPC", NULL, &buffer);
	upc = buffer.pointer;
	if (!upc || (upc->type != ACPI_TYPE_PACKAGE)
		|| upc->package.count != 4) {
		ret = -EINVAL;
		goto out;
	}

	if (upc->package.elements[0].integer.value)
		if (pld->user_visible)
			usb_set_hub_port_connect_type(hdev, port1,
				USB_PORT_CONNECT_TYPE_HOT_PLUG);
		else
			usb_set_hub_port_connect_type(hdev, port1,
				USB_PORT_CONNECT_TYPE_HARD_WIRED);
	else if (!pld->user_visible)
		usb_set_hub_port_connect_type(hdev, port1, USB_PORT_NOT_USED);

out:
	ACPI_FREE(pld);
	kfree(upc);
	return ret;
}

static struct acpi_device *usb_acpi_find_companion(struct device *dev)
{
	struct usb_device *udev;
	acpi_handle *parent_handle;
	int port_num;

	/*
	 * In the ACPI DSDT table, only usb root hub and usb ports are
	 * acpi device nodes. The hierarchy like following.
	 * Device (EHC1)
	 *	Device (HUBN)
	 *		Device (PR01)
	 *			Device (PR11)
	 *			Device (PR12)
	 *			Device (PR13)
	 *			...
	 * So all binding process is divided into two parts. binding
	 * root hub and usb ports.
	 */
	if (is_usb_device(dev)) {
		udev = to_usb_device(dev);
		if (udev->parent) {
			enum usb_port_connect_type type;

			/*
			 * According usb port's connect type to set usb device's
			 * removability.
			 */
			type = usb_get_hub_port_connect_type(udev->parent,
				udev->portnum);
			switch (type) {
			case USB_PORT_CONNECT_TYPE_HOT_PLUG:
				udev->removable = USB_DEVICE_REMOVABLE;
				break;
			case USB_PORT_CONNECT_TYPE_HARD_WIRED:
				udev->removable = USB_DEVICE_FIXED;
				break;
			default:
				udev->removable = USB_DEVICE_REMOVABLE_UNKNOWN;
				break;
			}

			return NULL;
		}

		/* root hub's parent is the usb hcd. */
		return acpi_find_child_device(ACPI_COMPANION(dev->parent),
					      udev->portnum, false);
	} else if (is_usb_port(dev)) {
		struct acpi_device *adev = NULL;

		sscanf(dev_name(dev), "port%d", &port_num);
		/* Get the struct usb_device point of port's hub */
		udev = to_usb_device(dev->parent->parent);

		/*
		 * The root hub ports' parent is the root hub. The non-root-hub
		 * ports' parent is the parent hub port which the hub is
		 * connected to.
		 */
		if (!udev->parent) {
			struct usb_hcd *hcd = bus_to_hcd(udev->bus);
			int raw_port_num;

			raw_port_num = usb_hcd_find_raw_port_number(hcd,
				port_num);
			adev = acpi_find_child_device(ACPI_COMPANION(&udev->dev),
						      raw_port_num, false);
			if (!adev)
				return NULL;
		} else {
			parent_handle =
				usb_get_hub_port_acpi_handle(udev->parent,
				udev->portnum);
			if (!parent_handle)
				return NULL;

			acpi_bus_get_device(parent_handle, &adev);
			adev = acpi_find_child_device(adev, port_num, false);
			if (!adev)
				return NULL;
		}
		usb_acpi_check_port_connect_type(udev, adev->handle, port_num);
		return adev;
	}

	return NULL;
}

static bool usb_acpi_bus_match(struct device *dev)
{
	return is_usb_device(dev) || is_usb_port(dev);
}

static struct acpi_bus_type usb_acpi_bus = {
	.name = "USB",
	.match = usb_acpi_bus_match,
	.find_companion = usb_acpi_find_companion,
};

int usb_acpi_register(void)
{
	return register_acpi_bus_type(&usb_acpi_bus);
}

void usb_acpi_unregister(void)
{
	unregister_acpi_bus_type(&usb_acpi_bus);
}
Commit	Line	Data
da0af6e7 MG	1	/*
	2	* USB-ACPI glue code
	3	*
	4	* Copyright 2012 Red Hat <mjg@redhat.com>
	5	*
	6	* This program is free software; you can redistribute it and/or modify it
	7	* under the terms of the GNU General Public License as published by the Free
	8	* Software Foundation, version 2.
	9	*
	10	*/
	11	#include <linux/module.h>
	12	#include <linux/usb.h>
	13	#include <linux/device.h>
	14	#include <linux/errno.h>
	15	#include <linux/kernel.h>
	16	#include <linux/acpi.h>
	17	#include <linux/pci.h>
bafcaf6d	18	#include <linux/usb/hcd.h>
da0af6e7 MG	19
	20	#include "usb.h"
	21
f7ac7787 LT	22	/**
	23	* usb_acpi_power_manageable - check whether usb port has
	24	* acpi power resource.
	25	* @hdev: USB device belonging to the usb hub
	26	* @index: port index based zero
	27	*
	28	* Return true if the port has acpi power resource and false if no.
	29	*/
	30	bool usb_acpi_power_manageable(struct usb_device *hdev, int index)
	31	{
	32	acpi_handle port_handle;
	33	int port1 = index + 1;
	34
	35	port_handle = usb_get_hub_port_acpi_handle(hdev,
	36	port1);
	37	if (port_handle)
	38	return acpi_bus_power_manageable(port_handle);
	39	else
	40	return false;
	41	}
	42	EXPORT_SYMBOL_GPL(usb_acpi_power_manageable);
	43
	44	/**
	45	* usb_acpi_set_power_state - control usb port's power via acpi power
	46	* resource
	47	* @hdev: USB device belonging to the usb hub
	48	* @index: port index based zero
	49	* @enable: power state expected to be set
	50	*
	51	* Notice to use usb_acpi_power_manageable() to check whether the usb port
	52	* has acpi power resource before invoking this function.
	53	*
	54	* Returns 0 on success, else negative errno.
	55	*/
	56	int usb_acpi_set_power_state(struct usb_device *hdev, int index, bool enable)
	57	{
	58	acpi_handle port_handle;
	59	unsigned char state;
	60	int port1 = index + 1;
	61	int error = -EINVAL;
	62
	63	port_handle = (acpi_handle)usb_get_hub_port_acpi_handle(hdev,
	64	port1);
	65	if (!port_handle)
	66	return error;
	67
	68	if (enable)
	69	state = ACPI_STATE_D0;
	70	else
	71	state = ACPI_STATE_D3_COLD;
	72
	73	error = acpi_bus_set_power(port_handle, state);
	74	if (!error)
	75	dev_dbg(&hdev->dev, "The power of hub port %d was set to %d\n",
	76	port1, enable);
	77	else
	78	dev_dbg(&hdev->dev, "The power of hub port failed to be set\n");
	79
	80	return error;
	81	}
	82	EXPORT_SYMBOL_GPL(usb_acpi_set_power_state);
	83
05f91689 LT	84	static int usb_acpi_check_port_connect_type(struct usb_device *hdev,
05f91689 LT	85	acpi_handle handle, int port1)
54d3f8c6 MG	86	{
	87	acpi_status status;
	88	struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
	89	union acpi_object *upc;
d8dc91b7	90	struct acpi_pld_info *pld;
54d3f8c6 MG	91	int ret = 0;
54d3f8c6 MG	92
05f91689	93	/*
025d4430	94	* According to ACPI Spec 9.13. PLD indicates whether usb port is
05f91689 LT	95	* user visible and _UPC indicates whether it is connectable. If
	96	* the port was visible and connectable, it could be freely connected
	97	* and disconnected with USB devices. If no visible and connectable,
	98	* a usb device is directly hard-wired to the port. If no visible and
	99	* no connectable, the port would be not used.
	100	*/
	101	status = acpi_get_physical_device_location(handle, &pld);
54d3f8c6 MG	102	if (ACPI_FAILURE(status))
	103	return -ENODEV;
	104
05f91689	105	status = acpi_evaluate_object(handle, "_UPC", NULL, &buffer);
54d3f8c6	106	upc = buffer.pointer;
54d3f8c6 MG	107	if (!upc \|\| (upc->type != ACPI_TYPE_PACKAGE)
	108	\|\| upc->package.count != 4) {
	109	ret = -EINVAL;
	110	goto out;
	111	}
	112
	113	if (upc->package.elements[0].integer.value)
d8dc91b7	114	if (pld->user_visible)
05f91689 LT	115	usb_set_hub_port_connect_type(hdev, port1,
	116	USB_PORT_CONNECT_TYPE_HOT_PLUG);
	117	else
	118	usb_set_hub_port_connect_type(hdev, port1,
	119	USB_PORT_CONNECT_TYPE_HARD_WIRED);
d8dc91b7	120	else if (!pld->user_visible)
05f91689	121	usb_set_hub_port_connect_type(hdev, port1, USB_PORT_NOT_USED);
54d3f8c6 MG	122
54d3f8c6 MG	123	out:
d8dc91b7	124	ACPI_FREE(pld);
54d3f8c6 MG	125	kfree(upc);
	126	return ret;
	127	}
	128
e3f02c52	129	static struct acpi_device usb_acpi_find_companion(struct device dev)
da0af6e7 MG	130	{
da0af6e7 MG	131	struct usb_device *udev;
da0af6e7	132	acpi_handle *parent_handle;
d5575424	133	int port_num;
da0af6e7	134
d5575424 LT	135	/*
	136	* In the ACPI DSDT table, only usb root hub and usb ports are
	137	* acpi device nodes. The hierarchy like following.
	138	* Device (EHC1)
	139	* Device (HUBN)
	140	* Device (PR01)
	141	* Device (PR11)
	142	* Device (PR12)
	143	* Device (PR13)
	144	* ...
	145	* So all binding process is divided into two parts. binding
	146	* root hub and usb ports.
	147	*/
	148	if (is_usb_device(dev)) {
	149	udev = to_usb_device(dev);
05f91689 LT	150	if (udev->parent) {
	151	enum usb_port_connect_type type;
	152
	153	/*
	154	* According usb port's connect type to set usb device's
	155	* removability.
	156	*/
	157	type = usb_get_hub_port_connect_type(udev->parent,
	158	udev->portnum);
	159	switch (type) {
	160	case USB_PORT_CONNECT_TYPE_HOT_PLUG:
	161	udev->removable = USB_DEVICE_REMOVABLE;
	162	break;
	163	case USB_PORT_CONNECT_TYPE_HARD_WIRED:
	164	udev->removable = USB_DEVICE_FIXED;
	165	break;
	166	default:
	167	udev->removable = USB_DEVICE_REMOVABLE_UNKNOWN;
	168	break;
	169	}
	170
e3f02c52	171	return NULL;
05f91689 LT	172	}
05f91689 LT	173
d5575424	174	/* root hub's parent is the usb hcd. */
e3f02c52 RW	175	return acpi_find_child_device(ACPI_COMPANION(dev->parent),
e3f02c52 RW	176	udev->portnum, false);
d5575424	177	} else if (is_usb_port(dev)) {
e3f02c52 RW	178	struct acpi_device *adev = NULL;
e3f02c52 RW	179
d5575424 LT	180	sscanf(dev_name(dev), "port%d", &port_num);
	181	/* Get the struct usb_device point of port's hub */
	182	udev = to_usb_device(dev->parent->parent);
	183
	184	/*
	185	* The root hub ports' parent is the root hub. The non-root-hub
	186	* ports' parent is the parent hub port which the hub is
	187	* connected to.
	188	*/
	189	if (!udev->parent) {
bafcaf6d LT	190	struct usb_hcd *hcd = bus_to_hcd(udev->bus);
	191	int raw_port_num;
	192
	193	raw_port_num = usb_hcd_find_raw_port_number(hcd,
d5575424	194	port_num);
e3f02c52 RW	195	adev = acpi_find_child_device(ACPI_COMPANION(&udev->dev),
	196	raw_port_num, false);
	197	if (!adev)
	198	return NULL;
d5575424 LT	199	} else {
	200	parent_handle =
	201	usb_get_hub_port_acpi_handle(udev->parent,
	202	udev->portnum);
	203	if (!parent_handle)
e3f02c52	204	return NULL;
d5575424	205
e3f02c52 RW	206	acpi_bus_get_device(parent_handle, &adev);
	207	adev = acpi_find_child_device(adev, port_num, false);
	208	if (!adev)
	209	return NULL;
d5575424	210	}
e3f02c52 RW	211	usb_acpi_check_port_connect_type(udev, adev->handle, port_num);
	212	return adev;
	213	}
da0af6e7	214
e3f02c52	215	return NULL;
da0af6e7 MG	216	}
da0af6e7 MG	217
53540098 RW	218	static bool usb_acpi_bus_match(struct device *dev)
	219	{
	220	return is_usb_device(dev) \|\| is_usb_port(dev);
	221	}
	222
da0af6e7	223	static struct acpi_bus_type usb_acpi_bus = {
53540098 RW	224	.name = "USB",
53540098 RW	225	.match = usb_acpi_bus_match,
e3f02c52	226	.find_companion = usb_acpi_find_companion,
da0af6e7 MG	227	};
	228
	229	int usb_acpi_register(void)
	230	{
	231	return register_acpi_bus_type(&usb_acpi_bus);
	232	}
	233
	234	void usb_acpi_unregister(void)
	235	{
	236	unregister_acpi_bus_type(&usb_acpi_bus);
	237	}