1 // SPDX-License-Identifier: GPL-2.0
3 * Motorola Mapphone MDM6600 modem GPIO controlled USB PHY driver
4 * Copyright (C) 2018 Tony Lindgren <tony@atomide.com>
7 #include <linux/delay.h>
10 #include <linux/interrupt.h>
11 #include <linux/module.h>
13 #include <linux/platform_device.h>
14 #include <linux/slab.h>
16 #include <linux/gpio/consumer.h>
17 #include <linux/of_platform.h>
18 #include <linux/phy/phy.h>
19 #include <linux/pinctrl/consumer.h>
21 #define PHY_MDM6600_PHY_DELAY_MS 4000 /* PHY enable 2.2s to 3.5s */
22 #define PHY_MDM6600_ENABLED_DELAY_MS 8000 /* 8s more total for MDM6600 */
23 #define MDM6600_MODEM_IDLE_DELAY_MS 1000 /* modem after USB suspend */
24 #define MDM6600_MODEM_WAKE_DELAY_MS 200 /* modem response after idle */
26 enum phy_mdm6600_ctrl_lines
{
27 PHY_MDM6600_ENABLE
, /* USB PHY enable */
28 PHY_MDM6600_POWER
, /* Device power */
29 PHY_MDM6600_RESET
, /* Device reset */
30 PHY_MDM6600_NR_CTRL_LINES
,
33 enum phy_mdm6600_bootmode_lines
{
34 PHY_MDM6600_MODE0
, /* out USB mode0 and OOB wake */
35 PHY_MDM6600_MODE1
, /* out USB mode1, in OOB wake */
36 PHY_MDM6600_NR_MODE_LINES
,
39 enum phy_mdm6600_cmd_lines
{
43 PHY_MDM6600_NR_CMD_LINES
,
46 enum phy_mdm6600_status_lines
{
50 PHY_MDM6600_NR_STATUS_LINES
,
54 * MDM6600 command codes. These are based on Motorola Mapphone Linux
57 enum phy_mdm6600_cmd
{
58 PHY_MDM6600_CMD_BP_PANIC_ACK
,
59 PHY_MDM6600_CMD_DATA_ONLY_BYPASS
, /* Reroute USB to CPCAP PHY */
60 PHY_MDM6600_CMD_FULL_BYPASS
, /* Reroute USB to CPCAP PHY */
61 PHY_MDM6600_CMD_NO_BYPASS
, /* Request normal USB mode */
62 PHY_MDM6600_CMD_BP_SHUTDOWN_REQ
, /* Request device power off */
63 PHY_MDM6600_CMD_BP_UNKNOWN_5
,
64 PHY_MDM6600_CMD_BP_UNKNOWN_6
,
65 PHY_MDM6600_CMD_UNDEFINED
,
69 * MDM6600 status codes. These are based on Motorola Mapphone Linux
72 enum phy_mdm6600_status
{
73 PHY_MDM6600_STATUS_PANIC
, /* Seems to be really off */
74 PHY_MDM6600_STATUS_PANIC_BUSY_WAIT
,
75 PHY_MDM6600_STATUS_QC_DLOAD
,
76 PHY_MDM6600_STATUS_RAM_DOWNLOADER
, /* MDM6600 USB flashing mode */
77 PHY_MDM6600_STATUS_PHONE_CODE_AWAKE
, /* MDM6600 normal USB mode */
78 PHY_MDM6600_STATUS_PHONE_CODE_ASLEEP
,
79 PHY_MDM6600_STATUS_SHUTDOWN_ACK
,
80 PHY_MDM6600_STATUS_UNDEFINED
,
83 static const char * const
84 phy_mdm6600_status_name
[] = {
85 "off", "busy", "qc_dl", "ram_dl", "awake",
86 "asleep", "shutdown", "undefined",
91 struct phy
*generic_phy
;
92 struct phy_provider
*phy_provider
;
93 struct gpio_desc
*ctrl_gpios
[PHY_MDM6600_NR_CTRL_LINES
];
94 struct gpio_descs
*mode_gpios
;
95 struct gpio_descs
*status_gpios
;
96 struct gpio_descs
*cmd_gpios
;
97 struct delayed_work bootup_work
;
98 struct delayed_work status_work
;
99 struct delayed_work modem_wake_work
;
100 struct completion ack
;
101 bool enabled
; /* mdm6600 phy enabled */
102 bool running
; /* mdm6600 boot done */
103 bool awake
; /* mdm6600 respnds on n_gsm */
107 static int phy_mdm6600_init(struct phy
*x
)
109 struct phy_mdm6600
*ddata
= phy_get_drvdata(x
);
110 struct gpio_desc
*enable_gpio
= ddata
->ctrl_gpios
[PHY_MDM6600_ENABLE
];
113 return -EPROBE_DEFER
;
115 gpiod_set_value_cansleep(enable_gpio
, 0);
120 static int phy_mdm6600_power_on(struct phy
*x
)
122 struct phy_mdm6600
*ddata
= phy_get_drvdata(x
);
123 struct gpio_desc
*enable_gpio
= ddata
->ctrl_gpios
[PHY_MDM6600_ENABLE
];
129 error
= pinctrl_pm_select_default_state(ddata
->dev
);
131 dev_warn(ddata
->dev
, "%s: error with default_state: %i\n",
134 gpiod_set_value_cansleep(enable_gpio
, 1);
136 /* Allow aggressive PM for USB, it's only needed for n_gsm port */
137 if (pm_runtime_enabled(&x
->dev
))
138 phy_pm_runtime_put(x
);
143 static int phy_mdm6600_power_off(struct phy
*x
)
145 struct phy_mdm6600
*ddata
= phy_get_drvdata(x
);
146 struct gpio_desc
*enable_gpio
= ddata
->ctrl_gpios
[PHY_MDM6600_ENABLE
];
152 /* Paired with phy_pm_runtime_put() in phy_mdm6600_power_on() */
153 if (pm_runtime_enabled(&x
->dev
)) {
154 error
= phy_pm_runtime_get(x
);
155 if (error
< 0 && error
!= -EINPROGRESS
)
156 dev_warn(ddata
->dev
, "%s: phy_pm_runtime_get: %i\n",
160 gpiod_set_value_cansleep(enable_gpio
, 0);
162 error
= pinctrl_pm_select_sleep_state(ddata
->dev
);
164 dev_warn(ddata
->dev
, "%s: error with sleep_state: %i\n",
170 static const struct phy_ops gpio_usb_ops
= {
171 .init
= phy_mdm6600_init
,
172 .power_on
= phy_mdm6600_power_on
,
173 .power_off
= phy_mdm6600_power_off
,
174 .owner
= THIS_MODULE
,
178 * phy_mdm6600_cmd() - send a command request to mdm6600
179 * @ddata: device driver data
181 * Configures the three command request GPIOs to the specified value.
183 static void phy_mdm6600_cmd(struct phy_mdm6600
*ddata
, int val
)
185 DECLARE_BITMAP(values
, PHY_MDM6600_NR_CMD_LINES
);
189 gpiod_set_array_value_cansleep(PHY_MDM6600_NR_CMD_LINES
,
190 ddata
->cmd_gpios
->desc
,
191 ddata
->cmd_gpios
->info
, values
);
195 * phy_mdm6600_status() - read mdm6600 status lines
196 * @ddata: device driver data
198 static void phy_mdm6600_status(struct work_struct
*work
)
200 struct phy_mdm6600
*ddata
;
202 DECLARE_BITMAP(values
, PHY_MDM6600_NR_STATUS_LINES
);
205 ddata
= container_of(work
, struct phy_mdm6600
, status_work
.work
);
208 error
= gpiod_get_array_value_cansleep(PHY_MDM6600_NR_STATUS_LINES
,
209 ddata
->status_gpios
->desc
,
210 ddata
->status_gpios
->info
,
215 ddata
->status
= values
[0] & ((1 << PHY_MDM6600_NR_STATUS_LINES
) - 1);
217 dev_info(dev
, "modem status: %i %s\n",
219 phy_mdm6600_status_name
[ddata
->status
]);
220 complete(&ddata
->ack
);
223 static irqreturn_t
phy_mdm6600_irq_thread(int irq
, void *data
)
225 struct phy_mdm6600
*ddata
= data
;
227 schedule_delayed_work(&ddata
->status_work
, msecs_to_jiffies(10));
233 * phy_mdm6600_wakeirq_thread - handle mode1 line OOB wake after booting
235 * @data: interrupt handler data
237 * GPIO mode1 is used initially as output to configure the USB boot
238 * mode for mdm6600. After booting it is used as input for OOB wake
239 * signal from mdm6600 to the SoC. Just use it for debug info only
242 static irqreturn_t
phy_mdm6600_wakeirq_thread(int irq
, void *data
)
244 struct phy_mdm6600
*ddata
= data
;
245 struct gpio_desc
*mode_gpio1
;
247 mode_gpio1
= ddata
->mode_gpios
->desc
[PHY_MDM6600_MODE1
];
248 dev_dbg(ddata
->dev
, "OOB wake on mode_gpio1: %i\n",
249 gpiod_get_value(mode_gpio1
));
255 * phy_mdm6600_init_irq() - initialize mdm6600 status IRQ lines
256 * @ddata: device driver data
258 static void phy_mdm6600_init_irq(struct phy_mdm6600
*ddata
)
260 struct device
*dev
= ddata
->dev
;
263 for (i
= PHY_MDM6600_STATUS0
;
264 i
<= PHY_MDM6600_STATUS2
; i
++) {
265 struct gpio_desc
*gpio
= ddata
->status_gpios
->desc
[i
];
267 irq
= gpiod_to_irq(gpio
);
271 error
= devm_request_threaded_irq(dev
, irq
, NULL
,
272 phy_mdm6600_irq_thread
,
273 IRQF_TRIGGER_RISING
|
274 IRQF_TRIGGER_FALLING
|
279 dev_warn(dev
, "no modem status irq%i: %i\n",
284 struct phy_mdm6600_map
{
289 static const struct phy_mdm6600_map
290 phy_mdm6600_ctrl_gpio_map
[PHY_MDM6600_NR_CTRL_LINES
] = {
291 { "enable", GPIOD_OUT_LOW
, }, /* low = phy disabled */
292 { "power", GPIOD_OUT_LOW
, }, /* low = off */
293 { "reset", GPIOD_OUT_HIGH
, }, /* high = reset */
297 * phy_mdm6600_init_lines() - initialize mdm6600 GPIO lines
298 * @ddata: device driver data
300 static int phy_mdm6600_init_lines(struct phy_mdm6600
*ddata
)
302 struct device
*dev
= ddata
->dev
;
305 /* MDM6600 control lines */
306 for (i
= 0; i
< ARRAY_SIZE(phy_mdm6600_ctrl_gpio_map
); i
++) {
307 const struct phy_mdm6600_map
*map
=
308 &phy_mdm6600_ctrl_gpio_map
[i
];
309 struct gpio_desc
**gpio
= &ddata
->ctrl_gpios
[i
];
311 *gpio
= devm_gpiod_get(dev
, map
->name
, map
->direction
);
313 dev_info(dev
, "gpio %s error %li\n",
314 map
->name
, PTR_ERR(*gpio
));
315 return PTR_ERR(*gpio
);
319 /* MDM6600 USB start-up mode output lines */
320 ddata
->mode_gpios
= devm_gpiod_get_array(dev
, "motorola,mode",
322 if (IS_ERR(ddata
->mode_gpios
))
323 return PTR_ERR(ddata
->mode_gpios
);
325 if (ddata
->mode_gpios
->ndescs
!= PHY_MDM6600_NR_MODE_LINES
)
328 /* MDM6600 status input lines */
329 ddata
->status_gpios
= devm_gpiod_get_array(dev
, "motorola,status",
331 if (IS_ERR(ddata
->status_gpios
))
332 return PTR_ERR(ddata
->status_gpios
);
334 if (ddata
->status_gpios
->ndescs
!= PHY_MDM6600_NR_STATUS_LINES
)
337 /* MDM6600 cmd output lines */
338 ddata
->cmd_gpios
= devm_gpiod_get_array(dev
, "motorola,cmd",
340 if (IS_ERR(ddata
->cmd_gpios
))
341 return PTR_ERR(ddata
->cmd_gpios
);
343 if (ddata
->cmd_gpios
->ndescs
!= PHY_MDM6600_NR_CMD_LINES
)
350 * phy_mdm6600_device_power_on() - power on mdm6600 device
351 * @ddata: device driver data
353 * To get the integrated USB phy in MDM6600 takes some hoops. We must ensure
354 * the shared USB bootmode GPIOs are configured, then request modem start-up,
355 * reset and power-up.. And then we need to recycle the shared USB bootmode
356 * GPIOs as they are also used for Out of Band (OOB) wake for the USB and
357 * TS 27.010 serial mux.
359 static int phy_mdm6600_device_power_on(struct phy_mdm6600
*ddata
)
361 struct gpio_desc
*mode_gpio0
, *mode_gpio1
, *reset_gpio
, *power_gpio
;
362 int error
= 0, wakeirq
;
364 mode_gpio0
= ddata
->mode_gpios
->desc
[PHY_MDM6600_MODE0
];
365 mode_gpio1
= ddata
->mode_gpios
->desc
[PHY_MDM6600_MODE1
];
366 reset_gpio
= ddata
->ctrl_gpios
[PHY_MDM6600_RESET
];
367 power_gpio
= ddata
->ctrl_gpios
[PHY_MDM6600_POWER
];
370 * Shared GPIOs must be low for normal USB mode. After booting
371 * they are used for OOB wake signaling. These can be also used
372 * to configure USB flashing mode later on based on a module
375 gpiod_set_value_cansleep(mode_gpio0
, 0);
376 gpiod_set_value_cansleep(mode_gpio1
, 0);
378 /* Request start-up mode */
379 phy_mdm6600_cmd(ddata
, PHY_MDM6600_CMD_NO_BYPASS
);
381 /* Request a reset first */
382 gpiod_set_value_cansleep(reset_gpio
, 0);
385 /* Toggle power GPIO to request mdm6600 to start */
386 gpiod_set_value_cansleep(power_gpio
, 1);
388 gpiod_set_value_cansleep(power_gpio
, 0);
391 * Looks like the USB PHY needs between 2.2 to 4 seconds.
392 * If we try to use it before that, we will get L3 errors
393 * from omap-usb-host trying to access the PHY. See also
394 * phy_mdm6600_init() for -EPROBE_DEFER.
396 msleep(PHY_MDM6600_PHY_DELAY_MS
);
397 ddata
->enabled
= true;
399 /* Booting up the rest of MDM6600 will take total about 8 seconds */
400 dev_info(ddata
->dev
, "Waiting for power up request to complete..\n");
401 if (wait_for_completion_timeout(&ddata
->ack
,
402 msecs_to_jiffies(PHY_MDM6600_ENABLED_DELAY_MS
))) {
403 if (ddata
->status
> PHY_MDM6600_STATUS_PANIC
&&
404 ddata
->status
< PHY_MDM6600_STATUS_SHUTDOWN_ACK
)
405 dev_info(ddata
->dev
, "Powered up OK\n");
407 ddata
->enabled
= false;
409 dev_err(ddata
->dev
, "Timed out powering up\n");
412 /* Reconfigure mode1 GPIO as input for OOB wake */
413 gpiod_direction_input(mode_gpio1
);
415 wakeirq
= gpiod_to_irq(mode_gpio1
);
419 error
= devm_request_threaded_irq(ddata
->dev
, wakeirq
, NULL
,
420 phy_mdm6600_wakeirq_thread
,
421 IRQF_TRIGGER_RISING
|
422 IRQF_TRIGGER_FALLING
|
427 dev_warn(ddata
->dev
, "no modem wakeirq irq%i: %i\n",
430 ddata
->running
= true;
436 * phy_mdm6600_device_power_off() - power off mdm6600 device
437 * @ddata: device driver data
439 static void phy_mdm6600_device_power_off(struct phy_mdm6600
*ddata
)
441 struct gpio_desc
*reset_gpio
=
442 ddata
->ctrl_gpios
[PHY_MDM6600_RESET
];
444 ddata
->enabled
= false;
445 phy_mdm6600_cmd(ddata
, PHY_MDM6600_CMD_BP_SHUTDOWN_REQ
);
448 gpiod_set_value_cansleep(reset_gpio
, 1);
450 dev_info(ddata
->dev
, "Waiting for power down request to complete.. ");
451 if (wait_for_completion_timeout(&ddata
->ack
,
452 msecs_to_jiffies(5000))) {
453 if (ddata
->status
== PHY_MDM6600_STATUS_PANIC
)
454 dev_info(ddata
->dev
, "Powered down OK\n");
456 dev_err(ddata
->dev
, "Timed out powering down\n");
460 static void phy_mdm6600_deferred_power_on(struct work_struct
*work
)
462 struct phy_mdm6600
*ddata
;
465 ddata
= container_of(work
, struct phy_mdm6600
, bootup_work
.work
);
467 error
= phy_mdm6600_device_power_on(ddata
);
469 dev_err(ddata
->dev
, "Device not functional\n");
473 * USB suspend puts mdm6600 into low power mode. For any n_gsm using apps,
474 * we need to keep the modem awake by kicking it's mode0 GPIO. This will
475 * keep the modem awake for about 1.2 seconds. When no n_gsm apps are using
476 * the modem, runtime PM auto mode can be enabled so modem can enter low
479 static void phy_mdm6600_wake_modem(struct phy_mdm6600
*ddata
)
481 struct gpio_desc
*mode_gpio0
;
483 mode_gpio0
= ddata
->mode_gpios
->desc
[PHY_MDM6600_MODE0
];
484 gpiod_set_value_cansleep(mode_gpio0
, 1);
486 gpiod_set_value_cansleep(mode_gpio0
, 0);
490 msleep(MDM6600_MODEM_WAKE_DELAY_MS
);
493 static void phy_mdm6600_modem_wake(struct work_struct
*work
)
495 struct phy_mdm6600
*ddata
;
497 ddata
= container_of(work
, struct phy_mdm6600
, modem_wake_work
.work
);
498 phy_mdm6600_wake_modem(ddata
);
499 schedule_delayed_work(&ddata
->modem_wake_work
,
500 msecs_to_jiffies(MDM6600_MODEM_IDLE_DELAY_MS
));
503 static int __maybe_unused
phy_mdm6600_runtime_suspend(struct device
*dev
)
505 struct phy_mdm6600
*ddata
= dev_get_drvdata(dev
);
507 cancel_delayed_work_sync(&ddata
->modem_wake_work
);
508 ddata
->awake
= false;
513 static int __maybe_unused
phy_mdm6600_runtime_resume(struct device
*dev
)
515 struct phy_mdm6600
*ddata
= dev_get_drvdata(dev
);
517 phy_mdm6600_modem_wake(&ddata
->modem_wake_work
.work
);
523 static const struct dev_pm_ops phy_mdm6600_pm_ops
= {
524 SET_RUNTIME_PM_OPS(phy_mdm6600_runtime_suspend
,
525 phy_mdm6600_runtime_resume
, NULL
)
528 static const struct of_device_id phy_mdm6600_id_table
[] = {
529 { .compatible
= "motorola,mapphone-mdm6600", },
532 MODULE_DEVICE_TABLE(of
, phy_mdm6600_id_table
);
534 static int phy_mdm6600_probe(struct platform_device
*pdev
)
536 struct phy_mdm6600
*ddata
;
539 ddata
= devm_kzalloc(&pdev
->dev
, sizeof(*ddata
), GFP_KERNEL
);
543 INIT_DELAYED_WORK(&ddata
->bootup_work
,
544 phy_mdm6600_deferred_power_on
);
545 INIT_DELAYED_WORK(&ddata
->status_work
, phy_mdm6600_status
);
546 INIT_DELAYED_WORK(&ddata
->modem_wake_work
, phy_mdm6600_modem_wake
);
547 init_completion(&ddata
->ack
);
549 ddata
->dev
= &pdev
->dev
;
550 platform_set_drvdata(pdev
, ddata
);
552 /* Active state selected in phy_mdm6600_power_on() */
553 error
= pinctrl_pm_select_sleep_state(ddata
->dev
);
555 dev_warn(ddata
->dev
, "%s: error with sleep_state: %i\n",
558 error
= phy_mdm6600_init_lines(ddata
);
562 phy_mdm6600_init_irq(ddata
);
563 schedule_delayed_work(&ddata
->bootup_work
, 0);
566 * See phy_mdm6600_device_power_on(). We should be able
567 * to remove this eventually when ohci-platform can deal
568 * with -EPROBE_DEFER.
570 msleep(PHY_MDM6600_PHY_DELAY_MS
+ 500);
573 * Enable PM runtime only after PHY has been powered up properly.
574 * It is currently only needed after USB suspends mdm6600 and n_gsm
575 * needs to access the device. We don't want to do this earlier as
576 * gpio mode0 pin doubles as mdm6600 wake-up gpio.
578 pm_runtime_use_autosuspend(ddata
->dev
);
579 pm_runtime_set_autosuspend_delay(ddata
->dev
,
580 MDM6600_MODEM_IDLE_DELAY_MS
);
581 pm_runtime_enable(ddata
->dev
);
582 error
= pm_runtime_get_sync(ddata
->dev
);
584 dev_warn(ddata
->dev
, "failed to wake modem: %i\n", error
);
585 pm_runtime_put_noidle(ddata
->dev
);
589 ddata
->generic_phy
= devm_phy_create(ddata
->dev
, NULL
, &gpio_usb_ops
);
590 if (IS_ERR(ddata
->generic_phy
)) {
591 error
= PTR_ERR(ddata
->generic_phy
);
595 phy_set_drvdata(ddata
->generic_phy
, ddata
);
597 ddata
->phy_provider
=
598 devm_of_phy_provider_register(ddata
->dev
,
599 of_phy_simple_xlate
);
600 if (IS_ERR(ddata
->phy_provider
))
601 error
= PTR_ERR(ddata
->phy_provider
);
604 pm_runtime_mark_last_busy(ddata
->dev
);
605 pm_runtime_put_autosuspend(ddata
->dev
);
609 phy_mdm6600_device_power_off(ddata
);
614 static int phy_mdm6600_remove(struct platform_device
*pdev
)
616 struct phy_mdm6600
*ddata
= platform_get_drvdata(pdev
);
617 struct gpio_desc
*reset_gpio
= ddata
->ctrl_gpios
[PHY_MDM6600_RESET
];
619 pm_runtime_dont_use_autosuspend(ddata
->dev
);
620 pm_runtime_put_sync(ddata
->dev
);
621 pm_runtime_disable(ddata
->dev
);
624 wait_for_completion_timeout(&ddata
->ack
,
625 msecs_to_jiffies(PHY_MDM6600_ENABLED_DELAY_MS
));
627 gpiod_set_value_cansleep(reset_gpio
, 1);
628 phy_mdm6600_device_power_off(ddata
);
630 cancel_delayed_work_sync(&ddata
->modem_wake_work
);
631 cancel_delayed_work_sync(&ddata
->bootup_work
);
632 cancel_delayed_work_sync(&ddata
->status_work
);
637 static struct platform_driver phy_mdm6600_driver
= {
638 .probe
= phy_mdm6600_probe
,
639 .remove
= phy_mdm6600_remove
,
641 .name
= "phy-mapphone-mdm6600",
642 .pm
= &phy_mdm6600_pm_ops
,
643 .of_match_table
= of_match_ptr(phy_mdm6600_id_table
),
647 module_platform_driver(phy_mdm6600_driver
);
649 MODULE_ALIAS("platform:gpio_usb");
650 MODULE_AUTHOR("Tony Lindgren <tony@atomide.com>");
651 MODULE_DESCRIPTION("mdm6600 gpio usb phy driver");
652 MODULE_LICENSE("GPL v2");