1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 * Cadence USBSS and USBSSP DRD Header File.
4 *
5 * Copyright (C) 2017-2018 NXP
6 * Copyright (C) 2018-2019 Cadence.
7 *
8 * Authors: Peter Chen <peter.chen@nxp.com>
9 * Pawel Laszczak <pawell@cadence.com>
10 */
11 #ifndef __LINUX_CDNS3_CORE_H
12 #define __LINUX_CDNS3_CORE_H
13
14 #include <linux/usb/otg.h>
15 #include <linux/usb/role.h>
16
17 struct cdns;
18
19 /**
20 * struct cdns_role_driver - host/gadget role driver
21 * @start: start this role
22 * @stop: stop this role
23 * @suspend: suspend callback for this role
24 * @resume: resume callback for this role
25 * @irq: irq handler for this role
26 * @name: role name string (host/gadget)
27 * @state: current state
28 */
29 struct cdns_role_driver {
30 int (*start)(struct cdns *cdns);
31 void (*stop)(struct cdns *cdns);
32 int (*suspend)(struct cdns *cdns, bool do_wakeup);
33 int (*resume)(struct cdns *cdns, bool hibernated);
34 const char *name;
35 #define CDNS_ROLE_STATE_INACTIVE 0
36 #define CDNS_ROLE_STATE_ACTIVE 1
37 int state;
38 };
39
40 #define CDNS_XHCI_RESOURCES_NUM 2
41
42 struct cdns3_platform_data {
43 int (*platform_suspend)(struct device *dev,
44 bool suspend, bool wakeup);
45 unsigned long quirks;
46 #define CDNS3_DEFAULT_PM_RUNTIME_ALLOW BIT(0)
47 #define CDNS3_DRD_SUSPEND_RESIDENCY_ENABLE BIT(1)
48 };
49
50 /**
51 * struct cdns - Representation of Cadence USB3 DRD controller.
52 * @dev: pointer to Cadence device struct
53 * @xhci_regs: pointer to base of xhci registers
54 * @xhci_res: the resource for xhci
55 * @dev_regs: pointer to base of dev registers
56 * @otg_res: the resource for otg
57 * @otg_v0_regs: pointer to base of v0 otg registers
58 * @otg_v1_regs: pointer to base of v1 otg registers
59 * @otg_cdnsp_regs: pointer to base of CDNSP otg registers
60 * @otg_regs: pointer to base of otg registers
61 * @otg_irq_regs: pointer to interrupt registers
62 * @otg_irq: irq number for otg controller
63 * @dev_irq: irq number for device controller
64 * @wakeup_irq: irq number for wakeup event, it is optional
65 * @roles: array of supported roles for this controller
66 * @role: current role
67 * @host_dev: the child host device pointer for cdns core
68 * @gadget_dev: the child gadget device pointer
69 * @usb2_phy: pointer to USB2 PHY
70 * @usb3_phy: pointer to USB3 PHY
71 * @mutex: the mutex for concurrent code at driver
72 * @dr_mode: supported mode of operation it can be only Host, only Device
73 * or OTG mode that allow to switch between Device and Host mode.
74 * This field based on firmware setting, kernel configuration
75 * and hardware configuration.
76 * @role_sw: pointer to role switch object.
77 * @in_lpm: indicate the controller is in low power mode
78 * @wakeup_pending: wakeup interrupt pending
79 * @pdata: platform data from glue layer
80 * @lock: spinlock structure
81 * @xhci_plat_data: xhci private data structure pointer
82 * @override_apb_timeout: hold value of APB timeout. For value 0 the default
83 * value in CHICKEN_BITS_3 will be preserved.
84 * @gadget_init: pointer to gadget initialization function
85 */
86 struct cdns {
87 struct device *dev;
88 void __iomem *xhci_regs;
89 struct resource xhci_res[CDNS_XHCI_RESOURCES_NUM];
90 struct cdns3_usb_regs __iomem *dev_regs;
91
92 struct resource otg_res;
93 struct cdns3_otg_legacy_regs __iomem *otg_v0_regs;
94 struct cdns3_otg_regs __iomem *otg_v1_regs;
95 struct cdnsp_otg_regs __iomem *otg_cdnsp_regs;
96 struct cdns_otg_common_regs __iomem *otg_regs;
97 struct cdns_otg_irq_regs __iomem *otg_irq_regs;
98 #define CDNS3_CONTROLLER_V0 0
99 #define CDNS3_CONTROLLER_V1 1
100 #define CDNSP_CONTROLLER_V2 2
101 u32 version;
102 bool phyrst_a_enable;
103
104 int otg_irq;
105 int dev_irq;
106 int wakeup_irq;
107 struct cdns_role_driver *roles[USB_ROLE_DEVICE + 1];
108 enum usb_role role;
109 struct platform_device *host_dev;
110 void *gadget_dev;
111 struct phy *usb2_phy;
112 struct phy *usb3_phy;
113 /* mutext used in workqueue*/
114 struct mutex mutex;
115 enum usb_dr_mode dr_mode;
116 struct usb_role_switch *role_sw;
117 bool in_lpm;
118 bool wakeup_pending;
119 struct cdns3_platform_data *pdata;
120 spinlock_t lock;
121 struct xhci_plat_priv *xhci_plat_data;
122 u32 override_apb_timeout;
123
124 int (*gadget_init)(struct cdns *cdns);
125 };
126
127 int cdns_hw_role_switch(struct cdns *cdns);
128 int cdns_init(struct cdns *cdns);
129 int cdns_remove(struct cdns *cdns);
130
131 #ifdef CONFIG_PM_SLEEP
132 int cdns_resume(struct cdns *cdns);
133 int cdns_suspend(struct cdns *cdns);
134 void cdns_set_active(struct cdns *cdns, u8 set_active);
135 #else /* CONFIG_PM_SLEEP */
cdns_resume(struct cdns * cdns)136 static inline int cdns_resume(struct cdns *cdns)
137 { return 0; }
cdns_set_active(struct cdns * cdns,u8 set_active)138 static inline void cdns_set_active(struct cdns *cdns, u8 set_active) { }
cdns_suspend(struct cdns * cdns)139 static inline int cdns_suspend(struct cdns *cdns)
140 { return 0; }
141 #endif /* CONFIG_PM_SLEEP */
142 #endif /* __LINUX_CDNS3_CORE_H */
143