[linux-2.6-block.git] / drivers / usb / chipidea / ci.h

// SPDX-License-Identifier: GPL-2.0
/*
 * ci.h - common structures, functions, and macros of the ChipIdea driver
 *
 * Copyright (C) 2008 Chipidea - MIPS Technologies, Inc. All rights reserved.
 *
 * Author: David Lopo
 */

#ifndef __DRIVERS_USB_CHIPIDEA_CI_H
#define __DRIVERS_USB_CHIPIDEA_CI_H

#include <linux/list.h>
#include <linux/irqreturn.h>
#include <linux/usb.h>
#include <linux/usb/gadget.h>
#include <linux/usb/otg-fsm.h>
#include <linux/usb/otg.h>
#include <linux/ulpi/interface.h>

/******************************************************************************
 * DEFINE
 *****************************************************************************/
#define TD_PAGE_COUNT      5
#define CI_HDRC_PAGE_SIZE  4096ul /* page size for TD's */
#define ENDPT_MAX          32

/******************************************************************************
 * REGISTERS
 *****************************************************************************/
/* Identification Registers */
#define ID_ID				0x0
#define ID_HWGENERAL			0x4
#define ID_HWHOST			0x8
#define ID_HWDEVICE			0xc
#define ID_HWTXBUF			0x10
#define ID_HWRXBUF			0x14
#define ID_SBUSCFG			0x90

/* register indices */
enum ci_hw_regs {
	CAP_CAPLENGTH,
	CAP_HCCPARAMS,
	CAP_DCCPARAMS,
	CAP_TESTMODE,
	CAP_LAST = CAP_TESTMODE,
	OP_USBCMD,
	OP_USBSTS,
	OP_USBINTR,
	OP_DEVICEADDR,
	OP_ENDPTLISTADDR,
	OP_TTCTRL,
	OP_BURSTSIZE,
	OP_ULPI_VIEWPORT,
	OP_PORTSC,
	OP_DEVLC,
	OP_OTGSC,
	OP_USBMODE,
	OP_ENDPTSETUPSTAT,
	OP_ENDPTPRIME,
	OP_ENDPTFLUSH,
	OP_ENDPTSTAT,
	OP_ENDPTCOMPLETE,
	OP_ENDPTCTRL,
	/* endptctrl1..15 follow */
	OP_LAST = OP_ENDPTCTRL + ENDPT_MAX / 2,
};

/******************************************************************************
 * STRUCTURES
 *****************************************************************************/
/**
 * struct ci_hw_ep - endpoint representation
 * @ep: endpoint structure for gadget drivers
 * @dir: endpoint direction (TX/RX)
 * @num: endpoint number
 * @type: endpoint type
 * @name: string description of the endpoint
 * @qh: queue head for this endpoint
 * @wedge: is the endpoint wedged
 * @ci: pointer to the controller
 * @lock: pointer to controller's spinlock
 * @td_pool: pointer to controller's TD pool
 */
struct ci_hw_ep {
	struct usb_ep				ep;
	u8					dir;
	u8					num;
	u8					type;
	char					name[16];
	struct {
		struct list_head	queue;
		struct ci_hw_qh		*ptr;
		dma_addr_t		dma;
	}					qh;
	int					wedge;

	/* global resources */
	struct ci_hdrc				*ci;
	spinlock_t				*lock;
	struct dma_pool				*td_pool;
	struct td_node				*pending_td;
};

enum ci_role {
	CI_ROLE_HOST = 0,
	CI_ROLE_GADGET,
	CI_ROLE_END,
};

enum ci_revision {
	CI_REVISION_1X = 10,	/* Revision 1.x */
	CI_REVISION_20 = 20, /* Revision 2.0 */
	CI_REVISION_21, /* Revision 2.1 */
	CI_REVISION_22, /* Revision 2.2 */
	CI_REVISION_23, /* Revision 2.3 */
	CI_REVISION_24, /* Revision 2.4 */
	CI_REVISION_25, /* Revision 2.5 */
	CI_REVISION_25_PLUS, /* Revision above than 2.5 */
	CI_REVISION_UNKNOWN = 99, /* Unknown Revision */
};

/**
 * struct ci_role_driver - host/gadget role driver
 * @start: start this role
 * @stop: stop this role
 * @irq: irq handler for this role
 * @name: role name string (host/gadget)
 */
