[linux-2.6-block.git] / drivers / usb / cdns3 / drd.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Cadence USB3 DRD header file.
 *
 * Copyright (C) 2018-2019 Cadence.
 *
 * Author: Pawel Laszczak <pawell@cadence.com>
 */
#ifndef __LINUX_CDNS3_DRD
#define __LINUX_CDNS3_DRD

#include <linux/usb/otg.h>
#include <linux/phy/phy.h>
#include "core.h"

/*  DRD register interface for version v1. */
struct cdns3_otg_regs {
	__le32 did;
	__le32 rid;
	__le32 capabilities;
	__le32 reserved1;
	__le32 cmd;
	__le32 sts;
	__le32 state;
	__le32 reserved2;
	__le32 ien;
	__le32 ivect;
	__le32 refclk;
	__le32 tmr;
	__le32 reserved3[4];
	__le32 simulate;
	__le32 override;
	__le32 susp_ctrl;
	__le32 reserved4;
	__le32 anasts;
	__le32 adp_ramp_time;
	__le32 ctrl1;
	__le32 ctrl2;
};

/*  DRD register interface for version v0. */
struct cdns3_otg_legacy_regs {
	__le32 cmd;
	__le32 sts;
	__le32 state;
	__le32 refclk;
	__le32 ien;
	__le32 ivect;
	__le32 reserved1[3];
	__le32 tmr;
	__le32 reserved2[2];
	__le32 version;
	__le32 capabilities;
	__le32 reserved3[2];
	__le32 simulate;
	__le32 reserved4[5];
	__le32 ctrl1;
};

/*
 * Common registers interface for both version of DRD.
 */
struct cdns3_otg_common_regs {
	__le32 cmd;
	__le32 sts;
	__le32 state;
	__le32 different1;
	__le32 ien;
	__le32 ivect;
};

/* CDNS_RID - bitmasks */
#define CDNS_RID(p)			((p) & GENMASK(15, 0))

/* CDNS_VID - bitmasks */
#define CDNS_DID(p)			((p) & GENMASK(31, 0))

/* OTGCMD - bitmasks */
/* "Request the bus for Device mode. */
#define OTGCMD_DEV_BUS_REQ		BIT(0)
/* Request the bus for Host mode */
#define OTGCMD_HOST_BUS_REQ		BIT(1)
/* Enable OTG mode. */
#define OTGCMD_OTG_EN			BIT(2)
/* Disable OTG mode */
#define OTGCMD_OTG_DIS			BIT(3)
/*"Configure OTG as A-Device. */
#define OTGCMD_A_DEV_EN			BIT(4)
/*"Configure OTG as A-Device. */
#define OTGCMD_A_DEV_DIS		BIT(5)
/* Drop the bus for Device mod	e. */
#define OTGCMD_DEV_BUS_DROP		BIT(8)
/* Drop the bus for Host mode*/
#define OTGCMD_HOST_BUS_DROP		BIT(9)
/* Power Down USBSS-DEV. */
#define OTGCMD_DEV_POWER_OFF		BIT(11)
/* Power Down CDNSXHCI. */
#define OTGCMD_HOST_POWER_OFF		BIT(12)

/* OTGIEN - bitmasks */
/* ID change interrupt enable */
#define OTGIEN_ID_CHANGE_INT		BIT(0)
/* Vbusvalid fall detected interrupt enable.*/
#define OTGIEN_VBUSVALID_RISE_INT	BIT(4)
/* Vbusvalid fall detected interrupt enable */
#define OTGIEN_VBUSVALID_FALL_INT	BIT(5)

/* OTGSTS - bitmasks */
/*
 * Current value of the ID pin. It is only valid when idpullup in
 *  OTGCTRL1_TYPE register is set to '1'.
 */
#define OTGSTS_ID_VALUE			BIT(0)
/* Current value of the vbus_valid */
#define OTGSTS_VBUS_VALID		BIT(1)
/* Current value of the b_sess_vld */
#define OTGSTS_SESSION_VALID		BIT(2)
/*Device mode is active*/
#define OTGSTS_DEV_ACTIVE		BIT(3)
/* Host mode is active. */
#define OTGSTS_HOST_ACTIVE		BIT(4)
/* OTG Controller not ready. */
#define OTGSTS_OTG_NRDY_MASK		BIT(11)
#define OTGSTS_OTG_NRDY(p)		((p) & OTGSTS_OTG_NRDY_MASK)
/*
 * Value of the strap pins.
 * 000 - no default configuration
 * 010 - Controller initiall configured as Host
 * 100 - Controller initially configured as Device
 */
#define OTGSTS_STRAP(p)			(((p) & GENMASK(14, 12)) >> 12)
#define OTGSTS_STRAP_NO_DEFAULT_CFG	0x00
#define OTGSTS_STRAP_HOST_OTG		0x01
#define OTGSTS_STRAP_HOST		0x02
#define OTGSTS_STRAP_GADGET		0x04
/* Host mode is turned on. */
#define OTGSTS_XHCI_READY		BIT(26)
/* "Device mode is turned on .*/
#define OTGSTS_DEV_READY		BIT(27)

