1 // SPDX-License-Identifier: GPL-2.0+
3 // extcon-max8997.c - MAX8997 extcon driver to support MAX8997 MUIC
5 // Copyright (C) 2012 Samsung Electronics
6 // Donggeun Kim <dg77.kim@samsung.com>
8 #include <linux/kernel.h>
9 #include <linux/module.h>
10 #include <linux/i2c.h>
11 #include <linux/slab.h>
12 #include <linux/interrupt.h>
13 #include <linux/err.h>
14 #include <linux/platform_device.h>
15 #include <linux/kobject.h>
16 #include <linux/mfd/max8997.h>
17 #include <linux/mfd/max8997-private.h>
18 #include <linux/extcon-provider.h>
19 #include <linux/irqdomain.h>
21 #define DEV_NAME "max8997-muic"
22 #define DELAY_MS_DEFAULT 20000 /* unit: millisecond */
24 enum max8997_muic_adc_debounce_time {
25 ADC_DEBOUNCE_TIME_0_5MS = 0, /* 0.5ms */
26 ADC_DEBOUNCE_TIME_10MS, /* 10ms */
27 ADC_DEBOUNCE_TIME_25MS, /* 25ms */
28 ADC_DEBOUNCE_TIME_38_62MS, /* 38.62ms */
31 struct max8997_muic_irq {
37 static struct max8997_muic_irq muic_irqs[] = {
38 { MAX8997_MUICIRQ_ADCError, "muic-ADCERROR" },
39 { MAX8997_MUICIRQ_ADCLow, "muic-ADCLOW" },
40 { MAX8997_MUICIRQ_ADC, "muic-ADC" },
41 { MAX8997_MUICIRQ_VBVolt, "muic-VBVOLT" },
42 { MAX8997_MUICIRQ_DBChg, "muic-DBCHG" },
43 { MAX8997_MUICIRQ_DCDTmr, "muic-DCDTMR" },
44 { MAX8997_MUICIRQ_ChgDetRun, "muic-CHGDETRUN" },
45 { MAX8997_MUICIRQ_ChgTyp, "muic-CHGTYP" },
46 { MAX8997_MUICIRQ_OVP, "muic-OVP" },
49 /* Define supported cable type */
50 enum max8997_muic_acc_type {
51 MAX8997_MUIC_ADC_GROUND = 0x0,
52 MAX8997_MUIC_ADC_MHL, /* MHL*/
53 MAX8997_MUIC_ADC_REMOTE_S1_BUTTON,
54 MAX8997_MUIC_ADC_REMOTE_S2_BUTTON,
55 MAX8997_MUIC_ADC_REMOTE_S3_BUTTON,
56 MAX8997_MUIC_ADC_REMOTE_S4_BUTTON,
57 MAX8997_MUIC_ADC_REMOTE_S5_BUTTON,
58 MAX8997_MUIC_ADC_REMOTE_S6_BUTTON,
59 MAX8997_MUIC_ADC_REMOTE_S7_BUTTON,
60 MAX8997_MUIC_ADC_REMOTE_S8_BUTTON,
61 MAX8997_MUIC_ADC_REMOTE_S9_BUTTON,
62 MAX8997_MUIC_ADC_REMOTE_S10_BUTTON,
63 MAX8997_MUIC_ADC_REMOTE_S11_BUTTON,
64 MAX8997_MUIC_ADC_REMOTE_S12_BUTTON,
65 MAX8997_MUIC_ADC_RESERVED_ACC_1,
66 MAX8997_MUIC_ADC_RESERVED_ACC_2,
67 MAX8997_MUIC_ADC_RESERVED_ACC_3,
68 MAX8997_MUIC_ADC_RESERVED_ACC_4,
69 MAX8997_MUIC_ADC_RESERVED_ACC_5,
70 MAX8997_MUIC_ADC_CEA936_AUDIO,
71 MAX8997_MUIC_ADC_PHONE_POWERED_DEV,
72 MAX8997_MUIC_ADC_TTY_CONVERTER,
73 MAX8997_MUIC_ADC_UART_CABLE,
74 MAX8997_MUIC_ADC_CEA936A_TYPE1_CHG,
75 MAX8997_MUIC_ADC_FACTORY_MODE_USB_OFF, /* JIG-USB-OFF */
76 MAX8997_MUIC_ADC_FACTORY_MODE_USB_ON, /* JIG-USB-ON */
77 MAX8997_MUIC_ADC_AV_CABLE_NOLOAD, /* DESKDOCK */
78 MAX8997_MUIC_ADC_CEA936A_TYPE2_CHG,
79 MAX8997_MUIC_ADC_FACTORY_MODE_UART_OFF, /* JIG-UART */
80 MAX8997_MUIC_ADC_FACTORY_MODE_UART_ON, /* CARDOCK */
81 MAX8997_MUIC_ADC_AUDIO_MODE_REMOTE,
82 MAX8997_MUIC_ADC_OPEN, /* OPEN */
85 enum max8997_muic_cable_group {
86 MAX8997_CABLE_GROUP_ADC = 0,
87 MAX8997_CABLE_GROUP_ADC_GND,
88 MAX8997_CABLE_GROUP_CHG,
89 MAX8997_CABLE_GROUP_VBVOLT,
92 enum max8997_muic_usb_type {
97 enum max8997_muic_charger_type {
98 MAX8997_CHARGER_TYPE_NONE = 0,
99 MAX8997_CHARGER_TYPE_USB,
100 MAX8997_CHARGER_TYPE_DOWNSTREAM_PORT,
101 MAX8997_CHARGER_TYPE_DEDICATED_CHG,
102 MAX8997_CHARGER_TYPE_500MA,
103 MAX8997_CHARGER_TYPE_1A,
104 MAX8997_CHARGER_TYPE_DEAD_BATTERY = 7,
107 struct max8997_muic_info {
109 struct i2c_client *muic;
110 struct extcon_dev *edev;
116 struct work_struct irq_work;
119 struct max8997_muic_platform_data *muic_pdata;
120 enum max8997_muic_charger_type pre_charger_type;
123 * Use delayed workqueue to detect cable state and then
124 * notify cable state to notifiee/platform through uevent.
125 * After completing the booting of platform, the extcon provider
126 * driver should notify cable state to upper layer.
128 struct delayed_work wq_detcable;
131 * Default usb/uart path whether UART/USB or AUX_UART/AUX_USB
132 * h/w path of COMP2/COMN1 on CONTROL1 register.
138 static const unsigned int max8997_extcon_cable[] = {
153 * max8997_muic_set_debounce_time - Set the debounce time of ADC
154 * @info: the instance including private data of max8997 MUIC
155 * @time: the debounce time of ADC
157 static int max8997_muic_set_debounce_time(struct max8997_muic_info *info,
158 enum max8997_muic_adc_debounce_time time)
163 case ADC_DEBOUNCE_TIME_0_5MS:
164 case ADC_DEBOUNCE_TIME_10MS:
165 case ADC_DEBOUNCE_TIME_25MS:
166 case ADC_DEBOUNCE_TIME_38_62MS:
167 ret = max8997_update_reg(info->muic,
168 MAX8997_MUIC_REG_CONTROL3,
169 time << CONTROL3_ADCDBSET_SHIFT,
170 CONTROL3_ADCDBSET_MASK);
172 dev_err(info->dev, "failed to set ADC debounce time\n");
177 dev_err(info->dev, "invalid ADC debounce time\n");
185 * max8997_muic_set_path - Set hardware line according to attached cable
186 * @info: the instance including private data of max8997 MUIC
187 * @value: the path according to attached cable
188 * @attached: the state of cable (true:attached, false:detached)
190 * The max8997 MUIC device share outside H/W line among a varity of cables,
191 * so this function set internal path of H/W line according to the type of
194 static int max8997_muic_set_path(struct max8997_muic_info *info,
195 u8 val, bool attached)
203 ctrl1 = CONTROL1_SW_OPEN;
205 ret = max8997_update_reg(info->muic,
206 MAX8997_MUIC_REG_CONTROL1, ctrl1, COMP_SW_MASK);
208 dev_err(info->dev, "failed to update MUIC register\n");
213 ctrl2 |= CONTROL2_CPEN_MASK; /* LowPwr=0, CPEn=1 */
215 ctrl2 |= CONTROL2_LOWPWR_MASK; /* LowPwr=1, CPEn=0 */
217 ret = max8997_update_reg(info->muic,
218 MAX8997_MUIC_REG_CONTROL2, ctrl2,
219 CONTROL2_LOWPWR_MASK | CONTROL2_CPEN_MASK);
221 dev_err(info->dev, "failed to update MUIC register\n");
226 "CONTROL1 : 0x%02x, CONTROL2 : 0x%02x, state : %s\n",
227 ctrl1, ctrl2, attached ? "attached" : "detached");
233 * max8997_muic_get_cable_type - Return cable type and check cable state
234 * @info: the instance including private data of max8997 MUIC
235 * @group: the path according to attached cable
236 * @attached: store cable state and return
238 * This function check the cable state either attached or detached,
239 * and then divide precise type of cable according to cable group.
240 * - MAX8997_CABLE_GROUP_ADC
241 * - MAX8997_CABLE_GROUP_CHG
243 static int max8997_muic_get_cable_type(struct max8997_muic_info *info,
244 enum max8997_muic_cable_group group, bool *attached)
251 case MAX8997_CABLE_GROUP_ADC:
253 * Read ADC value to check cable type and decide cable state
254 * according to cable type
256 adc = info->status[0] & STATUS1_ADC_MASK;
257 adc >>= STATUS1_ADC_SHIFT;
260 * Check current cable state/cable type and store cable type
261 * (info->prev_cable_type) for handling cable when cable is
264 if (adc == MAX8997_MUIC_ADC_OPEN) {
267 cable_type = info->prev_cable_type;
268 info->prev_cable_type = MAX8997_MUIC_ADC_OPEN;
272 cable_type = info->prev_cable_type = adc;
275 case MAX8997_CABLE_GROUP_CHG:
277 * Read charger type to check cable type and decide cable state
278 * according to type of charger cable.
280 chg_type = info->status[1] & STATUS2_CHGTYP_MASK;
281 chg_type >>= STATUS2_CHGTYP_SHIFT;
283 if (chg_type == MAX8997_CHARGER_TYPE_NONE) {
286 cable_type = info->prev_chg_type;
287 info->prev_chg_type = MAX8997_CHARGER_TYPE_NONE;
292 * Check current cable state/cable type and store cable
293 * type(info->prev_chg_type) for handling cable when
294 * charger cable is detached.
296 cable_type = info->prev_chg_type = chg_type;
301 dev_err(info->dev, "Unknown cable group (%d)\n", group);
302 cable_type = -EINVAL;
309 static int max8997_muic_handle_usb(struct max8997_muic_info *info,
310 enum max8997_muic_usb_type usb_type, bool attached)
314 if (usb_type == MAX8997_USB_HOST) {
315 ret = max8997_muic_set_path(info, info->path_usb, attached);
317 dev_err(info->dev, "failed to update muic register\n");
323 case MAX8997_USB_HOST:
324 extcon_set_state_sync(info->edev, EXTCON_USB_HOST, attached);
326 case MAX8997_USB_DEVICE:
327 extcon_set_state_sync(info->edev, EXTCON_USB, attached);
328 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_SDP,
332 dev_err(info->dev, "failed to detect %s usb cable\n",
333 attached ? "attached" : "detached");
340 static int max8997_muic_handle_dock(struct max8997_muic_info *info,
341 int cable_type, bool attached)
345 ret = max8997_muic_set_path(info, CONTROL1_SW_AUDIO, attached);
347 dev_err(info->dev, "failed to update muic register\n");
351 switch (cable_type) {
352 case MAX8997_MUIC_ADC_AV_CABLE_NOLOAD:
353 case MAX8997_MUIC_ADC_FACTORY_MODE_UART_ON:
354 extcon_set_state_sync(info->edev, EXTCON_DOCK, attached);
357 dev_err(info->dev, "failed to detect %s dock device\n",
358 attached ? "attached" : "detached");
365 static int max8997_muic_handle_jig_uart(struct max8997_muic_info *info,
371 ret = max8997_muic_set_path(info, info->path_uart, attached);
373 dev_err(info->dev, "failed to update muic register\n");
377 extcon_set_state_sync(info->edev, EXTCON_JIG, attached);
382 static int max8997_muic_adc_handler(struct max8997_muic_info *info)
388 /* Check cable state which is either detached or attached */
389 cable_type = max8997_muic_get_cable_type(info,
390 MAX8997_CABLE_GROUP_ADC, &attached);
392 switch (cable_type) {
393 case MAX8997_MUIC_ADC_GROUND:
394 ret = max8997_muic_handle_usb(info, MAX8997_USB_HOST, attached);
398 case MAX8997_MUIC_ADC_MHL:
399 extcon_set_state_sync(info->edev, EXTCON_DISP_MHL, attached);
401 case MAX8997_MUIC_ADC_FACTORY_MODE_USB_OFF:
402 case MAX8997_MUIC_ADC_FACTORY_MODE_USB_ON:
403 ret = max8997_muic_handle_usb(info,
404 MAX8997_USB_DEVICE, attached);
408 case MAX8997_MUIC_ADC_AV_CABLE_NOLOAD:
409 case MAX8997_MUIC_ADC_FACTORY_MODE_UART_ON:
410 ret = max8997_muic_handle_dock(info, cable_type, attached);
414 case MAX8997_MUIC_ADC_FACTORY_MODE_UART_OFF:
415 ret = max8997_muic_handle_jig_uart(info, attached);
417 case MAX8997_MUIC_ADC_REMOTE_S1_BUTTON:
418 case MAX8997_MUIC_ADC_REMOTE_S2_BUTTON:
419 case MAX8997_MUIC_ADC_REMOTE_S3_BUTTON:
420 case MAX8997_MUIC_ADC_REMOTE_S4_BUTTON:
421 case MAX8997_MUIC_ADC_REMOTE_S5_BUTTON:
422 case MAX8997_MUIC_ADC_REMOTE_S6_BUTTON:
423 case MAX8997_MUIC_ADC_REMOTE_S7_BUTTON:
424 case MAX8997_MUIC_ADC_REMOTE_S8_BUTTON:
425 case MAX8997_MUIC_ADC_REMOTE_S9_BUTTON:
426 case MAX8997_MUIC_ADC_REMOTE_S10_BUTTON:
427 case MAX8997_MUIC_ADC_REMOTE_S11_BUTTON:
428 case MAX8997_MUIC_ADC_REMOTE_S12_BUTTON:
429 case MAX8997_MUIC_ADC_RESERVED_ACC_1:
430 case MAX8997_MUIC_ADC_RESERVED_ACC_2:
431 case MAX8997_MUIC_ADC_RESERVED_ACC_3:
432 case MAX8997_MUIC_ADC_RESERVED_ACC_4:
433 case MAX8997_MUIC_ADC_RESERVED_ACC_5:
434 case MAX8997_MUIC_ADC_CEA936_AUDIO:
435 case MAX8997_MUIC_ADC_PHONE_POWERED_DEV:
436 case MAX8997_MUIC_ADC_TTY_CONVERTER:
437 case MAX8997_MUIC_ADC_UART_CABLE:
438 case MAX8997_MUIC_ADC_CEA936A_TYPE1_CHG:
439 case MAX8997_MUIC_ADC_CEA936A_TYPE2_CHG:
440 case MAX8997_MUIC_ADC_AUDIO_MODE_REMOTE:
442 * This cable isn't used in general case if it is specially
443 * needed to detect additional cable, should implement
444 * proper operation when this cable is attached/detached.
447 "cable is %s but it isn't used (type:0x%x)\n",
448 attached ? "attached" : "detached", cable_type);
452 "failed to detect %s unknown cable (type:0x%x)\n",
453 attached ? "attached" : "detached", cable_type);
460 static int max8997_muic_chg_handler(struct max8997_muic_info *info)
466 chg_type = max8997_muic_get_cable_type(info,
467 MAX8997_CABLE_GROUP_CHG, &attached);
470 case MAX8997_CHARGER_TYPE_NONE:
472 case MAX8997_CHARGER_TYPE_USB:
473 adc = info->status[0] & STATUS1_ADC_MASK;
474 adc >>= STATUS1_ADC_SHIFT;
476 if ((adc & STATUS1_ADC_MASK) == MAX8997_MUIC_ADC_OPEN) {
477 max8997_muic_handle_usb(info,
478 MAX8997_USB_DEVICE, attached);
481 case MAX8997_CHARGER_TYPE_DOWNSTREAM_PORT:
482 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_CDP,
485 case MAX8997_CHARGER_TYPE_DEDICATED_CHG:
486 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_DCP,
489 case MAX8997_CHARGER_TYPE_500MA:
490 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_SLOW,
493 case MAX8997_CHARGER_TYPE_1A:
494 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_FAST,
499 "failed to detect %s unknown chg cable (type:0x%x)\n",
500 attached ? "attached" : "detached", chg_type);
507 static void max8997_muic_irq_work(struct work_struct *work)
509 struct max8997_muic_info *info = container_of(work,
510 struct max8997_muic_info, irq_work);
517 mutex_lock(&info->mutex);
519 for (i = 0; i < ARRAY_SIZE(muic_irqs); i++)
520 if (info->irq == muic_irqs[i].virq)
521 irq_type = muic_irqs[i].irq;
523 ret = max8997_bulk_read(info->muic, MAX8997_MUIC_REG_STATUS1,
526 dev_err(info->dev, "failed to read muic register\n");
527 mutex_unlock(&info->mutex);
532 case MAX8997_MUICIRQ_ADCError:
533 case MAX8997_MUICIRQ_ADCLow:
534 case MAX8997_MUICIRQ_ADC:
535 /* Handle all of cable except for charger cable */
536 ret = max8997_muic_adc_handler(info);
538 case MAX8997_MUICIRQ_VBVolt:
539 case MAX8997_MUICIRQ_DBChg:
540 case MAX8997_MUICIRQ_DCDTmr:
541 case MAX8997_MUICIRQ_ChgDetRun:
542 case MAX8997_MUICIRQ_ChgTyp:
543 /* Handle charger cable */
544 ret = max8997_muic_chg_handler(info);
546 case MAX8997_MUICIRQ_OVP:
549 dev_info(info->dev, "misc interrupt: irq %d occurred\n",
551 mutex_unlock(&info->mutex);
556 dev_err(info->dev, "failed to handle MUIC interrupt\n");
558 mutex_unlock(&info->mutex);
561 static irqreturn_t max8997_muic_irq_handler(int irq, void *data)
563 struct max8997_muic_info *info = data;
565 dev_dbg(info->dev, "irq:%d\n", irq);
568 schedule_work(&info->irq_work);
573 static int max8997_muic_detect_dev(struct max8997_muic_info *info)
580 mutex_lock(&info->mutex);
582 /* Read STATUSx register to detect accessory */
583 ret = max8997_bulk_read(info->muic,
584 MAX8997_MUIC_REG_STATUS1, 2, info->status);
586 dev_err(info->dev, "failed to read MUIC register\n");
587 mutex_unlock(&info->mutex);
591 adc = max8997_muic_get_cable_type(info, MAX8997_CABLE_GROUP_ADC,
593 if (attached && adc != MAX8997_MUIC_ADC_OPEN) {
594 ret = max8997_muic_adc_handler(info);
596 dev_err(info->dev, "Cannot detect ADC cable\n");
597 mutex_unlock(&info->mutex);
602 chg_type = max8997_muic_get_cable_type(info, MAX8997_CABLE_GROUP_CHG,
604 if (attached && chg_type != MAX8997_CHARGER_TYPE_NONE) {
605 ret = max8997_muic_chg_handler(info);
607 dev_err(info->dev, "Cannot detect charger cable\n");
608 mutex_unlock(&info->mutex);
613 mutex_unlock(&info->mutex);
618 static void max8997_muic_detect_cable_wq(struct work_struct *work)
620 struct max8997_muic_info *info = container_of(to_delayed_work(work),
621 struct max8997_muic_info, wq_detcable);
624 ret = max8997_muic_detect_dev(info);
626 dev_err(info->dev, "failed to detect cable type\n");
629 static int max8997_muic_probe(struct platform_device *pdev)
631 struct max8997_dev *max8997 = dev_get_drvdata(pdev->dev.parent);
632 struct max8997_platform_data *pdata = dev_get_platdata(max8997->dev);
633 struct max8997_muic_info *info;
637 info = devm_kzalloc(&pdev->dev, sizeof(struct max8997_muic_info),
642 info->dev = &pdev->dev;
643 info->muic = max8997->muic;
645 platform_set_drvdata(pdev, info);
646 mutex_init(&info->mutex);
648 INIT_WORK(&info->irq_work, max8997_muic_irq_work);
650 for (i = 0; i < ARRAY_SIZE(muic_irqs); i++) {
651 struct max8997_muic_irq *muic_irq = &muic_irqs[i];
652 unsigned int virq = 0;
654 virq = irq_create_mapping(max8997->irq_domain, muic_irq->irq);
659 muic_irq->virq = virq;
661 ret = request_threaded_irq(virq, NULL,
662 max8997_muic_irq_handler,
664 muic_irq->name, info);
667 "failed: irq request (IRQ: %d, error :%d)\n",
673 /* External connector */
674 info->edev = devm_extcon_dev_allocate(&pdev->dev, max8997_extcon_cable);
675 if (IS_ERR(info->edev)) {
676 dev_err(&pdev->dev, "failed to allocate memory for extcon\n");
681 ret = devm_extcon_dev_register(&pdev->dev, info->edev);
683 dev_err(&pdev->dev, "failed to register extcon device\n");
687 if (pdata && pdata->muic_pdata) {
688 struct max8997_muic_platform_data *muic_pdata
691 /* Initialize registers according to platform data */
692 for (i = 0; i < muic_pdata->num_init_data; i++) {
693 max8997_write_reg(info->muic,
694 muic_pdata->init_data[i].addr,
695 muic_pdata->init_data[i].data);
699 * Default usb/uart path whether UART/USB or AUX_UART/AUX_USB
700 * h/w path of COMP2/COMN1 on CONTROL1 register.
702 if (muic_pdata->path_uart)
703 info->path_uart = muic_pdata->path_uart;
705 info->path_uart = CONTROL1_SW_UART;
707 if (muic_pdata->path_usb)
708 info->path_usb = muic_pdata->path_usb;
710 info->path_usb = CONTROL1_SW_USB;
713 * Default delay time for detecting cable state
714 * after certain time.
716 if (muic_pdata->detcable_delay_ms)
718 msecs_to_jiffies(muic_pdata->detcable_delay_ms);
720 delay_jiffies = msecs_to_jiffies(DELAY_MS_DEFAULT);
722 info->path_uart = CONTROL1_SW_UART;
723 info->path_usb = CONTROL1_SW_USB;
724 delay_jiffies = msecs_to_jiffies(DELAY_MS_DEFAULT);
727 /* Set initial path for UART */
728 max8997_muic_set_path(info, info->path_uart, true);
730 /* Set ADC debounce time */
731 max8997_muic_set_debounce_time(info, ADC_DEBOUNCE_TIME_25MS);
734 * Detect accessory after completing the initialization of platform
736 * - Use delayed workqueue to detect cable state and then
737 * notify cable state to notifiee/platform through uevent.
738 * After completing the booting of platform, the extcon provider
739 * driver should notify cable state to upper layer.
741 INIT_DELAYED_WORK(&info->wq_detcable, max8997_muic_detect_cable_wq);
742 queue_delayed_work(system_power_efficient_wq, &info->wq_detcable,
749 free_irq(muic_irqs[i].virq, info);
753 static int max8997_muic_remove(struct platform_device *pdev)
755 struct max8997_muic_info *info = platform_get_drvdata(pdev);
758 for (i = 0; i < ARRAY_SIZE(muic_irqs); i++)
759 free_irq(muic_irqs[i].virq, info);
760 cancel_work_sync(&info->irq_work);
765 static struct platform_driver max8997_muic_driver = {
769 .probe = max8997_muic_probe,
770 .remove = max8997_muic_remove,
773 module_platform_driver(max8997_muic_driver);
775 MODULE_DESCRIPTION("Maxim MAX8997 Extcon driver");
776 MODULE_AUTHOR("Donggeun Kim <dg77.kim@samsung.com>");
777 MODULE_LICENSE("GPL");