b1234e3b3b
Introduce runtime PM and wakeup interrupt handler for cdns3, the runtime PM is default off since other cdns3 may not implement glue layer support for runtime PM. One typical wakeup event use case is xHCI runtime suspend will clear USBCMD.RS bit, after that the xHCI will not trigger any interrupts, so its parent (cdns core device) needs to resume xHCI device when any (wakeup) events occurs at host port. When the controller is in low power mode, the lpm flag will be set. The interrupt triggered later than lpm flag is set considers as wakeup interrupt and handled at cdns_wakeup_irq. Once the wakeup occurs, it first disables interrupt to avoid later interrupt occurrence since the controller is in low power mode at that time, and access registers may be invalid at that time. At wakeup handler, it will call pm_request_resume to wakeup xHCI device, and at runtime resume handler, it will enable interrupt again. The API platform_suspend is introduced for glue layer to implement platform specific PM sequence. Reviewed-by: Pawel Laszczak <pawell@cadence.com> Signed-off-by: Peter Chen <peter.chen@nxp.com> Signed-off-by: Felipe Balbi <balbi@kernel.org>
113 lines
3.4 KiB
C
113 lines
3.4 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
/*
|
|
* Cadence USBSS DRD Header File.
|
|
*
|
|
* Copyright (C) 2017-2018 NXP
|
|
* Copyright (C) 2018-2019 Cadence.
|
|
*
|
|
* Authors: Peter Chen <peter.chen@nxp.com>
|
|
* Pawel Laszczak <pawell@cadence.com>
|
|
*/
|
|
#include <linux/usb/otg.h>
|
|
#include <linux/usb/role.h>
|
|
|
|
#ifndef __LINUX_CDNS3_CORE_H
|
|
#define __LINUX_CDNS3_CORE_H
|
|
|
|
struct cdns3;
|
|
|
|
/**
|
|
* struct cdns3_role_driver - host/gadget role driver
|
|
* @start: start this role
|
|
* @stop: stop this role
|
|
* @suspend: suspend callback for this role
|
|
* @resume: resume callback for this role
|
|
* @irq: irq handler for this role
|
|
* @name: role name string (host/gadget)
|
|
* @state: current state
|
|
*/
|
|
struct cdns3_role_driver {
|
|
int (*start)(struct cdns3 *cdns);
|
|
void (*stop)(struct cdns3 *cdns);
|
|
int (*suspend)(struct cdns3 *cdns, bool do_wakeup);
|
|
int (*resume)(struct cdns3 *cdns, bool hibernated);
|
|
const char *name;
|
|
#define CDNS3_ROLE_STATE_INACTIVE 0
|
|
#define CDNS3_ROLE_STATE_ACTIVE 1
|
|
int state;
|
|
};
|
|
|
|
#define CDNS3_XHCI_RESOURCES_NUM 2
|
|
|
|
struct cdns3_platform_data {
|
|
int (*platform_suspend)(struct device *dev,
|
|
bool suspend, bool wakeup);
|
|
};
|
|
|
|
/**
|
|
* struct cdns3 - Representation of Cadence USB3 DRD controller.
|
|
* @dev: pointer to Cadence device struct
|
|
* @xhci_regs: pointer to base of xhci registers
|
|
* @xhci_res: the resource for xhci
|
|
* @dev_regs: pointer to base of dev registers
|
|
* @otg_res: the resource for otg
|
|
* @otg_v0_regs: pointer to base of v0 otg registers
|
|
* @otg_v1_regs: pointer to base of v1 otg registers
|
|
* @otg_regs: pointer to base of otg registers
|
|
* @otg_irq: irq number for otg controller
|
|
* @dev_irq: irq number for device controller
|
|
* @wakeup_irq: irq number for wakeup event, it is optional
|
|
* @roles: array of supported roles for this controller
|
|
* @role: current role
|
|
* @host_dev: the child host device pointer for cdns3 core
|
|
* @gadget_dev: the child gadget device pointer for cdns3 core
|
|
* @usb2_phy: pointer to USB2 PHY
|
|
* @usb3_phy: pointer to USB3 PHY
|
|
* @mutex: the mutex for concurrent code at driver
|
|
* @dr_mode: supported mode of operation it can be only Host, only Device
|
|
* or OTG mode that allow to switch between Device and Host mode.
|
|
* This field based on firmware setting, kernel configuration
|
|
* and hardware configuration.
|
|
* @role_sw: pointer to role switch object.
|
|
* @in_lpm: indicate the controller is in low power mode
|
|
* @wakeup_pending: wakeup interrupt pending
|
|
* @pdata: platform data from glue layer
|
|
* @lock: spinlock structure
|
|
*/
|
|
struct cdns3 {
|
|
struct device *dev;
|
|
void __iomem *xhci_regs;
|
|
struct resource xhci_res[CDNS3_XHCI_RESOURCES_NUM];
|
|
struct cdns3_usb_regs __iomem *dev_regs;
|
|
|
|
struct resource otg_res;
|
|
struct cdns3_otg_legacy_regs *otg_v0_regs;
|
|
struct cdns3_otg_regs *otg_v1_regs;
|
|
struct cdns3_otg_common_regs *otg_regs;
|
|
#define CDNS3_CONTROLLER_V0 0
|
|
#define CDNS3_CONTROLLER_V1 1
|
|
u32 version;
|
|
|
|
int otg_irq;
|
|
int dev_irq;
|
|
int wakeup_irq;
|
|
struct cdns3_role_driver *roles[USB_ROLE_DEVICE + 1];
|
|
enum usb_role role;
|
|
struct platform_device *host_dev;
|
|
struct cdns3_device *gadget_dev;
|
|
struct phy *usb2_phy;
|
|
struct phy *usb3_phy;
|
|
/* mutext used in workqueue*/
|
|
struct mutex mutex;
|
|
enum usb_dr_mode dr_mode;
|
|
struct usb_role_switch *role_sw;
|
|
bool in_lpm;
|
|
bool wakeup_pending;
|
|
struct cdns3_platform_data *pdata;
|
|
spinlock_t lock;
|
|
};
|
|
|
|
int cdns3_hw_role_switch(struct cdns3 *cdns);
|
|
|
|
#endif /* __LINUX_CDNS3_CORE_H */
|