1 // SPDX-License-Identifier: GPL-2.0+
3 // extcon-max77693.c - MAX77693 extcon driver to support MAX77693 MUIC
5 // Copyright (C) 2012 Samsung Electrnoics
6 // Chanwoo Choi <cw00.choi@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/input.h>
13 #include <linux/interrupt.h>
14 #include <linux/err.h>
15 #include <linux/platform_device.h>
16 #include <linux/mfd/max77693.h>
17 #include <linux/mfd/max77693-common.h>
18 #include <linux/mfd/max77693-private.h>
19 #include <linux/extcon-provider.h>
20 #include <linux/regmap.h>
21 #include <linux/irqdomain.h>
23 #define DEV_NAME "max77693-muic"
24 #define DELAY_MS_DEFAULT 20000 /* unit: millisecond */
27 * Default value of MAX77693 register to bring up MUIC device.
28 * If user don't set some initial value for MUIC device through platform data,
29 * extcon-max77693 driver use 'default_init_data' to bring up base operation
30 * of MAX77693 MUIC device.
32 static struct max77693_reg_data default_init_data[] = {
34 /* STATUS2 - [3]ChgDetRun */
35 .addr = MAX77693_MUIC_REG_STATUS2,
36 .data = MAX77693_STATUS2_CHGDETRUN_MASK,
38 /* INTMASK1 - Unmask [3]ADC1KM,[0]ADCM */
39 .addr = MAX77693_MUIC_REG_INTMASK1,
40 .data = INTMASK1_ADC1K_MASK
43 /* INTMASK2 - Unmask [0]ChgTypM */
44 .addr = MAX77693_MUIC_REG_INTMASK2,
45 .data = INTMASK2_CHGTYP_MASK,
47 /* INTMASK3 - Mask all of interrupts */
48 .addr = MAX77693_MUIC_REG_INTMASK3,
52 .addr = MAX77693_MUIC_REG_CDETCTRL2,
53 .data = CDETCTRL2_VIDRMEN_MASK
54 | CDETCTRL2_DXOVPEN_MASK,
58 enum max77693_muic_adc_debounce_time {
59 ADC_DEBOUNCE_TIME_5MS = 0,
60 ADC_DEBOUNCE_TIME_10MS,
61 ADC_DEBOUNCE_TIME_25MS,
62 ADC_DEBOUNCE_TIME_38_62MS,
65 struct max77693_muic_info {
67 struct max77693_dev *max77693;
68 struct extcon_dev *edev;
70 int prev_cable_type_gnd;
76 struct work_struct irq_work;
80 * Use delayed workqueue to detect cable state and then
81 * notify cable state to notifiee/platform through uevent.
82 * After completing the booting of platform, the extcon provider
83 * driver should notify cable state to upper layer.
85 struct delayed_work wq_detcable;
87 /* Button of dock device */
88 struct input_dev *dock;
91 * Default usb/uart path whether UART/USB or AUX_UART/AUX_USB
92 * h/w path of COMP2/COMN1 on CONTROL1 register.
98 enum max77693_muic_cable_group {
99 MAX77693_CABLE_GROUP_ADC = 0,
100 MAX77693_CABLE_GROUP_ADC_GND,
101 MAX77693_CABLE_GROUP_CHG,
102 MAX77693_CABLE_GROUP_VBVOLT,
105 enum max77693_muic_charger_type {
106 MAX77693_CHARGER_TYPE_NONE = 0,
107 MAX77693_CHARGER_TYPE_USB,
108 MAX77693_CHARGER_TYPE_DOWNSTREAM_PORT,
109 MAX77693_CHARGER_TYPE_DEDICATED_CHG,
110 MAX77693_CHARGER_TYPE_APPLE_500MA,
111 MAX77693_CHARGER_TYPE_APPLE_1A_2A,
112 MAX77693_CHARGER_TYPE_DEAD_BATTERY = 7,
116 * struct max77693_muic_irq
117 * @irq: the index of irq list of MUIC device.
118 * @name: the name of irq.
119 * @virq: the virtual irq to use irq domain
121 struct max77693_muic_irq {
127 static struct max77693_muic_irq muic_irqs[] = {
128 { MAX77693_MUIC_IRQ_INT1_ADC, "muic-ADC" },
129 { MAX77693_MUIC_IRQ_INT1_ADC_LOW, "muic-ADCLOW" },
130 { MAX77693_MUIC_IRQ_INT1_ADC_ERR, "muic-ADCError" },
131 { MAX77693_MUIC_IRQ_INT1_ADC1K, "muic-ADC1K" },
132 { MAX77693_MUIC_IRQ_INT2_CHGTYP, "muic-CHGTYP" },
133 { MAX77693_MUIC_IRQ_INT2_CHGDETREUN, "muic-CHGDETREUN" },
134 { MAX77693_MUIC_IRQ_INT2_DCDTMR, "muic-DCDTMR" },
135 { MAX77693_MUIC_IRQ_INT2_DXOVP, "muic-DXOVP" },
136 { MAX77693_MUIC_IRQ_INT2_VBVOLT, "muic-VBVOLT" },
137 { MAX77693_MUIC_IRQ_INT2_VIDRM, "muic-VIDRM" },
138 { MAX77693_MUIC_IRQ_INT3_EOC, "muic-EOC" },
139 { MAX77693_MUIC_IRQ_INT3_CGMBC, "muic-CGMBC" },
140 { MAX77693_MUIC_IRQ_INT3_OVP, "muic-OVP" },
141 { MAX77693_MUIC_IRQ_INT3_MBCCHG_ERR, "muic-MBCCHG_ERR" },
142 { MAX77693_MUIC_IRQ_INT3_CHG_ENABLED, "muic-CHG_ENABLED" },
143 { MAX77693_MUIC_IRQ_INT3_BAT_DET, "muic-BAT_DET" },
146 /* Define supported accessory type */
147 enum max77693_muic_acc_type {
148 MAX77693_MUIC_ADC_GROUND = 0x0,
149 MAX77693_MUIC_ADC_SEND_END_BUTTON,
150 MAX77693_MUIC_ADC_REMOTE_S1_BUTTON,
151 MAX77693_MUIC_ADC_REMOTE_S2_BUTTON,
152 MAX77693_MUIC_ADC_REMOTE_S3_BUTTON,
153 MAX77693_MUIC_ADC_REMOTE_S4_BUTTON,
154 MAX77693_MUIC_ADC_REMOTE_S5_BUTTON,
155 MAX77693_MUIC_ADC_REMOTE_S6_BUTTON,
156 MAX77693_MUIC_ADC_REMOTE_S7_BUTTON,
157 MAX77693_MUIC_ADC_REMOTE_S8_BUTTON,
158 MAX77693_MUIC_ADC_REMOTE_S9_BUTTON,
159 MAX77693_MUIC_ADC_REMOTE_S10_BUTTON,
160 MAX77693_MUIC_ADC_REMOTE_S11_BUTTON,
161 MAX77693_MUIC_ADC_REMOTE_S12_BUTTON,
162 MAX77693_MUIC_ADC_RESERVED_ACC_1,
163 MAX77693_MUIC_ADC_RESERVED_ACC_2,
164 MAX77693_MUIC_ADC_RESERVED_ACC_3,
165 MAX77693_MUIC_ADC_RESERVED_ACC_4,
166 MAX77693_MUIC_ADC_RESERVED_ACC_5,
167 MAX77693_MUIC_ADC_CEA936_AUDIO,
168 MAX77693_MUIC_ADC_PHONE_POWERED_DEV,
169 MAX77693_MUIC_ADC_TTY_CONVERTER,
170 MAX77693_MUIC_ADC_UART_CABLE,
171 MAX77693_MUIC_ADC_CEA936A_TYPE1_CHG,
172 MAX77693_MUIC_ADC_FACTORY_MODE_USB_OFF,
173 MAX77693_MUIC_ADC_FACTORY_MODE_USB_ON,
174 MAX77693_MUIC_ADC_AV_CABLE_NOLOAD,
175 MAX77693_MUIC_ADC_CEA936A_TYPE2_CHG,
176 MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF,
177 MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON,
178 MAX77693_MUIC_ADC_AUDIO_MODE_REMOTE,
179 MAX77693_MUIC_ADC_OPEN,
182 * The below accessories have same ADC value so ADCLow and
183 * ADC1K bit is used to separate specific accessory.
185 /* ADC|VBVolot|ADCLow|ADC1K| */
186 MAX77693_MUIC_GND_USB_HOST = 0x100, /* 0x0| 0| 0| 0| */
187 MAX77693_MUIC_GND_USB_HOST_VB = 0x104, /* 0x0| 1| 0| 0| */
188 MAX77693_MUIC_GND_AV_CABLE_LOAD = 0x102,/* 0x0| 0| 1| 0| */
189 MAX77693_MUIC_GND_MHL = 0x103, /* 0x0| 0| 1| 1| */
190 MAX77693_MUIC_GND_MHL_VB = 0x107, /* 0x0| 1| 1| 1| */
194 * MAX77693 MUIC device support below list of accessories(external connector)
196 static const unsigned int max77693_extcon_cable[] = {
211 * max77693_muic_set_debounce_time - Set the debounce time of ADC
212 * @info: the instance including private data of max77693 MUIC
213 * @time: the debounce time of ADC
215 static int max77693_muic_set_debounce_time(struct max77693_muic_info *info,
216 enum max77693_muic_adc_debounce_time time)
221 case ADC_DEBOUNCE_TIME_5MS:
222 case ADC_DEBOUNCE_TIME_10MS:
223 case ADC_DEBOUNCE_TIME_25MS:
224 case ADC_DEBOUNCE_TIME_38_62MS:
226 * Don't touch BTLDset, JIGset when you want to change adc
227 * debounce time. If it writes other than 0 to BTLDset, JIGset
228 * muic device will be reset and loose current state.
230 ret = regmap_write(info->max77693->regmap_muic,
231 MAX77693_MUIC_REG_CTRL3,
232 time << MAX77693_CONTROL3_ADCDBSET_SHIFT);
234 dev_err(info->dev, "failed to set ADC debounce time\n");
239 dev_err(info->dev, "invalid ADC debounce time\n");
247 * max77693_muic_set_path - Set hardware line according to attached cable
248 * @info: the instance including private data of max77693 MUIC
249 * @value: the path according to attached cable
250 * @attached: the state of cable (true:attached, false:detached)
252 * The max77693 MUIC device share outside H/W line among a varity of cables
253 * so, this function set internal path of H/W line according to the type of
256 static int max77693_muic_set_path(struct max77693_muic_info *info,
257 u8 val, bool attached)
260 unsigned int ctrl1, ctrl2 = 0;
265 ctrl1 = MAX77693_CONTROL1_SW_OPEN;
267 ret = regmap_update_bits(info->max77693->regmap_muic,
268 MAX77693_MUIC_REG_CTRL1, COMP_SW_MASK, ctrl1);
270 dev_err(info->dev, "failed to update MUIC register\n");
275 ctrl2 |= MAX77693_CONTROL2_CPEN_MASK; /* LowPwr=0, CPEn=1 */
277 ctrl2 |= MAX77693_CONTROL2_LOWPWR_MASK; /* LowPwr=1, CPEn=0 */
279 ret = regmap_update_bits(info->max77693->regmap_muic,
280 MAX77693_MUIC_REG_CTRL2,
281 MAX77693_CONTROL2_LOWPWR_MASK | MAX77693_CONTROL2_CPEN_MASK,
284 dev_err(info->dev, "failed to update MUIC register\n");
289 "CONTROL1 : 0x%02x, CONTROL2 : 0x%02x, state : %s\n",
290 ctrl1, ctrl2, attached ? "attached" : "detached");
296 * max77693_muic_get_cable_type - Return cable type and check cable state
297 * @info: the instance including private data of max77693 MUIC
298 * @group: the path according to attached cable
299 * @attached: store cable state and return
301 * This function check the cable state either attached or detached,
302 * and then divide precise type of cable according to cable group.
303 * - MAX77693_CABLE_GROUP_ADC
304 * - MAX77693_CABLE_GROUP_ADC_GND
305 * - MAX77693_CABLE_GROUP_CHG
306 * - MAX77693_CABLE_GROUP_VBVOLT
308 static int max77693_muic_get_cable_type(struct max77693_muic_info *info,
309 enum max77693_muic_cable_group group, bool *attached)
319 case MAX77693_CABLE_GROUP_ADC:
321 * Read ADC value to check cable type and decide cable state
322 * according to cable type
324 adc = info->status[0] & MAX77693_STATUS1_ADC_MASK;
325 adc >>= MAX77693_STATUS1_ADC_SHIFT;
328 * Check current cable state/cable type and store cable type
329 * (info->prev_cable_type) for handling cable when cable is
332 if (adc == MAX77693_MUIC_ADC_OPEN) {
335 cable_type = info->prev_cable_type;
336 info->prev_cable_type = MAX77693_MUIC_ADC_OPEN;
340 cable_type = info->prev_cable_type = adc;
343 case MAX77693_CABLE_GROUP_ADC_GND:
345 * Read ADC value to check cable type and decide cable state
346 * according to cable type
348 adc = info->status[0] & MAX77693_STATUS1_ADC_MASK;
349 adc >>= MAX77693_STATUS1_ADC_SHIFT;
352 * Check current cable state/cable type and store cable type
353 * (info->prev_cable_type/_gnd) for handling cable when cable
356 if (adc == MAX77693_MUIC_ADC_OPEN) {
359 cable_type = info->prev_cable_type_gnd;
360 info->prev_cable_type_gnd = MAX77693_MUIC_ADC_OPEN;
364 adclow = info->status[0] & MAX77693_STATUS1_ADCLOW_MASK;
365 adclow >>= MAX77693_STATUS1_ADCLOW_SHIFT;
366 adc1k = info->status[0] & MAX77693_STATUS1_ADC1K_MASK;
367 adc1k >>= MAX77693_STATUS1_ADC1K_SHIFT;
369 vbvolt = info->status[1] & MAX77693_STATUS2_VBVOLT_MASK;
370 vbvolt >>= MAX77693_STATUS2_VBVOLT_SHIFT;
373 * [0x1|VBVolt|ADCLow|ADC1K]
374 * [0x1| 0| 0| 0] USB_HOST
375 * [0x1| 1| 0| 0] USB_HSOT_VB
376 * [0x1| 0| 1| 0] Audio Video cable with load
377 * [0x1| 0| 1| 1] MHL without charging cable
378 * [0x1| 1| 1| 1] MHL with charging cable
380 cable_type = ((0x1 << 8)
385 info->prev_cable_type = adc;
386 info->prev_cable_type_gnd = cable_type;
390 case MAX77693_CABLE_GROUP_CHG:
392 * Read charger type to check cable type and decide cable state
393 * according to type of charger cable.
395 chg_type = info->status[1] & MAX77693_STATUS2_CHGTYP_MASK;
396 chg_type >>= MAX77693_STATUS2_CHGTYP_SHIFT;
398 if (chg_type == MAX77693_CHARGER_TYPE_NONE) {
401 cable_type = info->prev_chg_type;
402 info->prev_chg_type = MAX77693_CHARGER_TYPE_NONE;
407 * Check current cable state/cable type and store cable
408 * type(info->prev_chg_type) for handling cable when
409 * charger cable is detached.
411 cable_type = info->prev_chg_type = chg_type;
415 case MAX77693_CABLE_GROUP_VBVOLT:
417 * Read ADC value to check cable type and decide cable state
418 * according to cable type
420 adc = info->status[0] & MAX77693_STATUS1_ADC_MASK;
421 adc >>= MAX77693_STATUS1_ADC_SHIFT;
422 chg_type = info->status[1] & MAX77693_STATUS2_CHGTYP_MASK;
423 chg_type >>= MAX77693_STATUS2_CHGTYP_SHIFT;
425 if (adc == MAX77693_MUIC_ADC_OPEN
426 && chg_type == MAX77693_CHARGER_TYPE_NONE)
432 * Read vbvolt field, if vbvolt is 1,
433 * this cable is used for charging.
435 vbvolt = info->status[1] & MAX77693_STATUS2_VBVOLT_MASK;
436 vbvolt >>= MAX77693_STATUS2_VBVOLT_SHIFT;
441 dev_err(info->dev, "Unknown cable group (%d)\n", group);
442 cable_type = -EINVAL;
449 static int max77693_muic_dock_handler(struct max77693_muic_info *info,
450 int cable_type, bool attached)
455 unsigned int dock_id;
458 "external connector is %s (adc:0x%02x)\n",
459 attached ? "attached" : "detached", cable_type);
461 switch (cable_type) {
462 case MAX77693_MUIC_ADC_RESERVED_ACC_3: /* Dock-Smart */
464 * Check power cable whether attached or detached state.
465 * The Dock-Smart device need surely external power supply.
466 * If power cable(USB/TA) isn't connected to Dock device,
467 * user can't use Dock-Smart for desktop mode.
469 vbvolt = max77693_muic_get_cable_type(info,
470 MAX77693_CABLE_GROUP_VBVOLT, &cable_attached);
471 if (attached && !vbvolt) {
473 "Cannot detect external power supply\n");
478 * Notify Dock/MHL state.
479 * - Dock device include three type of cable which
480 * are HDMI, USB for mouse/keyboard and micro-usb port
481 * for USB/TA cable. Dock device need always exteranl
482 * power supply(USB/TA cable through micro-usb cable). Dock
483 * device support screen output of target to separate
484 * monitor and mouse/keyboard for desktop mode.
486 * Features of 'USB/TA cable with Dock device'
488 * - Support external output feature of audio
489 * - Support charging through micro-usb port without data
490 * connection if TA cable is connected to target.
491 * - Support charging and data connection through micro-usb port
492 * if USB cable is connected between target and host
494 * - Support OTG(On-The-Go) device (Ex: Mouse/Keyboard)
496 ret = max77693_muic_set_path(info, info->path_usb, attached);
500 extcon_set_state_sync(info->edev, EXTCON_DOCK, attached);
501 extcon_set_state_sync(info->edev, EXTCON_DISP_MHL, attached);
503 case MAX77693_MUIC_ADC_AUDIO_MODE_REMOTE: /* Dock-Desk */
504 dock_id = EXTCON_DOCK;
506 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD: /* Dock-Audio */
507 dock_id = EXTCON_DOCK;
509 extcon_set_state_sync(info->edev, EXTCON_USB, false);
510 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_SDP,
515 dev_err(info->dev, "failed to detect %s dock device\n",
516 attached ? "attached" : "detached");
520 /* Dock-Car/Desk/Audio, PATH:AUDIO */
521 ret = max77693_muic_set_path(info, MAX77693_CONTROL1_SW_AUDIO,
525 extcon_set_state_sync(info->edev, dock_id, attached);
531 static int max77693_muic_dock_button_handler(struct max77693_muic_info *info,
532 int button_type, bool attached)
534 struct input_dev *dock = info->dock;
537 switch (button_type) {
538 case MAX77693_MUIC_ADC_REMOTE_S3_BUTTON-1
539 ... MAX77693_MUIC_ADC_REMOTE_S3_BUTTON+1:
541 code = KEY_PREVIOUSSONG;
543 case MAX77693_MUIC_ADC_REMOTE_S7_BUTTON-1
544 ... MAX77693_MUIC_ADC_REMOTE_S7_BUTTON+1:
548 case MAX77693_MUIC_ADC_REMOTE_S9_BUTTON:
550 code = KEY_VOLUMEDOWN;
552 case MAX77693_MUIC_ADC_REMOTE_S10_BUTTON:
556 case MAX77693_MUIC_ADC_REMOTE_S12_BUTTON-1
557 ... MAX77693_MUIC_ADC_REMOTE_S12_BUTTON+1:
558 /* DOCK_KEY_PLAY_PAUSE */
559 code = KEY_PLAYPAUSE;
563 "failed to detect %s key (adc:0x%x)\n",
564 attached ? "pressed" : "released", button_type);
568 input_event(dock, EV_KEY, code, attached);
574 static int max77693_muic_adc_ground_handler(struct max77693_muic_info *info)
580 cable_type_gnd = max77693_muic_get_cable_type(info,
581 MAX77693_CABLE_GROUP_ADC_GND, &attached);
583 switch (cable_type_gnd) {
584 case MAX77693_MUIC_GND_USB_HOST:
585 case MAX77693_MUIC_GND_USB_HOST_VB:
586 /* USB_HOST, PATH: AP_USB */
587 ret = max77693_muic_set_path(info, MAX77693_CONTROL1_SW_USB,
591 extcon_set_state_sync(info->edev, EXTCON_USB_HOST, attached);
593 case MAX77693_MUIC_GND_AV_CABLE_LOAD:
594 /* Audio Video Cable with load, PATH:AUDIO */
595 ret = max77693_muic_set_path(info, MAX77693_CONTROL1_SW_AUDIO,
599 extcon_set_state_sync(info->edev, EXTCON_USB, attached);
600 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_SDP,
603 case MAX77693_MUIC_GND_MHL:
604 case MAX77693_MUIC_GND_MHL_VB:
605 /* MHL or MHL with USB/TA cable */
606 extcon_set_state_sync(info->edev, EXTCON_DISP_MHL, attached);
609 dev_err(info->dev, "failed to detect %s cable of gnd type\n",
610 attached ? "attached" : "detached");
617 static int max77693_muic_jig_handler(struct max77693_muic_info *info,
618 int cable_type, bool attached)
621 u8 path = MAX77693_CONTROL1_SW_OPEN;
624 "external connector is %s (adc:0x%02x)\n",
625 attached ? "attached" : "detached", cable_type);
627 switch (cable_type) {
628 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_OFF: /* ADC_JIG_USB_OFF */
629 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_ON: /* ADC_JIG_USB_ON */
631 path = MAX77693_CONTROL1_SW_USB;
633 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF: /* ADC_JIG_UART_OFF */
634 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON: /* ADC_JIG_UART_ON */
636 path = MAX77693_CONTROL1_SW_UART;
639 dev_err(info->dev, "failed to detect %s jig cable\n",
640 attached ? "attached" : "detached");
644 ret = max77693_muic_set_path(info, path, attached);
648 extcon_set_state_sync(info->edev, EXTCON_JIG, attached);
653 static int max77693_muic_adc_handler(struct max77693_muic_info *info)
660 /* Check accessory state which is either detached or attached */
661 cable_type = max77693_muic_get_cable_type(info,
662 MAX77693_CABLE_GROUP_ADC, &attached);
665 "external connector is %s (adc:0x%02x, prev_adc:0x%x)\n",
666 attached ? "attached" : "detached", cable_type,
667 info->prev_cable_type);
669 switch (cable_type) {
670 case MAX77693_MUIC_ADC_GROUND:
671 /* USB_HOST/MHL/Audio */
672 max77693_muic_adc_ground_handler(info);
674 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_OFF:
675 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_ON:
676 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF:
677 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON:
679 ret = max77693_muic_jig_handler(info, cable_type, attached);
683 case MAX77693_MUIC_ADC_RESERVED_ACC_3: /* Dock-Smart */
684 case MAX77693_MUIC_ADC_AUDIO_MODE_REMOTE: /* Dock-Desk */
685 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD: /* Dock-Audio */
689 * The MAX77693 MUIC device can detect total 34 cable type
690 * except of charger cable and MUIC device didn't define
691 * specfic role of cable in the range of from 0x01 to 0x12
692 * of ADC value. So, can use/define cable with no role according
693 * to schema of hardware board.
695 ret = max77693_muic_dock_handler(info, cable_type, attached);
699 case MAX77693_MUIC_ADC_REMOTE_S3_BUTTON: /* DOCK_KEY_PREV */
700 case MAX77693_MUIC_ADC_REMOTE_S7_BUTTON: /* DOCK_KEY_NEXT */
701 case MAX77693_MUIC_ADC_REMOTE_S9_BUTTON: /* DOCK_VOL_DOWN */
702 case MAX77693_MUIC_ADC_REMOTE_S10_BUTTON: /* DOCK_VOL_UP */
703 case MAX77693_MUIC_ADC_REMOTE_S12_BUTTON: /* DOCK_KEY_PLAY_PAUSE */
705 * Button of DOCK device
706 * - the Prev/Next/Volume Up/Volume Down/Play-Pause button
708 * The MAX77693 MUIC device can detect total 34 cable type
709 * except of charger cable and MUIC device didn't define
710 * specfic role of cable in the range of from 0x01 to 0x12
711 * of ADC value. So, can use/define cable with no role according
712 * to schema of hardware board.
715 button_type = info->prev_button_type = cable_type;
717 button_type = info->prev_button_type;
719 ret = max77693_muic_dock_button_handler(info, button_type,
724 case MAX77693_MUIC_ADC_SEND_END_BUTTON:
725 case MAX77693_MUIC_ADC_REMOTE_S1_BUTTON:
726 case MAX77693_MUIC_ADC_REMOTE_S2_BUTTON:
727 case MAX77693_MUIC_ADC_REMOTE_S4_BUTTON:
728 case MAX77693_MUIC_ADC_REMOTE_S5_BUTTON:
729 case MAX77693_MUIC_ADC_REMOTE_S6_BUTTON:
730 case MAX77693_MUIC_ADC_REMOTE_S8_BUTTON:
731 case MAX77693_MUIC_ADC_REMOTE_S11_BUTTON:
732 case MAX77693_MUIC_ADC_RESERVED_ACC_1:
733 case MAX77693_MUIC_ADC_RESERVED_ACC_2:
734 case MAX77693_MUIC_ADC_RESERVED_ACC_4:
735 case MAX77693_MUIC_ADC_RESERVED_ACC_5:
736 case MAX77693_MUIC_ADC_CEA936_AUDIO:
737 case MAX77693_MUIC_ADC_PHONE_POWERED_DEV:
738 case MAX77693_MUIC_ADC_TTY_CONVERTER:
739 case MAX77693_MUIC_ADC_UART_CABLE:
740 case MAX77693_MUIC_ADC_CEA936A_TYPE1_CHG:
741 case MAX77693_MUIC_ADC_CEA936A_TYPE2_CHG:
743 * This accessory isn't used in general case if it is specially
744 * needed to detect additional accessory, should implement
745 * proper operation when this accessory is attached/detached.
748 "accessory is %s but it isn't used (adc:0x%x)\n",
749 attached ? "attached" : "detached", cable_type);
753 "failed to detect %s accessory (adc:0x%x)\n",
754 attached ? "attached" : "detached", cable_type);
761 static int max77693_muic_chg_handler(struct max77693_muic_info *info)
770 chg_type = max77693_muic_get_cable_type(info,
771 MAX77693_CABLE_GROUP_CHG, &attached);
774 "external connector is %s(chg_type:0x%x, prev_chg_type:0x%x)\n",
775 attached ? "attached" : "detached",
776 chg_type, info->prev_chg_type);
779 case MAX77693_CHARGER_TYPE_USB:
780 case MAX77693_CHARGER_TYPE_DEDICATED_CHG:
781 case MAX77693_CHARGER_TYPE_NONE:
782 /* Check MAX77693_CABLE_GROUP_ADC_GND type */
783 cable_type_gnd = max77693_muic_get_cable_type(info,
784 MAX77693_CABLE_GROUP_ADC_GND,
786 switch (cable_type_gnd) {
787 case MAX77693_MUIC_GND_MHL:
788 case MAX77693_MUIC_GND_MHL_VB:
790 * MHL cable with USB/TA cable
791 * - MHL cable include two port(HDMI line and separate
792 * micro-usb port. When the target connect MHL cable,
793 * extcon driver check whether USB/TA cable is
794 * connected. If USB/TA cable is connected, extcon
795 * driver notify state to notifiee for charging battery.
797 * Features of 'USB/TA with MHL cable'
799 * - Support charging through micro-usb port without
802 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_DCP,
804 extcon_set_state_sync(info->edev, EXTCON_DISP_MHL,
809 /* Check MAX77693_CABLE_GROUP_ADC type */
810 cable_type = max77693_muic_get_cable_type(info,
811 MAX77693_CABLE_GROUP_ADC,
813 switch (cable_type) {
814 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD: /* Dock-Audio */
816 * Dock-Audio device with USB/TA cable
817 * - Dock device include two port(Dock-Audio and micro-
818 * usb port). When the target connect Dock-Audio device,
819 * extcon driver check whether USB/TA cable is connected
820 * or not. If USB/TA cable is connected, extcon driver
821 * notify state to notifiee for charging battery.
823 * Features of 'USB/TA cable with Dock-Audio device'
824 * - Support external output feature of audio.
825 * - Support charging through micro-usb port without
828 extcon_set_state_sync(info->edev, EXTCON_USB,
830 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_SDP,
834 extcon_set_state_sync(info->edev, EXTCON_DOCK,
837 case MAX77693_MUIC_ADC_RESERVED_ACC_3: /* Dock-Smart */
839 * Dock-Smart device with USB/TA cable
840 * - Dock-Desk device include three type of cable which
841 * are HDMI, USB for mouse/keyboard and micro-usb port
842 * for USB/TA cable. Dock-Smart device need always
843 * exteranl power supply(USB/TA cable through micro-usb
844 * cable). Dock-Smart device support screen output of
845 * target to separate monitor and mouse/keyboard for
848 * Features of 'USB/TA cable with Dock-Smart device'
850 * - Support external output feature of audio
851 * - Support charging through micro-usb port without
852 * data connection if TA cable is connected to target.
853 * - Support charging and data connection through micro-
854 * usb port if USB cable is connected between target
856 * - Support OTG(On-The-Go) device (Ex: Mouse/Keyboard)
858 ret = max77693_muic_set_path(info, info->path_usb,
863 extcon_set_state_sync(info->edev, EXTCON_DOCK,
865 extcon_set_state_sync(info->edev, EXTCON_DISP_MHL,
870 /* Check MAX77693_CABLE_GROUP_CHG type */
872 case MAX77693_CHARGER_TYPE_NONE:
874 * When MHL(with USB/TA cable) or Dock-Audio with USB/TA
875 * cable is attached, muic device happen below two irq.
876 * - 'MAX77693_MUIC_IRQ_INT1_ADC' for detecting
878 * - 'MAX77693_MUIC_IRQ_INT2_CHGTYP' for detecting
879 * USB/TA cable connected to MHL or Dock-Audio.
880 * Always, happen eariler MAX77693_MUIC_IRQ_INT1_ADC
881 * irq than MAX77693_MUIC_IRQ_INT2_CHGTYP irq.
883 * If user attach MHL (with USB/TA cable and immediately
884 * detach MHL with USB/TA cable before MAX77693_MUIC_IRQ
885 * _INT2_CHGTYP irq is happened, USB/TA cable remain
886 * connected state to target. But USB/TA cable isn't
887 * connected to target. The user be face with unusual
888 * action. So, driver should check this situation in
889 * spite of, that previous charger type is N/A.
892 case MAX77693_CHARGER_TYPE_USB:
893 /* Only USB cable, PATH:AP_USB */
894 ret = max77693_muic_set_path(info, info->path_usb,
899 extcon_set_state_sync(info->edev, EXTCON_USB,
901 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_SDP,
904 case MAX77693_CHARGER_TYPE_DEDICATED_CHG:
906 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_DCP,
911 case MAX77693_CHARGER_TYPE_DOWNSTREAM_PORT:
912 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_CDP,
915 case MAX77693_CHARGER_TYPE_APPLE_500MA:
916 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_SLOW,
919 case MAX77693_CHARGER_TYPE_APPLE_1A_2A:
920 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_FAST,
923 case MAX77693_CHARGER_TYPE_DEAD_BATTERY:
927 "failed to detect %s accessory (chg_type:0x%x)\n",
928 attached ? "attached" : "detached", chg_type);
935 static void max77693_muic_irq_work(struct work_struct *work)
937 struct max77693_muic_info *info = container_of(work,
938 struct max77693_muic_info, irq_work);
945 mutex_lock(&info->mutex);
947 for (i = 0; i < ARRAY_SIZE(muic_irqs); i++)
948 if (info->irq == muic_irqs[i].virq)
949 irq_type = muic_irqs[i].irq;
951 ret = regmap_bulk_read(info->max77693->regmap_muic,
952 MAX77693_MUIC_REG_STATUS1, info->status, 2);
954 dev_err(info->dev, "failed to read MUIC register\n");
955 mutex_unlock(&info->mutex);
960 case MAX77693_MUIC_IRQ_INT1_ADC:
961 case MAX77693_MUIC_IRQ_INT1_ADC_LOW:
962 case MAX77693_MUIC_IRQ_INT1_ADC_ERR:
963 case MAX77693_MUIC_IRQ_INT1_ADC1K:
965 * Handle all of accessory except for
966 * type of charger accessory.
968 ret = max77693_muic_adc_handler(info);
970 case MAX77693_MUIC_IRQ_INT2_CHGTYP:
971 case MAX77693_MUIC_IRQ_INT2_CHGDETREUN:
972 case MAX77693_MUIC_IRQ_INT2_DCDTMR:
973 case MAX77693_MUIC_IRQ_INT2_DXOVP:
974 case MAX77693_MUIC_IRQ_INT2_VBVOLT:
975 case MAX77693_MUIC_IRQ_INT2_VIDRM:
976 /* Handle charger accessory */
977 ret = max77693_muic_chg_handler(info);
979 case MAX77693_MUIC_IRQ_INT3_EOC:
980 case MAX77693_MUIC_IRQ_INT3_CGMBC:
981 case MAX77693_MUIC_IRQ_INT3_OVP:
982 case MAX77693_MUIC_IRQ_INT3_MBCCHG_ERR:
983 case MAX77693_MUIC_IRQ_INT3_CHG_ENABLED:
984 case MAX77693_MUIC_IRQ_INT3_BAT_DET:
987 dev_err(info->dev, "muic interrupt: irq %d occurred\n",
989 mutex_unlock(&info->mutex);
994 dev_err(info->dev, "failed to handle MUIC interrupt\n");
996 mutex_unlock(&info->mutex);
999 static irqreturn_t max77693_muic_irq_handler(int irq, void *data)
1001 struct max77693_muic_info *info = data;
1004 schedule_work(&info->irq_work);
1009 static const struct regmap_config max77693_muic_regmap_config = {
1014 static int max77693_muic_detect_accessory(struct max77693_muic_info *info)
1021 mutex_lock(&info->mutex);
1023 /* Read STATUSx register to detect accessory */
1024 ret = regmap_bulk_read(info->max77693->regmap_muic,
1025 MAX77693_MUIC_REG_STATUS1, info->status, 2);
1027 dev_err(info->dev, "failed to read MUIC register\n");
1028 mutex_unlock(&info->mutex);
1032 adc = max77693_muic_get_cable_type(info, MAX77693_CABLE_GROUP_ADC,
1034 if (attached && adc != MAX77693_MUIC_ADC_OPEN) {
1035 ret = max77693_muic_adc_handler(info);
1037 dev_err(info->dev, "Cannot detect accessory\n");
1038 mutex_unlock(&info->mutex);
1043 chg_type = max77693_muic_get_cable_type(info, MAX77693_CABLE_GROUP_CHG,
1045 if (attached && chg_type != MAX77693_CHARGER_TYPE_NONE) {
1046 ret = max77693_muic_chg_handler(info);
1048 dev_err(info->dev, "Cannot detect charger accessory\n");
1049 mutex_unlock(&info->mutex);
1054 mutex_unlock(&info->mutex);
1059 static void max77693_muic_detect_cable_wq(struct work_struct *work)
1061 struct max77693_muic_info *info = container_of(to_delayed_work(work),
1062 struct max77693_muic_info, wq_detcable);
1064 max77693_muic_detect_accessory(info);
1067 static int max77693_muic_probe(struct platform_device *pdev)
1069 struct max77693_dev *max77693 = dev_get_drvdata(pdev->dev.parent);
1070 struct max77693_platform_data *pdata = dev_get_platdata(max77693->dev);
1071 struct max77693_muic_info *info;
1072 struct max77693_reg_data *init_data;
1081 info = devm_kzalloc(&pdev->dev, sizeof(struct max77693_muic_info),
1086 info->dev = &pdev->dev;
1087 info->max77693 = max77693;
1088 if (info->max77693->regmap_muic) {
1089 dev_dbg(&pdev->dev, "allocate register map\n");
1091 info->max77693->regmap_muic = devm_regmap_init_i2c(
1092 info->max77693->i2c_muic,
1093 &max77693_muic_regmap_config);
1094 if (IS_ERR(info->max77693->regmap_muic)) {
1095 ret = PTR_ERR(info->max77693->regmap_muic);
1096 dev_err(max77693->dev,
1097 "failed to allocate register map: %d\n", ret);
1102 /* Register input device for button of dock device */
1103 info->dock = devm_input_allocate_device(&pdev->dev);
1105 dev_err(&pdev->dev, "%s: failed to allocate input\n", __func__);
1108 info->dock->name = "max77693-muic/dock";
1109 info->dock->phys = "max77693-muic/extcon";
1110 info->dock->dev.parent = &pdev->dev;
1112 __set_bit(EV_REP, info->dock->evbit);
1114 input_set_capability(info->dock, EV_KEY, KEY_VOLUMEUP);
1115 input_set_capability(info->dock, EV_KEY, KEY_VOLUMEDOWN);
1116 input_set_capability(info->dock, EV_KEY, KEY_PLAYPAUSE);
1117 input_set_capability(info->dock, EV_KEY, KEY_PREVIOUSSONG);
1118 input_set_capability(info->dock, EV_KEY, KEY_NEXTSONG);
1120 ret = input_register_device(info->dock);
1122 dev_err(&pdev->dev, "Cannot register input device error(%d)\n",
1127 platform_set_drvdata(pdev, info);
1128 mutex_init(&info->mutex);
1130 INIT_WORK(&info->irq_work, max77693_muic_irq_work);
1132 /* Support irq domain for MAX77693 MUIC device */
1133 for (i = 0; i < ARRAY_SIZE(muic_irqs); i++) {
1134 struct max77693_muic_irq *muic_irq = &muic_irqs[i];
1137 virq = regmap_irq_get_virq(max77693->irq_data_muic,
1141 muic_irq->virq = virq;
1143 ret = devm_request_threaded_irq(&pdev->dev, virq, NULL,
1144 max77693_muic_irq_handler,
1146 muic_irq->name, info);
1149 "failed: irq request (IRQ: %d, error :%d)\n",
1150 muic_irq->irq, ret);
1155 /* Initialize extcon device */
1156 info->edev = devm_extcon_dev_allocate(&pdev->dev,
1157 max77693_extcon_cable);
1158 if (IS_ERR(info->edev)) {
1159 dev_err(&pdev->dev, "failed to allocate memory for extcon\n");
1163 ret = devm_extcon_dev_register(&pdev->dev, info->edev);
1165 dev_err(&pdev->dev, "failed to register extcon device\n");
1169 /* Initialize MUIC register by using platform data or default data */
1170 if (pdata && pdata->muic_data) {
1171 init_data = pdata->muic_data->init_data;
1172 num_init_data = pdata->muic_data->num_init_data;
1174 init_data = default_init_data;
1175 num_init_data = ARRAY_SIZE(default_init_data);
1178 for (i = 0; i < num_init_data; i++) {
1179 regmap_write(info->max77693->regmap_muic,
1184 if (pdata && pdata->muic_data) {
1185 struct max77693_muic_platform_data *muic_pdata
1189 * Default usb/uart path whether UART/USB or AUX_UART/AUX_USB
1190 * h/w path of COMP2/COMN1 on CONTROL1 register.
1192 if (muic_pdata->path_uart)
1193 info->path_uart = muic_pdata->path_uart;
1195 info->path_uart = MAX77693_CONTROL1_SW_UART;
1197 if (muic_pdata->path_usb)
1198 info->path_usb = muic_pdata->path_usb;
1200 info->path_usb = MAX77693_CONTROL1_SW_USB;
1203 * Default delay time for detecting cable state
1204 * after certain time.
1206 if (muic_pdata->detcable_delay_ms)
1208 msecs_to_jiffies(muic_pdata->detcable_delay_ms);
1210 delay_jiffies = msecs_to_jiffies(DELAY_MS_DEFAULT);
1212 info->path_usb = MAX77693_CONTROL1_SW_USB;
1213 info->path_uart = MAX77693_CONTROL1_SW_UART;
1214 delay_jiffies = msecs_to_jiffies(DELAY_MS_DEFAULT);
1217 /* Set initial path for UART when JIG is connected to get serial logs */
1218 ret = regmap_bulk_read(info->max77693->regmap_muic,
1219 MAX77693_MUIC_REG_STATUS1, info->status, 2);
1221 dev_err(info->dev, "failed to read MUIC register\n");
1224 cable_type = max77693_muic_get_cable_type(info,
1225 MAX77693_CABLE_GROUP_ADC, &attached);
1226 if (attached && (cable_type == MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON ||
1227 cable_type == MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF))
1228 max77693_muic_set_path(info, info->path_uart, true);
1230 /* Check revision number of MUIC device*/
1231 ret = regmap_read(info->max77693->regmap_muic,
1232 MAX77693_MUIC_REG_ID, &id);
1234 dev_err(&pdev->dev, "failed to read revision number\n");
1237 dev_info(info->dev, "device ID : 0x%x\n", id);
1239 /* Set ADC debounce time */
1240 max77693_muic_set_debounce_time(info, ADC_DEBOUNCE_TIME_25MS);
1243 * Detect accessory after completing the initialization of platform
1245 * - Use delayed workqueue to detect cable state and then
1246 * notify cable state to notifiee/platform through uevent.
1247 * After completing the booting of platform, the extcon provider
1248 * driver should notify cable state to upper layer.
1250 INIT_DELAYED_WORK(&info->wq_detcable, max77693_muic_detect_cable_wq);
1251 queue_delayed_work(system_power_efficient_wq, &info->wq_detcable,
1257 static int max77693_muic_remove(struct platform_device *pdev)
1259 struct max77693_muic_info *info = platform_get_drvdata(pdev);
1261 cancel_work_sync(&info->irq_work);
1262 input_unregister_device(info->dock);
1267 static struct platform_driver max77693_muic_driver = {
1271 .probe = max77693_muic_probe,
1272 .remove = max77693_muic_remove,
1275 module_platform_driver(max77693_muic_driver);
1277 MODULE_DESCRIPTION("Maxim MAX77693 Extcon driver");
1278 MODULE_AUTHOR("Chanwoo Choi <cw00.choi@samsung.com>");
1279 MODULE_LICENSE("GPL");
1280 MODULE_ALIAS("platform:extcon-max77693");