1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Motorola Mapphone MDM6600 modem GPIO controlled USB PHY driver
4*4882a593Smuzhiyun * Copyright (C) 2018 Tony Lindgren <tony@atomide.com>
5*4882a593Smuzhiyun */
6*4882a593Smuzhiyun
7*4882a593Smuzhiyun #include <linux/delay.h>
8*4882a593Smuzhiyun #include <linux/err.h>
9*4882a593Smuzhiyun #include <linux/io.h>
10*4882a593Smuzhiyun #include <linux/interrupt.h>
11*4882a593Smuzhiyun #include <linux/module.h>
12*4882a593Smuzhiyun #include <linux/of.h>
13*4882a593Smuzhiyun #include <linux/platform_device.h>
14*4882a593Smuzhiyun #include <linux/slab.h>
15*4882a593Smuzhiyun
16*4882a593Smuzhiyun #include <linux/gpio/consumer.h>
17*4882a593Smuzhiyun #include <linux/of_platform.h>
18*4882a593Smuzhiyun #include <linux/phy/phy.h>
19*4882a593Smuzhiyun #include <linux/pinctrl/consumer.h>
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun #define PHY_MDM6600_PHY_DELAY_MS 4000 /* PHY enable 2.2s to 3.5s */
22*4882a593Smuzhiyun #define PHY_MDM6600_ENABLED_DELAY_MS 8000 /* 8s more total for MDM6600 */
23*4882a593Smuzhiyun #define PHY_MDM6600_WAKE_KICK_MS 600 /* time on after GPIO toggle */
24*4882a593Smuzhiyun #define MDM6600_MODEM_IDLE_DELAY_MS 1000 /* modem after USB suspend */
25*4882a593Smuzhiyun #define MDM6600_MODEM_WAKE_DELAY_MS 200 /* modem response after idle */
26*4882a593Smuzhiyun
27*4882a593Smuzhiyun enum phy_mdm6600_ctrl_lines {
28*4882a593Smuzhiyun PHY_MDM6600_ENABLE, /* USB PHY enable */
29*4882a593Smuzhiyun PHY_MDM6600_POWER, /* Device power */
30*4882a593Smuzhiyun PHY_MDM6600_RESET, /* Device reset */
31*4882a593Smuzhiyun PHY_MDM6600_NR_CTRL_LINES,
32*4882a593Smuzhiyun };
33*4882a593Smuzhiyun
34*4882a593Smuzhiyun enum phy_mdm6600_bootmode_lines {
35*4882a593Smuzhiyun PHY_MDM6600_MODE0, /* out USB mode0 and OOB wake */
36*4882a593Smuzhiyun PHY_MDM6600_MODE1, /* out USB mode1, in OOB wake */
37*4882a593Smuzhiyun PHY_MDM6600_NR_MODE_LINES,
38*4882a593Smuzhiyun };
39*4882a593Smuzhiyun
40*4882a593Smuzhiyun enum phy_mdm6600_cmd_lines {
41*4882a593Smuzhiyun PHY_MDM6600_CMD0,
42*4882a593Smuzhiyun PHY_MDM6600_CMD1,
43*4882a593Smuzhiyun PHY_MDM6600_CMD2,
44*4882a593Smuzhiyun PHY_MDM6600_NR_CMD_LINES,
45*4882a593Smuzhiyun };
46*4882a593Smuzhiyun
47*4882a593Smuzhiyun enum phy_mdm6600_status_lines {
48*4882a593Smuzhiyun PHY_MDM6600_STATUS0,
49*4882a593Smuzhiyun PHY_MDM6600_STATUS1,
50*4882a593Smuzhiyun PHY_MDM6600_STATUS2,
51*4882a593Smuzhiyun PHY_MDM6600_NR_STATUS_LINES,
52*4882a593Smuzhiyun };
53*4882a593Smuzhiyun
54*4882a593Smuzhiyun /*
55*4882a593Smuzhiyun * MDM6600 command codes. These are based on Motorola Mapphone Linux
56*4882a593Smuzhiyun * kernel tree.
57*4882a593Smuzhiyun */
58*4882a593Smuzhiyun enum phy_mdm6600_cmd {
59*4882a593Smuzhiyun PHY_MDM6600_CMD_BP_PANIC_ACK,
60*4882a593Smuzhiyun PHY_MDM6600_CMD_DATA_ONLY_BYPASS, /* Reroute USB to CPCAP PHY */
61*4882a593Smuzhiyun PHY_MDM6600_CMD_FULL_BYPASS, /* Reroute USB to CPCAP PHY */
62*4882a593Smuzhiyun PHY_MDM6600_CMD_NO_BYPASS, /* Request normal USB mode */
63*4882a593Smuzhiyun PHY_MDM6600_CMD_BP_SHUTDOWN_REQ, /* Request device power off */
64*4882a593Smuzhiyun PHY_MDM6600_CMD_BP_UNKNOWN_5,
65*4882a593Smuzhiyun PHY_MDM6600_CMD_BP_UNKNOWN_6,
66*4882a593Smuzhiyun PHY_MDM6600_CMD_UNDEFINED,
67*4882a593Smuzhiyun };
68*4882a593Smuzhiyun
69*4882a593Smuzhiyun /*
70*4882a593Smuzhiyun * MDM6600 status codes. These are based on Motorola Mapphone Linux
71*4882a593Smuzhiyun * kernel tree.
72*4882a593Smuzhiyun */
73*4882a593Smuzhiyun enum phy_mdm6600_status {
74*4882a593Smuzhiyun PHY_MDM6600_STATUS_PANIC, /* Seems to be really off */
75*4882a593Smuzhiyun PHY_MDM6600_STATUS_PANIC_BUSY_WAIT,
76*4882a593Smuzhiyun PHY_MDM6600_STATUS_QC_DLOAD,
77*4882a593Smuzhiyun PHY_MDM6600_STATUS_RAM_DOWNLOADER, /* MDM6600 USB flashing mode */
78*4882a593Smuzhiyun PHY_MDM6600_STATUS_PHONE_CODE_AWAKE, /* MDM6600 normal USB mode */
79*4882a593Smuzhiyun PHY_MDM6600_STATUS_PHONE_CODE_ASLEEP,
80*4882a593Smuzhiyun PHY_MDM6600_STATUS_SHUTDOWN_ACK,
81*4882a593Smuzhiyun PHY_MDM6600_STATUS_UNDEFINED,
82*4882a593Smuzhiyun };
83*4882a593Smuzhiyun
84*4882a593Smuzhiyun static const char * const
85*4882a593Smuzhiyun phy_mdm6600_status_name[] = {
86*4882a593Smuzhiyun "off", "busy", "qc_dl", "ram_dl", "awake",
87*4882a593Smuzhiyun "asleep", "shutdown", "undefined",
88*4882a593Smuzhiyun };
89*4882a593Smuzhiyun
90*4882a593Smuzhiyun struct phy_mdm6600 {
91*4882a593Smuzhiyun struct device *dev;
92*4882a593Smuzhiyun struct phy *generic_phy;
93*4882a593Smuzhiyun struct phy_provider *phy_provider;
94*4882a593Smuzhiyun struct gpio_desc *ctrl_gpios[PHY_MDM6600_NR_CTRL_LINES];
95*4882a593Smuzhiyun struct gpio_descs *mode_gpios;
96*4882a593Smuzhiyun struct gpio_descs *status_gpios;
97*4882a593Smuzhiyun struct gpio_descs *cmd_gpios;
98*4882a593Smuzhiyun struct delayed_work bootup_work;
99*4882a593Smuzhiyun struct delayed_work status_work;
100*4882a593Smuzhiyun struct delayed_work modem_wake_work;
101*4882a593Smuzhiyun struct completion ack;
102*4882a593Smuzhiyun bool enabled; /* mdm6600 phy enabled */
103*4882a593Smuzhiyun bool running; /* mdm6600 boot done */
104*4882a593Smuzhiyun bool awake; /* mdm6600 respnds on n_gsm */
105*4882a593Smuzhiyun int status;
106*4882a593Smuzhiyun };
107*4882a593Smuzhiyun
phy_mdm6600_init(struct phy * x)108*4882a593Smuzhiyun static int phy_mdm6600_init(struct phy *x)
109*4882a593Smuzhiyun {
110*4882a593Smuzhiyun struct phy_mdm6600 *ddata = phy_get_drvdata(x);
111*4882a593Smuzhiyun struct gpio_desc *enable_gpio = ddata->ctrl_gpios[PHY_MDM6600_ENABLE];
112*4882a593Smuzhiyun
113*4882a593Smuzhiyun if (!ddata->enabled)
114*4882a593Smuzhiyun return -EPROBE_DEFER;
115*4882a593Smuzhiyun
116*4882a593Smuzhiyun gpiod_set_value_cansleep(enable_gpio, 0);
117*4882a593Smuzhiyun
118*4882a593Smuzhiyun return 0;
119*4882a593Smuzhiyun }
120*4882a593Smuzhiyun
phy_mdm6600_power_on(struct phy * x)121*4882a593Smuzhiyun static int phy_mdm6600_power_on(struct phy *x)
122*4882a593Smuzhiyun {
123*4882a593Smuzhiyun struct phy_mdm6600 *ddata = phy_get_drvdata(x);
124*4882a593Smuzhiyun struct gpio_desc *enable_gpio = ddata->ctrl_gpios[PHY_MDM6600_ENABLE];
125*4882a593Smuzhiyun int error;
126*4882a593Smuzhiyun
127*4882a593Smuzhiyun if (!ddata->enabled)
128*4882a593Smuzhiyun return -ENODEV;
129*4882a593Smuzhiyun
130*4882a593Smuzhiyun error = pinctrl_pm_select_default_state(ddata->dev);
131*4882a593Smuzhiyun if (error)
132*4882a593Smuzhiyun dev_warn(ddata->dev, "%s: error with default_state: %i\n",
133*4882a593Smuzhiyun __func__, error);
134*4882a593Smuzhiyun
135*4882a593Smuzhiyun gpiod_set_value_cansleep(enable_gpio, 1);
136*4882a593Smuzhiyun
137*4882a593Smuzhiyun /* Allow aggressive PM for USB, it's only needed for n_gsm port */
138*4882a593Smuzhiyun if (pm_runtime_enabled(&x->dev))
139*4882a593Smuzhiyun phy_pm_runtime_put(x);
140*4882a593Smuzhiyun
141*4882a593Smuzhiyun return 0;
142*4882a593Smuzhiyun }
143*4882a593Smuzhiyun
phy_mdm6600_power_off(struct phy * x)144*4882a593Smuzhiyun static int phy_mdm6600_power_off(struct phy *x)
145*4882a593Smuzhiyun {
146*4882a593Smuzhiyun struct phy_mdm6600 *ddata = phy_get_drvdata(x);
147*4882a593Smuzhiyun struct gpio_desc *enable_gpio = ddata->ctrl_gpios[PHY_MDM6600_ENABLE];
148*4882a593Smuzhiyun int error;
149*4882a593Smuzhiyun
150*4882a593Smuzhiyun if (!ddata->enabled)
151*4882a593Smuzhiyun return -ENODEV;
152*4882a593Smuzhiyun
153*4882a593Smuzhiyun /* Paired with phy_pm_runtime_put() in phy_mdm6600_power_on() */
154*4882a593Smuzhiyun if (pm_runtime_enabled(&x->dev)) {
155*4882a593Smuzhiyun error = phy_pm_runtime_get(x);
156*4882a593Smuzhiyun if (error < 0 && error != -EINPROGRESS)
157*4882a593Smuzhiyun dev_warn(ddata->dev, "%s: phy_pm_runtime_get: %i\n",
158*4882a593Smuzhiyun __func__, error);
159*4882a593Smuzhiyun }
160*4882a593Smuzhiyun
161*4882a593Smuzhiyun gpiod_set_value_cansleep(enable_gpio, 0);
162*4882a593Smuzhiyun
163*4882a593Smuzhiyun error = pinctrl_pm_select_sleep_state(ddata->dev);
164*4882a593Smuzhiyun if (error)
165*4882a593Smuzhiyun dev_warn(ddata->dev, "%s: error with sleep_state: %i\n",
166*4882a593Smuzhiyun __func__, error);
167*4882a593Smuzhiyun
168*4882a593Smuzhiyun return 0;
169*4882a593Smuzhiyun }
170*4882a593Smuzhiyun
171*4882a593Smuzhiyun static const struct phy_ops gpio_usb_ops = {
172*4882a593Smuzhiyun .init = phy_mdm6600_init,
173*4882a593Smuzhiyun .power_on = phy_mdm6600_power_on,
174*4882a593Smuzhiyun .power_off = phy_mdm6600_power_off,
175*4882a593Smuzhiyun .owner = THIS_MODULE,
176*4882a593Smuzhiyun };
177*4882a593Smuzhiyun
178*4882a593Smuzhiyun /**
179*4882a593Smuzhiyun * phy_mdm6600_cmd() - send a command request to mdm6600
180*4882a593Smuzhiyun * @ddata: device driver data
181*4882a593Smuzhiyun * @val: value of cmd to be set
182*4882a593Smuzhiyun *
183*4882a593Smuzhiyun * Configures the three command request GPIOs to the specified value.
184*4882a593Smuzhiyun */
phy_mdm6600_cmd(struct phy_mdm6600 * ddata,int val)185*4882a593Smuzhiyun static void phy_mdm6600_cmd(struct phy_mdm6600 *ddata, int val)
186*4882a593Smuzhiyun {
187*4882a593Smuzhiyun DECLARE_BITMAP(values, PHY_MDM6600_NR_CMD_LINES);
188*4882a593Smuzhiyun
189*4882a593Smuzhiyun values[0] = val;
190*4882a593Smuzhiyun
191*4882a593Smuzhiyun gpiod_set_array_value_cansleep(PHY_MDM6600_NR_CMD_LINES,
192*4882a593Smuzhiyun ddata->cmd_gpios->desc,
193*4882a593Smuzhiyun ddata->cmd_gpios->info, values);
194*4882a593Smuzhiyun }
195*4882a593Smuzhiyun
196*4882a593Smuzhiyun /**
197*4882a593Smuzhiyun * phy_mdm6600_status() - read mdm6600 status lines
198*4882a593Smuzhiyun * @work: work structure
199*4882a593Smuzhiyun */
phy_mdm6600_status(struct work_struct * work)200*4882a593Smuzhiyun static void phy_mdm6600_status(struct work_struct *work)
201*4882a593Smuzhiyun {
202*4882a593Smuzhiyun struct phy_mdm6600 *ddata;
203*4882a593Smuzhiyun struct device *dev;
204*4882a593Smuzhiyun DECLARE_BITMAP(values, PHY_MDM6600_NR_STATUS_LINES);
205*4882a593Smuzhiyun int error;
206*4882a593Smuzhiyun
207*4882a593Smuzhiyun ddata = container_of(work, struct phy_mdm6600, status_work.work);
208*4882a593Smuzhiyun dev = ddata->dev;
209*4882a593Smuzhiyun
210*4882a593Smuzhiyun error = gpiod_get_array_value_cansleep(PHY_MDM6600_NR_STATUS_LINES,
211*4882a593Smuzhiyun ddata->status_gpios->desc,
212*4882a593Smuzhiyun ddata->status_gpios->info,
213*4882a593Smuzhiyun values);
214*4882a593Smuzhiyun if (error)
215*4882a593Smuzhiyun return;
216*4882a593Smuzhiyun
217*4882a593Smuzhiyun ddata->status = values[0] & ((1 << PHY_MDM6600_NR_STATUS_LINES) - 1);
218*4882a593Smuzhiyun
219*4882a593Smuzhiyun dev_info(dev, "modem status: %i %s\n",
220*4882a593Smuzhiyun ddata->status,
221*4882a593Smuzhiyun phy_mdm6600_status_name[ddata->status]);
222*4882a593Smuzhiyun complete(&ddata->ack);
223*4882a593Smuzhiyun }
224*4882a593Smuzhiyun
phy_mdm6600_irq_thread(int irq,void * data)225*4882a593Smuzhiyun static irqreturn_t phy_mdm6600_irq_thread(int irq, void *data)
226*4882a593Smuzhiyun {
227*4882a593Smuzhiyun struct phy_mdm6600 *ddata = data;
228*4882a593Smuzhiyun
229*4882a593Smuzhiyun schedule_delayed_work(&ddata->status_work, msecs_to_jiffies(10));
230*4882a593Smuzhiyun
231*4882a593Smuzhiyun return IRQ_HANDLED;
232*4882a593Smuzhiyun }
233*4882a593Smuzhiyun
234*4882a593Smuzhiyun /**
235*4882a593Smuzhiyun * phy_mdm6600_wakeirq_thread - handle mode1 line OOB wake after booting
236*4882a593Smuzhiyun * @irq: interrupt
237*4882a593Smuzhiyun * @data: interrupt handler data
238*4882a593Smuzhiyun *
239*4882a593Smuzhiyun * GPIO mode1 is used initially as output to configure the USB boot
240*4882a593Smuzhiyun * mode for mdm6600. After booting it is used as input for OOB wake
241*4882a593Smuzhiyun * signal from mdm6600 to the SoC. Just use it for debug info only
242*4882a593Smuzhiyun * for now.
243*4882a593Smuzhiyun */
phy_mdm6600_wakeirq_thread(int irq,void * data)244*4882a593Smuzhiyun static irqreturn_t phy_mdm6600_wakeirq_thread(int irq, void *data)
245*4882a593Smuzhiyun {
246*4882a593Smuzhiyun struct phy_mdm6600 *ddata = data;
247*4882a593Smuzhiyun struct gpio_desc *mode_gpio1;
248*4882a593Smuzhiyun int error, wakeup;
249*4882a593Smuzhiyun
250*4882a593Smuzhiyun mode_gpio1 = ddata->mode_gpios->desc[PHY_MDM6600_MODE1];
251*4882a593Smuzhiyun wakeup = gpiod_get_value(mode_gpio1);
252*4882a593Smuzhiyun if (!wakeup)
253*4882a593Smuzhiyun return IRQ_NONE;
254*4882a593Smuzhiyun
255*4882a593Smuzhiyun dev_dbg(ddata->dev, "OOB wake on mode_gpio1: %i\n", wakeup);
256*4882a593Smuzhiyun error = pm_runtime_get_sync(ddata->dev);
257*4882a593Smuzhiyun if (error < 0) {
258*4882a593Smuzhiyun pm_runtime_put_noidle(ddata->dev);
259*4882a593Smuzhiyun
260*4882a593Smuzhiyun return IRQ_NONE;
261*4882a593Smuzhiyun }
262*4882a593Smuzhiyun
263*4882a593Smuzhiyun /* Just wake-up and kick the autosuspend timer */
264*4882a593Smuzhiyun pm_runtime_mark_last_busy(ddata->dev);
265*4882a593Smuzhiyun pm_runtime_put_autosuspend(ddata->dev);
266*4882a593Smuzhiyun
267*4882a593Smuzhiyun return IRQ_HANDLED;
268*4882a593Smuzhiyun }
269*4882a593Smuzhiyun
270*4882a593Smuzhiyun /**
271*4882a593Smuzhiyun * phy_mdm6600_init_irq() - initialize mdm6600 status IRQ lines
272*4882a593Smuzhiyun * @ddata: device driver data
273*4882a593Smuzhiyun */
phy_mdm6600_init_irq(struct phy_mdm6600 * ddata)274*4882a593Smuzhiyun static void phy_mdm6600_init_irq(struct phy_mdm6600 *ddata)
275*4882a593Smuzhiyun {
276*4882a593Smuzhiyun struct device *dev = ddata->dev;
277*4882a593Smuzhiyun int i, error, irq;
278*4882a593Smuzhiyun
279*4882a593Smuzhiyun for (i = PHY_MDM6600_STATUS0;
280*4882a593Smuzhiyun i <= PHY_MDM6600_STATUS2; i++) {
281*4882a593Smuzhiyun struct gpio_desc *gpio = ddata->status_gpios->desc[i];
282*4882a593Smuzhiyun
283*4882a593Smuzhiyun irq = gpiod_to_irq(gpio);
284*4882a593Smuzhiyun if (irq <= 0)
285*4882a593Smuzhiyun continue;
286*4882a593Smuzhiyun
287*4882a593Smuzhiyun error = devm_request_threaded_irq(dev, irq, NULL,
288*4882a593Smuzhiyun phy_mdm6600_irq_thread,
289*4882a593Smuzhiyun IRQF_TRIGGER_RISING |
290*4882a593Smuzhiyun IRQF_TRIGGER_FALLING |
291*4882a593Smuzhiyun IRQF_ONESHOT,
292*4882a593Smuzhiyun "mdm6600",
293*4882a593Smuzhiyun ddata);
294*4882a593Smuzhiyun if (error)
295*4882a593Smuzhiyun dev_warn(dev, "no modem status irq%i: %i\n",
296*4882a593Smuzhiyun irq, error);
297*4882a593Smuzhiyun }
298*4882a593Smuzhiyun }
299*4882a593Smuzhiyun
300*4882a593Smuzhiyun struct phy_mdm6600_map {
301*4882a593Smuzhiyun const char *name;
302*4882a593Smuzhiyun int direction;
303*4882a593Smuzhiyun };
304*4882a593Smuzhiyun
305*4882a593Smuzhiyun static const struct phy_mdm6600_map
306*4882a593Smuzhiyun phy_mdm6600_ctrl_gpio_map[PHY_MDM6600_NR_CTRL_LINES] = {
307*4882a593Smuzhiyun { "enable", GPIOD_OUT_LOW, }, /* low = phy disabled */
308*4882a593Smuzhiyun { "power", GPIOD_OUT_LOW, }, /* low = off */
309*4882a593Smuzhiyun { "reset", GPIOD_OUT_HIGH, }, /* high = reset */
310*4882a593Smuzhiyun };
311*4882a593Smuzhiyun
312*4882a593Smuzhiyun /**
313*4882a593Smuzhiyun * phy_mdm6600_init_lines() - initialize mdm6600 GPIO lines
314*4882a593Smuzhiyun * @ddata: device driver data
315*4882a593Smuzhiyun */
phy_mdm6600_init_lines(struct phy_mdm6600 * ddata)316*4882a593Smuzhiyun static int phy_mdm6600_init_lines(struct phy_mdm6600 *ddata)
317*4882a593Smuzhiyun {
318*4882a593Smuzhiyun struct device *dev = ddata->dev;
319*4882a593Smuzhiyun int i;
320*4882a593Smuzhiyun
321*4882a593Smuzhiyun /* MDM6600 control lines */
322*4882a593Smuzhiyun for (i = 0; i < ARRAY_SIZE(phy_mdm6600_ctrl_gpio_map); i++) {
323*4882a593Smuzhiyun const struct phy_mdm6600_map *map =
324*4882a593Smuzhiyun &phy_mdm6600_ctrl_gpio_map[i];
325*4882a593Smuzhiyun struct gpio_desc **gpio = &ddata->ctrl_gpios[i];
326*4882a593Smuzhiyun
327*4882a593Smuzhiyun *gpio = devm_gpiod_get(dev, map->name, map->direction);
328*4882a593Smuzhiyun if (IS_ERR(*gpio)) {
329*4882a593Smuzhiyun dev_info(dev, "gpio %s error %li\n",
330*4882a593Smuzhiyun map->name, PTR_ERR(*gpio));
331*4882a593Smuzhiyun return PTR_ERR(*gpio);
332*4882a593Smuzhiyun }
333*4882a593Smuzhiyun }
334*4882a593Smuzhiyun
335*4882a593Smuzhiyun /* MDM6600 USB start-up mode output lines */
336*4882a593Smuzhiyun ddata->mode_gpios = devm_gpiod_get_array(dev, "motorola,mode",
337*4882a593Smuzhiyun GPIOD_OUT_LOW);
338*4882a593Smuzhiyun if (IS_ERR(ddata->mode_gpios))
339*4882a593Smuzhiyun return PTR_ERR(ddata->mode_gpios);
340*4882a593Smuzhiyun
341*4882a593Smuzhiyun if (ddata->mode_gpios->ndescs != PHY_MDM6600_NR_MODE_LINES)
342*4882a593Smuzhiyun return -EINVAL;
343*4882a593Smuzhiyun
344*4882a593Smuzhiyun /* MDM6600 status input lines */
345*4882a593Smuzhiyun ddata->status_gpios = devm_gpiod_get_array(dev, "motorola,status",
346*4882a593Smuzhiyun GPIOD_IN);
347*4882a593Smuzhiyun if (IS_ERR(ddata->status_gpios))
348*4882a593Smuzhiyun return PTR_ERR(ddata->status_gpios);
349*4882a593Smuzhiyun
350*4882a593Smuzhiyun if (ddata->status_gpios->ndescs != PHY_MDM6600_NR_STATUS_LINES)
351*4882a593Smuzhiyun return -EINVAL;
352*4882a593Smuzhiyun
353*4882a593Smuzhiyun /* MDM6600 cmd output lines */
354*4882a593Smuzhiyun ddata->cmd_gpios = devm_gpiod_get_array(dev, "motorola,cmd",
355*4882a593Smuzhiyun GPIOD_OUT_LOW);
356*4882a593Smuzhiyun if (IS_ERR(ddata->cmd_gpios))
357*4882a593Smuzhiyun return PTR_ERR(ddata->cmd_gpios);
358*4882a593Smuzhiyun
359*4882a593Smuzhiyun if (ddata->cmd_gpios->ndescs != PHY_MDM6600_NR_CMD_LINES)
360*4882a593Smuzhiyun return -EINVAL;
361*4882a593Smuzhiyun
362*4882a593Smuzhiyun return 0;
363*4882a593Smuzhiyun }
364*4882a593Smuzhiyun
365*4882a593Smuzhiyun /**
366*4882a593Smuzhiyun * phy_mdm6600_device_power_on() - power on mdm6600 device
367*4882a593Smuzhiyun * @ddata: device driver data
368*4882a593Smuzhiyun *
369*4882a593Smuzhiyun * To get the integrated USB phy in MDM6600 takes some hoops. We must ensure
370*4882a593Smuzhiyun * the shared USB bootmode GPIOs are configured, then request modem start-up,
371*4882a593Smuzhiyun * reset and power-up.. And then we need to recycle the shared USB bootmode
372*4882a593Smuzhiyun * GPIOs as they are also used for Out of Band (OOB) wake for the USB and
373*4882a593Smuzhiyun * TS 27.010 serial mux.
374*4882a593Smuzhiyun */
phy_mdm6600_device_power_on(struct phy_mdm6600 * ddata)375*4882a593Smuzhiyun static int phy_mdm6600_device_power_on(struct phy_mdm6600 *ddata)
376*4882a593Smuzhiyun {
377*4882a593Smuzhiyun struct gpio_desc *mode_gpio0, *mode_gpio1, *reset_gpio, *power_gpio;
378*4882a593Smuzhiyun int error = 0, wakeirq;
379*4882a593Smuzhiyun
380*4882a593Smuzhiyun mode_gpio0 = ddata->mode_gpios->desc[PHY_MDM6600_MODE0];
381*4882a593Smuzhiyun mode_gpio1 = ddata->mode_gpios->desc[PHY_MDM6600_MODE1];
382*4882a593Smuzhiyun reset_gpio = ddata->ctrl_gpios[PHY_MDM6600_RESET];
383*4882a593Smuzhiyun power_gpio = ddata->ctrl_gpios[PHY_MDM6600_POWER];
384*4882a593Smuzhiyun
385*4882a593Smuzhiyun /*
386*4882a593Smuzhiyun * Shared GPIOs must be low for normal USB mode. After booting
387*4882a593Smuzhiyun * they are used for OOB wake signaling. These can be also used
388*4882a593Smuzhiyun * to configure USB flashing mode later on based on a module
389*4882a593Smuzhiyun * parameter.
390*4882a593Smuzhiyun */
391*4882a593Smuzhiyun gpiod_set_value_cansleep(mode_gpio0, 0);
392*4882a593Smuzhiyun gpiod_set_value_cansleep(mode_gpio1, 0);
393*4882a593Smuzhiyun
394*4882a593Smuzhiyun /* Request start-up mode */
395*4882a593Smuzhiyun phy_mdm6600_cmd(ddata, PHY_MDM6600_CMD_NO_BYPASS);
396*4882a593Smuzhiyun
397*4882a593Smuzhiyun /* Request a reset first */
398*4882a593Smuzhiyun gpiod_set_value_cansleep(reset_gpio, 0);
399*4882a593Smuzhiyun msleep(100);
400*4882a593Smuzhiyun
401*4882a593Smuzhiyun /* Toggle power GPIO to request mdm6600 to start */
402*4882a593Smuzhiyun gpiod_set_value_cansleep(power_gpio, 1);
403*4882a593Smuzhiyun msleep(100);
404*4882a593Smuzhiyun gpiod_set_value_cansleep(power_gpio, 0);
405*4882a593Smuzhiyun
406*4882a593Smuzhiyun /*
407*4882a593Smuzhiyun * Looks like the USB PHY needs between 2.2 to 4 seconds.
408*4882a593Smuzhiyun * If we try to use it before that, we will get L3 errors
409*4882a593Smuzhiyun * from omap-usb-host trying to access the PHY. See also
410*4882a593Smuzhiyun * phy_mdm6600_init() for -EPROBE_DEFER.
411*4882a593Smuzhiyun */
412*4882a593Smuzhiyun msleep(PHY_MDM6600_PHY_DELAY_MS);
413*4882a593Smuzhiyun ddata->enabled = true;
414*4882a593Smuzhiyun
415*4882a593Smuzhiyun /* Booting up the rest of MDM6600 will take total about 8 seconds */
416*4882a593Smuzhiyun dev_info(ddata->dev, "Waiting for power up request to complete..\n");
417*4882a593Smuzhiyun if (wait_for_completion_timeout(&ddata->ack,
418*4882a593Smuzhiyun msecs_to_jiffies(PHY_MDM6600_ENABLED_DELAY_MS))) {
419*4882a593Smuzhiyun if (ddata->status > PHY_MDM6600_STATUS_PANIC &&
420*4882a593Smuzhiyun ddata->status < PHY_MDM6600_STATUS_SHUTDOWN_ACK)
421*4882a593Smuzhiyun dev_info(ddata->dev, "Powered up OK\n");
422*4882a593Smuzhiyun } else {
423*4882a593Smuzhiyun ddata->enabled = false;
424*4882a593Smuzhiyun error = -ETIMEDOUT;
425*4882a593Smuzhiyun dev_err(ddata->dev, "Timed out powering up\n");
426*4882a593Smuzhiyun }
427*4882a593Smuzhiyun
428*4882a593Smuzhiyun /* Reconfigure mode1 GPIO as input for OOB wake */
429*4882a593Smuzhiyun gpiod_direction_input(mode_gpio1);
430*4882a593Smuzhiyun
431*4882a593Smuzhiyun wakeirq = gpiod_to_irq(mode_gpio1);
432*4882a593Smuzhiyun if (wakeirq <= 0)
433*4882a593Smuzhiyun return wakeirq;
434*4882a593Smuzhiyun
435*4882a593Smuzhiyun error = devm_request_threaded_irq(ddata->dev, wakeirq, NULL,
436*4882a593Smuzhiyun phy_mdm6600_wakeirq_thread,
437*4882a593Smuzhiyun IRQF_TRIGGER_RISING |
438*4882a593Smuzhiyun IRQF_TRIGGER_FALLING |
439*4882a593Smuzhiyun IRQF_ONESHOT,
440*4882a593Smuzhiyun "mdm6600-wake",
441*4882a593Smuzhiyun ddata);
442*4882a593Smuzhiyun if (error)
443*4882a593Smuzhiyun dev_warn(ddata->dev, "no modem wakeirq irq%i: %i\n",
444*4882a593Smuzhiyun wakeirq, error);
445*4882a593Smuzhiyun
446*4882a593Smuzhiyun ddata->running = true;
447*4882a593Smuzhiyun
448*4882a593Smuzhiyun return error;
449*4882a593Smuzhiyun }
450*4882a593Smuzhiyun
451*4882a593Smuzhiyun /**
452*4882a593Smuzhiyun * phy_mdm6600_device_power_off() - power off mdm6600 device
453*4882a593Smuzhiyun * @ddata: device driver data
454*4882a593Smuzhiyun */
phy_mdm6600_device_power_off(struct phy_mdm6600 * ddata)455*4882a593Smuzhiyun static void phy_mdm6600_device_power_off(struct phy_mdm6600 *ddata)
456*4882a593Smuzhiyun {
457*4882a593Smuzhiyun struct gpio_desc *reset_gpio =
458*4882a593Smuzhiyun ddata->ctrl_gpios[PHY_MDM6600_RESET];
459*4882a593Smuzhiyun
460*4882a593Smuzhiyun ddata->enabled = false;
461*4882a593Smuzhiyun phy_mdm6600_cmd(ddata, PHY_MDM6600_CMD_BP_SHUTDOWN_REQ);
462*4882a593Smuzhiyun msleep(100);
463*4882a593Smuzhiyun
464*4882a593Smuzhiyun gpiod_set_value_cansleep(reset_gpio, 1);
465*4882a593Smuzhiyun
466*4882a593Smuzhiyun dev_info(ddata->dev, "Waiting for power down request to complete.. ");
467*4882a593Smuzhiyun if (wait_for_completion_timeout(&ddata->ack,
468*4882a593Smuzhiyun msecs_to_jiffies(5000))) {
469*4882a593Smuzhiyun if (ddata->status == PHY_MDM6600_STATUS_PANIC)
470*4882a593Smuzhiyun dev_info(ddata->dev, "Powered down OK\n");
471*4882a593Smuzhiyun } else {
472*4882a593Smuzhiyun dev_err(ddata->dev, "Timed out powering down\n");
473*4882a593Smuzhiyun }
474*4882a593Smuzhiyun }
475*4882a593Smuzhiyun
phy_mdm6600_deferred_power_on(struct work_struct * work)476*4882a593Smuzhiyun static void phy_mdm6600_deferred_power_on(struct work_struct *work)
477*4882a593Smuzhiyun {
478*4882a593Smuzhiyun struct phy_mdm6600 *ddata;
479*4882a593Smuzhiyun int error;
480*4882a593Smuzhiyun
481*4882a593Smuzhiyun ddata = container_of(work, struct phy_mdm6600, bootup_work.work);
482*4882a593Smuzhiyun
483*4882a593Smuzhiyun error = phy_mdm6600_device_power_on(ddata);
484*4882a593Smuzhiyun if (error)
485*4882a593Smuzhiyun dev_err(ddata->dev, "Device not functional\n");
486*4882a593Smuzhiyun }
487*4882a593Smuzhiyun
488*4882a593Smuzhiyun /*
489*4882a593Smuzhiyun * USB suspend puts mdm6600 into low power mode. For any n_gsm using apps,
490*4882a593Smuzhiyun * we need to keep the modem awake by kicking it's mode0 GPIO. This will
491*4882a593Smuzhiyun * keep the modem awake for about 1.2 seconds. When no n_gsm apps are using
492*4882a593Smuzhiyun * the modem, runtime PM auto mode can be enabled so modem can enter low
493*4882a593Smuzhiyun * power mode.
494*4882a593Smuzhiyun */
phy_mdm6600_wake_modem(struct phy_mdm6600 * ddata)495*4882a593Smuzhiyun static void phy_mdm6600_wake_modem(struct phy_mdm6600 *ddata)
496*4882a593Smuzhiyun {
497*4882a593Smuzhiyun struct gpio_desc *mode_gpio0;
498*4882a593Smuzhiyun
499*4882a593Smuzhiyun mode_gpio0 = ddata->mode_gpios->desc[PHY_MDM6600_MODE0];
500*4882a593Smuzhiyun gpiod_set_value_cansleep(mode_gpio0, 1);
501*4882a593Smuzhiyun usleep_range(5, 15);
502*4882a593Smuzhiyun gpiod_set_value_cansleep(mode_gpio0, 0);
503*4882a593Smuzhiyun if (ddata->awake)
504*4882a593Smuzhiyun usleep_range(5, 15);
505*4882a593Smuzhiyun else
506*4882a593Smuzhiyun msleep(MDM6600_MODEM_WAKE_DELAY_MS);
507*4882a593Smuzhiyun }
508*4882a593Smuzhiyun
phy_mdm6600_modem_wake(struct work_struct * work)509*4882a593Smuzhiyun static void phy_mdm6600_modem_wake(struct work_struct *work)
510*4882a593Smuzhiyun {
511*4882a593Smuzhiyun struct phy_mdm6600 *ddata;
512*4882a593Smuzhiyun
513*4882a593Smuzhiyun ddata = container_of(work, struct phy_mdm6600, modem_wake_work.work);
514*4882a593Smuzhiyun phy_mdm6600_wake_modem(ddata);
515*4882a593Smuzhiyun
516*4882a593Smuzhiyun /*
517*4882a593Smuzhiyun * The modem does not always stay awake 1.2 seconds after toggling
518*4882a593Smuzhiyun * the wake GPIO, and sometimes it idles after about some 600 ms
519*4882a593Smuzhiyun * making writes time out.
520*4882a593Smuzhiyun */
521*4882a593Smuzhiyun schedule_delayed_work(&ddata->modem_wake_work,
522*4882a593Smuzhiyun msecs_to_jiffies(PHY_MDM6600_WAKE_KICK_MS));
523*4882a593Smuzhiyun }
524*4882a593Smuzhiyun
phy_mdm6600_runtime_suspend(struct device * dev)525*4882a593Smuzhiyun static int __maybe_unused phy_mdm6600_runtime_suspend(struct device *dev)
526*4882a593Smuzhiyun {
527*4882a593Smuzhiyun struct phy_mdm6600 *ddata = dev_get_drvdata(dev);
528*4882a593Smuzhiyun
529*4882a593Smuzhiyun cancel_delayed_work_sync(&ddata->modem_wake_work);
530*4882a593Smuzhiyun ddata->awake = false;
531*4882a593Smuzhiyun
532*4882a593Smuzhiyun return 0;
533*4882a593Smuzhiyun }
534*4882a593Smuzhiyun
phy_mdm6600_runtime_resume(struct device * dev)535*4882a593Smuzhiyun static int __maybe_unused phy_mdm6600_runtime_resume(struct device *dev)
536*4882a593Smuzhiyun {
537*4882a593Smuzhiyun struct phy_mdm6600 *ddata = dev_get_drvdata(dev);
538*4882a593Smuzhiyun
539*4882a593Smuzhiyun phy_mdm6600_modem_wake(&ddata->modem_wake_work.work);
540*4882a593Smuzhiyun ddata->awake = true;
541*4882a593Smuzhiyun
542*4882a593Smuzhiyun return 0;
543*4882a593Smuzhiyun }
544*4882a593Smuzhiyun
545*4882a593Smuzhiyun static const struct dev_pm_ops phy_mdm6600_pm_ops = {
546*4882a593Smuzhiyun SET_RUNTIME_PM_OPS(phy_mdm6600_runtime_suspend,
547*4882a593Smuzhiyun phy_mdm6600_runtime_resume, NULL)
548*4882a593Smuzhiyun };
549*4882a593Smuzhiyun
550*4882a593Smuzhiyun static const struct of_device_id phy_mdm6600_id_table[] = {
551*4882a593Smuzhiyun { .compatible = "motorola,mapphone-mdm6600", },
552*4882a593Smuzhiyun {},
553*4882a593Smuzhiyun };
554*4882a593Smuzhiyun MODULE_DEVICE_TABLE(of, phy_mdm6600_id_table);
555*4882a593Smuzhiyun
phy_mdm6600_probe(struct platform_device * pdev)556*4882a593Smuzhiyun static int phy_mdm6600_probe(struct platform_device *pdev)
557*4882a593Smuzhiyun {
558*4882a593Smuzhiyun struct phy_mdm6600 *ddata;
559*4882a593Smuzhiyun int error;
560*4882a593Smuzhiyun
561*4882a593Smuzhiyun ddata = devm_kzalloc(&pdev->dev, sizeof(*ddata), GFP_KERNEL);
562*4882a593Smuzhiyun if (!ddata)
563*4882a593Smuzhiyun return -ENOMEM;
564*4882a593Smuzhiyun
565*4882a593Smuzhiyun INIT_DELAYED_WORK(&ddata->bootup_work,
566*4882a593Smuzhiyun phy_mdm6600_deferred_power_on);
567*4882a593Smuzhiyun INIT_DELAYED_WORK(&ddata->status_work, phy_mdm6600_status);
568*4882a593Smuzhiyun INIT_DELAYED_WORK(&ddata->modem_wake_work, phy_mdm6600_modem_wake);
569*4882a593Smuzhiyun init_completion(&ddata->ack);
570*4882a593Smuzhiyun
571*4882a593Smuzhiyun ddata->dev = &pdev->dev;
572*4882a593Smuzhiyun platform_set_drvdata(pdev, ddata);
573*4882a593Smuzhiyun
574*4882a593Smuzhiyun /* Active state selected in phy_mdm6600_power_on() */
575*4882a593Smuzhiyun error = pinctrl_pm_select_sleep_state(ddata->dev);
576*4882a593Smuzhiyun if (error)
577*4882a593Smuzhiyun dev_warn(ddata->dev, "%s: error with sleep_state: %i\n",
578*4882a593Smuzhiyun __func__, error);
579*4882a593Smuzhiyun
580*4882a593Smuzhiyun error = phy_mdm6600_init_lines(ddata);
581*4882a593Smuzhiyun if (error)
582*4882a593Smuzhiyun return error;
583*4882a593Smuzhiyun
584*4882a593Smuzhiyun phy_mdm6600_init_irq(ddata);
585*4882a593Smuzhiyun schedule_delayed_work(&ddata->bootup_work, 0);
586*4882a593Smuzhiyun
587*4882a593Smuzhiyun /*
588*4882a593Smuzhiyun * See phy_mdm6600_device_power_on(). We should be able
589*4882a593Smuzhiyun * to remove this eventually when ohci-platform can deal
590*4882a593Smuzhiyun * with -EPROBE_DEFER.
591*4882a593Smuzhiyun */
592*4882a593Smuzhiyun msleep(PHY_MDM6600_PHY_DELAY_MS + 500);
593*4882a593Smuzhiyun
594*4882a593Smuzhiyun /*
595*4882a593Smuzhiyun * Enable PM runtime only after PHY has been powered up properly.
596*4882a593Smuzhiyun * It is currently only needed after USB suspends mdm6600 and n_gsm
597*4882a593Smuzhiyun * needs to access the device. We don't want to do this earlier as
598*4882a593Smuzhiyun * gpio mode0 pin doubles as mdm6600 wake-up gpio.
599*4882a593Smuzhiyun */
600*4882a593Smuzhiyun pm_runtime_use_autosuspend(ddata->dev);
601*4882a593Smuzhiyun pm_runtime_set_autosuspend_delay(ddata->dev,
602*4882a593Smuzhiyun MDM6600_MODEM_IDLE_DELAY_MS);
603*4882a593Smuzhiyun pm_runtime_enable(ddata->dev);
604*4882a593Smuzhiyun error = pm_runtime_get_sync(ddata->dev);
605*4882a593Smuzhiyun if (error < 0) {
606*4882a593Smuzhiyun dev_warn(ddata->dev, "failed to wake modem: %i\n", error);
607*4882a593Smuzhiyun pm_runtime_put_noidle(ddata->dev);
608*4882a593Smuzhiyun goto cleanup;
609*4882a593Smuzhiyun }
610*4882a593Smuzhiyun
611*4882a593Smuzhiyun ddata->generic_phy = devm_phy_create(ddata->dev, NULL, &gpio_usb_ops);
612*4882a593Smuzhiyun if (IS_ERR(ddata->generic_phy)) {
613*4882a593Smuzhiyun error = PTR_ERR(ddata->generic_phy);
614*4882a593Smuzhiyun goto idle;
615*4882a593Smuzhiyun }
616*4882a593Smuzhiyun
617*4882a593Smuzhiyun phy_set_drvdata(ddata->generic_phy, ddata);
618*4882a593Smuzhiyun
619*4882a593Smuzhiyun ddata->phy_provider =
620*4882a593Smuzhiyun devm_of_phy_provider_register(ddata->dev,
621*4882a593Smuzhiyun of_phy_simple_xlate);
622*4882a593Smuzhiyun if (IS_ERR(ddata->phy_provider))
623*4882a593Smuzhiyun error = PTR_ERR(ddata->phy_provider);
624*4882a593Smuzhiyun
625*4882a593Smuzhiyun idle:
626*4882a593Smuzhiyun pm_runtime_mark_last_busy(ddata->dev);
627*4882a593Smuzhiyun pm_runtime_put_autosuspend(ddata->dev);
628*4882a593Smuzhiyun
629*4882a593Smuzhiyun cleanup:
630*4882a593Smuzhiyun if (error < 0)
631*4882a593Smuzhiyun phy_mdm6600_device_power_off(ddata);
632*4882a593Smuzhiyun pm_runtime_disable(ddata->dev);
633*4882a593Smuzhiyun pm_runtime_dont_use_autosuspend(ddata->dev);
634*4882a593Smuzhiyun return error;
635*4882a593Smuzhiyun }
636*4882a593Smuzhiyun
phy_mdm6600_remove(struct platform_device * pdev)637*4882a593Smuzhiyun static int phy_mdm6600_remove(struct platform_device *pdev)
638*4882a593Smuzhiyun {
639*4882a593Smuzhiyun struct phy_mdm6600 *ddata = platform_get_drvdata(pdev);
640*4882a593Smuzhiyun struct gpio_desc *reset_gpio = ddata->ctrl_gpios[PHY_MDM6600_RESET];
641*4882a593Smuzhiyun
642*4882a593Smuzhiyun pm_runtime_dont_use_autosuspend(ddata->dev);
643*4882a593Smuzhiyun pm_runtime_put_sync(ddata->dev);
644*4882a593Smuzhiyun pm_runtime_disable(ddata->dev);
645*4882a593Smuzhiyun
646*4882a593Smuzhiyun if (!ddata->running)
647*4882a593Smuzhiyun wait_for_completion_timeout(&ddata->ack,
648*4882a593Smuzhiyun msecs_to_jiffies(PHY_MDM6600_ENABLED_DELAY_MS));
649*4882a593Smuzhiyun
650*4882a593Smuzhiyun gpiod_set_value_cansleep(reset_gpio, 1);
651*4882a593Smuzhiyun phy_mdm6600_device_power_off(ddata);
652*4882a593Smuzhiyun
653*4882a593Smuzhiyun cancel_delayed_work_sync(&ddata->modem_wake_work);
654*4882a593Smuzhiyun cancel_delayed_work_sync(&ddata->bootup_work);
655*4882a593Smuzhiyun cancel_delayed_work_sync(&ddata->status_work);
656*4882a593Smuzhiyun
657*4882a593Smuzhiyun return 0;
658*4882a593Smuzhiyun }
659*4882a593Smuzhiyun
660*4882a593Smuzhiyun static struct platform_driver phy_mdm6600_driver = {
661*4882a593Smuzhiyun .probe = phy_mdm6600_probe,
662*4882a593Smuzhiyun .remove = phy_mdm6600_remove,
663*4882a593Smuzhiyun .driver = {
664*4882a593Smuzhiyun .name = "phy-mapphone-mdm6600",
665*4882a593Smuzhiyun .pm = &phy_mdm6600_pm_ops,
666*4882a593Smuzhiyun .of_match_table = of_match_ptr(phy_mdm6600_id_table),
667*4882a593Smuzhiyun },
668*4882a593Smuzhiyun };
669*4882a593Smuzhiyun
670*4882a593Smuzhiyun module_platform_driver(phy_mdm6600_driver);
671*4882a593Smuzhiyun
672*4882a593Smuzhiyun MODULE_ALIAS("platform:gpio_usb");
673*4882a593Smuzhiyun MODULE_AUTHOR("Tony Lindgren <tony@atomide.com>");
674*4882a593Smuzhiyun MODULE_DESCRIPTION("mdm6600 gpio usb phy driver");
675*4882a593Smuzhiyun MODULE_LICENSE("GPL v2");
676