struct ci_role_driver {
	int		(*start)(struct ci_hdrc *);
	void		(*stop)(struct ci_hdrc *);
	irqreturn_t	(*irq)(struct ci_hdrc *);
	const char	*name;
};

/**
 * struct hw_bank - hardware register mapping representation
 * @lpm: set if the device is LPM capable
 * @phys: physical address of the controller's registers
 * @abs: absolute address of the beginning of register window
 * @cap: capability registers
 * @op: operational registers
 * @size: size of the register window
 * @regmap: register lookup table
 */
struct hw_bank {
	unsigned	lpm;
	resource_size_t	phys;
	void __iomem	*abs;
	void __iomem	*cap;
	void __iomem	*op;
	size_t		size;
	void __iomem	*regmap[OP_LAST + 1];
};

/**
 * struct ci_hdrc - chipidea device representation
 * @dev: pointer to parent device
 * @lock: access synchronization
 * @hw_bank: hardware register mapping
 * @irq: IRQ number
 * @roles: array of supported roles for this controller
 * @role: current role
 * @is_otg: if the device is otg-capable
 * @fsm: otg finite state machine
 * @otg_fsm_hrtimer: hrtimer for otg fsm timers
 * @hr_timeouts: time out list for active otg fsm timers
 * @enabled_otg_timer_bits: bits of enabled otg timers
 * @next_otg_timer: next nearest enabled timer to be expired
 * @work: work for role changing
 * @wq: workqueue thread
 * @qh_pool: allocation pool for queue heads
 * @td_pool: allocation pool for transfer descriptors
 * @gadget: device side representation for peripheral controller
 * @driver: gadget driver
 * @resume_state: save the state of gadget suspend from
 * @hw_ep_max: total number of endpoints supported by hardware
 * @ci_hw_ep: array of endpoints
 * @ep0_dir: ep0 direction
 * @ep0out: pointer to ep0 OUT endpoint
 * @ep0in: pointer to ep0 IN endpoint
 * @status: ep0 status request
 * @setaddr: if we should set the address on status completion
 * @address: usb address received from the host
 * @remote_wakeup: host-enabled remote wakeup
 * @suspended: suspended by host
 * @test_mode: the selected test mode
 * @platdata: platform specific information supplied by parent device
 * @vbus_active: is VBUS active
 * @ulpi: pointer to ULPI device, if any
 * @ulpi_ops: ULPI read/write ops for this device
 * @phy: pointer to PHY, if any
 * @usb_phy: pointer to USB PHY, if any and if using the USB PHY framework
 * @hcd: pointer to usb_hcd for ehci host driver
 * @debugfs: root dentry for this controller in debugfs
 * @id_event: indicates there is an id event, and handled at ci_otg_work
 * @b_sess_valid_event: indicates there is a vbus event, and handled
 * at ci_otg_work
 * @imx28_write_fix: Freescale imx28 needs swp instruction for writing
 * @supports_runtime_pm: if runtime pm is supported
 * @in_lpm: if the core in low power mode
 * @wakeup_int: if wakeup interrupt occur
 * @rev: The revision number for controller
 */
struct ci_hdrc {
	struct device			*dev;
	spinlock_t			lock;
	struct hw_bank			hw_bank;
	int				irq;
	struct ci_role_driver		*roles[CI_ROLE_END];
	enum ci_role			role;
	bool				is_otg;
	struct usb_otg			otg;
	struct otg_fsm			fsm;
	struct hrtimer			otg_fsm_hrtimer;
	ktime_t				hr_timeouts[NUM_OTG_FSM_TIMERS];
	unsigned			enabled_otg_timer_bits;
	enum otg_fsm_timer		next_otg_timer;
	struct work_struct		work;
	struct workqueue_struct		*wq;

	struct dma_pool			*qh_pool;
	struct dma_pool			*td_pool;

	struct usb_gadget		gadget;
	struct usb_gadget_driver	*driver;
	enum usb_device_state		resume_state;
	unsigned			hw_ep_max;
	struct ci_hw_ep			ci_hw_ep[ENDPT_MAX];
	u32				ep0_dir;
	struct ci_hw_ep			*ep0out, *ep0in;

	struct usb_request		*status;
	bool				setaddr;
	u8				address;
	u8				remote_wakeup;
	u8				suspended;
	u8				test_mode;

