2 * extcon-max77693.c - MAX77693 extcon driver to support MAX77693 MUIC
4 * Copyright (C) 2012 Samsung Electrnoics
5 * Chanwoo Choi <cw00.choi@samsung.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
18 #include <linux/kernel.h>
19 #include <linux/module.h>
20 #include <linux/i2c.h>
21 #include <linux/slab.h>
22 #include <linux/input.h>
23 #include <linux/interrupt.h>
24 #include <linux/err.h>
25 #include <linux/platform_device.h>
26 #include <linux/mfd/max77693.h>
27 #include <linux/mfd/max77693-private.h>
28 #include <linux/extcon.h>
29 #include <linux/regmap.h>
30 #include <linux/irqdomain.h>
32 #define DEV_NAME "max77693-muic"
33 #define DELAY_MS_DEFAULT 20000 /* unit: millisecond */
36 * Default value of MAX77693 register to bring up MUIC device.
37 * If user don't set some initial value for MUIC device through platform data,
38 * extcon-max77693 driver use 'default_init_data' to bring up base operation
39 * of MAX77693 MUIC device.
41 static struct max77693_reg_data default_init_data[] = {
43 /* STATUS2 - [3]ChgDetRun */
44 .addr = MAX77693_MUIC_REG_STATUS2,
45 .data = STATUS2_CHGDETRUN_MASK,
47 /* INTMASK1 - Unmask [3]ADC1KM,[0]ADCM */
48 .addr = MAX77693_MUIC_REG_INTMASK1,
49 .data = INTMASK1_ADC1K_MASK
52 /* INTMASK2 - Unmask [0]ChgTypM */
53 .addr = MAX77693_MUIC_REG_INTMASK2,
54 .data = INTMASK2_CHGTYP_MASK,
56 /* INTMASK3 - Mask all of interrupts */
57 .addr = MAX77693_MUIC_REG_INTMASK3,
61 .addr = MAX77693_MUIC_REG_CDETCTRL2,
62 .data = CDETCTRL2_VIDRMEN_MASK
63 | CDETCTRL2_DXOVPEN_MASK,
67 enum max77693_muic_adc_debounce_time {
68 ADC_DEBOUNCE_TIME_5MS = 0,
69 ADC_DEBOUNCE_TIME_10MS,
70 ADC_DEBOUNCE_TIME_25MS,
71 ADC_DEBOUNCE_TIME_38_62MS,
74 struct max77693_muic_info {
76 struct max77693_dev *max77693;
77 struct extcon_dev *edev;
79 int prev_cable_type_gnd;
85 struct work_struct irq_work;
89 * Use delayed workqueue to detect cable state and then
90 * notify cable state to notifiee/platform through uevent.
91 * After completing the booting of platform, the extcon provider
92 * driver should notify cable state to upper layer.
94 struct delayed_work wq_detcable;
96 /* Button of dock device */
97 struct input_dev *dock;
100 * Default usb/uart path whether UART/USB or AUX_UART/AUX_USB
101 * h/w path of COMP2/COMN1 on CONTROL1 register.
107 enum max77693_muic_cable_group {
108 MAX77693_CABLE_GROUP_ADC = 0,
109 MAX77693_CABLE_GROUP_ADC_GND,
110 MAX77693_CABLE_GROUP_CHG,
111 MAX77693_CABLE_GROUP_VBVOLT,
114 enum max77693_muic_charger_type {
115 MAX77693_CHARGER_TYPE_NONE = 0,
116 MAX77693_CHARGER_TYPE_USB,
117 MAX77693_CHARGER_TYPE_DOWNSTREAM_PORT,
118 MAX77693_CHARGER_TYPE_DEDICATED_CHG,
119 MAX77693_CHARGER_TYPE_APPLE_500MA,
120 MAX77693_CHARGER_TYPE_APPLE_1A_2A,
121 MAX77693_CHARGER_TYPE_DEAD_BATTERY = 7,
125 * struct max77693_muic_irq
126 * @irq: the index of irq list of MUIC device.
127 * @name: the name of irq.
128 * @virq: the virtual irq to use irq domain
130 struct max77693_muic_irq {
136 static struct max77693_muic_irq muic_irqs[] = {
137 { MAX77693_MUIC_IRQ_INT1_ADC, "muic-ADC" },
138 { MAX77693_MUIC_IRQ_INT1_ADC_LOW, "muic-ADCLOW" },
139 { MAX77693_MUIC_IRQ_INT1_ADC_ERR, "muic-ADCError" },
140 { MAX77693_MUIC_IRQ_INT1_ADC1K, "muic-ADC1K" },
141 { MAX77693_MUIC_IRQ_INT2_CHGTYP, "muic-CHGTYP" },
142 { MAX77693_MUIC_IRQ_INT2_CHGDETREUN, "muic-CHGDETREUN" },
143 { MAX77693_MUIC_IRQ_INT2_DCDTMR, "muic-DCDTMR" },
144 { MAX77693_MUIC_IRQ_INT2_DXOVP, "muic-DXOVP" },
145 { MAX77693_MUIC_IRQ_INT2_VBVOLT, "muic-VBVOLT" },
146 { MAX77693_MUIC_IRQ_INT2_VIDRM, "muic-VIDRM" },
147 { MAX77693_MUIC_IRQ_INT3_EOC, "muic-EOC" },
148 { MAX77693_MUIC_IRQ_INT3_CGMBC, "muic-CGMBC" },
149 { MAX77693_MUIC_IRQ_INT3_OVP, "muic-OVP" },
150 { MAX77693_MUIC_IRQ_INT3_MBCCHG_ERR, "muic-MBCCHG_ERR" },
151 { MAX77693_MUIC_IRQ_INT3_CHG_ENABLED, "muic-CHG_ENABLED" },
152 { MAX77693_MUIC_IRQ_INT3_BAT_DET, "muic-BAT_DET" },
155 /* Define supported accessory type */
156 enum max77693_muic_acc_type {
157 MAX77693_MUIC_ADC_GROUND = 0x0,
158 MAX77693_MUIC_ADC_SEND_END_BUTTON,
159 MAX77693_MUIC_ADC_REMOTE_S1_BUTTON,
160 MAX77693_MUIC_ADC_REMOTE_S2_BUTTON,
161 MAX77693_MUIC_ADC_REMOTE_S3_BUTTON,
162 MAX77693_MUIC_ADC_REMOTE_S4_BUTTON,
163 MAX77693_MUIC_ADC_REMOTE_S5_BUTTON,
164 MAX77693_MUIC_ADC_REMOTE_S6_BUTTON,
165 MAX77693_MUIC_ADC_REMOTE_S7_BUTTON,
166 MAX77693_MUIC_ADC_REMOTE_S8_BUTTON,
167 MAX77693_MUIC_ADC_REMOTE_S9_BUTTON,
168 MAX77693_MUIC_ADC_REMOTE_S10_BUTTON,
169 MAX77693_MUIC_ADC_REMOTE_S11_BUTTON,
170 MAX77693_MUIC_ADC_REMOTE_S12_BUTTON,
171 MAX77693_MUIC_ADC_RESERVED_ACC_1,
172 MAX77693_MUIC_ADC_RESERVED_ACC_2,
173 MAX77693_MUIC_ADC_RESERVED_ACC_3,
174 MAX77693_MUIC_ADC_RESERVED_ACC_4,
175 MAX77693_MUIC_ADC_RESERVED_ACC_5,
176 MAX77693_MUIC_ADC_CEA936_AUDIO,
177 MAX77693_MUIC_ADC_PHONE_POWERED_DEV,
178 MAX77693_MUIC_ADC_TTY_CONVERTER,
179 MAX77693_MUIC_ADC_UART_CABLE,
180 MAX77693_MUIC_ADC_CEA936A_TYPE1_CHG,
181 MAX77693_MUIC_ADC_FACTORY_MODE_USB_OFF,
182 MAX77693_MUIC_ADC_FACTORY_MODE_USB_ON,
183 MAX77693_MUIC_ADC_AV_CABLE_NOLOAD,
184 MAX77693_MUIC_ADC_CEA936A_TYPE2_CHG,
185 MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF,
186 MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON,
187 MAX77693_MUIC_ADC_AUDIO_MODE_REMOTE,
188 MAX77693_MUIC_ADC_OPEN,
190 /* The below accessories have same ADC value so ADCLow and
191 ADC1K bit is used to separate specific accessory */
192 /* ADC|VBVolot|ADCLow|ADC1K| */
193 MAX77693_MUIC_GND_USB_HOST = 0x100, /* 0x0| 0| 0| 0| */
194 MAX77693_MUIC_GND_USB_HOST_VB = 0x104, /* 0x0| 1| 0| 0| */
195 MAX77693_MUIC_GND_AV_CABLE_LOAD = 0x102,/* 0x0| 0| 1| 0| */
196 MAX77693_MUIC_GND_MHL = 0x103, /* 0x0| 0| 1| 1| */
197 MAX77693_MUIC_GND_MHL_VB = 0x107, /* 0x0| 1| 1| 1| */
201 * MAX77693 MUIC device support below list of accessories(external connector)
204 EXTCON_CABLE_USB = 0,
205 EXTCON_CABLE_USB_HOST,
207 EXTCON_CABLE_FAST_CHARGER,
208 EXTCON_CABLE_SLOW_CHARGER,
209 EXTCON_CABLE_CHARGE_DOWNSTREAM,
217 static const char *max77693_extcon_cable[] = {
218 [EXTCON_CABLE_USB] = "USB",
219 [EXTCON_CABLE_USB_HOST] = "USB-Host",
220 [EXTCON_CABLE_TA] = "TA",
221 [EXTCON_CABLE_FAST_CHARGER] = "Fast-charger",
222 [EXTCON_CABLE_SLOW_CHARGER] = "Slow-charger",
223 [EXTCON_CABLE_CHARGE_DOWNSTREAM] = "Charge-downstream",
224 [EXTCON_CABLE_MHL] = "MHL",
225 [EXTCON_CABLE_JIG] = "JIG",
226 [EXTCON_CABLE_DOCK] = "DOCK",
232 * max77693_muic_set_debounce_time - Set the debounce time of ADC
233 * @info: the instance including private data of max77693 MUIC
234 * @time: the debounce time of ADC
236 static int max77693_muic_set_debounce_time(struct max77693_muic_info *info,
237 enum max77693_muic_adc_debounce_time time)
242 case ADC_DEBOUNCE_TIME_5MS:
243 case ADC_DEBOUNCE_TIME_10MS:
244 case ADC_DEBOUNCE_TIME_25MS:
245 case ADC_DEBOUNCE_TIME_38_62MS:
247 * Don't touch BTLDset, JIGset when you want to change adc
248 * debounce time. If it writes other than 0 to BTLDset, JIGset
249 * muic device will be reset and loose current state.
251 ret = regmap_write(info->max77693->regmap_muic,
252 MAX77693_MUIC_REG_CTRL3,
253 time << CONTROL3_ADCDBSET_SHIFT);
255 dev_err(info->dev, "failed to set ADC debounce time\n");
260 dev_err(info->dev, "invalid ADC debounce time\n");
268 * max77693_muic_set_path - Set hardware line according to attached cable
269 * @info: the instance including private data of max77693 MUIC
270 * @value: the path according to attached cable
271 * @attached: the state of cable (true:attached, false:detached)
273 * The max77693 MUIC device share outside H/W line among a varity of cables
274 * so, this function set internal path of H/W line according to the type of
277 static int max77693_muic_set_path(struct max77693_muic_info *info,
278 u8 val, bool attached)
281 unsigned int ctrl1, ctrl2 = 0;
286 ctrl1 = CONTROL1_SW_OPEN;
288 ret = regmap_update_bits(info->max77693->regmap_muic,
289 MAX77693_MUIC_REG_CTRL1, COMP_SW_MASK, ctrl1);
291 dev_err(info->dev, "failed to update MUIC register\n");
296 ctrl2 |= CONTROL2_CPEN_MASK; /* LowPwr=0, CPEn=1 */
298 ctrl2 |= CONTROL2_LOWPWR_MASK; /* LowPwr=1, CPEn=0 */
300 ret = regmap_update_bits(info->max77693->regmap_muic,
301 MAX77693_MUIC_REG_CTRL2,
302 CONTROL2_LOWPWR_MASK | CONTROL2_CPEN_MASK, ctrl2);
304 dev_err(info->dev, "failed to update MUIC register\n");
309 "CONTROL1 : 0x%02x, CONTROL2 : 0x%02x, state : %s\n",
310 ctrl1, ctrl2, attached ? "attached" : "detached");
316 * max77693_muic_get_cable_type - Return cable type and check cable state
317 * @info: the instance including private data of max77693 MUIC
318 * @group: the path according to attached cable
319 * @attached: store cable state and return
321 * This function check the cable state either attached or detached,
322 * and then divide precise type of cable according to cable group.
323 * - MAX77693_CABLE_GROUP_ADC
324 * - MAX77693_CABLE_GROUP_ADC_GND
325 * - MAX77693_CABLE_GROUP_CHG
326 * - MAX77693_CABLE_GROUP_VBVOLT
328 static int max77693_muic_get_cable_type(struct max77693_muic_info *info,
329 enum max77693_muic_cable_group group, bool *attached)
339 case MAX77693_CABLE_GROUP_ADC:
341 * Read ADC value to check cable type and decide cable state
342 * according to cable type
344 adc = info->status[0] & STATUS1_ADC_MASK;
345 adc >>= STATUS1_ADC_SHIFT;
348 * Check current cable state/cable type and store cable type
349 * (info->prev_cable_type) for handling cable when cable is
352 if (adc == MAX77693_MUIC_ADC_OPEN) {
355 cable_type = info->prev_cable_type;
356 info->prev_cable_type = MAX77693_MUIC_ADC_OPEN;
360 cable_type = info->prev_cable_type = adc;
363 case MAX77693_CABLE_GROUP_ADC_GND:
365 * Read ADC value to check cable type and decide cable state
366 * according to cable type
368 adc = info->status[0] & STATUS1_ADC_MASK;
369 adc >>= STATUS1_ADC_SHIFT;
372 * Check current cable state/cable type and store cable type
373 * (info->prev_cable_type/_gnd) for handling cable when cable
376 if (adc == MAX77693_MUIC_ADC_OPEN) {
379 cable_type = info->prev_cable_type_gnd;
380 info->prev_cable_type_gnd = MAX77693_MUIC_ADC_OPEN;
384 adclow = info->status[0] & STATUS1_ADCLOW_MASK;
385 adclow >>= STATUS1_ADCLOW_SHIFT;
386 adc1k = info->status[0] & STATUS1_ADC1K_MASK;
387 adc1k >>= STATUS1_ADC1K_SHIFT;
389 vbvolt = info->status[1] & STATUS2_VBVOLT_MASK;
390 vbvolt >>= STATUS2_VBVOLT_SHIFT;
393 * [0x1|VBVolt|ADCLow|ADC1K]
394 * [0x1| 0| 0| 0] USB_HOST
395 * [0x1| 1| 0| 0] USB_HSOT_VB
396 * [0x1| 0| 1| 0] Audio Video cable with load
397 * [0x1| 0| 1| 1] MHL without charging cable
398 * [0x1| 1| 1| 1] MHL with charging cable
400 cable_type = ((0x1 << 8)
405 info->prev_cable_type = adc;
406 info->prev_cable_type_gnd = cable_type;
410 case MAX77693_CABLE_GROUP_CHG:
412 * Read charger type to check cable type and decide cable state
413 * according to type of charger cable.
415 chg_type = info->status[1] & STATUS2_CHGTYP_MASK;
416 chg_type >>= STATUS2_CHGTYP_SHIFT;
418 if (chg_type == MAX77693_CHARGER_TYPE_NONE) {
421 cable_type = info->prev_chg_type;
422 info->prev_chg_type = MAX77693_CHARGER_TYPE_NONE;
427 * Check current cable state/cable type and store cable
428 * type(info->prev_chg_type) for handling cable when
429 * charger cable is detached.
431 cable_type = info->prev_chg_type = chg_type;
435 case MAX77693_CABLE_GROUP_VBVOLT:
437 * Read ADC value to check cable type and decide cable state
438 * according to cable type
440 adc = info->status[0] & STATUS1_ADC_MASK;
441 adc >>= STATUS1_ADC_SHIFT;
442 chg_type = info->status[1] & STATUS2_CHGTYP_MASK;
443 chg_type >>= STATUS2_CHGTYP_SHIFT;
445 if (adc == MAX77693_MUIC_ADC_OPEN
446 && chg_type == MAX77693_CHARGER_TYPE_NONE)
452 * Read vbvolt field, if vbvolt is 1,
453 * this cable is used for charging.
455 vbvolt = info->status[1] & STATUS2_VBVOLT_MASK;
456 vbvolt >>= STATUS2_VBVOLT_SHIFT;
461 dev_err(info->dev, "Unknown cable group (%d)\n", group);
462 cable_type = -EINVAL;
469 static int max77693_muic_dock_handler(struct max77693_muic_info *info,
470 int cable_type, bool attached)
475 char dock_name[CABLE_NAME_MAX];
478 "external connector is %s (adc:0x%02x)\n",
479 attached ? "attached" : "detached", cable_type);
481 switch (cable_type) {
482 case MAX77693_MUIC_ADC_RESERVED_ACC_3: /* Dock-Smart */
484 * Check power cable whether attached or detached state.
485 * The Dock-Smart device need surely external power supply.
486 * If power cable(USB/TA) isn't connected to Dock device,
487 * user can't use Dock-Smart for desktop mode.
489 vbvolt = max77693_muic_get_cable_type(info,
490 MAX77693_CABLE_GROUP_VBVOLT, &cable_attached);
491 if (attached && !vbvolt) {
493 "Cannot detect external power supply\n");
498 * Notify Dock/MHL state.
499 * - Dock device include three type of cable which
500 * are HDMI, USB for mouse/keyboard and micro-usb port
501 * for USB/TA cable. Dock device need always exteranl
502 * power supply(USB/TA cable through micro-usb cable). Dock
503 * device support screen output of target to separate
504 * monitor and mouse/keyboard for desktop mode.
506 * Features of 'USB/TA cable with Dock device'
508 * - Support external output feature of audio
509 * - Support charging through micro-usb port without data
510 * connection if TA cable is connected to target.
511 * - Support charging and data connection through micro-usb port
512 * if USB cable is connected between target and host
514 * - Support OTG(On-The-Go) device (Ex: Mouse/Keyboard)
516 ret = max77693_muic_set_path(info, info->path_usb, attached);
520 extcon_set_cable_state(info->edev, "DOCK", attached);
521 extcon_set_cable_state(info->edev, "MHL", attached);
523 case MAX77693_MUIC_ADC_AUDIO_MODE_REMOTE: /* Dock-Desk */
524 strcpy(dock_name, "DOCK");
526 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD: /* Dock-Audio */
527 strcpy(dock_name, "DOCK");
529 extcon_set_cable_state(info->edev, "USB", false);
532 dev_err(info->dev, "failed to detect %s dock device\n",
533 attached ? "attached" : "detached");
537 /* Dock-Car/Desk/Audio, PATH:AUDIO */
538 ret = max77693_muic_set_path(info, CONTROL1_SW_AUDIO, attached);
541 extcon_set_cable_state(info->edev, dock_name, attached);
547 static int max77693_muic_dock_button_handler(struct max77693_muic_info *info,
548 int button_type, bool attached)
550 struct input_dev *dock = info->dock;
553 switch (button_type) {
554 case MAX77693_MUIC_ADC_REMOTE_S3_BUTTON-1
555 ... MAX77693_MUIC_ADC_REMOTE_S3_BUTTON+1:
557 code = KEY_PREVIOUSSONG;
559 case MAX77693_MUIC_ADC_REMOTE_S7_BUTTON-1
560 ... MAX77693_MUIC_ADC_REMOTE_S7_BUTTON+1:
564 case MAX77693_MUIC_ADC_REMOTE_S9_BUTTON:
566 code = KEY_VOLUMEDOWN;
568 case MAX77693_MUIC_ADC_REMOTE_S10_BUTTON:
572 case MAX77693_MUIC_ADC_REMOTE_S12_BUTTON-1
573 ... MAX77693_MUIC_ADC_REMOTE_S12_BUTTON+1:
574 /* DOCK_KEY_PLAY_PAUSE */
575 code = KEY_PLAYPAUSE;
579 "failed to detect %s key (adc:0x%x)\n",
580 attached ? "pressed" : "released", button_type);
584 input_event(dock, EV_KEY, code, attached);
590 static int max77693_muic_adc_ground_handler(struct max77693_muic_info *info)
596 cable_type_gnd = max77693_muic_get_cable_type(info,
597 MAX77693_CABLE_GROUP_ADC_GND, &attached);
599 switch (cable_type_gnd) {
600 case MAX77693_MUIC_GND_USB_HOST:
601 case MAX77693_MUIC_GND_USB_HOST_VB:
602 /* USB_HOST, PATH: AP_USB */
603 ret = max77693_muic_set_path(info, CONTROL1_SW_USB, attached);
606 extcon_set_cable_state(info->edev, "USB-Host", attached);
608 case MAX77693_MUIC_GND_AV_CABLE_LOAD:
609 /* Audio Video Cable with load, PATH:AUDIO */
610 ret = max77693_muic_set_path(info, CONTROL1_SW_AUDIO, attached);
613 extcon_set_cable_state(info->edev,
614 "Audio-video-load", attached);
616 case MAX77693_MUIC_GND_MHL:
617 case MAX77693_MUIC_GND_MHL_VB:
618 /* MHL or MHL with USB/TA cable */
619 extcon_set_cable_state(info->edev, "MHL", attached);
622 dev_err(info->dev, "failed to detect %s cable of gnd type\n",
623 attached ? "attached" : "detached");
630 static int max77693_muic_jig_handler(struct max77693_muic_info *info,
631 int cable_type, bool attached)
634 u8 path = CONTROL1_SW_OPEN;
637 "external connector is %s (adc:0x%02x)\n",
638 attached ? "attached" : "detached", cable_type);
640 switch (cable_type) {
641 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_OFF: /* ADC_JIG_USB_OFF */
642 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_ON: /* ADC_JIG_USB_ON */
644 path = CONTROL1_SW_USB;
646 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF: /* ADC_JIG_UART_OFF */
647 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON: /* ADC_JIG_UART_ON */
649 path = CONTROL1_SW_UART;
652 dev_err(info->dev, "failed to detect %s jig cable\n",
653 attached ? "attached" : "detached");
657 ret = max77693_muic_set_path(info, path, attached);
661 extcon_set_cable_state(info->edev, "JIG", attached);
666 static int max77693_muic_adc_handler(struct max77693_muic_info *info)
673 /* Check accessory state which is either detached or attached */
674 cable_type = max77693_muic_get_cable_type(info,
675 MAX77693_CABLE_GROUP_ADC, &attached);
678 "external connector is %s (adc:0x%02x, prev_adc:0x%x)\n",
679 attached ? "attached" : "detached", cable_type,
680 info->prev_cable_type);
682 switch (cable_type) {
683 case MAX77693_MUIC_ADC_GROUND:
684 /* USB_HOST/MHL/Audio */
685 max77693_muic_adc_ground_handler(info);
687 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_OFF:
688 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_ON:
689 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF:
690 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON:
692 ret = max77693_muic_jig_handler(info, cable_type, attached);
696 case MAX77693_MUIC_ADC_RESERVED_ACC_3: /* Dock-Smart */
697 case MAX77693_MUIC_ADC_AUDIO_MODE_REMOTE: /* Dock-Desk */
698 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD: /* Dock-Audio */
702 * The MAX77693 MUIC device can detect total 34 cable type
703 * except of charger cable and MUIC device didn't define
704 * specfic role of cable in the range of from 0x01 to 0x12
705 * of ADC value. So, can use/define cable with no role according
706 * to schema of hardware board.
708 ret = max77693_muic_dock_handler(info, cable_type, attached);
712 case MAX77693_MUIC_ADC_REMOTE_S3_BUTTON: /* DOCK_KEY_PREV */
713 case MAX77693_MUIC_ADC_REMOTE_S7_BUTTON: /* DOCK_KEY_NEXT */
714 case MAX77693_MUIC_ADC_REMOTE_S9_BUTTON: /* DOCK_VOL_DOWN */
715 case MAX77693_MUIC_ADC_REMOTE_S10_BUTTON: /* DOCK_VOL_UP */
716 case MAX77693_MUIC_ADC_REMOTE_S12_BUTTON: /* DOCK_KEY_PLAY_PAUSE */
718 * Button of DOCK device
719 * - the Prev/Next/Volume Up/Volume Down/Play-Pause button
721 * The MAX77693 MUIC device can detect total 34 cable type
722 * except of charger cable and MUIC device didn't define
723 * specfic role of cable in the range of from 0x01 to 0x12
724 * of ADC value. So, can use/define cable with no role according
725 * to schema of hardware board.
728 button_type = info->prev_button_type = cable_type;
730 button_type = info->prev_button_type;
732 ret = max77693_muic_dock_button_handler(info, button_type,
737 case MAX77693_MUIC_ADC_SEND_END_BUTTON:
738 case MAX77693_MUIC_ADC_REMOTE_S1_BUTTON:
739 case MAX77693_MUIC_ADC_REMOTE_S2_BUTTON:
740 case MAX77693_MUIC_ADC_REMOTE_S4_BUTTON:
741 case MAX77693_MUIC_ADC_REMOTE_S5_BUTTON:
742 case MAX77693_MUIC_ADC_REMOTE_S6_BUTTON:
743 case MAX77693_MUIC_ADC_REMOTE_S8_BUTTON:
744 case MAX77693_MUIC_ADC_REMOTE_S11_BUTTON:
745 case MAX77693_MUIC_ADC_RESERVED_ACC_1:
746 case MAX77693_MUIC_ADC_RESERVED_ACC_2:
747 case MAX77693_MUIC_ADC_RESERVED_ACC_4:
748 case MAX77693_MUIC_ADC_RESERVED_ACC_5:
749 case MAX77693_MUIC_ADC_CEA936_AUDIO:
750 case MAX77693_MUIC_ADC_PHONE_POWERED_DEV:
751 case MAX77693_MUIC_ADC_TTY_CONVERTER:
752 case MAX77693_MUIC_ADC_UART_CABLE:
753 case MAX77693_MUIC_ADC_CEA936A_TYPE1_CHG:
754 case MAX77693_MUIC_ADC_CEA936A_TYPE2_CHG:
756 * This accessory isn't used in general case if it is specially
757 * needed to detect additional accessory, should implement
758 * proper operation when this accessory is attached/detached.
761 "accessory is %s but it isn't used (adc:0x%x)\n",
762 attached ? "attached" : "detached", cable_type);
766 "failed to detect %s accessory (adc:0x%x)\n",
767 attached ? "attached" : "detached", cable_type);
774 static int max77693_muic_chg_handler(struct max77693_muic_info *info)
783 chg_type = max77693_muic_get_cable_type(info,
784 MAX77693_CABLE_GROUP_CHG, &attached);
787 "external connector is %s(chg_type:0x%x, prev_chg_type:0x%x)\n",
788 attached ? "attached" : "detached",
789 chg_type, info->prev_chg_type);
792 case MAX77693_CHARGER_TYPE_USB:
793 case MAX77693_CHARGER_TYPE_DEDICATED_CHG:
794 case MAX77693_CHARGER_TYPE_NONE:
795 /* Check MAX77693_CABLE_GROUP_ADC_GND type */
796 cable_type_gnd = max77693_muic_get_cable_type(info,
797 MAX77693_CABLE_GROUP_ADC_GND,
799 switch (cable_type_gnd) {
800 case MAX77693_MUIC_GND_MHL:
801 case MAX77693_MUIC_GND_MHL_VB:
803 * MHL cable with USB/TA cable
804 * - MHL cable include two port(HDMI line and separate
805 * micro-usb port. When the target connect MHL cable,
806 * extcon driver check whether USB/TA cable is
807 * connected. If USB/TA cable is connected, extcon
808 * driver notify state to notifiee for charging battery.
810 * Features of 'USB/TA with MHL cable'
812 * - Support charging through micro-usb port without
815 extcon_set_cable_state(info->edev, "TA", attached);
817 extcon_set_cable_state(info->edev,
818 "MHL", cable_attached);
822 /* Check MAX77693_CABLE_GROUP_ADC type */
823 cable_type = max77693_muic_get_cable_type(info,
824 MAX77693_CABLE_GROUP_ADC,
826 switch (cable_type) {
827 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD: /* Dock-Audio */
829 * Dock-Audio device with USB/TA cable
830 * - Dock device include two port(Dock-Audio and micro-
831 * usb port). When the target connect Dock-Audio device,
832 * extcon driver check whether USB/TA cable is connected
833 * or not. If USB/TA cable is connected, extcon driver
834 * notify state to notifiee for charging battery.
836 * Features of 'USB/TA cable with Dock-Audio device'
837 * - Support external output feature of audio.
838 * - Support charging through micro-usb port without
841 extcon_set_cable_state(info->edev, "USB", attached);
844 extcon_set_cable_state(info->edev, "DOCK",
847 case MAX77693_MUIC_ADC_RESERVED_ACC_3: /* Dock-Smart */
849 * Dock-Smart device with USB/TA cable
850 * - Dock-Desk device include three type of cable which
851 * are HDMI, USB for mouse/keyboard and micro-usb port
852 * for USB/TA cable. Dock-Smart device need always
853 * exteranl power supply(USB/TA cable through micro-usb
854 * cable). Dock-Smart device support screen output of
855 * target to separate monitor and mouse/keyboard for
858 * Features of 'USB/TA cable with Dock-Smart device'
860 * - Support external output feature of audio
861 * - Support charging through micro-usb port without
862 * data connection if TA cable is connected to target.
863 * - Support charging and data connection through micro-
864 * usb port if USB cable is connected between target
866 * - Support OTG(On-The-Go) device (Ex: Mouse/Keyboard)
868 ret = max77693_muic_set_path(info, info->path_usb,
873 extcon_set_cable_state(info->edev, "DOCK", attached);
874 extcon_set_cable_state(info->edev, "MHL", attached);
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, "USB", attached);
910 case MAX77693_CHARGER_TYPE_DEDICATED_CHG:
912 extcon_set_cable_state(info->edev, "TA", attached);
916 case MAX77693_CHARGER_TYPE_DOWNSTREAM_PORT:
917 extcon_set_cable_state(info->edev,
918 "Charge-downstream", attached);
920 case MAX77693_CHARGER_TYPE_APPLE_500MA:
921 extcon_set_cable_state(info->edev, "Slow-charger", attached);
923 case MAX77693_CHARGER_TYPE_APPLE_1A_2A:
924 extcon_set_cable_state(info->edev, "Fast-charger", attached);
926 case MAX77693_CHARGER_TYPE_DEAD_BATTERY:
930 "failed to detect %s accessory (chg_type:0x%x)\n",
931 attached ? "attached" : "detached", chg_type);
938 static void max77693_muic_irq_work(struct work_struct *work)
940 struct max77693_muic_info *info = container_of(work,
941 struct max77693_muic_info, irq_work);
948 mutex_lock(&info->mutex);
950 for (i = 0; i < ARRAY_SIZE(muic_irqs); i++)
951 if (info->irq == muic_irqs[i].virq)
952 irq_type = muic_irqs[i].irq;
954 ret = regmap_bulk_read(info->max77693->regmap_muic,
955 MAX77693_MUIC_REG_STATUS1, info->status, 2);
957 dev_err(info->dev, "failed to read MUIC register\n");
958 mutex_unlock(&info->mutex);
963 case MAX77693_MUIC_IRQ_INT1_ADC:
964 case MAX77693_MUIC_IRQ_INT1_ADC_LOW:
965 case MAX77693_MUIC_IRQ_INT1_ADC_ERR:
966 case MAX77693_MUIC_IRQ_INT1_ADC1K:
967 /* Handle all of accessory except for
968 type of charger accessory */
969 ret = max77693_muic_adc_handler(info);
971 case MAX77693_MUIC_IRQ_INT2_CHGTYP:
972 case MAX77693_MUIC_IRQ_INT2_CHGDETREUN:
973 case MAX77693_MUIC_IRQ_INT2_DCDTMR:
974 case MAX77693_MUIC_IRQ_INT2_DXOVP:
975 case MAX77693_MUIC_IRQ_INT2_VBVOLT:
976 case MAX77693_MUIC_IRQ_INT2_VIDRM:
977 /* Handle charger accessory */
978 ret = max77693_muic_chg_handler(info);
980 case MAX77693_MUIC_IRQ_INT3_EOC:
981 case MAX77693_MUIC_IRQ_INT3_CGMBC:
982 case MAX77693_MUIC_IRQ_INT3_OVP:
983 case MAX77693_MUIC_IRQ_INT3_MBCCHG_ERR:
984 case MAX77693_MUIC_IRQ_INT3_CHG_ENABLED:
985 case MAX77693_MUIC_IRQ_INT3_BAT_DET:
988 dev_err(info->dev, "muic interrupt: irq %d occurred\n",
990 mutex_unlock(&info->mutex);
995 dev_err(info->dev, "failed to handle MUIC interrupt\n");
997 mutex_unlock(&info->mutex);
1000 static irqreturn_t max77693_muic_irq_handler(int irq, void *data)
1002 struct max77693_muic_info *info = data;
1005 schedule_work(&info->irq_work);
1010 static const struct regmap_config max77693_muic_regmap_config = {
1015 static int max77693_muic_detect_accessory(struct max77693_muic_info *info)
1022 mutex_lock(&info->mutex);
1024 /* Read STATUSx register to detect accessory */
1025 ret = regmap_bulk_read(info->max77693->regmap_muic,
1026 MAX77693_MUIC_REG_STATUS1, info->status, 2);
1028 dev_err(info->dev, "failed to read MUIC register\n");
1029 mutex_unlock(&info->mutex);
1033 adc = max77693_muic_get_cable_type(info, MAX77693_CABLE_GROUP_ADC,
1035 if (attached && adc != MAX77693_MUIC_ADC_OPEN) {
1036 ret = max77693_muic_adc_handler(info);
1038 dev_err(info->dev, "Cannot detect accessory\n");
1039 mutex_unlock(&info->mutex);
1044 chg_type = max77693_muic_get_cable_type(info, MAX77693_CABLE_GROUP_CHG,
1046 if (attached && chg_type != MAX77693_CHARGER_TYPE_NONE) {
1047 ret = max77693_muic_chg_handler(info);
1049 dev_err(info->dev, "Cannot detect charger accessory\n");
1050 mutex_unlock(&info->mutex);
1055 mutex_unlock(&info->mutex);
1060 static void max77693_muic_detect_cable_wq(struct work_struct *work)
1062 struct max77693_muic_info *info = container_of(to_delayed_work(work),
1063 struct max77693_muic_info, wq_detcable);
1065 max77693_muic_detect_accessory(info);
1068 static int max77693_muic_probe(struct platform_device *pdev)
1070 struct max77693_dev *max77693 = dev_get_drvdata(pdev->dev.parent);
1071 struct max77693_platform_data *pdata = dev_get_platdata(max77693->dev);
1072 struct max77693_muic_info *info;
1073 struct max77693_reg_data *init_data;
1080 info = devm_kzalloc(&pdev->dev, sizeof(struct max77693_muic_info),
1085 info->dev = &pdev->dev;
1086 info->max77693 = max77693;
1087 if (info->max77693->regmap_muic) {
1088 dev_dbg(&pdev->dev, "allocate register map\n");
1090 info->max77693->regmap_muic = devm_regmap_init_i2c(
1091 info->max77693->muic,
1092 &max77693_muic_regmap_config);
1093 if (IS_ERR(info->max77693->regmap_muic)) {
1094 ret = PTR_ERR(info->max77693->regmap_muic);
1095 dev_err(max77693->dev,
1096 "failed to allocate register map: %d\n", ret);
1101 /* Register input device for button of dock device */
1102 info->dock = devm_input_allocate_device(&pdev->dev);
1104 dev_err(&pdev->dev, "%s: failed to allocate input\n", __func__);
1107 info->dock->name = "max77693-muic/dock";
1108 info->dock->phys = "max77693-muic/extcon";
1109 info->dock->dev.parent = &pdev->dev;
1111 __set_bit(EV_REP, info->dock->evbit);
1113 input_set_capability(info->dock, EV_KEY, KEY_VOLUMEUP);
1114 input_set_capability(info->dock, EV_KEY, KEY_VOLUMEDOWN);
1115 input_set_capability(info->dock, EV_KEY, KEY_PLAYPAUSE);
1116 input_set_capability(info->dock, EV_KEY, KEY_PREVIOUSSONG);
1117 input_set_capability(info->dock, EV_KEY, KEY_NEXTSONG);
1119 ret = input_register_device(info->dock);
1121 dev_err(&pdev->dev, "Cannot register input device error(%d)\n",
1126 platform_set_drvdata(pdev, info);
1127 mutex_init(&info->mutex);
1129 INIT_WORK(&info->irq_work, max77693_muic_irq_work);
1131 /* Support irq domain for MAX77693 MUIC device */
1132 for (i = 0; i < ARRAY_SIZE(muic_irqs); i++) {
1133 struct max77693_muic_irq *muic_irq = &muic_irqs[i];
1134 unsigned int virq = 0;
1136 virq = regmap_irq_get_virq(max77693->irq_data_muic,
1140 muic_irq->virq = virq;
1142 ret = devm_request_threaded_irq(&pdev->dev, virq, NULL,
1143 max77693_muic_irq_handler,
1145 muic_irq->name, info);
1148 "failed: irq request (IRQ: %d, error :%d)\n",
1149 muic_irq->irq, ret);
1154 /* Initialize extcon device */
1155 info->edev = devm_extcon_dev_allocate(&pdev->dev,
1156 max77693_extcon_cable);
1157 if (IS_ERR(info->edev)) {
1158 dev_err(&pdev->dev, "failed to allocate memory for extcon\n");
1161 info->edev->name = DEV_NAME;
1163 ret = devm_extcon_dev_register(&pdev->dev, info->edev);
1165 dev_err(&pdev->dev, "failed to register extcon device\n");
1169 /* Initialize MUIC register by using platform data or default data */
1170 if (pdata && pdata->muic_data) {
1171 init_data = pdata->muic_data->init_data;
1172 num_init_data = pdata->muic_data->num_init_data;
1174 init_data = default_init_data;
1175 num_init_data = ARRAY_SIZE(default_init_data);
1178 for (i = 0; i < num_init_data; i++) {
1179 enum max77693_irq_source irq_src
1180 = MAX77693_IRQ_GROUP_NR;
1182 regmap_write(info->max77693->regmap_muic,
1186 switch (init_data[i].addr) {
1187 case MAX77693_MUIC_REG_INTMASK1:
1188 irq_src = MUIC_INT1;
1190 case MAX77693_MUIC_REG_INTMASK2:
1191 irq_src = MUIC_INT2;
1193 case MAX77693_MUIC_REG_INTMASK3:
1194 irq_src = MUIC_INT3;
1198 if (irq_src < MAX77693_IRQ_GROUP_NR)
1199 info->max77693->irq_masks_cur[irq_src]
1200 = init_data[i].data;
1203 if (pdata && pdata->muic_data) {
1204 struct max77693_muic_platform_data *muic_pdata
1208 * Default usb/uart path whether UART/USB or AUX_UART/AUX_USB
1209 * h/w path of COMP2/COMN1 on CONTROL1 register.
1211 if (muic_pdata->path_uart)
1212 info->path_uart = muic_pdata->path_uart;
1214 info->path_uart = CONTROL1_SW_UART;
1216 if (muic_pdata->path_usb)
1217 info->path_usb = muic_pdata->path_usb;
1219 info->path_usb = CONTROL1_SW_USB;
1222 * Default delay time for detecting cable state
1223 * after certain time.
1225 if (muic_pdata->detcable_delay_ms)
1227 msecs_to_jiffies(muic_pdata->detcable_delay_ms);
1229 delay_jiffies = msecs_to_jiffies(DELAY_MS_DEFAULT);
1231 info->path_usb = CONTROL1_SW_USB;
1232 info->path_uart = CONTROL1_SW_UART;
1233 delay_jiffies = msecs_to_jiffies(DELAY_MS_DEFAULT);
1236 /* Set initial path for UART */
1237 max77693_muic_set_path(info, info->path_uart, true);
1239 /* Check revision number of MUIC device*/
1240 ret = regmap_read(info->max77693->regmap_muic,
1241 MAX77693_MUIC_REG_ID, &id);
1243 dev_err(&pdev->dev, "failed to read revision number\n");
1246 dev_info(info->dev, "device ID : 0x%x\n", id);
1248 /* Set ADC debounce time */
1249 max77693_muic_set_debounce_time(info, ADC_DEBOUNCE_TIME_25MS);
1252 * Detect accessory after completing the initialization of platform
1254 * - Use delayed workqueue to detect cable state and then
1255 * notify cable state to notifiee/platform through uevent.
1256 * After completing the booting of platform, the extcon provider
1257 * driver should notify cable state to upper layer.
1259 INIT_DELAYED_WORK(&info->wq_detcable, max77693_muic_detect_cable_wq);
1260 queue_delayed_work(system_power_efficient_wq, &info->wq_detcable,
1266 static int max77693_muic_remove(struct platform_device *pdev)
1268 struct max77693_muic_info *info = platform_get_drvdata(pdev);
1270 cancel_work_sync(&info->irq_work);
1271 input_unregister_device(info->dock);
1276 static struct platform_driver max77693_muic_driver = {
1280 .probe = max77693_muic_probe,
1281 .remove = max77693_muic_remove,
1284 module_platform_driver(max77693_muic_driver);
1286 MODULE_DESCRIPTION("Maxim MAX77693 Extcon driver");
1287 MODULE_AUTHOR("Chanwoo Choi <cw00.choi@samsung.com>");
1288 MODULE_LICENSE("GPL");
1289 MODULE_ALIAS("platform:extcon-max77693");