/* OTGSTATE- bitmasks */
#define OTGSTATE_DEV_STATE_MASK		GENMASK(2, 0)
#define OTGSTATE_HOST_STATE_MASK	GENMASK(5, 3)
#define OTGSTATE_HOST_STATE_IDLE	0x0
#define OTGSTATE_HOST_STATE_VBUS_FALL	0x7
#define OTGSTATE_HOST_STATE(p)		(((p) & OTGSTATE_HOST_STATE_MASK) >> 3)

/* OTGREFCLK - bitmasks */
#define OTGREFCLK_STB_CLK_SWITCH_EN	BIT(31)

/* OVERRIDE - bitmasks */
#define OVERRIDE_IDPULLUP		BIT(0)
/* Only for CDNS3_CONTROLLER_V0 version */
#define OVERRIDE_IDPULLUP_V0		BIT(24)

#define CDNS3_ID_PERIPHERAL		1
#define CDNS3_ID_HOST			0

bool cdns3_is_host(struct cdns3 *cdns);
bool cdns3_is_device(struct cdns3 *cdns);
int cdns3_get_id(struct cdns3 *cdns);
int cdns3_get_vbus(struct cdns3 *cdns);
int cdns3_drd_init(struct cdns3 *cdns);
int cdns3_drd_exit(struct cdns3 *cdns);
int cdns3_drd_update_mode(struct cdns3 *cdns);
int cdns3_drd_gadget_on(struct cdns3 *cdns);
void cdns3_drd_gadget_off(struct cdns3 *cdns);
int cdns3_drd_host_on(struct cdns3 *cdns);
void cdns3_drd_host_off(struct cdns3 *cdns);
int cdns3_set_mode(struct cdns3 *cdns, enum usb_dr_mode mode);

