2 * ISP1704 USB Charger Detection driver
4 * Copyright (C) 2010 Nokia Corporation
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #include <linux/kernel.h>
22 #include <linux/module.h>
23 #include <linux/err.h>
24 #include <linux/init.h>
25 #include <linux/types.h>
26 #include <linux/device.h>
27 #include <linux/sysfs.h>
28 #include <linux/platform_device.h>
29 #include <linux/power_supply.h>
30 #include <linux/delay.h>
32 #include <linux/usb/otg.h>
33 #include <linux/usb/ulpi.h>
34 #include <linux/usb/ch9.h>
35 #include <linux/usb/gadget.h>
36 #include <linux/power/isp1704_charger.h>
38 /* Vendor specific Power Control register */
39 #define ISP1704_PWR_CTRL 0x3d
40 #define ISP1704_PWR_CTRL_SWCTRL (1 << 0)
41 #define ISP1704_PWR_CTRL_DET_COMP (1 << 1)
42 #define ISP1704_PWR_CTRL_BVALID_RISE (1 << 2)
43 #define ISP1704_PWR_CTRL_BVALID_FALL (1 << 3)
44 #define ISP1704_PWR_CTRL_DP_WKPU_EN (1 << 4)
45 #define ISP1704_PWR_CTRL_VDAT_DET (1 << 5)
46 #define ISP1704_PWR_CTRL_DPVSRC_EN (1 << 6)
47 #define ISP1704_PWR_CTRL_HWDETECT (1 << 7)
49 #define NXP_VENDOR_ID 0x04cc
51 static u16 isp170x_id[] = {
56 struct isp1704_charger {
58 struct power_supply psy;
60 struct notifier_block nb;
61 struct work_struct work;
69 /* temp storage variables */
74 static inline int isp1704_read(struct isp1704_charger *isp, u32 reg)
76 return usb_phy_io_read(isp->phy, reg);
79 static inline int isp1704_write(struct isp1704_charger *isp, u32 val, u32 reg)
81 return usb_phy_io_write(isp->phy, val, reg);
85 * Disable/enable the power from the isp1704 if a function for it
86 * has been provided with platform data.
88 static void isp1704_charger_set_power(struct isp1704_charger *isp, bool on)
90 struct isp1704_charger_data *board = isp->dev->platform_data;
92 if (board && board->set_power)
97 * Determine is the charging port DCP (dedicated charger) or CDP (Host/HUB
100 * REVISIT: The method is defined in Battery Charging Specification and is
101 * applicable to any ULPI transceiver. Nothing isp170x specific here.
103 static inline int isp1704_charger_type(struct isp1704_charger *isp)
108 int type = POWER_SUPPLY_TYPE_USB_DCP;
110 func_ctrl = isp1704_read(isp, ULPI_FUNC_CTRL);
111 otg_ctrl = isp1704_read(isp, ULPI_OTG_CTRL);
113 /* disable pulldowns */
114 reg = ULPI_OTG_CTRL_DM_PULLDOWN | ULPI_OTG_CTRL_DP_PULLDOWN;
115 isp1704_write(isp, ULPI_CLR(ULPI_OTG_CTRL), reg);
118 isp1704_write(isp, ULPI_CLR(ULPI_FUNC_CTRL),
119 ULPI_FUNC_CTRL_XCVRSEL_MASK);
120 isp1704_write(isp, ULPI_SET(ULPI_FUNC_CTRL),
121 ULPI_FUNC_CTRL_FULL_SPEED);
123 /* Enable strong pull-up on DP (1.5K) and reset */
124 reg = ULPI_FUNC_CTRL_TERMSELECT | ULPI_FUNC_CTRL_RESET;
125 isp1704_write(isp, ULPI_SET(ULPI_FUNC_CTRL), reg);
126 usleep_range(1000, 2000);
128 reg = isp1704_read(isp, ULPI_DEBUG);
130 type = POWER_SUPPLY_TYPE_USB_CDP;
132 /* recover original state */
133 isp1704_write(isp, ULPI_FUNC_CTRL, func_ctrl);
134 isp1704_write(isp, ULPI_OTG_CTRL, otg_ctrl);
140 * ISP1704 detects PS/2 adapters as charger. To make sure the detected charger
141 * is actually a dedicated charger, the following steps need to be taken.
143 static inline int isp1704_charger_verify(struct isp1704_charger *isp)
148 /* Reset the transceiver */
149 r = isp1704_read(isp, ULPI_FUNC_CTRL);
150 r |= ULPI_FUNC_CTRL_RESET;
151 isp1704_write(isp, ULPI_FUNC_CTRL, r);
152 usleep_range(1000, 2000);
154 /* Set normal mode */
155 r &= ~(ULPI_FUNC_CTRL_RESET | ULPI_FUNC_CTRL_OPMODE_MASK);
156 isp1704_write(isp, ULPI_FUNC_CTRL, r);
158 /* Clear the DP and DM pull-down bits */
159 r = ULPI_OTG_CTRL_DP_PULLDOWN | ULPI_OTG_CTRL_DM_PULLDOWN;
160 isp1704_write(isp, ULPI_CLR(ULPI_OTG_CTRL), r);
162 /* Enable strong pull-up on DP (1.5K) and reset */
163 r = ULPI_FUNC_CTRL_TERMSELECT | ULPI_FUNC_CTRL_RESET;
164 isp1704_write(isp, ULPI_SET(ULPI_FUNC_CTRL), r);
165 usleep_range(1000, 2000);
167 /* Read the line state */
168 if (!isp1704_read(isp, ULPI_DEBUG)) {
169 /* Disable strong pull-up on DP (1.5K) */
170 isp1704_write(isp, ULPI_CLR(ULPI_FUNC_CTRL),
171 ULPI_FUNC_CTRL_TERMSELECT);
175 /* Is it a charger or PS/2 connection */
177 /* Enable weak pull-up resistor on DP */
178 isp1704_write(isp, ULPI_SET(ISP1704_PWR_CTRL),
179 ISP1704_PWR_CTRL_DP_WKPU_EN);
181 /* Disable strong pull-up on DP (1.5K) */
182 isp1704_write(isp, ULPI_CLR(ULPI_FUNC_CTRL),
183 ULPI_FUNC_CTRL_TERMSELECT);
185 /* Enable weak pull-down resistor on DM */
186 isp1704_write(isp, ULPI_SET(ULPI_OTG_CTRL),
187 ULPI_OTG_CTRL_DM_PULLDOWN);
189 /* It's a charger if the line states are clear */
190 if (!(isp1704_read(isp, ULPI_DEBUG)))
193 /* Disable weak pull-up resistor on DP */
194 isp1704_write(isp, ULPI_CLR(ISP1704_PWR_CTRL),
195 ISP1704_PWR_CTRL_DP_WKPU_EN);
200 static inline int isp1704_charger_detect(struct isp1704_charger *isp)
202 unsigned long timeout;
206 pwr_ctrl = isp1704_read(isp, ISP1704_PWR_CTRL);
208 /* set SW control bit in PWR_CTRL register */
209 isp1704_write(isp, ISP1704_PWR_CTRL,
210 ISP1704_PWR_CTRL_SWCTRL);
212 /* enable manual charger detection */
213 isp1704_write(isp, ULPI_SET(ISP1704_PWR_CTRL),
214 ISP1704_PWR_CTRL_SWCTRL
215 | ISP1704_PWR_CTRL_DPVSRC_EN);
216 usleep_range(1000, 2000);
218 timeout = jiffies + msecs_to_jiffies(300);
220 /* Check if there is a charger */
221 if (isp1704_read(isp, ISP1704_PWR_CTRL)
222 & ISP1704_PWR_CTRL_VDAT_DET) {
223 ret = isp1704_charger_verify(isp);
226 } while (!time_after(jiffies, timeout) && isp->online);
228 /* recover original state */
229 isp1704_write(isp, ISP1704_PWR_CTRL, pwr_ctrl);
234 static void isp1704_charger_work(struct work_struct *data)
239 struct isp1704_charger *isp =
240 container_of(data, struct isp1704_charger, work);
241 static DEFINE_MUTEX(lock);
244 power = isp->max_power;
248 if (event != USB_EVENT_NONE)
249 isp1704_charger_set_power(isp, 1);
256 detect = isp1704_charger_detect(isp);
259 isp->present = detect;
260 isp->psy.type = isp1704_charger_type(isp);
263 switch (isp->psy.type) {
264 case POWER_SUPPLY_TYPE_USB_DCP:
265 isp->current_max = 1800;
267 case POWER_SUPPLY_TYPE_USB_CDP:
269 * Only 500mA here or high speed chirp
270 * handshaking may break
272 isp->current_max = 500;
274 case POWER_SUPPLY_TYPE_USB:
276 /* enable data pullups */
277 if (isp->phy->otg->gadget)
278 usb_gadget_connect(isp->phy->otg->gadget);
283 isp->current_max = 0;
285 isp->current_max = 0;
286 isp->psy.type = POWER_SUPPLY_TYPE_USB;
289 * Disable data pullups. We need to prevent the controller from
292 * FIXME: This is here to allow charger detection with Host/HUB
293 * chargers. The pullups may be enabled elsewhere, so this can
294 * not be the final solution.
296 if (isp->phy->otg->gadget)
297 usb_gadget_disconnect(isp->phy->otg->gadget);
299 isp1704_charger_set_power(isp, 0);
301 case USB_EVENT_ENUMERATED:
303 isp->current_max = 1800;
305 isp->current_max = power;
311 power_supply_changed(&isp->psy);
316 static int isp1704_notifier_call(struct notifier_block *nb,
317 unsigned long event, void *power)
319 struct isp1704_charger *isp =
320 container_of(nb, struct isp1704_charger, nb);
325 isp->max_power = *((unsigned *)power);
327 schedule_work(&isp->work);
332 static int isp1704_charger_get_property(struct power_supply *psy,
333 enum power_supply_property psp,
334 union power_supply_propval *val)
336 struct isp1704_charger *isp =
337 container_of(psy, struct isp1704_charger, psy);
340 case POWER_SUPPLY_PROP_PRESENT:
341 val->intval = isp->present;
343 case POWER_SUPPLY_PROP_ONLINE:
344 val->intval = isp->online;
346 case POWER_SUPPLY_PROP_CURRENT_MAX:
347 val->intval = isp->current_max;
349 case POWER_SUPPLY_PROP_MODEL_NAME:
350 val->strval = isp->model;
352 case POWER_SUPPLY_PROP_MANUFACTURER:
361 static enum power_supply_property power_props[] = {
362 POWER_SUPPLY_PROP_PRESENT,
363 POWER_SUPPLY_PROP_ONLINE,
364 POWER_SUPPLY_PROP_CURRENT_MAX,
365 POWER_SUPPLY_PROP_MODEL_NAME,
366 POWER_SUPPLY_PROP_MANUFACTURER,
369 static inline int isp1704_test_ulpi(struct isp1704_charger *isp)
376 /* Test ULPI interface */
377 ret = isp1704_write(isp, ULPI_SCRATCH, 0xaa);
381 ret = isp1704_read(isp, ULPI_SCRATCH);
388 /* Verify the product and vendor id matches */
389 vendor = isp1704_read(isp, ULPI_VENDOR_ID_LOW);
390 vendor |= isp1704_read(isp, ULPI_VENDOR_ID_HIGH) << 8;
391 if (vendor != NXP_VENDOR_ID)
394 product = isp1704_read(isp, ULPI_PRODUCT_ID_LOW);
395 product |= isp1704_read(isp, ULPI_PRODUCT_ID_HIGH) << 8;
397 for (i = 0; i < ARRAY_SIZE(isp170x_id); i++) {
398 if (product == isp170x_id[i]) {
399 sprintf(isp->model, "isp%x", product);
404 dev_err(isp->dev, "product id %x not matching known ids", product);
409 static int __devinit isp1704_charger_probe(struct platform_device *pdev)
411 struct isp1704_charger *isp;
414 isp = kzalloc(sizeof *isp, GFP_KERNEL);
418 isp->phy = usb_get_phy(USB_PHY_TYPE_USB2);
422 isp->dev = &pdev->dev;
423 platform_set_drvdata(pdev, isp);
425 isp1704_charger_set_power(isp, 1);
427 ret = isp1704_test_ulpi(isp);
431 isp->psy.name = "isp1704";
432 isp->psy.type = POWER_SUPPLY_TYPE_USB;
433 isp->psy.properties = power_props;
434 isp->psy.num_properties = ARRAY_SIZE(power_props);
435 isp->psy.get_property = isp1704_charger_get_property;
437 ret = power_supply_register(isp->dev, &isp->psy);
442 * REVISIT: using work in order to allow the usb notifications to be
443 * made atomically in the future.
445 INIT_WORK(&isp->work, isp1704_charger_work);
447 isp->nb.notifier_call = isp1704_notifier_call;
449 ret = usb_register_notifier(isp->phy, &isp->nb);
453 dev_info(isp->dev, "registered with product id %s\n", isp->model);
456 * Taking over the D+ pullup.
458 * FIXME: The device will be disconnected if it was already
459 * enumerated. The charger driver should be always loaded before any
462 if (isp->phy->otg->gadget)
463 usb_gadget_disconnect(isp->phy->otg->gadget);
465 /* Detect charger if VBUS is valid (the cable was already plugged). */
466 ret = isp1704_read(isp, ULPI_USB_INT_STS);
467 isp1704_charger_set_power(isp, 0);
468 if ((ret & ULPI_INT_VBUS_VALID) && !isp->phy->otg->default_a) {
469 isp->event = USB_EVENT_VBUS;
470 schedule_work(&isp->work);
475 power_supply_unregister(&isp->psy);
477 isp1704_charger_set_power(isp, 0);
478 usb_put_phy(isp->phy);
482 dev_err(&pdev->dev, "failed to register isp1704 with error %d\n", ret);
487 static int __devexit isp1704_charger_remove(struct platform_device *pdev)
489 struct isp1704_charger *isp = platform_get_drvdata(pdev);
491 usb_unregister_notifier(isp->phy, &isp->nb);
492 power_supply_unregister(&isp->psy);
493 usb_put_phy(isp->phy);
494 isp1704_charger_set_power(isp, 0);
500 static struct platform_driver isp1704_charger_driver = {
502 .name = "isp1704_charger",
504 .probe = isp1704_charger_probe,
505 .remove = __devexit_p(isp1704_charger_remove),
508 module_platform_driver(isp1704_charger_driver);
510 MODULE_ALIAS("platform:isp1704_charger");
511 MODULE_AUTHOR("Nokia Corporation");
512 MODULE_DESCRIPTION("ISP170x USB Charger driver");
513 MODULE_LICENSE("GPL");