/* 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 #include #include #include #include #include #include #include /****************************************************************************** * DEFINE *****************************************************************************/ #define TD_PAGE_COUNT 5 #define CI_HDRC_PAGE_SIZE 4096ul /* page size for TD's */ #define ENDPT_MAX 32 #define CI_MAX_BUF_SIZE (TD_PAGE_COUNT * CI_HDRC_PAGE_SIZE) /****************************************************************************** * 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 * @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 * @mutex: protect code from concorrent running when doing role switch */ 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 usb_role_switch *role_switch; 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; 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; struct mutex mutex; }; 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); } static inline enum usb_role ci_role_to_usb_role(struct ci_hdrc *ci) { if (ci->role == CI_ROLE_HOST) return USB_ROLE_HOST; else if (ci->role == CI_ROLE_GADGET && ci->vbus_active) return USB_ROLE_DEVICE; else return USB_ROLE_NONE; } static inline enum ci_role usb_role_to_ci_role(enum usb_role role) { if (role == USB_ROLE_HOST) return CI_ROLE_HOST; else if (role == USB_ROLE_DEVICE) return CI_ROLE_GADGET; else return CI_ROLE_END; } /** * 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 */