#endif /* __LINUX_CDNS3_DRD */
Commit	Line	Data
7733f6c3 PL	1	/* SPDX-License-Identifier: GPL-2.0 */
	2	/*
	3	* Cadence USB3 DRD header file.
	4	*
	5	* Copyright (C) 2018-2019 Cadence.
	6	*
	7	* Author: Pawel Laszczak <pawell@cadence.com>
	8	*/
	9	#ifndef __LINUX_CDNS3_DRD
	10	#define __LINUX_CDNS3_DRD
	11
	12	#include <linux/usb/otg.h>
	13	#include <linux/phy/phy.h>
	14	#include "core.h"
	15
	16	/* DRD register interface for version v1. */
	17	struct cdns3_otg_regs {
	18	__le32 did;
	19	__le32 rid;
	20	__le32 capabilities;
	21	__le32 reserved1;
	22	__le32 cmd;
	23	__le32 sts;
	24	__le32 state;
	25	__le32 reserved2;
	26	__le32 ien;
	27	__le32 ivect;
	28	__le32 refclk;
	29	__le32 tmr;
	30	__le32 reserved3[4];
	31	__le32 simulate;
	32	__le32 override;
	33	__le32 susp_ctrl;
	34	__le32 reserved4;
	35	__le32 anasts;
	36	__le32 adp_ramp_time;
	37	__le32 ctrl1;
	38	__le32 ctrl2;
	39	};
	40
	41	/* DRD register interface for version v0. */
	42	struct cdns3_otg_legacy_regs {
	43	__le32 cmd;
	44	__le32 sts;
	45	__le32 state;
	46	__le32 refclk;
	47	__le32 ien;
	48	__le32 ivect;
	49	__le32 reserved1[3];
	50	__le32 tmr;
	51	__le32 reserved2[2];
	52	__le32 version;
	53	__le32 capabilities;
	54	__le32 reserved3[2];
	55	__le32 simulate;
	56	__le32 reserved4[5];
	57	__le32 ctrl1;
	58	};
	59
	60	/*
	61	* Common registers interface for both version of DRD.
	62	*/
	63	struct cdns3_otg_common_regs {
	64	__le32 cmd;
65	__le32 sts;
66	__le32 state;
67	__le32 different1;
68	__le32 ien;
69	__le32 ivect;
70	};
71
72	/* CDNS_RID - bitmasks */
73	#define CDNS_RID(p) ((p) & GENMASK(15, 0))
74
75	/* CDNS_VID - bitmasks */
76	#define CDNS_DID(p) ((p) & GENMASK(31, 0))
77
78	/* OTGCMD - bitmasks */
79	/* "Request the bus for Device mode. */
80	#define OTGCMD_DEV_BUS_REQ BIT(0)
81	/* Request the bus for Host mode */
82	#define OTGCMD_HOST_BUS_REQ BIT(1)
83	/* Enable OTG mode. */
84	#define OTGCMD_OTG_EN BIT(2)
85	/* Disable OTG mode */
86	#define OTGCMD_OTG_DIS BIT(3)
87	/"Configure OTG as A-Device. /
88	#define OTGCMD_A_DEV_EN BIT(4)
89	/"Configure OTG as A-Device. /
90	#define OTGCMD_A_DEV_DIS BIT(5)
91	/* Drop the bus for Device mod e. */
92	#define OTGCMD_DEV_BUS_DROP BIT(8)
93	/* Drop the bus for Host mode*/
94	#define OTGCMD_HOST_BUS_DROP BIT(9)
95	/* Power Down USBSS-DEV. */
96	#define OTGCMD_DEV_POWER_OFF BIT(11)
97	/* Power Down CDNSXHCI. */
98	#define OTGCMD_HOST_POWER_OFF BIT(12)
99
100	/* OTGIEN - bitmasks */
101	/* ID change interrupt enable */
102	#define OTGIEN_ID_CHANGE_INT BIT(0)
103	/* Vbusvalid fall detected interrupt enable.*/
104	#define OTGIEN_VBUSVALID_RISE_INT BIT(4)
105	/* Vbusvalid fall detected interrupt enable */
106	#define OTGIEN_VBUSVALID_FALL_INT BIT(5)
107
108	/* OTGSTS - bitmasks */
109	/*
110	* Current value of the ID pin. It is only valid when idpullup in
111	* OTGCTRL1_TYPE register is set to '1'.
112	*/
113	#define OTGSTS_ID_VALUE BIT(0)
114	/* Current value of the vbus_valid */
115	#define OTGSTS_VBUS_VALID BIT(1)
116	/* Current value of the b_sess_vld */
117	#define OTGSTS_SESSION_VALID BIT(2)
118	/Device mode is active/
119	#define OTGSTS_DEV_ACTIVE BIT(3)
120	/* Host mode is active. */
121	#define OTGSTS_HOST_ACTIVE BIT(4)
122	/* OTG Controller not ready. */
123	#define OTGSTS_OTG_NRDY_MASK BIT(11)
124	#define OTGSTS_OTG_NRDY(p) ((p) & OTGSTS_OTG_NRDY_MASK)
125	/*
126	* Value of the strap pins.
127	* 000 - no default configuration
128	* 010 - Controller initiall configured as Host
129	* 100 - Controller initially configured as Device
130	*/
131	#define OTGSTS_STRAP(p) (((p) & GENMASK(14, 12)) >> 12)
132	#define OTGSTS_STRAP_NO_DEFAULT_CFG 0x00
133	#define OTGSTS_STRAP_HOST_OTG 0x01
134	#define OTGSTS_STRAP_HOST 0x02
135	#define OTGSTS_STRAP_GADGET 0x04
136	/* Host mode is turned on. */
137	#define OTGSTS_XHCI_READY BIT(26)
138	/* "Device mode is turned on .*/
139	#define OTGSTS_DEV_READY BIT(27)
140
141	/* OTGSTATE- bitmasks */
142	#define OTGSTATE_DEV_STATE_MASK GENMASK(2, 0)
143	#define OTGSTATE_HOST_STATE_MASK GENMASK(5, 3)
144	#define OTGSTATE_HOST_STATE_IDLE 0x0
145	#define OTGSTATE_HOST_STATE_VBUS_FALL 0x7
146	#define OTGSTATE_HOST_STATE(p) (((p) & OTGSTATE_HOST_STATE_MASK) >> 3)
147
148	/* OTGREFCLK - bitmasks */
149	#define OTGREFCLK_STB_CLK_SWITCH_EN BIT(31)
150
151	/* OVERRIDE - bitmasks */
152	#define OVERRIDE_IDPULLUP BIT(0)
153	/* Only for CDNS3_CONTROLLER_V0 version */
154	#define OVERRIDE_IDPULLUP_V0 BIT(24)
155
08c35dd3 PL	156	#define CDNS3_ID_PERIPHERAL 1
	157	#define CDNS3_ID_HOST 0
	158
24525849 PL	159	bool cdns3_is_host(struct cdns3 *cdns);
24525849 PL	160	bool cdns3_is_device(struct cdns3 *cdns);
7733f6c3 PL	161	int cdns3_get_id(struct cdns3 *cdns);
	162	int cdns3_get_vbus(struct cdns3 *cdns);
	163	int cdns3_drd_init(struct cdns3 *cdns);
	164	int cdns3_drd_exit(struct cdns3 *cdns);
	165	int cdns3_drd_update_mode(struct cdns3 *cdns);
b2aeb6da PL	166	int cdns3_drd_gadget_on(struct cdns3 *cdns);
	167	void cdns3_drd_gadget_off(struct cdns3 *cdns);
	168	int cdns3_drd_host_on(struct cdns3 *cdns);
	169	void cdns3_drd_host_off(struct cdns3 *cdns);
7733f6c3 PL	170	int cdns3_set_mode(struct cdns3 *cdns, enum usb_dr_mode mode);
	171
	172	#endif /* __LINUX_CDNS3_DRD */