[mirror_ubuntu-focal-kernel.git] / include / linux / usb / otg.h

/* USB OTG (On The Go) defines */
/*
 *
 * These APIs may be used between USB controllers.  USB device drivers
 * (for either host or peripheral roles) don't use these calls; they
 * continue to use just usb_device and usb_gadget.
 */

#ifndef __LINUX_USB_OTG_H
#define __LINUX_USB_OTG_H

#include <linux/notifier.h>

/* OTG defines lots of enumeration states before device reset */
enum usb_otg_state {
	OTG_STATE_UNDEFINED = 0,

	/* single-role peripheral, and dual-role default-b */
	OTG_STATE_B_IDLE,
	OTG_STATE_B_SRP_INIT,
	OTG_STATE_B_PERIPHERAL,

	/* extra dual-role default-b states */
	OTG_STATE_B_WAIT_ACON,
	OTG_STATE_B_HOST,

	/* dual-role default-a */
	OTG_STATE_A_IDLE,
	OTG_STATE_A_WAIT_VRISE,
	OTG_STATE_A_WAIT_BCON,
	OTG_STATE_A_HOST,
	OTG_STATE_A_SUSPEND,
	OTG_STATE_A_PERIPHERAL,
	OTG_STATE_A_WAIT_VFALL,
	OTG_STATE_A_VBUS_ERR,
};

enum usb_phy_events {
	USB_EVENT_NONE,         /* no events or cable disconnected */
	USB_EVENT_VBUS,         /* vbus valid event */
	USB_EVENT_ID,           /* id was grounded */
	USB_EVENT_CHARGER,      /* usb dedicated charger */
	USB_EVENT_ENUMERATED,   /* gadget driver enumerated */
};

struct usb_phy;

/* for transceivers connected thru an ULPI interface, the user must
 * provide access ops
 */
struct usb_phy_io_ops {
	int (*read)(struct usb_phy *x, u32 reg);
	int (*write)(struct usb_phy *x, u32 val, u32 reg);
};

struct usb_otg {
	u8			default_a;

	struct usb_phy		*phy;
	struct usb_bus		*host;
	struct usb_gadget	*gadget;

	/* bind/unbind the host controller */
	int	(*set_host)(struct usb_otg *otg, struct usb_bus *host);

	/* bind/unbind the peripheral controller */
	int	(*set_peripheral)(struct usb_otg *otg,
					struct usb_gadget *gadget);

	/* effective for A-peripheral, ignored for B devices */
	int	(*set_vbus)(struct usb_otg *otg, bool enabled);

	/* for B devices only:  start session with A-Host */
	int	(*start_srp)(struct usb_otg *otg);

	/* start or continue HNP role switch */
	int	(*start_hnp)(struct usb_otg *otg);

};

/*
 * the otg driver needs to interact with both device side and host side
 * usb controllers.  it decides which controller is active at a given
 * moment, using the transceiver, ID signal, HNP and sometimes static
 * configuration information (including "board isn't wired for otg").
 */
struct usb_phy {
	struct device		*dev;
	const char		*label;
	unsigned int		 flags;

	u8			default_a;
	enum usb_otg_state	state;
	enum usb_phy_events	last_event;

	struct usb_otg		*otg;

	struct usb_bus		*host;
	struct usb_gadget	*gadget;

	struct usb_phy_io_ops	*io_ops;
	void __iomem		*io_priv;

	/* for notification of usb_phy_events */
	struct atomic_notifier_head	notifier;

	/* to pass extra port status to the root hub */
	u16			port_status;
	u16			port_change;

	/* initialize/shutdown the OTG controller */
	int	(*init)(struct usb_phy *x);
	void	(*shutdown)(struct usb_phy *x);

	/* bind/unbind the host controller */
	int	(*set_host)(struct usb_phy *x,
				struct usb_bus *host);

	/* bind/unbind the peripheral controller */
	int	(*set_peripheral)(struct usb_phy *x,
				struct usb_gadget *gadget);

