[mirror_ubuntu-disco-kernel.git] / include / linux / usb / musb.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * This is used to for host and peripheral modes of the driver for
 * Inventra (Multidrop) Highspeed Dual-Role Controllers:  (M)HDRC.
 *
 * Board initialization should put one of these into dev->platform_data,
 * probably on some platform_device named "musb-hdrc".  It encapsulates
 * key configuration differences between boards.
 */

#ifndef __LINUX_USB_MUSB_H
#define __LINUX_USB_MUSB_H

/* The USB role is defined by the connector used on the board, so long as
 * standards are being followed.  (Developer boards sometimes won't.)
 */
enum musb_mode {
	MUSB_UNDEFINED = 0,
	MUSB_HOST,		/* A or Mini-A connector */
	MUSB_PERIPHERAL,	/* B or Mini-B connector */
	MUSB_OTG		/* Mini-AB connector */
};

struct clk;

enum musb_fifo_style {
	FIFO_RXTX,
	FIFO_TX,
	FIFO_RX
} __attribute__ ((packed));

enum musb_buf_mode {
	BUF_SINGLE,
	BUF_DOUBLE
} __attribute__ ((packed));

struct musb_fifo_cfg {
	u8			hw_ep_num;
	enum musb_fifo_style	style;
	enum musb_buf_mode	mode;
	u16			maxpacket;
};

#define MUSB_EP_FIFO(ep, st, m, pkt)		\
{						\
	.hw_ep_num	= ep,			\
	.style		= st,			\
	.mode		= m,			\
	.maxpacket	= pkt,			\
}

#define MUSB_EP_FIFO_SINGLE(ep, st, pkt)	\
	MUSB_EP_FIFO(ep, st, BUF_SINGLE, pkt)

#define MUSB_EP_FIFO_DOUBLE(ep, st, pkt)	\
	MUSB_EP_FIFO(ep, st, BUF_DOUBLE, pkt)

struct musb_hdrc_eps_bits {
	const char	name[16];
	u8		bits;
};

struct musb_hdrc_config {
	struct musb_fifo_cfg	*fifo_cfg;	/* board fifo configuration */
	unsigned		fifo_cfg_size;	/* size of the fifo configuration */

	/* MUSB configuration-specific details */
	unsigned	multipoint:1;	/* multipoint device */
	unsigned	dyn_fifo:1 __deprecated; /* supports dynamic fifo sizing */
	unsigned	soft_con:1 __deprecated; /* soft connect required */
	unsigned	utm_16:1 __deprecated; /* utm data witdh is 16 bits */
	unsigned	big_endian:1;	/* true if CPU uses big-endian */
	unsigned	mult_bulk_tx:1;	/* Tx ep required for multbulk pkts */
	unsigned	mult_bulk_rx:1;	/* Rx ep required for multbulk pkts */
	unsigned	high_iso_tx:1;	/* Tx ep required for HB iso */
	unsigned	high_iso_rx:1;	/* Rx ep required for HD iso */
	unsigned	dma:1 __deprecated; /* supports DMA */
	unsigned	vendor_req:1 __deprecated; /* vendor registers required */

	/* need to explicitly de-assert the port reset after resume? */
	unsigned	host_port_deassert_reset_at_resume:1;

	u8		num_eps;	/* number of endpoints _with_ ep0 */
	u8		dma_channels __deprecated; /* number of dma channels */
	u8		dyn_fifo_size;	/* dynamic size in bytes */
	u8		vendor_ctrl __deprecated; /* vendor control reg width */
	u8		vendor_stat __deprecated; /* vendor status reg witdh */
	u8		dma_req_chan __deprecated; /* bitmask for required dma channels */
	u8		ram_bits;	/* ram address size */

	struct musb_hdrc_eps_bits *eps_bits __deprecated;
#ifdef CONFIG_BLACKFIN
	/* A GPIO controlling VRSEL in Blackfin */
	unsigned int	gpio_vrsel;
	unsigned int	gpio_vrsel_active;
	/* musb CLKIN in Blackfin in MHZ */
	unsigned char   clkin;
#endif
	u32		maximum_speed;
};

struct musb_hdrc_platform_data {
	/* MUSB_HOST, MUSB_PERIPHERAL, or MUSB_OTG */
	u8		mode;

	/* for clk_get() */
	const char	*clock;

	/* (HOST or OTG) switch VBUS on/off */
	int		(*set_vbus)(struct device *dev, int is_on);

	/* (HOST or OTG) mA/2 power supplied on (default = 8mA) */
	u8		power;

	/* (PERIPHERAL) mA/2 max power consumed (default = 100mA) */
	u8		min_power;

	/* (HOST or OTG) msec/2 after VBUS on till power good */
	u8		potpgt;

	/* (HOST or OTG) program PHY for external Vbus */
	unsigned	extvbus:1;

	/* Power the device on or off */
	int		(*set_power)(int state);