	struct ci_hdrc_platform_data	*platdata;
	int				vbus_active;
	struct ulpi			*ulpi;
	struct ulpi_ops 		ulpi_ops;
	struct phy			*phy;
	/* old usb_phy interface */
	struct usb_phy			*usb_phy;
	struct usb_hcd			*hcd;
	struct dentry			*debugfs;
	bool				id_event;
	bool				b_sess_valid_event;
	bool				imx28_write_fix;
	bool				supports_runtime_pm;
	bool				in_lpm;
	bool				wakeup_int;
	enum ci_revision		rev;
};

static inline struct ci_role_driver *ci_role(struct ci_hdrc *ci)
{
	BUG_ON(ci->role >= CI_ROLE_END || !ci->roles[ci->role]);
	return ci->roles[ci->role];
}

static inline int ci_role_start(struct ci_hdrc *ci, enum ci_role role)
{
	int ret;

	if (role >= CI_ROLE_END)
		return -EINVAL;

	if (!ci->roles[role])
		return -ENXIO;

	ret = ci->roles[role]->start(ci);
	if (!ret)
		ci->role = role;
	return ret;
}

static inline void ci_role_stop(struct ci_hdrc *ci)
{
	enum ci_role role = ci->role;

	if (role == CI_ROLE_END)
		return;

	ci->role = CI_ROLE_END;

	ci->roles[role]->stop(ci);
}

/**
 * hw_read_id_reg: reads from a identification register
 * @ci: the controller
 * @offset: offset from the beginning of identification registers region
 * @mask: bitfield mask
 *
 * This function returns register contents
 */
static inline u32 hw_read_id_reg(struct ci_hdrc *ci, u32 offset, u32 mask)
{
	return ioread32(ci->hw_bank.abs + offset) & mask;
}

/**
 * hw_write_id_reg: writes to a identification register
 * @ci: the controller
 * @offset: offset from the beginning of identification registers region
 * @mask: bitfield mask
 * @data: new value
 */
static inline void hw_write_id_reg(struct ci_hdrc *ci, u32 offset,
			    u32 mask, u32 data)
{
	if (~mask)
		data = (ioread32(ci->hw_bank.abs + offset) & ~mask)
			| (data & mask);

	iowrite32(data, ci->hw_bank.abs + offset);
}

/**
 * hw_read: reads from a hw register
 * @ci: the controller
 * @reg:  register index
 * @mask: bitfield mask
 *
 * This function returns register contents
 */
static inline u32 hw_read(struct ci_hdrc *ci, enum ci_hw_regs reg, u32 mask)
{
	return ioread32(ci->hw_bank.regmap[reg]) & mask;
}

#ifdef CONFIG_SOC_IMX28
static inline void imx28_ci_writel(u32 val, volatile void __iomem *addr)
{
	__asm__ ("swp %0, %0, [%1]" : : "r"(val), "r"(addr));
}
#else
static inline void imx28_ci_writel(u32 val, volatile void __iomem *addr)
{
}
#endif

static inline void __hw_write(struct ci_hdrc *ci, u32 val,
		void __iomem *addr)
{
	if (ci->imx28_write_fix)
		imx28_ci_writel(val, addr);
	else
		iowrite32(val, addr);
}

/**
 * hw_write: writes to a hw register
 * @ci: the controller
 * @reg:  register index
 * @mask: bitfield mask
 * @data: new value
 */
static inline void hw_write(struct ci_hdrc *ci, enum ci_hw_regs reg,
			    u32 mask, u32 data)
{
	if (~mask)
		data = (ioread32(ci->hw_bank.regmap[reg]) & ~mask)
			| (data & mask);

	__hw_write(ci, data, ci->hw_bank.regmap[reg]);
}

/**
 * hw_test_and_clear: tests & clears a hw register
 * @ci: the controller
 * @reg:  register index
 * @mask: bitfield mask
 *
 * This function returns register contents
 */
static inline u32 hw_test_and_clear(struct ci_hdrc *ci, enum ci_hw_regs reg,
				    u32 mask)
{
	u32 val = ioread32(ci->hw_bank.regmap[reg]) & mask;

	__hw_write(ci, val, ci->hw_bank.regmap[reg]);
	return val;
}

/**
 * hw_test_and_write: tests & writes a hw register
 * @ci: the controller
 * @reg:  register index
 * @mask: bitfield mask
 * @data: new value
 *
 * This function returns register contents
 */
static inline u32 hw_test_and_write(struct ci_hdrc *ci, enum ci_hw_regs reg,
				    u32 mask, u32 data)
{
	u32 val = hw_read(ci, reg, ~0);

	hw_write(ci, reg, mask, data);
	return (val & mask) >> __ffs(mask);
}