	/* effective for B devices, ignored for A-peripheral */
	int	(*set_power)(struct usb_phy *x,
				unsigned mA);

	/* effective for A-peripheral, ignored for B devices */
	int	(*set_vbus)(struct usb_phy *x,
				bool enabled);

	/* for non-OTG B devices: set transceiver into suspend mode */
	int	(*set_suspend)(struct usb_phy *x,
				int suspend);

	/* for B devices only:  start session with A-Host */
	int	(*start_srp)(struct usb_phy *x);

	/* start or continue HNP role switch */
	int	(*start_hnp)(struct usb_phy *x);

};


/* for board-specific init logic */
extern int usb_set_transceiver(struct usb_phy *);

#if defined(CONFIG_NOP_USB_XCEIV) || (defined(CONFIG_NOP_USB_XCEIV_MODULE) && defined(MODULE))
/* sometimes transceivers are accessed only through e.g. ULPI */
extern void usb_nop_xceiv_register(void);
extern void usb_nop_xceiv_unregister(void);
#else
static inline void usb_nop_xceiv_register(void)
{
}

static inline void usb_nop_xceiv_unregister(void)
{
}
#endif

/* helpers for direct access thru low-level io interface */
static inline int usb_phy_io_read(struct usb_phy *x, u32 reg)
{
	if (x->io_ops && x->io_ops->read)
		return x->io_ops->read(x, reg);

	return -EINVAL;
}

static inline int usb_phy_io_write(struct usb_phy *x, u32 val, u32 reg)
{
	if (x->io_ops && x->io_ops->write)
		return x->io_ops->write(x, val, reg);

	return -EINVAL;
}

static inline int
usb_phy_init(struct usb_phy *x)
{
	if (x->init)
		return x->init(x);

	return 0;
}

static inline void
usb_phy_shutdown(struct usb_phy *x)
{
	if (x->shutdown)
		x->shutdown(x);
}

/* for usb host and peripheral controller drivers */
#ifdef CONFIG_USB_OTG_UTILS
extern struct usb_phy *usb_get_transceiver(void);
extern void usb_put_transceiver(struct usb_phy *);
extern const char *otg_state_string(enum usb_otg_state state);
#else
static inline struct usb_phy *usb_get_transceiver(void)
{
	return NULL;
}

static inline void usb_put_transceiver(struct usb_phy *x)
{
}

static inline const char *otg_state_string(enum usb_otg_state state)
{
	return NULL;
}
#endif

/* Context: can sleep */
static inline int
otg_start_hnp(struct usb_phy *x)
{
	if (x->otg && x->otg->start_hnp)
		return x->otg->start_hnp(x->otg);

	return x->start_hnp(x);
}

/* Context: can sleep */
static inline int
otg_set_vbus(struct usb_phy *x, bool enabled)
{
	if (x->otg && x->otg->set_vbus)
		return x->otg->set_vbus(x->otg, enabled);

	return x->set_vbus(x, enabled);
}

/* for HCDs */
static inline int
otg_set_host(struct usb_phy *x, struct usb_bus *host)
{
	if (x->otg && x->otg->set_host)
		return x->otg->set_host(x->otg, host);

	return x->set_host(x, host);
}

/* for usb peripheral controller drivers */

/* Context: can sleep */
static inline int
otg_set_peripheral(struct usb_phy *x, struct usb_gadget *periph)
{
	if (x->otg && x->otg->set_peripheral)
		return x->otg->set_peripheral(x->otg, periph);

	return x->set_peripheral(x, periph);
}

static inline int
usb_phy_set_power(struct usb_phy *x, unsigned mA)
{
	if (x && x->set_power)
		return x->set_power(x, mA);
	return 0;
}

/* Context: can sleep */
static inline int
usb_phy_set_suspend(struct usb_phy *x, int suspend)
{
	if (x->set_suspend != NULL)
		return x->set_suspend(x, suspend);
	else
		return 0;
}

