drivers/usb/mtu3/mtu3_dr.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * mtu3_dr.c - dual role switch and host glue layer
   4  *
   5  * Copyright (C) 2016 MediaTek Inc.
   6  *
   7  * Author: Chunfeng Yun <chunfeng.yun@mediatek.com>
   8  */
   9
  10 #include "mtu3.h"
  11 #include "mtu3_dr.h"
  12 #include "mtu3_debug.h"
  13
  14 #define USB2_PORT 2
  15 #define USB3_PORT 3
  16
  17 static inline struct ssusb_mtk *otg_sx_to_ssusb(struct otg_switch_mtk *otg_sx)
  18 {
  19         return container_of(otg_sx, struct ssusb_mtk, otg_switch);
  20 }
  21
  22 static void toggle_opstate(struct ssusb_mtk *ssusb)
  23 {
  24         if (!ssusb->otg_switch.is_u3_drd) {
  25                 mtu3_setbits(ssusb->mac_base, U3D_DEVICE_CONTROL, DC_SESSION);
  26                 mtu3_setbits(ssusb->mac_base, U3D_POWER_MANAGEMENT, SOFT_CONN);
  27         }
  28 }
  29
  30 /* only port0 supports dual-role mode */
  31 static int ssusb_port0_switch(struct ssusb_mtk *ssusb,
  32         int version, bool tohost)
  33 {
  34         void __iomem *ibase = ssusb->ippc_base;
  35         u32 value;
  36
  37         dev_dbg(ssusb->dev, "%s (switch u%d port0 to %s)\n", __func__,
  38                 version, tohost ? "host" : "device");
  39
  40         if (version == USB2_PORT) {
  41                 /* 1. power off and disable u2 port0 */
  42                 value = mtu3_readl(ibase, SSUSB_U2_CTRL(0));
  43                 value |= SSUSB_U2_PORT_PDN | SSUSB_U2_PORT_DIS;
  44                 mtu3_writel(ibase, SSUSB_U2_CTRL(0), value);
  45
  46                 /* 2. power on, enable u2 port0 and select its mode */
  47                 value = mtu3_readl(ibase, SSUSB_U2_CTRL(0));
  48                 value &= ~(SSUSB_U2_PORT_PDN | SSUSB_U2_PORT_DIS);
  49                 value = tohost ? (value | SSUSB_U2_PORT_HOST_SEL) :
  50                         (value & (~SSUSB_U2_PORT_HOST_SEL));
  51                 mtu3_writel(ibase, SSUSB_U2_CTRL(0), value);
  52         } else {
  53                 /* 1. power off and disable u3 port0 */
  54                 value = mtu3_readl(ibase, SSUSB_U3_CTRL(0));
  55                 value |= SSUSB_U3_PORT_PDN | SSUSB_U3_PORT_DIS;
  56                 mtu3_writel(ibase, SSUSB_U3_CTRL(0), value);
  57
  58                 /* 2. power on, enable u3 port0 and select its mode */
  59                 value = mtu3_readl(ibase, SSUSB_U3_CTRL(0));
  60                 value &= ~(SSUSB_U3_PORT_PDN | SSUSB_U3_PORT_DIS);
  61                 value = tohost ? (value | SSUSB_U3_PORT_HOST_SEL) :
  62                         (value & (~SSUSB_U3_PORT_HOST_SEL));
  63                 mtu3_writel(ibase, SSUSB_U3_CTRL(0), value);
  64         }
  65
  66         return 0;
  67 }
  68
  69 static void switch_port_to_host(struct ssusb_mtk *ssusb)
  70 {
  71         u32 check_clk = 0;
  72
  73         dev_dbg(ssusb->dev, "%s\n", __func__);
  74
  75         ssusb_port0_switch(ssusb, USB2_PORT, true);
  76
  77         if (ssusb->otg_switch.is_u3_drd) {
  78                 ssusb_port0_switch(ssusb, USB3_PORT, true);
  79                 check_clk = SSUSB_U3_MAC_RST_B_STS;
  80         }
  81
  82         ssusb_check_clocks(ssusb, check_clk);
  83
  84         /* after all clocks are stable */
  85         toggle_opstate(ssusb);
  86 }
  87
  88 static void switch_port_to_device(struct ssusb_mtk *ssusb)
  89 {
  90         u32 check_clk = 0;
  91
  92         dev_dbg(ssusb->dev, "%s\n", __func__);
  93
  94         ssusb_port0_switch(ssusb, USB2_PORT, false);
  95
  96         if (ssusb->otg_switch.is_u3_drd) {
  97                 ssusb_port0_switch(ssusb, USB3_PORT, false);
  98                 check_clk = SSUSB_U3_MAC_RST_B_STS;
  99         }
 100
 101         ssusb_check_clocks(ssusb, check_clk);
 102 }
 103
 104 int ssusb_set_vbus(struct otg_switch_mtk *otg_sx, int is_on)
 105 {
 106         struct ssusb_mtk *ssusb = otg_sx_to_ssusb(otg_sx);
 107         struct regulator *vbus = otg_sx->vbus;
 108         int ret;
 109
 110         /* vbus is optional */
 111         if (!vbus)
 112                 return 0;
 113
 114         dev_dbg(ssusb->dev, "%s: turn %s\n", __func__, is_on ? "on" : "off");
 115
 116         if (is_on) {
 117                 ret = regulator_enable(vbus);
 118                 if (ret) {
 119                         dev_err(ssusb->dev, "vbus regulator enable failed\n");
 120                         return ret;
 121                 }
 122         } else {
 123                 regulator_disable(vbus);
 124         }
 125
 126         return 0;
 127 }
 128
 129 static void ssusb_mode_sw_work(struct work_struct *work)
 130 {
 131         struct otg_switch_mtk *otg_sx =
 132                 container_of(work, struct otg_switch_mtk, dr_work);
 133         struct ssusb_mtk *ssusb = otg_sx_to_ssusb(otg_sx);
 134         struct mtu3 *mtu = ssusb->u3d;
 135         enum usb_role desired_role = otg_sx->desired_role;
 136         enum usb_role current_role;
 137
 138         current_role = ssusb->is_host ? USB_ROLE_HOST : USB_ROLE_DEVICE;
 139
 140         if (desired_role == USB_ROLE_NONE)
 141                 desired_role = USB_ROLE_HOST;
 142
 143         if (current_role == desired_role)
 144                 return;
 145
 146         dev_dbg(ssusb->dev, "set role : %s\n", usb_role_string(desired_role));
 147         mtu3_dbg_trace(ssusb->dev, "set role : %s", usb_role_string(desired_role));
 148
 149         switch (desired_role) {
 150         case USB_ROLE_HOST:
 151                 mtu3_stop(mtu);
 152                 switch_port_to_host(ssusb);
 153                 ssusb_set_vbus(otg_sx, 1);
 154                 ssusb->is_host = true;
 155                 break;
 156         case USB_ROLE_DEVICE:
 157                 ssusb->is_host = false;
 158                 ssusb_set_vbus(otg_sx, 0);
 159                 switch_port_to_device(ssusb);
 160                 mtu3_start(mtu);
 161                 break;
 162         case USB_ROLE_NONE:
 163         default:
 164                 dev_err(ssusb->dev, "invalid role\n");
 165         }
 166 }
 167
 168 static void ssusb_set_mode(struct otg_switch_mtk *otg_sx, enum usb_role role)
 169 {
 170         struct ssusb_mtk *ssusb = otg_sx_to_ssusb(otg_sx);
 171
 172         if (ssusb->dr_mode != USB_DR_MODE_OTG)
 173                 return;
 174
 175         otg_sx->desired_role = role;
 176         queue_work(system_freezable_wq, &otg_sx->dr_work);
 177 }
 178
 179 static int ssusb_id_notifier(struct notifier_block *nb,
 180         unsigned long event, void *ptr)
 181 {
 182         struct otg_switch_mtk *otg_sx =
 183                 container_of(nb, struct otg_switch_mtk, id_nb);
 184
 185         ssusb_set_mode(otg_sx, event ? USB_ROLE_HOST : USB_ROLE_DEVICE);
 186
 187         return NOTIFY_DONE;
 188 }
 189
 190 static int ssusb_extcon_register(struct otg_switch_mtk *otg_sx)
 191 {
 192         struct ssusb_mtk *ssusb = otg_sx_to_ssusb(otg_sx);
 193         struct extcon_dev *edev = otg_sx->edev;
 194         int ret;
 195
 196         /* extcon is optional */
 197         if (!edev)
 198                 return 0;
 199
 200         otg_sx->id_nb.notifier_call = ssusb_id_notifier;
 201         ret = devm_extcon_register_notifier(ssusb->dev, edev, EXTCON_USB_HOST,
 202                                         &otg_sx->id_nb);
 203         if (ret < 0) {
 204                 dev_err(ssusb->dev, "failed to register notifier for USB-HOST\n");
 205                 return ret;
 206         }
 207
 208         ret = extcon_get_state(edev, EXTCON_USB_HOST);
 209         dev_dbg(ssusb->dev, "EXTCON_USB_HOST: %d\n", ret);
 210
 211         /* default as host, switch to device mode if needed */
 212         if (!ret)
 213                 ssusb_set_mode(otg_sx, USB_ROLE_DEVICE);
 214
 215         return 0;
 216 }
 217
 218 /*
 219  * We provide an interface via debugfs to switch between host and device modes
 220  * depending on user input.
 221  * This is useful in special cases, such as uses TYPE-A receptacle but also
 222  * wants to support dual-role mode.
 223  */
 224 void ssusb_mode_switch(struct ssusb_mtk *ssusb, int to_host)
 225 {
 226         struct otg_switch_mtk *otg_sx = &ssusb->otg_switch;
 227
 228         if (to_host) {
 229                 ssusb_set_force_mode(ssusb, MTU3_DR_FORCE_HOST);
 230                 ssusb_set_mode(otg_sx, USB_ROLE_HOST);
 231         } else {
 232                 ssusb_set_force_mode(ssusb, MTU3_DR_FORCE_DEVICE);
 233                 ssusb_set_mode(otg_sx, USB_ROLE_DEVICE);
 234         }
 235 }
 236
 237 void ssusb_set_force_mode(struct ssusb_mtk *ssusb,
 238                           enum mtu3_dr_force_mode mode)
 239 {
 240         u32 value;
 241
 242         value = mtu3_readl(ssusb->ippc_base, SSUSB_U2_CTRL(0));
 243         switch (mode) {
 244         case MTU3_DR_FORCE_DEVICE:
 245                 value |= SSUSB_U2_PORT_FORCE_IDDIG | SSUSB_U2_PORT_RG_IDDIG;
 246                 break;
 247         case MTU3_DR_FORCE_HOST:
 248                 value |= SSUSB_U2_PORT_FORCE_IDDIG;
 249                 value &= ~SSUSB_U2_PORT_RG_IDDIG;
 250                 break;
 251         case MTU3_DR_FORCE_NONE:
 252                 value &= ~(SSUSB_U2_PORT_FORCE_IDDIG | SSUSB_U2_PORT_RG_IDDIG);
 253                 break;
 254         default:
 255                 return;
 256         }
 257         mtu3_writel(ssusb->ippc_base, SSUSB_U2_CTRL(0), value);
 258 }
 259
 260 static int ssusb_role_sw_set(struct usb_role_switch *sw, enum usb_role role)
 261 {
 262         struct ssusb_mtk *ssusb = usb_role_switch_get_drvdata(sw);
 263         bool to_host = false;
 264
 265         if (role == USB_ROLE_HOST)
 266                 to_host = true;
 267
 268         if (to_host ^ ssusb->is_host)
 269                 ssusb_mode_switch(ssusb, to_host);
 270
 271         return 0;
 272 }
 273
 274 static enum usb_role ssusb_role_sw_get(struct usb_role_switch *sw)
 275 {
 276         struct ssusb_mtk *ssusb = usb_role_switch_get_drvdata(sw);
 277         enum usb_role role;
 278
 279         role = ssusb->is_host ? USB_ROLE_HOST : USB_ROLE_DEVICE;
 280
 281         return role;
 282 }
 283
 284 static int ssusb_role_sw_register(struct otg_switch_mtk *otg_sx)
 285 {
 286         struct usb_role_switch_desc role_sx_desc = { 0 };
 287         struct ssusb_mtk *ssusb = otg_sx_to_ssusb(otg_sx);
 288
 289         if (!otg_sx->role_sw_used)
 290                 return 0;
 291
 292         role_sx_desc.set = ssusb_role_sw_set;
 293         role_sx_desc.get = ssusb_role_sw_get;
 294         role_sx_desc.fwnode = dev_fwnode(ssusb->dev);
 295         role_sx_desc.driver_data = ssusb;
 296         otg_sx->role_sw = usb_role_switch_register(ssusb->dev, &role_sx_desc);
 297
 298         return PTR_ERR_OR_ZERO(otg_sx->role_sw);
 299 }
 300
 301 int ssusb_otg_switch_init(struct ssusb_mtk *ssusb)
 302 {
 303         struct otg_switch_mtk *otg_sx = &ssusb->otg_switch;
 304         int ret = 0;
 305
 306         INIT_WORK(&otg_sx->dr_work, ssusb_mode_sw_work);
 307
 308         if (otg_sx->manual_drd_enabled)
 309                 ssusb_dr_debugfs_init(ssusb);
 310         else if (otg_sx->role_sw_used)
 311                 ret = ssusb_role_sw_register(otg_sx);
 312         else
 313                 ret = ssusb_extcon_register(otg_sx);
 314
 315         return ret;
 316 }
 317
 318 void ssusb_otg_switch_exit(struct ssusb_mtk *ssusb)
 319 {
 320         struct otg_switch_mtk *otg_sx = &ssusb->otg_switch;
 321
 322         cancel_work_sync(&otg_sx->dr_work);
 323         usb_role_switch_unregister(otg_sx->role_sw);
 324 }