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-common.h>
28 #include <linux/mfd/max77693-private.h>
29 #include <linux/extcon.h>
30 #include <linux/regmap.h>
31 #include <linux/irqdomain.h>
33 #define DEV_NAME "max77693-muic"
34 #define DELAY_MS_DEFAULT 20000 /* unit: millisecond */
37 * Default value of MAX77693 register to bring up MUIC device.
38 * If user don't set some initial value for MUIC device through platform data,
39 * extcon-max77693 driver use 'default_init_data' to bring up base operation
40 * of MAX77693 MUIC device.
42 static struct max77693_reg_data default_init_data[] = {
44 /* STATUS2 - [3]ChgDetRun */
45 .addr = MAX77693_MUIC_REG_STATUS2,
46 .data = MAX77693_STATUS2_CHGDETRUN_MASK,
48 /* INTMASK1 - Unmask [3]ADC1KM,[0]ADCM */
49 .addr = MAX77693_MUIC_REG_INTMASK1,
50 .data = INTMASK1_ADC1K_MASK
53 /* INTMASK2 - Unmask [0]ChgTypM */
54 .addr = MAX77693_MUIC_REG_INTMASK2,
55 .data = INTMASK2_CHGTYP_MASK,
57 /* INTMASK3 - Mask all of interrupts */
58 .addr = MAX77693_MUIC_REG_INTMASK3,
62 .addr = MAX77693_MUIC_REG_CDETCTRL2,
63 .data = CDETCTRL2_VIDRMEN_MASK
64 | CDETCTRL2_DXOVPEN_MASK,
68 enum max77693_muic_adc_debounce_time {
69 ADC_DEBOUNCE_TIME_5MS = 0,
70 ADC_DEBOUNCE_TIME_10MS,
71 ADC_DEBOUNCE_TIME_25MS,
72 ADC_DEBOUNCE_TIME_38_62MS,
75 struct max77693_muic_info {
77 struct max77693_dev *max77693;
78 struct extcon_dev *edev;
80 int prev_cable_type_gnd;
86 struct work_struct irq_work;
90 * Use delayed workqueue to detect cable state and then
91 * notify cable state to notifiee/platform through uevent.
92 * After completing the booting of platform, the extcon provider
93 * driver should notify cable state to upper layer.
95 struct delayed_work wq_detcable;
97 /* Button of dock device */
98 struct input_dev *dock;
101 * Default usb/uart path whether UART/USB or AUX_UART/AUX_USB
102 * h/w path of COMP2/COMN1 on CONTROL1 register.
108 enum max77693_muic_cable_group {
109 MAX77693_CABLE_GROUP_ADC = 0,
110 MAX77693_CABLE_GROUP_ADC_GND,
111 MAX77693_CABLE_GROUP_CHG,
112 MAX77693_CABLE_GROUP_VBVOLT,
115 enum max77693_muic_charger_type {
116 MAX77693_CHARGER_TYPE_NONE = 0,
117 MAX77693_CHARGER_TYPE_USB,
118 MAX77693_CHARGER_TYPE_DOWNSTREAM_PORT,
119 MAX77693_CHARGER_TYPE_DEDICATED_CHG,
120 MAX77693_CHARGER_TYPE_APPLE_500MA,
121 MAX77693_CHARGER_TYPE_APPLE_1A_2A,
122 MAX77693_CHARGER_TYPE_DEAD_BATTERY = 7,
126 * struct max77693_muic_irq
127 * @irq: the index of irq list of MUIC device.
128 * @name: the name of irq.
129 * @virq: the virtual irq to use irq domain
131 struct max77693_muic_irq {
137 static struct max77693_muic_irq muic_irqs[] = {
138 { MAX77693_MUIC_IRQ_INT1_ADC, "muic-ADC" },
139 { MAX77693_MUIC_IRQ_INT1_ADC_LOW, "muic-ADCLOW" },
140 { MAX77693_MUIC_IRQ_INT1_ADC_ERR, "muic-ADCError" },
141 { MAX77693_MUIC_IRQ_INT1_ADC1K, "muic-ADC1K" },
142 { MAX77693_MUIC_IRQ_INT2_CHGTYP, "muic-CHGTYP" },
143 { MAX77693_MUIC_IRQ_INT2_CHGDETREUN, "muic-CHGDETREUN" },
144 { MAX77693_MUIC_IRQ_INT2_DCDTMR, "muic-DCDTMR" },
145 { MAX77693_MUIC_IRQ_INT2_DXOVP, "muic-DXOVP" },
146 { MAX77693_MUIC_IRQ_INT2_VBVOLT, "muic-VBVOLT" },
147 { MAX77693_MUIC_IRQ_INT2_VIDRM, "muic-VIDRM" },
148 { MAX77693_MUIC_IRQ_INT3_EOC, "muic-EOC" },
149 { MAX77693_MUIC_IRQ_INT3_CGMBC, "muic-CGMBC" },
150 { MAX77693_MUIC_IRQ_INT3_OVP, "muic-OVP" },
151 { MAX77693_MUIC_IRQ_INT3_MBCCHG_ERR, "muic-MBCCHG_ERR" },
152 { MAX77693_MUIC_IRQ_INT3_CHG_ENABLED, "muic-CHG_ENABLED" },
153 { MAX77693_MUIC_IRQ_INT3_BAT_DET, "muic-BAT_DET" },
156 /* Define supported accessory type */
157 enum max77693_muic_acc_type {
158 MAX77693_MUIC_ADC_GROUND = 0x0,
159 MAX77693_MUIC_ADC_SEND_END_BUTTON,
160 MAX77693_MUIC_ADC_REMOTE_S1_BUTTON,
161 MAX77693_MUIC_ADC_REMOTE_S2_BUTTON,
162 MAX77693_MUIC_ADC_REMOTE_S3_BUTTON,
163 MAX77693_MUIC_ADC_REMOTE_S4_BUTTON,
164 MAX77693_MUIC_ADC_REMOTE_S5_BUTTON,
165 MAX77693_MUIC_ADC_REMOTE_S6_BUTTON,
166 MAX77693_MUIC_ADC_REMOTE_S7_BUTTON,
167 MAX77693_MUIC_ADC_REMOTE_S8_BUTTON,
168 MAX77693_MUIC_ADC_REMOTE_S9_BUTTON,
169 MAX77693_MUIC_ADC_REMOTE_S10_BUTTON,
170 MAX77693_MUIC_ADC_REMOTE_S11_BUTTON,
171 MAX77693_MUIC_ADC_REMOTE_S12_BUTTON,
172 MAX77693_MUIC_ADC_RESERVED_ACC_1,
173 MAX77693_MUIC_ADC_RESERVED_ACC_2,
174 MAX77693_MUIC_ADC_RESERVED_ACC_3,
175 MAX77693_MUIC_ADC_RESERVED_ACC_4,
176 MAX77693_MUIC_ADC_RESERVED_ACC_5,
177 MAX77693_MUIC_ADC_CEA936_AUDIO,
178 MAX77693_MUIC_ADC_PHONE_POWERED_DEV,
179 MAX77693_MUIC_ADC_TTY_CONVERTER,
180 MAX77693_MUIC_ADC_UART_CABLE,
181 MAX77693_MUIC_ADC_CEA936A_TYPE1_CHG,
182 MAX77693_MUIC_ADC_FACTORY_MODE_USB_OFF,
183 MAX77693_MUIC_ADC_FACTORY_MODE_USB_ON,
184 MAX77693_MUIC_ADC_AV_CABLE_NOLOAD,
185 MAX77693_MUIC_ADC_CEA936A_TYPE2_CHG,
186 MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF,
187 MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON,
188 MAX77693_MUIC_ADC_AUDIO_MODE_REMOTE,
189 MAX77693_MUIC_ADC_OPEN,
191 /* The below accessories have same ADC value so ADCLow and
192 ADC1K bit is used to separate specific accessory */
193 /* ADC|VBVolot|ADCLow|ADC1K| */
194 MAX77693_MUIC_GND_USB_HOST = 0x100, /* 0x0| 0| 0| 0| */
195 MAX77693_MUIC_GND_USB_HOST_VB = 0x104, /* 0x0| 1| 0| 0| */
196 MAX77693_MUIC_GND_AV_CABLE_LOAD = 0x102,/* 0x0| 0| 1| 0| */
197 MAX77693_MUIC_GND_MHL = 0x103, /* 0x0| 0| 1| 1| */
198 MAX77693_MUIC_GND_MHL_VB = 0x107, /* 0x0| 1| 1| 1| */
202 * MAX77693 MUIC device support below list of accessories(external connector)
204 static const unsigned int max77693_extcon_cable[] = {
219 * max77693_muic_set_debounce_time - Set the debounce time of ADC
220 * @info: the instance including private data of max77693 MUIC
221 * @time: the debounce time of ADC
223 static int max77693_muic_set_debounce_time(struct max77693_muic_info *info,
224 enum max77693_muic_adc_debounce_time time)
229 case ADC_DEBOUNCE_TIME_5MS:
230 case ADC_DEBOUNCE_TIME_10MS:
231 case ADC_DEBOUNCE_TIME_25MS:
232 case ADC_DEBOUNCE_TIME_38_62MS:
234 * Don't touch BTLDset, JIGset when you want to change adc
235 * debounce time. If it writes other than 0 to BTLDset, JIGset
236 * muic device will be reset and loose current state.
238 ret = regmap_write(info->max77693->regmap_muic,
239 MAX77693_MUIC_REG_CTRL3,
240 time << MAX77693_CONTROL3_ADCDBSET_SHIFT);
242 dev_err(info->dev, "failed to set ADC debounce time\n");
247 dev_err(info->dev, "invalid ADC debounce time\n");
255 * max77693_muic_set_path - Set hardware line according to attached cable
256 * @info: the instance including private data of max77693 MUIC
257 * @value: the path according to attached cable
258 * @attached: the state of cable (true:attached, false:detached)
260 * The max77693 MUIC device share outside H/W line among a varity of cables
261 * so, this function set internal path of H/W line according to the type of
264 static int max77693_muic_set_path(struct max77693_muic_info *info,
265 u8 val, bool attached)
268 unsigned int ctrl1, ctrl2 = 0;
273 ctrl1 = MAX77693_CONTROL1_SW_OPEN;
275 ret = regmap_update_bits(info->max77693->regmap_muic,
276 MAX77693_MUIC_REG_CTRL1, COMP_SW_MASK, ctrl1);
278 dev_err(info->dev, "failed to update MUIC register\n");
283 ctrl2 |= MAX77693_CONTROL2_CPEN_MASK; /* LowPwr=0, CPEn=1 */
285 ctrl2 |= MAX77693_CONTROL2_LOWPWR_MASK; /* LowPwr=1, CPEn=0 */
287 ret = regmap_update_bits(info->max77693->regmap_muic,
288 MAX77693_MUIC_REG_CTRL2,
289 MAX77693_CONTROL2_LOWPWR_MASK | MAX77693_CONTROL2_CPEN_MASK,
292 dev_err(info->dev, "failed to update MUIC register\n");
297 "CONTROL1 : 0x%02x, CONTROL2 : 0x%02x, state : %s\n",
298 ctrl1, ctrl2, attached ? "attached" : "detached");
304 * max77693_muic_get_cable_type - Return cable type and check cable state
305 * @info: the instance including private data of max77693 MUIC
306 * @group: the path according to attached cable
307 * @attached: store cable state and return
309 * This function check the cable state either attached or detached,
310 * and then divide precise type of cable according to cable group.
311 * - MAX77693_CABLE_GROUP_ADC
312 * - MAX77693_CABLE_GROUP_ADC_GND
313 * - MAX77693_CABLE_GROUP_CHG
314 * - MAX77693_CABLE_GROUP_VBVOLT
316 static int max77693_muic_get_cable_type(struct max77693_muic_info *info,
317 enum max77693_muic_cable_group group, bool *attached)
327 case MAX77693_CABLE_GROUP_ADC:
329 * Read ADC value to check cable type and decide cable state
330 * according to cable type
332 adc = info->status[0] & MAX77693_STATUS1_ADC_MASK;
333 adc >>= MAX77693_STATUS1_ADC_SHIFT;
336 * Check current cable state/cable type and store cable type
337 * (info->prev_cable_type) for handling cable when cable is
340 if (adc == MAX77693_MUIC_ADC_OPEN) {
343 cable_type = info->prev_cable_type;
344 info->prev_cable_type = MAX77693_MUIC_ADC_OPEN;
348 cable_type = info->prev_cable_type = adc;
351 case MAX77693_CABLE_GROUP_ADC_GND:
353 * Read ADC value to check cable type and decide cable state
354 * according to cable type
356 adc = info->status[0] & MAX77693_STATUS1_ADC_MASK;
357 adc >>= MAX77693_STATUS1_ADC_SHIFT;
360 * Check current cable state/cable type and store cable type
361 * (info->prev_cable_type/_gnd) for handling cable when cable
364 if (adc == MAX77693_MUIC_ADC_OPEN) {
367 cable_type = info->prev_cable_type_gnd;
368 info->prev_cable_type_gnd = MAX77693_MUIC_ADC_OPEN;
372 adclow = info->status[0] & MAX77693_STATUS1_ADCLOW_MASK;
373 adclow >>= MAX77693_STATUS1_ADCLOW_SHIFT;
374 adc1k = info->status[0] & MAX77693_STATUS1_ADC1K_MASK;
375 adc1k >>= MAX77693_STATUS1_ADC1K_SHIFT;
377 vbvolt = info->status[1] & MAX77693_STATUS2_VBVOLT_MASK;
378 vbvolt >>= MAX77693_STATUS2_VBVOLT_SHIFT;
381 * [0x1|VBVolt|ADCLow|ADC1K]
382 * [0x1| 0| 0| 0] USB_HOST
383 * [0x1| 1| 0| 0] USB_HSOT_VB
384 * [0x1| 0| 1| 0] Audio Video cable with load
385 * [0x1| 0| 1| 1] MHL without charging cable
386 * [0x1| 1| 1| 1] MHL with charging cable
388 cable_type = ((0x1 << 8)
393 info->prev_cable_type = adc;
394 info->prev_cable_type_gnd = cable_type;
398 case MAX77693_CABLE_GROUP_CHG:
400 * Read charger type to check cable type and decide cable state
401 * according to type of charger cable.
403 chg_type = info->status[1] & MAX77693_STATUS2_CHGTYP_MASK;
404 chg_type >>= MAX77693_STATUS2_CHGTYP_SHIFT;
406 if (chg_type == MAX77693_CHARGER_TYPE_NONE) {
409 cable_type = info->prev_chg_type;
410 info->prev_chg_type = MAX77693_CHARGER_TYPE_NONE;
415 * Check current cable state/cable type and store cable
416 * type(info->prev_chg_type) for handling cable when
417 * charger cable is detached.
419 cable_type = info->prev_chg_type = chg_type;
423 case MAX77693_CABLE_GROUP_VBVOLT:
425 * Read ADC value to check cable type and decide cable state
426 * according to cable type
428 adc = info->status[0] & MAX77693_STATUS1_ADC_MASK;
429 adc >>= MAX77693_STATUS1_ADC_SHIFT;
430 chg_type = info->status[1] & MAX77693_STATUS2_CHGTYP_MASK;
431 chg_type >>= MAX77693_STATUS2_CHGTYP_SHIFT;
433 if (adc == MAX77693_MUIC_ADC_OPEN
434 && chg_type == MAX77693_CHARGER_TYPE_NONE)
440 * Read vbvolt field, if vbvolt is 1,
441 * this cable is used for charging.
443 vbvolt = info->status[1] & MAX77693_STATUS2_VBVOLT_MASK;
444 vbvolt >>= MAX77693_STATUS2_VBVOLT_SHIFT;
449 dev_err(info->dev, "Unknown cable group (%d)\n", group);
450 cable_type = -EINVAL;
457 static int max77693_muic_dock_handler(struct max77693_muic_info *info,
458 int cable_type, bool attached)
463 unsigned int dock_id;
466 "external connector is %s (adc:0x%02x)\n",
467 attached ? "attached" : "detached", cable_type);
469 switch (cable_type) {
470 case MAX77693_MUIC_ADC_RESERVED_ACC_3: /* Dock-Smart */
472 * Check power cable whether attached or detached state.
473 * The Dock-Smart device need surely external power supply.
474 * If power cable(USB/TA) isn't connected to Dock device,
475 * user can't use Dock-Smart for desktop mode.
477 vbvolt = max77693_muic_get_cable_type(info,
478 MAX77693_CABLE_GROUP_VBVOLT, &cable_attached);
479 if (attached && !vbvolt) {
481 "Cannot detect external power supply\n");
486 * Notify Dock/MHL state.
487 * - Dock device include three type of cable which
488 * are HDMI, USB for mouse/keyboard and micro-usb port
489 * for USB/TA cable. Dock device need always exteranl
490 * power supply(USB/TA cable through micro-usb cable). Dock
491 * device support screen output of target to separate
492 * monitor and mouse/keyboard for desktop mode.
494 * Features of 'USB/TA cable with Dock device'
496 * - Support external output feature of audio
497 * - Support charging through micro-usb port without data
498 * connection if TA cable is connected to target.
499 * - Support charging and data connection through micro-usb port
500 * if USB cable is connected between target and host
502 * - Support OTG(On-The-Go) device (Ex: Mouse/Keyboard)
504 ret = max77693_muic_set_path(info, info->path_usb, attached);
508 extcon_set_cable_state_(info->edev, EXTCON_DOCK, attached);
509 extcon_set_cable_state_(info->edev, EXTCON_DISP_MHL, attached);
511 case MAX77693_MUIC_ADC_AUDIO_MODE_REMOTE: /* Dock-Desk */
512 dock_id = EXTCON_DOCK;
514 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD: /* Dock-Audio */
515 dock_id = EXTCON_DOCK;
517 extcon_set_cable_state_(info->edev, EXTCON_USB, false);
518 extcon_set_cable_state_(info->edev, EXTCON_CHG_USB_SDP,
523 dev_err(info->dev, "failed to detect %s dock device\n",
524 attached ? "attached" : "detached");
528 /* Dock-Car/Desk/Audio, PATH:AUDIO */
529 ret = max77693_muic_set_path(info, MAX77693_CONTROL1_SW_AUDIO,
533 extcon_set_cable_state_(info->edev, dock_id, attached);
539 static int max77693_muic_dock_button_handler(struct max77693_muic_info *info,
540 int button_type, bool attached)
542 struct input_dev *dock = info->dock;
545 switch (button_type) {
546 case MAX77693_MUIC_ADC_REMOTE_S3_BUTTON-1
547 ... MAX77693_MUIC_ADC_REMOTE_S3_BUTTON+1:
549 code = KEY_PREVIOUSSONG;
551 case MAX77693_MUIC_ADC_REMOTE_S7_BUTTON-1
552 ... MAX77693_MUIC_ADC_REMOTE_S7_BUTTON+1:
556 case MAX77693_MUIC_ADC_REMOTE_S9_BUTTON:
558 code = KEY_VOLUMEDOWN;
560 case MAX77693_MUIC_ADC_REMOTE_S10_BUTTON:
564 case MAX77693_MUIC_ADC_REMOTE_S12_BUTTON-1
565 ... MAX77693_MUIC_ADC_REMOTE_S12_BUTTON+1:
566 /* DOCK_KEY_PLAY_PAUSE */
567 code = KEY_PLAYPAUSE;
571 "failed to detect %s key (adc:0x%x)\n",
572 attached ? "pressed" : "released", button_type);
576 input_event(dock, EV_KEY, code, attached);
582 static int max77693_muic_adc_ground_handler(struct max77693_muic_info *info)
588 cable_type_gnd = max77693_muic_get_cable_type(info,
589 MAX77693_CABLE_GROUP_ADC_GND, &attached);
591 switch (cable_type_gnd) {
592 case MAX77693_MUIC_GND_USB_HOST:
593 case MAX77693_MUIC_GND_USB_HOST_VB:
594 /* USB_HOST, PATH: AP_USB */
595 ret = max77693_muic_set_path(info, MAX77693_CONTROL1_SW_USB,
599 extcon_set_cable_state_(info->edev, EXTCON_USB_HOST, attached);
601 case MAX77693_MUIC_GND_AV_CABLE_LOAD:
602 /* Audio Video Cable with load, PATH:AUDIO */
603 ret = max77693_muic_set_path(info, MAX77693_CONTROL1_SW_AUDIO,
607 extcon_set_cable_state_(info->edev, EXTCON_USB, attached);
608 extcon_set_cable_state_(info->edev, EXTCON_CHG_USB_SDP,
611 case MAX77693_MUIC_GND_MHL:
612 case MAX77693_MUIC_GND_MHL_VB:
613 /* MHL or MHL with USB/TA cable */
614 extcon_set_cable_state_(info->edev, EXTCON_DISP_MHL, attached);
617 dev_err(info->dev, "failed to detect %s cable of gnd type\n",
618 attached ? "attached" : "detached");
625 static int max77693_muic_jig_handler(struct max77693_muic_info *info,
626 int cable_type, bool attached)
629 u8 path = MAX77693_CONTROL1_SW_OPEN;
632 "external connector is %s (adc:0x%02x)\n",
633 attached ? "attached" : "detached", cable_type);
635 switch (cable_type) {
636 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_OFF: /* ADC_JIG_USB_OFF */
637 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_ON: /* ADC_JIG_USB_ON */
639 path = MAX77693_CONTROL1_SW_USB;
641 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF: /* ADC_JIG_UART_OFF */
642 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON: /* ADC_JIG_UART_ON */
644 path = MAX77693_CONTROL1_SW_UART;
647 dev_err(info->dev, "failed to detect %s jig cable\n",
648 attached ? "attached" : "detached");
652 ret = max77693_muic_set_path(info, path, attached);
656 extcon_set_cable_state_(info->edev, EXTCON_JIG, attached);
661 static int max77693_muic_adc_handler(struct max77693_muic_info *info)
668 /* Check accessory state which is either detached or attached */
669 cable_type = max77693_muic_get_cable_type(info,
670 MAX77693_CABLE_GROUP_ADC, &attached);
673 "external connector is %s (adc:0x%02x, prev_adc:0x%x)\n",
674 attached ? "attached" : "detached", cable_type,
675 info->prev_cable_type);
677 switch (cable_type) {
678 case MAX77693_MUIC_ADC_GROUND:
679 /* USB_HOST/MHL/Audio */
680 max77693_muic_adc_ground_handler(info);
682 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_OFF:
683 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_ON:
684 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF:
685 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON:
687 ret = max77693_muic_jig_handler(info, cable_type, attached);
691 case MAX77693_MUIC_ADC_RESERVED_ACC_3: /* Dock-Smart */
692 case MAX77693_MUIC_ADC_AUDIO_MODE_REMOTE: /* Dock-Desk */
693 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD: /* Dock-Audio */
697 * The MAX77693 MUIC device can detect total 34 cable type
698 * except of charger cable and MUIC device didn't define
699 * specfic role of cable in the range of from 0x01 to 0x12
700 * of ADC value. So, can use/define cable with no role according
701 * to schema of hardware board.
703 ret = max77693_muic_dock_handler(info, cable_type, attached);
707 case MAX77693_MUIC_ADC_REMOTE_S3_BUTTON: /* DOCK_KEY_PREV */
708 case MAX77693_MUIC_ADC_REMOTE_S7_BUTTON: /* DOCK_KEY_NEXT */
709 case MAX77693_MUIC_ADC_REMOTE_S9_BUTTON: /* DOCK_VOL_DOWN */
710 case MAX77693_MUIC_ADC_REMOTE_S10_BUTTON: /* DOCK_VOL_UP */
711 case MAX77693_MUIC_ADC_REMOTE_S12_BUTTON: /* DOCK_KEY_PLAY_PAUSE */
713 * Button of DOCK device
714 * - the Prev/Next/Volume Up/Volume Down/Play-Pause button
716 * The MAX77693 MUIC device can detect total 34 cable type
717 * except of charger cable and MUIC device didn't define
718 * specfic role of cable in the range of from 0x01 to 0x12
719 * of ADC value. So, can use/define cable with no role according
720 * to schema of hardware board.
723 button_type = info->prev_button_type = cable_type;
725 button_type = info->prev_button_type;
727 ret = max77693_muic_dock_button_handler(info, button_type,
732 case MAX77693_MUIC_ADC_SEND_END_BUTTON:
733 case MAX77693_MUIC_ADC_REMOTE_S1_BUTTON:
734 case MAX77693_MUIC_ADC_REMOTE_S2_BUTTON:
735 case MAX77693_MUIC_ADC_REMOTE_S4_BUTTON:
736 case MAX77693_MUIC_ADC_REMOTE_S5_BUTTON:
737 case MAX77693_MUIC_ADC_REMOTE_S6_BUTTON:
738 case MAX77693_MUIC_ADC_REMOTE_S8_BUTTON:
739 case MAX77693_MUIC_ADC_REMOTE_S11_BUTTON:
740 case MAX77693_MUIC_ADC_RESERVED_ACC_1:
741 case MAX77693_MUIC_ADC_RESERVED_ACC_2:
742 case MAX77693_MUIC_ADC_RESERVED_ACC_4:
743 case MAX77693_MUIC_ADC_RESERVED_ACC_5:
744 case MAX77693_MUIC_ADC_CEA936_AUDIO:
745 case MAX77693_MUIC_ADC_PHONE_POWERED_DEV:
746 case MAX77693_MUIC_ADC_TTY_CONVERTER:
747 case MAX77693_MUIC_ADC_UART_CABLE:
748 case MAX77693_MUIC_ADC_CEA936A_TYPE1_CHG:
749 case MAX77693_MUIC_ADC_CEA936A_TYPE2_CHG:
751 * This accessory isn't used in general case if it is specially
752 * needed to detect additional accessory, should implement
753 * proper operation when this accessory is attached/detached.
756 "accessory is %s but it isn't used (adc:0x%x)\n",
757 attached ? "attached" : "detached", cable_type);
761 "failed to detect %s accessory (adc:0x%x)\n",
762 attached ? "attached" : "detached", cable_type);
769 static int max77693_muic_chg_handler(struct max77693_muic_info *info)
778 chg_type = max77693_muic_get_cable_type(info,
779 MAX77693_CABLE_GROUP_CHG, &attached);
782 "external connector is %s(chg_type:0x%x, prev_chg_type:0x%x)\n",
783 attached ? "attached" : "detached",
784 chg_type, info->prev_chg_type);
787 case MAX77693_CHARGER_TYPE_USB:
788 case MAX77693_CHARGER_TYPE_DEDICATED_CHG:
789 case MAX77693_CHARGER_TYPE_NONE:
790 /* Check MAX77693_CABLE_GROUP_ADC_GND type */
791 cable_type_gnd = max77693_muic_get_cable_type(info,
792 MAX77693_CABLE_GROUP_ADC_GND,
794 switch (cable_type_gnd) {
795 case MAX77693_MUIC_GND_MHL:
796 case MAX77693_MUIC_GND_MHL_VB:
798 * MHL cable with USB/TA cable
799 * - MHL cable include two port(HDMI line and separate
800 * micro-usb port. When the target connect MHL cable,
801 * extcon driver check whether USB/TA cable is
802 * connected. If USB/TA cable is connected, extcon
803 * driver notify state to notifiee for charging battery.
805 * Features of 'USB/TA with MHL cable'
807 * - Support charging through micro-usb port without
810 extcon_set_cable_state_(info->edev, EXTCON_CHG_USB_DCP,
813 extcon_set_cable_state_(info->edev,
814 EXTCON_DISP_MHL, cable_attached);
818 /* Check MAX77693_CABLE_GROUP_ADC type */
819 cable_type = max77693_muic_get_cable_type(info,
820 MAX77693_CABLE_GROUP_ADC,
822 switch (cable_type) {
823 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD: /* Dock-Audio */
825 * Dock-Audio device with USB/TA cable
826 * - Dock device include two port(Dock-Audio and micro-
827 * usb port). When the target connect Dock-Audio device,
828 * extcon driver check whether USB/TA cable is connected
829 * or not. If USB/TA cable is connected, extcon driver
830 * notify state to notifiee for charging battery.
832 * Features of 'USB/TA cable with Dock-Audio device'
833 * - Support external output feature of audio.
834 * - Support charging through micro-usb port without
837 extcon_set_cable_state_(info->edev, EXTCON_USB,
839 extcon_set_cable_state_(info->edev, EXTCON_CHG_USB_SDP,
843 extcon_set_cable_state_(info->edev, EXTCON_DOCK,
846 case MAX77693_MUIC_ADC_RESERVED_ACC_3: /* Dock-Smart */
848 * Dock-Smart device with USB/TA cable
849 * - Dock-Desk device include three type of cable which
850 * are HDMI, USB for mouse/keyboard and micro-usb port
851 * for USB/TA cable. Dock-Smart device need always
852 * exteranl power supply(USB/TA cable through micro-usb
853 * cable). Dock-Smart device support screen output of
854 * target to separate monitor and mouse/keyboard for
857 * Features of 'USB/TA cable with Dock-Smart device'
859 * - Support external output feature of audio
860 * - Support charging through micro-usb port without
861 * data connection if TA cable is connected to target.
862 * - Support charging and data connection through micro-
863 * usb port if USB cable is connected between target
865 * - Support OTG(On-The-Go) device (Ex: Mouse/Keyboard)
867 ret = max77693_muic_set_path(info, info->path_usb,
872 extcon_set_cable_state_(info->edev, EXTCON_DOCK,
874 extcon_set_cable_state_(info->edev, EXTCON_DISP_MHL,
879 /* Check MAX77693_CABLE_GROUP_CHG type */
881 case MAX77693_CHARGER_TYPE_NONE:
883 * When MHL(with USB/TA cable) or Dock-Audio with USB/TA
884 * cable is attached, muic device happen below two irq.
885 * - 'MAX77693_MUIC_IRQ_INT1_ADC' for detecting
887 * - 'MAX77693_MUIC_IRQ_INT2_CHGTYP' for detecting
888 * USB/TA cable connected to MHL or Dock-Audio.
889 * Always, happen eariler MAX77693_MUIC_IRQ_INT1_ADC
890 * irq than MAX77693_MUIC_IRQ_INT2_CHGTYP irq.
892 * If user attach MHL (with USB/TA cable and immediately
893 * detach MHL with USB/TA cable before MAX77693_MUIC_IRQ
894 * _INT2_CHGTYP irq is happened, USB/TA cable remain
895 * connected state to target. But USB/TA cable isn't
896 * connected to target. The user be face with unusual
897 * action. So, driver should check this situation in
898 * spite of, that previous charger type is N/A.
901 case MAX77693_CHARGER_TYPE_USB:
902 /* Only USB cable, PATH:AP_USB */
903 ret = max77693_muic_set_path(info, info->path_usb,
908 extcon_set_cable_state_(info->edev, EXTCON_USB,
910 extcon_set_cable_state_(info->edev, EXTCON_CHG_USB_SDP,
913 case MAX77693_CHARGER_TYPE_DEDICATED_CHG:
915 extcon_set_cable_state_(info->edev, EXTCON_CHG_USB_DCP,
920 case MAX77693_CHARGER_TYPE_DOWNSTREAM_PORT:
921 extcon_set_cable_state_(info->edev, EXTCON_CHG_USB_CDP,
924 case MAX77693_CHARGER_TYPE_APPLE_500MA:
925 extcon_set_cable_state_(info->edev, EXTCON_CHG_USB_SLOW,
928 case MAX77693_CHARGER_TYPE_APPLE_1A_2A:
929 extcon_set_cable_state_(info->edev, EXTCON_CHG_USB_FAST,
932 case MAX77693_CHARGER_TYPE_DEAD_BATTERY:
936 "failed to detect %s accessory (chg_type:0x%x)\n",
937 attached ? "attached" : "detached", chg_type);
944 static void max77693_muic_irq_work(struct work_struct *work)
946 struct max77693_muic_info *info = container_of(work,
947 struct max77693_muic_info, irq_work);
954 mutex_lock(&info->mutex);
956 for (i = 0; i < ARRAY_SIZE(muic_irqs); i++)
957 if (info->irq == muic_irqs[i].virq)
958 irq_type = muic_irqs[i].irq;
960 ret = regmap_bulk_read(info->max77693->regmap_muic,
961 MAX77693_MUIC_REG_STATUS1, info->status, 2);
963 dev_err(info->dev, "failed to read MUIC register\n");
964 mutex_unlock(&info->mutex);
969 case MAX77693_MUIC_IRQ_INT1_ADC:
970 case MAX77693_MUIC_IRQ_INT1_ADC_LOW:
971 case MAX77693_MUIC_IRQ_INT1_ADC_ERR:
972 case MAX77693_MUIC_IRQ_INT1_ADC1K:
973 /* Handle all of accessory except for
974 type of charger accessory */
975 ret = max77693_muic_adc_handler(info);
977 case MAX77693_MUIC_IRQ_INT2_CHGTYP:
978 case MAX77693_MUIC_IRQ_INT2_CHGDETREUN:
979 case MAX77693_MUIC_IRQ_INT2_DCDTMR:
980 case MAX77693_MUIC_IRQ_INT2_DXOVP:
981 case MAX77693_MUIC_IRQ_INT2_VBVOLT:
982 case MAX77693_MUIC_IRQ_INT2_VIDRM:
983 /* Handle charger accessory */
984 ret = max77693_muic_chg_handler(info);
986 case MAX77693_MUIC_IRQ_INT3_EOC:
987 case MAX77693_MUIC_IRQ_INT3_CGMBC:
988 case MAX77693_MUIC_IRQ_INT3_OVP:
989 case MAX77693_MUIC_IRQ_INT3_MBCCHG_ERR:
990 case MAX77693_MUIC_IRQ_INT3_CHG_ENABLED:
991 case MAX77693_MUIC_IRQ_INT3_BAT_DET:
994 dev_err(info->dev, "muic interrupt: irq %d occurred\n",
996 mutex_unlock(&info->mutex);
1001 dev_err(info->dev, "failed to handle MUIC interrupt\n");
1003 mutex_unlock(&info->mutex);
1006 static irqreturn_t max77693_muic_irq_handler(int irq, void *data)
1008 struct max77693_muic_info *info = data;
1011 schedule_work(&info->irq_work);
1016 static const struct regmap_config max77693_muic_regmap_config = {
1021 static int max77693_muic_detect_accessory(struct max77693_muic_info *info)
1028 mutex_lock(&info->mutex);
1030 /* Read STATUSx register to detect accessory */
1031 ret = regmap_bulk_read(info->max77693->regmap_muic,
1032 MAX77693_MUIC_REG_STATUS1, info->status, 2);
1034 dev_err(info->dev, "failed to read MUIC register\n");
1035 mutex_unlock(&info->mutex);
1039 adc = max77693_muic_get_cable_type(info, MAX77693_CABLE_GROUP_ADC,
1041 if (attached && adc != MAX77693_MUIC_ADC_OPEN) {
1042 ret = max77693_muic_adc_handler(info);
1044 dev_err(info->dev, "Cannot detect accessory\n");
1045 mutex_unlock(&info->mutex);
1050 chg_type = max77693_muic_get_cable_type(info, MAX77693_CABLE_GROUP_CHG,
1052 if (attached && chg_type != MAX77693_CHARGER_TYPE_NONE) {
1053 ret = max77693_muic_chg_handler(info);
1055 dev_err(info->dev, "Cannot detect charger accessory\n");
1056 mutex_unlock(&info->mutex);
1061 mutex_unlock(&info->mutex);
1066 static void max77693_muic_detect_cable_wq(struct work_struct *work)
1068 struct max77693_muic_info *info = container_of(to_delayed_work(work),
1069 struct max77693_muic_info, wq_detcable);
1071 max77693_muic_detect_accessory(info);
1074 static int max77693_muic_probe(struct platform_device *pdev)
1076 struct max77693_dev *max77693 = dev_get_drvdata(pdev->dev.parent);
1077 struct max77693_platform_data *pdata = dev_get_platdata(max77693->dev);
1078 struct max77693_muic_info *info;
1079 struct max77693_reg_data *init_data;
1086 info = devm_kzalloc(&pdev->dev, sizeof(struct max77693_muic_info),
1091 info->dev = &pdev->dev;
1092 info->max77693 = max77693;
1093 if (info->max77693->regmap_muic) {
1094 dev_dbg(&pdev->dev, "allocate register map\n");
1096 info->max77693->regmap_muic = devm_regmap_init_i2c(
1097 info->max77693->i2c_muic,
1098 &max77693_muic_regmap_config);
1099 if (IS_ERR(info->max77693->regmap_muic)) {
1100 ret = PTR_ERR(info->max77693->regmap_muic);
1101 dev_err(max77693->dev,
1102 "failed to allocate register map: %d\n", ret);
1107 /* Register input device for button of dock device */
1108 info->dock = devm_input_allocate_device(&pdev->dev);
1110 dev_err(&pdev->dev, "%s: failed to allocate input\n", __func__);
1113 info->dock->name = "max77693-muic/dock";
1114 info->dock->phys = "max77693-muic/extcon";
1115 info->dock->dev.parent = &pdev->dev;
1117 __set_bit(EV_REP, info->dock->evbit);
1119 input_set_capability(info->dock, EV_KEY, KEY_VOLUMEUP);
1120 input_set_capability(info->dock, EV_KEY, KEY_VOLUMEDOWN);
1121 input_set_capability(info->dock, EV_KEY, KEY_PLAYPAUSE);
1122 input_set_capability(info->dock, EV_KEY, KEY_PREVIOUSSONG);
1123 input_set_capability(info->dock, EV_KEY, KEY_NEXTSONG);
1125 ret = input_register_device(info->dock);
1127 dev_err(&pdev->dev, "Cannot register input device error(%d)\n",
1132 platform_set_drvdata(pdev, info);
1133 mutex_init(&info->mutex);
1135 INIT_WORK(&info->irq_work, max77693_muic_irq_work);
1137 /* Support irq domain for MAX77693 MUIC device */
1138 for (i = 0; i < ARRAY_SIZE(muic_irqs); i++) {
1139 struct max77693_muic_irq *muic_irq = &muic_irqs[i];
1142 virq = regmap_irq_get_virq(max77693->irq_data_muic,
1146 muic_irq->virq = virq;
1148 ret = devm_request_threaded_irq(&pdev->dev, virq, NULL,
1149 max77693_muic_irq_handler,
1151 muic_irq->name, info);
1154 "failed: irq request (IRQ: %d, error :%d)\n",
1155 muic_irq->irq, ret);
1160 /* Initialize extcon device */
1161 info->edev = devm_extcon_dev_allocate(&pdev->dev,
1162 max77693_extcon_cable);
1163 if (IS_ERR(info->edev)) {
1164 dev_err(&pdev->dev, "failed to allocate memory for extcon\n");
1168 ret = devm_extcon_dev_register(&pdev->dev, info->edev);
1170 dev_err(&pdev->dev, "failed to register extcon device\n");
1174 /* Initialize MUIC register by using platform data or default data */
1175 if (pdata && pdata->muic_data) {
1176 init_data = pdata->muic_data->init_data;
1177 num_init_data = pdata->muic_data->num_init_data;
1179 init_data = default_init_data;
1180 num_init_data = ARRAY_SIZE(default_init_data);
1183 for (i = 0; i < num_init_data; i++) {
1184 regmap_write(info->max77693->regmap_muic,
1189 if (pdata && pdata->muic_data) {
1190 struct max77693_muic_platform_data *muic_pdata
1194 * Default usb/uart path whether UART/USB or AUX_UART/AUX_USB
1195 * h/w path of COMP2/COMN1 on CONTROL1 register.
1197 if (muic_pdata->path_uart)
1198 info->path_uart = muic_pdata->path_uart;
1200 info->path_uart = MAX77693_CONTROL1_SW_UART;
1202 if (muic_pdata->path_usb)
1203 info->path_usb = muic_pdata->path_usb;
1205 info->path_usb = MAX77693_CONTROL1_SW_USB;
1208 * Default delay time for detecting cable state
1209 * after certain time.
1211 if (muic_pdata->detcable_delay_ms)
1213 msecs_to_jiffies(muic_pdata->detcable_delay_ms);
1215 delay_jiffies = msecs_to_jiffies(DELAY_MS_DEFAULT);
1217 info->path_usb = MAX77693_CONTROL1_SW_USB;
1218 info->path_uart = MAX77693_CONTROL1_SW_UART;
1219 delay_jiffies = msecs_to_jiffies(DELAY_MS_DEFAULT);
1222 /* Set initial path for UART */
1223 max77693_muic_set_path(info, info->path_uart, true);
1225 /* Check revision number of MUIC device*/
1226 ret = regmap_read(info->max77693->regmap_muic,
1227 MAX77693_MUIC_REG_ID, &id);
1229 dev_err(&pdev->dev, "failed to read revision number\n");
1232 dev_info(info->dev, "device ID : 0x%x\n", id);
1234 /* Set ADC debounce time */
1235 max77693_muic_set_debounce_time(info, ADC_DEBOUNCE_TIME_25MS);
1238 * Detect accessory after completing the initialization of platform
1240 * - Use delayed workqueue to detect cable state and then
1241 * notify cable state to notifiee/platform through uevent.
1242 * After completing the booting of platform, the extcon provider
1243 * driver should notify cable state to upper layer.
1245 INIT_DELAYED_WORK(&info->wq_detcable, max77693_muic_detect_cable_wq);
1246 queue_delayed_work(system_power_efficient_wq, &info->wq_detcable,
1252 static int max77693_muic_remove(struct platform_device *pdev)
1254 struct max77693_muic_info *info = platform_get_drvdata(pdev);
1256 cancel_work_sync(&info->irq_work);
1257 input_unregister_device(info->dock);
1262 static struct platform_driver max77693_muic_driver = {
1266 .probe = max77693_muic_probe,
1267 .remove = max77693_muic_remove,
1270 module_platform_driver(max77693_muic_driver);
1272 MODULE_DESCRIPTION("Maxim MAX77693 Extcon driver");
1273 MODULE_AUTHOR("Chanwoo Choi <cw00.choi@samsung.com>");
1274 MODULE_LICENSE("GPL");
1275 MODULE_ALIAS("platform:extcon-max77693");