static inline int
otg_start_srp(struct usb_phy *x)
{
	if (x->otg && x->otg->start_srp)
		return x->otg->start_srp(x->otg);

	return x->start_srp(x);
}

/* notifiers */
static inline int
usb_register_notifier(struct usb_phy *x, struct notifier_block *nb)
{
	return atomic_notifier_chain_register(&x->notifier, nb);
}

static inline void
usb_unregister_notifier(struct usb_phy *x, struct notifier_block *nb)
{
	atomic_notifier_chain_unregister(&x->notifier, nb);
}

/* for OTG controller drivers (and maybe other stuff) */
extern int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num);

/* Temporary aliases for transceiver functions */
#define otg_set_transceiver(x) usb_set_transceiver(x)
#define otg_get_transceiver() usb_get_transceiver()
#define otg_put_transceiver(x) usb_put_transceiver(x)

#define otg_io_read(x, a) usb_phy_io_read(x, a)
#define otg_io_write(x, a, b) usb_phy_io_write(x, a, b)

#define otg_init(x) usb_phy_init(x)
#define otg_shutdown(x) usb_phy_shutdown(x)
#define otg_set_power(x, a) usb_phy_set_power(x, a)
#define otg_set_suspend(x, a) usb_phy_set_suspend(x, a)

#define otg_register_notifier(x, a) usb_register_notifier(x, a)
#define otg_unregister_notifier(x, a) usb_unregiser_notifier(x, a)

#define otg_io_access_ops usb_phy_io_ops

#endif /* __LINUX_USB_OTG_H */
Commit	Line	Data
41dceed5	1	/* USB OTG (On The Go) defines */
1da177e4	2	/*
dda43a0e	3	*
1da177e4 LT	4	* These APIs may be used between USB controllers. USB device drivers
	5	* (for either host or peripheral roles) don't use these calls; they
	6	* continue to use just usb_device and usb_gadget.
	7	*/
	8
dda43a0e RD	9	#ifndef __LINUX_USB_OTG_H
dda43a0e RD	10	#define __LINUX_USB_OTG_H
1da177e4	11
e9a20171 FB	12	#include <linux/notifier.h>
e9a20171 FB	13
1da177e4 LT	14	/* OTG defines lots of enumeration states before device reset */
	15	enum usb_otg_state {
	16	OTG_STATE_UNDEFINED = 0,
	17
	18	/* single-role peripheral, and dual-role default-b */
	19	OTG_STATE_B_IDLE,
	20	OTG_STATE_B_SRP_INIT,
	21	OTG_STATE_B_PERIPHERAL,
	22
	23	/* extra dual-role default-b states */
	24	OTG_STATE_B_WAIT_ACON,
	25	OTG_STATE_B_HOST,
	26
	27	/* dual-role default-a */
	28	OTG_STATE_A_IDLE,
	29	OTG_STATE_A_WAIT_VRISE,
	30	OTG_STATE_A_WAIT_BCON,
	31	OTG_STATE_A_HOST,
	32	OTG_STATE_A_SUSPEND,
	33	OTG_STATE_A_PERIPHERAL,
	34	OTG_STATE_A_WAIT_VFALL,
	35	OTG_STATE_A_VBUS_ERR,
	36	};
	37
de07e18c	38	enum usb_phy_events {
e9a20171 FB	39	USB_EVENT_NONE, /* no events or cable disconnected */
	40	USB_EVENT_VBUS, /* vbus valid event */
	41	USB_EVENT_ID, /* id was grounded */
	42	USB_EVENT_CHARGER, /* usb dedicated charger */
	43	USB_EVENT_ENUMERATED, /* gadget driver enumerated */
	44	};
	45
86753811	46	struct usb_phy;
91c8a5a9 DM	47
	48	/* for transceivers connected thru an ULPI interface, the user must
	49	* provide access ops
	50	*/
