[mirror_ubuntu-artful-kernel.git] / drivers / usb / common / common.c

/*
 * Provides code common for host and device side USB.
 *
 * 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.
 *
 * If either host side (ie. CONFIG_USB=y) or device side USB stack
 * (ie. CONFIG_USB_GADGET=y) is compiled in the kernel, this module is
 * compiled-in as well.  Otherwise, if either of the two stacks is
 * compiled as module, this file is compiled as module as well.
 */

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/usb/ch9.h>
#include <linux/usb/of.h>
#include <linux/usb/otg.h>

const char *usb_otg_state_string(enum usb_otg_state state)
{
	static const char *const names[] = {
		[OTG_STATE_A_IDLE] = "a_idle",
		[OTG_STATE_A_WAIT_VRISE] = "a_wait_vrise",
		[OTG_STATE_A_WAIT_BCON] = "a_wait_bcon",
		[OTG_STATE_A_HOST] = "a_host",
		[OTG_STATE_A_SUSPEND] = "a_suspend",
		[OTG_STATE_A_PERIPHERAL] = "a_peripheral",
		[OTG_STATE_A_WAIT_VFALL] = "a_wait_vfall",
		[OTG_STATE_A_VBUS_ERR] = "a_vbus_err",
		[OTG_STATE_B_IDLE] = "b_idle",
		[OTG_STATE_B_SRP_INIT] = "b_srp_init",
		[OTG_STATE_B_PERIPHERAL] = "b_peripheral",
		[OTG_STATE_B_WAIT_ACON] = "b_wait_acon",
		[OTG_STATE_B_HOST] = "b_host",
	};

	if (state < 0 || state >= ARRAY_SIZE(names))
		return "UNDEFINED";

	return names[state];
}
EXPORT_SYMBOL_GPL(usb_otg_state_string);

static const char *const speed_names[] = {
	[USB_SPEED_UNKNOWN] = "UNKNOWN",
	[USB_SPEED_LOW] = "low-speed",
	[USB_SPEED_FULL] = "full-speed",
	[USB_SPEED_HIGH] = "high-speed",
	[USB_SPEED_WIRELESS] = "wireless",
	[USB_SPEED_SUPER] = "super-speed",
};

const char *usb_speed_string(enum usb_device_speed speed)
{
	if (speed < 0 || speed >= ARRAY_SIZE(speed_names))
		speed = USB_SPEED_UNKNOWN;
	return speed_names[speed];
}
EXPORT_SYMBOL_GPL(usb_speed_string);

enum usb_device_speed usb_get_maximum_speed(struct device *dev)
{
	const char *maximum_speed;
	int err;
	int i;

	err = device_property_read_string(dev, "maximum-speed", &maximum_speed);
	if (err < 0)
		return USB_SPEED_UNKNOWN;

	for (i = 0; i < ARRAY_SIZE(speed_names); i++)
		if (strcmp(maximum_speed, speed_names[i]) == 0)
			return i;

	return USB_SPEED_UNKNOWN;
}
EXPORT_SYMBOL_GPL(usb_get_maximum_speed);

const char *usb_state_string(enum usb_device_state state)
{
	static const char *const names[] = {
		[USB_STATE_NOTATTACHED] = "not attached",
		[USB_STATE_ATTACHED] = "attached",
		[USB_STATE_POWERED] = "powered",
		[USB_STATE_RECONNECTING] = "reconnecting",
		[USB_STATE_UNAUTHENTICATED] = "unauthenticated",
		[USB_STATE_DEFAULT] = "default",
		[USB_STATE_ADDRESS] = "addressed",
		[USB_STATE_CONFIGURED] = "configured",
		[USB_STATE_SUSPENDED] = "suspended",
	};

	if (state < 0 || state >= ARRAY_SIZE(names))
		return "UNKNOWN";

	return names[state];
}
EXPORT_SYMBOL_GPL(usb_state_string);

