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/devm-helpers.h>
9 #include <linux/kernel.h>
10 #include <linux/module.h>
11 #include <linux/i2c.h>
12 #include <linux/slab.h>
13 #include <linux/input.h>
14 #include <linux/interrupt.h>
15 #include <linux/err.h>
16 #include <linux/platform_device.h>
17 #include <linux/mfd/max77693.h>
18 #include <linux/mfd/max77693-common.h>
19 #include <linux/mfd/max77693-private.h>
20 #include <linux/extcon-provider.h>
21 #include <linux/regmap.h>
22 #include <linux/irqdomain.h>
24 #define DEV_NAME "max77693-muic"
25 #define DELAY_MS_DEFAULT 20000 /* unit: millisecond */
28 * Default value of MAX77693 register to bring up MUIC device.
29 * If user don't set some initial value for MUIC device through platform data,
30 * extcon-max77693 driver use 'default_init_data' to bring up base operation
31 * of MAX77693 MUIC device.
33 static struct max77693_reg_data default_init_data
[] = {
35 /* STATUS2 - [3]ChgDetRun */
36 .addr
= MAX77693_MUIC_REG_STATUS2
,
37 .data
= MAX77693_STATUS2_CHGDETRUN_MASK
,
39 /* INTMASK1 - Unmask [3]ADC1KM,[0]ADCM */
40 .addr
= MAX77693_MUIC_REG_INTMASK1
,
41 .data
= INTMASK1_ADC1K_MASK
44 /* INTMASK2 - Unmask [0]ChgTypM */
45 .addr
= MAX77693_MUIC_REG_INTMASK2
,
46 .data
= INTMASK2_CHGTYP_MASK
,
48 /* INTMASK3 - Mask all of interrupts */
49 .addr
= MAX77693_MUIC_REG_INTMASK3
,
53 .addr
= MAX77693_MUIC_REG_CDETCTRL2
,
54 .data
= CDETCTRL2_VIDRMEN_MASK
55 | CDETCTRL2_DXOVPEN_MASK
,
59 enum max77693_muic_adc_debounce_time
{
60 ADC_DEBOUNCE_TIME_5MS
= 0,
61 ADC_DEBOUNCE_TIME_10MS
,
62 ADC_DEBOUNCE_TIME_25MS
,
63 ADC_DEBOUNCE_TIME_38_62MS
,
66 struct max77693_muic_info
{
68 struct max77693_dev
*max77693
;
69 struct extcon_dev
*edev
;
71 int prev_cable_type_gnd
;
77 struct work_struct irq_work
;
81 * Use delayed workqueue to detect cable state and then
82 * notify cable state to notifiee/platform through uevent.
83 * After completing the booting of platform, the extcon provider
84 * driver should notify cable state to upper layer.
86 struct delayed_work wq_detcable
;
88 /* Button of dock device */
89 struct input_dev
*dock
;
92 * Default usb/uart path whether UART/USB or AUX_UART/AUX_USB
93 * h/w path of COMP2/COMN1 on CONTROL1 register.
99 enum max77693_muic_cable_group
{
100 MAX77693_CABLE_GROUP_ADC
= 0,
101 MAX77693_CABLE_GROUP_ADC_GND
,
102 MAX77693_CABLE_GROUP_CHG
,
103 MAX77693_CABLE_GROUP_VBVOLT
,
106 enum max77693_muic_charger_type
{
107 MAX77693_CHARGER_TYPE_NONE
= 0,
108 MAX77693_CHARGER_TYPE_USB
,
109 MAX77693_CHARGER_TYPE_DOWNSTREAM_PORT
,
110 MAX77693_CHARGER_TYPE_DEDICATED_CHG
,
111 MAX77693_CHARGER_TYPE_APPLE_500MA
,
112 MAX77693_CHARGER_TYPE_APPLE_1A_2A
,
113 MAX77693_CHARGER_TYPE_DEAD_BATTERY
= 7,
117 * struct max77693_muic_irq
118 * @irq: the index of irq list of MUIC device.
119 * @name: the name of irq.
120 * @virq: the virtual irq to use irq domain
122 struct max77693_muic_irq
{
128 static struct max77693_muic_irq muic_irqs
[] = {
129 { MAX77693_MUIC_IRQ_INT1_ADC
, "muic-ADC" },
130 { MAX77693_MUIC_IRQ_INT1_ADC_LOW
, "muic-ADCLOW" },
131 { MAX77693_MUIC_IRQ_INT1_ADC_ERR
, "muic-ADCError" },
132 { MAX77693_MUIC_IRQ_INT1_ADC1K
, "muic-ADC1K" },
133 { MAX77693_MUIC_IRQ_INT2_CHGTYP
, "muic-CHGTYP" },
134 { MAX77693_MUIC_IRQ_INT2_CHGDETREUN
, "muic-CHGDETREUN" },
135 { MAX77693_MUIC_IRQ_INT2_DCDTMR
, "muic-DCDTMR" },
136 { MAX77693_MUIC_IRQ_INT2_DXOVP
, "muic-DXOVP" },
137 { MAX77693_MUIC_IRQ_INT2_VBVOLT
, "muic-VBVOLT" },
138 { MAX77693_MUIC_IRQ_INT2_VIDRM
, "muic-VIDRM" },
139 { MAX77693_MUIC_IRQ_INT3_EOC
, "muic-EOC" },
140 { MAX77693_MUIC_IRQ_INT3_CGMBC
, "muic-CGMBC" },
141 { MAX77693_MUIC_IRQ_INT3_OVP
, "muic-OVP" },
142 { MAX77693_MUIC_IRQ_INT3_MBCCHG_ERR
, "muic-MBCCHG_ERR" },
143 { MAX77693_MUIC_IRQ_INT3_CHG_ENABLED
, "muic-CHG_ENABLED" },
144 { MAX77693_MUIC_IRQ_INT3_BAT_DET
, "muic-BAT_DET" },
147 /* Define supported accessory type */
148 enum max77693_muic_acc_type
{
149 MAX77693_MUIC_ADC_GROUND
= 0x0,
150 MAX77693_MUIC_ADC_SEND_END_BUTTON
,
151 MAX77693_MUIC_ADC_REMOTE_S1_BUTTON
,
152 MAX77693_MUIC_ADC_REMOTE_S2_BUTTON
,
153 MAX77693_MUIC_ADC_REMOTE_S3_BUTTON
,
154 MAX77693_MUIC_ADC_REMOTE_S4_BUTTON
,
155 MAX77693_MUIC_ADC_REMOTE_S5_BUTTON
,
156 MAX77693_MUIC_ADC_REMOTE_S6_BUTTON
,
157 MAX77693_MUIC_ADC_REMOTE_S7_BUTTON
,
158 MAX77693_MUIC_ADC_REMOTE_S8_BUTTON
,
159 MAX77693_MUIC_ADC_REMOTE_S9_BUTTON
,
160 MAX77693_MUIC_ADC_REMOTE_S10_BUTTON
,
161 MAX77693_MUIC_ADC_REMOTE_S11_BUTTON
,
162 MAX77693_MUIC_ADC_REMOTE_S12_BUTTON
,
163 MAX77693_MUIC_ADC_RESERVED_ACC_1
,
164 MAX77693_MUIC_ADC_RESERVED_ACC_2
,
165 MAX77693_MUIC_ADC_RESERVED_ACC_3
,
166 MAX77693_MUIC_ADC_RESERVED_ACC_4
,
167 MAX77693_MUIC_ADC_RESERVED_ACC_5
,
168 MAX77693_MUIC_ADC_CEA936_AUDIO
,
169 MAX77693_MUIC_ADC_PHONE_POWERED_DEV
,
170 MAX77693_MUIC_ADC_TTY_CONVERTER
,
171 MAX77693_MUIC_ADC_UART_CABLE
,
172 MAX77693_MUIC_ADC_CEA936A_TYPE1_CHG
,
173 MAX77693_MUIC_ADC_FACTORY_MODE_USB_OFF
,
174 MAX77693_MUIC_ADC_FACTORY_MODE_USB_ON
,
175 MAX77693_MUIC_ADC_AV_CABLE_NOLOAD
,
176 MAX77693_MUIC_ADC_CEA936A_TYPE2_CHG
,
177 MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF
,
178 MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON
,
179 MAX77693_MUIC_ADC_AUDIO_MODE_REMOTE
,
180 MAX77693_MUIC_ADC_OPEN
,
183 * The below accessories have same ADC value so ADCLow and
184 * ADC1K bit is used to separate specific accessory.
186 /* ADC|VBVolot|ADCLow|ADC1K| */
187 MAX77693_MUIC_GND_USB_HOST
= 0x100, /* 0x0| 0| 0| 0| */
188 MAX77693_MUIC_GND_USB_HOST_VB
= 0x104, /* 0x0| 1| 0| 0| */
189 MAX77693_MUIC_GND_AV_CABLE_LOAD
= 0x102,/* 0x0| 0| 1| 0| */
190 MAX77693_MUIC_GND_MHL
= 0x103, /* 0x0| 0| 1| 1| */
191 MAX77693_MUIC_GND_MHL_VB
= 0x107, /* 0x0| 1| 1| 1| */
195 * MAX77693 MUIC device support below list of accessories(external connector)
197 static const unsigned int max77693_extcon_cable
[] = {
212 * max77693_muic_set_debounce_time - Set the debounce time of ADC
213 * @info: the instance including private data of max77693 MUIC
214 * @time: the debounce time of ADC
216 static int max77693_muic_set_debounce_time(struct max77693_muic_info
*info
,
217 enum max77693_muic_adc_debounce_time time
)
222 case ADC_DEBOUNCE_TIME_5MS
:
223 case ADC_DEBOUNCE_TIME_10MS
:
224 case ADC_DEBOUNCE_TIME_25MS
:
225 case ADC_DEBOUNCE_TIME_38_62MS
:
227 * Don't touch BTLDset, JIGset when you want to change adc
228 * debounce time. If it writes other than 0 to BTLDset, JIGset
229 * muic device will be reset and loose current state.
231 ret
= regmap_write(info
->max77693
->regmap_muic
,
232 MAX77693_MUIC_REG_CTRL3
,
233 time
<< MAX77693_CONTROL3_ADCDBSET_SHIFT
);
235 dev_err(info
->dev
, "failed to set ADC debounce time\n");
240 dev_err(info
->dev
, "invalid ADC debounce time\n");
248 * max77693_muic_set_path - Set hardware line according to attached cable
249 * @info: the instance including private data of max77693 MUIC
250 * @value: the path according to attached cable
251 * @attached: the state of cable (true:attached, false:detached)
253 * The max77693 MUIC device share outside H/W line among a varity of cables
254 * so, this function set internal path of H/W line according to the type of
257 static int max77693_muic_set_path(struct max77693_muic_info
*info
,
258 u8 val
, bool attached
)
261 unsigned int ctrl1
, ctrl2
= 0;
266 ctrl1
= MAX77693_CONTROL1_SW_OPEN
;
268 ret
= regmap_update_bits(info
->max77693
->regmap_muic
,
269 MAX77693_MUIC_REG_CTRL1
, COMP_SW_MASK
, ctrl1
);
271 dev_err(info
->dev
, "failed to update MUIC register\n");
276 ctrl2
|= MAX77693_CONTROL2_CPEN_MASK
; /* LowPwr=0, CPEn=1 */
278 ctrl2
|= MAX77693_CONTROL2_LOWPWR_MASK
; /* LowPwr=1, CPEn=0 */
280 ret
= regmap_update_bits(info
->max77693
->regmap_muic
,
281 MAX77693_MUIC_REG_CTRL2
,
282 MAX77693_CONTROL2_LOWPWR_MASK
| MAX77693_CONTROL2_CPEN_MASK
,
285 dev_err(info
->dev
, "failed to update MUIC register\n");
290 "CONTROL1 : 0x%02x, CONTROL2 : 0x%02x, state : %s\n",
291 ctrl1
, ctrl2
, attached
? "attached" : "detached");
297 * max77693_muic_get_cable_type - Return cable type and check cable state
298 * @info: the instance including private data of max77693 MUIC
299 * @group: the path according to attached cable
300 * @attached: store cable state and return
302 * This function check the cable state either attached or detached,
303 * and then divide precise type of cable according to cable group.
304 * - MAX77693_CABLE_GROUP_ADC
305 * - MAX77693_CABLE_GROUP_ADC_GND
306 * - MAX77693_CABLE_GROUP_CHG
307 * - MAX77693_CABLE_GROUP_VBVOLT
309 static int max77693_muic_get_cable_type(struct max77693_muic_info
*info
,
310 enum max77693_muic_cable_group group
, bool *attached
)
320 case MAX77693_CABLE_GROUP_ADC
:
322 * Read ADC value to check cable type and decide cable state
323 * according to cable type
325 adc
= info
->status
[0] & MAX77693_STATUS1_ADC_MASK
;
326 adc
>>= MAX77693_STATUS1_ADC_SHIFT
;
329 * Check current cable state/cable type and store cable type
330 * (info->prev_cable_type) for handling cable when cable is
333 if (adc
== MAX77693_MUIC_ADC_OPEN
) {
336 cable_type
= info
->prev_cable_type
;
337 info
->prev_cable_type
= MAX77693_MUIC_ADC_OPEN
;
341 cable_type
= info
->prev_cable_type
= adc
;
344 case MAX77693_CABLE_GROUP_ADC_GND
:
346 * Read ADC value to check cable type and decide cable state
347 * according to cable type
349 adc
= info
->status
[0] & MAX77693_STATUS1_ADC_MASK
;
350 adc
>>= MAX77693_STATUS1_ADC_SHIFT
;
353 * Check current cable state/cable type and store cable type
354 * (info->prev_cable_type/_gnd) for handling cable when cable
357 if (adc
== MAX77693_MUIC_ADC_OPEN
) {
360 cable_type
= info
->prev_cable_type_gnd
;
361 info
->prev_cable_type_gnd
= MAX77693_MUIC_ADC_OPEN
;
365 adclow
= info
->status
[0] & MAX77693_STATUS1_ADCLOW_MASK
;
366 adclow
>>= MAX77693_STATUS1_ADCLOW_SHIFT
;
367 adc1k
= info
->status
[0] & MAX77693_STATUS1_ADC1K_MASK
;
368 adc1k
>>= MAX77693_STATUS1_ADC1K_SHIFT
;
370 vbvolt
= info
->status
[1] & MAX77693_STATUS2_VBVOLT_MASK
;
371 vbvolt
>>= MAX77693_STATUS2_VBVOLT_SHIFT
;
374 * [0x1|VBVolt|ADCLow|ADC1K]
375 * [0x1| 0| 0| 0] USB_HOST
376 * [0x1| 1| 0| 0] USB_HSOT_VB
377 * [0x1| 0| 1| 0] Audio Video cable with load
378 * [0x1| 0| 1| 1] MHL without charging cable
379 * [0x1| 1| 1| 1] MHL with charging cable
381 cable_type
= ((0x1 << 8)
386 info
->prev_cable_type
= adc
;
387 info
->prev_cable_type_gnd
= cable_type
;
391 case MAX77693_CABLE_GROUP_CHG
:
393 * Read charger type to check cable type and decide cable state
394 * according to type of charger cable.
396 chg_type
= info
->status
[1] & MAX77693_STATUS2_CHGTYP_MASK
;
397 chg_type
>>= MAX77693_STATUS2_CHGTYP_SHIFT
;
399 if (chg_type
== MAX77693_CHARGER_TYPE_NONE
) {
402 cable_type
= info
->prev_chg_type
;
403 info
->prev_chg_type
= MAX77693_CHARGER_TYPE_NONE
;
408 * Check current cable state/cable type and store cable
409 * type(info->prev_chg_type) for handling cable when
410 * charger cable is detached.
412 cable_type
= info
->prev_chg_type
= chg_type
;
416 case MAX77693_CABLE_GROUP_VBVOLT
:
418 * Read ADC value to check cable type and decide cable state
419 * according to cable type
421 adc
= info
->status
[0] & MAX77693_STATUS1_ADC_MASK
;
422 adc
>>= MAX77693_STATUS1_ADC_SHIFT
;
423 chg_type
= info
->status
[1] & MAX77693_STATUS2_CHGTYP_MASK
;
424 chg_type
>>= MAX77693_STATUS2_CHGTYP_SHIFT
;
426 if (adc
== MAX77693_MUIC_ADC_OPEN
427 && chg_type
== MAX77693_CHARGER_TYPE_NONE
)
433 * Read vbvolt field, if vbvolt is 1,
434 * this cable is used for charging.
436 vbvolt
= info
->status
[1] & MAX77693_STATUS2_VBVOLT_MASK
;
437 vbvolt
>>= MAX77693_STATUS2_VBVOLT_SHIFT
;
442 dev_err(info
->dev
, "Unknown cable group (%d)\n", group
);
443 cable_type
= -EINVAL
;
450 static int max77693_muic_dock_handler(struct max77693_muic_info
*info
,
451 int cable_type
, bool attached
)
456 unsigned int dock_id
;
459 "external connector is %s (adc:0x%02x)\n",
460 attached
? "attached" : "detached", cable_type
);
462 switch (cable_type
) {
463 case MAX77693_MUIC_ADC_RESERVED_ACC_3
: /* Dock-Smart */
465 * Check power cable whether attached or detached state.
466 * The Dock-Smart device need surely external power supply.
467 * If power cable(USB/TA) isn't connected to Dock device,
468 * user can't use Dock-Smart for desktop mode.
470 vbvolt
= max77693_muic_get_cable_type(info
,
471 MAX77693_CABLE_GROUP_VBVOLT
, &cable_attached
);
472 if (attached
&& !vbvolt
) {
474 "Cannot detect external power supply\n");
479 * Notify Dock/MHL state.
480 * - Dock device include three type of cable which
481 * are HDMI, USB for mouse/keyboard and micro-usb port
482 * for USB/TA cable. Dock device need always exteranl
483 * power supply(USB/TA cable through micro-usb cable). Dock
484 * device support screen output of target to separate
485 * monitor and mouse/keyboard for desktop mode.
487 * Features of 'USB/TA cable with Dock device'
489 * - Support external output feature of audio
490 * - Support charging through micro-usb port without data
491 * connection if TA cable is connected to target.
492 * - Support charging and data connection through micro-usb port
493 * if USB cable is connected between target and host
495 * - Support OTG(On-The-Go) device (Ex: Mouse/Keyboard)
497 ret
= max77693_muic_set_path(info
, info
->path_usb
, attached
);
501 extcon_set_state_sync(info
->edev
, EXTCON_DOCK
, attached
);
502 extcon_set_state_sync(info
->edev
, EXTCON_DISP_MHL
, attached
);
504 case MAX77693_MUIC_ADC_AUDIO_MODE_REMOTE
: /* Dock-Desk */
505 dock_id
= EXTCON_DOCK
;
507 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD
: /* Dock-Audio */
508 dock_id
= EXTCON_DOCK
;
510 extcon_set_state_sync(info
->edev
, EXTCON_USB
, false);
511 extcon_set_state_sync(info
->edev
, EXTCON_CHG_USB_SDP
,
516 dev_err(info
->dev
, "failed to detect %s dock device\n",
517 attached
? "attached" : "detached");
521 /* Dock-Car/Desk/Audio, PATH:AUDIO */
522 ret
= max77693_muic_set_path(info
, MAX77693_CONTROL1_SW_AUDIO
,
526 extcon_set_state_sync(info
->edev
, dock_id
, attached
);
532 static int max77693_muic_dock_button_handler(struct max77693_muic_info
*info
,
533 int button_type
, bool attached
)
535 struct input_dev
*dock
= info
->dock
;
538 switch (button_type
) {
539 case MAX77693_MUIC_ADC_REMOTE_S3_BUTTON
-1
540 ... MAX77693_MUIC_ADC_REMOTE_S3_BUTTON
+1:
542 code
= KEY_PREVIOUSSONG
;
544 case MAX77693_MUIC_ADC_REMOTE_S7_BUTTON
-1
545 ... MAX77693_MUIC_ADC_REMOTE_S7_BUTTON
+1:
549 case MAX77693_MUIC_ADC_REMOTE_S9_BUTTON
:
551 code
= KEY_VOLUMEDOWN
;
553 case MAX77693_MUIC_ADC_REMOTE_S10_BUTTON
:
557 case MAX77693_MUIC_ADC_REMOTE_S12_BUTTON
-1
558 ... MAX77693_MUIC_ADC_REMOTE_S12_BUTTON
+1:
559 /* DOCK_KEY_PLAY_PAUSE */
560 code
= KEY_PLAYPAUSE
;
564 "failed to detect %s key (adc:0x%x)\n",
565 attached
? "pressed" : "released", button_type
);
569 input_event(dock
, EV_KEY
, code
, attached
);
575 static int max77693_muic_adc_ground_handler(struct max77693_muic_info
*info
)
581 cable_type_gnd
= max77693_muic_get_cable_type(info
,
582 MAX77693_CABLE_GROUP_ADC_GND
, &attached
);
584 switch (cable_type_gnd
) {
585 case MAX77693_MUIC_GND_USB_HOST
:
586 case MAX77693_MUIC_GND_USB_HOST_VB
:
587 /* USB_HOST, PATH: AP_USB */
588 ret
= max77693_muic_set_path(info
, MAX77693_CONTROL1_SW_USB
,
592 extcon_set_state_sync(info
->edev
, EXTCON_USB_HOST
, attached
);
594 case MAX77693_MUIC_GND_AV_CABLE_LOAD
:
595 /* Audio Video Cable with load, PATH:AUDIO */
596 ret
= max77693_muic_set_path(info
, MAX77693_CONTROL1_SW_AUDIO
,
600 extcon_set_state_sync(info
->edev
, EXTCON_USB
, attached
);
601 extcon_set_state_sync(info
->edev
, EXTCON_CHG_USB_SDP
,
604 case MAX77693_MUIC_GND_MHL
:
605 case MAX77693_MUIC_GND_MHL_VB
:
606 /* MHL or MHL with USB/TA cable */
607 extcon_set_state_sync(info
->edev
, EXTCON_DISP_MHL
, attached
);
610 dev_err(info
->dev
, "failed to detect %s cable of gnd type\n",
611 attached
? "attached" : "detached");
618 static int max77693_muic_jig_handler(struct max77693_muic_info
*info
,
619 int cable_type
, bool attached
)
622 u8 path
= MAX77693_CONTROL1_SW_OPEN
;
625 "external connector is %s (adc:0x%02x)\n",
626 attached
? "attached" : "detached", cable_type
);
628 switch (cable_type
) {
629 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_OFF
: /* ADC_JIG_USB_OFF */
630 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_ON
: /* ADC_JIG_USB_ON */
632 path
= MAX77693_CONTROL1_SW_USB
;
634 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF
: /* ADC_JIG_UART_OFF */
635 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON
: /* ADC_JIG_UART_ON */
637 path
= MAX77693_CONTROL1_SW_UART
;
640 dev_err(info
->dev
, "failed to detect %s jig cable\n",
641 attached
? "attached" : "detached");
645 ret
= max77693_muic_set_path(info
, path
, attached
);
649 extcon_set_state_sync(info
->edev
, EXTCON_JIG
, attached
);
654 static int max77693_muic_adc_handler(struct max77693_muic_info
*info
)
661 /* Check accessory state which is either detached or attached */
662 cable_type
= max77693_muic_get_cable_type(info
,
663 MAX77693_CABLE_GROUP_ADC
, &attached
);
666 "external connector is %s (adc:0x%02x, prev_adc:0x%x)\n",
667 attached
? "attached" : "detached", cable_type
,
668 info
->prev_cable_type
);
670 switch (cable_type
) {
671 case MAX77693_MUIC_ADC_GROUND
:
672 /* USB_HOST/MHL/Audio */
673 max77693_muic_adc_ground_handler(info
);
675 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_OFF
:
676 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_ON
:
677 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF
:
678 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON
:
680 ret
= max77693_muic_jig_handler(info
, cable_type
, attached
);
684 case MAX77693_MUIC_ADC_RESERVED_ACC_3
: /* Dock-Smart */
685 case MAX77693_MUIC_ADC_AUDIO_MODE_REMOTE
: /* Dock-Desk */
686 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD
: /* Dock-Audio */
690 * The MAX77693 MUIC device can detect total 34 cable type
691 * except of charger cable and MUIC device didn't define
692 * specfic role of cable in the range of from 0x01 to 0x12
693 * of ADC value. So, can use/define cable with no role according
694 * to schema of hardware board.
696 ret
= max77693_muic_dock_handler(info
, cable_type
, attached
);
700 case MAX77693_MUIC_ADC_REMOTE_S3_BUTTON
: /* DOCK_KEY_PREV */
701 case MAX77693_MUIC_ADC_REMOTE_S7_BUTTON
: /* DOCK_KEY_NEXT */
702 case MAX77693_MUIC_ADC_REMOTE_S9_BUTTON
: /* DOCK_VOL_DOWN */
703 case MAX77693_MUIC_ADC_REMOTE_S10_BUTTON
: /* DOCK_VOL_UP */
704 case MAX77693_MUIC_ADC_REMOTE_S12_BUTTON
: /* DOCK_KEY_PLAY_PAUSE */
706 * Button of DOCK device
707 * - the Prev/Next/Volume Up/Volume Down/Play-Pause button
709 * The MAX77693 MUIC device can detect total 34 cable type
710 * except of charger cable and MUIC device didn't define
711 * specfic role of cable in the range of from 0x01 to 0x12
712 * of ADC value. So, can use/define cable with no role according
713 * to schema of hardware board.
716 button_type
= info
->prev_button_type
= cable_type
;
718 button_type
= info
->prev_button_type
;
720 ret
= max77693_muic_dock_button_handler(info
, button_type
,
725 case MAX77693_MUIC_ADC_SEND_END_BUTTON
:
726 case MAX77693_MUIC_ADC_REMOTE_S1_BUTTON
:
727 case MAX77693_MUIC_ADC_REMOTE_S2_BUTTON
:
728 case MAX77693_MUIC_ADC_REMOTE_S4_BUTTON
:
729 case MAX77693_MUIC_ADC_REMOTE_S5_BUTTON
:
730 case MAX77693_MUIC_ADC_REMOTE_S6_BUTTON
:
731 case MAX77693_MUIC_ADC_REMOTE_S8_BUTTON
:
732 case MAX77693_MUIC_ADC_REMOTE_S11_BUTTON
:
733 case MAX77693_MUIC_ADC_RESERVED_ACC_1
:
734 case MAX77693_MUIC_ADC_RESERVED_ACC_2
:
735 case MAX77693_MUIC_ADC_RESERVED_ACC_4
:
736 case MAX77693_MUIC_ADC_RESERVED_ACC_5
:
737 case MAX77693_MUIC_ADC_CEA936_AUDIO
:
738 case MAX77693_MUIC_ADC_PHONE_POWERED_DEV
:
739 case MAX77693_MUIC_ADC_TTY_CONVERTER
:
740 case MAX77693_MUIC_ADC_UART_CABLE
:
741 case MAX77693_MUIC_ADC_CEA936A_TYPE1_CHG
:
742 case MAX77693_MUIC_ADC_CEA936A_TYPE2_CHG
:
744 * This accessory isn't used in general case if it is specially
745 * needed to detect additional accessory, should implement
746 * proper operation when this accessory is attached/detached.
749 "accessory is %s but it isn't used (adc:0x%x)\n",
750 attached
? "attached" : "detached", cable_type
);
754 "failed to detect %s accessory (adc:0x%x)\n",
755 attached
? "attached" : "detached", cable_type
);
762 static int max77693_muic_chg_handler(struct max77693_muic_info
*info
)
771 chg_type
= max77693_muic_get_cable_type(info
,
772 MAX77693_CABLE_GROUP_CHG
, &attached
);
775 "external connector is %s(chg_type:0x%x, prev_chg_type:0x%x)\n",
776 attached
? "attached" : "detached",
777 chg_type
, info
->prev_chg_type
);
780 case MAX77693_CHARGER_TYPE_USB
:
781 case MAX77693_CHARGER_TYPE_DEDICATED_CHG
:
782 case MAX77693_CHARGER_TYPE_NONE
:
783 /* Check MAX77693_CABLE_GROUP_ADC_GND type */
784 cable_type_gnd
= max77693_muic_get_cable_type(info
,
785 MAX77693_CABLE_GROUP_ADC_GND
,
787 switch (cable_type_gnd
) {
788 case MAX77693_MUIC_GND_MHL
:
789 case MAX77693_MUIC_GND_MHL_VB
:
791 * MHL cable with USB/TA cable
792 * - MHL cable include two port(HDMI line and separate
793 * micro-usb port. When the target connect MHL cable,
794 * extcon driver check whether USB/TA cable is
795 * connected. If USB/TA cable is connected, extcon
796 * driver notify state to notifiee for charging battery.
798 * Features of 'USB/TA with MHL cable'
800 * - Support charging through micro-usb port without
803 extcon_set_state_sync(info
->edev
, EXTCON_CHG_USB_DCP
,
805 extcon_set_state_sync(info
->edev
, EXTCON_DISP_MHL
,
810 /* Check MAX77693_CABLE_GROUP_ADC type */
811 cable_type
= max77693_muic_get_cable_type(info
,
812 MAX77693_CABLE_GROUP_ADC
,
814 switch (cable_type
) {
815 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD
: /* Dock-Audio */
817 * Dock-Audio device with USB/TA cable
818 * - Dock device include two port(Dock-Audio and micro-
819 * usb port). When the target connect Dock-Audio device,
820 * extcon driver check whether USB/TA cable is connected
821 * or not. If USB/TA cable is connected, extcon driver
822 * notify state to notifiee for charging battery.
824 * Features of 'USB/TA cable with Dock-Audio device'
825 * - Support external output feature of audio.
826 * - Support charging through micro-usb port without
829 extcon_set_state_sync(info
->edev
, EXTCON_USB
,
831 extcon_set_state_sync(info
->edev
, EXTCON_CHG_USB_SDP
,
835 extcon_set_state_sync(info
->edev
, EXTCON_DOCK
,
838 case MAX77693_MUIC_ADC_RESERVED_ACC_3
: /* Dock-Smart */
840 * Dock-Smart device with USB/TA cable
841 * - Dock-Desk device include three type of cable which
842 * are HDMI, USB for mouse/keyboard and micro-usb port
843 * for USB/TA cable. Dock-Smart device need always
844 * exteranl power supply(USB/TA cable through micro-usb
845 * cable). Dock-Smart device support screen output of
846 * target to separate monitor and mouse/keyboard for
849 * Features of 'USB/TA cable with Dock-Smart device'
851 * - Support external output feature of audio
852 * - Support charging through micro-usb port without
853 * data connection if TA cable is connected to target.
854 * - Support charging and data connection through micro-
855 * usb port if USB cable is connected between target
857 * - Support OTG(On-The-Go) device (Ex: Mouse/Keyboard)
859 ret
= max77693_muic_set_path(info
, info
->path_usb
,
864 extcon_set_state_sync(info
->edev
, EXTCON_DOCK
,
866 extcon_set_state_sync(info
->edev
, EXTCON_DISP_MHL
,
871 /* Check MAX77693_CABLE_GROUP_CHG type */
873 case MAX77693_CHARGER_TYPE_NONE
:
875 * When MHL(with USB/TA cable) or Dock-Audio with USB/TA
876 * cable is attached, muic device happen below two irq.
877 * - 'MAX77693_MUIC_IRQ_INT1_ADC' for detecting
879 * - 'MAX77693_MUIC_IRQ_INT2_CHGTYP' for detecting
880 * USB/TA cable connected to MHL or Dock-Audio.
881 * Always, happen eariler MAX77693_MUIC_IRQ_INT1_ADC
882 * irq than MAX77693_MUIC_IRQ_INT2_CHGTYP irq.
884 * If user attach MHL (with USB/TA cable and immediately
885 * detach MHL with USB/TA cable before MAX77693_MUIC_IRQ
886 * _INT2_CHGTYP irq is happened, USB/TA cable remain
887 * connected state to target. But USB/TA cable isn't
888 * connected to target. The user be face with unusual
889 * action. So, driver should check this situation in
890 * spite of, that previous charger type is N/A.
893 case MAX77693_CHARGER_TYPE_USB
:
894 /* Only USB cable, PATH:AP_USB */
895 ret
= max77693_muic_set_path(info
, info
->path_usb
,
900 extcon_set_state_sync(info
->edev
, EXTCON_USB
,
902 extcon_set_state_sync(info
->edev
, EXTCON_CHG_USB_SDP
,
905 case MAX77693_CHARGER_TYPE_DEDICATED_CHG
:
907 extcon_set_state_sync(info
->edev
, EXTCON_CHG_USB_DCP
,
912 case MAX77693_CHARGER_TYPE_DOWNSTREAM_PORT
:
913 extcon_set_state_sync(info
->edev
, EXTCON_CHG_USB_CDP
,
916 case MAX77693_CHARGER_TYPE_APPLE_500MA
:
917 extcon_set_state_sync(info
->edev
, EXTCON_CHG_USB_SLOW
,
920 case MAX77693_CHARGER_TYPE_APPLE_1A_2A
:
921 extcon_set_state_sync(info
->edev
, EXTCON_CHG_USB_FAST
,
924 case MAX77693_CHARGER_TYPE_DEAD_BATTERY
:
928 "failed to detect %s accessory (chg_type:0x%x)\n",
929 attached
? "attached" : "detached", chg_type
);
936 static void max77693_muic_irq_work(struct work_struct
*work
)
938 struct max77693_muic_info
*info
= container_of(work
,
939 struct max77693_muic_info
, irq_work
);
946 mutex_lock(&info
->mutex
);
948 for (i
= 0; i
< ARRAY_SIZE(muic_irqs
); i
++)
949 if (info
->irq
== muic_irqs
[i
].virq
)
950 irq_type
= muic_irqs
[i
].irq
;
952 ret
= regmap_bulk_read(info
->max77693
->regmap_muic
,
953 MAX77693_MUIC_REG_STATUS1
, info
->status
, 2);
955 dev_err(info
->dev
, "failed to read MUIC register\n");
956 mutex_unlock(&info
->mutex
);
961 case MAX77693_MUIC_IRQ_INT1_ADC
:
962 case MAX77693_MUIC_IRQ_INT1_ADC_LOW
:
963 case MAX77693_MUIC_IRQ_INT1_ADC_ERR
:
964 case MAX77693_MUIC_IRQ_INT1_ADC1K
:
966 * Handle all of accessory except for
967 * type of charger accessory.
969 ret
= max77693_muic_adc_handler(info
);
971 case MAX77693_MUIC_IRQ_INT2_CHGTYP
:
972 case MAX77693_MUIC_IRQ_INT2_CHGDETREUN
:
973 case MAX77693_MUIC_IRQ_INT2_DCDTMR
:
974 case MAX77693_MUIC_IRQ_INT2_DXOVP
:
975 case MAX77693_MUIC_IRQ_INT2_VBVOLT
:
976 case MAX77693_MUIC_IRQ_INT2_VIDRM
:
977 /* Handle charger accessory */
978 ret
= max77693_muic_chg_handler(info
);
980 case MAX77693_MUIC_IRQ_INT3_EOC
:
981 case MAX77693_MUIC_IRQ_INT3_CGMBC
:
982 case MAX77693_MUIC_IRQ_INT3_OVP
:
983 case MAX77693_MUIC_IRQ_INT3_MBCCHG_ERR
:
984 case MAX77693_MUIC_IRQ_INT3_CHG_ENABLED
:
985 case MAX77693_MUIC_IRQ_INT3_BAT_DET
:
988 dev_err(info
->dev
, "muic interrupt: irq %d occurred\n",
990 mutex_unlock(&info
->mutex
);
995 dev_err(info
->dev
, "failed to handle MUIC interrupt\n");
997 mutex_unlock(&info
->mutex
);
1000 static irqreturn_t
max77693_muic_irq_handler(int irq
, void *data
)
1002 struct max77693_muic_info
*info
= data
;
1005 schedule_work(&info
->irq_work
);
1010 static const struct regmap_config max77693_muic_regmap_config
= {
1015 static int max77693_muic_detect_accessory(struct max77693_muic_info
*info
)
1022 mutex_lock(&info
->mutex
);
1024 /* Read STATUSx register to detect accessory */
1025 ret
= regmap_bulk_read(info
->max77693
->regmap_muic
,
1026 MAX77693_MUIC_REG_STATUS1
, info
->status
, 2);
1028 dev_err(info
->dev
, "failed to read MUIC register\n");
1029 mutex_unlock(&info
->mutex
);
1033 adc
= max77693_muic_get_cable_type(info
, MAX77693_CABLE_GROUP_ADC
,
1035 if (attached
&& adc
!= MAX77693_MUIC_ADC_OPEN
) {
1036 ret
= max77693_muic_adc_handler(info
);
1038 dev_err(info
->dev
, "Cannot detect accessory\n");
1039 mutex_unlock(&info
->mutex
);
1044 chg_type
= max77693_muic_get_cable_type(info
, MAX77693_CABLE_GROUP_CHG
,
1046 if (attached
&& chg_type
!= MAX77693_CHARGER_TYPE_NONE
) {
1047 ret
= max77693_muic_chg_handler(info
);
1049 dev_err(info
->dev
, "Cannot detect charger accessory\n");
1050 mutex_unlock(&info
->mutex
);
1055 mutex_unlock(&info
->mutex
);
1060 static void max77693_muic_detect_cable_wq(struct work_struct
*work
)
1062 struct max77693_muic_info
*info
= container_of(to_delayed_work(work
),
1063 struct max77693_muic_info
, wq_detcable
);
1065 max77693_muic_detect_accessory(info
);
1068 static int max77693_muic_probe(struct platform_device
*pdev
)
1070 struct max77693_dev
*max77693
= dev_get_drvdata(pdev
->dev
.parent
);
1071 struct max77693_platform_data
*pdata
= dev_get_platdata(max77693
->dev
);
1072 struct max77693_muic_info
*info
;
1073 struct max77693_reg_data
*init_data
;
1082 info
= devm_kzalloc(&pdev
->dev
, sizeof(struct max77693_muic_info
),
1087 info
->dev
= &pdev
->dev
;
1088 info
->max77693
= max77693
;
1089 if (info
->max77693
->regmap_muic
) {
1090 dev_dbg(&pdev
->dev
, "allocate register map\n");
1092 info
->max77693
->regmap_muic
= devm_regmap_init_i2c(
1093 info
->max77693
->i2c_muic
,
1094 &max77693_muic_regmap_config
);
1095 if (IS_ERR(info
->max77693
->regmap_muic
)) {
1096 ret
= PTR_ERR(info
->max77693
->regmap_muic
);
1097 dev_err(max77693
->dev
,
1098 "failed to allocate register map: %d\n", ret
);
1103 /* Register input device for button of dock device */
1104 info
->dock
= devm_input_allocate_device(&pdev
->dev
);
1106 dev_err(&pdev
->dev
, "%s: failed to allocate input\n", __func__
);
1109 info
->dock
->name
= "max77693-muic/dock";
1110 info
->dock
->phys
= "max77693-muic/extcon";
1111 info
->dock
->dev
.parent
= &pdev
->dev
;
1113 __set_bit(EV_REP
, info
->dock
->evbit
);
1115 input_set_capability(info
->dock
, EV_KEY
, KEY_VOLUMEUP
);
1116 input_set_capability(info
->dock
, EV_KEY
, KEY_VOLUMEDOWN
);
1117 input_set_capability(info
->dock
, EV_KEY
, KEY_PLAYPAUSE
);
1118 input_set_capability(info
->dock
, EV_KEY
, KEY_PREVIOUSSONG
);
1119 input_set_capability(info
->dock
, EV_KEY
, KEY_NEXTSONG
);
1121 ret
= input_register_device(info
->dock
);
1123 dev_err(&pdev
->dev
, "Cannot register input device error(%d)\n",
1128 platform_set_drvdata(pdev
, info
);
1129 mutex_init(&info
->mutex
);
1131 ret
= devm_work_autocancel(&pdev
->dev
, &info
->irq_work
,
1132 max77693_muic_irq_work
);
1136 /* Support irq domain for MAX77693 MUIC device */
1137 for (i
= 0; i
< ARRAY_SIZE(muic_irqs
); i
++) {
1138 struct max77693_muic_irq
*muic_irq
= &muic_irqs
[i
];
1141 virq
= regmap_irq_get_virq(max77693
->irq_data_muic
,
1145 muic_irq
->virq
= virq
;
1147 ret
= devm_request_threaded_irq(&pdev
->dev
, virq
, NULL
,
1148 max77693_muic_irq_handler
,
1150 muic_irq
->name
, info
);
1153 "failed: irq request (IRQ: %d, error :%d)\n",
1154 muic_irq
->irq
, ret
);
1159 /* Initialize extcon device */
1160 info
->edev
= devm_extcon_dev_allocate(&pdev
->dev
,
1161 max77693_extcon_cable
);
1162 if (IS_ERR(info
->edev
)) {
1163 dev_err(&pdev
->dev
, "failed to allocate memory for extcon\n");
1164 return PTR_ERR(info
->edev
);
1167 ret
= devm_extcon_dev_register(&pdev
->dev
, info
->edev
);
1169 dev_err(&pdev
->dev
, "failed to register extcon device\n");
1173 /* Initialize MUIC register by using platform data or default data */
1174 if (pdata
&& pdata
->muic_data
) {
1175 init_data
= pdata
->muic_data
->init_data
;
1176 num_init_data
= pdata
->muic_data
->num_init_data
;
1178 init_data
= default_init_data
;
1179 num_init_data
= ARRAY_SIZE(default_init_data
);
1182 for (i
= 0; i
< num_init_data
; i
++) {
1183 regmap_write(info
->max77693
->regmap_muic
,
1188 if (pdata
&& pdata
->muic_data
) {
1189 struct max77693_muic_platform_data
*muic_pdata
1193 * Default usb/uart path whether UART/USB or AUX_UART/AUX_USB
1194 * h/w path of COMP2/COMN1 on CONTROL1 register.
1196 if (muic_pdata
->path_uart
)
1197 info
->path_uart
= muic_pdata
->path_uart
;
1199 info
->path_uart
= MAX77693_CONTROL1_SW_UART
;
1201 if (muic_pdata
->path_usb
)
1202 info
->path_usb
= muic_pdata
->path_usb
;
1204 info
->path_usb
= MAX77693_CONTROL1_SW_USB
;
1207 * Default delay time for detecting cable state
1208 * after certain time.
1210 if (muic_pdata
->detcable_delay_ms
)
1212 msecs_to_jiffies(muic_pdata
->detcable_delay_ms
);
1214 delay_jiffies
= msecs_to_jiffies(DELAY_MS_DEFAULT
);
1216 info
->path_usb
= MAX77693_CONTROL1_SW_USB
;
1217 info
->path_uart
= MAX77693_CONTROL1_SW_UART
;
1218 delay_jiffies
= msecs_to_jiffies(DELAY_MS_DEFAULT
);
1221 /* Set initial path for UART when JIG is connected to get serial logs */
1222 ret
= regmap_bulk_read(info
->max77693
->regmap_muic
,
1223 MAX77693_MUIC_REG_STATUS1
, info
->status
, 2);
1225 dev_err(info
->dev
, "failed to read MUIC register\n");
1228 cable_type
= max77693_muic_get_cable_type(info
,
1229 MAX77693_CABLE_GROUP_ADC
, &attached
);
1230 if (attached
&& (cable_type
== MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON
||
1231 cable_type
== MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF
))
1232 max77693_muic_set_path(info
, info
->path_uart
, true);
1234 /* Check revision number of MUIC device*/
1235 ret
= regmap_read(info
->max77693
->regmap_muic
,
1236 MAX77693_MUIC_REG_ID
, &id
);
1238 dev_err(&pdev
->dev
, "failed to read revision number\n");
1241 dev_info(info
->dev
, "device ID : 0x%x\n", id
);
1243 /* Set ADC debounce time */
1244 max77693_muic_set_debounce_time(info
, ADC_DEBOUNCE_TIME_25MS
);
1247 * Detect accessory after completing the initialization of platform
1249 * - Use delayed workqueue to detect cable state and then
1250 * notify cable state to notifiee/platform through uevent.
1251 * After completing the booting of platform, the extcon provider
1252 * driver should notify cable state to upper layer.
1254 INIT_DELAYED_WORK(&info
->wq_detcable
, max77693_muic_detect_cable_wq
);
1255 queue_delayed_work(system_power_efficient_wq
, &info
->wq_detcable
,
1261 static const struct of_device_id of_max77693_muic_dt_match
[] = {
1262 { .compatible
= "maxim,max77693-muic", },
1265 MODULE_DEVICE_TABLE(of
, of_max77693_muic_dt_match
);
1267 static struct platform_driver max77693_muic_driver
= {
1270 .of_match_table
= of_max77693_muic_dt_match
,
1272 .probe
= max77693_muic_probe
,
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:max77693-muic");