7a8a3a9b	51	struct usb_phy_io_ops {
86753811 HK	52	int (read)(struct usb_phy x, u32 reg);
86753811 HK	53	int (write)(struct usb_phy x, u32 val, u32 reg);
91c8a5a9 DM	54	};
91c8a5a9 DM	55
7a8a3a9b HK	56	struct usb_otg {
	57	u8 default_a;
	58
	59	struct usb_phy *phy;
	60	struct usb_bus *host;
	61	struct usb_gadget *gadget;
	62
	63	/* bind/unbind the host controller */
	64	int (set_host)(struct usb_otg otg, struct usb_bus *host);
	65
	66	/* bind/unbind the peripheral controller */
	67	int (set_peripheral)(struct usb_otg otg,
	68	struct usb_gadget *gadget);
	69
	70	/* effective for A-peripheral, ignored for B devices */
	71	int (set_vbus)(struct usb_otg otg, bool enabled);
	72
	73	/* for B devices only: start session with A-Host */
	74	int (start_srp)(struct usb_otg otg);
	75
	76	/* start or continue HNP role switch */
	77	int (start_hnp)(struct usb_otg otg);
	78
	79	};
	80
1da177e4 LT	81	/*
	82	* the otg driver needs to interact with both device side and host side
	83	* usb controllers. it decides which controller is active at a given
	84	* moment, using the transceiver, ID signal, HNP and sometimes static
	85	* configuration information (including "board isn't wired for otg").
	86	*/
86753811	87	struct usb_phy {
1da177e4 LT	88	struct device *dev;
1da177e4 LT	89	const char *label;
91c8a5a9	90	unsigned int flags;
1da177e4 LT	91
	92	u8 default_a;
	93	enum usb_otg_state state;
de07e18c	94	enum usb_phy_events last_event;
1da177e4	95
7a8a3a9b HK	96	struct usb_otg *otg;
7a8a3a9b HK	97
1da177e4 LT	98	struct usb_bus *host;
	99	struct usb_gadget *gadget;
	100
7a8a3a9b HK	101	struct usb_phy_io_ops *io_ops;
7a8a3a9b HK	102	void __iomem *io_priv;
91c8a5a9	103
de07e18c	104	/* for notification of usb_phy_events */
cccad6d4	105	struct atomic_notifier_head notifier;
e9a20171	106
1da177e4 LT	107	/* to pass extra port status to the root hub */
	108	u16 port_status;
	109	u16 port_change;
	110
91c8a5a9	111	/* initialize/shutdown the OTG controller */
86753811 HK	112	int (init)(struct usb_phy x);
86753811 HK	113	void (shutdown)(struct usb_phy x);
91c8a5a9	114
1da177e4	115	/* bind/unbind the host controller */
86753811	116	int (set_host)(struct usb_phy x,
1da177e4 LT	117	struct usb_bus *host);
	118
	119	/* bind/unbind the peripheral controller */
86753811	120	int (set_peripheral)(struct usb_phy x,
1da177e4 LT	121	struct usb_gadget *gadget);
	122
	123	/* effective for B devices, ignored for A-peripheral */
86753811	124	int (set_power)(struct usb_phy x,
1da177e4 LT	125	unsigned mA);
1da177e4 LT	126
91c8a5a9	127	/* effective for A-peripheral, ignored for B devices */
86753811	128	int (set_vbus)(struct usb_phy x,
91c8a5a9 DM	129	bool enabled);
91c8a5a9 DM	130
4e67185a	131	/* for non-OTG B devices: set transceiver into suspend mode */
86753811	132	int (set_suspend)(struct usb_phy x,
4e67185a JY	133	int suspend);
4e67185a JY	134
1da177e4	135	/* for B devices only: start session with A-Host */
86753811	136	int (start_srp)(struct usb_phy x);
1da177e4 LT	137
1da177e4 LT	138	/* start or continue HNP role switch */
86753811	139	int (start_hnp)(struct usb_phy x);
1da177e4 LT	140
	141	};
	142
	143
	144	/* for board-specific init logic */
