Merge tag 'trace-v5.11-rc2' of git://git.kernel.org/pub/scm/linux/kernel/git/rostedt...
[linux/fpc-iii.git] / drivers / usb / cdns3 / core.h
blob3176f924293a188b922be6271435627478d8f603
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 * Cadence USBSS DRD Header File.
5 * Copyright (C) 2017-2018 NXP
6 * Copyright (C) 2018-2019 Cadence.
8 * Authors: Peter Chen <peter.chen@nxp.com>
9 * Pawel Laszczak <pawell@cadence.com>
11 #include <linux/usb/otg.h>
12 #include <linux/usb/role.h>
14 #ifndef __LINUX_CDNS3_CORE_H
15 #define __LINUX_CDNS3_CORE_H
17 struct cdns3;
19 /**
20 * struct cdns3_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
29 struct cdns3_role_driver {
30 int (*start)(struct cdns3 *cdns);
31 void (*stop)(struct cdns3 *cdns);
32 int (*suspend)(struct cdns3 *cdns, bool do_wakeup);
33 int (*resume)(struct cdns3 *cdns, bool hibernated);
34 const char *name;
35 #define CDNS3_ROLE_STATE_INACTIVE 0
36 #define CDNS3_ROLE_STATE_ACTIVE 1
37 int state;
40 #define CDNS3_XHCI_RESOURCES_NUM 2
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)
49 /**
50 * struct cdns3 - Representation of Cadence USB3 DRD controller.
51 * @dev: pointer to Cadence device struct
52 * @xhci_regs: pointer to base of xhci registers
53 * @xhci_res: the resource for xhci
54 * @dev_regs: pointer to base of dev registers
55 * @otg_res: the resource for otg
56 * @otg_v0_regs: pointer to base of v0 otg registers
57 * @otg_v1_regs: pointer to base of v1 otg registers
58 * @otg_regs: pointer to base of otg registers
59 * @otg_irq: irq number for otg controller
60 * @dev_irq: irq number for device controller
61 * @wakeup_irq: irq number for wakeup event, it is optional
62 * @roles: array of supported roles for this controller
63 * @role: current role
64 * @host_dev: the child host device pointer for cdns3 core
65 * @gadget_dev: the child gadget device pointer for cdns3 core
66 * @usb2_phy: pointer to USB2 PHY
67 * @usb3_phy: pointer to USB3 PHY
68 * @mutex: the mutex for concurrent code at driver
69 * @dr_mode: supported mode of operation it can be only Host, only Device
70 * or OTG mode that allow to switch between Device and Host mode.
71 * This field based on firmware setting, kernel configuration
72 * and hardware configuration.
73 * @role_sw: pointer to role switch object.
74 * @in_lpm: indicate the controller is in low power mode
75 * @wakeup_pending: wakeup interrupt pending
76 * @pdata: platform data from glue layer
77 * @lock: spinlock structure
78 * @xhci_plat_data: xhci private data structure pointer
80 struct cdns3 {
81 struct device *dev;
82 void __iomem *xhci_regs;
83 struct resource xhci_res[CDNS3_XHCI_RESOURCES_NUM];
84 struct cdns3_usb_regs __iomem *dev_regs;
86 struct resource otg_res;
87 struct cdns3_otg_legacy_regs *otg_v0_regs;
88 struct cdns3_otg_regs *otg_v1_regs;
89 struct cdns3_otg_common_regs *otg_regs;
90 #define CDNS3_CONTROLLER_V0 0
91 #define CDNS3_CONTROLLER_V1 1
92 u32 version;
93 bool phyrst_a_enable;
95 int otg_irq;
96 int dev_irq;
97 int wakeup_irq;
98 struct cdns3_role_driver *roles[USB_ROLE_DEVICE + 1];
99 enum usb_role role;
100 struct platform_device *host_dev;
101 struct cdns3_device *gadget_dev;
102 struct phy *usb2_phy;
103 struct phy *usb3_phy;
104 /* mutext used in workqueue*/
105 struct mutex mutex;
106 enum usb_dr_mode dr_mode;
107 struct usb_role_switch *role_sw;
108 bool in_lpm;
109 bool wakeup_pending;
110 struct cdns3_platform_data *pdata;
111 spinlock_t lock;
112 struct xhci_plat_priv *xhci_plat_data;
115 int cdns3_hw_role_switch(struct cdns3 *cdns);
117 #endif /* __LINUX_CDNS3_CORE_H */