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
{
118 CPCAP_UNKNOWN_DISABLED
, /* Seems to disable USB lines */
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
;
137 unsigned int vbus_provider
:1;
138 unsigned int docked
:1;
141 static bool cpcap_usb_vbus_valid(struct cpcap_phy_ddata
*ddata
)
143 int error
, value
= 0;
145 error
= iio_read_channel_processed(ddata
->vbus
, &value
);
147 return value
> 3900 ? true : false;
149 dev_err(ddata
->dev
, "error reading VBUS: %i\n", error
);
154 static int cpcap_usb_phy_set_host(struct usb_otg
*otg
, struct usb_bus
*host
)
158 otg
->state
= OTG_STATE_UNDEFINED
;
163 static int cpcap_usb_phy_set_peripheral(struct usb_otg
*otg
,
164 struct usb_gadget
*gadget
)
166 otg
->gadget
= gadget
;
168 otg
->state
= OTG_STATE_UNDEFINED
;
173 static const struct phy_ops ops
= {
174 .owner
= THIS_MODULE
,
177 static int cpcap_phy_get_ints_state(struct cpcap_phy_ddata
*ddata
,
178 struct cpcap_usb_ints_state
*s
)
182 error
= regmap_read(ddata
->reg
, CPCAP_REG_INTS1
, &val
);
186 s
->id_ground
= val
& BIT(15);
187 s
->id_float
= val
& BIT(14);
188 s
->vbusov
= val
& BIT(11);
190 error
= regmap_read(ddata
->reg
, CPCAP_REG_INTS2
, &val
);
194 s
->vbusvld
= val
& BIT(3);
195 s
->sessvld
= val
& BIT(2);
196 s
->sessend
= val
& BIT(1);
197 s
->se1
= val
& BIT(0);
199 error
= regmap_read(ddata
->reg
, CPCAP_REG_INTS4
, &val
);
203 s
->dm
= val
& BIT(1);
204 s
->dp
= val
& BIT(0);
209 static int cpcap_usb_set_uart_mode(struct cpcap_phy_ddata
*ddata
);
210 static int cpcap_usb_set_usb_mode(struct cpcap_phy_ddata
*ddata
);
212 static void cpcap_usb_try_musb_mailbox(struct cpcap_phy_ddata
*ddata
,
213 enum musb_vbus_id_status status
)
217 error
= musb_mailbox(status
);
221 dev_dbg(ddata
->dev
, "%s: musb_mailbox failed: %i\n",
225 static void cpcap_usb_detect(struct work_struct
*work
)
227 struct cpcap_phy_ddata
*ddata
;
228 struct cpcap_usb_ints_state s
;
232 ddata
= container_of(work
, struct cpcap_phy_ddata
, detect_work
.work
);
234 error
= cpcap_phy_get_ints_state(ddata
, &s
);
238 vbus
= cpcap_usb_vbus_valid(ddata
);
240 /* We need to kick the VBUS as USB A-host */
241 if (s
.id_ground
&& ddata
->vbus_provider
) {
242 dev_dbg(ddata
->dev
, "still in USB A-host mode, kicking VBUS\n");
244 cpcap_usb_try_musb_mailbox(ddata
, MUSB_ID_GROUND
);
246 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC3
,
247 CPCAP_BIT_VBUSSTBY_EN
|
248 CPCAP_BIT_VBUSEN_SPI
,
249 CPCAP_BIT_VBUSEN_SPI
);
256 if (vbus
&& s
.id_ground
&& ddata
->docked
) {
257 dev_dbg(ddata
->dev
, "still docked as A-host, signal ID down\n");
259 cpcap_usb_try_musb_mailbox(ddata
, MUSB_ID_GROUND
);
264 /* No VBUS needed with docks */
265 if (vbus
&& s
.id_ground
&& !ddata
->vbus_provider
) {
266 dev_dbg(ddata
->dev
, "connected to a dock\n");
268 ddata
->docked
= true;
270 error
= cpcap_usb_set_usb_mode(ddata
);
274 cpcap_usb_try_musb_mailbox(ddata
, MUSB_ID_GROUND
);
277 * Force check state again after musb has reoriented,
278 * otherwise devices won't enumerate after loading PHY
281 schedule_delayed_work(&ddata
->detect_work
,
282 msecs_to_jiffies(1000));
287 if (s
.id_ground
&& !ddata
->docked
) {
288 dev_dbg(ddata
->dev
, "id ground, USB host mode\n");
290 ddata
->vbus_provider
= true;
292 error
= cpcap_usb_set_usb_mode(ddata
);
296 cpcap_usb_try_musb_mailbox(ddata
, MUSB_ID_GROUND
);
298 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC3
,
299 CPCAP_BIT_VBUSSTBY_EN
|
300 CPCAP_BIT_VBUSEN_SPI
,
301 CPCAP_BIT_VBUSEN_SPI
);
308 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC3
,
309 CPCAP_BIT_VBUSSTBY_EN
|
310 CPCAP_BIT_VBUSEN_SPI
, 0);
314 vbus
= cpcap_usb_vbus_valid(ddata
);
316 /* Otherwise assume we're connected to a USB host */
318 dev_dbg(ddata
->dev
, "connected to USB host\n");
319 error
= cpcap_usb_set_usb_mode(ddata
);
322 cpcap_usb_try_musb_mailbox(ddata
, MUSB_VBUS_VALID
);
327 ddata
->vbus_provider
= false;
328 ddata
->docked
= false;
329 cpcap_usb_try_musb_mailbox(ddata
, MUSB_VBUS_OFF
);
331 /* Default to debug UART mode */
332 error
= cpcap_usb_set_uart_mode(ddata
);
336 dev_dbg(ddata
->dev
, "set UART mode\n");
341 dev_err(ddata
->dev
, "error setting cable state: %i\n", error
);
344 static irqreturn_t
cpcap_phy_irq_thread(int irq
, void *data
)
346 struct cpcap_phy_ddata
*ddata
= data
;
348 if (!atomic_read(&ddata
->active
))
351 schedule_delayed_work(&ddata
->detect_work
, msecs_to_jiffies(1));
356 static int cpcap_usb_init_irq(struct platform_device
*pdev
,
357 struct cpcap_phy_ddata
*ddata
,
362 irq
= platform_get_irq_byname(pdev
, name
);
366 error
= devm_request_threaded_irq(ddata
->dev
, irq
, NULL
,
367 cpcap_phy_irq_thread
,
371 dev_err(ddata
->dev
, "could not get irq %s: %i\n",
380 static const char * const cpcap_phy_irqs
[] = {
382 "id_ground", "id_float",
385 "se0conn", "vbusvld", "sessvld", "sessend", "se1",
391 static int cpcap_usb_init_interrupts(struct platform_device
*pdev
,
392 struct cpcap_phy_ddata
*ddata
)
396 for (i
= 0; i
< ARRAY_SIZE(cpcap_phy_irqs
); i
++) {
397 error
= cpcap_usb_init_irq(pdev
, ddata
, cpcap_phy_irqs
[i
]);
406 * Optional pins and modes. At least Motorola mapphone devices
407 * are using two GPIOs and dynamic pinctrl to multiplex PHY pins
408 * to UART, ULPI or UTMI mode.
411 static int cpcap_usb_gpio_set_mode(struct cpcap_phy_ddata
*ddata
,
412 enum cpcap_gpio_mode mode
)
414 if (!ddata
->gpio
[0] || !ddata
->gpio
[1])
417 gpiod_set_value(ddata
->gpio
[0], mode
& 1);
418 gpiod_set_value(ddata
->gpio
[1], mode
>> 1);
423 static int cpcap_usb_set_uart_mode(struct cpcap_phy_ddata
*ddata
)
427 /* Disable lines to prevent glitches from waking up mdm6600 */
428 error
= cpcap_usb_gpio_set_mode(ddata
, CPCAP_UNKNOWN_DISABLED
);
432 if (ddata
->pins_uart
) {
433 error
= pinctrl_select_state(ddata
->pins
, ddata
->pins_uart
);
438 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC1
,
444 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC2
,
445 0xffff, CPCAP_BIT_UARTMUX0
|
450 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC3
, 0x7fff,
455 /* Enable UART mode */
456 error
= cpcap_usb_gpio_set_mode(ddata
, CPCAP_DM_DP
);
463 dev_err(ddata
->dev
, "%s failed with %i\n", __func__
, error
);
468 static int cpcap_usb_set_usb_mode(struct cpcap_phy_ddata
*ddata
)
472 /* Disable lines to prevent glitches from waking up mdm6600 */
473 error
= cpcap_usb_gpio_set_mode(ddata
, CPCAP_UNKNOWN_DISABLED
);
477 if (ddata
->pins_utmi
) {
478 error
= pinctrl_select_state(ddata
->pins
, ddata
->pins_utmi
);
480 dev_err(ddata
->dev
, "could not set usb mode: %i\n",
487 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC1
,
488 CPCAP_BIT_VBUSPD
, 0);
492 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC3
,
496 CPCAP_BIT_SUSPEND_SPI
|
497 CPCAP_BIT_ULPI_SPI_SEL
, 0);
501 error
= regmap_update_bits(ddata
->reg
, CPCAP_REG_USBC2
,
503 CPCAP_BIT_USBXCVREN
);
507 /* Enable USB mode */
508 error
= cpcap_usb_gpio_set_mode(ddata
, CPCAP_OTG_DM_DP
);
515 dev_err(ddata
->dev
, "%s failed with %i\n", __func__
, error
);
520 static int cpcap_usb_init_optional_pins(struct cpcap_phy_ddata
*ddata
)
522 ddata
->pins
= devm_pinctrl_get(ddata
->dev
);
523 if (IS_ERR(ddata
->pins
)) {
524 dev_info(ddata
->dev
, "default pins not configured: %ld\n",
525 PTR_ERR(ddata
->pins
));
531 ddata
->pins_ulpi
= pinctrl_lookup_state(ddata
->pins
, "ulpi");
532 if (IS_ERR(ddata
->pins_ulpi
)) {
533 dev_info(ddata
->dev
, "ulpi pins not configured\n");
534 ddata
->pins_ulpi
= NULL
;
537 ddata
->pins_utmi
= pinctrl_lookup_state(ddata
->pins
, "utmi");
538 if (IS_ERR(ddata
->pins_utmi
)) {
539 dev_info(ddata
->dev
, "utmi pins not configured\n");
540 ddata
->pins_utmi
= NULL
;
543 ddata
->pins_uart
= pinctrl_lookup_state(ddata
->pins
, "uart");
544 if (IS_ERR(ddata
->pins_uart
)) {
545 dev_info(ddata
->dev
, "uart pins not configured\n");
546 ddata
->pins_uart
= NULL
;
549 if (ddata
->pins_uart
)
550 return pinctrl_select_state(ddata
->pins
, ddata
->pins_uart
);
555 static void cpcap_usb_init_optional_gpios(struct cpcap_phy_ddata
*ddata
)
559 for (i
= 0; i
< 2; i
++) {
560 ddata
->gpio
[i
] = devm_gpiod_get_index(ddata
->dev
, "mode",
562 if (IS_ERR(ddata
->gpio
[i
])) {
563 dev_info(ddata
->dev
, "no mode change GPIO%i: %li\n",
564 i
, PTR_ERR(ddata
->gpio
[i
]));
565 ddata
->gpio
[i
] = NULL
;
570 static int cpcap_usb_init_iio(struct cpcap_phy_ddata
*ddata
)
572 enum iio_chan_type type
;
575 ddata
->vbus
= devm_iio_channel_get(ddata
->dev
, "vbus");
576 if (IS_ERR(ddata
->vbus
)) {
577 error
= PTR_ERR(ddata
->vbus
);
581 if (!ddata
->vbus
->indio_dev
) {
586 error
= iio_get_channel_type(ddata
->vbus
, &type
);
590 if (type
!= IIO_VOLTAGE
) {
598 dev_err(ddata
->dev
, "could not initialize VBUS or ID IIO: %i\n",
605 static const struct of_device_id cpcap_usb_phy_id_table
[] = {
607 .compatible
= "motorola,cpcap-usb-phy",
610 .compatible
= "motorola,mapphone-cpcap-usb-phy",
614 MODULE_DEVICE_TABLE(of
, cpcap_usb_phy_id_table
);
617 static int cpcap_usb_phy_probe(struct platform_device
*pdev
)
619 struct cpcap_phy_ddata
*ddata
;
620 struct phy
*generic_phy
;
621 struct phy_provider
*phy_provider
;
623 const struct of_device_id
*of_id
;
626 of_id
= of_match_device(of_match_ptr(cpcap_usb_phy_id_table
),
631 ddata
= devm_kzalloc(&pdev
->dev
, sizeof(*ddata
), GFP_KERNEL
);
635 ddata
->reg
= dev_get_regmap(pdev
->dev
.parent
, NULL
);
639 otg
= devm_kzalloc(&pdev
->dev
, sizeof(*otg
), GFP_KERNEL
);
643 ddata
->dev
= &pdev
->dev
;
644 ddata
->phy
.dev
= ddata
->dev
;
645 ddata
->phy
.label
= "cpcap_usb_phy";
646 ddata
->phy
.otg
= otg
;
647 ddata
->phy
.type
= USB_PHY_TYPE_USB2
;
648 otg
->set_host
= cpcap_usb_phy_set_host
;
649 otg
->set_peripheral
= cpcap_usb_phy_set_peripheral
;
650 otg
->usb_phy
= &ddata
->phy
;
651 INIT_DELAYED_WORK(&ddata
->detect_work
, cpcap_usb_detect
);
652 platform_set_drvdata(pdev
, ddata
);
654 ddata
->vusb
= devm_regulator_get(&pdev
->dev
, "vusb");
655 if (IS_ERR(ddata
->vusb
))
656 return PTR_ERR(ddata
->vusb
);
658 error
= regulator_enable(ddata
->vusb
);
662 generic_phy
= devm_phy_create(ddata
->dev
, NULL
, &ops
);
663 if (IS_ERR(generic_phy
)) {
664 error
= PTR_ERR(generic_phy
);
665 return PTR_ERR(generic_phy
);
668 phy_set_drvdata(generic_phy
, ddata
);
670 phy_provider
= devm_of_phy_provider_register(ddata
->dev
,
671 of_phy_simple_xlate
);
672 if (IS_ERR(phy_provider
))
673 return PTR_ERR(phy_provider
);
675 error
= cpcap_usb_init_optional_pins(ddata
);
679 cpcap_usb_init_optional_gpios(ddata
);
681 error
= cpcap_usb_init_iio(ddata
);
685 error
= cpcap_usb_init_interrupts(pdev
, ddata
);
689 usb_add_phy_dev(&ddata
->phy
);
690 atomic_set(&ddata
->active
, 1);
691 schedule_delayed_work(&ddata
->detect_work
, msecs_to_jiffies(1));
696 static int cpcap_usb_phy_remove(struct platform_device
*pdev
)
698 struct cpcap_phy_ddata
*ddata
= platform_get_drvdata(pdev
);
701 atomic_set(&ddata
->active
, 0);
702 error
= cpcap_usb_set_uart_mode(ddata
);
704 dev_err(ddata
->dev
, "could not set UART mode\n");
706 cpcap_usb_try_musb_mailbox(ddata
, MUSB_VBUS_OFF
);
708 usb_remove_phy(&ddata
->phy
);
709 cancel_delayed_work_sync(&ddata
->detect_work
);
710 clk_unprepare(ddata
->refclk
);
711 regulator_disable(ddata
->vusb
);
716 static struct platform_driver cpcap_usb_phy_driver
= {
717 .probe
= cpcap_usb_phy_probe
,
718 .remove
= cpcap_usb_phy_remove
,
720 .name
= "cpcap-usb-phy",
721 .of_match_table
= of_match_ptr(cpcap_usb_phy_id_table
),
725 module_platform_driver(cpcap_usb_phy_driver
);
727 MODULE_ALIAS("platform:cpcap_usb");
728 MODULE_AUTHOR("Tony Lindgren <tony@atomide.com>");
729 MODULE_DESCRIPTION("CPCAP usb phy driver");
730 MODULE_LICENSE("GPL v2");