static const char *const usb_dr_modes[] = {
	[USB_DR_MODE_UNKNOWN]		= "",
	[USB_DR_MODE_HOST]		= "host",
	[USB_DR_MODE_PERIPHERAL]	= "peripheral",
	[USB_DR_MODE_OTG]		= "otg",
};

enum usb_dr_mode usb_get_dr_mode(struct device *dev)
{
	const char *dr_mode;
	int err, i;

	err = device_property_read_string(dev, "dr_mode", &dr_mode);
	if (err < 0)
		return USB_DR_MODE_UNKNOWN;

	for (i = 0; i < ARRAY_SIZE(usb_dr_modes); i++)
		if (!strcmp(dr_mode, usb_dr_modes[i]))
			return i;

	return USB_DR_MODE_UNKNOWN;
}
EXPORT_SYMBOL_GPL(usb_get_dr_mode);

#ifdef CONFIG_OF
/**
 * of_usb_host_tpl_support - to get if Targeted Peripheral List is supported
 * for given targeted hosts (non-PC hosts)
 * @np: Pointer to the given device_node
 *
 * The function gets if the targeted hosts support TPL or not
 */
bool of_usb_host_tpl_support(struct device_node *np)
{
	if (of_find_property(np, "tpl-support", NULL))
		return true;

	return false;
}
EXPORT_SYMBOL_GPL(of_usb_host_tpl_support);

/**
 * of_usb_update_otg_caps - to update usb otg capabilities according to
 * the passed properties in DT.
 * @np: Pointer to the given device_node
 * @otg_caps: Pointer to the target usb_otg_caps to be set
 *
 * The function updates the otg capabilities
 */
int of_usb_update_otg_caps(struct device_node *np,
			struct usb_otg_caps *otg_caps)
{
	u32 otg_rev;

	if (!otg_caps)
		return -EINVAL;

	if (!of_property_read_u32(np, "otg-rev", &otg_rev)) {
		switch (otg_rev) {
		case 0x0100:
		case 0x0120:
		case 0x0130:
		case 0x0200:
			/* Choose the lesser one if it's already been set */
			if (otg_caps->otg_rev)
				otg_caps->otg_rev = min_t(u16, otg_rev,
							otg_caps->otg_rev);
			else
				otg_caps->otg_rev = otg_rev;
			break;
		default:
			pr_err("%s: unsupported otg-rev: 0x%x\n",
						np->full_name, otg_rev);
			return -EINVAL;
		}
	} else {
		/*
		 * otg-rev is mandatory for otg properties, if not passed
		 * we set it to be 0 and assume it's a legacy otg device.
		 * Non-dt platform can set it afterwards.
		 */
		otg_caps->otg_rev = 0;
	}

	if (of_find_property(np, "hnp-disable", NULL))
		otg_caps->hnp_support = false;
	if (of_find_property(np, "srp-disable", NULL))
		otg_caps->srp_support = false;
	if (of_find_property(np, "adp-disable", NULL) ||
				(otg_caps->otg_rev < 0x0200))
		otg_caps->adp_support = false;

	return 0;
}
EXPORT_SYMBOL_GPL(of_usb_update_otg_caps);

#endif

MODULE_LICENSE("GPL");
Commit	Line	Data
e538dfda MN	1	/*
	2	* Provides code common for host and device side USB.
	3	*
	4	* This program is free software; you can redistribute it and/or
	5	* modify it under the terms of the GNU General Public License as
	6	* published by the Free Software Foundation, version 2.
	7	*
	8	* If either host side (ie. CONFIG_USB=y) or device side USB stack
	9	* (ie. CONFIG_USB_GADGET=y) is compiled in the kernel, this module is
	10	* compiled-in as well. Otherwise, if either of the two stacks is
	11	* compiled as module, this file is compiled as module as well.
	12	*/
	13
	14	#include <linux/kernel.h>
	15	#include <linux/module.h>