	/* MUSB configuration-specific details */
	const struct musb_hdrc_config *config;

	/* Architecture specific board data	*/
	void		*board_data;

	/* Platform specific struct musb_ops pointer */
	const void	*platform_ops;
};

enum musb_vbus_id_status {
	MUSB_UNKNOWN = 0,
	MUSB_ID_GROUND,
	MUSB_ID_FLOAT,
	MUSB_VBUS_VALID,
	MUSB_VBUS_OFF,
};

#if IS_ENABLED(CONFIG_USB_MUSB_HDRC)
int musb_mailbox(enum musb_vbus_id_status status);
#else
static inline int musb_mailbox(enum musb_vbus_id_status status)
{
	return 0;
}
#endif

/* TUSB 6010 support */

#define	TUSB6010_OSCCLK_60	16667	/* psec/clk @ 60.0 MHz */
#define	TUSB6010_REFCLK_24	41667	/* psec/clk @ 24.0 MHz XI */
#define	TUSB6010_REFCLK_19	52083	/* psec/clk @ 19.2 MHz CLKIN */

#ifdef	CONFIG_ARCH_OMAP2

extern int __init tusb6010_setup_interface(
		struct musb_hdrc_platform_data *data,
		unsigned ps_refclk, unsigned waitpin,
		unsigned async_cs, unsigned sync_cs,
		unsigned irq, unsigned dmachan);

extern int tusb6010_platform_retime(unsigned is_refclk);

#endif	/* OMAP2 */

#endif /* __LINUX_USB_MUSB_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
550a7375 FB	2	/*
	3	* This is used to for host and peripheral modes of the driver for
	4	* Inventra (Multidrop) Highspeed Dual-Role Controllers: (M)HDRC.
	5	*
	6	* Board initialization should put one of these into dev->platform_data,
05ac10dd	7	* probably on some platform_device named "musb-hdrc". It encapsulates
550a7375 FB	8	* key configuration differences between boards.
	9	*/
	10
fbfc396e MG	11	#ifndef __LINUX_USB_MUSB_H
	12	#define __LINUX_USB_MUSB_H
	13
550a7375 FB	14	/* The USB role is defined by the connector used on the board, so long as
	15	* standards are being followed. (Developer boards sometimes won't.)
	16	*/
	17	enum musb_mode {
	18	MUSB_UNDEFINED = 0,
	19	MUSB_HOST, /* A or Mini-A connector */
	20	MUSB_PERIPHERAL, /* B or Mini-B connector */
	21	MUSB_OTG /* Mini-AB connector */
	22	};
	23
	24	struct clk;
	25
e6c213b2 FB	26	enum musb_fifo_style {
	27	FIFO_RXTX,
	28	FIFO_TX,
	29	FIFO_RX
	30	} __attribute__ ((packed));
	31
	32	enum musb_buf_mode {
	33	BUF_SINGLE,
	34	BUF_DOUBLE
	35	} __attribute__ ((packed));
	36
	37	struct musb_fifo_cfg {
	38	u8 hw_ep_num;
	39	enum musb_fifo_style style;
	40	enum musb_buf_mode mode;
	41	u16 maxpacket;
	42	};
	43
	44	#define MUSB_EP_FIFO(ep, st, m, pkt) \
	45	{ \
	46	.hw_ep_num = ep, \
	47	.style = st, \
	48	.mode = m, \
	49	.maxpacket = pkt, \
	50	}
	51
	52	#define MUSB_EP_FIFO_SINGLE(ep, st, pkt) \
	53	MUSB_EP_FIFO(ep, st, BUF_SINGLE, pkt)
	54
	55	#define MUSB_EP_FIFO_DOUBLE(ep, st, pkt) \
	56	MUSB_EP_FIFO(ep, st, BUF_DOUBLE, pkt)
	57
