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)
203 static const unsigned int max77693_extcon_cable[] = {
209 EXTCON_CHARGE_DOWNSTREAM,
217 * max77693_muic_set_debounce_time - Set the debounce time of ADC
218 * @info: the instance including private data of max77693 MUIC
219 * @time: the debounce time of ADC
221 static int max77693_muic_set_debounce_time(struct max77693_muic_info *info,
222 enum max77693_muic_adc_debounce_time time)
227 case ADC_DEBOUNCE_TIME_5MS:
228 case ADC_DEBOUNCE_TIME_10MS:
229 case ADC_DEBOUNCE_TIME_25MS:
230 case ADC_DEBOUNCE_TIME_38_62MS:
232 * Don't touch BTLDset, JIGset when you want to change adc
233 * debounce time. If it writes other than 0 to BTLDset, JIGset
234 * muic device will be reset and loose current state.
236 ret = regmap_write(info->max77693->regmap_muic,
237 MAX77693_MUIC_REG_CTRL3,
238 time << CONTROL3_ADCDBSET_SHIFT);
240 dev_err(info->dev, "failed to set ADC debounce time\n");
245 dev_err(info->dev, "invalid ADC debounce time\n");
253 * max77693_muic_set_path - Set hardware line according to attached cable
254 * @info: the instance including private data of max77693 MUIC
255 * @value: the path according to attached cable
256 * @attached: the state of cable (true:attached, false:detached)
258 * The max77693 MUIC device share outside H/W line among a varity of cables
259 * so, this function set internal path of H/W line according to the type of
262 static int max77693_muic_set_path(struct max77693_muic_info *info,
263 u8 val, bool attached)
266 unsigned int ctrl1, ctrl2 = 0;
271 ctrl1 = CONTROL1_SW_OPEN;
273 ret = regmap_update_bits(info->max77693->regmap_muic,
274 MAX77693_MUIC_REG_CTRL1, COMP_SW_MASK, ctrl1);
276 dev_err(info->dev, "failed to update MUIC register\n");
281 ctrl2 |= CONTROL2_CPEN_MASK; /* LowPwr=0, CPEn=1 */
283 ctrl2 |= CONTROL2_LOWPWR_MASK; /* LowPwr=1, CPEn=0 */
285 ret = regmap_update_bits(info->max77693->regmap_muic,
286 MAX77693_MUIC_REG_CTRL2,
287 CONTROL2_LOWPWR_MASK | CONTROL2_CPEN_MASK, ctrl2);
289 dev_err(info->dev, "failed to update MUIC register\n");
294 "CONTROL1 : 0x%02x, CONTROL2 : 0x%02x, state : %s\n",
295 ctrl1, ctrl2, attached ? "attached" : "detached");
301 * max77693_muic_get_cable_type - Return cable type and check cable state
302 * @info: the instance including private data of max77693 MUIC
303 * @group: the path according to attached cable
304 * @attached: store cable state and return
306 * This function check the cable state either attached or detached,
307 * and then divide precise type of cable according to cable group.
308 * - MAX77693_CABLE_GROUP_ADC
309 * - MAX77693_CABLE_GROUP_ADC_GND
310 * - MAX77693_CABLE_GROUP_CHG
311 * - MAX77693_CABLE_GROUP_VBVOLT
313 static int max77693_muic_get_cable_type(struct max77693_muic_info *info,
314 enum max77693_muic_cable_group group, bool *attached)
324 case MAX77693_CABLE_GROUP_ADC:
326 * Read ADC value to check cable type and decide cable state
327 * according to cable type
329 adc = info->status[0] & STATUS1_ADC_MASK;
330 adc >>= STATUS1_ADC_SHIFT;
333 * Check current cable state/cable type and store cable type
334 * (info->prev_cable_type) for handling cable when cable is
337 if (adc == MAX77693_MUIC_ADC_OPEN) {
340 cable_type = info->prev_cable_type;
341 info->prev_cable_type = MAX77693_MUIC_ADC_OPEN;
345 cable_type = info->prev_cable_type = adc;
348 case MAX77693_CABLE_GROUP_ADC_GND:
350 * Read ADC value to check cable type and decide cable state
351 * according to cable type
353 adc = info->status[0] & STATUS1_ADC_MASK;
354 adc >>= STATUS1_ADC_SHIFT;
357 * Check current cable state/cable type and store cable type
358 * (info->prev_cable_type/_gnd) for handling cable when cable
361 if (adc == MAX77693_MUIC_ADC_OPEN) {
364 cable_type = info->prev_cable_type_gnd;
365 info->prev_cable_type_gnd = MAX77693_MUIC_ADC_OPEN;
369 adclow = info->status[0] & STATUS1_ADCLOW_MASK;
370 adclow >>= STATUS1_ADCLOW_SHIFT;
371 adc1k = info->status[0] & STATUS1_ADC1K_MASK;
372 adc1k >>= STATUS1_ADC1K_SHIFT;
374 vbvolt = info->status[1] & STATUS2_VBVOLT_MASK;
375 vbvolt >>= STATUS2_VBVOLT_SHIFT;
378 * [0x1|VBVolt|ADCLow|ADC1K]
379 * [0x1| 0| 0| 0] USB_HOST
380 * [0x1| 1| 0| 0] USB_HSOT_VB
381 * [0x1| 0| 1| 0] Audio Video cable with load
382 * [0x1| 0| 1| 1] MHL without charging cable
383 * [0x1| 1| 1| 1] MHL with charging cable
385 cable_type = ((0x1 << 8)
390 info->prev_cable_type = adc;
391 info->prev_cable_type_gnd = cable_type;
395 case MAX77693_CABLE_GROUP_CHG:
397 * Read charger type to check cable type and decide cable state
398 * according to type of charger cable.
400 chg_type = info->status[1] & STATUS2_CHGTYP_MASK;
401 chg_type >>= STATUS2_CHGTYP_SHIFT;
403 if (chg_type == MAX77693_CHARGER_TYPE_NONE) {
406 cable_type = info->prev_chg_type;
407 info->prev_chg_type = MAX77693_CHARGER_TYPE_NONE;
412 * Check current cable state/cable type and store cable
413 * type(info->prev_chg_type) for handling cable when
414 * charger cable is detached.
416 cable_type = info->prev_chg_type = chg_type;
420 case MAX77693_CABLE_GROUP_VBVOLT:
422 * Read ADC value to check cable type and decide cable state
423 * according to cable type
425 adc = info->status[0] & STATUS1_ADC_MASK;
426 adc >>= STATUS1_ADC_SHIFT;
427 chg_type = info->status[1] & STATUS2_CHGTYP_MASK;
428 chg_type >>= STATUS2_CHGTYP_SHIFT;
430 if (adc == MAX77693_MUIC_ADC_OPEN
431 && chg_type == MAX77693_CHARGER_TYPE_NONE)
437 * Read vbvolt field, if vbvolt is 1,
438 * this cable is used for charging.
440 vbvolt = info->status[1] & STATUS2_VBVOLT_MASK;
441 vbvolt >>= STATUS2_VBVOLT_SHIFT;
446 dev_err(info->dev, "Unknown cable group (%d)\n", group);
447 cable_type = -EINVAL;
454 static int max77693_muic_dock_handler(struct max77693_muic_info *info,
455 int cable_type, bool attached)
460 unsigned int dock_id;
463 "external connector is %s (adc:0x%02x)\n",
464 attached ? "attached" : "detached", cable_type);
466 switch (cable_type) {
467 case MAX77693_MUIC_ADC_RESERVED_ACC_3: /* Dock-Smart */
469 * Check power cable whether attached or detached state.
470 * The Dock-Smart device need surely external power supply.
471 * If power cable(USB/TA) isn't connected to Dock device,
472 * user can't use Dock-Smart for desktop mode.
474 vbvolt = max77693_muic_get_cable_type(info,
475 MAX77693_CABLE_GROUP_VBVOLT, &cable_attached);
476 if (attached && !vbvolt) {
478 "Cannot detect external power supply\n");
483 * Notify Dock/MHL state.
484 * - Dock device include three type of cable which
485 * are HDMI, USB for mouse/keyboard and micro-usb port
486 * for USB/TA cable. Dock device need always exteranl
487 * power supply(USB/TA cable through micro-usb cable). Dock
488 * device support screen output of target to separate
489 * monitor and mouse/keyboard for desktop mode.
491 * Features of 'USB/TA cable with Dock device'
493 * - Support external output feature of audio
494 * - Support charging through micro-usb port without data
495 * connection if TA cable is connected to target.
496 * - Support charging and data connection through micro-usb port
497 * if USB cable is connected between target and host
499 * - Support OTG(On-The-Go) device (Ex: Mouse/Keyboard)
501 ret = max77693_muic_set_path(info, info->path_usb, attached);
505 extcon_set_cable_state_(info->edev, EXTCON_DOCK, attached);
506 extcon_set_cable_state_(info->edev, EXTCON_MHL, attached);
508 case MAX77693_MUIC_ADC_AUDIO_MODE_REMOTE: /* Dock-Desk */
509 dock_id = EXTCON_DOCK;
511 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD: /* Dock-Audio */
512 dock_id = EXTCON_DOCK;
514 extcon_set_cable_state_(info->edev, EXTCON_USB, false);
517 dev_err(info->dev, "failed to detect %s dock device\n",
518 attached ? "attached" : "detached");
522 /* Dock-Car/Desk/Audio, PATH:AUDIO */
523 ret = max77693_muic_set_path(info, CONTROL1_SW_AUDIO, attached);
526 extcon_set_cable_state_(info->edev, dock_id, attached);
532 static int max77693_muic_dock_button_handler(struct max77693_muic_info *info,
533 int button_type, bool attached)
535 struct input_dev *dock = info->dock;
538 switch (button_type) {
539 case MAX77693_MUIC_ADC_REMOTE_S3_BUTTON-1
540 ... MAX77693_MUIC_ADC_REMOTE_S3_BUTTON+1:
542 code = KEY_PREVIOUSSONG;
544 case MAX77693_MUIC_ADC_REMOTE_S7_BUTTON-1
545 ... MAX77693_MUIC_ADC_REMOTE_S7_BUTTON+1:
549 case MAX77693_MUIC_ADC_REMOTE_S9_BUTTON:
551 code = KEY_VOLUMEDOWN;
553 case MAX77693_MUIC_ADC_REMOTE_S10_BUTTON:
557 case MAX77693_MUIC_ADC_REMOTE_S12_BUTTON-1
558 ... MAX77693_MUIC_ADC_REMOTE_S12_BUTTON+1:
559 /* DOCK_KEY_PLAY_PAUSE */
560 code = KEY_PLAYPAUSE;
564 "failed to detect %s key (adc:0x%x)\n",
565 attached ? "pressed" : "released", button_type);
569 input_event(dock, EV_KEY, code, attached);
575 static int max77693_muic_adc_ground_handler(struct max77693_muic_info *info)
581 cable_type_gnd = max77693_muic_get_cable_type(info,
582 MAX77693_CABLE_GROUP_ADC_GND, &attached);
584 switch (cable_type_gnd) {
585 case MAX77693_MUIC_GND_USB_HOST:
586 case MAX77693_MUIC_GND_USB_HOST_VB:
587 /* USB_HOST, PATH: AP_USB */
588 ret = max77693_muic_set_path(info, CONTROL1_SW_USB, attached);
591 extcon_set_cable_state_(info->edev, EXTCON_USB_HOST, attached);
593 case MAX77693_MUIC_GND_AV_CABLE_LOAD:
594 /* Audio Video Cable with load, PATH:AUDIO */
595 ret = max77693_muic_set_path(info, CONTROL1_SW_AUDIO, attached);
598 extcon_set_cable_state_(info->edev, EXTCON_USB, attached);
600 case MAX77693_MUIC_GND_MHL:
601 case MAX77693_MUIC_GND_MHL_VB:
602 /* MHL or MHL with USB/TA cable */
603 extcon_set_cable_state_(info->edev, EXTCON_MHL, attached);
606 dev_err(info->dev, "failed to detect %s cable of gnd type\n",
607 attached ? "attached" : "detached");
614 static int max77693_muic_jig_handler(struct max77693_muic_info *info,
615 int cable_type, bool attached)
618 u8 path = CONTROL1_SW_OPEN;
621 "external connector is %s (adc:0x%02x)\n",
622 attached ? "attached" : "detached", cable_type);
624 switch (cable_type) {
625 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_OFF: /* ADC_JIG_USB_OFF */
626 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_ON: /* ADC_JIG_USB_ON */
628 path = CONTROL1_SW_USB;
630 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF: /* ADC_JIG_UART_OFF */
631 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON: /* ADC_JIG_UART_ON */
633 path = CONTROL1_SW_UART;
636 dev_err(info->dev, "failed to detect %s jig cable\n",
637 attached ? "attached" : "detached");
641 ret = max77693_muic_set_path(info, path, attached);
645 extcon_set_cable_state_(info->edev, EXTCON_JIG, attached);
650 static int max77693_muic_adc_handler(struct max77693_muic_info *info)
657 /* Check accessory state which is either detached or attached */
658 cable_type = max77693_muic_get_cable_type(info,
659 MAX77693_CABLE_GROUP_ADC, &attached);
662 "external connector is %s (adc:0x%02x, prev_adc:0x%x)\n",
663 attached ? "attached" : "detached", cable_type,
664 info->prev_cable_type);
666 switch (cable_type) {
667 case MAX77693_MUIC_ADC_GROUND:
668 /* USB_HOST/MHL/Audio */
669 max77693_muic_adc_ground_handler(info);
671 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_OFF:
672 case MAX77693_MUIC_ADC_FACTORY_MODE_USB_ON:
673 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_OFF:
674 case MAX77693_MUIC_ADC_FACTORY_MODE_UART_ON:
676 ret = max77693_muic_jig_handler(info, cable_type, attached);
680 case MAX77693_MUIC_ADC_RESERVED_ACC_3: /* Dock-Smart */
681 case MAX77693_MUIC_ADC_AUDIO_MODE_REMOTE: /* Dock-Desk */
682 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD: /* Dock-Audio */
686 * The MAX77693 MUIC device can detect total 34 cable type
687 * except of charger cable and MUIC device didn't define
688 * specfic role of cable in the range of from 0x01 to 0x12
689 * of ADC value. So, can use/define cable with no role according
690 * to schema of hardware board.
692 ret = max77693_muic_dock_handler(info, cable_type, attached);
696 case MAX77693_MUIC_ADC_REMOTE_S3_BUTTON: /* DOCK_KEY_PREV */
697 case MAX77693_MUIC_ADC_REMOTE_S7_BUTTON: /* DOCK_KEY_NEXT */
698 case MAX77693_MUIC_ADC_REMOTE_S9_BUTTON: /* DOCK_VOL_DOWN */
699 case MAX77693_MUIC_ADC_REMOTE_S10_BUTTON: /* DOCK_VOL_UP */
700 case MAX77693_MUIC_ADC_REMOTE_S12_BUTTON: /* DOCK_KEY_PLAY_PAUSE */
702 * Button of DOCK device
703 * - the Prev/Next/Volume Up/Volume Down/Play-Pause button
705 * The MAX77693 MUIC device can detect total 34 cable type
706 * except of charger cable and MUIC device didn't define
707 * specfic role of cable in the range of from 0x01 to 0x12
708 * of ADC value. So, can use/define cable with no role according
709 * to schema of hardware board.
712 button_type = info->prev_button_type = cable_type;
714 button_type = info->prev_button_type;
716 ret = max77693_muic_dock_button_handler(info, button_type,
721 case MAX77693_MUIC_ADC_SEND_END_BUTTON:
722 case MAX77693_MUIC_ADC_REMOTE_S1_BUTTON:
723 case MAX77693_MUIC_ADC_REMOTE_S2_BUTTON:
724 case MAX77693_MUIC_ADC_REMOTE_S4_BUTTON:
725 case MAX77693_MUIC_ADC_REMOTE_S5_BUTTON:
726 case MAX77693_MUIC_ADC_REMOTE_S6_BUTTON:
727 case MAX77693_MUIC_ADC_REMOTE_S8_BUTTON:
728 case MAX77693_MUIC_ADC_REMOTE_S11_BUTTON:
729 case MAX77693_MUIC_ADC_RESERVED_ACC_1:
730 case MAX77693_MUIC_ADC_RESERVED_ACC_2:
731 case MAX77693_MUIC_ADC_RESERVED_ACC_4:
732 case MAX77693_MUIC_ADC_RESERVED_ACC_5:
733 case MAX77693_MUIC_ADC_CEA936_AUDIO:
734 case MAX77693_MUIC_ADC_PHONE_POWERED_DEV:
735 case MAX77693_MUIC_ADC_TTY_CONVERTER:
736 case MAX77693_MUIC_ADC_UART_CABLE:
737 case MAX77693_MUIC_ADC_CEA936A_TYPE1_CHG:
738 case MAX77693_MUIC_ADC_CEA936A_TYPE2_CHG:
740 * This accessory isn't used in general case if it is specially
741 * needed to detect additional accessory, should implement
742 * proper operation when this accessory is attached/detached.
745 "accessory is %s but it isn't used (adc:0x%x)\n",
746 attached ? "attached" : "detached", cable_type);
750 "failed to detect %s accessory (adc:0x%x)\n",
751 attached ? "attached" : "detached", cable_type);
758 static int max77693_muic_chg_handler(struct max77693_muic_info *info)
767 chg_type = max77693_muic_get_cable_type(info,
768 MAX77693_CABLE_GROUP_CHG, &attached);
771 "external connector is %s(chg_type:0x%x, prev_chg_type:0x%x)\n",
772 attached ? "attached" : "detached",
773 chg_type, info->prev_chg_type);
776 case MAX77693_CHARGER_TYPE_USB:
777 case MAX77693_CHARGER_TYPE_DEDICATED_CHG:
778 case MAX77693_CHARGER_TYPE_NONE:
779 /* Check MAX77693_CABLE_GROUP_ADC_GND type */
780 cable_type_gnd = max77693_muic_get_cable_type(info,
781 MAX77693_CABLE_GROUP_ADC_GND,
783 switch (cable_type_gnd) {
784 case MAX77693_MUIC_GND_MHL:
785 case MAX77693_MUIC_GND_MHL_VB:
787 * MHL cable with USB/TA cable
788 * - MHL cable include two port(HDMI line and separate
789 * micro-usb port. When the target connect MHL cable,
790 * extcon driver check whether USB/TA cable is
791 * connected. If USB/TA cable is connected, extcon
792 * driver notify state to notifiee for charging battery.
794 * Features of 'USB/TA with MHL cable'
796 * - Support charging through micro-usb port without
799 extcon_set_cable_state_(info->edev, EXTCON_TA, attached);
801 extcon_set_cable_state_(info->edev, EXTCON_MHL,
806 /* Check MAX77693_CABLE_GROUP_ADC type */
807 cable_type = max77693_muic_get_cable_type(info,
808 MAX77693_CABLE_GROUP_ADC,
810 switch (cable_type) {
811 case MAX77693_MUIC_ADC_AV_CABLE_NOLOAD: /* Dock-Audio */
813 * Dock-Audio device with USB/TA cable
814 * - Dock device include two port(Dock-Audio and micro-
815 * usb port). When the target connect Dock-Audio device,
816 * extcon driver check whether USB/TA cable is connected
817 * or not. If USB/TA cable is connected, extcon driver
818 * notify state to notifiee for charging battery.
820 * Features of 'USB/TA cable with Dock-Audio device'
821 * - Support external output feature of audio.
822 * - Support charging through micro-usb port without
825 extcon_set_cable_state_(info->edev, EXTCON_USB,
829 extcon_set_cable_state_(info->edev, EXTCON_DOCK,
832 case MAX77693_MUIC_ADC_RESERVED_ACC_3: /* Dock-Smart */
834 * Dock-Smart device with USB/TA cable
835 * - Dock-Desk device include three type of cable which
836 * are HDMI, USB for mouse/keyboard and micro-usb port
837 * for USB/TA cable. Dock-Smart device need always
838 * exteranl power supply(USB/TA cable through micro-usb
839 * cable). Dock-Smart device support screen output of
840 * target to separate monitor and mouse/keyboard for
843 * Features of 'USB/TA cable with Dock-Smart device'
845 * - Support external output feature of audio
846 * - Support charging through micro-usb port without
847 * data connection if TA cable is connected to target.
848 * - Support charging and data connection through micro-
849 * usb port if USB cable is connected between target
851 * - Support OTG(On-The-Go) device (Ex: Mouse/Keyboard)
853 ret = max77693_muic_set_path(info, info->path_usb,
858 extcon_set_cable_state_(info->edev, EXTCON_DOCK,
860 extcon_set_cable_state_(info->edev, EXTCON_MHL,
865 /* Check MAX77693_CABLE_GROUP_CHG type */
867 case MAX77693_CHARGER_TYPE_NONE:
869 * When MHL(with USB/TA cable) or Dock-Audio with USB/TA
870 * cable is attached, muic device happen below two irq.
871 * - 'MAX77693_MUIC_IRQ_INT1_ADC' for detecting
873 * - 'MAX77693_MUIC_IRQ_INT2_CHGTYP' for detecting
874 * USB/TA cable connected to MHL or Dock-Audio.
875 * Always, happen eariler MAX77693_MUIC_IRQ_INT1_ADC
876 * irq than MAX77693_MUIC_IRQ_INT2_CHGTYP irq.
878 * If user attach MHL (with USB/TA cable and immediately
879 * detach MHL with USB/TA cable before MAX77693_MUIC_IRQ
880 * _INT2_CHGTYP irq is happened, USB/TA cable remain
881 * connected state to target. But USB/TA cable isn't
882 * connected to target. The user be face with unusual
883 * action. So, driver should check this situation in
884 * spite of, that previous charger type is N/A.
887 case MAX77693_CHARGER_TYPE_USB:
888 /* Only USB cable, PATH:AP_USB */
889 ret = max77693_muic_set_path(info, info->path_usb,
894 extcon_set_cable_state_(info->edev, EXTCON_USB,
897 case MAX77693_CHARGER_TYPE_DEDICATED_CHG:
899 extcon_set_cable_state_(info->edev, EXTCON_TA, attached);
903 case MAX77693_CHARGER_TYPE_DOWNSTREAM_PORT:
904 extcon_set_cable_state_(info->edev, EXTCON_CHARGE_DOWNSTREAM,
907 case MAX77693_CHARGER_TYPE_APPLE_500MA:
908 extcon_set_cable_state_(info->edev, EXTCON_SLOW_CHARGER,
911 case MAX77693_CHARGER_TYPE_APPLE_1A_2A:
912 extcon_set_cable_state_(info->edev, EXTCON_FAST_CHARGER,
915 case MAX77693_CHARGER_TYPE_DEAD_BATTERY:
919 "failed to detect %s accessory (chg_type:0x%x)\n",
920 attached ? "attached" : "detached", chg_type);
927 static void max77693_muic_irq_work(struct work_struct *work)
929 struct max77693_muic_info *info = container_of(work,
930 struct max77693_muic_info, irq_work);
937 mutex_lock(&info->mutex);
939 for (i = 0; i < ARRAY_SIZE(muic_irqs); i++)
940 if (info->irq == muic_irqs[i].virq)
941 irq_type = muic_irqs[i].irq;
943 ret = regmap_bulk_read(info->max77693->regmap_muic,
944 MAX77693_MUIC_REG_STATUS1, info->status, 2);
946 dev_err(info->dev, "failed to read MUIC register\n");
947 mutex_unlock(&info->mutex);
952 case MAX77693_MUIC_IRQ_INT1_ADC:
953 case MAX77693_MUIC_IRQ_INT1_ADC_LOW:
954 case MAX77693_MUIC_IRQ_INT1_ADC_ERR:
955 case MAX77693_MUIC_IRQ_INT1_ADC1K:
956 /* Handle all of accessory except for
957 type of charger accessory */
958 ret = max77693_muic_adc_handler(info);
960 case MAX77693_MUIC_IRQ_INT2_CHGTYP:
961 case MAX77693_MUIC_IRQ_INT2_CHGDETREUN:
962 case MAX77693_MUIC_IRQ_INT2_DCDTMR:
963 case MAX77693_MUIC_IRQ_INT2_DXOVP:
964 case MAX77693_MUIC_IRQ_INT2_VBVOLT:
965 case MAX77693_MUIC_IRQ_INT2_VIDRM:
966 /* Handle charger accessory */
967 ret = max77693_muic_chg_handler(info);
969 case MAX77693_MUIC_IRQ_INT3_EOC:
970 case MAX77693_MUIC_IRQ_INT3_CGMBC:
971 case MAX77693_MUIC_IRQ_INT3_OVP:
972 case MAX77693_MUIC_IRQ_INT3_MBCCHG_ERR:
973 case MAX77693_MUIC_IRQ_INT3_CHG_ENABLED:
974 case MAX77693_MUIC_IRQ_INT3_BAT_DET:
977 dev_err(info->dev, "muic interrupt: irq %d occurred\n",
979 mutex_unlock(&info->mutex);
984 dev_err(info->dev, "failed to handle MUIC interrupt\n");
986 mutex_unlock(&info->mutex);
989 static irqreturn_t max77693_muic_irq_handler(int irq, void *data)
991 struct max77693_muic_info *info = data;
994 schedule_work(&info->irq_work);
999 static const struct regmap_config max77693_muic_regmap_config = {
1004 static int max77693_muic_detect_accessory(struct max77693_muic_info *info)
1011 mutex_lock(&info->mutex);
1013 /* Read STATUSx register to detect accessory */
1014 ret = regmap_bulk_read(info->max77693->regmap_muic,
1015 MAX77693_MUIC_REG_STATUS1, info->status, 2);
1017 dev_err(info->dev, "failed to read MUIC register\n");
1018 mutex_unlock(&info->mutex);
1022 adc = max77693_muic_get_cable_type(info, MAX77693_CABLE_GROUP_ADC,
1024 if (attached && adc != MAX77693_MUIC_ADC_OPEN) {
1025 ret = max77693_muic_adc_handler(info);
1027 dev_err(info->dev, "Cannot detect accessory\n");
1028 mutex_unlock(&info->mutex);
1033 chg_type = max77693_muic_get_cable_type(info, MAX77693_CABLE_GROUP_CHG,
1035 if (attached && chg_type != MAX77693_CHARGER_TYPE_NONE) {
1036 ret = max77693_muic_chg_handler(info);
1038 dev_err(info->dev, "Cannot detect charger accessory\n");
1039 mutex_unlock(&info->mutex);
1044 mutex_unlock(&info->mutex);
1049 static void max77693_muic_detect_cable_wq(struct work_struct *work)
1051 struct max77693_muic_info *info = container_of(to_delayed_work(work),
1052 struct max77693_muic_info, wq_detcable);
1054 max77693_muic_detect_accessory(info);
1057 static int max77693_muic_probe(struct platform_device *pdev)
1059 struct max77693_dev *max77693 = dev_get_drvdata(pdev->dev.parent);
1060 struct max77693_platform_data *pdata = dev_get_platdata(max77693->dev);
1061 struct max77693_muic_info *info;
1062 struct max77693_reg_data *init_data;
1069 info = devm_kzalloc(&pdev->dev, sizeof(struct max77693_muic_info),
1074 info->dev = &pdev->dev;
1075 info->max77693 = max77693;
1076 if (info->max77693->regmap_muic) {
1077 dev_dbg(&pdev->dev, "allocate register map\n");
1079 info->max77693->regmap_muic = devm_regmap_init_i2c(
1080 info->max77693->muic,
1081 &max77693_muic_regmap_config);
1082 if (IS_ERR(info->max77693->regmap_muic)) {
1083 ret = PTR_ERR(info->max77693->regmap_muic);
1084 dev_err(max77693->dev,
1085 "failed to allocate register map: %d\n", ret);
1090 /* Register input device for button of dock device */
1091 info->dock = devm_input_allocate_device(&pdev->dev);
1093 dev_err(&pdev->dev, "%s: failed to allocate input\n", __func__);
1096 info->dock->name = "max77693-muic/dock";
1097 info->dock->phys = "max77693-muic/extcon";
1098 info->dock->dev.parent = &pdev->dev;
1100 __set_bit(EV_REP, info->dock->evbit);
1102 input_set_capability(info->dock, EV_KEY, KEY_VOLUMEUP);
1103 input_set_capability(info->dock, EV_KEY, KEY_VOLUMEDOWN);
1104 input_set_capability(info->dock, EV_KEY, KEY_PLAYPAUSE);
1105 input_set_capability(info->dock, EV_KEY, KEY_PREVIOUSSONG);
1106 input_set_capability(info->dock, EV_KEY, KEY_NEXTSONG);
1108 ret = input_register_device(info->dock);
1110 dev_err(&pdev->dev, "Cannot register input device error(%d)\n",
1115 platform_set_drvdata(pdev, info);
1116 mutex_init(&info->mutex);
1118 INIT_WORK(&info->irq_work, max77693_muic_irq_work);
1120 /* Support irq domain for MAX77693 MUIC device */
1121 for (i = 0; i < ARRAY_SIZE(muic_irqs); i++) {
1122 struct max77693_muic_irq *muic_irq = &muic_irqs[i];
1123 unsigned int virq = 0;
1125 virq = regmap_irq_get_virq(max77693->irq_data_muic,
1129 muic_irq->virq = virq;
1131 ret = devm_request_threaded_irq(&pdev->dev, virq, NULL,
1132 max77693_muic_irq_handler,
1134 muic_irq->name, info);
1137 "failed: irq request (IRQ: %d, error :%d)\n",
1138 muic_irq->irq, ret);
1143 /* Initialize extcon device */
1144 info->edev = devm_extcon_dev_allocate(&pdev->dev,
1145 max77693_extcon_cable);
1146 if (IS_ERR(info->edev)) {
1147 dev_err(&pdev->dev, "failed to allocate memory for extcon\n");
1151 ret = devm_extcon_dev_register(&pdev->dev, info->edev);
1153 dev_err(&pdev->dev, "failed to register extcon device\n");
1157 /* Initialize MUIC register by using platform data or default data */
1158 if (pdata && pdata->muic_data) {
1159 init_data = pdata->muic_data->init_data;
1160 num_init_data = pdata->muic_data->num_init_data;
1162 init_data = default_init_data;
1163 num_init_data = ARRAY_SIZE(default_init_data);
1166 for (i = 0; i < num_init_data; i++) {
1167 enum max77693_irq_source irq_src
1168 = MAX77693_IRQ_GROUP_NR;
1170 regmap_write(info->max77693->regmap_muic,
1174 switch (init_data[i].addr) {
1175 case MAX77693_MUIC_REG_INTMASK1:
1176 irq_src = MUIC_INT1;
1178 case MAX77693_MUIC_REG_INTMASK2:
1179 irq_src = MUIC_INT2;
1181 case MAX77693_MUIC_REG_INTMASK3:
1182 irq_src = MUIC_INT3;
1186 if (irq_src < MAX77693_IRQ_GROUP_NR)
1187 info->max77693->irq_masks_cur[irq_src]
1188 = init_data[i].data;
1191 if (pdata && pdata->muic_data) {
1192 struct max77693_muic_platform_data *muic_pdata
1196 * Default usb/uart path whether UART/USB or AUX_UART/AUX_USB
1197 * h/w path of COMP2/COMN1 on CONTROL1 register.
1199 if (muic_pdata->path_uart)
1200 info->path_uart = muic_pdata->path_uart;
1202 info->path_uart = CONTROL1_SW_UART;
1204 if (muic_pdata->path_usb)
1205 info->path_usb = muic_pdata->path_usb;
1207 info->path_usb = CONTROL1_SW_USB;
1210 * Default delay time for detecting cable state
1211 * after certain time.
1213 if (muic_pdata->detcable_delay_ms)
1215 msecs_to_jiffies(muic_pdata->detcable_delay_ms);
1217 delay_jiffies = msecs_to_jiffies(DELAY_MS_DEFAULT);
1219 info->path_usb = CONTROL1_SW_USB;
1220 info->path_uart = CONTROL1_SW_UART;
1221 delay_jiffies = msecs_to_jiffies(DELAY_MS_DEFAULT);
1224 /* Set initial path for UART */
1225 max77693_muic_set_path(info, info->path_uart, true);
1227 /* Check revision number of MUIC device*/
1228 ret = regmap_read(info->max77693->regmap_muic,
1229 MAX77693_MUIC_REG_ID, &id);
1231 dev_err(&pdev->dev, "failed to read revision number\n");
1234 dev_info(info->dev, "device ID : 0x%x\n", id);
1236 /* Set ADC debounce time */
1237 max77693_muic_set_debounce_time(info, ADC_DEBOUNCE_TIME_25MS);
1240 * Detect accessory after completing the initialization of platform
1242 * - Use delayed workqueue to detect cable state and then
1243 * notify cable state to notifiee/platform through uevent.
1244 * After completing the booting of platform, the extcon provider
1245 * driver should notify cable state to upper layer.
1247 INIT_DELAYED_WORK(&info->wq_detcable, max77693_muic_detect_cable_wq);
1248 queue_delayed_work(system_power_efficient_wq, &info->wq_detcable,
1254 static int max77693_muic_remove(struct platform_device *pdev)
1256 struct max77693_muic_info *info = platform_get_drvdata(pdev);
1258 cancel_work_sync(&info->irq_work);
1259 input_unregister_device(info->dock);
1264 static struct platform_driver max77693_muic_driver = {
1268 .probe = max77693_muic_probe,
1269 .remove = max77693_muic_remove,
1272 module_platform_driver(max77693_muic_driver);
1274 MODULE_DESCRIPTION("Maxim MAX77693 Extcon driver");
1275 MODULE_AUTHOR("Chanwoo Choi <cw00.choi@samsung.com>");
1276 MODULE_LICENSE("GPL");
1277 MODULE_ALIAS("platform:extcon-max77693");