kernel-brax3-ubuntu-touch/drivers/usb/mtu3/mtu3_dr.c
erascape f319b992b1 kernel-5.15: Initial import brax3 UT kernel
* halium configs enabled

Signed-off-by: erascape <erascape@proton.me>
2025-09-23 15:17:10 +00:00

702 lines
18 KiB
C

// SPDX-License-Identifier: GPL-2.0
/*
* mtu3_dr.c - dual role switch and host glue layer
*
* Copyright (C) 2016 MediaTek Inc.
*
* Author: Chunfeng Yun <chunfeng.yun@mediatek.com>
*/
#include <linux/usb/role.h>
#include <linux/of_platform.h>
#include <linux/iopoll.h>
#include "mtu3.h"
#include "mtu3_dr.h"
#include "mtu3_debug.h"
#define USB2_PORT 2
#define USB3_PORT 3
static inline struct ssusb_mtk *otg_sx_to_ssusb(struct otg_switch_mtk *otg_sx)
{
return container_of(otg_sx, struct ssusb_mtk, otg_switch);
}
static void toggle_opstate(struct ssusb_mtk *ssusb)
{
mtu3_setbits(ssusb->mac_base, U3D_DEVICE_CONTROL, DC_SESSION);
mtu3_setbits(ssusb->mac_base, U3D_POWER_MANAGEMENT, SOFT_CONN);
}
/* only port0 supports dual-role mode */
static int ssusb_port0_switch(struct ssusb_mtk *ssusb,
int version, bool tohost)
{
void __iomem *ibase = ssusb->ippc_base;
u32 value;
dev_dbg(ssusb->dev, "%s (switch u%d port0 to %s)\n", __func__,
version, tohost ? "host" : "device");
if (version == USB2_PORT) {
/* 1. power off and disable u2 port0 */
value = mtu3_readl(ibase, SSUSB_U2_CTRL(0));
value |= SSUSB_U2_PORT_PDN | SSUSB_U2_PORT_DIS;
mtu3_writel(ibase, SSUSB_U2_CTRL(0), value);
/* 2. power on, enable u2 port0 and select its mode */
value = mtu3_readl(ibase, SSUSB_U2_CTRL(0));
value &= ~(SSUSB_U2_PORT_PDN | SSUSB_U2_PORT_DIS);
value = tohost ? (value | SSUSB_U2_PORT_HOST_SEL) :
(value & (~SSUSB_U2_PORT_HOST_SEL));
mtu3_writel(ibase, SSUSB_U2_CTRL(0), value);
} else {
/* 1. power off and disable u3 port0 */
value = mtu3_readl(ibase, SSUSB_U3_CTRL(0));
value |= SSUSB_U3_PORT_PDN | SSUSB_U3_PORT_DIS;
mtu3_writel(ibase, SSUSB_U3_CTRL(0), value);
/* 2. power on, enable u3 port0 and select its mode */
value = mtu3_readl(ibase, SSUSB_U3_CTRL(0));
value &= ~(SSUSB_U3_PORT_PDN | SSUSB_U3_PORT_DIS);
value = tohost ? (value | SSUSB_U3_PORT_HOST_SEL) :
(value & (~SSUSB_U3_PORT_HOST_SEL));
mtu3_writel(ibase, SSUSB_U3_CTRL(0), value);
}
return 0;
}
static void ssusb_ip_sleep(struct ssusb_mtk *ssusb)
{
void __iomem *ibase = ssusb->ippc_base;
u32 value;
int ret;
/* power down and disable all u3 ports */
value = mtu3_readl(ibase, SSUSB_U3_CTRL(0));
value |= SSUSB_U3_PORT_PDN | SSUSB_U3_PORT_DIS;
mtu3_writel(ibase, SSUSB_U3_CTRL(0), value);
mtu3_clrbits(ibase, SSUSB_U3_CTRL(0), SSUSB_U3_PORT_DUAL_MODE);
/* power down and disable all u2 ports */
value = mtu3_readl(ibase, SSUSB_U2_CTRL(0));
value |= SSUSB_U2_PORT_PDN | SSUSB_U2_PORT_DIS;
mtu3_writel(ibase, SSUSB_U2_CTRL(0), value);
mtu3_clrbits(ibase, SSUSB_U2_CTRL(0), SSUSB_U2_PORT_OTG_SEL);
/* power down device ip */
mtu3_setbits(ibase, U3D_SSUSB_IP_PW_CTRL2, SSUSB_IP_DEV_PDN);
/* power down host ip */
mtu3_setbits(ibase, U3D_SSUSB_IP_PW_CTRL1, SSUSB_IP_HOST_PDN);
/* wait for ip to sleep */
ret = readl_poll_timeout(ibase + U3D_SSUSB_IP_PW_STS1, value,
(value & SSUSB_IP_SLEEP_STS), 100, 100000);
if (ret)
dev_info(ssusb->dev, "ip sleep failed!!!\n");
}
static void switch_port_to_on(struct ssusb_mtk *ssusb, enum phy_mode mode)
{
dev_info(ssusb->dev, "port on (%d)\n", mode);
ssusb_clks_enable(ssusb);
ssusb_vsvoter_set(ssusb);
ssusb_phy_power_on(ssusb);
ssusb_phy_set_mode(ssusb, mode);
ssusb_ip_sw_reset(ssusb);
}
static void switch_port_to_off(struct ssusb_mtk *ssusb)
{
dev_info(ssusb->dev, "port off\n");
synchronize_irq(ssusb->u3d->irq);
ssusb_ip_sleep(ssusb);
ssusb_phy_set_mode(ssusb, PHY_MODE_INVALID);
ssusb_phy_power_off(ssusb);
ssusb_vsvoter_clr(ssusb);
ssusb_clks_disable(ssusb);
}
static void switch_port_to_host(struct ssusb_mtk *ssusb)
{
u32 check_clk = 0;
dev_dbg(ssusb->dev, "%s\n", __func__);
ssusb_port0_switch(ssusb, USB2_PORT, true);
if (ssusb->otg_switch.is_u3_drd) {
ssusb_port0_switch(ssusb, USB3_PORT, true);
check_clk = SSUSB_U3_MAC_RST_B_STS;
}
ssusb_check_clocks(ssusb, check_clk);
/* after all clocks are stable */
toggle_opstate(ssusb);
}
static void switch_port_to_device(struct ssusb_mtk *ssusb)
{
u32 check_clk = 0;
dev_dbg(ssusb->dev, "%s\n", __func__);
ssusb_port0_switch(ssusb, USB2_PORT, false);
if (ssusb->otg_switch.is_u3_drd) {
ssusb_port0_switch(ssusb, USB3_PORT, false);
check_clk = SSUSB_U3_MAC_RST_B_STS;
}
ssusb_check_clocks(ssusb, check_clk);
}
static void ssusb_host_register(struct ssusb_mtk *ssusb, bool on)
{
int ret;
dev_info(ssusb->dev, "%s %d\n", __func__, on);
if (!ssusb->xhci_pdrv)
return;
if (on) {
ret = platform_driver_register(ssusb->xhci_pdrv);
if (ret)
dev_info(ssusb->dev, "register host driver fail\n");
} else {
platform_driver_unregister(ssusb->xhci_pdrv);
}
}
int ssusb_set_vbus(struct otg_switch_mtk *otg_sx, int is_on)
{
struct ssusb_mtk *ssusb = otg_sx_to_ssusb(otg_sx);
struct regulator *vbus = otg_sx->vbus;
int ret;
/* vbus is optional */
if (!vbus)
return 0;
dev_dbg(ssusb->dev, "%s: turn %s\n", __func__, is_on ? "on" : "off");
if (is_on) {
ret = regulator_enable(vbus);
if (ret) {
dev_err(ssusb->dev, "vbus regulator enable failed\n");
return ret;
}
} else {
regulator_disable(vbus);
}
return 0;
}
static void ssusb_mode_sw_work_v2(struct work_struct *work)
{
struct otg_switch_mtk *otg_sx =
container_of(work, struct otg_switch_mtk, dr_work);
struct ssusb_mtk *ssusb = otg_sx_to_ssusb(otg_sx);
struct mtu3 *mtu = ssusb->u3d;
enum usb_role desired_role = otg_sx->desired_role;
enum usb_role current_role = otg_sx->current_role;
unsigned long flags;
if (current_role == desired_role)
return;
dev_info(ssusb->dev, "%s: %s to %s\n", __func__,
usb_role_string(current_role), usb_role_string(desired_role));
mtu3_dbg_trace(ssusb->dev, "set role : %s", usb_role_string(desired_role));
pm_runtime_get_sync(ssusb->dev);
/* switch port to off first */
switch (current_role) {
case USB_ROLE_HOST:
ssusb->is_host = false;
ssusb_set_vbus(otg_sx, 0);
/* unregister host driver */
ssusb_host_register(ssusb, false);
ssusb_set_power_state(ssusb, MTU3_STATE_POWER_OFF);
ssusb_host_disable(ssusb);
switch_port_to_off(ssusb);
break;
case USB_ROLE_DEVICE:
spin_lock_irqsave(&mtu->lock, flags);
mtu3_stop(mtu);
/* report disconnect */
if (mtu->g.speed != USB_SPEED_UNKNOWN)
mtu3_gadget_disconnect(mtu);
spin_unlock_irqrestore(&mtu->lock, flags);
ssusb_set_power_state(ssusb, MTU3_STATE_POWER_OFF);
mtu3_device_disable(mtu);
switch_port_to_off(ssusb);
pm_relax(ssusb->dev);
break;
case USB_ROLE_NONE:
break;
default:
dev_info(ssusb->dev, "invalid role\n");
}
/* switch port to on again */
switch (desired_role) {
case USB_ROLE_HOST:
switch_port_to_on(ssusb, PHY_MODE_USB_HOST);
ssusb_host_enable(ssusb);
ssusb_set_power_state(ssusb, MTU3_STATE_POWER_ON);
ssusb_set_force_mode(ssusb, MTU3_DR_FORCE_HOST);
/* register host driver */
ssusb_host_register(ssusb, true);
ssusb_set_noise_still_tr(ssusb);
ssusb_set_vbus(otg_sx, 1);
ssusb->is_host = true;
break;
case USB_ROLE_DEVICE:
/* avoid suspend when works as device */
pm_stay_awake(ssusb->dev);
switch_port_to_on(ssusb, PHY_MODE_USB_DEVICE);
mtu3_device_enable(mtu);
ssusb_set_power_state(ssusb, MTU3_STATE_POWER_ON);
ssusb_set_force_mode(ssusb, MTU3_DR_FORCE_DEVICE);
mtu3_start(mtu);
break;
case USB_ROLE_NONE:
break;
default:
dev_info(ssusb->dev, "invalid role\n");
}
otg_sx->current_role = desired_role;
pm_runtime_put(ssusb->dev);
}
static void ssusb_mode_sw_work(struct work_struct *work)
{
struct otg_switch_mtk *otg_sx =
container_of(work, struct otg_switch_mtk, dr_work);
struct ssusb_mtk *ssusb = otg_sx_to_ssusb(otg_sx);
struct mtu3 *mtu = ssusb->u3d;
enum usb_role desired_role = otg_sx->desired_role;
enum usb_role current_role;
current_role = ssusb->is_host ? USB_ROLE_HOST : USB_ROLE_DEVICE;
if (desired_role == USB_ROLE_NONE) {
/* the default mode is host as probe does */
desired_role = USB_ROLE_HOST;
if (otg_sx->default_role == USB_ROLE_DEVICE)
desired_role = USB_ROLE_DEVICE;
}
if (current_role == desired_role)
return;
dev_dbg(ssusb->dev, "set role : %s\n", usb_role_string(desired_role));
mtu3_dbg_trace(ssusb->dev, "set role : %s", usb_role_string(desired_role));
pm_runtime_get_sync(ssusb->dev);
switch (desired_role) {
case USB_ROLE_HOST:
ssusb_set_force_mode(ssusb, MTU3_DR_FORCE_HOST);
mtu3_stop(mtu);
switch_port_to_host(ssusb);
ssusb_set_vbus(otg_sx, 1);
ssusb->is_host = true;
break;
case USB_ROLE_DEVICE:
ssusb_set_force_mode(ssusb, MTU3_DR_FORCE_DEVICE);
ssusb->is_host = false;
ssusb_set_vbus(otg_sx, 0);
switch_port_to_device(ssusb);
mtu3_start(mtu);
break;
case USB_ROLE_NONE:
default:
dev_err(ssusb->dev, "invalid role\n");
}
pm_runtime_put(ssusb->dev);
}
static void ssusb_set_mode(struct otg_switch_mtk *otg_sx, enum usb_role role)
{
struct ssusb_mtk *ssusb = otg_sx_to_ssusb(otg_sx);
dev_info(ssusb->dev, "%s %s\n", __func__, usb_role_string(role));
otg_sx->latest_role = role;
if (otg_sx->op_mode != MTU3_DR_OPERATION_DUAL) {
dev_info(ssusb->dev, "op_mode %d, skip set role\n", otg_sx->op_mode);
return;
}
if (ssusb->dr_mode != USB_DR_MODE_OTG)
return;
otg_sx->desired_role = role;
queue_work(system_freezable_wq, &otg_sx->dr_work);
}
static int ssusb_id_notifier(struct notifier_block *nb,
unsigned long event, void *ptr)
{
struct otg_switch_mtk *otg_sx =
container_of(nb, struct otg_switch_mtk, id_nb);
ssusb_set_mode(otg_sx, event ? USB_ROLE_HOST : USB_ROLE_DEVICE);
return NOTIFY_DONE;
}
static int ssusb_extcon_register(struct otg_switch_mtk *otg_sx)
{
struct ssusb_mtk *ssusb = otg_sx_to_ssusb(otg_sx);
struct extcon_dev *edev = otg_sx->edev;
int ret;
/* extcon is optional */
if (!edev)
return 0;
otg_sx->id_nb.notifier_call = ssusb_id_notifier;
ret = devm_extcon_register_notifier(ssusb->dev, edev, EXTCON_USB_HOST,
&otg_sx->id_nb);
if (ret < 0) {
dev_err(ssusb->dev, "failed to register notifier for USB-HOST\n");
return ret;
}
ret = extcon_get_state(edev, EXTCON_USB_HOST);
dev_dbg(ssusb->dev, "EXTCON_USB_HOST: %d\n", ret);
/* default as host, switch to device mode if needed */
if (!ret)
ssusb_set_mode(otg_sx, USB_ROLE_DEVICE);
return 0;
}
/*
* We provide an interface via debugfs to switch between host and device modes
* depending on user input.
* This is useful in special cases, such as uses TYPE-A receptacle but also
* wants to support dual-role mode.
*/
void ssusb_mode_switch(struct ssusb_mtk *ssusb, int to_host)
{
struct otg_switch_mtk *otg_sx = &ssusb->otg_switch;
ssusb_set_mode(otg_sx, to_host ? USB_ROLE_HOST : USB_ROLE_DEVICE);
}
void ssusb_set_force_mode(struct ssusb_mtk *ssusb,
enum mtu3_dr_force_mode mode)
{
u32 value;
value = mtu3_readl(ssusb->ippc_base, SSUSB_U2_CTRL(0));
switch (mode) {
case MTU3_DR_FORCE_DEVICE:
value |= SSUSB_U2_PORT_FORCE_IDDIG | SSUSB_U2_PORT_RG_IDDIG;
break;
case MTU3_DR_FORCE_HOST:
value |= SSUSB_U2_PORT_FORCE_IDDIG;
value &= ~SSUSB_U2_PORT_RG_IDDIG;
break;
case MTU3_DR_FORCE_NONE:
value &= ~(SSUSB_U2_PORT_FORCE_IDDIG | SSUSB_U2_PORT_RG_IDDIG);
break;
default:
return;
}
mtu3_writel(ssusb->ippc_base, SSUSB_U2_CTRL(0), value);
}
static int ssusb_role_sw_set(struct usb_role_switch *sw, enum usb_role role)
{
struct ssusb_mtk *ssusb = usb_role_switch_get_drvdata(sw);
struct otg_switch_mtk *otg_sx = &ssusb->otg_switch;
/* wait for host device remove done, e.g. usb audio */
if (otg_sx->current_role == USB_ROLE_HOST)
mdelay(100);
ssusb_set_mode(otg_sx, role);
return 0;
}
static enum usb_role ssusb_role_sw_get(struct usb_role_switch *sw)
{
struct ssusb_mtk *ssusb = usb_role_switch_get_drvdata(sw);
return ssusb->is_host ? USB_ROLE_HOST : USB_ROLE_DEVICE;
}
static int ssusb_role_sw_register(struct otg_switch_mtk *otg_sx)
{
struct usb_role_switch_desc role_sx_desc = { 0 };
struct ssusb_mtk *ssusb = otg_sx_to_ssusb(otg_sx);
struct device *dev = ssusb->dev;
enum usb_dr_mode mode;
if (!otg_sx->role_sw_used)
return 0;
mode = usb_get_role_switch_default_mode(dev);
if (mode == USB_DR_MODE_PERIPHERAL)
otg_sx->default_role = USB_ROLE_DEVICE;
else
otg_sx->default_role = USB_ROLE_HOST;
if (ssusb->clk_mgr)
otg_sx->default_role = USB_ROLE_NONE;
role_sx_desc.set = ssusb_role_sw_set;
role_sx_desc.get = ssusb_role_sw_get;
role_sx_desc.fwnode = dev_fwnode(dev);
role_sx_desc.driver_data = ssusb;
role_sx_desc.allow_userspace_control = true;
otg_sx->role_sw = usb_role_switch_register(dev, &role_sx_desc);
if (IS_ERR(otg_sx->role_sw))
return PTR_ERR(otg_sx->role_sw);
ssusb_set_mode(otg_sx, otg_sx->default_role);
return 0;
}
static ssize_t mode_store(struct device *dev,
struct device_attribute *attr,
const char *buf, size_t count)
{
struct ssusb_mtk *ssusb = dev_get_drvdata(dev);
struct otg_switch_mtk *otg_sx = &ssusb->otg_switch;
enum usb_role role = otg_sx->latest_role;
int mode;
if (kstrtoint(buf, 10, &mode))
return -EINVAL;
dev_info(dev, "store mode %d op_mode %d\n", mode, otg_sx->op_mode);
if (otg_sx->op_mode != mode) {
/* set switch role */
switch (mode) {
case MTU3_DR_OPERATION_OFF:
otg_sx->latest_role = USB_ROLE_NONE;
break;
case MTU3_DR_OPERATION_DUAL:
/* switch usb role to latest role */
break;
case MTU3_DR_OPERATION_HOST:
otg_sx->latest_role = USB_ROLE_HOST;
break;
case MTU3_DR_OPERATION_DEVICE:
otg_sx->latest_role = USB_ROLE_DEVICE;
break;
default:
return -EINVAL;
}
/* switch operation mode to normal temporarily */
otg_sx->op_mode = MTU3_DR_OPERATION_DUAL;
/* switch usb role */
ssusb_role_sw_set(otg_sx->role_sw, otg_sx->latest_role);
/* update operation mode */
otg_sx->op_mode = mode;
/* restore role */
otg_sx->latest_role = role;
}
return count;
}
static ssize_t mode_show(struct device *dev,
struct device_attribute *attr,
char *buf)
{
struct ssusb_mtk *ssusb = dev_get_drvdata(dev);
struct otg_switch_mtk *otg_sx = &ssusb->otg_switch;
return sprintf(buf, "%d\n", otg_sx->op_mode);
}
static DEVICE_ATTR_RW(mode);
static ssize_t role_mode_show(struct device *dev,
struct device_attribute *attr,
char *buf)
{
struct ssusb_mtk *ssusb = dev_get_drvdata(dev);
struct otg_switch_mtk *otg_sx = &ssusb->otg_switch;
return sprintf(buf, "%d\n", otg_sx->current_role);
}
static DEVICE_ATTR_RO(role_mode);
static ssize_t max_speed_store(struct device *dev,
struct device_attribute *attr,
const char *buf, size_t count)
{
struct ssusb_mtk *ssusb = dev_get_drvdata(dev);
struct mtu3 *mtu = ssusb->u3d;
int speed;
if (!strncmp(buf, "super-speed-plus", 16))
speed = USB_SPEED_SUPER_PLUS;
else if (!strncmp(buf, "super-speed", 11))
speed = USB_SPEED_SUPER;
else if (!strncmp(buf, "high-speed", 10))
speed = USB_SPEED_HIGH;
else if (!strncmp(buf, "full-speed", 10))
speed = USB_SPEED_FULL;
else
return -EFAULT;
dev_info(dev, "store speed %s\n", buf);
if ((!mtu->is_u3_ip || mtu->ssusb->u2_ip) && (speed > USB_SPEED_HIGH)) {
dev_info(dev, "not u3 ip, set max_speed to high speed\n");
speed = USB_SPEED_HIGH;
}
mtu->max_speed = speed;
mtu->g.max_speed = speed;
return count;
}
static ssize_t max_speed_show(struct device *dev,
struct device_attribute *attr,
char *buf)
{
struct ssusb_mtk *ssusb = dev_get_drvdata(dev);
struct mtu3 *mtu = ssusb->u3d;
return sprintf(buf, "%s\n", usb_speed_string(mtu->max_speed));
}
static DEVICE_ATTR_RW(max_speed);
static ssize_t saving_store(struct device *dev,
struct device_attribute *attr,
const char *buf, size_t count)
{
struct ssusb_mtk *ssusb = dev_get_drvdata(dev);
struct mtu3 *mtu = ssusb->u3d;
int mode;
if (kstrtoint(buf, 10, &mode))
return -EINVAL;
if (mode < MTU3_EP_SLOT_DEFAULT || mode > MTU3_EP_SLOT_MAX)
return -EINVAL;
mtu->ep_slot_mode = mode;
dev_info(dev, "slot mode %d\n", mtu->ep_slot_mode);
return count;
}
static ssize_t saving_show(struct device *dev,
struct device_attribute *attr,
char *buf)
{
struct ssusb_mtk *ssusb = dev_get_drvdata(dev);
struct mtu3 *mtu = ssusb->u3d;
return sprintf(buf, "%d\n", mtu->ep_slot_mode);
}
static DEVICE_ATTR_RW(saving);
static ssize_t u3_lpm_store(struct device *dev,
struct device_attribute *attr,
const char *buf, size_t count)
{
struct ssusb_mtk *ssusb = dev_get_drvdata(dev);
struct mtu3 *mtu = ssusb->u3d;
bool enable;
if (kstrtobool(buf, &enable))
return -EINVAL;
if (of_property_read_bool(dev->of_node, "usb3-lpm-disable"))
return -EINVAL;
mtu->u3_lpm = enable ? 1 : 0;
return count;
}
static ssize_t u3_lpm_show(struct device *dev,
struct device_attribute *attr,
char *buf)
{
struct ssusb_mtk *ssusb = dev_get_drvdata(dev);
struct mtu3 *mtu = ssusb->u3d;
return sprintf(buf, "%d\n", mtu->u3_lpm);
}
static DEVICE_ATTR_RW(u3_lpm);
static struct attribute *ssusb_dr_attrs[] = {
&dev_attr_mode.attr,
&dev_attr_role_mode.attr,
&dev_attr_max_speed.attr,
&dev_attr_saving.attr,
&dev_attr_u3_lpm.attr,
NULL
};
static const struct attribute_group ssusb_dr_group = {
.attrs = ssusb_dr_attrs,
};
int ssusb_otg_switch_init(struct ssusb_mtk *ssusb)
{
struct otg_switch_mtk *otg_sx = &ssusb->otg_switch;
int ret = 0;
if (ssusb->clk_mgr)
INIT_WORK(&otg_sx->dr_work, ssusb_mode_sw_work_v2);
else
INIT_WORK(&otg_sx->dr_work, ssusb_mode_sw_work);
/* initial operation mode */
otg_sx->op_mode = MTU3_DR_OPERATION_DUAL;
otg_sx->current_role = ssusb->is_host ?
USB_ROLE_HOST : USB_ROLE_DEVICE;
ret = sysfs_create_group(&ssusb->dev->kobj, &ssusb_dr_group);
if (ret)
dev_info(ssusb->dev, "error creating sysfs attributes\n");
if (otg_sx->manual_drd_enabled)
ssusb_dr_debugfs_init(ssusb);
else if (otg_sx->role_sw_used)
ret = ssusb_role_sw_register(otg_sx);
else
ret = ssusb_extcon_register(otg_sx);
return ret;
}
void ssusb_otg_switch_exit(struct ssusb_mtk *ssusb)
{
struct otg_switch_mtk *otg_sx = &ssusb->otg_switch;
cancel_work_sync(&otg_sx->dr_work);
usb_role_switch_unregister(otg_sx->role_sw);
sysfs_remove_group(&ssusb->dev->kobj, &ssusb_dr_group);
}