/**
 * ci_otg_is_fsm_mode: runtime check if otg controller
 * is in otg fsm mode.
 *
 * @ci: chipidea device
 */
static inline bool ci_otg_is_fsm_mode(struct ci_hdrc *ci)
{
#ifdef CONFIG_USB_OTG_FSM
	struct usb_otg_caps *otg_caps = &ci->platdata->ci_otg_caps;

	return ci->is_otg && ci->roles[CI_ROLE_HOST] &&
		ci->roles[CI_ROLE_GADGET] && (otg_caps->srp_support ||
		otg_caps->hnp_support || otg_caps->adp_support);
#else
	return false;
#endif
}

int ci_ulpi_init(struct ci_hdrc *ci);
void ci_ulpi_exit(struct ci_hdrc *ci);
int ci_ulpi_resume(struct ci_hdrc *ci);

u32 hw_read_intr_enable(struct ci_hdrc *ci);

u32 hw_read_intr_status(struct ci_hdrc *ci);

int hw_device_reset(struct ci_hdrc *ci);

int hw_port_test_set(struct ci_hdrc *ci, u8 mode);

u8 hw_port_test_get(struct ci_hdrc *ci);

void hw_phymode_configure(struct ci_hdrc *ci);

void ci_platform_configure(struct ci_hdrc *ci);

void dbg_create_files(struct ci_hdrc *ci);

void dbg_remove_files(struct ci_hdrc *ci);
#endif	/* __DRIVERS_USB_CHIPIDEA_CI_H */
Commit	Line	Data
5fd54ace	1	// SPDX-License-Identifier: GPL-2.0
e443b333 AS	2	/*
	3	* ci.h - common structures, functions, and macros of the ChipIdea driver
	4	*
	5	* Copyright (C) 2008 Chipidea - MIPS Technologies, Inc. All rights reserved.
	6	*
	7	* Author: David Lopo
e443b333 AS	8	*/
	9
	10	#ifndef __DRIVERS_USB_CHIPIDEA_CI_H
	11	#define __DRIVERS_USB_CHIPIDEA_CI_H
	12
	13	#include <linux/list.h>
5f36e231	14	#include <linux/irqreturn.h>
eb70e5ab	15	#include <linux/usb.h>
e443b333	16	#include <linux/usb/gadget.h>
57677be5	17	#include <linux/usb/otg-fsm.h>
7bb7e9b1 SB	18	#include <linux/usb/otg.h>
7bb7e9b1 SB	19	#include <linux/ulpi/interface.h>
e443b333 AS	20
	21	/******************************************************************************
	22	* DEFINE
	23	*****************************************************************************/
b983e51a	24	#define TD_PAGE_COUNT 5
8e22978c	25	#define CI_HDRC_PAGE_SIZE 4096ul /* page size for TD's */
e443b333 AS	26	#define ENDPT_MAX 32
e443b333 AS	27
21395a1a MKB	28	/******************************************************************************
	29	* REGISTERS
	30	*****************************************************************************/
655d32e9 PC	31	/* Identification Registers */
	32	#define ID_ID 0x0
	33	#define ID_HWGENERAL 0x4
	34	#define ID_HWHOST 0x8
	35	#define ID_HWDEVICE 0xc
	36	#define ID_HWTXBUF 0x10
	37	#define ID_HWRXBUF 0x14
	38	#define ID_SBUSCFG 0x90
	39
21395a1a MKB	40	/* register indices */
	41	enum ci_hw_regs {
	42	CAP_CAPLENGTH,
	43	CAP_HCCPARAMS,
	44	CAP_DCCPARAMS,
	45	CAP_TESTMODE,
	46	CAP_LAST = CAP_TESTMODE,
	47	OP_USBCMD,
	48	OP_USBSTS,
	49	OP_USBINTR,
	50	OP_DEVICEADDR,
	51	OP_ENDPTLISTADDR,
28362673	52	OP_TTCTRL,
96625ead	53	OP_BURSTSIZE,
7bb7e9b1	54	OP_ULPI_VIEWPORT,
21395a1a MKB	55	OP_PORTSC,
	56	OP_DEVLC,
	57	OP_OTGSC,
	58	OP_USBMODE,
	59	OP_ENDPTSETUPSTAT,
	60	OP_ENDPTPRIME,
	61	OP_ENDPTFLUSH,
	62	OP_ENDPTSTAT,
	63	OP_ENDPTCOMPLETE,
	64	OP_ENDPTCTRL,
	65	/* endptctrl1..15 follow */
	66	OP_LAST = OP_ENDPTCTRL + ENDPT_MAX / 2,
	67	};
	68
