2 * extcon-max77693.c - MAX77693 extcon driver to support MAX77693 MUIC
4 * Copyright (C) 2012 Samsung Electrnoics
5 * Chanwoo Choi <cw00.choi@samsung.com>
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/input.h>
23 #include <linux/interrupt.h>
24 #include <linux/err.h>
25 #include <linux/platform_device.h>
26 #include <linux/mfd/max77693.h>
27 #include <linux/mfd/max77693-private.h>
28 #include <linux/extcon.h>
29 #include <linux/regmap.h>
30 #include <linux/irqdomain.h>
32 #define DEV_NAME "max77693-muic"
33 #define DELAY_MS_DEFAULT 20000 /* unit: millisecond */
36 * Default value of MAX77693 register to bring up MUIC device.
37 * If user don't set some initial value for MUIC device through platform data,
38 * extcon-max77693 driver use 'default_init_data' to bring up base operation
39 * of MAX77693 MUIC device.
41 static struct max77693_reg_data default_init_data[] = {
43 /* STATUS2 - [3]ChgDetRun */
44 .addr = MAX77693_MUIC_REG_STATUS2,
45 .data = STATUS2_CHGDETRUN_MASK,
47 /* INTMASK1 - Unmask [3]ADC1KM,[0]ADCM */
48 .addr = MAX77693_MUIC_REG_INTMASK1,
49 .data = INTMASK1_ADC1K_MASK
52 /* INTMASK2 - Unmask [0]ChgTypM */
53 .addr = MAX77693_MUIC_REG_INTMASK2,
54 .data = INTMASK2_CHGTYP_MASK,
56 /* INTMASK3 - Mask all of interrupts */
57 .addr = MAX77693_MUIC_REG_INTMASK3,
61 .addr = MAX77693_MUIC_REG_CDETCTRL2,
62 .data = CDETCTRL2_VIDRMEN_MASK
63 | CDETCTRL2_DXOVPEN_MASK,
67 enum max77693_muic_adc_debounce_time {
68 ADC_DEBOUNCE_TIME_5MS = 0,
69 ADC_DEBOUNCE_TIME_10MS,
70 ADC_DEBOUNCE_TIME_25MS,
71 ADC_DEBOUNCE_TIME_38_62MS,
74 struct max77693_muic_info {
76 struct max77693_dev *max77693;
77 struct extcon_dev *edev;
79 int prev_cable_type_gnd;
85 struct work_struct irq_work;
89 * Use delayed workqueue to detect cable state and then
90 * notify cable state to notifiee/platform through uevent.
91 * After completing the booting of platform, the extcon provider
92 * driver should notify cable state to upper layer.
94 struct delayed_work wq_detcable;
96 /* Button of dock device */
97 struct input_dev *dock;
100 * Default usb/uart path whether UART/USB or AUX_UART/AUX_USB
101 * h/w path of COMP2/COMN1 on CONTROL1 register.
107 enum max77693_muic_cable_group {
108 MAX77693_CABLE_GROUP_ADC = 0,
109 MAX77693_CABLE_GROUP_ADC_GND,
110 MAX77693_CABLE_GROUP_CHG,
111 MAX77693_CABLE_GROUP_VBVOLT,
114 enum max77693_muic_charger_type {
115 MAX77693_CHARGER_TYPE_NONE = 0,
116 MAX77693_CHARGER_TYPE_USB,
117 MAX77693_CHARGER_TYPE_DOWNSTREAM_PORT,
118 MAX77693_CHARGER_TYPE_DEDICATED_CHG,
119 MAX77693_CHARGER_TYPE_APPLE_500MA,
120 MAX77693_CHARGER_TYPE_APPLE_1A_2A,
121 MAX77693_CHARGER_TYPE_DEAD_BATTERY = 7,
125 * struct max77693_muic_irq
126 * @irq: the index of irq list of MUIC device.
127 * @name: the name of irq.
128 * @virq: the virtual irq to use irq domain
130 struct max77693_muic_irq {
136 static struct max77693_muic_irq muic_irqs[] = {
137 { MAX77693_MUIC_IRQ_INT1_ADC, "muic-ADC" },
138 { MAX77693_MUIC_IRQ_INT1_ADC_LOW, "muic-ADCLOW" },
139 { MAX77693_MUIC_IRQ_INT1_ADC_ERR, "muic-ADCError" },
140 { MAX77693_MUIC_IRQ_INT1_ADC1K, "muic-ADC1K" },
141 { MAX77693_MUIC_IRQ_INT2_CHGTYP, "muic-CHGTYP" },
142 { MAX77693_MUIC_IRQ_INT2_CHGDETREUN, "muic-CHGDETREUN" },
143 { MAX77693_MUIC_IRQ_INT2_DCDTMR, "muic-DCDTMR" },
144 { MAX77693_MUIC_IRQ_INT2_DXOVP, "muic-DXOVP" },
145 { MAX77693_MUIC_IRQ_INT2_VBVOLT, "muic-VBVOLT" },
146 { MAX77693_MUIC_IRQ_INT2_VIDRM, "muic-VIDRM" },
147 { MAX77693_MUIC_IRQ_INT3_EOC, "muic-EOC" },
148 { MAX77693_MUIC_IRQ_INT3_CGMBC, "muic-CGMBC" },
149 { MAX77693_MUIC_IRQ_INT3_OVP, "muic-OVP" },
150 { MAX77693_MUIC_IRQ_INT3_MBCCHG_ERR, "muic-MBCCHG_ERR" },
151 { MAX77693_MUIC_IRQ_INT3_CHG_ENABLED, "muic-CHG_ENABLED" },
152 { MAX77693_MUIC_IRQ_INT3_BAT_DET, "muic-BAT_DET" },
155 /* Define supported accessory type */
156 enum max77693_muic_acc_type {
157 MAX77693_MUIC_ADC_GROUND = 0x0,
158 MAX77693_MUIC_ADC_SEND_END_BUTTON,
159 MAX77693_MUIC_ADC_REMOTE_S1_BUTTON,
160 MAX77693_MUIC_ADC_REMOTE_S2_BUTTON,
161 MAX77693_MUIC_ADC_REMOTE_S3_BUTTON,
162 MAX77693_MUIC_ADC_REMOTE_S4_BUTTON,
163 MAX77693_MUIC_ADC_REMOTE_S5_BUTTON,
164 MAX77693_MUIC_ADC_REMOTE_S6_BUTTON,
165 MAX77693_MUIC_ADC_REMOTE_S7_BUTTON,
166 MAX77693_MUIC_ADC_REMOTE_S8_BUTTON,
167 MAX77693_MUIC_ADC_REMOTE_S9_BUTTON,
168 MAX77693_MUIC_ADC_REMOTE_S10_BUTTON,
169 MAX77693_MUIC_ADC_REMOTE_S11_BUTTON,
170 MAX77693_MUIC_ADC_REMOTE_S12_BUTTON,
171 MAX77693_MUIC_ADC_RESERVED_ACC_1,
172 MAX77693_MUIC_ADC_RESERVED_ACC_2,
173 MAX77693_MUIC_ADC_RESERVED_ACC_3,
174 MAX77693_MUIC_ADC_RESERVED_ACC_4,
175 MAX77693_MUIC_ADC_RESERVED_ACC_5,
176 MAX77693_MUIC_ADC_CEA936_AUDIO,
177 MAX77693_MUIC_ADC_PHONE_POWERED_DEV,
178 MAX77693_MUIC_ADC_TTY_CONVERTER,
179 MAX77693_MUIC_ADC_UART_CABLE,
180 MAX77693_MUIC_ADC_CEA936A_TYPE1_CHG,
181 MAX77693_MUIC_ADC_FACTORY_MODE_USB_OFF,
182 MAX77693_MUIC_ADC_FACTORY_MODE_USB_ON,
183 MAX77693_MUIC_ADC_AV_CABLE_NOLOAD,
184 MAX77693_MUIC_ADC_CEA936A_TYPE2_CHG,
185 MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF,
186 MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON,
187 MAX77693_MUIC_ADC_AUDIO_MODE_REMOTE,
188 MAX77693_MUIC_ADC_OPEN,
190 /* The below accessories have same ADC value so ADCLow and
191 ADC1K bit is used to separate specific accessory */
192 /* ADC|VBVolot|ADCLow|ADC1K| */
193 MAX77693_MUIC_GND_USB_OTG = 0x100, /* 0x0| 0| 0| 0| */
194 MAX77693_MUIC_GND_USB_OTG_VB = 0x104, /* 0x0| 1| 0| 0| */
195 MAX77693_MUIC_GND_AV_CABLE_LOAD = 0x102,/* 0x0| 0| 1| 0| */
196 MAX77693_MUIC_GND_MHL = 0x103, /* 0x0| 0| 1| 1| */
197 MAX77693_MUIC_GND_MHL_VB = 0x107, /* 0x0| 1| 1| 1| */
201 * MAX77693 MUIC device support below list of accessories(external connector)
204 EXTCON_CABLE_USB = 0,
205 EXTCON_CABLE_USB_HOST,
207 EXTCON_CABLE_FAST_CHARGER,
208 EXTCON_CABLE_SLOW_CHARGER,
209 EXTCON_CABLE_CHARGE_DOWNSTREAM,
212 EXTCON_CABLE_JIG_USB_ON,
213 EXTCON_CABLE_JIG_USB_OFF,
214 EXTCON_CABLE_JIG_UART_OFF,
215 EXTCON_CABLE_JIG_UART_ON,
216 EXTCON_CABLE_DOCK_SMART,
217 EXTCON_CABLE_DOCK_DESK,
218 EXTCON_CABLE_DOCK_AUDIO,
223 static const char *max77693_extcon_cable[] = {
224 [EXTCON_CABLE_USB] = "USB",
225 [EXTCON_CABLE_USB_HOST] = "USB-Host",
226 [EXTCON_CABLE_TA] = "TA",
227 [EXTCON_CABLE_FAST_CHARGER] = "Fast-charger",
228 [EXTCON_CABLE_SLOW_CHARGER] = "Slow-charger",
229 [EXTCON_CABLE_CHARGE_DOWNSTREAM] = "Charge-downstream",
230 [EXTCON_CABLE_MHL] = "MHL",
231 [EXTCON_CABLE_MHL_TA] = "MHL_TA",
232 [EXTCON_CABLE_JIG_USB_ON] = "JIG-USB-ON",
233 [EXTCON_CABLE_JIG_USB_OFF] = "JIG-USB-OFF",
234 [EXTCON_CABLE_JIG_UART_OFF] = "JIG-UART-OFF",
235 [EXTCON_CABLE_JIG_UART_ON] = "Dock-Car",
236 [EXTCON_CABLE_DOCK_SMART] = "Dock-Smart",
237 [EXTCON_CABLE_DOCK_DESK] = "Dock-Desk",
238 [EXTCON_CABLE_DOCK_AUDIO] = "Dock-Audio",
244 * max77693_muic_set_debounce_time - Set the debounce time of ADC
245 * @info: the instance including private data of max77693 MUIC
246 * @time: the debounce time of ADC
248 static int max77693_muic_set_debounce_time(struct max77693_muic_info *info,
249 enum max77693_muic_adc_debounce_time time)
254 case ADC_DEBOUNCE_TIME_5MS:
255 case ADC_DEBOUNCE_TIME_10MS:
256 case ADC_DEBOUNCE_TIME_25MS:
257 case ADC_DEBOUNCE_TIME_38_62MS:
258 ret = max77693_update_reg(info->max77693->regmap_muic,
259 MAX77693_MUIC_REG_CTRL3,
260 time << CONTROL3_ADCDBSET_SHIFT,
261 CONTROL3_ADCDBSET_MASK);
263 dev_err(info->dev, "failed to set ADC debounce time\n");
268 dev_err(info->dev, "invalid ADC debounce time\n");
276 * max77693_muic_set_path - Set hardware line according to attached cable
277 * @info: the instance including private data of max77693 MUIC
278 * @value: the path according to attached cable
279 * @attached: the state of cable (true:attached, false:detached)
281 * The max77693 MUIC device share outside H/W line among a varity of cables
282 * so, this function set internal path of H/W line according to the type of
285 static int max77693_muic_set_path(struct max77693_muic_info *info,
286 u8 val, bool attached)
294 ctrl1 = CONTROL1_SW_OPEN;
296 ret = max77693_update_reg(info->max77693->regmap_muic,
297 MAX77693_MUIC_REG_CTRL1, ctrl1, COMP_SW_MASK);
299 dev_err(info->dev, "failed to update MUIC register\n");
304 ctrl2 |= CONTROL2_CPEN_MASK; /* LowPwr=0, CPEn=1 */
306 ctrl2 |= CONTROL2_LOWPWR_MASK; /* LowPwr=1, CPEn=0 */
308 ret = max77693_update_reg(info->max77693->regmap_muic,
309 MAX77693_MUIC_REG_CTRL2, ctrl2,
310 CONTROL2_LOWPWR_MASK | CONTROL2_CPEN_MASK);
312 dev_err(info->dev, "failed to update MUIC register\n");
317 "CONTROL1 : 0x%02x, CONTROL2 : 0x%02x, state : %s\n",
318 ctrl1, ctrl2, attached ? "attached" : "detached");
324 * max77693_muic_get_cable_type - Return cable type and check cable state
325 * @info: the instance including private data of max77693 MUIC
326 * @group: the path according to attached cable
327 * @attached: store cable state and return
329 * This function check the cable state either attached or detached,
330 * and then divide precise type of cable according to cable group.
331 * - MAX77693_CABLE_GROUP_ADC
332 * - MAX77693_CABLE_GROUP_ADC_GND
333 * - MAX77693_CABLE_GROUP_CHG
334 * - MAX77693_CABLE_GROUP_VBVOLT
336 static int max77693_muic_get_cable_type(struct max77693_muic_info *info,
337 enum max77693_muic_cable_group group, bool *attached)
347 case MAX77693_CABLE_GROUP_ADC:
349 * Read ADC value to check cable type and decide cable state
350 * according to cable type
352 adc = info->status[0] & STATUS1_ADC_MASK;
353 adc >>= STATUS1_ADC_SHIFT;
356 * Check current cable state/cable type and store cable type
357 * (info->prev_cable_type) for handling cable when cable is
360 if (adc == MAX77693_MUIC_ADC_OPEN) {
363 cable_type = info->prev_cable_type;
364 info->prev_cable_type = MAX77693_MUIC_ADC_OPEN;
368 cable_type = info->prev_cable_type = adc;
371 case MAX77693_CABLE_GROUP_ADC_GND:
373 * Read ADC value to check cable type and decide cable state
374 * according to cable type
376 adc = info->status[0] & STATUS1_ADC_MASK;
377 adc >>= STATUS1_ADC_SHIFT;
380 * Check current cable state/cable type and store cable type
381 * (info->prev_cable_type/_gnd) for handling cable when cable
384 if (adc == MAX77693_MUIC_ADC_OPEN) {
387 cable_type = info->prev_cable_type_gnd;
388 info->prev_cable_type_gnd = MAX77693_MUIC_ADC_OPEN;
392 adclow = info->status[0] & STATUS1_ADCLOW_MASK;
393 adclow >>= STATUS1_ADCLOW_SHIFT;
394 adc1k = info->status[0] & STATUS1_ADC1K_MASK;
395 adc1k >>= STATUS1_ADC1K_SHIFT;
397 vbvolt = info->status[1] & STATUS2_VBVOLT_MASK;
398 vbvolt >>= STATUS2_VBVOLT_SHIFT;
401 * [0x1|VBVolt|ADCLow|ADC1K]
402 * [0x1| 0| 0| 0] USB_OTG
403 * [0x1| 1| 0| 0] USB_OTG_VB
404 * [0x1| 0| 1| 0] Audio Video cable with load
405 * [0x1| 0| 1| 1] MHL without charging cable
406 * [0x1| 1| 1| 1] MHL with charging cable
408 cable_type = ((0x1 << 8)
413 info->prev_cable_type = adc;
414 info->prev_cable_type_gnd = cable_type;
418 case MAX77693_CABLE_GROUP_CHG:
420 * Read charger type to check cable type and decide cable state
421 * according to type of charger cable.
423 chg_type = info->status[1] & STATUS2_CHGTYP_MASK;
424 chg_type >>= STATUS2_CHGTYP_SHIFT;
426 if (chg_type == MAX77693_CHARGER_TYPE_NONE) {
429 cable_type = info->prev_chg_type;
430 info->prev_chg_type = MAX77693_CHARGER_TYPE_NONE;
435 * Check current cable state/cable type and store cable
436 * type(info->prev_chg_type) for handling cable when
437 * charger cable is detached.
439 cable_type = info->prev_chg_type = chg_type;
443 case MAX77693_CABLE_GROUP_VBVOLT:
445 * Read ADC value to check cable type and decide cable state
446 * according to cable type
448 adc = info->status[0] & STATUS1_ADC_MASK;
449 adc >>= STATUS1_ADC_SHIFT;
450 chg_type = info->status[1] & STATUS2_CHGTYP_MASK;
451 chg_type >>= STATUS2_CHGTYP_SHIFT;
453 if (adc == MAX77693_MUIC_ADC_OPEN
454 && chg_type == MAX77693_CHARGER_TYPE_NONE)
460 * Read vbvolt field, if vbvolt is 1,
461 * this cable is used for charging.
463 vbvolt = info->status[1] & STATUS2_VBVOLT_MASK;
464 vbvolt >>= STATUS2_VBVOLT_SHIFT;
469 dev_err(info->dev, "Unknown cable group (%d)\n", group);
470 cable_type = -EINVAL;
477 static int max77693_muic_dock_handler(struct max77693_muic_info *info,
478 int cable_type, bool attached)
483 char dock_name[CABLE_NAME_MAX];
486 "external connector is %s (adc:0x%02x)\n",
487 attached ? "attached" : "detached", cable_type);
489 switch (cable_type) {
490 case MAX77693_MUIC_ADC_RESERVED_ACC_3: /* Dock-Smart */
492 * Check power cable whether attached or detached state.
493 * The Dock-Smart device need surely external power supply.
494 * If power cable(USB/TA) isn't connected to Dock device,
495 * user can't use Dock-Smart for desktop mode.
497 vbvolt = max77693_muic_get_cable_type(info,
498 MAX77693_CABLE_GROUP_VBVOLT, &cable_attached);
499 if (attached && !vbvolt) {
501 "Cannot detect external power supply\n");
506 * Notify Dock-Smart/MHL state.
507 * - Dock-Smart device include three type of cable which
508 * are HDMI, USB for mouse/keyboard and micro-usb port
509 * for USB/TA cable. Dock-Smart device need always exteranl
510 * power supply(USB/TA cable through micro-usb cable). Dock-
511 * Smart device support screen output of target to separate
512 * monitor and mouse/keyboard for desktop mode.
514 * Features of 'USB/TA cable with Dock-Smart device'
516 * - Support external output feature of audio
517 * - Support charging through micro-usb port without data
518 * connection if TA cable is connected to target.
519 * - Support charging and data connection through micro-usb port
520 * if USB cable is connected between target and host
522 * - Support OTG device (Mouse/Keyboard)
524 ret = max77693_muic_set_path(info, info->path_usb, attached);
528 extcon_set_cable_state(info->edev, "Dock-Smart", attached);
529 extcon_set_cable_state(info->edev, "MHL", attached);
531 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON: /* Dock-Car */
532 strcpy(dock_name, "Dock-Car");
534 case MAX77693_MUIC_ADC_AUDIO_MODE_REMOTE: /* Dock-Desk */
535 strcpy(dock_name, "Dock-Desk");
537 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD: /* Dock-Audio */
538 strcpy(dock_name, "Dock-Audio");
540 extcon_set_cable_state(info->edev, "USB", false);
543 dev_err(info->dev, "failed to detect %s dock device\n",
544 attached ? "attached" : "detached");
548 /* Dock-Car/Desk/Audio, PATH:AUDIO */
549 ret = max77693_muic_set_path(info, CONTROL1_SW_AUDIO, attached);
552 extcon_set_cable_state(info->edev, dock_name, attached);
558 static int max77693_muic_dock_button_handler(struct max77693_muic_info *info,
559 int button_type, bool attached)
561 struct input_dev *dock = info->dock;
564 switch (button_type) {
565 case MAX77693_MUIC_ADC_REMOTE_S3_BUTTON-1
566 ... MAX77693_MUIC_ADC_REMOTE_S3_BUTTON+1:
568 code = KEY_PREVIOUSSONG;
570 case MAX77693_MUIC_ADC_REMOTE_S7_BUTTON-1
571 ... MAX77693_MUIC_ADC_REMOTE_S7_BUTTON+1:
575 case MAX77693_MUIC_ADC_REMOTE_S9_BUTTON:
577 code = KEY_VOLUMEDOWN;
579 case MAX77693_MUIC_ADC_REMOTE_S10_BUTTON:
583 case MAX77693_MUIC_ADC_REMOTE_S12_BUTTON-1
584 ... MAX77693_MUIC_ADC_REMOTE_S12_BUTTON+1:
585 /* DOCK_KEY_PLAY_PAUSE */
586 code = KEY_PLAYPAUSE;
590 "failed to detect %s key (adc:0x%x)\n",
591 attached ? "pressed" : "released", button_type);
595 input_event(dock, EV_KEY, code, attached);
601 static int max77693_muic_adc_ground_handler(struct max77693_muic_info *info)
607 cable_type_gnd = max77693_muic_get_cable_type(info,
608 MAX77693_CABLE_GROUP_ADC_GND, &attached);
610 switch (cable_type_gnd) {
611 case MAX77693_MUIC_GND_USB_OTG:
612 case MAX77693_MUIC_GND_USB_OTG_VB:
613 /* USB_OTG, PATH: AP_USB */
614 ret = max77693_muic_set_path(info, CONTROL1_SW_USB, attached);
617 extcon_set_cable_state(info->edev, "USB-Host", attached);
619 case MAX77693_MUIC_GND_AV_CABLE_LOAD:
620 /* Audio Video Cable with load, PATH:AUDIO */
621 ret = max77693_muic_set_path(info, CONTROL1_SW_AUDIO, attached);
624 extcon_set_cable_state(info->edev,
625 "Audio-video-load", attached);
627 case MAX77693_MUIC_GND_MHL:
628 case MAX77693_MUIC_GND_MHL_VB:
629 /* MHL or MHL with USB/TA cable */
630 extcon_set_cable_state(info->edev, "MHL", attached);
633 dev_err(info->dev, "failed to detect %s cable of gnd type\n",
634 attached ? "attached" : "detached");
641 static int max77693_muic_jig_handler(struct max77693_muic_info *info,
642 int cable_type, bool attached)
646 u8 path = CONTROL1_SW_OPEN;
649 "external connector is %s (adc:0x%02x)\n",
650 attached ? "attached" : "detached", cable_type);
652 switch (cable_type) {
653 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_OFF: /* ADC_JIG_USB_OFF */
655 strcpy(cable_name, "JIG-USB-OFF");
656 path = CONTROL1_SW_USB;
658 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_ON: /* ADC_JIG_USB_ON */
660 strcpy(cable_name, "JIG-USB-ON");
661 path = CONTROL1_SW_USB;
663 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF: /* ADC_JIG_UART_OFF */
665 strcpy(cable_name, "JIG-UART-OFF");
666 path = CONTROL1_SW_UART;
669 dev_err(info->dev, "failed to detect %s jig cable\n",
670 attached ? "attached" : "detached");
674 ret = max77693_muic_set_path(info, path, attached);
678 extcon_set_cable_state(info->edev, cable_name, attached);
683 static int max77693_muic_adc_handler(struct max77693_muic_info *info)
690 /* Check accessory state which is either detached or attached */
691 cable_type = max77693_muic_get_cable_type(info,
692 MAX77693_CABLE_GROUP_ADC, &attached);
695 "external connector is %s (adc:0x%02x, prev_adc:0x%x)\n",
696 attached ? "attached" : "detached", cable_type,
697 info->prev_cable_type);
699 switch (cable_type) {
700 case MAX77693_MUIC_ADC_GROUND:
701 /* USB_OTG/MHL/Audio */
702 max77693_muic_adc_ground_handler(info);
704 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_OFF:
705 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_ON:
706 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF:
708 ret = max77693_muic_jig_handler(info, cable_type, attached);
712 case MAX77693_MUIC_ADC_RESERVED_ACC_3: /* Dock-Smart */
713 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON: /* Dock-Car */
714 case MAX77693_MUIC_ADC_AUDIO_MODE_REMOTE: /* Dock-Desk */
715 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD: /* Dock-Audio */
719 * The MAX77693 MUIC device can detect total 34 cable type
720 * except of charger cable and MUIC device didn't define
721 * specfic role of cable in the range of from 0x01 to 0x12
722 * of ADC value. So, can use/define cable with no role according
723 * to schema of hardware board.
725 ret = max77693_muic_dock_handler(info, cable_type, attached);
729 case MAX77693_MUIC_ADC_REMOTE_S3_BUTTON: /* DOCK_KEY_PREV */
730 case MAX77693_MUIC_ADC_REMOTE_S7_BUTTON: /* DOCK_KEY_NEXT */
731 case MAX77693_MUIC_ADC_REMOTE_S9_BUTTON: /* DOCK_VOL_DOWN */
732 case MAX77693_MUIC_ADC_REMOTE_S10_BUTTON: /* DOCK_VOL_UP */
733 case MAX77693_MUIC_ADC_REMOTE_S12_BUTTON: /* DOCK_KEY_PLAY_PAUSE */
735 * Button of DOCK device
736 * - the Prev/Next/Volume Up/Volume Down/Play-Pause button
738 * The MAX77693 MUIC device can detect total 34 cable type
739 * except of charger cable and MUIC device didn't define
740 * specfic role of cable in the range of from 0x01 to 0x12
741 * of ADC value. So, can use/define cable with no role according
742 * to schema of hardware board.
745 button_type = info->prev_button_type = cable_type;
747 button_type = info->prev_button_type;
749 ret = max77693_muic_dock_button_handler(info, button_type,
754 case MAX77693_MUIC_ADC_SEND_END_BUTTON:
755 case MAX77693_MUIC_ADC_REMOTE_S1_BUTTON:
756 case MAX77693_MUIC_ADC_REMOTE_S2_BUTTON:
757 case MAX77693_MUIC_ADC_REMOTE_S4_BUTTON:
758 case MAX77693_MUIC_ADC_REMOTE_S5_BUTTON:
759 case MAX77693_MUIC_ADC_REMOTE_S6_BUTTON:
760 case MAX77693_MUIC_ADC_REMOTE_S8_BUTTON:
761 case MAX77693_MUIC_ADC_REMOTE_S11_BUTTON:
762 case MAX77693_MUIC_ADC_RESERVED_ACC_1:
763 case MAX77693_MUIC_ADC_RESERVED_ACC_2:
764 case MAX77693_MUIC_ADC_RESERVED_ACC_4:
765 case MAX77693_MUIC_ADC_RESERVED_ACC_5:
766 case MAX77693_MUIC_ADC_CEA936_AUDIO:
767 case MAX77693_MUIC_ADC_PHONE_POWERED_DEV:
768 case MAX77693_MUIC_ADC_TTY_CONVERTER:
769 case MAX77693_MUIC_ADC_UART_CABLE:
770 case MAX77693_MUIC_ADC_CEA936A_TYPE1_CHG:
771 case MAX77693_MUIC_ADC_CEA936A_TYPE2_CHG:
773 * This accessory isn't used in general case if it is specially
774 * needed to detect additional accessory, should implement
775 * proper operation when this accessory is attached/detached.
778 "accessory is %s but it isn't used (adc:0x%x)\n",
779 attached ? "attached" : "detached", cable_type);
783 "failed to detect %s accessory (adc:0x%x)\n",
784 attached ? "attached" : "detached", cable_type);
791 static int max77693_muic_chg_handler(struct max77693_muic_info *info)
800 chg_type = max77693_muic_get_cable_type(info,
801 MAX77693_CABLE_GROUP_CHG, &attached);
804 "external connector is %s(chg_type:0x%x, prev_chg_type:0x%x)\n",
805 attached ? "attached" : "detached",
806 chg_type, info->prev_chg_type);
809 case MAX77693_CHARGER_TYPE_USB:
810 case MAX77693_CHARGER_TYPE_DEDICATED_CHG:
811 case MAX77693_CHARGER_TYPE_NONE:
812 /* Check MAX77693_CABLE_GROUP_ADC_GND type */
813 cable_type_gnd = max77693_muic_get_cable_type(info,
814 MAX77693_CABLE_GROUP_ADC_GND,
816 switch (cable_type_gnd) {
817 case MAX77693_MUIC_GND_MHL:
818 case MAX77693_MUIC_GND_MHL_VB:
820 * MHL cable with MHL_TA(USB/TA) cable
821 * - MHL cable include two port(HDMI line and separate
822 * micro-usb port. When the target connect MHL cable,
823 * extcon driver check whether MHL_TA(USB/TA) cable is
824 * connected. If MHL_TA cable is connected, extcon
825 * driver notify state to notifiee for charging battery.
827 * Features of 'MHL_TA(USB/TA) with MHL cable'
829 * - Support charging through micro-usb port without
832 extcon_set_cable_state(info->edev, "MHL_TA", attached);
834 extcon_set_cable_state(info->edev,
835 "MHL", cable_attached);
839 /* Check MAX77693_CABLE_GROUP_ADC type */
840 cable_type = max77693_muic_get_cable_type(info,
841 MAX77693_CABLE_GROUP_ADC,
843 switch (cable_type) {
844 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD: /* Dock-Audio */
846 * Dock-Audio device with USB/TA cable
847 * - Dock device include two port(Dock-Audio and micro-
848 * usb port). When the target connect Dock-Audio device,
849 * extcon driver check whether USB/TA cable is connected
850 * or not. If USB/TA cable is connected, extcon driver
851 * notify state to notifiee for charging battery.
853 * Features of 'USB/TA cable with Dock-Audio device'
854 * - Support external output feature of audio.
855 * - Support charging through micro-usb port without
858 extcon_set_cable_state(info->edev, "USB", attached);
861 extcon_set_cable_state(info->edev, "Dock-Audio",
864 case MAX77693_MUIC_ADC_RESERVED_ACC_3: /* Dock-Smart */
866 * Dock-Smart device with USB/TA cable
867 * - Dock-Desk device include three type of cable which
868 * are HDMI, USB for mouse/keyboard and micro-usb port
869 * for USB/TA cable. Dock-Smart device need always
870 * exteranl power supply(USB/TA cable through micro-usb
871 * cable). Dock-Smart device support screen output of
872 * target to separate monitor and mouse/keyboard for
875 * Features of 'USB/TA cable with Dock-Smart device'
877 * - Support external output feature of audio
878 * - Support charging through micro-usb port without
879 * data connection if TA cable is connected to target.
880 * - Support charging and data connection through micro-
881 * usb port if USB cable is connected between target
883 * - Support OTG device (Mouse/Keyboard)
885 ret = max77693_muic_set_path(info, info->path_usb,
890 extcon_set_cable_state(info->edev, "Dock-Smart",
892 extcon_set_cable_state(info->edev, "MHL", attached);
897 /* Check MAX77693_CABLE_GROUP_CHG type */
899 case MAX77693_CHARGER_TYPE_NONE:
901 * When MHL(with USB/TA cable) or Dock-Audio with USB/TA
902 * cable is attached, muic device happen below two irq.
903 * - 'MAX77693_MUIC_IRQ_INT1_ADC' for detecting
905 * - 'MAX77693_MUIC_IRQ_INT2_CHGTYP' for detecting
906 * USB/TA cable connected to MHL or Dock-Audio.
907 * Always, happen eariler MAX77693_MUIC_IRQ_INT1_ADC
908 * irq than MAX77693_MUIC_IRQ_INT2_CHGTYP irq.
910 * If user attach MHL (with USB/TA cable and immediately
911 * detach MHL with USB/TA cable before MAX77693_MUIC_IRQ
912 * _INT2_CHGTYP irq is happened, USB/TA cable remain
913 * connected state to target. But USB/TA cable isn't
914 * connected to target. The user be face with unusual
915 * action. So, driver should check this situation in
916 * spite of, that previous charger type is N/A.
919 case MAX77693_CHARGER_TYPE_USB:
920 /* Only USB cable, PATH:AP_USB */
921 ret = max77693_muic_set_path(info, info->path_usb,
926 extcon_set_cable_state(info->edev, "USB", attached);
928 case MAX77693_CHARGER_TYPE_DEDICATED_CHG:
930 extcon_set_cable_state(info->edev, "TA", attached);
934 case MAX77693_CHARGER_TYPE_DOWNSTREAM_PORT:
935 extcon_set_cable_state(info->edev,
936 "Charge-downstream", attached);
938 case MAX77693_CHARGER_TYPE_APPLE_500MA:
939 extcon_set_cable_state(info->edev, "Slow-charger", attached);
941 case MAX77693_CHARGER_TYPE_APPLE_1A_2A:
942 extcon_set_cable_state(info->edev, "Fast-charger", attached);
944 case MAX77693_CHARGER_TYPE_DEAD_BATTERY:
948 "failed to detect %s accessory (chg_type:0x%x)\n",
949 attached ? "attached" : "detached", chg_type);
956 static void max77693_muic_irq_work(struct work_struct *work)
958 struct max77693_muic_info *info = container_of(work,
959 struct max77693_muic_info, irq_work);
966 mutex_lock(&info->mutex);
968 for (i = 0; i < ARRAY_SIZE(muic_irqs); i++)
969 if (info->irq == muic_irqs[i].virq)
970 irq_type = muic_irqs[i].irq;
972 ret = max77693_bulk_read(info->max77693->regmap_muic,
973 MAX77693_MUIC_REG_STATUS1, 2, info->status);
975 dev_err(info->dev, "failed to read MUIC register\n");
976 mutex_unlock(&info->mutex);
981 case MAX77693_MUIC_IRQ_INT1_ADC:
982 case MAX77693_MUIC_IRQ_INT1_ADC_LOW:
983 case MAX77693_MUIC_IRQ_INT1_ADC_ERR:
984 case MAX77693_MUIC_IRQ_INT1_ADC1K:
985 /* Handle all of accessory except for
986 type of charger accessory */
987 ret = max77693_muic_adc_handler(info);
989 case MAX77693_MUIC_IRQ_INT2_CHGTYP:
990 case MAX77693_MUIC_IRQ_INT2_CHGDETREUN:
991 case MAX77693_MUIC_IRQ_INT2_DCDTMR:
992 case MAX77693_MUIC_IRQ_INT2_DXOVP:
993 case MAX77693_MUIC_IRQ_INT2_VBVOLT:
994 case MAX77693_MUIC_IRQ_INT2_VIDRM:
995 /* Handle charger accessory */
996 ret = max77693_muic_chg_handler(info);
998 case MAX77693_MUIC_IRQ_INT3_EOC:
999 case MAX77693_MUIC_IRQ_INT3_CGMBC:
1000 case MAX77693_MUIC_IRQ_INT3_OVP:
1001 case MAX77693_MUIC_IRQ_INT3_MBCCHG_ERR:
1002 case MAX77693_MUIC_IRQ_INT3_CHG_ENABLED:
1003 case MAX77693_MUIC_IRQ_INT3_BAT_DET:
1006 dev_err(info->dev, "muic interrupt: irq %d occurred\n",
1008 mutex_unlock(&info->mutex);
1013 dev_err(info->dev, "failed to handle MUIC interrupt\n");
1015 mutex_unlock(&info->mutex);
1020 static irqreturn_t max77693_muic_irq_handler(int irq, void *data)
1022 struct max77693_muic_info *info = data;
1025 schedule_work(&info->irq_work);
1030 static struct regmap_config max77693_muic_regmap_config = {
1035 static int max77693_muic_detect_accessory(struct max77693_muic_info *info)
1042 mutex_lock(&info->mutex);
1044 /* Read STATUSx register to detect accessory */
1045 ret = max77693_bulk_read(info->max77693->regmap_muic,
1046 MAX77693_MUIC_REG_STATUS1, 2, info->status);
1048 dev_err(info->dev, "failed to read MUIC register\n");
1049 mutex_unlock(&info->mutex);
1053 adc = max77693_muic_get_cable_type(info, MAX77693_CABLE_GROUP_ADC,
1055 if (attached && adc != MAX77693_MUIC_ADC_OPEN) {
1056 ret = max77693_muic_adc_handler(info);
1058 dev_err(info->dev, "Cannot detect accessory\n");
1059 mutex_unlock(&info->mutex);
1064 chg_type = max77693_muic_get_cable_type(info, MAX77693_CABLE_GROUP_CHG,
1066 if (attached && chg_type != MAX77693_CHARGER_TYPE_NONE) {
1067 ret = max77693_muic_chg_handler(info);
1069 dev_err(info->dev, "Cannot detect charger accessory\n");
1070 mutex_unlock(&info->mutex);
1075 mutex_unlock(&info->mutex);
1080 static void max77693_muic_detect_cable_wq(struct work_struct *work)
1082 struct max77693_muic_info *info = container_of(to_delayed_work(work),
1083 struct max77693_muic_info, wq_detcable);
1085 max77693_muic_detect_accessory(info);
1088 static int max77693_muic_probe(struct platform_device *pdev)
1090 struct max77693_dev *max77693 = dev_get_drvdata(pdev->dev.parent);
1091 struct max77693_platform_data *pdata = dev_get_platdata(max77693->dev);
1092 struct max77693_muic_info *info;
1093 struct max77693_reg_data *init_data;
1100 info = devm_kzalloc(&pdev->dev, sizeof(struct max77693_muic_info),
1103 dev_err(&pdev->dev, "failed to allocate memory\n");
1106 info->dev = &pdev->dev;
1107 info->max77693 = max77693;
1108 if (info->max77693->regmap_muic) {
1109 dev_dbg(&pdev->dev, "allocate register map\n");
1111 info->max77693->regmap_muic = devm_regmap_init_i2c(
1112 info->max77693->muic,
1113 &max77693_muic_regmap_config);
1114 if (IS_ERR(info->max77693->regmap_muic)) {
1115 ret = PTR_ERR(info->max77693->regmap_muic);
1116 dev_err(max77693->dev,
1117 "failed to allocate register map: %d\n", ret);
1122 /* Register input device for button of dock device */
1123 info->dock = devm_input_allocate_device(&pdev->dev);
1125 dev_err(&pdev->dev, "%s: failed to allocate input\n", __func__);
1128 info->dock->name = "max77693-muic/dock";
1129 info->dock->phys = "max77693-muic/extcon";
1130 info->dock->dev.parent = &pdev->dev;
1132 __set_bit(EV_REP, info->dock->evbit);
1134 input_set_capability(info->dock, EV_KEY, KEY_VOLUMEUP);
1135 input_set_capability(info->dock, EV_KEY, KEY_VOLUMEDOWN);
1136 input_set_capability(info->dock, EV_KEY, KEY_PLAYPAUSE);
1137 input_set_capability(info->dock, EV_KEY, KEY_PREVIOUSSONG);
1138 input_set_capability(info->dock, EV_KEY, KEY_NEXTSONG);
1140 ret = input_register_device(info->dock);
1142 dev_err(&pdev->dev, "Cannot register input device error(%d)\n",
1147 platform_set_drvdata(pdev, info);
1148 mutex_init(&info->mutex);
1150 INIT_WORK(&info->irq_work, max77693_muic_irq_work);
1152 /* Support irq domain for MAX77693 MUIC device */
1153 for (i = 0; i < ARRAY_SIZE(muic_irqs); i++) {
1154 struct max77693_muic_irq *muic_irq = &muic_irqs[i];
1155 unsigned int virq = 0;
1157 virq = irq_create_mapping(max77693->irq_domain, muic_irq->irq);
1162 muic_irq->virq = virq;
1164 ret = request_threaded_irq(virq, NULL,
1165 max77693_muic_irq_handler,
1167 muic_irq->name, info);
1170 "failed: irq request (IRQ: %d,"
1172 muic_irq->irq, ret);
1177 /* Initialize extcon device */
1178 info->edev = devm_kzalloc(&pdev->dev, sizeof(struct extcon_dev),
1181 dev_err(&pdev->dev, "failed to allocate memory for extcon\n");
1185 info->edev->name = DEV_NAME;
1186 info->edev->dev.parent = &pdev->dev;
1187 info->edev->supported_cable = max77693_extcon_cable;
1188 ret = extcon_dev_register(info->edev);
1190 dev_err(&pdev->dev, "failed to register extcon device\n");
1195 /* Initialize MUIC register by using platform data or default data */
1196 if (pdata->muic_data) {
1197 init_data = pdata->muic_data->init_data;
1198 num_init_data = pdata->muic_data->num_init_data;
1200 init_data = default_init_data;
1201 num_init_data = ARRAY_SIZE(default_init_data);
1204 for (i = 0; i < num_init_data; i++) {
1205 enum max77693_irq_source irq_src
1206 = MAX77693_IRQ_GROUP_NR;
1208 max77693_write_reg(info->max77693->regmap_muic,
1212 switch (init_data[i].addr) {
1213 case MAX77693_MUIC_REG_INTMASK1:
1214 irq_src = MUIC_INT1;
1216 case MAX77693_MUIC_REG_INTMASK2:
1217 irq_src = MUIC_INT2;
1219 case MAX77693_MUIC_REG_INTMASK3:
1220 irq_src = MUIC_INT3;
1224 if (irq_src < MAX77693_IRQ_GROUP_NR)
1225 info->max77693->irq_masks_cur[irq_src]
1226 = init_data[i].data;
1229 if (pdata->muic_data) {
1230 struct max77693_muic_platform_data *muic_pdata
1234 * Default usb/uart path whether UART/USB or AUX_UART/AUX_USB
1235 * h/w path of COMP2/COMN1 on CONTROL1 register.
1237 if (muic_pdata->path_uart)
1238 info->path_uart = muic_pdata->path_uart;
1240 info->path_uart = CONTROL1_SW_UART;
1242 if (muic_pdata->path_usb)
1243 info->path_usb = muic_pdata->path_usb;
1245 info->path_usb = CONTROL1_SW_USB;
1248 * Default delay time for detecting cable state
1249 * after certain time.
1251 if (muic_pdata->detcable_delay_ms)
1253 msecs_to_jiffies(muic_pdata->detcable_delay_ms);
1255 delay_jiffies = msecs_to_jiffies(DELAY_MS_DEFAULT);
1257 info->path_usb = CONTROL1_SW_USB;
1258 info->path_uart = CONTROL1_SW_UART;
1259 delay_jiffies = msecs_to_jiffies(DELAY_MS_DEFAULT);
1262 /* Set initial path for UART */
1263 max77693_muic_set_path(info, info->path_uart, true);
1265 /* Check revision number of MUIC device*/
1266 ret = max77693_read_reg(info->max77693->regmap_muic,
1267 MAX77693_MUIC_REG_ID, &id);
1269 dev_err(&pdev->dev, "failed to read revision number\n");
1272 dev_info(info->dev, "device ID : 0x%x\n", id);
1274 /* Set ADC debounce time */
1275 max77693_muic_set_debounce_time(info, ADC_DEBOUNCE_TIME_25MS);
1278 * Detect accessory after completing the initialization of platform
1280 * - Use delayed workqueue to detect cable state and then
1281 * notify cable state to notifiee/platform through uevent.
1282 * After completing the booting of platform, the extcon provider
1283 * driver should notify cable state to upper layer.
1285 INIT_DELAYED_WORK(&info->wq_detcable, max77693_muic_detect_cable_wq);
1286 schedule_delayed_work(&info->wq_detcable, delay_jiffies);
1291 extcon_dev_unregister(info->edev);
1294 free_irq(muic_irqs[i].virq, info);
1298 static int max77693_muic_remove(struct platform_device *pdev)
1300 struct max77693_muic_info *info = platform_get_drvdata(pdev);
1303 for (i = 0; i < ARRAY_SIZE(muic_irqs); i++)
1304 free_irq(muic_irqs[i].virq, info);
1305 cancel_work_sync(&info->irq_work);
1306 input_unregister_device(info->dock);
1307 extcon_dev_unregister(info->edev);
1312 static struct platform_driver max77693_muic_driver = {
1315 .owner = THIS_MODULE,
1317 .probe = max77693_muic_probe,
1318 .remove = max77693_muic_remove,
1321 module_platform_driver(max77693_muic_driver);
1323 MODULE_DESCRIPTION("Maxim MAX77693 Extcon driver");
1324 MODULE_AUTHOR("Chanwoo Choi <cw00.choi@samsung.com>");
1325 MODULE_LICENSE("GPL");
1326 MODULE_ALIAS("platform:extcon-max77693");