2 * extcon-max77693.c - MAX77693 extcon driver to support MAX77693 MUIC
4 * Copyright (C) 2012 Samsung Electrnoics
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[] = {
210 EXTCON_CHARGE_DOWNSTREAM,
218 * max77693_muic_set_debounce_time - Set the debounce time of ADC
219 * @info: the instance including private data of max77693 MUIC
220 * @time: the debounce time of ADC
222 static int max77693_muic_set_debounce_time(struct max77693_muic_info *info,
223 enum max77693_muic_adc_debounce_time time)
228 case ADC_DEBOUNCE_TIME_5MS:
229 case ADC_DEBOUNCE_TIME_10MS:
230 case ADC_DEBOUNCE_TIME_25MS:
231 case ADC_DEBOUNCE_TIME_38_62MS:
233 * Don't touch BTLDset, JIGset when you want to change adc
234 * debounce time. If it writes other than 0 to BTLDset, JIGset
235 * muic device will be reset and loose current state.
237 ret = regmap_write(info->max77693->regmap_muic,
238 MAX77693_MUIC_REG_CTRL3,
239 time << MAX77693_CONTROL3_ADCDBSET_SHIFT);
241 dev_err(info->dev, "failed to set ADC debounce time\n");
246 dev_err(info->dev, "invalid ADC debounce time\n");
254 * max77693_muic_set_path - Set hardware line according to attached cable
255 * @info: the instance including private data of max77693 MUIC
256 * @value: the path according to attached cable
257 * @attached: the state of cable (true:attached, false:detached)
259 * The max77693 MUIC device share outside H/W line among a varity of cables
260 * so, this function set internal path of H/W line according to the type of
263 static int max77693_muic_set_path(struct max77693_muic_info *info,
264 u8 val, bool attached)
267 unsigned int ctrl1, ctrl2 = 0;
272 ctrl1 = MAX77693_CONTROL1_SW_OPEN;
274 ret = regmap_update_bits(info->max77693->regmap_muic,
275 MAX77693_MUIC_REG_CTRL1, COMP_SW_MASK, ctrl1);
277 dev_err(info->dev, "failed to update MUIC register\n");
282 ctrl2 |= MAX77693_CONTROL2_CPEN_MASK; /* LowPwr=0, CPEn=1 */
284 ctrl2 |= MAX77693_CONTROL2_LOWPWR_MASK; /* LowPwr=1, CPEn=0 */
286 ret = regmap_update_bits(info->max77693->regmap_muic,
287 MAX77693_MUIC_REG_CTRL2,
288 MAX77693_CONTROL2_LOWPWR_MASK | MAX77693_CONTROL2_CPEN_MASK,
291 dev_err(info->dev, "failed to update MUIC register\n");
296 "CONTROL1 : 0x%02x, CONTROL2 : 0x%02x, state : %s\n",
297 ctrl1, ctrl2, attached ? "attached" : "detached");
303 * max77693_muic_get_cable_type - Return cable type and check cable state
304 * @info: the instance including private data of max77693 MUIC
305 * @group: the path according to attached cable
306 * @attached: store cable state and return
308 * This function check the cable state either attached or detached,
309 * and then divide precise type of cable according to cable group.
310 * - MAX77693_CABLE_GROUP_ADC
311 * - MAX77693_CABLE_GROUP_ADC_GND
312 * - MAX77693_CABLE_GROUP_CHG
313 * - MAX77693_CABLE_GROUP_VBVOLT
315 static int max77693_muic_get_cable_type(struct max77693_muic_info *info,
316 enum max77693_muic_cable_group group, bool *attached)
326 case MAX77693_CABLE_GROUP_ADC:
328 * Read ADC value to check cable type and decide cable state
329 * according to cable type
331 adc = info->status[0] & MAX77693_STATUS1_ADC_MASK;
332 adc >>= MAX77693_STATUS1_ADC_SHIFT;
335 * Check current cable state/cable type and store cable type
336 * (info->prev_cable_type) for handling cable when cable is
339 if (adc == MAX77693_MUIC_ADC_OPEN) {
342 cable_type = info->prev_cable_type;
343 info->prev_cable_type = MAX77693_MUIC_ADC_OPEN;
347 cable_type = info->prev_cable_type = adc;
350 case MAX77693_CABLE_GROUP_ADC_GND:
352 * Read ADC value to check cable type and decide cable state
353 * according to cable type
355 adc = info->status[0] & MAX77693_STATUS1_ADC_MASK;
356 adc >>= MAX77693_STATUS1_ADC_SHIFT;
359 * Check current cable state/cable type and store cable type
360 * (info->prev_cable_type/_gnd) for handling cable when cable
363 if (adc == MAX77693_MUIC_ADC_OPEN) {
366 cable_type = info->prev_cable_type_gnd;
367 info->prev_cable_type_gnd = MAX77693_MUIC_ADC_OPEN;
371 adclow = info->status[0] & MAX77693_STATUS1_ADCLOW_MASK;
372 adclow >>= MAX77693_STATUS1_ADCLOW_SHIFT;
373 adc1k = info->status[0] & MAX77693_STATUS1_ADC1K_MASK;
374 adc1k >>= MAX77693_STATUS1_ADC1K_SHIFT;
376 vbvolt = info->status[1] & MAX77693_STATUS2_VBVOLT_MASK;
377 vbvolt >>= MAX77693_STATUS2_VBVOLT_SHIFT;
380 * [0x1|VBVolt|ADCLow|ADC1K]
381 * [0x1| 0| 0| 0] USB_HOST
382 * [0x1| 1| 0| 0] USB_HSOT_VB
383 * [0x1| 0| 1| 0] Audio Video cable with load
384 * [0x1| 0| 1| 1] MHL without charging cable
385 * [0x1| 1| 1| 1] MHL with charging cable
387 cable_type = ((0x1 << 8)
392 info->prev_cable_type = adc;
393 info->prev_cable_type_gnd = cable_type;
397 case MAX77693_CABLE_GROUP_CHG:
399 * Read charger type to check cable type and decide cable state
400 * according to type of charger cable.
402 chg_type = info->status[1] & MAX77693_STATUS2_CHGTYP_MASK;
403 chg_type >>= MAX77693_STATUS2_CHGTYP_SHIFT;
405 if (chg_type == MAX77693_CHARGER_TYPE_NONE) {
408 cable_type = info->prev_chg_type;
409 info->prev_chg_type = MAX77693_CHARGER_TYPE_NONE;
414 * Check current cable state/cable type and store cable
415 * type(info->prev_chg_type) for handling cable when
416 * charger cable is detached.
418 cable_type = info->prev_chg_type = chg_type;
422 case MAX77693_CABLE_GROUP_VBVOLT:
424 * Read ADC value to check cable type and decide cable state
425 * according to cable type
427 adc = info->status[0] & MAX77693_STATUS1_ADC_MASK;
428 adc >>= MAX77693_STATUS1_ADC_SHIFT;
429 chg_type = info->status[1] & MAX77693_STATUS2_CHGTYP_MASK;
430 chg_type >>= MAX77693_STATUS2_CHGTYP_SHIFT;
432 if (adc == MAX77693_MUIC_ADC_OPEN
433 && chg_type == MAX77693_CHARGER_TYPE_NONE)
439 * Read vbvolt field, if vbvolt is 1,
440 * this cable is used for charging.
442 vbvolt = info->status[1] & MAX77693_STATUS2_VBVOLT_MASK;
443 vbvolt >>= MAX77693_STATUS2_VBVOLT_SHIFT;
448 dev_err(info->dev, "Unknown cable group (%d)\n", group);
449 cable_type = -EINVAL;
456 static int max77693_muic_dock_handler(struct max77693_muic_info *info,
457 int cable_type, bool attached)
462 unsigned int dock_id;
465 "external connector is %s (adc:0x%02x)\n",
466 attached ? "attached" : "detached", cable_type);
468 switch (cable_type) {
469 case MAX77693_MUIC_ADC_RESERVED_ACC_3: /* Dock-Smart */
471 * Check power cable whether attached or detached state.
472 * The Dock-Smart device need surely external power supply.
473 * If power cable(USB/TA) isn't connected to Dock device,
474 * user can't use Dock-Smart for desktop mode.
476 vbvolt = max77693_muic_get_cable_type(info,
477 MAX77693_CABLE_GROUP_VBVOLT, &cable_attached);
478 if (attached && !vbvolt) {
480 "Cannot detect external power supply\n");
485 * Notify Dock/MHL state.
486 * - Dock device include three type of cable which
487 * are HDMI, USB for mouse/keyboard and micro-usb port
488 * for USB/TA cable. Dock device need always exteranl
489 * power supply(USB/TA cable through micro-usb cable). Dock
490 * device support screen output of target to separate
491 * monitor and mouse/keyboard for desktop mode.
493 * Features of 'USB/TA cable with Dock device'
495 * - Support external output feature of audio
496 * - Support charging through micro-usb port without data
497 * connection if TA cable is connected to target.
498 * - Support charging and data connection through micro-usb port
499 * if USB cable is connected between target and host
501 * - Support OTG(On-The-Go) device (Ex: Mouse/Keyboard)
503 ret = max77693_muic_set_path(info, info->path_usb, attached);
507 extcon_set_cable_state_(info->edev, EXTCON_DOCK, attached);
508 extcon_set_cable_state_(info->edev, EXTCON_MHL, attached);
510 case MAX77693_MUIC_ADC_AUDIO_MODE_REMOTE: /* Dock-Desk */
511 dock_id = EXTCON_DOCK;
513 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD: /* Dock-Audio */
514 dock_id = EXTCON_DOCK;
516 extcon_set_cable_state_(info->edev, EXTCON_USB, false);
519 dev_err(info->dev, "failed to detect %s dock device\n",
520 attached ? "attached" : "detached");
524 /* Dock-Car/Desk/Audio, PATH:AUDIO */
525 ret = max77693_muic_set_path(info, MAX77693_CONTROL1_SW_AUDIO,
529 extcon_set_cable_state_(info->edev, dock_id, attached);
535 static int max77693_muic_dock_button_handler(struct max77693_muic_info *info,
536 int button_type, bool attached)
538 struct input_dev *dock = info->dock;
541 switch (button_type) {
542 case MAX77693_MUIC_ADC_REMOTE_S3_BUTTON-1
543 ... MAX77693_MUIC_ADC_REMOTE_S3_BUTTON+1:
545 code = KEY_PREVIOUSSONG;
547 case MAX77693_MUIC_ADC_REMOTE_S7_BUTTON-1
548 ... MAX77693_MUIC_ADC_REMOTE_S7_BUTTON+1:
552 case MAX77693_MUIC_ADC_REMOTE_S9_BUTTON:
554 code = KEY_VOLUMEDOWN;
556 case MAX77693_MUIC_ADC_REMOTE_S10_BUTTON:
560 case MAX77693_MUIC_ADC_REMOTE_S12_BUTTON-1
561 ... MAX77693_MUIC_ADC_REMOTE_S12_BUTTON+1:
562 /* DOCK_KEY_PLAY_PAUSE */
563 code = KEY_PLAYPAUSE;
567 "failed to detect %s key (adc:0x%x)\n",
568 attached ? "pressed" : "released", button_type);
572 input_event(dock, EV_KEY, code, attached);
578 static int max77693_muic_adc_ground_handler(struct max77693_muic_info *info)
584 cable_type_gnd = max77693_muic_get_cable_type(info,
585 MAX77693_CABLE_GROUP_ADC_GND, &attached);
587 switch (cable_type_gnd) {
588 case MAX77693_MUIC_GND_USB_HOST:
589 case MAX77693_MUIC_GND_USB_HOST_VB:
590 /* USB_HOST, PATH: AP_USB */
591 ret = max77693_muic_set_path(info, MAX77693_CONTROL1_SW_USB,
595 extcon_set_cable_state_(info->edev, EXTCON_USB_HOST, attached);
597 case MAX77693_MUIC_GND_AV_CABLE_LOAD:
598 /* Audio Video Cable with load, PATH:AUDIO */
599 ret = max77693_muic_set_path(info, MAX77693_CONTROL1_SW_AUDIO,
603 extcon_set_cable_state_(info->edev, EXTCON_USB, attached);
605 case MAX77693_MUIC_GND_MHL:
606 case MAX77693_MUIC_GND_MHL_VB:
607 /* MHL or MHL with USB/TA cable */
608 extcon_set_cable_state_(info->edev, EXTCON_MHL, attached);
611 dev_err(info->dev, "failed to detect %s cable of gnd type\n",
612 attached ? "attached" : "detached");
619 static int max77693_muic_jig_handler(struct max77693_muic_info *info,
620 int cable_type, bool attached)
623 u8 path = MAX77693_CONTROL1_SW_OPEN;
626 "external connector is %s (adc:0x%02x)\n",
627 attached ? "attached" : "detached", cable_type);
629 switch (cable_type) {
630 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_OFF: /* ADC_JIG_USB_OFF */
631 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_ON: /* ADC_JIG_USB_ON */
633 path = MAX77693_CONTROL1_SW_USB;
635 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF: /* ADC_JIG_UART_OFF */
636 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON: /* ADC_JIG_UART_ON */
638 path = MAX77693_CONTROL1_SW_UART;
641 dev_err(info->dev, "failed to detect %s jig cable\n",
642 attached ? "attached" : "detached");
646 ret = max77693_muic_set_path(info, path, attached);
650 extcon_set_cable_state_(info->edev, EXTCON_JIG, attached);
655 static int max77693_muic_adc_handler(struct max77693_muic_info *info)
662 /* Check accessory state which is either detached or attached */
663 cable_type = max77693_muic_get_cable_type(info,
664 MAX77693_CABLE_GROUP_ADC, &attached);
667 "external connector is %s (adc:0x%02x, prev_adc:0x%x)\n",
668 attached ? "attached" : "detached", cable_type,
669 info->prev_cable_type);
671 switch (cable_type) {
672 case MAX77693_MUIC_ADC_GROUND:
673 /* USB_HOST/MHL/Audio */
674 max77693_muic_adc_ground_handler(info);
676 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_OFF:
677 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_ON:
678 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF:
679 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON:
681 ret = max77693_muic_jig_handler(info, cable_type, attached);
685 case MAX77693_MUIC_ADC_RESERVED_ACC_3: /* Dock-Smart */
686 case MAX77693_MUIC_ADC_AUDIO_MODE_REMOTE: /* Dock-Desk */
687 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD: /* Dock-Audio */
691 * The MAX77693 MUIC device can detect total 34 cable type
692 * except of charger cable and MUIC device didn't define
693 * specfic role of cable in the range of from 0x01 to 0x12
694 * of ADC value. So, can use/define cable with no role according
695 * to schema of hardware board.
697 ret = max77693_muic_dock_handler(info, cable_type, attached);
701 case MAX77693_MUIC_ADC_REMOTE_S3_BUTTON: /* DOCK_KEY_PREV */
702 case MAX77693_MUIC_ADC_REMOTE_S7_BUTTON: /* DOCK_KEY_NEXT */
703 case MAX77693_MUIC_ADC_REMOTE_S9_BUTTON: /* DOCK_VOL_DOWN */
704 case MAX77693_MUIC_ADC_REMOTE_S10_BUTTON: /* DOCK_VOL_UP */
705 case MAX77693_MUIC_ADC_REMOTE_S12_BUTTON: /* DOCK_KEY_PLAY_PAUSE */
707 * Button of DOCK device
708 * - the Prev/Next/Volume Up/Volume Down/Play-Pause button
710 * The MAX77693 MUIC device can detect total 34 cable type
711 * except of charger cable and MUIC device didn't define
712 * specfic role of cable in the range of from 0x01 to 0x12
713 * of ADC value. So, can use/define cable with no role according
714 * to schema of hardware board.
717 button_type = info->prev_button_type = cable_type;
719 button_type = info->prev_button_type;
721 ret = max77693_muic_dock_button_handler(info, button_type,
726 case MAX77693_MUIC_ADC_SEND_END_BUTTON:
727 case MAX77693_MUIC_ADC_REMOTE_S1_BUTTON:
728 case MAX77693_MUIC_ADC_REMOTE_S2_BUTTON:
729 case MAX77693_MUIC_ADC_REMOTE_S4_BUTTON:
730 case MAX77693_MUIC_ADC_REMOTE_S5_BUTTON:
731 case MAX77693_MUIC_ADC_REMOTE_S6_BUTTON:
732 case MAX77693_MUIC_ADC_REMOTE_S8_BUTTON:
733 case MAX77693_MUIC_ADC_REMOTE_S11_BUTTON:
734 case MAX77693_MUIC_ADC_RESERVED_ACC_1:
735 case MAX77693_MUIC_ADC_RESERVED_ACC_2:
736 case MAX77693_MUIC_ADC_RESERVED_ACC_4:
737 case MAX77693_MUIC_ADC_RESERVED_ACC_5:
738 case MAX77693_MUIC_ADC_CEA936_AUDIO:
739 case MAX77693_MUIC_ADC_PHONE_POWERED_DEV:
740 case MAX77693_MUIC_ADC_TTY_CONVERTER:
741 case MAX77693_MUIC_ADC_UART_CABLE:
742 case MAX77693_MUIC_ADC_CEA936A_TYPE1_CHG:
743 case MAX77693_MUIC_ADC_CEA936A_TYPE2_CHG:
745 * This accessory isn't used in general case if it is specially
746 * needed to detect additional accessory, should implement
747 * proper operation when this accessory is attached/detached.
750 "accessory is %s but it isn't used (adc:0x%x)\n",
751 attached ? "attached" : "detached", cable_type);
755 "failed to detect %s accessory (adc:0x%x)\n",
756 attached ? "attached" : "detached", cable_type);
763 static int max77693_muic_chg_handler(struct max77693_muic_info *info)
772 chg_type = max77693_muic_get_cable_type(info,
773 MAX77693_CABLE_GROUP_CHG, &attached);
776 "external connector is %s(chg_type:0x%x, prev_chg_type:0x%x)\n",
777 attached ? "attached" : "detached",
778 chg_type, info->prev_chg_type);
781 case MAX77693_CHARGER_TYPE_USB:
782 case MAX77693_CHARGER_TYPE_DEDICATED_CHG:
783 case MAX77693_CHARGER_TYPE_NONE:
784 /* Check MAX77693_CABLE_GROUP_ADC_GND type */
785 cable_type_gnd = max77693_muic_get_cable_type(info,
786 MAX77693_CABLE_GROUP_ADC_GND,
788 switch (cable_type_gnd) {
789 case MAX77693_MUIC_GND_MHL:
790 case MAX77693_MUIC_GND_MHL_VB:
792 * MHL cable with USB/TA cable
793 * - MHL cable include two port(HDMI line and separate
794 * micro-usb port. When the target connect MHL cable,
795 * extcon driver check whether USB/TA cable is
796 * connected. If USB/TA cable is connected, extcon
797 * driver notify state to notifiee for charging battery.
799 * Features of 'USB/TA with MHL cable'
801 * - Support charging through micro-usb port without
804 extcon_set_cable_state_(info->edev, EXTCON_TA, attached);
806 extcon_set_cable_state_(info->edev, EXTCON_MHL,
811 /* Check MAX77693_CABLE_GROUP_ADC type */
812 cable_type = max77693_muic_get_cable_type(info,
813 MAX77693_CABLE_GROUP_ADC,
815 switch (cable_type) {
816 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD: /* Dock-Audio */
818 * Dock-Audio device with USB/TA cable
819 * - Dock device include two port(Dock-Audio and micro-
820 * usb port). When the target connect Dock-Audio device,
821 * extcon driver check whether USB/TA cable is connected
822 * or not. If USB/TA cable is connected, extcon driver
823 * notify state to notifiee for charging battery.
825 * Features of 'USB/TA cable with Dock-Audio device'
826 * - Support external output feature of audio.
827 * - Support charging through micro-usb port without
830 extcon_set_cable_state_(info->edev, EXTCON_USB,
834 extcon_set_cable_state_(info->edev, EXTCON_DOCK,
837 case MAX77693_MUIC_ADC_RESERVED_ACC_3: /* Dock-Smart */
839 * Dock-Smart device with USB/TA cable
840 * - Dock-Desk device include three type of cable which
841 * are HDMI, USB for mouse/keyboard and micro-usb port
842 * for USB/TA cable. Dock-Smart device need always
843 * exteranl power supply(USB/TA cable through micro-usb
844 * cable). Dock-Smart device support screen output of
845 * target to separate monitor and mouse/keyboard for
848 * Features of 'USB/TA cable with Dock-Smart device'
850 * - Support external output feature of audio
851 * - Support charging through micro-usb port without
852 * data connection if TA cable is connected to target.
853 * - Support charging and data connection through micro-
854 * usb port if USB cable is connected between target
856 * - Support OTG(On-The-Go) device (Ex: Mouse/Keyboard)
858 ret = max77693_muic_set_path(info, info->path_usb,
863 extcon_set_cable_state_(info->edev, EXTCON_DOCK,
865 extcon_set_cable_state_(info->edev, EXTCON_MHL,
870 /* Check MAX77693_CABLE_GROUP_CHG type */
872 case MAX77693_CHARGER_TYPE_NONE:
874 * When MHL(with USB/TA cable) or Dock-Audio with USB/TA
875 * cable is attached, muic device happen below two irq.
876 * - 'MAX77693_MUIC_IRQ_INT1_ADC' for detecting
878 * - 'MAX77693_MUIC_IRQ_INT2_CHGTYP' for detecting
879 * USB/TA cable connected to MHL or Dock-Audio.
880 * Always, happen eariler MAX77693_MUIC_IRQ_INT1_ADC
881 * irq than MAX77693_MUIC_IRQ_INT2_CHGTYP irq.
883 * If user attach MHL (with USB/TA cable and immediately
884 * detach MHL with USB/TA cable before MAX77693_MUIC_IRQ
885 * _INT2_CHGTYP irq is happened, USB/TA cable remain
886 * connected state to target. But USB/TA cable isn't
887 * connected to target. The user be face with unusual
888 * action. So, driver should check this situation in
889 * spite of, that previous charger type is N/A.
892 case MAX77693_CHARGER_TYPE_USB:
893 /* Only USB cable, PATH:AP_USB */
894 ret = max77693_muic_set_path(info, info->path_usb,
899 extcon_set_cable_state_(info->edev, EXTCON_USB,
902 case MAX77693_CHARGER_TYPE_DEDICATED_CHG:
904 extcon_set_cable_state_(info->edev, EXTCON_TA, attached);
908 case MAX77693_CHARGER_TYPE_DOWNSTREAM_PORT:
909 extcon_set_cable_state_(info->edev, EXTCON_CHARGE_DOWNSTREAM,
912 case MAX77693_CHARGER_TYPE_APPLE_500MA:
913 extcon_set_cable_state_(info->edev, EXTCON_SLOW_CHARGER,
916 case MAX77693_CHARGER_TYPE_APPLE_1A_2A:
917 extcon_set_cable_state_(info->edev, EXTCON_FAST_CHARGER,
920 case MAX77693_CHARGER_TYPE_DEAD_BATTERY:
924 "failed to detect %s accessory (chg_type:0x%x)\n",
925 attached ? "attached" : "detached", chg_type);
932 static void max77693_muic_irq_work(struct work_struct *work)
934 struct max77693_muic_info *info = container_of(work,
935 struct max77693_muic_info, irq_work);
942 mutex_lock(&info->mutex);
944 for (i = 0; i < ARRAY_SIZE(muic_irqs); i++)
945 if (info->irq == muic_irqs[i].virq)
946 irq_type = muic_irqs[i].irq;
948 ret = regmap_bulk_read(info->max77693->regmap_muic,
949 MAX77693_MUIC_REG_STATUS1, info->status, 2);
951 dev_err(info->dev, "failed to read MUIC register\n");
952 mutex_unlock(&info->mutex);
957 case MAX77693_MUIC_IRQ_INT1_ADC:
958 case MAX77693_MUIC_IRQ_INT1_ADC_LOW:
959 case MAX77693_MUIC_IRQ_INT1_ADC_ERR:
960 case MAX77693_MUIC_IRQ_INT1_ADC1K:
961 /* Handle all of accessory except for
962 type of charger accessory */
963 ret = max77693_muic_adc_handler(info);
965 case MAX77693_MUIC_IRQ_INT2_CHGTYP:
966 case MAX77693_MUIC_IRQ_INT2_CHGDETREUN:
967 case MAX77693_MUIC_IRQ_INT2_DCDTMR:
968 case MAX77693_MUIC_IRQ_INT2_DXOVP:
969 case MAX77693_MUIC_IRQ_INT2_VBVOLT:
970 case MAX77693_MUIC_IRQ_INT2_VIDRM:
971 /* Handle charger accessory */
972 ret = max77693_muic_chg_handler(info);
974 case MAX77693_MUIC_IRQ_INT3_EOC:
975 case MAX77693_MUIC_IRQ_INT3_CGMBC:
976 case MAX77693_MUIC_IRQ_INT3_OVP:
977 case MAX77693_MUIC_IRQ_INT3_MBCCHG_ERR:
978 case MAX77693_MUIC_IRQ_INT3_CHG_ENABLED:
979 case MAX77693_MUIC_IRQ_INT3_BAT_DET:
982 dev_err(info->dev, "muic interrupt: irq %d occurred\n",
984 mutex_unlock(&info->mutex);
989 dev_err(info->dev, "failed to handle MUIC interrupt\n");
991 mutex_unlock(&info->mutex);
994 static irqreturn_t max77693_muic_irq_handler(int irq, void *data)
996 struct max77693_muic_info *info = data;
999 schedule_work(&info->irq_work);
1004 static const struct regmap_config max77693_muic_regmap_config = {
1009 static int max77693_muic_detect_accessory(struct max77693_muic_info *info)
1016 mutex_lock(&info->mutex);
1018 /* Read STATUSx register to detect accessory */
1019 ret = regmap_bulk_read(info->max77693->regmap_muic,
1020 MAX77693_MUIC_REG_STATUS1, info->status, 2);
1022 dev_err(info->dev, "failed to read MUIC register\n");
1023 mutex_unlock(&info->mutex);
1027 adc = max77693_muic_get_cable_type(info, MAX77693_CABLE_GROUP_ADC,
1029 if (attached && adc != MAX77693_MUIC_ADC_OPEN) {
1030 ret = max77693_muic_adc_handler(info);
1032 dev_err(info->dev, "Cannot detect accessory\n");
1033 mutex_unlock(&info->mutex);
1038 chg_type = max77693_muic_get_cable_type(info, MAX77693_CABLE_GROUP_CHG,
1040 if (attached && chg_type != MAX77693_CHARGER_TYPE_NONE) {
1041 ret = max77693_muic_chg_handler(info);
1043 dev_err(info->dev, "Cannot detect charger accessory\n");
1044 mutex_unlock(&info->mutex);
1049 mutex_unlock(&info->mutex);
1054 static void max77693_muic_detect_cable_wq(struct work_struct *work)
1056 struct max77693_muic_info *info = container_of(to_delayed_work(work),
1057 struct max77693_muic_info, wq_detcable);
1059 max77693_muic_detect_accessory(info);
1062 static int max77693_muic_probe(struct platform_device *pdev)
1064 struct max77693_dev *max77693 = dev_get_drvdata(pdev->dev.parent);
1065 struct max77693_platform_data *pdata = dev_get_platdata(max77693->dev);
1066 struct max77693_muic_info *info;
1067 struct max77693_reg_data *init_data;
1074 info = devm_kzalloc(&pdev->dev, sizeof(struct max77693_muic_info),
1079 info->dev = &pdev->dev;
1080 info->max77693 = max77693;
1081 if (info->max77693->regmap_muic) {
1082 dev_dbg(&pdev->dev, "allocate register map\n");
1084 info->max77693->regmap_muic = devm_regmap_init_i2c(
1085 info->max77693->i2c_muic,
1086 &max77693_muic_regmap_config);
1087 if (IS_ERR(info->max77693->regmap_muic)) {
1088 ret = PTR_ERR(info->max77693->regmap_muic);
1089 dev_err(max77693->dev,
1090 "failed to allocate register map: %d\n", ret);
1095 /* Register input device for button of dock device */
1096 info->dock = devm_input_allocate_device(&pdev->dev);
1098 dev_err(&pdev->dev, "%s: failed to allocate input\n", __func__);
1101 info->dock->name = "max77693-muic/dock";
1102 info->dock->phys = "max77693-muic/extcon";
1103 info->dock->dev.parent = &pdev->dev;
1105 __set_bit(EV_REP, info->dock->evbit);
1107 input_set_capability(info->dock, EV_KEY, KEY_VOLUMEUP);
1108 input_set_capability(info->dock, EV_KEY, KEY_VOLUMEDOWN);
1109 input_set_capability(info->dock, EV_KEY, KEY_PLAYPAUSE);
1110 input_set_capability(info->dock, EV_KEY, KEY_PREVIOUSSONG);
1111 input_set_capability(info->dock, EV_KEY, KEY_NEXTSONG);
1113 ret = input_register_device(info->dock);
1115 dev_err(&pdev->dev, "Cannot register input device error(%d)\n",
1120 platform_set_drvdata(pdev, info);
1121 mutex_init(&info->mutex);
1123 INIT_WORK(&info->irq_work, max77693_muic_irq_work);
1125 /* Support irq domain for MAX77693 MUIC device */
1126 for (i = 0; i < ARRAY_SIZE(muic_irqs); i++) {
1127 struct max77693_muic_irq *muic_irq = &muic_irqs[i];
1128 unsigned int virq = 0;
1130 virq = regmap_irq_get_virq(max77693->irq_data_muic,
1134 muic_irq->virq = virq;
1136 ret = devm_request_threaded_irq(&pdev->dev, virq, NULL,
1137 max77693_muic_irq_handler,
1139 muic_irq->name, info);
1142 "failed: irq request (IRQ: %d, error :%d)\n",
1143 muic_irq->irq, ret);
1148 /* Initialize extcon device */
1149 info->edev = devm_extcon_dev_allocate(&pdev->dev,
1150 max77693_extcon_cable);
1151 if (IS_ERR(info->edev)) {
1152 dev_err(&pdev->dev, "failed to allocate memory for extcon\n");
1156 ret = devm_extcon_dev_register(&pdev->dev, info->edev);
1158 dev_err(&pdev->dev, "failed to register extcon device\n");
1162 /* Initialize MUIC register by using platform data or default data */
1163 if (pdata && pdata->muic_data) {
1164 init_data = pdata->muic_data->init_data;
1165 num_init_data = pdata->muic_data->num_init_data;
1167 init_data = default_init_data;
1168 num_init_data = ARRAY_SIZE(default_init_data);
1171 for (i = 0; i < num_init_data; i++) {
1172 regmap_write(info->max77693->regmap_muic,
1177 if (pdata && pdata->muic_data) {
1178 struct max77693_muic_platform_data *muic_pdata
1182 * Default usb/uart path whether UART/USB or AUX_UART/AUX_USB
1183 * h/w path of COMP2/COMN1 on CONTROL1 register.
1185 if (muic_pdata->path_uart)
1186 info->path_uart = muic_pdata->path_uart;
1188 info->path_uart = MAX77693_CONTROL1_SW_UART;
1190 if (muic_pdata->path_usb)
1191 info->path_usb = muic_pdata->path_usb;
1193 info->path_usb = MAX77693_CONTROL1_SW_USB;
1196 * Default delay time for detecting cable state
1197 * after certain time.
1199 if (muic_pdata->detcable_delay_ms)
1201 msecs_to_jiffies(muic_pdata->detcable_delay_ms);
1203 delay_jiffies = msecs_to_jiffies(DELAY_MS_DEFAULT);
1205 info->path_usb = MAX77693_CONTROL1_SW_USB;
1206 info->path_uart = MAX77693_CONTROL1_SW_UART;
1207 delay_jiffies = msecs_to_jiffies(DELAY_MS_DEFAULT);
1210 /* Set initial path for UART */
1211 max77693_muic_set_path(info, info->path_uart, true);
1213 /* Check revision number of MUIC device*/
1214 ret = regmap_read(info->max77693->regmap_muic,
1215 MAX77693_MUIC_REG_ID, &id);
1217 dev_err(&pdev->dev, "failed to read revision number\n");
1220 dev_info(info->dev, "device ID : 0x%x\n", id);
1222 /* Set ADC debounce time */
1223 max77693_muic_set_debounce_time(info, ADC_DEBOUNCE_TIME_25MS);
1226 * Detect accessory after completing the initialization of platform
1228 * - Use delayed workqueue to detect cable state and then
1229 * notify cable state to notifiee/platform through uevent.
1230 * After completing the booting of platform, the extcon provider
1231 * driver should notify cable state to upper layer.
1233 INIT_DELAYED_WORK(&info->wq_detcable, max77693_muic_detect_cable_wq);
1234 queue_delayed_work(system_power_efficient_wq, &info->wq_detcable,
1240 static int max77693_muic_remove(struct platform_device *pdev)
1242 struct max77693_muic_info *info = platform_get_drvdata(pdev);
1244 cancel_work_sync(&info->irq_work);
1245 input_unregister_device(info->dock);
1250 static struct platform_driver max77693_muic_driver = {
1254 .probe = max77693_muic_probe,
1255 .remove = max77693_muic_remove,
1258 module_platform_driver(max77693_muic_driver);
1260 MODULE_DESCRIPTION("Maxim MAX77693 Extcon driver");
1262 MODULE_LICENSE("GPL");
1263 MODULE_ALIAS("platform:extcon-max77693");