2 * Copyright (C) 2017 Broadcom
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License as
6 * published by the Free Software Foundation version 2.
8 * This program is distributed "as is" WITHOUT ANY WARRANTY of any
9 * kind, whether express or implied; without even the implied warranty
10 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
14 #include <linux/delay.h>
15 #include <linux/extcon-provider.h>
16 #include <linux/gpio.h>
17 #include <linux/gpio/consumer.h>
18 #include <linux/init.h>
19 #include <linux/interrupt.h>
21 #include <linux/iopoll.h>
22 #include <linux/irq.h>
23 #include <linux/mfd/syscon.h>
24 #include <linux/module.h>
26 #include <linux/of_address.h>
27 #include <linux/phy/phy.h>
28 #include <linux/platform_device.h>
29 #include <linux/regmap.h>
30 #include <linux/slab.h>
31 #include <linux/workqueue.h>
33 #define ICFG_DRD_AFE 0x0
34 #define ICFG_MISC_STAT 0x18
35 #define ICFG_DRD_P0CTL 0x1C
36 #define ICFG_STRAP_CTRL 0x20
37 #define ICFG_FSM_CTRL 0x24
39 #define ICFG_DEV_BIT BIT(2)
40 #define IDM_RST_BIT BIT(0)
41 #define AFE_CORERDY_VDDC BIT(18)
42 #define PHY_PLL_RESETB BIT(15)
43 #define PHY_RESETB BIT(14)
44 #define PHY_PLL_LOCK BIT(0)
46 #define DRD_DEV_MODE BIT(20)
47 #define OHCI_OVRCUR_POL BIT(11)
48 #define ICFG_OFF_MODE BIT(6)
49 #define PLL_LOCK_RETRY 1000
54 #define DRD_HOST_MODE (BIT(2) | BIT(3))
55 #define DRD_DEVICE_MODE (BIT(4) | BIT(5))
56 #define DRD_HOST_VAL 0x803
57 #define DRD_DEV_VAL 0x807
61 struct ns2_phy_driver {
62 void __iomem *icfgdrd_regs;
63 void __iomem *idmdrd_rst_ctrl;
64 void __iomem *crmu_usb2_ctrl;
65 void __iomem *usb2h_strap_reg;
66 struct ns2_phy_data *data;
67 struct extcon_dev *edev;
68 struct gpio_desc *vbus_gpiod;
69 struct gpio_desc *id_gpiod;
72 unsigned long debounce_jiffies;
73 struct delayed_work wq_extcon;
77 struct ns2_phy_driver *driver;
82 static const unsigned int usb_extcon_cable[] = {
88 static inline int pll_lock_stat(u32 usb_reg, int reg_mask,
89 struct ns2_phy_driver *driver)
93 return readl_poll_timeout_atomic(driver->icfgdrd_regs + usb_reg,
94 val, (val & reg_mask), 1,
98 static int ns2_drd_phy_init(struct phy *phy)
100 struct ns2_phy_data *data = phy_get_drvdata(phy);
101 struct ns2_phy_driver *driver = data->driver;
104 val = readl(driver->icfgdrd_regs + ICFG_FSM_CTRL);
106 if (data->new_state == EVT_HOST) {
107 val &= ~DRD_DEVICE_MODE;
108 val |= DRD_HOST_MODE;
110 val &= ~DRD_HOST_MODE;
111 val |= DRD_DEVICE_MODE;
113 writel(val, driver->icfgdrd_regs + ICFG_FSM_CTRL);
118 static int ns2_drd_phy_poweroff(struct phy *phy)
120 struct ns2_phy_data *data = phy_get_drvdata(phy);
121 struct ns2_phy_driver *driver = data->driver;
124 val = readl(driver->crmu_usb2_ctrl);
125 val &= ~AFE_CORERDY_VDDC;
126 writel(val, driver->crmu_usb2_ctrl);
128 val = readl(driver->crmu_usb2_ctrl);
129 val &= ~DRD_DEV_MODE;
130 writel(val, driver->crmu_usb2_ctrl);
132 /* Disable Host and Device Mode */
133 val = readl(driver->icfgdrd_regs + ICFG_FSM_CTRL);
134 val &= ~(DRD_HOST_MODE | DRD_DEVICE_MODE | ICFG_OFF_MODE);
135 writel(val, driver->icfgdrd_regs + ICFG_FSM_CTRL);
140 static int ns2_drd_phy_poweron(struct phy *phy)
142 struct ns2_phy_data *data = phy_get_drvdata(phy);
143 struct ns2_phy_driver *driver = data->driver;
144 u32 extcon_event = data->new_state;
148 if (extcon_event == EVT_DEVICE) {
149 writel(DRD_DEV_VAL, driver->icfgdrd_regs + ICFG_DRD_P0CTL);
151 val = readl(driver->idmdrd_rst_ctrl);
153 writel(val, driver->idmdrd_rst_ctrl);
155 val = readl(driver->crmu_usb2_ctrl);
156 val |= (AFE_CORERDY_VDDC | DRD_DEV_MODE);
157 writel(val, driver->crmu_usb2_ctrl);
159 /* Bring PHY and PHY_PLL out of Reset */
160 val = readl(driver->crmu_usb2_ctrl);
161 val |= (PHY_PLL_RESETB | PHY_RESETB);
162 writel(val, driver->crmu_usb2_ctrl);
164 ret = pll_lock_stat(ICFG_MISC_STAT, PHY_PLL_LOCK, driver);
166 dev_err(&phy->dev, "Phy PLL lock failed\n");
170 writel(DRD_HOST_VAL, driver->icfgdrd_regs + ICFG_DRD_P0CTL);
172 val = readl(driver->crmu_usb2_ctrl);
173 val |= AFE_CORERDY_VDDC;
174 writel(val, driver->crmu_usb2_ctrl);
176 ret = pll_lock_stat(ICFG_MISC_STAT, PHY_PLL_LOCK, driver);
178 dev_err(&phy->dev, "Phy PLL lock failed\n");
182 val = readl(driver->idmdrd_rst_ctrl);
184 writel(val, driver->idmdrd_rst_ctrl);
186 /* port over current Polarity */
187 val = readl(driver->usb2h_strap_reg);
188 val |= OHCI_OVRCUR_POL;
189 writel(val, driver->usb2h_strap_reg);
195 static void connect_change(struct ns2_phy_driver *driver)
200 extcon_event = driver->data->new_state;
201 val = readl(driver->icfgdrd_regs + ICFG_FSM_CTRL);
203 switch (extcon_event) {
205 val &= ~(DRD_HOST_MODE | DRD_DEVICE_MODE);
206 writel(val, driver->icfgdrd_regs + ICFG_FSM_CTRL);
208 val = (val & ~DRD_HOST_MODE) | DRD_DEVICE_MODE;
209 writel(val, driver->icfgdrd_regs + ICFG_FSM_CTRL);
211 val = readl(driver->icfgdrd_regs + ICFG_DRD_P0CTL);
213 writel(val, driver->icfgdrd_regs + ICFG_DRD_P0CTL);
217 val &= ~(DRD_HOST_MODE | DRD_DEVICE_MODE);
218 writel(val, driver->icfgdrd_regs + ICFG_FSM_CTRL);
220 val = (val & ~DRD_DEVICE_MODE) | DRD_HOST_MODE;
221 writel(val, driver->icfgdrd_regs + ICFG_FSM_CTRL);
223 val = readl(driver->usb2h_strap_reg);
224 val |= OHCI_OVRCUR_POL;
225 writel(val, driver->usb2h_strap_reg);
227 val = readl(driver->icfgdrd_regs + ICFG_DRD_P0CTL);
228 val &= ~ICFG_DEV_BIT;
229 writel(val, driver->icfgdrd_regs + ICFG_DRD_P0CTL);
233 pr_err("Invalid extcon event\n");
238 static void extcon_work(struct work_struct *work)
240 struct ns2_phy_driver *driver;
244 driver = container_of(to_delayed_work(work),
245 struct ns2_phy_driver, wq_extcon);
247 id = gpiod_get_value_cansleep(driver->id_gpiod);
248 vbus = gpiod_get_value_cansleep(driver->vbus_gpiod);
250 if (!id && vbus) { /* Host connected */
251 extcon_set_state_sync(driver->edev, EXTCON_USB_HOST, true);
252 pr_debug("Host cable connected\n");
253 driver->data->new_state = EVT_HOST;
254 connect_change(driver);
255 } else if (id && !vbus) { /* Disconnected */
256 extcon_set_state_sync(driver->edev, EXTCON_USB_HOST, false);
257 extcon_set_state_sync(driver->edev, EXTCON_USB, false);
258 pr_debug("Cable disconnected\n");
259 } else if (id && vbus) { /* Device connected */
260 extcon_set_state_sync(driver->edev, EXTCON_USB, true);
261 pr_debug("Device cable connected\n");
262 driver->data->new_state = EVT_DEVICE;
263 connect_change(driver);
267 static irqreturn_t gpio_irq_handler(int irq, void *dev_id)
269 struct ns2_phy_driver *driver = dev_id;
271 queue_delayed_work(system_power_efficient_wq, &driver->wq_extcon,
272 driver->debounce_jiffies);
277 static const struct phy_ops ops = {
278 .init = ns2_drd_phy_init,
279 .power_on = ns2_drd_phy_poweron,
280 .power_off = ns2_drd_phy_poweroff,
281 .owner = THIS_MODULE,
284 static const struct of_device_id ns2_drd_phy_dt_ids[] = {
285 { .compatible = "brcm,ns2-drd-phy", },
288 MODULE_DEVICE_TABLE(of, ns2_drd_phy_dt_ids);
290 static int ns2_drd_phy_probe(struct platform_device *pdev)
292 struct phy_provider *phy_provider;
293 struct device *dev = &pdev->dev;
294 struct ns2_phy_driver *driver;
295 struct ns2_phy_data *data;
296 struct resource *res;
300 driver = devm_kzalloc(dev, sizeof(struct ns2_phy_driver),
305 driver->data = devm_kzalloc(dev, sizeof(struct ns2_phy_data),
310 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "icfg");
311 driver->icfgdrd_regs = devm_ioremap_resource(dev, res);
312 if (IS_ERR(driver->icfgdrd_regs))
313 return PTR_ERR(driver->icfgdrd_regs);
315 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "rst-ctrl");
316 driver->idmdrd_rst_ctrl = devm_ioremap_resource(dev, res);
317 if (IS_ERR(driver->idmdrd_rst_ctrl))
318 return PTR_ERR(driver->idmdrd_rst_ctrl);
320 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "crmu-ctrl");
321 driver->crmu_usb2_ctrl = devm_ioremap_resource(dev, res);
322 if (IS_ERR(driver->crmu_usb2_ctrl))
323 return PTR_ERR(driver->crmu_usb2_ctrl);
325 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "usb2-strap");
326 driver->usb2h_strap_reg = devm_ioremap_resource(dev, res);
327 if (IS_ERR(driver->usb2h_strap_reg))
328 return PTR_ERR(driver->usb2h_strap_reg);
331 driver->id_gpiod = devm_gpiod_get(&pdev->dev, "id", GPIOD_IN);
332 if (IS_ERR(driver->id_gpiod)) {
333 dev_err(dev, "failed to get ID GPIO\n");
334 return PTR_ERR(driver->id_gpiod);
336 driver->vbus_gpiod = devm_gpiod_get(&pdev->dev, "vbus", GPIOD_IN);
337 if (IS_ERR(driver->vbus_gpiod)) {
338 dev_err(dev, "failed to get VBUS GPIO\n");
339 return PTR_ERR(driver->vbus_gpiod);
342 driver->edev = devm_extcon_dev_allocate(dev, usb_extcon_cable);
343 if (IS_ERR(driver->edev)) {
344 dev_err(dev, "failed to allocate extcon device\n");
348 ret = devm_extcon_dev_register(dev, driver->edev);
350 dev_err(dev, "failed to register extcon device\n");
354 ret = gpiod_set_debounce(driver->id_gpiod, GPIO_DELAY * 1000);
356 driver->debounce_jiffies = msecs_to_jiffies(GPIO_DELAY);
358 INIT_DELAYED_WORK(&driver->wq_extcon, extcon_work);
360 driver->id_irq = gpiod_to_irq(driver->id_gpiod);
361 if (driver->id_irq < 0) {
362 dev_err(dev, "failed to get ID IRQ\n");
363 return driver->id_irq;
366 driver->vbus_irq = gpiod_to_irq(driver->vbus_gpiod);
367 if (driver->vbus_irq < 0) {
368 dev_err(dev, "failed to get ID IRQ\n");
369 return driver->vbus_irq;
372 ret = devm_request_irq(dev, driver->id_irq, gpio_irq_handler,
373 IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING,
376 dev_err(dev, "failed to request handler for ID IRQ\n");
380 ret = devm_request_irq(dev, driver->vbus_irq, gpio_irq_handler,
381 IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING,
384 dev_err(dev, "failed to request handler for VBUS IRQ\n");
388 dev_set_drvdata(dev, driver);
390 /* Shutdown all ports. They can be powered up as required */
391 val = readl(driver->crmu_usb2_ctrl);
392 val &= ~(AFE_CORERDY_VDDC | PHY_RESETB);
393 writel(val, driver->crmu_usb2_ctrl);
396 data->phy = devm_phy_create(dev, dev->of_node, &ops);
397 if (IS_ERR(data->phy)) {
398 dev_err(dev, "Failed to create usb drd phy\n");
399 return PTR_ERR(data->phy);
402 data->driver = driver;
403 phy_set_drvdata(data->phy, data);
405 phy_provider = devm_of_phy_provider_register(dev, of_phy_simple_xlate);
406 if (IS_ERR(phy_provider)) {
407 dev_err(dev, "Failed to register as phy provider\n");
408 return PTR_ERR(phy_provider);
411 platform_set_drvdata(pdev, driver);
413 dev_info(dev, "Registered NS2 DRD Phy device\n");
414 queue_delayed_work(system_power_efficient_wq, &driver->wq_extcon,
415 driver->debounce_jiffies);
420 static struct platform_driver ns2_drd_phy_driver = {
421 .probe = ns2_drd_phy_probe,
423 .name = "bcm-ns2-usbphy",
424 .of_match_table = of_match_ptr(ns2_drd_phy_dt_ids),
427 module_platform_driver(ns2_drd_phy_driver);
429 MODULE_ALIAS("platform:bcm-ns2-drd-phy");
430 MODULE_AUTHOR("Broadcom");
431 MODULE_DESCRIPTION("Broadcom NS2 USB2 PHY driver");
432 MODULE_LICENSE("GPL v2");