7a8a3a9b	145	extern int usb_set_transceiver(struct usb_phy *);
cc835e32	146
352a3378	147	#if defined(CONFIG_NOP_USB_XCEIV) \|\| (defined(CONFIG_NOP_USB_XCEIV_MODULE) && defined(MODULE))
cc835e32	148	/* sometimes transceivers are accessed only through e.g. ULPI */
f6d92a05 AKG	149	extern void usb_nop_xceiv_register(void);
f6d92a05 AKG	150	extern void usb_nop_xceiv_unregister(void);
224e1542 MM	151	#else
	152	static inline void usb_nop_xceiv_register(void)
	153	{
	154	}
	155
	156	static inline void usb_nop_xceiv_unregister(void)
	157	{
	158	}
	159	#endif
1da177e4	160
91c8a5a9	161	/* helpers for direct access thru low-level io interface */
7a8a3a9b	162	static inline int usb_phy_io_read(struct usb_phy *x, u32 reg)
91c8a5a9	163	{
86753811 HK	164	if (x->io_ops && x->io_ops->read)
86753811 HK	165	return x->io_ops->read(x, reg);
91c8a5a9 DM	166
	167	return -EINVAL;
	168	}
	169
7a8a3a9b	170	static inline int usb_phy_io_write(struct usb_phy *x, u32 val, u32 reg)
91c8a5a9	171	{
86753811 HK	172	if (x->io_ops && x->io_ops->write)
86753811 HK	173	return x->io_ops->write(x, val, reg);
91c8a5a9 DM	174
	175	return -EINVAL;
	176	}
	177
	178	static inline int
7a8a3a9b	179	usb_phy_init(struct usb_phy *x)
91c8a5a9	180	{
86753811 HK	181	if (x->init)
86753811 HK	182	return x->init(x);
91c8a5a9 DM	183
	184	return 0;
	185	}
	186
	187	static inline void
7a8a3a9b	188	usb_phy_shutdown(struct usb_phy *x)
91c8a5a9	189	{
86753811 HK	190	if (x->shutdown)
86753811 HK	191	x->shutdown(x);
91c8a5a9	192	}
1da177e4 LT	193
1da177e4 LT	194	/* for usb host and peripheral controller drivers */
748eee09	195	#ifdef CONFIG_USB_OTG_UTILS
7a8a3a9b HK	196	extern struct usb_phy *usb_get_transceiver(void);
7a8a3a9b HK	197	extern void usb_put_transceiver(struct usb_phy *);
3df00453	198	extern const char *otg_state_string(enum usb_otg_state state);
748eee09	199	#else
7a8a3a9b	200	static inline struct usb_phy *usb_get_transceiver(void)
748eee09 GI	201	{
	202	return NULL;
	203	}
	204
7a8a3a9b	205	static inline void usb_put_transceiver(struct usb_phy *x)
748eee09 GI	206	{
748eee09 GI	207	}
3df00453 AG	208
	209	static inline const char *otg_state_string(enum usb_otg_state state)
	210	{
	211	return NULL;
	212	}
748eee09	213	#endif
1da177e4	214
c2344f13	215	/* Context: can sleep */
1da177e4	216	static inline int
86753811	217	otg_start_hnp(struct usb_phy *x)
1da177e4	218	{
7a8a3a9b HK	219	if (x->otg && x->otg->start_hnp)
	220	return x->otg->start_hnp(x->otg);
	221
86753811	222	return x->start_hnp(x);
1da177e4 LT	223	}
1da177e4 LT	224
91c8a5a9 DM	225	/* Context: can sleep */
91c8a5a9 DM	226	static inline int
86753811	227	otg_set_vbus(struct usb_phy *x, bool enabled)
91c8a5a9	228	{
7a8a3a9b HK	229	if (x->otg && x->otg->set_vbus)
	230	return x->otg->set_vbus(x->otg, enabled);
	231
86753811	232	return x->set_vbus(x, enabled);
91c8a5a9	233	}
1da177e4 LT	234
	235	/* for HCDs */
	236	static inline int
