drivers/usb/mtu3/mtu3.h - linux - Git at Google

 /* SPDX-License-Identifier: GPL-2.0 */
 /*
  * mtu3.h - MediaTek USB3 DRD header
  *
  * Copyright (C) 2016 MediaTek Inc.
  *
  * Author: Chunfeng Yun <chunfeng.yun@mediatek.com>
  */

 #ifndef __MTU3_H__
 #define __MTU3_H__

 #include <linux/clk.h>
 #include <linux/device.h>
 #include <linux/dmapool.h>
 #include <linux/extcon.h>
 #include <linux/interrupt.h>
 #include <linux/list.h>
 #include <linux/phy/phy.h>
 #include <linux/regulator/consumer.h>
 #include <linux/usb.h>
 #include <linux/usb/ch9.h>
 #include <linux/usb/gadget.h>
 #include <linux/usb/otg.h>
 #include <linux/usb/role.h>

 struct mtu3;
 struct mtu3_ep;
 struct mtu3_request;

 #include "mtu3_hw_regs.h"
 #include "mtu3_qmu.h"

 #define	MU3D_EP_TXCR0(epnum)	(U3D_TX1CSR0 + (((epnum) - 1) * 0x10))
 #define	MU3D_EP_TXCR1(epnum)	(U3D_TX1CSR1 + (((epnum) - 1) * 0x10))
 #define	MU3D_EP_TXCR2(epnum)	(U3D_TX1CSR2 + (((epnum) - 1) * 0x10))

 #define	MU3D_EP_RXCR0(epnum)	(U3D_RX1CSR0 + (((epnum) - 1) * 0x10))
 #define	MU3D_EP_RXCR1(epnum)	(U3D_RX1CSR1 + (((epnum) - 1) * 0x10))
 #define	MU3D_EP_RXCR2(epnum)	(U3D_RX1CSR2 + (((epnum) - 1) * 0x10))

 #define USB_QMU_TQHIAR(epnum)	(U3D_TXQHIAR1 + (((epnum) - 1) * 0x4))
 #define USB_QMU_RQHIAR(epnum)	(U3D_RXQHIAR1 + (((epnum) - 1) * 0x4))

 #define USB_QMU_RQCSR(epnum)	(U3D_RXQCSR1 + (((epnum) - 1) * 0x10))
 #define USB_QMU_RQSAR(epnum)	(U3D_RXQSAR1 + (((epnum) - 1) * 0x10))
 #define USB_QMU_RQCPR(epnum)	(U3D_RXQCPR1 + (((epnum) - 1) * 0x10))

 #define USB_QMU_TQCSR(epnum)	(U3D_TXQCSR1 + (((epnum) - 1) * 0x10))
 #define USB_QMU_TQSAR(epnum)	(U3D_TXQSAR1 + (((epnum) - 1) * 0x10))
 #define USB_QMU_TQCPR(epnum)	(U3D_TXQCPR1 + (((epnum) - 1) * 0x10))

 #define SSUSB_U3_CTRL(p)	(U3D_SSUSB_U3_CTRL_0P + ((p) * 0x08))
 #define SSUSB_U2_CTRL(p)	(U3D_SSUSB_U2_CTRL_0P + ((p) * 0x08))

 #define MTU3_DRIVER_NAME	"mtu3"
 #define	DMA_ADDR_INVALID	(~(dma_addr_t)0)

 #define MTU3_EP_ENABLED		BIT(0)
 #define MTU3_EP_STALL		BIT(1)
 #define MTU3_EP_WEDGE		BIT(2)
 #define MTU3_EP_BUSY		BIT(3)

 #define MTU3_U3_IP_SLOT_DEFAULT 2
 #define MTU3_U2_IP_SLOT_DEFAULT 1

 /**
  * IP TRUNK version
  * from 0x1003 version, USB3 Gen2 is supported, two changes affect driver:
  * 1. MAXPKT and MULTI bits layout of TXCSR1 and RXCSR1 are adjusted,
  *    but not backward compatible
  * 2. QMU extend buffer length supported
  */
 #define MTU3_TRUNK_VERS_1003	0x1003

 /**
  * Normally the device works on HS or SS, to simplify fifo management,
  * devide fifo into some 512B parts, use bitmap to manage it; And
  * 128 bits size of bitmap is large enough, that means it can manage
  * up to 64KB fifo size.
  * NOTE: MTU3_EP_FIFO_UNIT should be power of two
  */
 #define MTU3_EP_FIFO_UNIT		(1 << 9)
 #define MTU3_FIFO_BIT_SIZE		128
 #define MTU3_U2_IP_EP0_FIFO_SIZE	64

 /**
  * Maximum size of ep0 response buffer for ch9 requests,
  * the SET_SEL request uses 6 so far, and GET_STATUS is 2
  */
 #define EP0_RESPONSE_BUF  6

 #define BULK_CLKS_CNT	4

 /* device operated link and speed got from DEVICE_CONF register */
 enum mtu3_speed {
 	MTU3_SPEED_INACTIVE = 0,
 	MTU3_SPEED_FULL = 1,
 	MTU3_SPEED_HIGH = 3,
 	MTU3_SPEED_SUPER = 4,
 	MTU3_SPEED_SUPER_PLUS = 5,
 };

 /**
  * @MU3D_EP0_STATE_SETUP: waits for SETUP or received a SETUP
  *		without data stage.
  * @MU3D_EP0_STATE_TX: IN data stage
  * @MU3D_EP0_STATE_RX: OUT data stage
  * @MU3D_EP0_STATE_TX_END: the last IN data is transferred, and
  *		waits for its completion interrupt
  * @MU3D_EP0_STATE_STALL: ep0 is in stall status, will be auto-cleared
  *		after receives a SETUP.
  */
 enum mtu3_g_ep0_state {
 	MU3D_EP0_STATE_SETUP = 1,
 	MU3D_EP0_STATE_TX,
 	MU3D_EP0_STATE_RX,
 	MU3D_EP0_STATE_TX_END,
 	MU3D_EP0_STATE_STALL,
 };

 /**
  * MTU3_DR_FORCE_NONE: automatically switch host and periperal mode
  *		by IDPIN signal.
  * MTU3_DR_FORCE_HOST: force to enter host mode and override OTG
  *		IDPIN signal.
  * MTU3_DR_FORCE_DEVICE: force to enter peripheral mode.
  */
 enum mtu3_dr_force_mode {
 	MTU3_DR_FORCE_NONE = 0,
 	MTU3_DR_FORCE_HOST,
 	MTU3_DR_FORCE_DEVICE,
 };

 /**
  * @base: the base address of fifo
  * @limit: the bitmap size in bits
  * @bitmap: fifo bitmap in unit of @MTU3_EP_FIFO_UNIT
  */
 struct mtu3_fifo_info {
 	u32 base;
 	u32 limit;
 	DECLARE_BITMAP(bitmap, MTU3_FIFO_BIT_SIZE);
 };

 /**
  * General Purpose Descriptor (GPD):
  *	The format of TX GPD is a little different from RX one.
  *	And the size of GPD is 16 bytes.
  *
  * @dw0_info:
  *	bit0: Hardware Own (HWO)
  *	bit1: Buffer Descriptor Present (BDP), always 0, BD is not supported
  *	bit2: Bypass (BPS), 1: HW skips this GPD if HWO = 1
  *	bit6: [EL] Zero Length Packet (ZLP), moved from @dw3_info[29]
  *	bit7: Interrupt On Completion (IOC)
  *	bit[31:16]: ([EL] bit[31:12]) allow data buffer length (RX ONLY),
  *		the buffer length of the data to receive
  *	bit[23:16]: ([EL] bit[31:24]) extension address (TX ONLY),
  *		lower 4 bits are extension bits of @buffer,
  *		upper 4 bits are extension bits of @next_gpd
  * @next_gpd: Physical address of the next GPD
  * @buffer: Physical address of the data buffer
  * @dw3_info:
  *	bit[15:0]: ([EL] bit[19:0]) data buffer length,
  *		(TX): the buffer length of the data to transmit
  *		(RX): The total length of data received
  *	bit[23:16]: ([EL] bit[31:24]) extension address (RX ONLY),
  *		lower 4 bits are extension bits of @buffer,
  *		upper 4 bits are extension bits of @next_gpd
  *	bit29: ([EL] abandoned) Zero Length Packet (ZLP) (TX ONLY)
  */
 struct qmu_gpd {
 	__le32 dw0_info;
 	__le32 next_gpd;
 	__le32 buffer;
 	__le32 dw3_info;
 } __packed;

 /**
 * dma: physical base address of GPD segment
 * start: virtual base address of GPD segment
 * end: the last GPD element
 * enqueue: the first empty GPD to use
 * dequeue: the first completed GPD serviced by ISR
 * NOTE: the size of GPD ring should be >= 2
 */
 struct mtu3_gpd_ring {
 	dma_addr_t dma;
 	struct qmu_gpd *start;
 	struct qmu_gpd *end;
 	struct qmu_gpd *enqueue;
 	struct qmu_gpd *dequeue;
 };

 /**
 * @vbus: vbus 5V used by host mode
 * @edev: external connector used to detect vbus and iddig changes
 * @id_nb : notifier for iddig(idpin) detection
 * @dr_work : work for drd mode switch, used to avoid sleep in atomic context
 * @desired_role : role desired to switch
 * @role_sw : use USB Role Switch to support dual-role switch, can't use
 *		extcon at the same time, and extcon is deprecated.
 * @role_sw_used : true when the USB Role Switch is used.
 * @is_u3_drd: whether port0 supports usb3.0 dual-role device or not
 * @manual_drd_enabled: it's true when supports dual-role device by debugfs
 *		to switch host/device modes depending on user input.
 */
 struct otg_switch_mtk {
 	struct regulator *vbus;
 	struct extcon_dev *edev;
 	struct notifier_block id_nb;
 	struct work_struct dr_work;
 	enum usb_role desired_role;
 	struct usb_role_switch *role_sw;
 	bool role_sw_used;
 	bool is_u3_drd;
 	bool manual_drd_enabled;
 };

 /**
  * @mac_base: register base address of device MAC, exclude xHCI's
  * @ippc_base: register base address of IP Power and Clock interface (IPPC)
  * @vusb33: usb3.3V shared by device/host IP
  * @dr_mode: works in which mode:
  *		host only, device only or dual-role mode
  * @u2_ports: number of usb2.0 host ports
  * @u3_ports: number of usb3.0 host ports
  * @u3p_dis_msk: mask of disabling usb3 ports, for example, bit0==1 to
  *		disable u3port0, bit1==1 to disable u3port1,... etc
  * @dbgfs_root: only used when supports manual dual-role switch via debugfs
  * @uwk_en: it's true when supports remote wakeup in host mode
  * @uwk: syscon including usb wakeup glue layer between SSUSB IP and SPM
  * @uwk_reg_base: the base address of the wakeup glue layer in @uwk
  * @uwk_vers: the version of the wakeup glue layer
  */
 struct ssusb_mtk {
 	struct device *dev;
 	struct mtu3 *u3d;
 	void __iomem *mac_base;
 	void __iomem *ippc_base;
 	struct phy **phys;
 	int num_phys;
 	/* common power & clock */
 	struct regulator *vusb33;
 	struct clk_bulk_data clks[BULK_CLKS_CNT];
 	/* otg */
 	struct otg_switch_mtk otg_switch;
 	enum usb_dr_mode dr_mode;
 	bool is_host;
 	int u2_ports;
 	int u3_ports;
 	int u3p_dis_msk;
 	struct dentry *dbgfs_root;
 	/* usb wakeup for host mode */
 	bool uwk_en;
 	struct regmap *uwk;
 	u32 uwk_reg_base;
 	u32 uwk_vers;
 };

 /**
  * @fifo_size: it is (@slot + 1) * @fifo_seg_size
  * @fifo_seg_size: it is roundup_pow_of_two(@maxp)
  */
 struct mtu3_ep {
 	struct usb_ep ep;
 	char name[12];
 	struct mtu3 *mtu;
 	u8 epnum;
 	u8 type;
 	u8 is_in;
 	u16 maxp;
 	int slot;
 	u32 fifo_size;
 	u32 fifo_addr;
 	u32 fifo_seg_size;
 	struct mtu3_fifo_info *fifo;

 	struct list_head req_list;
 	struct mtu3_gpd_ring gpd_ring;
 	const struct usb_ss_ep_comp_descriptor *comp_desc;
 	const struct usb_endpoint_descriptor *desc;

 	int flags;
 };

 struct mtu3_request {
 	struct usb_request request;
 	struct list_head list;
 	struct mtu3_ep *mep;
 	struct mtu3 *mtu;
 	struct qmu_gpd *gpd;
 	int epnum;
 };

 static inline struct ssusb_mtk *dev_to_ssusb(struct device *dev)
 {
 	return dev_get_drvdata(dev);
 }

 /**
  * struct mtu3 - device driver instance data.
  * @slot: MTU3_U2_IP_SLOT_DEFAULT for U2 IP only,
  *		MTU3_U3_IP_SLOT_DEFAULT for U3 IP
  * @may_wakeup: means device's remote wakeup is enabled
  * @is_self_powered: is reported in device status and the config descriptor
  * @delayed_status: true when function drivers ask for delayed status
  * @gen2cp: compatible with USB3 Gen2 IP
  * @ep0_req: dummy request used while handling standard USB requests
  *		for GET_STATUS and SET_SEL
  * @setup_buf: ep0 response buffer for GET_STATUS and SET_SEL requests
  */
 struct mtu3 {
 	spinlock_t lock;
 	struct ssusb_mtk *ssusb;
 	struct device *dev;
 	void __iomem *mac_base;
 	void __iomem *ippc_base;
 	int irq;

 	struct mtu3_fifo_info tx_fifo;
 	struct mtu3_fifo_info rx_fifo;

 	struct mtu3_ep *ep_array;
 	struct mtu3_ep *in_eps;
 	struct mtu3_ep *out_eps;
 	struct mtu3_ep *ep0;
 	int num_eps;
 	int slot;
 	int active_ep;

 	struct dma_pool	*qmu_gpd_pool;
 	enum mtu3_g_ep0_state ep0_state;
 	struct usb_gadget g;	/* the gadget */
 	struct usb_gadget_driver *gadget_driver;
 	struct mtu3_request ep0_req;
 	u8 setup_buf[EP0_RESPONSE_BUF];
 	enum usb_device_speed max_speed;
 	enum usb_device_speed speed;

 	unsigned is_active:1;
 	unsigned may_wakeup:1;
 	unsigned is_self_powered:1;
 	unsigned test_mode:1;
 	unsigned softconnect:1;
 	unsigned u1_enable:1;
 	unsigned u2_enable:1;
 	unsigned is_u3_ip:1;
 	unsigned delayed_status:1;
 	unsigned gen2cp:1;

 	u8 address;
 	u8 test_mode_nr;
 	u32 hw_version;
 };

 static inline struct mtu3 *gadget_to_mtu3(struct usb_gadget *g)
 {
 	return container_of(g, struct mtu3, g);
 }

 static inline struct mtu3_request *to_mtu3_request(struct usb_request *req)
 {
 	return req ? container_of(req, struct mtu3_request, request) : NULL;
 }

 static inline struct mtu3_ep *to_mtu3_ep(struct usb_ep *ep)
 {
 	return ep ? container_of(ep, struct mtu3_ep, ep) : NULL;
 }

 static inline struct mtu3_request *next_request(struct mtu3_ep *mep)
 {
 	return list_first_entry_or_null(&mep->req_list, struct mtu3_request,
 					list);
 }

 static inline void mtu3_writel(void __iomem *base, u32 offset, u32 data)
 {
 	writel(data, base + offset);
 }

 static inline u32 mtu3_readl(void __iomem *base, u32 offset)
 {
 	return readl(base + offset);
 }

 static inline void mtu3_setbits(void __iomem *base, u32 offset, u32 bits)
 {
 	void __iomem *addr = base + offset;
 	u32 tmp = readl(addr);

 	writel((tmp | (bits)), addr);
 }

 static inline void mtu3_clrbits(void __iomem *base, u32 offset, u32 bits)
 {
 	void __iomem *addr = base + offset;
 	u32 tmp = readl(addr);

 	writel((tmp & ~(bits)), addr);
 }

 int ssusb_check_clocks(struct ssusb_mtk *ssusb, u32 ex_clks);
 struct usb_request *mtu3_alloc_request(struct usb_ep *ep, gfp_t gfp_flags);
 void mtu3_free_request(struct usb_ep *ep, struct usb_request *req);
 void mtu3_req_complete(struct mtu3_ep *mep,
 		struct usb_request *req, int status);

 int mtu3_config_ep(struct mtu3 *mtu, struct mtu3_ep *mep,
 		int interval, int burst, int mult);
 void mtu3_deconfig_ep(struct mtu3 *mtu, struct mtu3_ep *mep);
 void mtu3_ep_stall_set(struct mtu3_ep *mep, bool set);
 void mtu3_start(struct mtu3 *mtu);
 void mtu3_stop(struct mtu3 *mtu);
 void mtu3_dev_on_off(struct mtu3 *mtu, int is_on);

 int mtu3_gadget_setup(struct mtu3 *mtu);
 void mtu3_gadget_cleanup(struct mtu3 *mtu);
 void mtu3_gadget_reset(struct mtu3 *mtu);
 void mtu3_gadget_suspend(struct mtu3 *mtu);
 void mtu3_gadget_resume(struct mtu3 *mtu);
 void mtu3_gadget_disconnect(struct mtu3 *mtu);

 irqreturn_t mtu3_ep0_isr(struct mtu3 *mtu);
 extern const struct usb_ep_ops mtu3_ep0_ops;

 #endif
	/* SPDX-License-Identifier: GPL-2.0 */
	/*
	* mtu3.h - MediaTek USB3 DRD header
	*
	* Copyright (C) 2016 MediaTek Inc.
	*
	* Author: Chunfeng Yun <chunfeng.yun@mediatek.com>
	*/

	#ifndef __MTU3_H__
	#define __MTU3_H__

	#include <linux/clk.h>
	#include <linux/device.h>
	#include <linux/dmapool.h>
	#include <linux/extcon.h>
	#include <linux/interrupt.h>
	#include <linux/list.h>
	#include <linux/phy/phy.h>
	#include <linux/regulator/consumer.h>
	#include <linux/usb.h>
	#include <linux/usb/ch9.h>
	#include <linux/usb/gadget.h>
	#include <linux/usb/otg.h>
	#include <linux/usb/role.h>

	struct mtu3;
	struct mtu3_ep;
	struct mtu3_request;

	#include "mtu3_hw_regs.h"
	#include "mtu3_qmu.h"

	#define MU3D_EP_TXCR0(epnum) (U3D_TX1CSR0 + (((epnum) - 1) * 0x10))
	#define MU3D_EP_TXCR1(epnum) (U3D_TX1CSR1 + (((epnum) - 1) * 0x10))
	#define MU3D_EP_TXCR2(epnum) (U3D_TX1CSR2 + (((epnum) - 1) * 0x10))

	#define MU3D_EP_RXCR0(epnum) (U3D_RX1CSR0 + (((epnum) - 1) * 0x10))
	#define MU3D_EP_RXCR1(epnum) (U3D_RX1CSR1 + (((epnum) - 1) * 0x10))
	#define MU3D_EP_RXCR2(epnum) (U3D_RX1CSR2 + (((epnum) - 1) * 0x10))

	#define USB_QMU_TQHIAR(epnum) (U3D_TXQHIAR1 + (((epnum) - 1) * 0x4))
	#define USB_QMU_RQHIAR(epnum) (U3D_RXQHIAR1 + (((epnum) - 1) * 0x4))

	#define USB_QMU_RQCSR(epnum) (U3D_RXQCSR1 + (((epnum) - 1) * 0x10))
	#define USB_QMU_RQSAR(epnum) (U3D_RXQSAR1 + (((epnum) - 1) * 0x10))
	#define USB_QMU_RQCPR(epnum) (U3D_RXQCPR1 + (((epnum) - 1) * 0x10))

	#define USB_QMU_TQCSR(epnum) (U3D_TXQCSR1 + (((epnum) - 1) * 0x10))
	#define USB_QMU_TQSAR(epnum) (U3D_TXQSAR1 + (((epnum) - 1) * 0x10))
	#define USB_QMU_TQCPR(epnum) (U3D_TXQCPR1 + (((epnum) - 1) * 0x10))

	#define SSUSB_U3_CTRL(p) (U3D_SSUSB_U3_CTRL_0P + ((p) * 0x08))
	#define SSUSB_U2_CTRL(p) (U3D_SSUSB_U2_CTRL_0P + ((p) * 0x08))

	#define MTU3_DRIVER_NAME "mtu3"
	#define DMA_ADDR_INVALID (~(dma_addr_t)0)

	#define MTU3_EP_ENABLED BIT(0)
	#define MTU3_EP_STALL BIT(1)
	#define MTU3_EP_WEDGE BIT(2)
	#define MTU3_EP_BUSY BIT(3)

	#define MTU3_U3_IP_SLOT_DEFAULT 2
	#define MTU3_U2_IP_SLOT_DEFAULT 1

	/**
	* IP TRUNK version
	* from 0x1003 version, USB3 Gen2 is supported, two changes affect driver:
	* 1. MAXPKT and MULTI bits layout of TXCSR1 and RXCSR1 are adjusted,
	* but not backward compatible
	* 2. QMU extend buffer length supported
	*/
	#define MTU3_TRUNK_VERS_1003 0x1003

	/**
	* Normally the device works on HS or SS, to simplify fifo management,
	* devide fifo into some 512B parts, use bitmap to manage it; And
	* 128 bits size of bitmap is large enough, that means it can manage
	* up to 64KB fifo size.
	* NOTE: MTU3_EP_FIFO_UNIT should be power of two
	*/
	#define MTU3_EP_FIFO_UNIT (1 << 9)
	#define MTU3_FIFO_BIT_SIZE 128
	#define MTU3_U2_IP_EP0_FIFO_SIZE 64

	/**
	* Maximum size of ep0 response buffer for ch9 requests,
	* the SET_SEL request uses 6 so far, and GET_STATUS is 2
	*/
	#define EP0_RESPONSE_BUF 6

	#define BULK_CLKS_CNT 4

	/* device operated link and speed got from DEVICE_CONF register */
	enum mtu3_speed {
	MTU3_SPEED_INACTIVE = 0,
	MTU3_SPEED_FULL = 1,
	MTU3_SPEED_HIGH = 3,
	MTU3_SPEED_SUPER = 4,
	MTU3_SPEED_SUPER_PLUS = 5,
	};

	/**
	* @MU3D_EP0_STATE_SETUP: waits for SETUP or received a SETUP
	* without data stage.
	* @MU3D_EP0_STATE_TX: IN data stage
	* @MU3D_EP0_STATE_RX: OUT data stage
	* @MU3D_EP0_STATE_TX_END: the last IN data is transferred, and
	* waits for its completion interrupt
	* @MU3D_EP0_STATE_STALL: ep0 is in stall status, will be auto-cleared
	* after receives a SETUP.
	*/
	enum mtu3_g_ep0_state {
	MU3D_EP0_STATE_SETUP = 1,
	MU3D_EP0_STATE_TX,
	MU3D_EP0_STATE_RX,
	MU3D_EP0_STATE_TX_END,
	MU3D_EP0_STATE_STALL,
	};

	/**
	* MTU3_DR_FORCE_NONE: automatically switch host and periperal mode
	* by IDPIN signal.
	* MTU3_DR_FORCE_HOST: force to enter host mode and override OTG
	* IDPIN signal.
	* MTU3_DR_FORCE_DEVICE: force to enter peripheral mode.
	*/
	enum mtu3_dr_force_mode {
	MTU3_DR_FORCE_NONE = 0,
	MTU3_DR_FORCE_HOST,
	MTU3_DR_FORCE_DEVICE,
	};

	/**
	* @base: the base address of fifo
	* @limit: the bitmap size in bits
	* @bitmap: fifo bitmap in unit of @MTU3_EP_FIFO_UNIT
	*/
	struct mtu3_fifo_info {
	u32 base;
	u32 limit;
	DECLARE_BITMAP(bitmap, MTU3_FIFO_BIT_SIZE);
	};

	/**
	* General Purpose Descriptor (GPD):
	* The format of TX GPD is a little different from RX one.
	* And the size of GPD is 16 bytes.
	*
	* @dw0_info:
	* bit0: Hardware Own (HWO)
	* bit1: Buffer Descriptor Present (BDP), always 0, BD is not supported
	* bit2: Bypass (BPS), 1: HW skips this GPD if HWO = 1
	* bit6: [EL] Zero Length Packet (ZLP), moved from @dw3_info[29]
	* bit7: Interrupt On Completion (IOC)
	* bit[31:16]: ([EL] bit[31:12]) allow data buffer length (RX ONLY),
	* the buffer length of the data to receive
	* bit[23:16]: ([EL] bit[31:24]) extension address (TX ONLY),
	* lower 4 bits are extension bits of @buffer,
	* upper 4 bits are extension bits of @next_gpd
	* @next_gpd: Physical address of the next GPD
	* @buffer: Physical address of the data buffer
	* @dw3_info:
	* bit[15:0]: ([EL] bit[19:0]) data buffer length,
	* (TX): the buffer length of the data to transmit
	* (RX): The total length of data received
	* bit[23:16]: ([EL] bit[31:24]) extension address (RX ONLY),
	* lower 4 bits are extension bits of @buffer,
	* upper 4 bits are extension bits of @next_gpd
	* bit29: ([EL] abandoned) Zero Length Packet (ZLP) (TX ONLY)
	*/
	struct qmu_gpd {
	__le32 dw0_info;
	__le32 next_gpd;
	__le32 buffer;
	__le32 dw3_info;
	} __packed;

	/**
	* dma: physical base address of GPD segment
	* start: virtual base address of GPD segment
	* end: the last GPD element
	* enqueue: the first empty GPD to use
	* dequeue: the first completed GPD serviced by ISR
	* NOTE: the size of GPD ring should be >= 2
	*/
	struct mtu3_gpd_ring {
	dma_addr_t dma;
	struct qmu_gpd *start;
	struct qmu_gpd *end;
	struct qmu_gpd *enqueue;
	struct qmu_gpd *dequeue;
	};

	/**
	* @vbus: vbus 5V used by host mode
	* @edev: external connector used to detect vbus and iddig changes
	* @id_nb : notifier for iddig(idpin) detection
	* @dr_work : work for drd mode switch, used to avoid sleep in atomic context
	* @desired_role : role desired to switch
	* @role_sw : use USB Role Switch to support dual-role switch, can't use
	* extcon at the same time, and extcon is deprecated.
	* @role_sw_used : true when the USB Role Switch is used.
	* @is_u3_drd: whether port0 supports usb3.0 dual-role device or not
	* @manual_drd_enabled: it's true when supports dual-role device by debugfs
	* to switch host/device modes depending on user input.
	*/
	struct otg_switch_mtk {
	struct regulator *vbus;
	struct extcon_dev *edev;
	struct notifier_block id_nb;
	struct work_struct dr_work;
	enum usb_role desired_role;
	struct usb_role_switch *role_sw;
	bool role_sw_used;
	bool is_u3_drd;
	bool manual_drd_enabled;
	};

	/**
	* @mac_base: register base address of device MAC, exclude xHCI's
	* @ippc_base: register base address of IP Power and Clock interface (IPPC)
	* @vusb33: usb3.3V shared by device/host IP
	* @dr_mode: works in which mode:
	* host only, device only or dual-role mode
	* @u2_ports: number of usb2.0 host ports
	* @u3_ports: number of usb3.0 host ports
	* @u3p_dis_msk: mask of disabling usb3 ports, for example, bit0==1 to
	* disable u3port0, bit1==1 to disable u3port1,... etc
	* @dbgfs_root: only used when supports manual dual-role switch via debugfs
	* @uwk_en: it's true when supports remote wakeup in host mode
	* @uwk: syscon including usb wakeup glue layer between SSUSB IP and SPM
	* @uwk_reg_base: the base address of the wakeup glue layer in @uwk
	* @uwk_vers: the version of the wakeup glue layer
	*/
	struct ssusb_mtk {
	struct device *dev;
	struct mtu3 *u3d;
	void __iomem *mac_base;
	void __iomem *ippc_base;
	struct phy **phys;
	int num_phys;
	/* common power & clock */
	struct regulator *vusb33;
	struct clk_bulk_data clks[BULK_CLKS_CNT];
	/* otg */
	struct otg_switch_mtk otg_switch;
	enum usb_dr_mode dr_mode;
	bool is_host;
	int u2_ports;
	int u3_ports;
	int u3p_dis_msk;
	struct dentry *dbgfs_root;
	/* usb wakeup for host mode */
	bool uwk_en;
	struct regmap *uwk;
	u32 uwk_reg_base;
	u32 uwk_vers;
	};

	/**
	* @fifo_size: it is (@slot + 1) * @fifo_seg_size
	* @fifo_seg_size: it is roundup_pow_of_two(@maxp)
	*/
	struct mtu3_ep {
	struct usb_ep ep;
	char name[12];
	struct mtu3 *mtu;
	u8 epnum;
	u8 type;
	u8 is_in;
	u16 maxp;
	int slot;
	u32 fifo_size;
	u32 fifo_addr;
	u32 fifo_seg_size;
	struct mtu3_fifo_info *fifo;

	struct list_head req_list;
	struct mtu3_gpd_ring gpd_ring;
	const struct usb_ss_ep_comp_descriptor *comp_desc;
	const struct usb_endpoint_descriptor *desc;

	int flags;
	};

	struct mtu3_request {
	struct usb_request request;
	struct list_head list;
	struct mtu3_ep *mep;
	struct mtu3 *mtu;
	struct qmu_gpd *gpd;
	int epnum;
	};

	static inline struct ssusb_mtk dev_to_ssusb(struct device dev)
	{
	return dev_get_drvdata(dev);
	}

	/**
	* struct mtu3 - device driver instance data.
	* @slot: MTU3_U2_IP_SLOT_DEFAULT for U2 IP only,
	* MTU3_U3_IP_SLOT_DEFAULT for U3 IP
	* @may_wakeup: means device's remote wakeup is enabled
	* @is_self_powered: is reported in device status and the config descriptor
	* @delayed_status: true when function drivers ask for delayed status
	* @gen2cp: compatible with USB3 Gen2 IP
	* @ep0_req: dummy request used while handling standard USB requests
	* for GET_STATUS and SET_SEL
	* @setup_buf: ep0 response buffer for GET_STATUS and SET_SEL requests
	*/
	struct mtu3 {
	spinlock_t lock;
	struct ssusb_mtk *ssusb;
	struct device *dev;
	void __iomem *mac_base;
	void __iomem *ippc_base;
	int irq;

	struct mtu3_fifo_info tx_fifo;
	struct mtu3_fifo_info rx_fifo;

	struct mtu3_ep *ep_array;
	struct mtu3_ep *in_eps;
	struct mtu3_ep *out_eps;
	struct mtu3_ep *ep0;
	int num_eps;
	int slot;
	int active_ep;

	struct dma_pool *qmu_gpd_pool;
	enum mtu3_g_ep0_state ep0_state;
	struct usb_gadget g; /* the gadget */
	struct usb_gadget_driver *gadget_driver;
	struct mtu3_request ep0_req;
	u8 setup_buf[EP0_RESPONSE_BUF];
	enum usb_device_speed max_speed;
	enum usb_device_speed speed;

	unsigned is_active:1;
	unsigned may_wakeup:1;
	unsigned is_self_powered:1;
	unsigned test_mode:1;
	unsigned softconnect:1;
	unsigned u1_enable:1;
	unsigned u2_enable:1;
	unsigned is_u3_ip:1;
	unsigned delayed_status:1;
	unsigned gen2cp:1;

	u8 address;
	u8 test_mode_nr;
	u32 hw_version;
	};

	static inline struct mtu3 gadget_to_mtu3(struct usb_gadget g)
	{
	return container_of(g, struct mtu3, g);
	}

	static inline struct mtu3_request to_mtu3_request(struct usb_request req)
	{
	return req ? container_of(req, struct mtu3_request, request) : NULL;
	}

	static inline struct mtu3_ep to_mtu3_ep(struct usb_ep ep)
	{
	return ep ? container_of(ep, struct mtu3_ep, ep) : NULL;
	}

	static inline struct mtu3_request next_request(struct mtu3_ep mep)
	{
	return list_first_entry_or_null(&mep->req_list, struct mtu3_request,
	list);
	}

	static inline void mtu3_writel(void __iomem *base, u32 offset, u32 data)
	{
	writel(data, base + offset);
	}

	static inline u32 mtu3_readl(void __iomem *base, u32 offset)
	{
	return readl(base + offset);
	}

	static inline void mtu3_setbits(void __iomem *base, u32 offset, u32 bits)
	{
	void __iomem *addr = base + offset;
	u32 tmp = readl(addr);

	writel((tmp \| (bits)), addr);
	}

	static inline void mtu3_clrbits(void __iomem *base, u32 offset, u32 bits)
	{
	void __iomem *addr = base + offset;
	u32 tmp = readl(addr);

	writel((tmp & ~(bits)), addr);
	}

	int ssusb_check_clocks(struct ssusb_mtk *ssusb, u32 ex_clks);
	struct usb_request mtu3_alloc_request(struct usb_ep ep, gfp_t gfp_flags);
	void mtu3_free_request(struct usb_ep ep, struct usb_request req);
	void mtu3_req_complete(struct mtu3_ep *mep,
	struct usb_request *req, int status);

	int mtu3_config_ep(struct mtu3 mtu, struct mtu3_ep mep,
	int interval, int burst, int mult);
	void mtu3_deconfig_ep(struct mtu3 mtu, struct mtu3_ep mep);
	void mtu3_ep_stall_set(struct mtu3_ep *mep, bool set);
	void mtu3_start(struct mtu3 *mtu);
	void mtu3_stop(struct mtu3 *mtu);
	void mtu3_dev_on_off(struct mtu3 *mtu, int is_on);

	int mtu3_gadget_setup(struct mtu3 *mtu);
	void mtu3_gadget_cleanup(struct mtu3 *mtu);
	void mtu3_gadget_reset(struct mtu3 *mtu);
	void mtu3_gadget_suspend(struct mtu3 *mtu);
	void mtu3_gadget_resume(struct mtu3 *mtu);
	void mtu3_gadget_disconnect(struct mtu3 *mtu);

	irqreturn_t mtu3_ep0_isr(struct mtu3 *mtu);
	extern const struct usb_ep_ops mtu3_ep0_ops;

	#endif