e443b333 AS	69	/******************************************************************************
	70	* STRUCTURES
	71	*****************************************************************************/
551a8ac6	72	/**
8e22978c	73	* struct ci_hw_ep - endpoint representation
551a8ac6 AS	74	* @ep: endpoint structure for gadget drivers
	75	* @dir: endpoint direction (TX/RX)
	76	* @num: endpoint number
	77	* @type: endpoint type
	78	* @name: string description of the endpoint
	79	* @qh: queue head for this endpoint
	80	* @wedge: is the endpoint wedged
26c696c6	81	* @ci: pointer to the controller
551a8ac6	82	* @lock: pointer to controller's spinlock
551a8ac6 AS	83	* @td_pool: pointer to controller's TD pool
551a8ac6 AS	84	*/
8e22978c	85	struct ci_hw_ep {
551a8ac6 AS	86	struct usb_ep ep;
	87	u8 dir;
	88	u8 num;
	89	u8 type;
	90	char name[16];
e443b333	91	struct {
551a8ac6	92	struct list_head queue;
8e22978c	93	struct ci_hw_qh *ptr;
551a8ac6 AS	94	dma_addr_t dma;
	95	} qh;
	96	int wedge;
e443b333 AS	97
e443b333 AS	98	/* global resources */
8e22978c	99	struct ci_hdrc *ci;
551a8ac6	100	spinlock_t *lock;
551a8ac6	101	struct dma_pool *td_pool;
2e270412	102	struct td_node *pending_td;
e443b333 AS	103	};
e443b333 AS	104
5f36e231 AS	105	enum ci_role {
	106	CI_ROLE_HOST = 0,
	107	CI_ROLE_GADGET,
	108	CI_ROLE_END,
	109	};
	110
cb271f3c PC	111	enum ci_revision {
	112	CI_REVISION_1X = 10, /* Revision 1.x */
	113	CI_REVISION_20 = 20, /* Revision 2.0 */
	114	CI_REVISION_21, /* Revision 2.1 */
	115	CI_REVISION_22, /* Revision 2.2 */
	116	CI_REVISION_23, /* Revision 2.3 */
	117	CI_REVISION_24, /* Revision 2.4 */
	118	CI_REVISION_25, /* Revision 2.5 */
	119	CI_REVISION_25_PLUS, /* Revision above than 2.5 */
	120	CI_REVISION_UNKNOWN = 99, /* Unknown Revision */
	121	};
	122
5f36e231 AS	123	/**
5f36e231 AS	124	* struct ci_role_driver - host/gadget role driver
19353881 PC	125	* @start: start this role
	126	* @stop: stop this role
	127	* @irq: irq handler for this role
	128	* @name: role name string (host/gadget)
5f36e231 AS	129	*/
5f36e231 AS	130	struct ci_role_driver {
8e22978c AS	131	int (start)(struct ci_hdrc );
	132	void (stop)(struct ci_hdrc );
	133	irqreturn_t (irq)(struct ci_hdrc );
5f36e231 AS	134	const char *name;
	135	};
	136
551a8ac6 AS	137	/**
	138	* struct hw_bank - hardware register mapping representation
	139	* @lpm: set if the device is LPM capable
eb70e5ab	140	* @phys: physical address of the controller's registers
551a8ac6 AS	141	* @abs: absolute address of the beginning of register window
	142	* @cap: capability registers
	143	* @op: operational registers
	144	* @size: size of the register window
	145	* @regmap: register lookup table
	146	*/
