[linux-2.6-block.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 "hub.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)
{
	struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
	struct usb_port *port_dev;
	acpi_handle port_handle;
	unsigned char state;
	int port1 = index + 1;
	int error = -EINVAL;

	if (!hub)
		return -ENODEV;
	port_dev = hub->ports[port1 - 1];

	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(&port_dev->dev, "acpi: power was set to %d\n", enable);
	else
		dev_dbg(&port_dev->dev, "acpi: power failed to be set\n");

	return error;
}
EXPORT_SYMBOL_GPL(usb_acpi_set_power_state);

static enum usb_port_connect_type usb_acpi_get_connect_type(acpi_handle handle,
		struct acpi_pld_info *pld)
{
	enum usb_port_connect_type connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
	struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
	union acpi_object *upc;
	acpi_status status;

	/*
	 * 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_evaluate_object(handle, "_UPC", NULL, &buffer);
	upc = buffer.pointer;
	if (!upc || (upc->type != ACPI_TYPE_PACKAGE)
		|| upc->package.count != 4) {
		goto out;
	}

	if (upc->package.elements[0].integer.value)
		if (pld->user_visible)
			connect_type = USB_PORT_CONNECT_TYPE_HOT_PLUG;
		else
			connect_type = USB_PORT_CONNECT_TYPE_HARD_WIRED;
	else if (!pld->user_visible)
		connect_type = USB_PORT_NOT_USED;
out:
	kfree(upc);
	return connect_type;
}


/*
 * Private to usb-acpi, all the core needs to know is that
 * port_dev->location is non-zero when it has been set by the firmware.
 */
#define USB_ACPI_LOCATION_VALID (1 << 31)

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

	/*
	 * 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)
			return NULL;

		/* root hub is only child (_ADR=0) under its parent, the HC */
		adev = ACPI_COMPANION(dev->parent);
		return acpi_find_child_device(adev, 0, false);
	} else if (is_usb_port(dev)) {
		struct usb_port *port_dev = to_usb_port(dev);
		int port1 = port_dev->portnum;
		struct acpi_pld_info *pld;
		acpi_handle *handle;
		acpi_status status;

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

			raw = usb_hcd_find_raw_port_number(hcd, port1);
			adev = acpi_find_child_device(ACPI_COMPANION(&udev->dev),
					raw, 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, port1, false);
			if (!adev)
				return NULL;
		}
		handle = adev->handle;
		status = acpi_get_physical_device_location(handle, &pld);
		if (ACPI_FAILURE(status) || !pld)
			return adev;

		port_dev->location = USB_ACPI_LOCATION_VALID
			| pld->group_token << 8 | pld->group_position;
		port_dev->connect_type = usb_acpi_get_connect_type(handle, pld);
		ACPI_FREE(pld);

		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	19
d99f6b41	20	#include "hub.h"
da0af6e7	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	{
d99f6b41 DW	58	struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
d99f6b41 DW	59	struct usb_port *port_dev;
f7ac7787 LT	60	acpi_handle port_handle;
	61	unsigned char state;
	62	int port1 = index + 1;
	63	int error = -EINVAL;
	64
d99f6b41 DW	65	if (!hub)
	66	return -ENODEV;
	67	port_dev = hub->ports[port1 - 1];
	68
	69	port_handle = (acpi_handle) usb_get_hub_port_acpi_handle(hdev, port1);
f7ac7787 LT	70	if (!port_handle)
	71	return error;
	72
	73	if (enable)
	74	state = ACPI_STATE_D0;
	75	else
	76	state = ACPI_STATE_D3_COLD;
	77
	78	error = acpi_bus_set_power(port_handle, state);
	79	if (!error)
d99f6b41	80	dev_dbg(&port_dev->dev, "acpi: power was set to %d\n", enable);
f7ac7787	81	else
d99f6b41	82	dev_dbg(&port_dev->dev, "acpi: power failed to be set\n");
f7ac7787 LT	83
	84	return error;
	85	}
	86	EXPORT_SYMBOL_GPL(usb_acpi_set_power_state);
	87
3bfd659b DW	88	static enum usb_port_connect_type usb_acpi_get_connect_type(acpi_handle handle,
3bfd659b DW	89	struct acpi_pld_info *pld)
54d3f8c6	90	{
d99f6b41	91	enum usb_port_connect_type connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
54d3f8c6	92	struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
d99f6b41 DW	93	union acpi_object *upc;
d99f6b41 DW	94	acpi_status status;
d99f6b41	95
05f91689	96	/*
025d4430	97	* According to ACPI Spec 9.13. PLD indicates whether usb port is
05f91689 LT	98	* user visible and _UPC indicates whether it is connectable. If
	99	* the port was visible and connectable, it could be freely connected
	100	* and disconnected with USB devices. If no visible and connectable,
	101	* a usb device is directly hard-wired to the port. If no visible and
	102	* no connectable, the port would be not used.
	103	*/
05f91689	104	status = acpi_evaluate_object(handle, "_UPC", NULL, &buffer);
54d3f8c6	105	upc = buffer.pointer;
54d3f8c6 MG	106	if (!upc \|\| (upc->type != ACPI_TYPE_PACKAGE)
54d3f8c6 MG	107	\|\| upc->package.count != 4) {
54d3f8c6 MG	108	goto out;
	109	}
	110
	111	if (upc->package.elements[0].integer.value)
d8dc91b7	112	if (pld->user_visible)
d99f6b41	113	connect_type = USB_PORT_CONNECT_TYPE_HOT_PLUG;
05f91689	114	else
d99f6b41	115	connect_type = USB_PORT_CONNECT_TYPE_HARD_WIRED;
d8dc91b7	116	else if (!pld->user_visible)
d99f6b41	117	connect_type = USB_PORT_NOT_USED;
54d3f8c6 MG	118	out:
54d3f8c6 MG	119	kfree(upc);
3bfd659b	120	return connect_type;
54d3f8c6 MG	121	}
54d3f8c6 MG	122
3bfd659b DW	123
	124	/*
	125	* Private to usb-acpi, all the core needs to know is that
	126	* port_dev->location is non-zero when it has been set by the firmware.
	127	*/
	128	#define USB_ACPI_LOCATION_VALID (1 << 31)
	129
e3f02c52	130	static struct acpi_device usb_acpi_find_companion(struct device dev)
da0af6e7 MG	131	{
da0af6e7 MG	132	struct usb_device *udev;
a4204ff0	133	struct acpi_device *adev;
da0af6e7 MG	134	acpi_handle *parent_handle;
da0af6e7 MG	135
d5575424 LT	136	/*
	137	* In the ACPI DSDT table, only usb root hub and usb ports are
	138	* acpi device nodes. The hierarchy like following.
	139	* Device (EHC1)
	140	* Device (HUBN)
	141	* Device (PR01)
	142	* Device (PR11)
	143	* Device (PR12)
	144	* Device (PR13)
	145	* ...
	146	* So all binding process is divided into two parts. binding
	147	* root hub and usb ports.
	148	*/
	149	if (is_usb_device(dev)) {
	150	udev = to_usb_device(dev);
a4204ff0	151	if (udev->parent)
e3f02c52	152	return NULL;
05f91689	153
a4204ff0 DW	154	/* root hub is only child (_ADR=0) under its parent, the HC */
	155	adev = ACPI_COMPANION(dev->parent);
	156	return acpi_find_child_device(adev, 0, false);
d5575424	157	} else if (is_usb_port(dev)) {
d99f6b41	158	struct usb_port *port_dev = to_usb_port(dev);
a4204ff0	159	int port1 = port_dev->portnum;
3bfd659b DW	160	struct acpi_pld_info *pld;
	161	acpi_handle *handle;
	162	acpi_status status;
e3f02c52	163
d5575424 LT	164	/* Get the struct usb_device point of port's hub */
	165	udev = to_usb_device(dev->parent->parent);
	166
	167	/*
	168	* The root hub ports' parent is the root hub. The non-root-hub
	169	* ports' parent is the parent hub port which the hub is
	170	* connected to.
	171	*/
	172	if (!udev->parent) {
bafcaf6d	173	struct usb_hcd *hcd = bus_to_hcd(udev->bus);
d99f6b41	174	int raw;
bafcaf6d	175
d99f6b41	176	raw = usb_hcd_find_raw_port_number(hcd, port1);
e3f02c52	177	adev = acpi_find_child_device(ACPI_COMPANION(&udev->dev),
d99f6b41	178	raw, false);
e3f02c52 RW	179	if (!adev)
e3f02c52 RW	180	return NULL;
d5575424 LT	181	} else {
	182	parent_handle =
	183	usb_get_hub_port_acpi_handle(udev->parent,
	184	udev->portnum);
	185	if (!parent_handle)
e3f02c52	186	return NULL;
d5575424	187
e3f02c52	188	acpi_bus_get_device(parent_handle, &adev);
d99f6b41	189	adev = acpi_find_child_device(adev, port1, false);
e3f02c52 RW	190	if (!adev)
e3f02c52 RW	191	return NULL;
d5575424	192	}
3bfd659b DW	193	handle = adev->handle;
	194	status = acpi_get_physical_device_location(handle, &pld);
	195	if (ACPI_FAILURE(status) \|\| !pld)
	196	return adev;
	197
	198	port_dev->location = USB_ACPI_LOCATION_VALID
	199	\| pld->group_token << 8 \| pld->group_position;
	200	port_dev->connect_type = usb_acpi_get_connect_type(handle, pld);
	201	ACPI_FREE(pld);
	202
e3f02c52 RW	203	return adev;
e3f02c52 RW	204	}
da0af6e7	205
e3f02c52	206	return NULL;
da0af6e7 MG	207	}
da0af6e7 MG	208
53540098 RW	209	static bool usb_acpi_bus_match(struct device *dev)
	210	{
	211	return is_usb_device(dev) \|\| is_usb_port(dev);
	212	}
	213
da0af6e7	214	static struct acpi_bus_type usb_acpi_bus = {
53540098 RW	215	.name = "USB",
53540098 RW	216	.match = usb_acpi_bus_match,
e3f02c52	217	.find_companion = usb_acpi_find_companion,
da0af6e7 MG	218	};
	219
	220	int usb_acpi_register(void)
	221	{
	222	return register_acpi_bus_type(&usb_acpi_bus);
	223	}
	224
	225	void usb_acpi_unregister(void)
	226	{
	227	unregister_acpi_bus_type(&usb_acpi_bus);
	228	}