ca6d1b13 FB	58	struct musb_hdrc_eps_bits {
	59	const char name[16];
	60	u8 bits;
	61	};
	62
	63	struct musb_hdrc_config {
e6c213b2 FB	64	struct musb_fifo_cfg fifo_cfg; / board fifo configuration */
	65	unsigned fifo_cfg_size; /* size of the fifo configuration */
	66
ca6d1b13 FB	67	/* MUSB configuration-specific details */
ca6d1b13 FB	68	unsigned multipoint:1; /* multipoint device */
c58bfa6b FB	69	unsigned dyn_fifo:1 __deprecated; /* supports dynamic fifo sizing */
	70	unsigned soft_con:1 __deprecated; /* soft connect required */
	71	unsigned utm_16:1 __deprecated; /* utm data witdh is 16 bits */
ca6d1b13 FB	72	unsigned big_endian:1; /* true if CPU uses big-endian */
	73	unsigned mult_bulk_tx:1; /* Tx ep required for multbulk pkts */
	74	unsigned mult_bulk_rx:1; /* Rx ep required for multbulk pkts */
	75	unsigned high_iso_tx:1; /* Tx ep required for HB iso */
	76	unsigned high_iso_rx:1; /* Rx ep required for HD iso */
c58bfa6b FB	77	unsigned dma:1 __deprecated; /* supports DMA */
c58bfa6b FB	78	unsigned vendor_req:1 __deprecated; /* vendor registers required */
ca6d1b13	79
869c5978 DM	80	/* need to explicitly de-assert the port reset after resume? */
	81	unsigned host_port_deassert_reset_at_resume:1;
	82
ca6d1b13	83	u8 num_eps; /* number of endpoints _with_ ep0 */
c58bfa6b	84	u8 dma_channels __deprecated; /* number of dma channels */
ca6d1b13	85	u8 dyn_fifo_size; /* dynamic size in bytes */
c58bfa6b FB	86	u8 vendor_ctrl __deprecated; /* vendor control reg width */
	87	u8 vendor_stat __deprecated; /* vendor status reg witdh */
	88	u8 dma_req_chan __deprecated; /* bitmask for required dma channels */
ca6d1b13 FB	89	u8 ram_bits; /* ram address size */
ca6d1b13 FB	90
c58bfa6b	91	struct musb_hdrc_eps_bits *eps_bits __deprecated;
2ffcdb3b	92	#ifdef CONFIG_BLACKFIN
0858a3a5 GKH	93	/* A GPIO controlling VRSEL in Blackfin */
0858a3a5 GKH	94	unsigned int gpio_vrsel;
6ddc6dae	95	unsigned int gpio_vrsel_active;
9c756462 BL	96	/* musb CLKIN in Blackfin in MHZ */
9c756462 BL	97	unsigned char clkin;
2ffcdb3b	98	#endif
9b753764	99	u32 maximum_speed;
ca6d1b13 FB	100	};
ca6d1b13 FB	101
550a7375 FB	102	struct musb_hdrc_platform_data {
	103	/* MUSB_HOST, MUSB_PERIPHERAL, or MUSB_OTG */
	104	u8 mode;
	105
	106	/* for clk_get() */
	107	const char *clock;
	108
	109	/* (HOST or OTG) switch VBUS on/off */
	110	int (set_vbus)(struct device dev, int is_on);
	111
	112	/* (HOST or OTG) mA/2 power supplied on (default = 8mA) */
	113	u8 power;
	114
	115	/* (PERIPHERAL) mA/2 max power consumed (default = 100mA) */
	116	u8 min_power;
	117
	118	/* (HOST or OTG) msec/2 after VBUS on till power good */
	119	u8 potpgt;
	120
5fc4e779 AKG	121	/* (HOST or OTG) program PHY for external Vbus */
	122	unsigned extvbus:1;
	123
550a7375 FB	124	/* Power the device on or off */
	125	int (*set_power)(int state);
	126
ca6d1b13	127	/* MUSB configuration-specific details */
ead22caf	128	const struct musb_hdrc_config *config;
884b8369 MM	129
	130	/* Architecture specific board data */
	131	void *board_data;
f7ec9437 FB	132
	133	/* Platform specific struct musb_ops pointer */
	134	const void *platform_ops;
550a7375 FB	135	};
550a7375 FB	136
8055555f TL	137	enum musb_vbus_id_status {
	138	MUSB_UNKNOWN = 0,
	139	MUSB_ID_GROUND,
	140	MUSB_ID_FLOAT,
	141	MUSB_VBUS_VALID,
	142	MUSB_VBUS_OFF,
	143	};
	144
	145	#if IS_ENABLED(CONFIG_USB_MUSB_HDRC)
12b7db2b	146	int musb_mailbox(enum musb_vbus_id_status status);
8055555f	147	#else
12b7db2b	148	static inline int musb_mailbox(enum musb_vbus_id_status status)
8055555f	149	{
12b7db2b	150	return 0;
8055555f TL	151	}
8055555f TL	152	#endif
550a7375 FB	153
	154	/* TUSB 6010 support */
	155
	156	#define TUSB6010_OSCCLK_60 16667 /* psec/clk @ 60.0 MHz */
	157	#define TUSB6010_REFCLK_24 41667 /* psec/clk @ 24.0 MHz XI */
	158	#define TUSB6010_REFCLK_19 52083 /* psec/clk @ 19.2 MHz CLKIN */
	159
	160	#ifdef CONFIG_ARCH_OMAP2
	161
	162	extern int __init tusb6010_setup_interface(
	163	struct musb_hdrc_platform_data *data,
	164	unsigned ps_refclk, unsigned waitpin,
	165	unsigned async_cs, unsigned sync_cs,
	166	unsigned irq, unsigned dmachan);
	167
	168	extern int tusb6010_platform_retime(unsigned is_refclk);
	169
	170	#endif /* OMAP2 */
fbfc396e MG	171
fbfc396e MG	172	#endif /* __LINUX_USB_MUSB_H */