e443b333	147	struct hw_bank {
551a8ac6	148	unsigned lpm;
eb70e5ab	149	resource_size_t phys;
551a8ac6 AS	150	void __iomem *abs;
	151	void __iomem *cap;
	152	void __iomem *op;
	153	size_t size;
21395a1a	154	void __iomem *regmap[OP_LAST + 1];
e443b333 AS	155	};
e443b333 AS	156
551a8ac6	157	/**
8e22978c	158	* struct ci_hdrc - chipidea device representation
551a8ac6 AS	159	* @dev: pointer to parent device
	160	* @lock: access synchronization
	161	* @hw_bank: hardware register mapping
	162	* @irq: IRQ number
	163	* @roles: array of supported roles for this controller
	164	* @role: current role
	165	* @is_otg: if the device is otg-capable
57677be5	166	* @fsm: otg finite state machine
3a316ec4 LJ	167	* @otg_fsm_hrtimer: hrtimer for otg fsm timers
	168	* @hr_timeouts: time out list for active otg fsm timers
	169	* @enabled_otg_timer_bits: bits of enabled otg timers
	170	* @next_otg_timer: next nearest enabled timer to be expired
551a8ac6 AS	171	* @work: work for role changing
	172	* @wq: workqueue thread
	173	* @qh_pool: allocation pool for queue heads
	174	* @td_pool: allocation pool for transfer descriptors
	175	* @gadget: device side representation for peripheral controller
	176	* @driver: gadget driver
4f4555cf	177	* @resume_state: save the state of gadget suspend from
551a8ac6	178	* @hw_ep_max: total number of endpoints supported by hardware
8e22978c	179	* @ci_hw_ep: array of endpoints
551a8ac6 AS	180	* @ep0_dir: ep0 direction
	181	* @ep0out: pointer to ep0 OUT endpoint
	182	* @ep0in: pointer to ep0 IN endpoint
	183	* @status: ep0 status request
	184	* @setaddr: if we should set the address on status completion
	185	* @address: usb address received from the host
	186	* @remote_wakeup: host-enabled remote wakeup
	187	* @suspended: suspended by host
	188	* @test_mode: the selected test mode
77c4400f	189	* @platdata: platform specific information supplied by parent device
551a8ac6	190	* @vbus_active: is VBUS active
7bb7e9b1 SB	191	* @ulpi: pointer to ULPI device, if any
7bb7e9b1 SB	192	* @ulpi_ops: ULPI read/write ops for this device
1e5e2d3d AT	193	* @phy: pointer to PHY, if any
1e5e2d3d AT	194	* @usb_phy: pointer to USB PHY, if any and if using the USB PHY framework
eb70e5ab	195	* @hcd: pointer to usb_hcd for ehci host driver
2d651289	196	* @debugfs: root dentry for this controller in debugfs
a107f8c5 PC	197	* @id_event: indicates there is an id event, and handled at ci_otg_work
	198	* @b_sess_valid_event: indicates there is a vbus event, and handled
	199	* at ci_otg_work
ed8f8318	200	* @imx28_write_fix: Freescale imx28 needs swp instruction for writing
1f874edc PC	201	* @supports_runtime_pm: if runtime pm is supported
	202	* @in_lpm: if the core in low power mode
	203	* @wakeup_int: if wakeup interrupt occur
cb271f3c	204	* @rev: The revision number for controller
551a8ac6	205	*/
8e22978c	206	struct ci_hdrc {
551a8ac6 AS	207	struct device *dev;
	208	spinlock_t lock;
	209	struct hw_bank hw_bank;
	210	int irq;
	211	struct ci_role_driver *roles[CI_ROLE_END];
	212	enum ci_role role;
	213	bool is_otg;
ef44cb42	214	struct usb_otg otg;
57677be5	215	struct otg_fsm fsm;
3a316ec4 LJ	216	struct hrtimer otg_fsm_hrtimer;
	217	ktime_t hr_timeouts[NUM_OTG_FSM_TIMERS];
	218	unsigned enabled_otg_timer_bits;
	219	enum otg_fsm_timer next_otg_timer;
551a8ac6 AS	220	struct work_struct work;
	221	struct workqueue_struct *wq;
	222
	223	struct dma_pool *qh_pool;
	224	struct dma_pool *td_pool;
	225
	226	struct usb_gadget gadget;
	227	struct usb_gadget_driver *driver;
4f4555cf	228	enum usb_device_state resume_state;
551a8ac6	229	unsigned hw_ep_max;
8e22978c	230	struct ci_hw_ep ci_hw_ep[ENDPT_MAX];
551a8ac6	231	u32 ep0_dir;
8e22978c	232	struct ci_hw_ep ep0out, ep0in;
551a8ac6 AS	233
	234	struct usb_request *status;
	235	bool setaddr;
	236	u8 address;
	237	u8 remote_wakeup;
	238	u8 suspended;
	239	u8 test_mode;
	240
8e22978c	241	struct ci_hdrc_platform_data *platdata;
551a8ac6	242	int vbus_active;
7bb7e9b1 SB	243	struct ulpi *ulpi;
7bb7e9b1 SB	244	struct ulpi_ops ulpi_ops;
1e5e2d3d AT	245	struct phy *phy;
1e5e2d3d AT	246	/* old usb_phy interface */
ef44cb42	247	struct usb_phy *usb_phy;
eb70e5ab	248	struct usb_hcd *hcd;
2d651289	249	struct dentry *debugfs;
a107f8c5 PC	250	bool id_event;
a107f8c5 PC	251	bool b_sess_valid_event;
ed8f8318	252	bool imx28_write_fix;
1f874edc PC	253	bool supports_runtime_pm;
	254	bool in_lpm;
	255	bool wakeup_int;
cb271f3c	256	enum ci_revision rev;
e443b333 AS	257	};
e443b333 AS	258
8e22978c	259	static inline struct ci_role_driver ci_role(struct ci_hdrc ci)
5f36e231 AS	260	{
	261	BUG_ON(ci->role >= CI_ROLE_END \|\| !ci->roles[ci->role]);
	262	return ci->roles[ci->role];
	263	}
	264
