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