2 * extcon-max8997.c - MAX8997 extcon driver to support MAX8997 MUIC
4 * Copyright (C) 2012 Samsung Electronics
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
18 #include <linux/kernel.h>
19 #include <linux/module.h>
20 #include <linux/i2c.h>
21 #include <linux/slab.h>
22 #include <linux/interrupt.h>
23 #include <linux/err.h>
24 #include <linux/platform_device.h>
25 #include <linux/kobject.h>
26 #include <linux/mfd/max8997.h>
27 #include <linux/mfd/max8997-private.h>
28 #include <linux/extcon.h>
29 #include <linux/irqdomain.h>
31 #define DEV_NAME "max8997-muic"
32 #define DELAY_MS_DEFAULT 20000 /* unit: millisecond */
34 enum max8997_muic_adc_debounce_time {
35 ADC_DEBOUNCE_TIME_0_5MS = 0, /* 0.5ms */
36 ADC_DEBOUNCE_TIME_10MS, /* 10ms */
37 ADC_DEBOUNCE_TIME_25MS, /* 25ms */
38 ADC_DEBOUNCE_TIME_38_62MS, /* 38.62ms */
41 struct max8997_muic_irq {
47 static struct max8997_muic_irq muic_irqs[] = {
48 { MAX8997_MUICIRQ_ADCError, "muic-ADCERROR" },
49 { MAX8997_MUICIRQ_ADCLow, "muic-ADCLOW" },
50 { MAX8997_MUICIRQ_ADC, "muic-ADC" },
51 { MAX8997_MUICIRQ_VBVolt, "muic-VBVOLT" },
52 { MAX8997_MUICIRQ_DBChg, "muic-DBCHG" },
53 { MAX8997_MUICIRQ_DCDTmr, "muic-DCDTMR" },
54 { MAX8997_MUICIRQ_ChgDetRun, "muic-CHGDETRUN" },
55 { MAX8997_MUICIRQ_ChgTyp, "muic-CHGTYP" },
56 { MAX8997_MUICIRQ_OVP, "muic-OVP" },
59 /* Define supported cable type */
60 enum max8997_muic_acc_type {
61 MAX8997_MUIC_ADC_GROUND = 0x0,
62 MAX8997_MUIC_ADC_MHL, /* MHL*/
63 MAX8997_MUIC_ADC_REMOTE_S1_BUTTON,
64 MAX8997_MUIC_ADC_REMOTE_S2_BUTTON,
65 MAX8997_MUIC_ADC_REMOTE_S3_BUTTON,
66 MAX8997_MUIC_ADC_REMOTE_S4_BUTTON,
67 MAX8997_MUIC_ADC_REMOTE_S5_BUTTON,
68 MAX8997_MUIC_ADC_REMOTE_S6_BUTTON,
69 MAX8997_MUIC_ADC_REMOTE_S7_BUTTON,
70 MAX8997_MUIC_ADC_REMOTE_S8_BUTTON,
71 MAX8997_MUIC_ADC_REMOTE_S9_BUTTON,
72 MAX8997_MUIC_ADC_REMOTE_S10_BUTTON,
73 MAX8997_MUIC_ADC_REMOTE_S11_BUTTON,
74 MAX8997_MUIC_ADC_REMOTE_S12_BUTTON,
75 MAX8997_MUIC_ADC_RESERVED_ACC_1,
76 MAX8997_MUIC_ADC_RESERVED_ACC_2,
77 MAX8997_MUIC_ADC_RESERVED_ACC_3,
78 MAX8997_MUIC_ADC_RESERVED_ACC_4,
79 MAX8997_MUIC_ADC_RESERVED_ACC_5,
80 MAX8997_MUIC_ADC_CEA936_AUDIO,
81 MAX8997_MUIC_ADC_PHONE_POWERED_DEV,
82 MAX8997_MUIC_ADC_TTY_CONVERTER,
83 MAX8997_MUIC_ADC_UART_CABLE,
84 MAX8997_MUIC_ADC_CEA936A_TYPE1_CHG,
85 MAX8997_MUIC_ADC_FACTORY_MODE_USB_OFF, /* JIG-USB-OFF */
86 MAX8997_MUIC_ADC_FACTORY_MODE_USB_ON, /* JIG-USB-ON */
87 MAX8997_MUIC_ADC_AV_CABLE_NOLOAD, /* DESKDOCK */
88 MAX8997_MUIC_ADC_CEA936A_TYPE2_CHG,
89 MAX8997_MUIC_ADC_FACTORY_MODE_UART_OFF, /* JIG-UART */
90 MAX8997_MUIC_ADC_FACTORY_MODE_UART_ON, /* CARDOCK */
91 MAX8997_MUIC_ADC_AUDIO_MODE_REMOTE,
92 MAX8997_MUIC_ADC_OPEN, /* OPEN */
95 enum max8997_muic_cable_group {
96 MAX8997_CABLE_GROUP_ADC = 0,
97 MAX8997_CABLE_GROUP_ADC_GND,
98 MAX8997_CABLE_GROUP_CHG,
99 MAX8997_CABLE_GROUP_VBVOLT,
102 enum max8997_muic_usb_type {
107 enum max8997_muic_charger_type {
108 MAX8997_CHARGER_TYPE_NONE = 0,
109 MAX8997_CHARGER_TYPE_USB,
110 MAX8997_CHARGER_TYPE_DOWNSTREAM_PORT,
111 MAX8997_CHARGER_TYPE_DEDICATED_CHG,
112 MAX8997_CHARGER_TYPE_500MA,
113 MAX8997_CHARGER_TYPE_1A,
114 MAX8997_CHARGER_TYPE_DEAD_BATTERY = 7,
117 struct max8997_muic_info {
119 struct i2c_client *muic;
120 struct extcon_dev *edev;
126 struct work_struct irq_work;
129 struct max8997_muic_platform_data *muic_pdata;
130 enum max8997_muic_charger_type pre_charger_type;
133 * Use delayed workqueue to detect cable state and then
134 * notify cable state to notifiee/platform through uevent.
135 * After completing the booting of platform, the extcon provider
136 * driver should notify cable state to upper layer.
138 struct delayed_work wq_detcable;
141 * Default usb/uart path whether UART/USB or AUX_UART/AUX_USB
142 * h/w path of COMP2/COMN1 on CONTROL1 register.
148 static const unsigned int max8997_extcon_cable[] = {
154 EXTCON_CHARGE_DOWNSTREAM,
162 * max8997_muic_set_debounce_time - Set the debounce time of ADC
163 * @info: the instance including private data of max8997 MUIC
164 * @time: the debounce time of ADC
166 static int max8997_muic_set_debounce_time(struct max8997_muic_info *info,
167 enum max8997_muic_adc_debounce_time time)
172 case ADC_DEBOUNCE_TIME_0_5MS:
173 case ADC_DEBOUNCE_TIME_10MS:
174 case ADC_DEBOUNCE_TIME_25MS:
175 case ADC_DEBOUNCE_TIME_38_62MS:
176 ret = max8997_update_reg(info->muic,
177 MAX8997_MUIC_REG_CONTROL3,
178 time << CONTROL3_ADCDBSET_SHIFT,
179 CONTROL3_ADCDBSET_MASK);
181 dev_err(info->dev, "failed to set ADC debounce time\n");
186 dev_err(info->dev, "invalid ADC debounce time\n");
194 * max8997_muic_set_path - Set hardware line according to attached cable
195 * @info: the instance including private data of max8997 MUIC
196 * @value: the path according to attached cable
197 * @attached: the state of cable (true:attached, false:detached)
199 * The max8997 MUIC device share outside H/W line among a varity of cables,
200 * so this function set internal path of H/W line according to the type of
203 static int max8997_muic_set_path(struct max8997_muic_info *info,
204 u8 val, bool attached)
212 ctrl1 = CONTROL1_SW_OPEN;
214 ret = max8997_update_reg(info->muic,
215 MAX8997_MUIC_REG_CONTROL1, ctrl1, COMP_SW_MASK);
217 dev_err(info->dev, "failed to update MUIC register\n");
222 ctrl2 |= CONTROL2_CPEN_MASK; /* LowPwr=0, CPEn=1 */
224 ctrl2 |= CONTROL2_LOWPWR_MASK; /* LowPwr=1, CPEn=0 */
226 ret = max8997_update_reg(info->muic,
227 MAX8997_MUIC_REG_CONTROL2, ctrl2,
228 CONTROL2_LOWPWR_MASK | CONTROL2_CPEN_MASK);
230 dev_err(info->dev, "failed to update MUIC register\n");
235 "CONTROL1 : 0x%02x, CONTROL2 : 0x%02x, state : %s\n",
236 ctrl1, ctrl2, attached ? "attached" : "detached");
242 * max8997_muic_get_cable_type - Return cable type and check cable state
243 * @info: the instance including private data of max8997 MUIC
244 * @group: the path according to attached cable
245 * @attached: store cable state and return
247 * This function check the cable state either attached or detached,
248 * and then divide precise type of cable according to cable group.
249 * - MAX8997_CABLE_GROUP_ADC
250 * - MAX8997_CABLE_GROUP_CHG
252 static int max8997_muic_get_cable_type(struct max8997_muic_info *info,
253 enum max8997_muic_cable_group group, bool *attached)
260 case MAX8997_CABLE_GROUP_ADC:
262 * Read ADC value to check cable type and decide cable state
263 * according to cable type
265 adc = info->status[0] & STATUS1_ADC_MASK;
266 adc >>= STATUS1_ADC_SHIFT;
269 * Check current cable state/cable type and store cable type
270 * (info->prev_cable_type) for handling cable when cable is
273 if (adc == MAX8997_MUIC_ADC_OPEN) {
276 cable_type = info->prev_cable_type;
277 info->prev_cable_type = MAX8997_MUIC_ADC_OPEN;
281 cable_type = info->prev_cable_type = adc;
284 case MAX8997_CABLE_GROUP_CHG:
286 * Read charger type to check cable type and decide cable state
287 * according to type of charger cable.
289 chg_type = info->status[1] & STATUS2_CHGTYP_MASK;
290 chg_type >>= STATUS2_CHGTYP_SHIFT;
292 if (chg_type == MAX8997_CHARGER_TYPE_NONE) {
295 cable_type = info->prev_chg_type;
296 info->prev_chg_type = MAX8997_CHARGER_TYPE_NONE;
301 * Check current cable state/cable type and store cable
302 * type(info->prev_chg_type) for handling cable when
303 * charger cable is detached.
305 cable_type = info->prev_chg_type = chg_type;
310 dev_err(info->dev, "Unknown cable group (%d)\n", group);
311 cable_type = -EINVAL;
318 static int max8997_muic_handle_usb(struct max8997_muic_info *info,
319 enum max8997_muic_usb_type usb_type, bool attached)
323 if (usb_type == MAX8997_USB_HOST) {
324 ret = max8997_muic_set_path(info, info->path_usb, attached);
326 dev_err(info->dev, "failed to update muic register\n");
332 case MAX8997_USB_HOST:
333 extcon_set_cable_state_(info->edev, EXTCON_USB_HOST, attached);
335 case MAX8997_USB_DEVICE:
336 extcon_set_cable_state_(info->edev, EXTCON_USB, attached);
339 dev_err(info->dev, "failed to detect %s usb cable\n",
340 attached ? "attached" : "detached");
347 static int max8997_muic_handle_dock(struct max8997_muic_info *info,
348 int cable_type, bool attached)
352 ret = max8997_muic_set_path(info, CONTROL1_SW_AUDIO, attached);
354 dev_err(info->dev, "failed to update muic register\n");
358 switch (cable_type) {
359 case MAX8997_MUIC_ADC_AV_CABLE_NOLOAD:
360 case MAX8997_MUIC_ADC_FACTORY_MODE_UART_ON:
361 extcon_set_cable_state_(info->edev, EXTCON_DOCK, attached);
364 dev_err(info->dev, "failed to detect %s dock device\n",
365 attached ? "attached" : "detached");
372 static int max8997_muic_handle_jig_uart(struct max8997_muic_info *info,
378 ret = max8997_muic_set_path(info, info->path_uart, attached);
380 dev_err(info->dev, "failed to update muic register\n");
384 extcon_set_cable_state_(info->edev, EXTCON_JIG, attached);
389 static int max8997_muic_adc_handler(struct max8997_muic_info *info)
395 /* Check cable state which is either detached or attached */
396 cable_type = max8997_muic_get_cable_type(info,
397 MAX8997_CABLE_GROUP_ADC, &attached);
399 switch (cable_type) {
400 case MAX8997_MUIC_ADC_GROUND:
401 ret = max8997_muic_handle_usb(info, MAX8997_USB_HOST, attached);
405 case MAX8997_MUIC_ADC_MHL:
406 extcon_set_cable_state_(info->edev, EXTCON_MHL, attached);
408 case MAX8997_MUIC_ADC_FACTORY_MODE_USB_OFF:
409 case MAX8997_MUIC_ADC_FACTORY_MODE_USB_ON:
410 ret = max8997_muic_handle_usb(info,
411 MAX8997_USB_DEVICE, attached);
415 case MAX8997_MUIC_ADC_AV_CABLE_NOLOAD:
416 case MAX8997_MUIC_ADC_FACTORY_MODE_UART_ON:
417 ret = max8997_muic_handle_dock(info, cable_type, attached);
421 case MAX8997_MUIC_ADC_FACTORY_MODE_UART_OFF:
422 ret = max8997_muic_handle_jig_uart(info, attached);
424 case MAX8997_MUIC_ADC_REMOTE_S1_BUTTON:
425 case MAX8997_MUIC_ADC_REMOTE_S2_BUTTON:
426 case MAX8997_MUIC_ADC_REMOTE_S3_BUTTON:
427 case MAX8997_MUIC_ADC_REMOTE_S4_BUTTON:
428 case MAX8997_MUIC_ADC_REMOTE_S5_BUTTON:
429 case MAX8997_MUIC_ADC_REMOTE_S6_BUTTON:
430 case MAX8997_MUIC_ADC_REMOTE_S7_BUTTON:
431 case MAX8997_MUIC_ADC_REMOTE_S8_BUTTON:
432 case MAX8997_MUIC_ADC_REMOTE_S9_BUTTON:
433 case MAX8997_MUIC_ADC_REMOTE_S10_BUTTON:
434 case MAX8997_MUIC_ADC_REMOTE_S11_BUTTON:
435 case MAX8997_MUIC_ADC_REMOTE_S12_BUTTON:
436 case MAX8997_MUIC_ADC_RESERVED_ACC_1:
437 case MAX8997_MUIC_ADC_RESERVED_ACC_2:
438 case MAX8997_MUIC_ADC_RESERVED_ACC_3:
439 case MAX8997_MUIC_ADC_RESERVED_ACC_4:
440 case MAX8997_MUIC_ADC_RESERVED_ACC_5:
441 case MAX8997_MUIC_ADC_CEA936_AUDIO:
442 case MAX8997_MUIC_ADC_PHONE_POWERED_DEV:
443 case MAX8997_MUIC_ADC_TTY_CONVERTER:
444 case MAX8997_MUIC_ADC_UART_CABLE:
445 case MAX8997_MUIC_ADC_CEA936A_TYPE1_CHG:
446 case MAX8997_MUIC_ADC_CEA936A_TYPE2_CHG:
447 case MAX8997_MUIC_ADC_AUDIO_MODE_REMOTE:
449 * This cable isn't used in general case if it is specially
450 * needed to detect additional cable, should implement
451 * proper operation when this cable is attached/detached.
454 "cable is %s but it isn't used (type:0x%x)\n",
455 attached ? "attached" : "detached", cable_type);
459 "failed to detect %s unknown cable (type:0x%x)\n",
460 attached ? "attached" : "detached", cable_type);
467 static int max8997_muic_chg_handler(struct max8997_muic_info *info)
473 chg_type = max8997_muic_get_cable_type(info,
474 MAX8997_CABLE_GROUP_CHG, &attached);
477 case MAX8997_CHARGER_TYPE_NONE:
479 case MAX8997_CHARGER_TYPE_USB:
480 adc = info->status[0] & STATUS1_ADC_MASK;
481 adc >>= STATUS1_ADC_SHIFT;
483 if ((adc & STATUS1_ADC_MASK) == MAX8997_MUIC_ADC_OPEN) {
484 max8997_muic_handle_usb(info,
485 MAX8997_USB_DEVICE, attached);
488 case MAX8997_CHARGER_TYPE_DOWNSTREAM_PORT:
489 extcon_set_cable_state_(info->edev, EXTCON_CHARGE_DOWNSTREAM,
492 case MAX8997_CHARGER_TYPE_DEDICATED_CHG:
493 extcon_set_cable_state_(info->edev, EXTCON_TA, attached);
495 case MAX8997_CHARGER_TYPE_500MA:
496 extcon_set_cable_state_(info->edev, EXTCON_SLOW_CHARGER,
499 case MAX8997_CHARGER_TYPE_1A:
500 extcon_set_cable_state_(info->edev, EXTCON_FAST_CHARGER,
505 "failed to detect %s unknown chg cable (type:0x%x)\n",
506 attached ? "attached" : "detached", chg_type);
513 static void max8997_muic_irq_work(struct work_struct *work)
515 struct max8997_muic_info *info = container_of(work,
516 struct max8997_muic_info, irq_work);
523 mutex_lock(&info->mutex);
525 for (i = 0; i < ARRAY_SIZE(muic_irqs); i++)
526 if (info->irq == muic_irqs[i].virq)
527 irq_type = muic_irqs[i].irq;
529 ret = max8997_bulk_read(info->muic, MAX8997_MUIC_REG_STATUS1,
532 dev_err(info->dev, "failed to read muic register\n");
533 mutex_unlock(&info->mutex);
538 case MAX8997_MUICIRQ_ADCError:
539 case MAX8997_MUICIRQ_ADCLow:
540 case MAX8997_MUICIRQ_ADC:
541 /* Handle all of cable except for charger cable */
542 ret = max8997_muic_adc_handler(info);
544 case MAX8997_MUICIRQ_VBVolt:
545 case MAX8997_MUICIRQ_DBChg:
546 case MAX8997_MUICIRQ_DCDTmr:
547 case MAX8997_MUICIRQ_ChgDetRun:
548 case MAX8997_MUICIRQ_ChgTyp:
549 /* Handle charger cable */
550 ret = max8997_muic_chg_handler(info);
552 case MAX8997_MUICIRQ_OVP:
555 dev_info(info->dev, "misc interrupt: irq %d occurred\n",
557 mutex_unlock(&info->mutex);
562 dev_err(info->dev, "failed to handle MUIC interrupt\n");
564 mutex_unlock(&info->mutex);
567 static irqreturn_t max8997_muic_irq_handler(int irq, void *data)
569 struct max8997_muic_info *info = data;
571 dev_dbg(info->dev, "irq:%d\n", irq);
574 schedule_work(&info->irq_work);
579 static int max8997_muic_detect_dev(struct max8997_muic_info *info)
586 mutex_lock(&info->mutex);
588 /* Read STATUSx register to detect accessory */
589 ret = max8997_bulk_read(info->muic,
590 MAX8997_MUIC_REG_STATUS1, 2, info->status);
592 dev_err(info->dev, "failed to read MUIC register\n");
593 mutex_unlock(&info->mutex);
597 adc = max8997_muic_get_cable_type(info, MAX8997_CABLE_GROUP_ADC,
599 if (attached && adc != MAX8997_MUIC_ADC_OPEN) {
600 ret = max8997_muic_adc_handler(info);
602 dev_err(info->dev, "Cannot detect ADC cable\n");
603 mutex_unlock(&info->mutex);
608 chg_type = max8997_muic_get_cable_type(info, MAX8997_CABLE_GROUP_CHG,
610 if (attached && chg_type != MAX8997_CHARGER_TYPE_NONE) {
611 ret = max8997_muic_chg_handler(info);
613 dev_err(info->dev, "Cannot detect charger cable\n");
614 mutex_unlock(&info->mutex);
619 mutex_unlock(&info->mutex);
624 static void max8997_muic_detect_cable_wq(struct work_struct *work)
626 struct max8997_muic_info *info = container_of(to_delayed_work(work),
627 struct max8997_muic_info, wq_detcable);
630 ret = max8997_muic_detect_dev(info);
632 dev_err(info->dev, "failed to detect cable type\n");
635 static int max8997_muic_probe(struct platform_device *pdev)
637 struct max8997_dev *max8997 = dev_get_drvdata(pdev->dev.parent);
638 struct max8997_platform_data *pdata = dev_get_platdata(max8997->dev);
639 struct max8997_muic_info *info;
643 info = devm_kzalloc(&pdev->dev, sizeof(struct max8997_muic_info),
648 info->dev = &pdev->dev;
649 info->muic = max8997->muic;
651 platform_set_drvdata(pdev, info);
652 mutex_init(&info->mutex);
654 INIT_WORK(&info->irq_work, max8997_muic_irq_work);
656 for (i = 0; i < ARRAY_SIZE(muic_irqs); i++) {
657 struct max8997_muic_irq *muic_irq = &muic_irqs[i];
658 unsigned int virq = 0;
660 virq = irq_create_mapping(max8997->irq_domain, muic_irq->irq);
665 muic_irq->virq = virq;
667 ret = request_threaded_irq(virq, NULL,
668 max8997_muic_irq_handler,
670 muic_irq->name, info);
673 "failed: irq request (IRQ: %d, error :%d)\n",
679 /* External connector */
680 info->edev = devm_extcon_dev_allocate(&pdev->dev, max8997_extcon_cable);
681 if (IS_ERR(info->edev)) {
682 dev_err(&pdev->dev, "failed to allocate memory for extcon\n");
687 ret = devm_extcon_dev_register(&pdev->dev, info->edev);
689 dev_err(&pdev->dev, "failed to register extcon device\n");
693 if (pdata && pdata->muic_pdata) {
694 struct max8997_muic_platform_data *muic_pdata
697 /* Initialize registers according to platform data */
698 for (i = 0; i < muic_pdata->num_init_data; i++) {
699 max8997_write_reg(info->muic,
700 muic_pdata->init_data[i].addr,
701 muic_pdata->init_data[i].data);
705 * Default usb/uart path whether UART/USB or AUX_UART/AUX_USB
706 * h/w path of COMP2/COMN1 on CONTROL1 register.
708 if (muic_pdata->path_uart)
709 info->path_uart = muic_pdata->path_uart;
711 info->path_uart = CONTROL1_SW_UART;
713 if (muic_pdata->path_usb)
714 info->path_usb = muic_pdata->path_usb;
716 info->path_usb = CONTROL1_SW_USB;
719 * Default delay time for detecting cable state
720 * after certain time.
722 if (muic_pdata->detcable_delay_ms)
724 msecs_to_jiffies(muic_pdata->detcable_delay_ms);
726 delay_jiffies = msecs_to_jiffies(DELAY_MS_DEFAULT);
728 info->path_uart = CONTROL1_SW_UART;
729 info->path_usb = CONTROL1_SW_USB;
730 delay_jiffies = msecs_to_jiffies(DELAY_MS_DEFAULT);
733 /* Set initial path for UART */
734 max8997_muic_set_path(info, info->path_uart, true);
736 /* Set ADC debounce time */
737 max8997_muic_set_debounce_time(info, ADC_DEBOUNCE_TIME_25MS);
740 * Detect accessory after completing the initialization of platform
742 * - Use delayed workqueue to detect cable state and then
743 * notify cable state to notifiee/platform through uevent.
744 * After completing the booting of platform, the extcon provider
745 * driver should notify cable state to upper layer.
747 INIT_DELAYED_WORK(&info->wq_detcable, max8997_muic_detect_cable_wq);
748 queue_delayed_work(system_power_efficient_wq, &info->wq_detcable,
755 free_irq(muic_irqs[i].virq, info);
759 static int max8997_muic_remove(struct platform_device *pdev)
761 struct max8997_muic_info *info = platform_get_drvdata(pdev);
764 for (i = 0; i < ARRAY_SIZE(muic_irqs); i++)
765 free_irq(muic_irqs[i].virq, info);
766 cancel_work_sync(&info->irq_work);
771 static struct platform_driver max8997_muic_driver = {
775 .probe = max8997_muic_probe,
776 .remove = max8997_muic_remove,
779 module_platform_driver(max8997_muic_driver);
781 MODULE_DESCRIPTION("Maxim MAX8997 Extcon driver");
783 MODULE_LICENSE("GPL");