86753811	237	otg_set_host(struct usb_phy x, struct usb_bus host)
1da177e4	238	{
7a8a3a9b HK	239	if (x->otg && x->otg->set_host)
	240	return x->otg->set_host(x->otg, host);
	241
86753811	242	return x->set_host(x, host);
1da177e4 LT	243	}
1da177e4 LT	244
1da177e4	245	/* for usb peripheral controller drivers */
c2344f13 RJ	246
c2344f13 RJ	247	/* Context: can sleep */
1da177e4	248	static inline int
86753811	249	otg_set_peripheral(struct usb_phy x, struct usb_gadget periph)
1da177e4	250	{
7a8a3a9b HK	251	if (x->otg && x->otg->set_peripheral)
	252	return x->otg->set_peripheral(x->otg, periph);
	253
86753811	254	return x->set_peripheral(x, periph);
1da177e4 LT	255	}
	256
	257	static inline int
7a8a3a9b	258	usb_phy_set_power(struct usb_phy *x, unsigned mA)
1da177e4	259	{
7a8a3a9b HK	260	if (x && x->set_power)
	261	return x->set_power(x, mA);
	262	return 0;
1da177e4 LT	263	}
1da177e4 LT	264
c2344f13	265	/* Context: can sleep */
4e67185a	266	static inline int
7a8a3a9b	267	usb_phy_set_suspend(struct usb_phy *x, int suspend)
4e67185a	268	{
86753811 HK	269	if (x->set_suspend != NULL)
86753811 HK	270	return x->set_suspend(x, suspend);
4e67185a JY	271	else
	272	return 0;
	273	}
	274
1da177e4	275	static inline int
86753811	276	otg_start_srp(struct usb_phy *x)
1da177e4	277	{
7a8a3a9b HK	278	if (x->otg && x->otg->start_srp)
	279	return x->otg->start_srp(x->otg);
	280
86753811	281	return x->start_srp(x);
1da177e4 LT	282	}
1da177e4 LT	283
e9a20171 FB	284	/* notifiers */
e9a20171 FB	285	static inline int
7a8a3a9b	286	usb_register_notifier(struct usb_phy x, struct notifier_block nb)
e9a20171	287	{
86753811	288	return atomic_notifier_chain_register(&x->notifier, nb);
e9a20171 FB	289	}
	290
	291	static inline void
7a8a3a9b	292	usb_unregister_notifier(struct usb_phy x, struct notifier_block nb)
e9a20171	293	{
86753811	294	atomic_notifier_chain_unregister(&x->notifier, nb);
e9a20171	295	}
1da177e4 LT	296
	297	/* for OTG controller drivers (and maybe other stuff) */
	298	extern int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num);
dda43a0e	299
7a8a3a9b HK	300	/* Temporary aliases for transceiver functions */
	301	#define otg_set_transceiver(x) usb_set_transceiver(x)
	302	#define otg_get_transceiver() usb_get_transceiver()
	303	#define otg_put_transceiver(x) usb_put_transceiver(x)
	304
	305	#define otg_io_read(x, a) usb_phy_io_read(x, a)
	306	#define otg_io_write(x, a, b) usb_phy_io_write(x, a, b)
	307
	308	#define otg_init(x) usb_phy_init(x)
	309	#define otg_shutdown(x) usb_phy_shutdown(x)
	310	#define otg_set_power(x, a) usb_phy_set_power(x, a)
	311	#define otg_set_suspend(x, a) usb_phy_set_suspend(x, a)
	312
	313	#define otg_register_notifier(x, a) usb_register_notifier(x, a)
	314	#define otg_unregister_notifier(x, a) usb_unregiser_notifier(x, a)
	315
	316	#define otg_io_access_ops usb_phy_io_ops
	317
dda43a0e	318	#endif /* __LINUX_USB_OTG_H */