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 PHY_MDM6600_WAKE_KICK_MS 600 /* time on after GPIO toggle */
24 #define MDM6600_MODEM_IDLE_DELAY_MS 1000 /* modem after USB suspend */
25 #define MDM6600_MODEM_WAKE_DELAY_MS 200 /* modem response after idle */
27 enum phy_mdm6600_ctrl_lines {
28 PHY_MDM6600_ENABLE, /* USB PHY enable */
29 PHY_MDM6600_POWER, /* Device power */
30 PHY_MDM6600_RESET, /* Device reset */
31 PHY_MDM6600_NR_CTRL_LINES,
34 enum phy_mdm6600_bootmode_lines {
35 PHY_MDM6600_MODE0, /* out USB mode0 and OOB wake */
36 PHY_MDM6600_MODE1, /* out USB mode1, in OOB wake */
37 PHY_MDM6600_NR_MODE_LINES,
40 enum phy_mdm6600_cmd_lines {
44 PHY_MDM6600_NR_CMD_LINES,
47 enum phy_mdm6600_status_lines {
51 PHY_MDM6600_NR_STATUS_LINES,
55 * MDM6600 command codes. These are based on Motorola Mapphone Linux
58 enum phy_mdm6600_cmd {
59 PHY_MDM6600_CMD_BP_PANIC_ACK,
60 PHY_MDM6600_CMD_DATA_ONLY_BYPASS, /* Reroute USB to CPCAP PHY */
61 PHY_MDM6600_CMD_FULL_BYPASS, /* Reroute USB to CPCAP PHY */
62 PHY_MDM6600_CMD_NO_BYPASS, /* Request normal USB mode */
63 PHY_MDM6600_CMD_BP_SHUTDOWN_REQ, /* Request device power off */
64 PHY_MDM6600_CMD_BP_UNKNOWN_5,
65 PHY_MDM6600_CMD_BP_UNKNOWN_6,
66 PHY_MDM6600_CMD_UNDEFINED,
70 * MDM6600 status codes. These are based on Motorola Mapphone Linux
73 enum phy_mdm6600_status {
74 PHY_MDM6600_STATUS_PANIC, /* Seems to be really off */
75 PHY_MDM6600_STATUS_PANIC_BUSY_WAIT,
76 PHY_MDM6600_STATUS_QC_DLOAD,
77 PHY_MDM6600_STATUS_RAM_DOWNLOADER, /* MDM6600 USB flashing mode */
78 PHY_MDM6600_STATUS_PHONE_CODE_AWAKE, /* MDM6600 normal USB mode */
79 PHY_MDM6600_STATUS_PHONE_CODE_ASLEEP,
80 PHY_MDM6600_STATUS_SHUTDOWN_ACK,
81 PHY_MDM6600_STATUS_UNDEFINED,
84 static const char * const
85 phy_mdm6600_status_name[] = {
86 "off", "busy", "qc_dl", "ram_dl", "awake",
87 "asleep", "shutdown", "undefined",
92 struct phy *generic_phy;
93 struct phy_provider *phy_provider;
94 struct gpio_desc *ctrl_gpios[PHY_MDM6600_NR_CTRL_LINES];
95 struct gpio_descs *mode_gpios;
96 struct gpio_descs *status_gpios;
97 struct gpio_descs *cmd_gpios;
98 struct delayed_work bootup_work;
99 struct delayed_work status_work;
100 struct delayed_work modem_wake_work;
101 struct completion ack;
102 bool enabled; /* mdm6600 phy enabled */
103 bool running; /* mdm6600 boot done */
104 bool awake; /* mdm6600 respnds on n_gsm */
108 static int phy_mdm6600_init(struct phy *x)
110 struct phy_mdm6600 *ddata = phy_get_drvdata(x);
111 struct gpio_desc *enable_gpio = ddata->ctrl_gpios[PHY_MDM6600_ENABLE];
114 return -EPROBE_DEFER;
116 gpiod_set_value_cansleep(enable_gpio, 0);
121 static int phy_mdm6600_power_on(struct phy *x)
123 struct phy_mdm6600 *ddata = phy_get_drvdata(x);
124 struct gpio_desc *enable_gpio = ddata->ctrl_gpios[PHY_MDM6600_ENABLE];
129 gpiod_set_value_cansleep(enable_gpio, 1);
131 /* Allow aggressive PM for USB, it's only needed for n_gsm port */
132 if (pm_runtime_enabled(&x->dev))
133 phy_pm_runtime_put(x);
138 static int phy_mdm6600_power_off(struct phy *x)
140 struct phy_mdm6600 *ddata = phy_get_drvdata(x);
141 struct gpio_desc *enable_gpio = ddata->ctrl_gpios[PHY_MDM6600_ENABLE];
147 /* Paired with phy_pm_runtime_put() in phy_mdm6600_power_on() */
148 if (pm_runtime_enabled(&x->dev)) {
149 error = phy_pm_runtime_get(x);
150 if (error < 0 && error != -EINPROGRESS)
151 dev_warn(ddata->dev, "%s: phy_pm_runtime_get: %i\n",
155 gpiod_set_value_cansleep(enable_gpio, 0);
160 static const struct phy_ops gpio_usb_ops = {
161 .init = phy_mdm6600_init,
162 .power_on = phy_mdm6600_power_on,
163 .power_off = phy_mdm6600_power_off,
164 .owner = THIS_MODULE,
168 * phy_mdm6600_cmd() - send a command request to mdm6600
169 * @ddata: device driver data
170 * @val: value of cmd to be set
172 * Configures the three command request GPIOs to the specified value.
174 static void phy_mdm6600_cmd(struct phy_mdm6600 *ddata, int val)
176 DECLARE_BITMAP(values, PHY_MDM6600_NR_CMD_LINES);
180 gpiod_set_array_value_cansleep(PHY_MDM6600_NR_CMD_LINES,
181 ddata->cmd_gpios->desc,
182 ddata->cmd_gpios->info, values);
186 * phy_mdm6600_status() - read mdm6600 status lines
187 * @work: work structure
189 static void phy_mdm6600_status(struct work_struct *work)
191 struct phy_mdm6600 *ddata;
193 DECLARE_BITMAP(values, PHY_MDM6600_NR_STATUS_LINES);
196 ddata = container_of(work, struct phy_mdm6600, status_work.work);
199 error = gpiod_get_array_value_cansleep(PHY_MDM6600_NR_STATUS_LINES,
200 ddata->status_gpios->desc,
201 ddata->status_gpios->info,
206 ddata->status = values[0] & ((1 << PHY_MDM6600_NR_STATUS_LINES) - 1);
208 dev_info(dev, "modem status: %i %s\n",
210 phy_mdm6600_status_name[ddata->status]);
211 complete(&ddata->ack);
214 static irqreturn_t phy_mdm6600_irq_thread(int irq, void *data)
216 struct phy_mdm6600 *ddata = data;
218 schedule_delayed_work(&ddata->status_work, msecs_to_jiffies(10));
224 * phy_mdm6600_wakeirq_thread - handle mode1 line OOB wake after booting
226 * @data: interrupt handler data
228 * GPIO mode1 is used initially as output to configure the USB boot
229 * mode for mdm6600. After booting it is used as input for OOB wake
230 * signal from mdm6600 to the SoC. Just use it for debug info only
233 static irqreturn_t phy_mdm6600_wakeirq_thread(int irq, void *data)
235 struct phy_mdm6600 *ddata = data;
236 struct gpio_desc *mode_gpio1;
239 mode_gpio1 = ddata->mode_gpios->desc[PHY_MDM6600_MODE1];
240 wakeup = gpiod_get_value(mode_gpio1);
244 dev_dbg(ddata->dev, "OOB wake on mode_gpio1: %i\n", wakeup);
245 error = pm_runtime_get_sync(ddata->dev);
247 pm_runtime_put_noidle(ddata->dev);
252 /* Just wake-up and kick the autosuspend timer */
253 pm_runtime_mark_last_busy(ddata->dev);
254 pm_runtime_put_autosuspend(ddata->dev);
260 * phy_mdm6600_init_irq() - initialize mdm6600 status IRQ lines
261 * @ddata: device driver data
263 static void phy_mdm6600_init_irq(struct phy_mdm6600 *ddata)
265 struct device *dev = ddata->dev;
268 for (i = PHY_MDM6600_STATUS0;
269 i <= PHY_MDM6600_STATUS2; i++) {
270 struct gpio_desc *gpio = ddata->status_gpios->desc[i];
272 irq = gpiod_to_irq(gpio);
276 error = devm_request_threaded_irq(dev, irq, NULL,
277 phy_mdm6600_irq_thread,
278 IRQF_TRIGGER_RISING |
279 IRQF_TRIGGER_FALLING |
284 dev_warn(dev, "no modem status irq%i: %i\n",
289 struct phy_mdm6600_map {
294 static const struct phy_mdm6600_map
295 phy_mdm6600_ctrl_gpio_map[PHY_MDM6600_NR_CTRL_LINES] = {
296 { "enable", GPIOD_OUT_LOW, }, /* low = phy disabled */
297 { "power", GPIOD_OUT_LOW, }, /* low = off */
298 { "reset", GPIOD_OUT_HIGH, }, /* high = reset */
302 * phy_mdm6600_init_lines() - initialize mdm6600 GPIO lines
303 * @ddata: device driver data
305 static int phy_mdm6600_init_lines(struct phy_mdm6600 *ddata)
307 struct device *dev = ddata->dev;
310 /* MDM6600 control lines */
311 for (i = 0; i < ARRAY_SIZE(phy_mdm6600_ctrl_gpio_map); i++) {
312 const struct phy_mdm6600_map *map =
313 &phy_mdm6600_ctrl_gpio_map[i];
314 struct gpio_desc **gpio = &ddata->ctrl_gpios[i];
316 *gpio = devm_gpiod_get(dev, map->name, map->direction);
318 dev_info(dev, "gpio %s error %li\n",
319 map->name, PTR_ERR(*gpio));
320 return PTR_ERR(*gpio);
324 /* MDM6600 USB start-up mode output lines */
325 ddata->mode_gpios = devm_gpiod_get_array(dev, "motorola,mode",
327 if (IS_ERR(ddata->mode_gpios))
328 return PTR_ERR(ddata->mode_gpios);
330 if (ddata->mode_gpios->ndescs != PHY_MDM6600_NR_MODE_LINES)
333 /* MDM6600 status input lines */
334 ddata->status_gpios = devm_gpiod_get_array(dev, "motorola,status",
336 if (IS_ERR(ddata->status_gpios))
337 return PTR_ERR(ddata->status_gpios);
339 if (ddata->status_gpios->ndescs != PHY_MDM6600_NR_STATUS_LINES)
342 /* MDM6600 cmd output lines */
343 ddata->cmd_gpios = devm_gpiod_get_array(dev, "motorola,cmd",
345 if (IS_ERR(ddata->cmd_gpios))
346 return PTR_ERR(ddata->cmd_gpios);
348 if (ddata->cmd_gpios->ndescs != PHY_MDM6600_NR_CMD_LINES)
355 * phy_mdm6600_device_power_on() - power on mdm6600 device
356 * @ddata: device driver data
358 * To get the integrated USB phy in MDM6600 takes some hoops. We must ensure
359 * the shared USB bootmode GPIOs are configured, then request modem start-up,
360 * reset and power-up.. And then we need to recycle the shared USB bootmode
361 * GPIOs as they are also used for Out of Band (OOB) wake for the USB and
362 * TS 27.010 serial mux.
364 static int phy_mdm6600_device_power_on(struct phy_mdm6600 *ddata)
366 struct gpio_desc *mode_gpio0, *mode_gpio1, *reset_gpio, *power_gpio;
367 int error = 0, wakeirq;
369 mode_gpio0 = ddata->mode_gpios->desc[PHY_MDM6600_MODE0];
370 mode_gpio1 = ddata->mode_gpios->desc[PHY_MDM6600_MODE1];
371 reset_gpio = ddata->ctrl_gpios[PHY_MDM6600_RESET];
372 power_gpio = ddata->ctrl_gpios[PHY_MDM6600_POWER];
375 * Shared GPIOs must be low for normal USB mode. After booting
376 * they are used for OOB wake signaling. These can be also used
377 * to configure USB flashing mode later on based on a module
380 gpiod_set_value_cansleep(mode_gpio0, 0);
381 gpiod_set_value_cansleep(mode_gpio1, 0);
383 /* Request start-up mode */
384 phy_mdm6600_cmd(ddata, PHY_MDM6600_CMD_NO_BYPASS);
386 /* Request a reset first */
387 gpiod_set_value_cansleep(reset_gpio, 0);
390 /* Toggle power GPIO to request mdm6600 to start */
391 gpiod_set_value_cansleep(power_gpio, 1);
393 gpiod_set_value_cansleep(power_gpio, 0);
396 * Looks like the USB PHY needs between 2.2 to 4 seconds.
397 * If we try to use it before that, we will get L3 errors
398 * from omap-usb-host trying to access the PHY. See also
399 * phy_mdm6600_init() for -EPROBE_DEFER.
401 msleep(PHY_MDM6600_PHY_DELAY_MS);
402 ddata->enabled = true;
404 /* Booting up the rest of MDM6600 will take total about 8 seconds */
405 dev_info(ddata->dev, "Waiting for power up request to complete..\n");
406 if (wait_for_completion_timeout(&ddata->ack,
407 msecs_to_jiffies(PHY_MDM6600_ENABLED_DELAY_MS))) {
408 if (ddata->status > PHY_MDM6600_STATUS_PANIC &&
409 ddata->status < PHY_MDM6600_STATUS_SHUTDOWN_ACK)
410 dev_info(ddata->dev, "Powered up OK\n");
412 ddata->enabled = false;
414 dev_err(ddata->dev, "Timed out powering up\n");
417 /* Reconfigure mode1 GPIO as input for OOB wake */
418 gpiod_direction_input(mode_gpio1);
420 wakeirq = gpiod_to_irq(mode_gpio1);
424 error = devm_request_threaded_irq(ddata->dev, wakeirq, NULL,
425 phy_mdm6600_wakeirq_thread,
426 IRQF_TRIGGER_RISING |
427 IRQF_TRIGGER_FALLING |
432 dev_warn(ddata->dev, "no modem wakeirq irq%i: %i\n",
435 ddata->running = true;
441 * phy_mdm6600_device_power_off() - power off mdm6600 device
442 * @ddata: device driver data
444 static void phy_mdm6600_device_power_off(struct phy_mdm6600 *ddata)
446 struct gpio_desc *reset_gpio =
447 ddata->ctrl_gpios[PHY_MDM6600_RESET];
450 ddata->enabled = false;
451 phy_mdm6600_cmd(ddata, PHY_MDM6600_CMD_BP_SHUTDOWN_REQ);
454 gpiod_set_value_cansleep(reset_gpio, 1);
456 dev_info(ddata->dev, "Waiting for power down request to complete.. ");
457 if (wait_for_completion_timeout(&ddata->ack,
458 msecs_to_jiffies(5000))) {
459 if (ddata->status == PHY_MDM6600_STATUS_PANIC)
460 dev_info(ddata->dev, "Powered down OK\n");
462 dev_err(ddata->dev, "Timed out powering down\n");
466 * Keep reset gpio high with padconf internal pull-up resistor to
467 * prevent modem from waking up during deeper SoC idle states. The
468 * gpio bank lines can have glitches if not in the always-on wkup
471 error = pinctrl_pm_select_sleep_state(ddata->dev);
473 dev_warn(ddata->dev, "%s: error with sleep_state: %i\n",
477 static void phy_mdm6600_deferred_power_on(struct work_struct *work)
479 struct phy_mdm6600 *ddata;
482 ddata = container_of(work, struct phy_mdm6600, bootup_work.work);
484 error = phy_mdm6600_device_power_on(ddata);
486 dev_err(ddata->dev, "Device not functional\n");
490 * USB suspend puts mdm6600 into low power mode. For any n_gsm using apps,
491 * we need to keep the modem awake by kicking it's mode0 GPIO. This will
492 * keep the modem awake for about 1.2 seconds. When no n_gsm apps are using
493 * the modem, runtime PM auto mode can be enabled so modem can enter low
496 static void phy_mdm6600_wake_modem(struct phy_mdm6600 *ddata)
498 struct gpio_desc *mode_gpio0;
500 mode_gpio0 = ddata->mode_gpios->desc[PHY_MDM6600_MODE0];
501 gpiod_set_value_cansleep(mode_gpio0, 1);
503 gpiod_set_value_cansleep(mode_gpio0, 0);
507 msleep(MDM6600_MODEM_WAKE_DELAY_MS);
510 static void phy_mdm6600_modem_wake(struct work_struct *work)
512 struct phy_mdm6600 *ddata;
514 ddata = container_of(work, struct phy_mdm6600, modem_wake_work.work);
515 phy_mdm6600_wake_modem(ddata);
518 * The modem does not always stay awake 1.2 seconds after toggling
519 * the wake GPIO, and sometimes it idles after about some 600 ms
520 * making writes time out.
522 schedule_delayed_work(&ddata->modem_wake_work,
523 msecs_to_jiffies(PHY_MDM6600_WAKE_KICK_MS));
526 static int __maybe_unused phy_mdm6600_runtime_suspend(struct device *dev)
528 struct phy_mdm6600 *ddata = dev_get_drvdata(dev);
530 cancel_delayed_work_sync(&ddata->modem_wake_work);
531 ddata->awake = false;
536 static int __maybe_unused phy_mdm6600_runtime_resume(struct device *dev)
538 struct phy_mdm6600 *ddata = dev_get_drvdata(dev);
540 phy_mdm6600_modem_wake(&ddata->modem_wake_work.work);
546 static const struct dev_pm_ops phy_mdm6600_pm_ops = {
547 SET_RUNTIME_PM_OPS(phy_mdm6600_runtime_suspend,
548 phy_mdm6600_runtime_resume, NULL)
551 static const struct of_device_id phy_mdm6600_id_table[] = {
552 { .compatible = "motorola,mapphone-mdm6600", },
555 MODULE_DEVICE_TABLE(of, phy_mdm6600_id_table);
557 static int phy_mdm6600_probe(struct platform_device *pdev)
559 struct phy_mdm6600 *ddata;
562 ddata = devm_kzalloc(&pdev->dev, sizeof(*ddata), GFP_KERNEL);
566 INIT_DELAYED_WORK(&ddata->bootup_work,
567 phy_mdm6600_deferred_power_on);
568 INIT_DELAYED_WORK(&ddata->status_work, phy_mdm6600_status);
569 INIT_DELAYED_WORK(&ddata->modem_wake_work, phy_mdm6600_modem_wake);
570 init_completion(&ddata->ack);
572 ddata->dev = &pdev->dev;
573 platform_set_drvdata(pdev, ddata);
575 error = phy_mdm6600_init_lines(ddata);
579 phy_mdm6600_init_irq(ddata);
580 schedule_delayed_work(&ddata->bootup_work, 0);
583 * See phy_mdm6600_device_power_on(). We should be able
584 * to remove this eventually when ohci-platform can deal
585 * with -EPROBE_DEFER.
587 msleep(PHY_MDM6600_PHY_DELAY_MS + 500);
590 * Enable PM runtime only after PHY has been powered up properly.
591 * It is currently only needed after USB suspends mdm6600 and n_gsm
592 * needs to access the device. We don't want to do this earlier as
593 * gpio mode0 pin doubles as mdm6600 wake-up gpio.
595 pm_runtime_use_autosuspend(ddata->dev);
596 pm_runtime_set_autosuspend_delay(ddata->dev,
597 MDM6600_MODEM_IDLE_DELAY_MS);
598 pm_runtime_enable(ddata->dev);
599 error = pm_runtime_get_sync(ddata->dev);
601 dev_warn(ddata->dev, "failed to wake modem: %i\n", error);
602 pm_runtime_put_noidle(ddata->dev);
606 ddata->generic_phy = devm_phy_create(ddata->dev, NULL, &gpio_usb_ops);
607 if (IS_ERR(ddata->generic_phy)) {
608 error = PTR_ERR(ddata->generic_phy);
612 phy_set_drvdata(ddata->generic_phy, ddata);
614 ddata->phy_provider =
615 devm_of_phy_provider_register(ddata->dev,
616 of_phy_simple_xlate);
617 if (IS_ERR(ddata->phy_provider))
618 error = PTR_ERR(ddata->phy_provider);
621 pm_runtime_mark_last_busy(ddata->dev);
622 pm_runtime_put_autosuspend(ddata->dev);
626 phy_mdm6600_device_power_off(ddata);
627 pm_runtime_disable(ddata->dev);
628 pm_runtime_dont_use_autosuspend(ddata->dev);
634 static int phy_mdm6600_remove(struct platform_device *pdev)
636 struct phy_mdm6600 *ddata = platform_get_drvdata(pdev);
637 struct gpio_desc *reset_gpio = ddata->ctrl_gpios[PHY_MDM6600_RESET];
639 pm_runtime_get_noresume(ddata->dev);
640 pm_runtime_dont_use_autosuspend(ddata->dev);
641 pm_runtime_put_sync(ddata->dev);
642 pm_runtime_disable(ddata->dev);
645 wait_for_completion_timeout(&ddata->ack,
646 msecs_to_jiffies(PHY_MDM6600_ENABLED_DELAY_MS));
648 gpiod_set_value_cansleep(reset_gpio, 1);
649 phy_mdm6600_device_power_off(ddata);
651 cancel_delayed_work_sync(&ddata->modem_wake_work);
652 cancel_delayed_work_sync(&ddata->bootup_work);
653 cancel_delayed_work_sync(&ddata->status_work);
658 static struct platform_driver phy_mdm6600_driver = {
659 .probe = phy_mdm6600_probe,
660 .remove = phy_mdm6600_remove,
662 .name = "phy-mapphone-mdm6600",
663 .pm = &phy_mdm6600_pm_ops,
664 .of_match_table = of_match_ptr(phy_mdm6600_id_table),
668 module_platform_driver(phy_mdm6600_driver);
670 MODULE_ALIAS("platform:gpio_usb");
671 MODULE_AUTHOR("Tony Lindgren <tony@atomide.com>");
672 MODULE_DESCRIPTION("mdm6600 gpio usb phy driver");
673 MODULE_LICENSE("GPL v2");