1 // SPDX-License-Identifier: GPL-2.0-only
3 * Motorola CPCAP PMIC USB PHY driver
4 * Copyright (C) 2017 Tony Lindgren <tony@atomide.com>
6 * Some parts based on earlier Motorola Linux kernel tree code in
7 * board-mapphone-usb.c and cpcap-usb-det.c:
8 * Copyright (C) 2007 - 2011 Motorola, Inc.
11 #include <linux/atomic.h>
12 #include <linux/clk.h>
13 #include <linux/delay.h>
14 #include <linux/err.h>
16 #include <linux/module.h>
18 #include <linux/iio/consumer.h>
19 #include <linux/pinctrl/consumer.h>
20 #include <linux/platform_device.h>
21 #include <linux/regmap.h>
22 #include <linux/slab.h>
24 #include <linux/gpio/consumer.h>
25 #include <linux/mfd/motorola-cpcap.h>
26 #include <linux/phy/omap_usb.h>
27 #include <linux/phy/phy.h>
28 #include <linux/regulator/consumer.h>
29 #include <linux/usb/musb.h>
31 /* CPCAP_REG_USBC1 register bits */
32 #define CPCAP_BIT_IDPULSE BIT(15)
33 #define CPCAP_BIT_ID100KPU BIT(14)
34 #define CPCAP_BIT_IDPUCNTRL BIT(13)
35 #define CPCAP_BIT_IDPU BIT(12)
36 #define CPCAP_BIT_IDPD BIT(11)
37 #define CPCAP_BIT_VBUSCHRGTMR3 BIT(10)
38 #define CPCAP_BIT_VBUSCHRGTMR2 BIT(9)
39 #define CPCAP_BIT_VBUSCHRGTMR1 BIT(8)
40 #define CPCAP_BIT_VBUSCHRGTMR0 BIT(7)
41 #define CPCAP_BIT_VBUSPU BIT(6)
42 #define CPCAP_BIT_VBUSPD BIT(5)
43 #define CPCAP_BIT_DMPD BIT(4)
44 #define CPCAP_BIT_DPPD BIT(3)
45 #define CPCAP_BIT_DM1K5PU BIT(2)
46 #define CPCAP_BIT_DP1K5PU BIT(1)
47 #define CPCAP_BIT_DP150KPU BIT(0)
49 /* CPCAP_REG_USBC2 register bits */
50 #define CPCAP_BIT_ZHSDRV1 BIT(15)
51 #define CPCAP_BIT_ZHSDRV0 BIT(14)
52 #define CPCAP_BIT_DPLLCLKREQ BIT(13)
53 #define CPCAP_BIT_SE0CONN BIT(12)
54 #define CPCAP_BIT_UARTTXTRI BIT(11)
55 #define CPCAP_BIT_UARTSWAP BIT(10)
56 #define CPCAP_BIT_UARTMUX1 BIT(9)
57 #define CPCAP_BIT_UARTMUX0 BIT(8)
58 #define CPCAP_BIT_ULPISTPLOW BIT(7)
59 #define CPCAP_BIT_TXENPOL BIT(6)
60 #define CPCAP_BIT_USBXCVREN BIT(5)
61 #define CPCAP_BIT_USBCNTRL BIT(4)
62 #define CPCAP_BIT_USBSUSPEND BIT(3)
63 #define CPCAP_BIT_EMUMODE2 BIT(2)
64 #define CPCAP_BIT_EMUMODE1 BIT(1)
65 #define CPCAP_BIT_EMUMODE0 BIT(0)
67 /* CPCAP_REG_USBC3 register bits */
68 #define CPCAP_BIT_SPARE_898_15 BIT(15)
69 #define CPCAP_BIT_IHSTX03 BIT(14)
70 #define CPCAP_BIT_IHSTX02 BIT(13)
71 #define CPCAP_BIT_IHSTX01 BIT(12)
72 #define CPCAP_BIT_IHSTX0 BIT(11)
73 #define CPCAP_BIT_IDPU_SPI BIT(10)
74 #define CPCAP_BIT_UNUSED_898_9 BIT(9)
75 #define CPCAP_BIT_VBUSSTBY_EN BIT(8)
76 #define CPCAP_BIT_VBUSEN_SPI BIT(7)
77 #define CPCAP_BIT_VBUSPU_SPI BIT(6)
78 #define CPCAP_BIT_VBUSPD_SPI BIT(5)
79 #define CPCAP_BIT_DMPD_SPI BIT(4)
80 #define CPCAP_BIT_DPPD_SPI BIT(3)
81 #define CPCAP_BIT_SUSPEND_SPI BIT(2)
82 #define CPCAP_BIT_PU_SPI BIT(1)
83 #define CPCAP_BIT_ULPI_SPI_SEL BIT(0)
85 struct cpcap_usb_ints_state
{
106 enum cpcap_gpio_mode
{
109 CPCAP_UNKNOWN_DISABLED
, /* Seems to disable USB lines */
113 struct cpcap_phy_ddata
{
117 struct delayed_work detect_work
;
118 struct pinctrl
*pins
;
119 struct pinctrl_state
*pins_ulpi
;
120 struct pinctrl_state
*pins_utmi
;
121 struct pinctrl_state
*pins_uart
;
122 struct gpio_desc
*gpio
[2];
123 struct iio_channel
*vbus
;
124 struct iio_channel
*id
;
125 struct regulator
*vusb
;
127 unsigned int vbus_provider
:1;
128 unsigned int docked
:1;
131 static bool cpcap_usb_vbus_valid(struct cpcap_phy_ddata
*ddata
)
133 int error
, value
= 0;
135 error
= iio_read_channel_processed(ddata
->vbus
, &value
);
139 dev_err(ddata
->dev
, "error reading VBUS: %i\n", error
);
144 static int cpcap_usb_phy_set_host(struct usb_otg
*otg
, struct usb_bus
*host
)
148 otg
->state
= OTG_STATE_UNDEFINED
;
153 static int cpcap_usb_phy_set_peripheral(struct usb_otg
*otg
,
154 struct usb_gadget
*gadget
)
156 otg
->gadget
= gadget
;
158 otg
->state
= OTG_STATE_UNDEFINED
;
163 static const struct phy_ops ops
= {
164 .owner
= THIS_MODULE
,
167 static int cpcap_phy_get_ints_state(struct cpcap_phy_ddata
*ddata
,
168 struct cpcap_usb_ints_state
*s
)
172 error
= regmap_read(ddata
->reg
, CPCAP_REG_INTS1
, &val
);
176 s
->id_ground
= val
& BIT(15);
177 s
->id_float
= val
& BIT(14);
178 s
->vbusov
= val
& BIT(11);
180 error
= regmap_read(ddata
->reg
, CPCAP_REG_INTS2
, &val
);
184 s
->vbusvld
= val
& BIT(3);
185 s
->sessvld
= val
& BIT(2);
186 s
->sessend
= val
& BIT(1);
187 s
->se1
= val
& BIT(0);
189 error
= regmap_read(ddata
->reg
, CPCAP_REG_INTS4
, &val
);
193 s
->dm
= val
& BIT(1);
194 s
->dp
= val
& BIT(0);
199 static int cpcap_usb_set_uart_mode(struct cpcap_phy_ddata
*ddata
);
200 static int cpcap_usb_set_usb_mode(struct cpcap_phy_ddata
*ddata
);
202 static void cpcap_usb_try_musb_mailbox(struct cpcap_phy_ddata
*ddata
,
203 enum musb_vbus_id_status status
)
207 error
= musb_mailbox(status
);
211 dev_dbg(ddata
->dev
, "%s: musb_mailbox failed: %i\n",
215 static void cpcap_usb_detect(struct work_struct
*work
)
217 struct cpcap_phy_ddata
*ddata
;
218 struct cpcap_usb_ints_state s
;
222 ddata
= container_of(work
, struct cpcap_phy_ddata
, detect_work
.work
);
224 error
= cpcap_phy_get_ints_state(ddata
, &s
);
228 vbus
= cpcap_usb_vbus_valid(ddata
);
230 /* We need to kick the VBUS as USB A-host */
231 if (s
.id_ground
&& ddata
->vbus_provider
) {
232 dev_dbg(ddata
->dev
, "still in USB A-host mode, kicking VBUS\n");
234 cpcap_usb_try_musb_mailbox(ddata
, MUSB_ID_GROUND
);
236 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC3
,
237 CPCAP_BIT_VBUSSTBY_EN
|
238 CPCAP_BIT_VBUSEN_SPI
,
239 CPCAP_BIT_VBUSEN_SPI
);
246 if (vbus
&& s
.id_ground
&& ddata
->docked
) {
247 dev_dbg(ddata
->dev
, "still docked as A-host, signal ID down\n");
249 cpcap_usb_try_musb_mailbox(ddata
, MUSB_ID_GROUND
);
254 /* No VBUS needed with docks */
255 if (vbus
&& s
.id_ground
&& !ddata
->vbus_provider
) {
256 dev_dbg(ddata
->dev
, "connected to a dock\n");
258 ddata
->docked
= true;
260 error
= cpcap_usb_set_usb_mode(ddata
);
264 cpcap_usb_try_musb_mailbox(ddata
, MUSB_ID_GROUND
);
267 * Force check state again after musb has reoriented,
268 * otherwise devices won't enumerate after loading PHY
271 schedule_delayed_work(&ddata
->detect_work
,
272 msecs_to_jiffies(1000));
277 if (s
.id_ground
&& !ddata
->docked
) {
278 dev_dbg(ddata
->dev
, "id ground, USB host mode\n");
280 ddata
->vbus_provider
= true;
282 error
= cpcap_usb_set_usb_mode(ddata
);
286 cpcap_usb_try_musb_mailbox(ddata
, MUSB_ID_GROUND
);
288 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC3
,
289 CPCAP_BIT_VBUSSTBY_EN
|
290 CPCAP_BIT_VBUSEN_SPI
,
291 CPCAP_BIT_VBUSEN_SPI
);
298 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC3
,
299 CPCAP_BIT_VBUSSTBY_EN
|
300 CPCAP_BIT_VBUSEN_SPI
, 0);
304 vbus
= cpcap_usb_vbus_valid(ddata
);
306 /* Otherwise assume we're connected to a USB host */
308 dev_dbg(ddata
->dev
, "connected to USB host\n");
309 error
= cpcap_usb_set_usb_mode(ddata
);
312 cpcap_usb_try_musb_mailbox(ddata
, MUSB_VBUS_VALID
);
317 ddata
->vbus_provider
= false;
318 ddata
->docked
= false;
319 cpcap_usb_try_musb_mailbox(ddata
, MUSB_VBUS_OFF
);
321 /* Default to debug UART mode */
322 error
= cpcap_usb_set_uart_mode(ddata
);
326 dev_dbg(ddata
->dev
, "set UART mode\n");
331 dev_err(ddata
->dev
, "error setting cable state: %i\n", error
);
334 static irqreturn_t
cpcap_phy_irq_thread(int irq
, void *data
)
336 struct cpcap_phy_ddata
*ddata
= data
;
338 if (!atomic_read(&ddata
->active
))
341 schedule_delayed_work(&ddata
->detect_work
, msecs_to_jiffies(1));
346 static int cpcap_usb_init_irq(struct platform_device
*pdev
,
347 struct cpcap_phy_ddata
*ddata
,
352 irq
= platform_get_irq_byname(pdev
, name
);
356 error
= devm_request_threaded_irq(ddata
->dev
, irq
, NULL
,
357 cpcap_phy_irq_thread
,
362 dev_err(ddata
->dev
, "could not get irq %s: %i\n",
371 static const char * const cpcap_phy_irqs
[] = {
373 "id_ground", "id_float",
376 "se0conn", "vbusvld", "sessvld", "sessend", "se1",
382 static int cpcap_usb_init_interrupts(struct platform_device
*pdev
,
383 struct cpcap_phy_ddata
*ddata
)
387 for (i
= 0; i
< ARRAY_SIZE(cpcap_phy_irqs
); i
++) {
388 error
= cpcap_usb_init_irq(pdev
, ddata
, cpcap_phy_irqs
[i
]);
397 * Optional pins and modes. At least Motorola mapphone devices
398 * are using two GPIOs and dynamic pinctrl to multiplex PHY pins
399 * to UART, ULPI or UTMI mode.
402 static int cpcap_usb_gpio_set_mode(struct cpcap_phy_ddata
*ddata
,
403 enum cpcap_gpio_mode mode
)
405 if (!ddata
->gpio
[0] || !ddata
->gpio
[1])
408 gpiod_set_value(ddata
->gpio
[0], mode
& 1);
409 gpiod_set_value(ddata
->gpio
[1], mode
>> 1);
414 static int cpcap_usb_set_uart_mode(struct cpcap_phy_ddata
*ddata
)
418 /* Disable lines to prevent glitches from waking up mdm6600 */
419 error
= cpcap_usb_gpio_set_mode(ddata
, CPCAP_UNKNOWN_DISABLED
);
423 if (ddata
->pins_uart
) {
424 error
= pinctrl_select_state(ddata
->pins
, ddata
->pins_uart
);
429 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC1
,
435 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC2
,
436 0xffff, CPCAP_BIT_UARTMUX0
|
441 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC3
, 0x7fff,
446 /* Enable UART mode */
447 error
= cpcap_usb_gpio_set_mode(ddata
, CPCAP_DM_DP
);
454 dev_err(ddata
->dev
, "%s failed with %i\n", __func__
, error
);
459 static int cpcap_usb_set_usb_mode(struct cpcap_phy_ddata
*ddata
)
463 /* Disable lines to prevent glitches from waking up mdm6600 */
464 error
= cpcap_usb_gpio_set_mode(ddata
, CPCAP_UNKNOWN_DISABLED
);
468 if (ddata
->pins_utmi
) {
469 error
= pinctrl_select_state(ddata
->pins
, ddata
->pins_utmi
);
471 dev_err(ddata
->dev
, "could not set usb mode: %i\n",
478 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC1
,
479 CPCAP_BIT_VBUSPD
, 0);
483 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC3
,
487 CPCAP_BIT_SUSPEND_SPI
|
488 CPCAP_BIT_ULPI_SPI_SEL
, 0);
492 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC2
,
494 CPCAP_BIT_USBXCVREN
);
498 /* Enable USB mode */
499 error
= cpcap_usb_gpio_set_mode(ddata
, CPCAP_OTG_DM_DP
);
506 dev_err(ddata
->dev
, "%s failed with %i\n", __func__
, error
);
511 static int cpcap_usb_init_optional_pins(struct cpcap_phy_ddata
*ddata
)
513 ddata
->pins
= devm_pinctrl_get(ddata
->dev
);
514 if (IS_ERR(ddata
->pins
)) {
515 dev_info(ddata
->dev
, "default pins not configured: %ld\n",
516 PTR_ERR(ddata
->pins
));
522 ddata
->pins_ulpi
= pinctrl_lookup_state(ddata
->pins
, "ulpi");
523 if (IS_ERR(ddata
->pins_ulpi
)) {
524 dev_info(ddata
->dev
, "ulpi pins not configured\n");
525 ddata
->pins_ulpi
= NULL
;
528 ddata
->pins_utmi
= pinctrl_lookup_state(ddata
->pins
, "utmi");
529 if (IS_ERR(ddata
->pins_utmi
)) {
530 dev_info(ddata
->dev
, "utmi pins not configured\n");
531 ddata
->pins_utmi
= NULL
;
534 ddata
->pins_uart
= pinctrl_lookup_state(ddata
->pins
, "uart");
535 if (IS_ERR(ddata
->pins_uart
)) {
536 dev_info(ddata
->dev
, "uart pins not configured\n");
537 ddata
->pins_uart
= NULL
;
540 if (ddata
->pins_uart
)
541 return pinctrl_select_state(ddata
->pins
, ddata
->pins_uart
);
546 static void cpcap_usb_init_optional_gpios(struct cpcap_phy_ddata
*ddata
)
550 for (i
= 0; i
< 2; i
++) {
551 ddata
->gpio
[i
] = devm_gpiod_get_index(ddata
->dev
, "mode",
553 if (IS_ERR(ddata
->gpio
[i
])) {
554 dev_info(ddata
->dev
, "no mode change GPIO%i: %li\n",
555 i
, PTR_ERR(ddata
->gpio
[i
]));
556 ddata
->gpio
[i
] = NULL
;
561 static int cpcap_usb_init_iio(struct cpcap_phy_ddata
*ddata
)
563 enum iio_chan_type type
;
566 ddata
->vbus
= devm_iio_channel_get(ddata
->dev
, "vbus");
567 if (IS_ERR(ddata
->vbus
)) {
568 error
= PTR_ERR(ddata
->vbus
);
572 if (!ddata
->vbus
->indio_dev
) {
577 error
= iio_get_channel_type(ddata
->vbus
, &type
);
581 if (type
!= IIO_VOLTAGE
) {
589 dev_err(ddata
->dev
, "could not initialize VBUS or ID IIO: %i\n",
596 static const struct of_device_id cpcap_usb_phy_id_table
[] = {
598 .compatible
= "motorola,cpcap-usb-phy",
601 .compatible
= "motorola,mapphone-cpcap-usb-phy",
605 MODULE_DEVICE_TABLE(of
, cpcap_usb_phy_id_table
);
608 static int cpcap_usb_phy_probe(struct platform_device
*pdev
)
610 struct cpcap_phy_ddata
*ddata
;
611 struct phy
*generic_phy
;
612 struct phy_provider
*phy_provider
;
616 ddata
= devm_kzalloc(&pdev
->dev
, sizeof(*ddata
), GFP_KERNEL
);
620 ddata
->reg
= dev_get_regmap(pdev
->dev
.parent
, NULL
);
624 otg
= devm_kzalloc(&pdev
->dev
, sizeof(*otg
), GFP_KERNEL
);
628 ddata
->dev
= &pdev
->dev
;
629 ddata
->phy
.dev
= ddata
->dev
;
630 ddata
->phy
.label
= "cpcap_usb_phy";
631 ddata
->phy
.otg
= otg
;
632 ddata
->phy
.type
= USB_PHY_TYPE_USB2
;
633 otg
->set_host
= cpcap_usb_phy_set_host
;
634 otg
->set_peripheral
= cpcap_usb_phy_set_peripheral
;
635 otg
->usb_phy
= &ddata
->phy
;
636 INIT_DELAYED_WORK(&ddata
->detect_work
, cpcap_usb_detect
);
637 platform_set_drvdata(pdev
, ddata
);
639 ddata
->vusb
= devm_regulator_get(&pdev
->dev
, "vusb");
640 if (IS_ERR(ddata
->vusb
))
641 return PTR_ERR(ddata
->vusb
);
643 error
= regulator_enable(ddata
->vusb
);
647 generic_phy
= devm_phy_create(ddata
->dev
, NULL
, &ops
);
648 if (IS_ERR(generic_phy
)) {
649 error
= PTR_ERR(generic_phy
);
650 goto out_reg_disable
;
653 phy_set_drvdata(generic_phy
, ddata
);
655 phy_provider
= devm_of_phy_provider_register(ddata
->dev
,
656 of_phy_simple_xlate
);
657 if (IS_ERR(phy_provider
)) {
658 error
= PTR_ERR(phy_provider
);
659 goto out_reg_disable
;
662 error
= cpcap_usb_init_optional_pins(ddata
);
664 goto out_reg_disable
;
666 cpcap_usb_init_optional_gpios(ddata
);
668 error
= cpcap_usb_init_iio(ddata
);
670 goto out_reg_disable
;
672 error
= cpcap_usb_init_interrupts(pdev
, ddata
);
674 goto out_reg_disable
;
676 usb_add_phy_dev(&ddata
->phy
);
677 atomic_set(&ddata
->active
, 1);
678 schedule_delayed_work(&ddata
->detect_work
, msecs_to_jiffies(1));
683 regulator_disable(ddata
->vusb
);
688 static void cpcap_usb_phy_remove(struct platform_device
*pdev
)
690 struct cpcap_phy_ddata
*ddata
= platform_get_drvdata(pdev
);
693 atomic_set(&ddata
->active
, 0);
694 error
= cpcap_usb_set_uart_mode(ddata
);
696 dev_err(ddata
->dev
, "could not set UART mode\n");
698 cpcap_usb_try_musb_mailbox(ddata
, MUSB_VBUS_OFF
);
700 usb_remove_phy(&ddata
->phy
);
701 cancel_delayed_work_sync(&ddata
->detect_work
);
702 regulator_disable(ddata
->vusb
);
705 static struct platform_driver cpcap_usb_phy_driver
= {
706 .probe
= cpcap_usb_phy_probe
,
707 .remove
= cpcap_usb_phy_remove
,
709 .name
= "cpcap-usb-phy",
710 .of_match_table
= of_match_ptr(cpcap_usb_phy_id_table
),
714 module_platform_driver(cpcap_usb_phy_driver
);
716 MODULE_ALIAS("platform:cpcap_usb");
717 MODULE_AUTHOR("Tony Lindgren <tony@atomide.com>");
718 MODULE_DESCRIPTION("CPCAP usb phy driver");
719 MODULE_LICENSE("GPL v2");