1c9af653	16	#include <linux/of.h>
e538dfda	17	#include <linux/usb/ch9.h>
1c9af653	18	#include <linux/usb/of.h>
7009bdd7 FB	19	#include <linux/usb/otg.h>
	20
	21	const char *usb_otg_state_string(enum usb_otg_state state)
	22	{
	23	static const char *const names[] = {
	24	[OTG_STATE_A_IDLE] = "a_idle",
	25	[OTG_STATE_A_WAIT_VRISE] = "a_wait_vrise",
	26	[OTG_STATE_A_WAIT_BCON] = "a_wait_bcon",
	27	[OTG_STATE_A_HOST] = "a_host",
	28	[OTG_STATE_A_SUSPEND] = "a_suspend",
	29	[OTG_STATE_A_PERIPHERAL] = "a_peripheral",
	30	[OTG_STATE_A_WAIT_VFALL] = "a_wait_vfall",
	31	[OTG_STATE_A_VBUS_ERR] = "a_vbus_err",
	32	[OTG_STATE_B_IDLE] = "b_idle",
	33	[OTG_STATE_B_SRP_INIT] = "b_srp_init",
	34	[OTG_STATE_B_PERIPHERAL] = "b_peripheral",
	35	[OTG_STATE_B_WAIT_ACON] = "b_wait_acon",
	36	[OTG_STATE_B_HOST] = "b_host",
	37	};
	38
	39	if (state < 0 \|\| state >= ARRAY_SIZE(names))
	40	return "UNDEFINED";
	41
	42	return names[state];
	43	}
	44	EXPORT_SYMBOL_GPL(usb_otg_state_string);
e538dfda	45
1494a1f6 FB	46	static const char *const speed_names[] = {
	47	[USB_SPEED_UNKNOWN] = "UNKNOWN",
	48	[USB_SPEED_LOW] = "low-speed",
	49	[USB_SPEED_FULL] = "full-speed",
	50	[USB_SPEED_HIGH] = "high-speed",
	51	[USB_SPEED_WIRELESS] = "wireless",
	52	[USB_SPEED_SUPER] = "super-speed",
	53	};
	54
e538dfda MN	55	const char *usb_speed_string(enum usb_device_speed speed)
e538dfda MN	56	{
1494a1f6	57	if (speed < 0 \|\| speed >= ARRAY_SIZE(speed_names))
e538dfda	58	speed = USB_SPEED_UNKNOWN;
1494a1f6	59	return speed_names[speed];
e538dfda MN	60	}
	61	EXPORT_SYMBOL_GPL(usb_speed_string);
	62
63863b98 HK	63	enum usb_device_speed usb_get_maximum_speed(struct device *dev)
	64	{
	65	const char *maximum_speed;
	66	int err;
	67	int i;
	68
	69	err = device_property_read_string(dev, "maximum-speed", &maximum_speed);
	70	if (err < 0)
	71	return USB_SPEED_UNKNOWN;
	72
	73	for (i = 0; i < ARRAY_SIZE(speed_names); i++)
	74	if (strcmp(maximum_speed, speed_names[i]) == 0)
	75	return i;
	76
	77	return USB_SPEED_UNKNOWN;
	78	}
	79	EXPORT_SYMBOL_GPL(usb_get_maximum_speed);
	80
d1e3d757 FB	81	const char *usb_state_string(enum usb_device_state state)
	82	{
	83	static const char *const names[] = {
	84	[USB_STATE_NOTATTACHED] = "not attached",
	85	[USB_STATE_ATTACHED] = "attached",
	86	[USB_STATE_POWERED] = "powered",
	87	[USB_STATE_RECONNECTING] = "reconnecting",
	88	[USB_STATE_UNAUTHENTICATED] = "unauthenticated",
	89	[USB_STATE_DEFAULT] = "default",
f9076e28	90	[USB_STATE_ADDRESS] = "addressed",
d1e3d757 FB	91	[USB_STATE_CONFIGURED] = "configured",
	92	[USB_STATE_SUSPENDED] = "suspended",
	93	};
	94
	95	if (state < 0 \|\| state >= ARRAY_SIZE(names))
	96	return "UNKNOWN";
	97
	98	return names[state];
	99	}
	100	EXPORT_SYMBOL_GPL(usb_state_string);
	101
