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,
192 * The below accessories have same ADC value so ADCLow and
193 * ADC1K bit is used to separate specific accessory.
195 /* ADC|VBVolot|ADCLow|ADC1K| */
196 MAX77693_MUIC_GND_USB_HOST = 0x100, /* 0x0| 0| 0| 0| */
197 MAX77693_MUIC_GND_USB_HOST_VB = 0x104, /* 0x0| 1| 0| 0| */
198 MAX77693_MUIC_GND_AV_CABLE_LOAD = 0x102,/* 0x0| 0| 1| 0| */
199 MAX77693_MUIC_GND_MHL = 0x103, /* 0x0| 0| 1| 1| */
200 MAX77693_MUIC_GND_MHL_VB = 0x107, /* 0x0| 1| 1| 1| */
204 * MAX77693 MUIC device support below list of accessories(external connector)
206 static const unsigned int max77693_extcon_cable[] = {
221 * max77693_muic_set_debounce_time - Set the debounce time of ADC
222 * @info: the instance including private data of max77693 MUIC
223 * @time: the debounce time of ADC
225 static int max77693_muic_set_debounce_time(struct max77693_muic_info *info,
226 enum max77693_muic_adc_debounce_time time)
231 case ADC_DEBOUNCE_TIME_5MS:
232 case ADC_DEBOUNCE_TIME_10MS:
233 case ADC_DEBOUNCE_TIME_25MS:
234 case ADC_DEBOUNCE_TIME_38_62MS:
236 * Don't touch BTLDset, JIGset when you want to change adc
237 * debounce time. If it writes other than 0 to BTLDset, JIGset
238 * muic device will be reset and loose current state.
240 ret = regmap_write(info->max77693->regmap_muic,
241 MAX77693_MUIC_REG_CTRL3,
242 time << MAX77693_CONTROL3_ADCDBSET_SHIFT);
244 dev_err(info->dev, "failed to set ADC debounce time\n");
249 dev_err(info->dev, "invalid ADC debounce time\n");
257 * max77693_muic_set_path - Set hardware line according to attached cable
258 * @info: the instance including private data of max77693 MUIC
259 * @value: the path according to attached cable
260 * @attached: the state of cable (true:attached, false:detached)
262 * The max77693 MUIC device share outside H/W line among a varity of cables
263 * so, this function set internal path of H/W line according to the type of
266 static int max77693_muic_set_path(struct max77693_muic_info *info,
267 u8 val, bool attached)
270 unsigned int ctrl1, ctrl2 = 0;
275 ctrl1 = MAX77693_CONTROL1_SW_OPEN;
277 ret = regmap_update_bits(info->max77693->regmap_muic,
278 MAX77693_MUIC_REG_CTRL1, COMP_SW_MASK, ctrl1);
280 dev_err(info->dev, "failed to update MUIC register\n");
285 ctrl2 |= MAX77693_CONTROL2_CPEN_MASK; /* LowPwr=0, CPEn=1 */
287 ctrl2 |= MAX77693_CONTROL2_LOWPWR_MASK; /* LowPwr=1, CPEn=0 */
289 ret = regmap_update_bits(info->max77693->regmap_muic,
290 MAX77693_MUIC_REG_CTRL2,
291 MAX77693_CONTROL2_LOWPWR_MASK | MAX77693_CONTROL2_CPEN_MASK,
294 dev_err(info->dev, "failed to update MUIC register\n");
299 "CONTROL1 : 0x%02x, CONTROL2 : 0x%02x, state : %s\n",
300 ctrl1, ctrl2, attached ? "attached" : "detached");
306 * max77693_muic_get_cable_type - Return cable type and check cable state
307 * @info: the instance including private data of max77693 MUIC
308 * @group: the path according to attached cable
309 * @attached: store cable state and return
311 * This function check the cable state either attached or detached,
312 * and then divide precise type of cable according to cable group.
313 * - MAX77693_CABLE_GROUP_ADC
314 * - MAX77693_CABLE_GROUP_ADC_GND
315 * - MAX77693_CABLE_GROUP_CHG
316 * - MAX77693_CABLE_GROUP_VBVOLT
318 static int max77693_muic_get_cable_type(struct max77693_muic_info *info,
319 enum max77693_muic_cable_group group, bool *attached)
329 case MAX77693_CABLE_GROUP_ADC:
331 * Read ADC value to check cable type and decide cable state
332 * according to cable type
334 adc = info->status[0] & MAX77693_STATUS1_ADC_MASK;
335 adc >>= MAX77693_STATUS1_ADC_SHIFT;
338 * Check current cable state/cable type and store cable type
339 * (info->prev_cable_type) for handling cable when cable is
342 if (adc == MAX77693_MUIC_ADC_OPEN) {
345 cable_type = info->prev_cable_type;
346 info->prev_cable_type = MAX77693_MUIC_ADC_OPEN;
350 cable_type = info->prev_cable_type = adc;
353 case MAX77693_CABLE_GROUP_ADC_GND:
355 * Read ADC value to check cable type and decide cable state
356 * according to cable type
358 adc = info->status[0] & MAX77693_STATUS1_ADC_MASK;
359 adc >>= MAX77693_STATUS1_ADC_SHIFT;
362 * Check current cable state/cable type and store cable type
363 * (info->prev_cable_type/_gnd) for handling cable when cable
366 if (adc == MAX77693_MUIC_ADC_OPEN) {
369 cable_type = info->prev_cable_type_gnd;
370 info->prev_cable_type_gnd = MAX77693_MUIC_ADC_OPEN;
374 adclow = info->status[0] & MAX77693_STATUS1_ADCLOW_MASK;
375 adclow >>= MAX77693_STATUS1_ADCLOW_SHIFT;
376 adc1k = info->status[0] & MAX77693_STATUS1_ADC1K_MASK;
377 adc1k >>= MAX77693_STATUS1_ADC1K_SHIFT;
379 vbvolt = info->status[1] & MAX77693_STATUS2_VBVOLT_MASK;
380 vbvolt >>= MAX77693_STATUS2_VBVOLT_SHIFT;
383 * [0x1|VBVolt|ADCLow|ADC1K]
384 * [0x1| 0| 0| 0] USB_HOST
385 * [0x1| 1| 0| 0] USB_HSOT_VB
386 * [0x1| 0| 1| 0] Audio Video cable with load
387 * [0x1| 0| 1| 1] MHL without charging cable
388 * [0x1| 1| 1| 1] MHL with charging cable
390 cable_type = ((0x1 << 8)
395 info->prev_cable_type = adc;
396 info->prev_cable_type_gnd = cable_type;
400 case MAX77693_CABLE_GROUP_CHG:
402 * Read charger type to check cable type and decide cable state
403 * according to type of charger cable.
405 chg_type = info->status[1] & MAX77693_STATUS2_CHGTYP_MASK;
406 chg_type >>= MAX77693_STATUS2_CHGTYP_SHIFT;
408 if (chg_type == MAX77693_CHARGER_TYPE_NONE) {
411 cable_type = info->prev_chg_type;
412 info->prev_chg_type = MAX77693_CHARGER_TYPE_NONE;
417 * Check current cable state/cable type and store cable
418 * type(info->prev_chg_type) for handling cable when
419 * charger cable is detached.
421 cable_type = info->prev_chg_type = chg_type;
425 case MAX77693_CABLE_GROUP_VBVOLT:
427 * Read ADC value to check cable type and decide cable state
428 * according to cable type
430 adc = info->status[0] & MAX77693_STATUS1_ADC_MASK;
431 adc >>= MAX77693_STATUS1_ADC_SHIFT;
432 chg_type = info->status[1] & MAX77693_STATUS2_CHGTYP_MASK;
433 chg_type >>= MAX77693_STATUS2_CHGTYP_SHIFT;
435 if (adc == MAX77693_MUIC_ADC_OPEN
436 && chg_type == MAX77693_CHARGER_TYPE_NONE)
442 * Read vbvolt field, if vbvolt is 1,
443 * this cable is used for charging.
445 vbvolt = info->status[1] & MAX77693_STATUS2_VBVOLT_MASK;
446 vbvolt >>= MAX77693_STATUS2_VBVOLT_SHIFT;
451 dev_err(info->dev, "Unknown cable group (%d)\n", group);
452 cable_type = -EINVAL;
459 static int max77693_muic_dock_handler(struct max77693_muic_info *info,
460 int cable_type, bool attached)
465 unsigned int dock_id;
468 "external connector is %s (adc:0x%02x)\n",
469 attached ? "attached" : "detached", cable_type);
471 switch (cable_type) {
472 case MAX77693_MUIC_ADC_RESERVED_ACC_3: /* Dock-Smart */
474 * Check power cable whether attached or detached state.
475 * The Dock-Smart device need surely external power supply.
476 * If power cable(USB/TA) isn't connected to Dock device,
477 * user can't use Dock-Smart for desktop mode.
479 vbvolt = max77693_muic_get_cable_type(info,
480 MAX77693_CABLE_GROUP_VBVOLT, &cable_attached);
481 if (attached && !vbvolt) {
483 "Cannot detect external power supply\n");
488 * Notify Dock/MHL state.
489 * - Dock device include three type of cable which
490 * are HDMI, USB for mouse/keyboard and micro-usb port
491 * for USB/TA cable. Dock device need always exteranl
492 * power supply(USB/TA cable through micro-usb cable). Dock
493 * device support screen output of target to separate
494 * monitor and mouse/keyboard for desktop mode.
496 * Features of 'USB/TA cable with Dock device'
498 * - Support external output feature of audio
499 * - Support charging through micro-usb port without data
500 * connection if TA cable is connected to target.
501 * - Support charging and data connection through micro-usb port
502 * if USB cable is connected between target and host
504 * - Support OTG(On-The-Go) device (Ex: Mouse/Keyboard)
506 ret = max77693_muic_set_path(info, info->path_usb, attached);
510 extcon_set_state_sync(info->edev, EXTCON_DOCK, attached);
511 extcon_set_state_sync(info->edev, EXTCON_DISP_MHL, attached);
513 case MAX77693_MUIC_ADC_AUDIO_MODE_REMOTE: /* Dock-Desk */
514 dock_id = EXTCON_DOCK;
516 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD: /* Dock-Audio */
517 dock_id = EXTCON_DOCK;
519 extcon_set_state_sync(info->edev, EXTCON_USB, false);
520 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_SDP,
525 dev_err(info->dev, "failed to detect %s dock device\n",
526 attached ? "attached" : "detached");
530 /* Dock-Car/Desk/Audio, PATH:AUDIO */
531 ret = max77693_muic_set_path(info, MAX77693_CONTROL1_SW_AUDIO,
535 extcon_set_state_sync(info->edev, dock_id, attached);
541 static int max77693_muic_dock_button_handler(struct max77693_muic_info *info,
542 int button_type, bool attached)
544 struct input_dev *dock = info->dock;
547 switch (button_type) {
548 case MAX77693_MUIC_ADC_REMOTE_S3_BUTTON-1
549 ... MAX77693_MUIC_ADC_REMOTE_S3_BUTTON+1:
551 code = KEY_PREVIOUSSONG;
553 case MAX77693_MUIC_ADC_REMOTE_S7_BUTTON-1
554 ... MAX77693_MUIC_ADC_REMOTE_S7_BUTTON+1:
558 case MAX77693_MUIC_ADC_REMOTE_S9_BUTTON:
560 code = KEY_VOLUMEDOWN;
562 case MAX77693_MUIC_ADC_REMOTE_S10_BUTTON:
566 case MAX77693_MUIC_ADC_REMOTE_S12_BUTTON-1
567 ... MAX77693_MUIC_ADC_REMOTE_S12_BUTTON+1:
568 /* DOCK_KEY_PLAY_PAUSE */
569 code = KEY_PLAYPAUSE;
573 "failed to detect %s key (adc:0x%x)\n",
574 attached ? "pressed" : "released", button_type);
578 input_event(dock, EV_KEY, code, attached);
584 static int max77693_muic_adc_ground_handler(struct max77693_muic_info *info)
590 cable_type_gnd = max77693_muic_get_cable_type(info,
591 MAX77693_CABLE_GROUP_ADC_GND, &attached);
593 switch (cable_type_gnd) {
594 case MAX77693_MUIC_GND_USB_HOST:
595 case MAX77693_MUIC_GND_USB_HOST_VB:
596 /* USB_HOST, PATH: AP_USB */
597 ret = max77693_muic_set_path(info, MAX77693_CONTROL1_SW_USB,
601 extcon_set_state_sync(info->edev, EXTCON_USB_HOST, attached);
603 case MAX77693_MUIC_GND_AV_CABLE_LOAD:
604 /* Audio Video Cable with load, PATH:AUDIO */
605 ret = max77693_muic_set_path(info, MAX77693_CONTROL1_SW_AUDIO,
609 extcon_set_state_sync(info->edev, EXTCON_USB, attached);
610 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_SDP,
613 case MAX77693_MUIC_GND_MHL:
614 case MAX77693_MUIC_GND_MHL_VB:
615 /* MHL or MHL with USB/TA cable */
616 extcon_set_state_sync(info->edev, EXTCON_DISP_MHL, attached);
619 dev_err(info->dev, "failed to detect %s cable of gnd type\n",
620 attached ? "attached" : "detached");
627 static int max77693_muic_jig_handler(struct max77693_muic_info *info,
628 int cable_type, bool attached)
631 u8 path = MAX77693_CONTROL1_SW_OPEN;
634 "external connector is %s (adc:0x%02x)\n",
635 attached ? "attached" : "detached", cable_type);
637 switch (cable_type) {
638 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_OFF: /* ADC_JIG_USB_OFF */
639 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_ON: /* ADC_JIG_USB_ON */
641 path = MAX77693_CONTROL1_SW_USB;
643 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF: /* ADC_JIG_UART_OFF */
644 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON: /* ADC_JIG_UART_ON */
646 path = MAX77693_CONTROL1_SW_UART;
649 dev_err(info->dev, "failed to detect %s jig cable\n",
650 attached ? "attached" : "detached");
654 ret = max77693_muic_set_path(info, path, attached);
658 extcon_set_state_sync(info->edev, EXTCON_JIG, attached);
663 static int max77693_muic_adc_handler(struct max77693_muic_info *info)
670 /* Check accessory state which is either detached or attached */
671 cable_type = max77693_muic_get_cable_type(info,
672 MAX77693_CABLE_GROUP_ADC, &attached);
675 "external connector is %s (adc:0x%02x, prev_adc:0x%x)\n",
676 attached ? "attached" : "detached", cable_type,
677 info->prev_cable_type);
679 switch (cable_type) {
680 case MAX77693_MUIC_ADC_GROUND:
681 /* USB_HOST/MHL/Audio */
682 max77693_muic_adc_ground_handler(info);
684 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_OFF:
685 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_ON:
686 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF:
687 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON:
689 ret = max77693_muic_jig_handler(info, cable_type, attached);
693 case MAX77693_MUIC_ADC_RESERVED_ACC_3: /* Dock-Smart */
694 case MAX77693_MUIC_ADC_AUDIO_MODE_REMOTE: /* Dock-Desk */
695 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD: /* Dock-Audio */
699 * The MAX77693 MUIC device can detect total 34 cable type
700 * except of charger cable and MUIC device didn't define
701 * specfic role of cable in the range of from 0x01 to 0x12
702 * of ADC value. So, can use/define cable with no role according
703 * to schema of hardware board.
705 ret = max77693_muic_dock_handler(info, cable_type, attached);
709 case MAX77693_MUIC_ADC_REMOTE_S3_BUTTON: /* DOCK_KEY_PREV */
710 case MAX77693_MUIC_ADC_REMOTE_S7_BUTTON: /* DOCK_KEY_NEXT */
711 case MAX77693_MUIC_ADC_REMOTE_S9_BUTTON: /* DOCK_VOL_DOWN */
712 case MAX77693_MUIC_ADC_REMOTE_S10_BUTTON: /* DOCK_VOL_UP */
713 case MAX77693_MUIC_ADC_REMOTE_S12_BUTTON: /* DOCK_KEY_PLAY_PAUSE */
715 * Button of DOCK device
716 * - the Prev/Next/Volume Up/Volume Down/Play-Pause button
718 * The MAX77693 MUIC device can detect total 34 cable type
719 * except of charger cable and MUIC device didn't define
720 * specfic role of cable in the range of from 0x01 to 0x12
721 * of ADC value. So, can use/define cable with no role according
722 * to schema of hardware board.
725 button_type = info->prev_button_type = cable_type;
727 button_type = info->prev_button_type;
729 ret = max77693_muic_dock_button_handler(info, button_type,
734 case MAX77693_MUIC_ADC_SEND_END_BUTTON:
735 case MAX77693_MUIC_ADC_REMOTE_S1_BUTTON:
736 case MAX77693_MUIC_ADC_REMOTE_S2_BUTTON:
737 case MAX77693_MUIC_ADC_REMOTE_S4_BUTTON:
738 case MAX77693_MUIC_ADC_REMOTE_S5_BUTTON:
739 case MAX77693_MUIC_ADC_REMOTE_S6_BUTTON:
740 case MAX77693_MUIC_ADC_REMOTE_S8_BUTTON:
741 case MAX77693_MUIC_ADC_REMOTE_S11_BUTTON:
742 case MAX77693_MUIC_ADC_RESERVED_ACC_1:
743 case MAX77693_MUIC_ADC_RESERVED_ACC_2:
744 case MAX77693_MUIC_ADC_RESERVED_ACC_4:
745 case MAX77693_MUIC_ADC_RESERVED_ACC_5:
746 case MAX77693_MUIC_ADC_CEA936_AUDIO:
747 case MAX77693_MUIC_ADC_PHONE_POWERED_DEV:
748 case MAX77693_MUIC_ADC_TTY_CONVERTER:
749 case MAX77693_MUIC_ADC_UART_CABLE:
750 case MAX77693_MUIC_ADC_CEA936A_TYPE1_CHG:
751 case MAX77693_MUIC_ADC_CEA936A_TYPE2_CHG:
753 * This accessory isn't used in general case if it is specially
754 * needed to detect additional accessory, should implement
755 * proper operation when this accessory is attached/detached.
758 "accessory is %s but it isn't used (adc:0x%x)\n",
759 attached ? "attached" : "detached", cable_type);
763 "failed to detect %s accessory (adc:0x%x)\n",
764 attached ? "attached" : "detached", cable_type);
771 static int max77693_muic_chg_handler(struct max77693_muic_info *info)
780 chg_type = max77693_muic_get_cable_type(info,
781 MAX77693_CABLE_GROUP_CHG, &attached);
784 "external connector is %s(chg_type:0x%x, prev_chg_type:0x%x)\n",
785 attached ? "attached" : "detached",
786 chg_type, info->prev_chg_type);
789 case MAX77693_CHARGER_TYPE_USB:
790 case MAX77693_CHARGER_TYPE_DEDICATED_CHG:
791 case MAX77693_CHARGER_TYPE_NONE:
792 /* Check MAX77693_CABLE_GROUP_ADC_GND type */
793 cable_type_gnd = max77693_muic_get_cable_type(info,
794 MAX77693_CABLE_GROUP_ADC_GND,
796 switch (cable_type_gnd) {
797 case MAX77693_MUIC_GND_MHL:
798 case MAX77693_MUIC_GND_MHL_VB:
800 * MHL cable with USB/TA cable
801 * - MHL cable include two port(HDMI line and separate
802 * micro-usb port. When the target connect MHL cable,
803 * extcon driver check whether USB/TA cable is
804 * connected. If USB/TA cable is connected, extcon
805 * driver notify state to notifiee for charging battery.
807 * Features of 'USB/TA with MHL cable'
809 * - Support charging through micro-usb port without
812 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_DCP,
815 extcon_set_state_sync(info->edev,
816 EXTCON_DISP_MHL, cable_attached);
820 /* Check MAX77693_CABLE_GROUP_ADC type */
821 cable_type = max77693_muic_get_cable_type(info,
822 MAX77693_CABLE_GROUP_ADC,
824 switch (cable_type) {
825 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD: /* Dock-Audio */
827 * Dock-Audio device with USB/TA cable
828 * - Dock device include two port(Dock-Audio and micro-
829 * usb port). When the target connect Dock-Audio device,
830 * extcon driver check whether USB/TA cable is connected
831 * or not. If USB/TA cable is connected, extcon driver
832 * notify state to notifiee for charging battery.
834 * Features of 'USB/TA cable with Dock-Audio device'
835 * - Support external output feature of audio.
836 * - Support charging through micro-usb port without
839 extcon_set_state_sync(info->edev, EXTCON_USB,
841 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_SDP,
845 extcon_set_state_sync(info->edev, EXTCON_DOCK,
848 case MAX77693_MUIC_ADC_RESERVED_ACC_3: /* Dock-Smart */
850 * Dock-Smart device with USB/TA cable
851 * - Dock-Desk device include three type of cable which
852 * are HDMI, USB for mouse/keyboard and micro-usb port
853 * for USB/TA cable. Dock-Smart device need always
854 * exteranl power supply(USB/TA cable through micro-usb
855 * cable). Dock-Smart device support screen output of
856 * target to separate monitor and mouse/keyboard for
859 * Features of 'USB/TA cable with Dock-Smart device'
861 * - Support external output feature of audio
862 * - Support charging through micro-usb port without
863 * data connection if TA cable is connected to target.
864 * - Support charging and data connection through micro-
865 * usb port if USB cable is connected between target
867 * - Support OTG(On-The-Go) device (Ex: Mouse/Keyboard)
869 ret = max77693_muic_set_path(info, info->path_usb,
874 extcon_set_state_sync(info->edev, EXTCON_DOCK,
876 extcon_set_state_sync(info->edev, EXTCON_DISP_MHL,
881 /* Check MAX77693_CABLE_GROUP_CHG type */
883 case MAX77693_CHARGER_TYPE_NONE:
885 * When MHL(with USB/TA cable) or Dock-Audio with USB/TA
886 * cable is attached, muic device happen below two irq.
887 * - 'MAX77693_MUIC_IRQ_INT1_ADC' for detecting
889 * - 'MAX77693_MUIC_IRQ_INT2_CHGTYP' for detecting
890 * USB/TA cable connected to MHL or Dock-Audio.
891 * Always, happen eariler MAX77693_MUIC_IRQ_INT1_ADC
892 * irq than MAX77693_MUIC_IRQ_INT2_CHGTYP irq.
894 * If user attach MHL (with USB/TA cable and immediately
895 * detach MHL with USB/TA cable before MAX77693_MUIC_IRQ
896 * _INT2_CHGTYP irq is happened, USB/TA cable remain
897 * connected state to target. But USB/TA cable isn't
898 * connected to target. The user be face with unusual
899 * action. So, driver should check this situation in
900 * spite of, that previous charger type is N/A.
903 case MAX77693_CHARGER_TYPE_USB:
904 /* Only USB cable, PATH:AP_USB */
905 ret = max77693_muic_set_path(info, info->path_usb,
910 extcon_set_state_sync(info->edev, EXTCON_USB,
912 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_SDP,
915 case MAX77693_CHARGER_TYPE_DEDICATED_CHG:
917 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_DCP,
922 case MAX77693_CHARGER_TYPE_DOWNSTREAM_PORT:
923 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_CDP,
926 case MAX77693_CHARGER_TYPE_APPLE_500MA:
927 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_SLOW,
930 case MAX77693_CHARGER_TYPE_APPLE_1A_2A:
931 extcon_set_state_sync(info->edev, EXTCON_CHG_USB_FAST,
934 case MAX77693_CHARGER_TYPE_DEAD_BATTERY:
938 "failed to detect %s accessory (chg_type:0x%x)\n",
939 attached ? "attached" : "detached", chg_type);
946 static void max77693_muic_irq_work(struct work_struct *work)
948 struct max77693_muic_info *info = container_of(work,
949 struct max77693_muic_info, irq_work);
956 mutex_lock(&info->mutex);
958 for (i = 0; i < ARRAY_SIZE(muic_irqs); i++)
959 if (info->irq == muic_irqs[i].virq)
960 irq_type = muic_irqs[i].irq;
962 ret = regmap_bulk_read(info->max77693->regmap_muic,
963 MAX77693_MUIC_REG_STATUS1, info->status, 2);
965 dev_err(info->dev, "failed to read MUIC register\n");
966 mutex_unlock(&info->mutex);
971 case MAX77693_MUIC_IRQ_INT1_ADC:
972 case MAX77693_MUIC_IRQ_INT1_ADC_LOW:
973 case MAX77693_MUIC_IRQ_INT1_ADC_ERR:
974 case MAX77693_MUIC_IRQ_INT1_ADC1K:
976 * Handle all of accessory except for
977 * type of charger accessory.
979 ret = max77693_muic_adc_handler(info);
981 case MAX77693_MUIC_IRQ_INT2_CHGTYP:
982 case MAX77693_MUIC_IRQ_INT2_CHGDETREUN:
983 case MAX77693_MUIC_IRQ_INT2_DCDTMR:
984 case MAX77693_MUIC_IRQ_INT2_DXOVP:
985 case MAX77693_MUIC_IRQ_INT2_VBVOLT:
986 case MAX77693_MUIC_IRQ_INT2_VIDRM:
987 /* Handle charger accessory */
988 ret = max77693_muic_chg_handler(info);
990 case MAX77693_MUIC_IRQ_INT3_EOC:
991 case MAX77693_MUIC_IRQ_INT3_CGMBC:
992 case MAX77693_MUIC_IRQ_INT3_OVP:
993 case MAX77693_MUIC_IRQ_INT3_MBCCHG_ERR:
994 case MAX77693_MUIC_IRQ_INT3_CHG_ENABLED:
995 case MAX77693_MUIC_IRQ_INT3_BAT_DET:
998 dev_err(info->dev, "muic interrupt: irq %d occurred\n",
1000 mutex_unlock(&info->mutex);
1005 dev_err(info->dev, "failed to handle MUIC interrupt\n");
1007 mutex_unlock(&info->mutex);
1010 static irqreturn_t max77693_muic_irq_handler(int irq, void *data)
1012 struct max77693_muic_info *info = data;
1015 schedule_work(&info->irq_work);
1020 static const struct regmap_config max77693_muic_regmap_config = {
1025 static int max77693_muic_detect_accessory(struct max77693_muic_info *info)
1032 mutex_lock(&info->mutex);
1034 /* Read STATUSx register to detect accessory */
1035 ret = regmap_bulk_read(info->max77693->regmap_muic,
1036 MAX77693_MUIC_REG_STATUS1, info->status, 2);
1038 dev_err(info->dev, "failed to read MUIC register\n");
1039 mutex_unlock(&info->mutex);
1043 adc = max77693_muic_get_cable_type(info, MAX77693_CABLE_GROUP_ADC,
1045 if (attached && adc != MAX77693_MUIC_ADC_OPEN) {
1046 ret = max77693_muic_adc_handler(info);
1048 dev_err(info->dev, "Cannot detect accessory\n");
1049 mutex_unlock(&info->mutex);
1054 chg_type = max77693_muic_get_cable_type(info, MAX77693_CABLE_GROUP_CHG,
1056 if (attached && chg_type != MAX77693_CHARGER_TYPE_NONE) {
1057 ret = max77693_muic_chg_handler(info);
1059 dev_err(info->dev, "Cannot detect charger accessory\n");
1060 mutex_unlock(&info->mutex);
1065 mutex_unlock(&info->mutex);
1070 static void max77693_muic_detect_cable_wq(struct work_struct *work)
1072 struct max77693_muic_info *info = container_of(to_delayed_work(work),
1073 struct max77693_muic_info, wq_detcable);
1075 max77693_muic_detect_accessory(info);
1078 static int max77693_muic_probe(struct platform_device *pdev)
1080 struct max77693_dev *max77693 = dev_get_drvdata(pdev->dev.parent);
1081 struct max77693_platform_data *pdata = dev_get_platdata(max77693->dev);
1082 struct max77693_muic_info *info;
1083 struct max77693_reg_data *init_data;
1090 info = devm_kzalloc(&pdev->dev, sizeof(struct max77693_muic_info),
1095 info->dev = &pdev->dev;
1096 info->max77693 = max77693;
1097 if (info->max77693->regmap_muic) {
1098 dev_dbg(&pdev->dev, "allocate register map\n");
1100 info->max77693->regmap_muic = devm_regmap_init_i2c(
1101 info->max77693->i2c_muic,
1102 &max77693_muic_regmap_config);
1103 if (IS_ERR(info->max77693->regmap_muic)) {
1104 ret = PTR_ERR(info->max77693->regmap_muic);
1105 dev_err(max77693->dev,
1106 "failed to allocate register map: %d\n", ret);
1111 /* Register input device for button of dock device */
1112 info->dock = devm_input_allocate_device(&pdev->dev);
1114 dev_err(&pdev->dev, "%s: failed to allocate input\n", __func__);
1117 info->dock->name = "max77693-muic/dock";
1118 info->dock->phys = "max77693-muic/extcon";
1119 info->dock->dev.parent = &pdev->dev;
1121 __set_bit(EV_REP, info->dock->evbit);
1123 input_set_capability(info->dock, EV_KEY, KEY_VOLUMEUP);
1124 input_set_capability(info->dock, EV_KEY, KEY_VOLUMEDOWN);
1125 input_set_capability(info->dock, EV_KEY, KEY_PLAYPAUSE);
1126 input_set_capability(info->dock, EV_KEY, KEY_PREVIOUSSONG);
1127 input_set_capability(info->dock, EV_KEY, KEY_NEXTSONG);
1129 ret = input_register_device(info->dock);
1131 dev_err(&pdev->dev, "Cannot register input device error(%d)\n",
1136 platform_set_drvdata(pdev, info);
1137 mutex_init(&info->mutex);
1139 INIT_WORK(&info->irq_work, max77693_muic_irq_work);
1141 /* Support irq domain for MAX77693 MUIC device */
1142 for (i = 0; i < ARRAY_SIZE(muic_irqs); i++) {
1143 struct max77693_muic_irq *muic_irq = &muic_irqs[i];
1146 virq = regmap_irq_get_virq(max77693->irq_data_muic,
1150 muic_irq->virq = virq;
1152 ret = devm_request_threaded_irq(&pdev->dev, virq, NULL,
1153 max77693_muic_irq_handler,
1155 muic_irq->name, info);
1158 "failed: irq request (IRQ: %d, error :%d)\n",
1159 muic_irq->irq, ret);
1164 /* Initialize extcon device */
1165 info->edev = devm_extcon_dev_allocate(&pdev->dev,
1166 max77693_extcon_cable);
1167 if (IS_ERR(info->edev)) {
1168 dev_err(&pdev->dev, "failed to allocate memory for extcon\n");
1172 ret = devm_extcon_dev_register(&pdev->dev, info->edev);
1174 dev_err(&pdev->dev, "failed to register extcon device\n");
1178 /* Initialize MUIC register by using platform data or default data */
1179 if (pdata && pdata->muic_data) {
1180 init_data = pdata->muic_data->init_data;
1181 num_init_data = pdata->muic_data->num_init_data;
1183 init_data = default_init_data;
1184 num_init_data = ARRAY_SIZE(default_init_data);
1187 for (i = 0; i < num_init_data; i++) {
1188 regmap_write(info->max77693->regmap_muic,
1193 if (pdata && pdata->muic_data) {
1194 struct max77693_muic_platform_data *muic_pdata
1198 * Default usb/uart path whether UART/USB or AUX_UART/AUX_USB
1199 * h/w path of COMP2/COMN1 on CONTROL1 register.
1201 if (muic_pdata->path_uart)
1202 info->path_uart = muic_pdata->path_uart;
1204 info->path_uart = MAX77693_CONTROL1_SW_UART;
1206 if (muic_pdata->path_usb)
1207 info->path_usb = muic_pdata->path_usb;
1209 info->path_usb = MAX77693_CONTROL1_SW_USB;
1212 * Default delay time for detecting cable state
1213 * after certain time.
1215 if (muic_pdata->detcable_delay_ms)
1217 msecs_to_jiffies(muic_pdata->detcable_delay_ms);
1219 delay_jiffies = msecs_to_jiffies(DELAY_MS_DEFAULT);
1221 info->path_usb = MAX77693_CONTROL1_SW_USB;
1222 info->path_uart = MAX77693_CONTROL1_SW_UART;
1223 delay_jiffies = msecs_to_jiffies(DELAY_MS_DEFAULT);
1226 /* Set initial path for UART */
1227 max77693_muic_set_path(info, info->path_uart, true);
1229 /* Check revision number of MUIC device*/
1230 ret = regmap_read(info->max77693->regmap_muic,
1231 MAX77693_MUIC_REG_ID, &id);
1233 dev_err(&pdev->dev, "failed to read revision number\n");
1236 dev_info(info->dev, "device ID : 0x%x\n", id);
1238 /* Set ADC debounce time */
1239 max77693_muic_set_debounce_time(info, ADC_DEBOUNCE_TIME_25MS);
1242 * Detect accessory after completing the initialization of platform
1244 * - Use delayed workqueue to detect cable state and then
1245 * notify cable state to notifiee/platform through uevent.
1246 * After completing the booting of platform, the extcon provider
1247 * driver should notify cable state to upper layer.
1249 INIT_DELAYED_WORK(&info->wq_detcable, max77693_muic_detect_cable_wq);
1250 queue_delayed_work(system_power_efficient_wq, &info->wq_detcable,
1256 static int max77693_muic_remove(struct platform_device *pdev)
1258 struct max77693_muic_info *info = platform_get_drvdata(pdev);
1260 cancel_work_sync(&info->irq_work);
1261 input_unregister_device(info->dock);
1266 static struct platform_driver max77693_muic_driver = {
1270 .probe = max77693_muic_probe,
1271 .remove = max77693_muic_remove,
1274 module_platform_driver(max77693_muic_driver);
1276 MODULE_DESCRIPTION("Maxim MAX77693 Extcon driver");
1278 MODULE_LICENSE("GPL");
1279 MODULE_ALIAS("platform:extcon-max77693");