8e22978c	265	static inline int ci_role_start(struct ci_hdrc *ci, enum ci_role role)
5f36e231 AS	266	{
	267	int ret;
	268
	269	if (role >= CI_ROLE_END)
	270	return -EINVAL;
	271
	272	if (!ci->roles[role])
	273	return -ENXIO;
	274
	275	ret = ci->roles[role]->start(ci);
	276	if (!ret)
	277	ci->role = role;
	278	return ret;
	279	}
	280
8e22978c	281	static inline void ci_role_stop(struct ci_hdrc *ci)
5f36e231 AS	282	{
	283	enum ci_role role = ci->role;
	284
	285	if (role == CI_ROLE_END)
	286	return;
	287
	288	ci->role = CI_ROLE_END;
	289
	290	ci->roles[role]->stop(ci);
	291	}
	292
655d32e9 PC	293	/**
	294	* hw_read_id_reg: reads from a identification register
	295	* @ci: the controller
	296	* @offset: offset from the beginning of identification registers region
	297	* @mask: bitfield mask
	298	*
	299	* This function returns register contents
	300	*/
	301	static inline u32 hw_read_id_reg(struct ci_hdrc *ci, u32 offset, u32 mask)
	302	{
	303	return ioread32(ci->hw_bank.abs + offset) & mask;
	304	}
	305
	306	/**
	307	* hw_write_id_reg: writes to a identification register
	308	* @ci: the controller
	309	* @offset: offset from the beginning of identification registers region
	310	* @mask: bitfield mask
	311	* @data: new value
	312	*/
	313	static inline void hw_write_id_reg(struct ci_hdrc *ci, u32 offset,
	314	u32 mask, u32 data)
	315	{
	316	if (~mask)
	317	data = (ioread32(ci->hw_bank.abs + offset) & ~mask)
	318	\| (data & mask);
	319
	320	iowrite32(data, ci->hw_bank.abs + offset);
	321	}
	322
e443b333 AS	323	/**
e443b333 AS	324	* hw_read: reads from a hw register
19353881	325	* @ci: the controller
e443b333 AS	326	* @reg: register index
	327	* @mask: bitfield mask
	328	*
	329	* This function returns register contents
	330	*/
8e22978c	331	static inline u32 hw_read(struct ci_hdrc *ci, enum ci_hw_regs reg, u32 mask)
e443b333	332	{
26c696c6	333	return ioread32(ci->hw_bank.regmap[reg]) & mask;
e443b333 AS	334	}
e443b333 AS	335
ed8f8318 PC	336	#ifdef CONFIG_SOC_IMX28
	337	static inline void imx28_ci_writel(u32 val, volatile void __iomem *addr)
	338	{
	339	__asm__ ("swp %0, %0, [%1]" : : "r"(val), "r"(addr));
	340	}
	341	#else
	342	static inline void imx28_ci_writel(u32 val, volatile void __iomem *addr)
	343	{
	344	}
	345	#endif
	346
	347	static inline void __hw_write(struct ci_hdrc *ci, u32 val,
	348	void __iomem *addr)
	349	{
	350	if (ci->imx28_write_fix)
	351	imx28_ci_writel(val, addr);
	352	else
	353	iowrite32(val, addr);
	354	}
	355