1c9af653 MG	102	static const char *const usb_dr_modes[] = {
	103	[USB_DR_MODE_UNKNOWN] = "",
	104	[USB_DR_MODE_HOST] = "host",
	105	[USB_DR_MODE_PERIPHERAL] = "peripheral",
	106	[USB_DR_MODE_OTG] = "otg",
	107	};
	108
06e7114f	109	enum usb_dr_mode usb_get_dr_mode(struct device *dev)
1c9af653 MG	110	{
	111	const char *dr_mode;
	112	int err, i;
	113
06e7114f	114	err = device_property_read_string(dev, "dr_mode", &dr_mode);
1c9af653 MG	115	if (err < 0)
	116	return USB_DR_MODE_UNKNOWN;
	117
	118	for (i = 0; i < ARRAY_SIZE(usb_dr_modes); i++)
	119	if (!strcmp(dr_mode, usb_dr_modes[i]))
	120	return i;
	121
	122	return USB_DR_MODE_UNKNOWN;
	123	}
06e7114f	124	EXPORT_SYMBOL_GPL(usb_get_dr_mode);
1494a1f6	125
06e7114f	126	#ifdef CONFIG_OF
05f8b35a PC	127	/**
	128	* of_usb_host_tpl_support - to get if Targeted Peripheral List is supported
	129	* for given targeted hosts (non-PC hosts)
	130	* @np: Pointer to the given device_node
	131	*
	132	* The function gets if the targeted hosts support TPL or not
	133	*/
	134	bool of_usb_host_tpl_support(struct device_node *np)
	135	{
	136	if (of_find_property(np, "tpl-support", NULL))
	137	return true;
	138
	139	return false;
	140	}
	141	EXPORT_SYMBOL_GPL(of_usb_host_tpl_support);
929412d9 LJ	142
	143	/**
	144	* of_usb_update_otg_caps - to update usb otg capabilities according to
	145	* the passed properties in DT.
	146	* @np: Pointer to the given device_node
	147	* @otg_caps: Pointer to the target usb_otg_caps to be set
	148	*
	149	* The function updates the otg capabilities
	150	*/
	151	int of_usb_update_otg_caps(struct device_node *np,
	152	struct usb_otg_caps *otg_caps)
	153	{
	154	u32 otg_rev;
	155
	156	if (!otg_caps)
	157	return -EINVAL;
	158
	159	if (!of_property_read_u32(np, "otg-rev", &otg_rev)) {
	160	switch (otg_rev) {
	161	case 0x0100:
	162	case 0x0120:
	163	case 0x0130:
	164	case 0x0200:
	165	/* Choose the lesser one if it's already been set */
	166	if (otg_caps->otg_rev)
	167	otg_caps->otg_rev = min_t(u16, otg_rev,
	168	otg_caps->otg_rev);
	169	else
	170	otg_caps->otg_rev = otg_rev;
	171	break;
	172	default:
	173	pr_err("%s: unsupported otg-rev: 0x%x\n",
	174	np->full_name, otg_rev);
	175	return -EINVAL;
	176	}
	177	} else {
	178	/*
	179	* otg-rev is mandatory for otg properties, if not passed
	180	* we set it to be 0 and assume it's a legacy otg device.
	181	* Non-dt platform can set it afterwards.
	182	*/
	183	otg_caps->otg_rev = 0;
	184	}
	185
	186	if (of_find_property(np, "hnp-disable", NULL))
	187	otg_caps->hnp_support = false;
	188	if (of_find_property(np, "srp-disable", NULL))
	189	otg_caps->srp_support = false;
	190	if (of_find_property(np, "adp-disable", NULL) \|\|
	191	(otg_caps->otg_rev < 0x0200))
	192	otg_caps->adp_support = false;
	193
	194	return 0;
	195	}
	196	EXPORT_SYMBOL_GPL(of_usb_update_otg_caps);
	197
1c9af653 MG	198	#endif
1c9af653 MG	199
e538dfda	200	MODULE_LICENSE("GPL");