2 * Motorola CPCAP PMIC USB PHY driver
3 * Copyright (C) 2017 Tony Lindgren <tony@atomide.com>
5 * Some parts based on earlier Motorola Linux kernel tree code in
6 * board-mapphone-usb.c and cpcap-usb-det.c:
7 * Copyright (C) 2007 - 2011 Motorola, Inc.
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License as
11 * published by the Free Software Foundation version 2.
13 * This program is distributed "as is" WITHOUT ANY WARRANTY of any
14 * kind, whether express or implied; without even the implied warranty
15 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
19 #include <linux/atomic.h>
20 #include <linux/clk.h>
21 #include <linux/delay.h>
22 #include <linux/err.h>
24 #include <linux/module.h>
26 #include <linux/of_platform.h>
27 #include <linux/iio/consumer.h>
28 #include <linux/pinctrl/consumer.h>
29 #include <linux/platform_device.h>
30 #include <linux/regmap.h>
31 #include <linux/slab.h>
33 #include <linux/gpio/consumer.h>
34 #include <linux/mfd/motorola-cpcap.h>
35 #include <linux/phy/omap_usb.h>
36 #include <linux/phy/phy.h>
37 #include <linux/regulator/consumer.h>
38 #include <linux/usb/musb.h>
40 /* CPCAP_REG_USBC1 register bits */
41 #define CPCAP_BIT_IDPULSE BIT(15)
42 #define CPCAP_BIT_ID100KPU BIT(14)
43 #define CPCAP_BIT_IDPUCNTRL BIT(13)
44 #define CPCAP_BIT_IDPU BIT(12)
45 #define CPCAP_BIT_IDPD BIT(11)
46 #define CPCAP_BIT_VBUSCHRGTMR3 BIT(10)
47 #define CPCAP_BIT_VBUSCHRGTMR2 BIT(9)
48 #define CPCAP_BIT_VBUSCHRGTMR1 BIT(8)
49 #define CPCAP_BIT_VBUSCHRGTMR0 BIT(7)
50 #define CPCAP_BIT_VBUSPU BIT(6)
51 #define CPCAP_BIT_VBUSPD BIT(5)
52 #define CPCAP_BIT_DMPD BIT(4)
53 #define CPCAP_BIT_DPPD BIT(3)
54 #define CPCAP_BIT_DM1K5PU BIT(2)
55 #define CPCAP_BIT_DP1K5PU BIT(1)
56 #define CPCAP_BIT_DP150KPU BIT(0)
58 /* CPCAP_REG_USBC2 register bits */
59 #define CPCAP_BIT_ZHSDRV1 BIT(15)
60 #define CPCAP_BIT_ZHSDRV0 BIT(14)
61 #define CPCAP_BIT_DPLLCLKREQ BIT(13)
62 #define CPCAP_BIT_SE0CONN BIT(12)
63 #define CPCAP_BIT_UARTTXTRI BIT(11)
64 #define CPCAP_BIT_UARTSWAP BIT(10)
65 #define CPCAP_BIT_UARTMUX1 BIT(9)
66 #define CPCAP_BIT_UARTMUX0 BIT(8)
67 #define CPCAP_BIT_ULPISTPLOW BIT(7)
68 #define CPCAP_BIT_TXENPOL BIT(6)
69 #define CPCAP_BIT_USBXCVREN BIT(5)
70 #define CPCAP_BIT_USBCNTRL BIT(4)
71 #define CPCAP_BIT_USBSUSPEND BIT(3)
72 #define CPCAP_BIT_EMUMODE2 BIT(2)
73 #define CPCAP_BIT_EMUMODE1 BIT(1)
74 #define CPCAP_BIT_EMUMODE0 BIT(0)
76 /* CPCAP_REG_USBC3 register bits */
77 #define CPCAP_BIT_SPARE_898_15 BIT(15)
78 #define CPCAP_BIT_IHSTX03 BIT(14)
79 #define CPCAP_BIT_IHSTX02 BIT(13)
80 #define CPCAP_BIT_IHSTX01 BIT(12)
81 #define CPCAP_BIT_IHSTX0 BIT(11)
82 #define CPCAP_BIT_IDPU_SPI BIT(10)
83 #define CPCAP_BIT_UNUSED_898_9 BIT(9)
84 #define CPCAP_BIT_VBUSSTBY_EN BIT(8)
85 #define CPCAP_BIT_VBUSEN_SPI BIT(7)
86 #define CPCAP_BIT_VBUSPU_SPI BIT(6)
87 #define CPCAP_BIT_VBUSPD_SPI BIT(5)
88 #define CPCAP_BIT_DMPD_SPI BIT(4)
89 #define CPCAP_BIT_DPPD_SPI BIT(3)
90 #define CPCAP_BIT_SUSPEND_SPI BIT(2)
91 #define CPCAP_BIT_PU_SPI BIT(1)
92 #define CPCAP_BIT_ULPI_SPI_SEL BIT(0)
94 struct cpcap_usb_ints_state
{
115 enum cpcap_gpio_mode
{
122 struct cpcap_phy_ddata
{
127 struct delayed_work detect_work
;
128 struct pinctrl
*pins
;
129 struct pinctrl_state
*pins_ulpi
;
130 struct pinctrl_state
*pins_utmi
;
131 struct pinctrl_state
*pins_uart
;
132 struct gpio_desc
*gpio
[2];
133 struct iio_channel
*vbus
;
134 struct iio_channel
*id
;
135 struct regulator
*vusb
;
139 static bool cpcap_usb_vbus_valid(struct cpcap_phy_ddata
*ddata
)
141 int error
, value
= 0;
143 error
= iio_read_channel_processed(ddata
->vbus
, &value
);
145 return value
> 3900 ? true : false;
147 dev_err(ddata
->dev
, "error reading VBUS: %i\n", error
);
152 static int cpcap_usb_phy_set_host(struct usb_otg
*otg
, struct usb_bus
*host
)
156 otg
->state
= OTG_STATE_UNDEFINED
;
161 static int cpcap_usb_phy_set_peripheral(struct usb_otg
*otg
,
162 struct usb_gadget
*gadget
)
164 otg
->gadget
= gadget
;
166 otg
->state
= OTG_STATE_UNDEFINED
;
171 static const struct phy_ops ops
= {
172 .owner
= THIS_MODULE
,
175 static int cpcap_phy_get_ints_state(struct cpcap_phy_ddata
*ddata
,
176 struct cpcap_usb_ints_state
*s
)
180 error
= regmap_read(ddata
->reg
, CPCAP_REG_INTS1
, &val
);
184 s
->id_ground
= val
& BIT(15);
185 s
->id_float
= val
& BIT(14);
186 s
->vbusov
= val
& BIT(11);
188 error
= regmap_read(ddata
->reg
, CPCAP_REG_INTS2
, &val
);
192 s
->vbusvld
= val
& BIT(3);
193 s
->sessvld
= val
& BIT(2);
194 s
->sessend
= val
& BIT(1);
195 s
->se1
= val
& BIT(0);
197 error
= regmap_read(ddata
->reg
, CPCAP_REG_INTS4
, &val
);
201 s
->dm
= val
& BIT(1);
202 s
->dp
= val
& BIT(0);
207 static int cpcap_usb_set_uart_mode(struct cpcap_phy_ddata
*ddata
);
208 static int cpcap_usb_set_usb_mode(struct cpcap_phy_ddata
*ddata
);
210 static void cpcap_usb_detect(struct work_struct
*work
)
212 struct cpcap_phy_ddata
*ddata
;
213 struct cpcap_usb_ints_state s
;
217 ddata
= container_of(work
, struct cpcap_phy_ddata
, detect_work
.work
);
219 error
= cpcap_phy_get_ints_state(ddata
, &s
);
224 dev_dbg(ddata
->dev
, "id ground, USB host mode\n");
225 error
= cpcap_usb_set_usb_mode(ddata
);
229 error
= musb_mailbox(MUSB_ID_GROUND
);
233 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC3
,
234 CPCAP_BIT_VBUSSTBY_EN
,
235 CPCAP_BIT_VBUSSTBY_EN
);
242 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC3
,
243 CPCAP_BIT_VBUSSTBY_EN
, 0);
247 vbus
= cpcap_usb_vbus_valid(ddata
);
250 /* Are we connected to a docking station with vbus? */
252 dev_dbg(ddata
->dev
, "connected to a dock\n");
254 /* No VBUS needed with docks */
255 error
= cpcap_usb_set_usb_mode(ddata
);
258 error
= musb_mailbox(MUSB_ID_GROUND
);
265 /* Otherwise assume we're connected to a USB host */
266 dev_dbg(ddata
->dev
, "connected to USB host\n");
267 error
= cpcap_usb_set_usb_mode(ddata
);
270 error
= musb_mailbox(MUSB_VBUS_VALID
);
277 /* Default to debug UART mode */
278 error
= cpcap_usb_set_uart_mode(ddata
);
282 error
= musb_mailbox(MUSB_VBUS_OFF
);
286 dev_dbg(ddata
->dev
, "set UART mode\n");
291 dev_err(ddata
->dev
, "error setting cable state: %i\n", error
);
294 static irqreturn_t
cpcap_phy_irq_thread(int irq
, void *data
)
296 struct cpcap_phy_ddata
*ddata
= data
;
298 if (!atomic_read(&ddata
->active
))
301 schedule_delayed_work(&ddata
->detect_work
, msecs_to_jiffies(1));
306 static int cpcap_usb_init_irq(struct platform_device
*pdev
,
307 struct cpcap_phy_ddata
*ddata
,
312 irq
= platform_get_irq_byname(pdev
, name
);
316 error
= devm_request_threaded_irq(ddata
->dev
, irq
, NULL
,
317 cpcap_phy_irq_thread
,
321 dev_err(ddata
->dev
, "could not get irq %s: %i\n",
330 static const char * const cpcap_phy_irqs
[] = {
332 "id_ground", "id_float",
335 "se0conn", "vbusvld", "sessvld", "sessend", "se1",
341 static int cpcap_usb_init_interrupts(struct platform_device
*pdev
,
342 struct cpcap_phy_ddata
*ddata
)
346 for (i
= 0; i
< ARRAY_SIZE(cpcap_phy_irqs
); i
++) {
347 error
= cpcap_usb_init_irq(pdev
, ddata
, cpcap_phy_irqs
[i
]);
356 * Optional pins and modes. At least Motorola mapphone devices
357 * are using two GPIOs and dynamic pinctrl to multiplex PHY pins
358 * to UART, ULPI or UTMI mode.
361 static int cpcap_usb_gpio_set_mode(struct cpcap_phy_ddata
*ddata
,
362 enum cpcap_gpio_mode mode
)
364 if (!ddata
->gpio
[0] || !ddata
->gpio
[1])
367 gpiod_set_value(ddata
->gpio
[0], mode
& 1);
368 gpiod_set_value(ddata
->gpio
[1], mode
>> 1);
373 static int cpcap_usb_set_uart_mode(struct cpcap_phy_ddata
*ddata
)
377 error
= cpcap_usb_gpio_set_mode(ddata
, CPCAP_DM_DP
);
381 if (ddata
->pins_uart
) {
382 error
= pinctrl_select_state(ddata
->pins
, ddata
->pins_uart
);
387 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC1
,
393 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC2
,
394 0xffff, CPCAP_BIT_UARTMUX0
|
399 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC3
, 0x7fff,
407 dev_err(ddata
->dev
, "%s failed with %i\n", __func__
, error
);
412 static int cpcap_usb_set_usb_mode(struct cpcap_phy_ddata
*ddata
)
416 error
= cpcap_usb_gpio_set_mode(ddata
, CPCAP_OTG_DM_DP
);
420 if (ddata
->pins_utmi
) {
421 error
= pinctrl_select_state(ddata
->pins
, ddata
->pins_utmi
);
423 dev_err(ddata
->dev
, "could not set usb mode: %i\n",
430 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC1
,
431 CPCAP_BIT_VBUSPD
, 0);
435 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC2
,
437 CPCAP_BIT_USBXCVREN
);
441 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC3
,
445 CPCAP_BIT_SUSPEND_SPI
|
446 CPCAP_BIT_ULPI_SPI_SEL
, 0);
450 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC2
,
452 CPCAP_BIT_USBXCVREN
);
459 dev_err(ddata
->dev
, "%s failed with %i\n", __func__
, error
);
464 static int cpcap_usb_init_optional_pins(struct cpcap_phy_ddata
*ddata
)
466 ddata
->pins
= devm_pinctrl_get(ddata
->dev
);
467 if (IS_ERR(ddata
->pins
)) {
468 dev_info(ddata
->dev
, "default pins not configured: %ld\n",
469 PTR_ERR(ddata
->pins
));
475 ddata
->pins_ulpi
= pinctrl_lookup_state(ddata
->pins
, "ulpi");
476 if (IS_ERR(ddata
->pins_ulpi
)) {
477 dev_info(ddata
->dev
, "ulpi pins not configured\n");
478 ddata
->pins_ulpi
= NULL
;
481 ddata
->pins_utmi
= pinctrl_lookup_state(ddata
->pins
, "utmi");
482 if (IS_ERR(ddata
->pins_utmi
)) {
483 dev_info(ddata
->dev
, "utmi pins not configured\n");
484 ddata
->pins_utmi
= NULL
;
487 ddata
->pins_uart
= pinctrl_lookup_state(ddata
->pins
, "uart");
488 if (IS_ERR(ddata
->pins_uart
)) {
489 dev_info(ddata
->dev
, "uart pins not configured\n");
490 ddata
->pins_uart
= NULL
;
493 if (ddata
->pins_uart
)
494 return pinctrl_select_state(ddata
->pins
, ddata
->pins_uart
);
499 static void cpcap_usb_init_optional_gpios(struct cpcap_phy_ddata
*ddata
)
503 for (i
= 0; i
< 2; i
++) {
504 ddata
->gpio
[i
] = devm_gpiod_get_index(ddata
->dev
, "mode",
506 if (IS_ERR(ddata
->gpio
[i
])) {
507 dev_info(ddata
->dev
, "no mode change GPIO%i: %li\n",
508 i
, PTR_ERR(ddata
->gpio
[i
]));
509 ddata
->gpio
[i
] = NULL
;
514 static int cpcap_usb_init_iio(struct cpcap_phy_ddata
*ddata
)
516 enum iio_chan_type type
;
519 ddata
->vbus
= devm_iio_channel_get(ddata
->dev
, "vbus");
520 if (IS_ERR(ddata
->vbus
)) {
521 error
= PTR_ERR(ddata
->vbus
);
525 if (!ddata
->vbus
->indio_dev
) {
530 error
= iio_get_channel_type(ddata
->vbus
, &type
);
534 if (type
!= IIO_VOLTAGE
) {
542 dev_err(ddata
->dev
, "could not initialize VBUS or ID IIO: %i\n",
549 static const struct of_device_id cpcap_usb_phy_id_table
[] = {
551 .compatible
= "motorola,cpcap-usb-phy",
554 .compatible
= "motorola,mapphone-cpcap-usb-phy",
558 MODULE_DEVICE_TABLE(of
, cpcap_usb_phy_id_table
);
561 static int cpcap_usb_phy_probe(struct platform_device
*pdev
)
563 struct cpcap_phy_ddata
*ddata
;
564 struct phy
*generic_phy
;
565 struct phy_provider
*phy_provider
;
567 const struct of_device_id
*of_id
;
570 of_id
= of_match_device(of_match_ptr(cpcap_usb_phy_id_table
),
575 ddata
= devm_kzalloc(&pdev
->dev
, sizeof(*ddata
), GFP_KERNEL
);
579 ddata
->reg
= dev_get_regmap(pdev
->dev
.parent
, NULL
);
583 otg
= devm_kzalloc(&pdev
->dev
, sizeof(*otg
), GFP_KERNEL
);
587 ddata
->dev
= &pdev
->dev
;
588 ddata
->phy
.dev
= ddata
->dev
;
589 ddata
->phy
.label
= "cpcap_usb_phy";
590 ddata
->phy
.otg
= otg
;
591 ddata
->phy
.type
= USB_PHY_TYPE_USB2
;
592 otg
->set_host
= cpcap_usb_phy_set_host
;
593 otg
->set_peripheral
= cpcap_usb_phy_set_peripheral
;
594 otg
->usb_phy
= &ddata
->phy
;
595 INIT_DELAYED_WORK(&ddata
->detect_work
, cpcap_usb_detect
);
596 platform_set_drvdata(pdev
, ddata
);
598 ddata
->vusb
= devm_regulator_get(&pdev
->dev
, "vusb");
599 if (IS_ERR(ddata
->vusb
))
600 return PTR_ERR(ddata
->vusb
);
602 error
= regulator_enable(ddata
->vusb
);
606 generic_phy
= devm_phy_create(ddata
->dev
, NULL
, &ops
);
607 if (IS_ERR(generic_phy
)) {
608 error
= PTR_ERR(generic_phy
);
609 return PTR_ERR(generic_phy
);
612 phy_set_drvdata(generic_phy
, ddata
);
614 phy_provider
= devm_of_phy_provider_register(ddata
->dev
,
615 of_phy_simple_xlate
);
616 if (IS_ERR(phy_provider
))
617 return PTR_ERR(phy_provider
);
619 error
= cpcap_usb_init_optional_pins(ddata
);
623 cpcap_usb_init_optional_gpios(ddata
);
625 error
= cpcap_usb_init_iio(ddata
);
629 error
= cpcap_usb_init_interrupts(pdev
, ddata
);
633 usb_add_phy_dev(&ddata
->phy
);
634 atomic_set(&ddata
->active
, 1);
635 schedule_delayed_work(&ddata
->detect_work
, msecs_to_jiffies(1));
640 static int cpcap_usb_phy_remove(struct platform_device
*pdev
)
642 struct cpcap_phy_ddata
*ddata
= platform_get_drvdata(pdev
);
645 atomic_set(&ddata
->active
, 0);
646 error
= cpcap_usb_set_uart_mode(ddata
);
648 dev_err(ddata
->dev
, "could not set UART mode\n");
650 error
= musb_mailbox(MUSB_VBUS_OFF
);
652 dev_err(ddata
->dev
, "could not set mailbox\n");
654 usb_remove_phy(&ddata
->phy
);
655 cancel_delayed_work_sync(&ddata
->detect_work
);
656 clk_unprepare(ddata
->refclk
);
657 regulator_disable(ddata
->vusb
);
662 static struct platform_driver cpcap_usb_phy_driver
= {
663 .probe
= cpcap_usb_phy_probe
,
664 .remove
= cpcap_usb_phy_remove
,
666 .name
= "cpcap-usb-phy",
667 .of_match_table
= of_match_ptr(cpcap_usb_phy_id_table
),
671 module_platform_driver(cpcap_usb_phy_driver
);
673 MODULE_ALIAS("platform:cpcap_usb");
674 MODULE_AUTHOR("Tony Lindgren <tony@atomide.com>");
675 MODULE_DESCRIPTION("CPCAP usb phy driver");
676 MODULE_LICENSE("GPL v2");