e443b333 AS	356	/**
e443b333 AS	357	* hw_write: writes to a hw register
19353881	358	* @ci: the controller
e443b333 AS	359	* @reg: register index
	360	* @mask: bitfield mask
	361	* @data: new value
	362	*/
8e22978c	363	static inline void hw_write(struct ci_hdrc *ci, enum ci_hw_regs reg,
e443b333 AS	364	u32 mask, u32 data)
	365	{
	366	if (~mask)
26c696c6	367	data = (ioread32(ci->hw_bank.regmap[reg]) & ~mask)
e443b333 AS	368	\| (data & mask);
e443b333 AS	369
ed8f8318	370	__hw_write(ci, data, ci->hw_bank.regmap[reg]);
e443b333 AS	371	}
	372
	373	/**
	374	* hw_test_and_clear: tests & clears a hw register
19353881	375	* @ci: the controller
e443b333 AS	376	* @reg: register index
	377	* @mask: bitfield mask
	378	*
	379	* This function returns register contents
	380	*/
8e22978c	381	static inline u32 hw_test_and_clear(struct ci_hdrc *ci, enum ci_hw_regs reg,
e443b333 AS	382	u32 mask)
e443b333 AS	383	{
26c696c6	384	u32 val = ioread32(ci->hw_bank.regmap[reg]) & mask;
e443b333	385
ed8f8318	386	__hw_write(ci, val, ci->hw_bank.regmap[reg]);
e443b333 AS	387	return val;
	388	}
	389
	390	/**
	391	* hw_test_and_write: tests & writes a hw register
19353881	392	* @ci: the controller
e443b333 AS	393	* @reg: register index
	394	* @mask: bitfield mask
	395	* @data: new value
	396	*
	397	* This function returns register contents
	398	*/
8e22978c	399	static inline u32 hw_test_and_write(struct ci_hdrc *ci, enum ci_hw_regs reg,
e443b333 AS	400	u32 mask, u32 data)
e443b333 AS	401	{
26c696c6	402	u32 val = hw_read(ci, reg, ~0);
e443b333	403
26c696c6	404	hw_write(ci, reg, mask, data);
727b4ddb	405	return (val & mask) >> __ffs(mask);
e443b333 AS	406	}
e443b333 AS	407
57677be5 LJ	408	/**
	409	* ci_otg_is_fsm_mode: runtime check if otg controller
	410	* is in otg fsm mode.
19353881 PC	411	*
19353881 PC	412	* @ci: chipidea device
57677be5 LJ	413	*/
	414	static inline bool ci_otg_is_fsm_mode(struct ci_hdrc *ci)
	415	{
	416	#ifdef CONFIG_USB_OTG_FSM
b0930d4c LJ	417	struct usb_otg_caps *otg_caps = &ci->platdata->ci_otg_caps;
b0930d4c LJ	418
57677be5	419	return ci->is_otg && ci->roles[CI_ROLE_HOST] &&
b0930d4c LJ	420	ci->roles[CI_ROLE_GADGET] && (otg_caps->srp_support \|\|
b0930d4c LJ	421	otg_caps->hnp_support \|\| otg_caps->adp_support);
57677be5 LJ	422	#else
	423	return false;
	424	#endif
	425	}
	426
7bb7e9b1 SB	427	int ci_ulpi_init(struct ci_hdrc *ci);
	428	void ci_ulpi_exit(struct ci_hdrc *ci);
	429	int ci_ulpi_resume(struct ci_hdrc *ci);
7bb7e9b1	430
36304b06 LJ	431	u32 hw_read_intr_enable(struct ci_hdrc *ci);
	432
	433	u32 hw_read_intr_status(struct ci_hdrc *ci);
	434
5b157300	435	int hw_device_reset(struct ci_hdrc *ci);
e443b333	436
8e22978c	437	int hw_port_test_set(struct ci_hdrc *ci, u8 mode);
e443b333	438
8e22978c	439	u8 hw_port_test_get(struct ci_hdrc *ci);
e443b333	440
7bb7e9b1 SB	441	void hw_phymode_configure(struct ci_hdrc *ci);
7bb7e9b1 SB	442
bf9c85e7 PC	443	void ci_platform_configure(struct ci_hdrc *ci);
bf9c85e7 PC	444
a61b75d1	445	void dbg_create_files(struct ci_hdrc *ci);
9d8c850d PC	446
9d8c850d PC	447	void dbg_remove_files(struct ci_hdrc *ci);
e443b333	448	#endif /* __DRIVERS_USB_CHIPIDEA_CI_H */