r8152: fix tx packets accounting
[linux/fpc-iii.git] / drivers / extcon / extcon.c
blobd0e367959c916b05fbcce4e69794891563f7357f
1 /*
2 * drivers/extcon/extcon.c - External Connector (extcon) framework.
4 * External connector (extcon) class driver
6 * Copyright (C) 2015 Samsung Electronics
7 * Author: Chanwoo Choi <cw00.choi@samsung.com>
9 * Copyright (C) 2012 Samsung Electronics
10 * Author: Donggeun Kim <dg77.kim@samsung.com>
11 * Author: MyungJoo Ham <myungjoo.ham@samsung.com>
13 * based on android/drivers/switch/switch_class.c
14 * Copyright (C) 2008 Google, Inc.
15 * Author: Mike Lockwood <lockwood@android.com>
17 * This software is licensed under the terms of the GNU General Public
18 * License version 2, as published by the Free Software Foundation, and
19 * may be copied, distributed, and modified under those terms.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
27 #include <linux/module.h>
28 #include <linux/types.h>
29 #include <linux/init.h>
30 #include <linux/device.h>
31 #include <linux/fs.h>
32 #include <linux/err.h>
33 #include <linux/extcon.h>
34 #include <linux/of.h>
35 #include <linux/slab.h>
36 #include <linux/sysfs.h>
38 #define SUPPORTED_CABLE_MAX 32
39 #define CABLE_NAME_MAX 30
41 struct __extcon_info {
42 unsigned int type;
43 unsigned int id;
44 const char *name;
46 } extcon_info[] = {
47 [EXTCON_NONE] = {
48 .type = EXTCON_TYPE_MISC,
49 .id = EXTCON_NONE,
50 .name = "NONE",
53 /* USB external connector */
54 [EXTCON_USB] = {
55 .type = EXTCON_TYPE_USB,
56 .id = EXTCON_USB,
57 .name = "USB",
59 [EXTCON_USB_HOST] = {
60 .type = EXTCON_TYPE_USB,
61 .id = EXTCON_USB_HOST,
62 .name = "USB_HOST",
65 /* Charging external connector */
66 [EXTCON_CHG_USB_SDP] = {
67 .type = EXTCON_TYPE_CHG | EXTCON_TYPE_USB,
68 .id = EXTCON_CHG_USB_SDP,
69 .name = "SDP",
71 [EXTCON_CHG_USB_DCP] = {
72 .type = EXTCON_TYPE_CHG | EXTCON_TYPE_USB,
73 .id = EXTCON_CHG_USB_DCP,
74 .name = "DCP",
76 [EXTCON_CHG_USB_CDP] = {
77 .type = EXTCON_TYPE_CHG | EXTCON_TYPE_USB,
78 .id = EXTCON_CHG_USB_CDP,
79 .name = "CDP",
81 [EXTCON_CHG_USB_ACA] = {
82 .type = EXTCON_TYPE_CHG | EXTCON_TYPE_USB,
83 .id = EXTCON_CHG_USB_ACA,
84 .name = "ACA",
86 [EXTCON_CHG_USB_FAST] = {
87 .type = EXTCON_TYPE_CHG | EXTCON_TYPE_USB,
88 .id = EXTCON_CHG_USB_FAST,
89 .name = "FAST-CHARGER",
91 [EXTCON_CHG_USB_SLOW] = {
92 .type = EXTCON_TYPE_CHG | EXTCON_TYPE_USB,
93 .id = EXTCON_CHG_USB_SLOW,
94 .name = "SLOW-CHARGER",
96 [EXTCON_CHG_WPT] = {
97 .type = EXTCON_TYPE_CHG,
98 .id = EXTCON_CHG_WPT,
99 .name = "WPT",
102 /* Jack external connector */
103 [EXTCON_JACK_MICROPHONE] = {
104 .type = EXTCON_TYPE_JACK,
105 .id = EXTCON_JACK_MICROPHONE,
106 .name = "MICROPHONE",
108 [EXTCON_JACK_HEADPHONE] = {
109 .type = EXTCON_TYPE_JACK,
110 .id = EXTCON_JACK_HEADPHONE,
111 .name = "HEADPHONE",
113 [EXTCON_JACK_LINE_IN] = {
114 .type = EXTCON_TYPE_JACK,
115 .id = EXTCON_JACK_LINE_IN,
116 .name = "LINE-IN",
118 [EXTCON_JACK_LINE_OUT] = {
119 .type = EXTCON_TYPE_JACK,
120 .id = EXTCON_JACK_LINE_OUT,
121 .name = "LINE-OUT",
123 [EXTCON_JACK_VIDEO_IN] = {
124 .type = EXTCON_TYPE_JACK,
125 .id = EXTCON_JACK_VIDEO_IN,
126 .name = "VIDEO-IN",
128 [EXTCON_JACK_VIDEO_OUT] = {
129 .type = EXTCON_TYPE_JACK,
130 .id = EXTCON_JACK_VIDEO_OUT,
131 .name = "VIDEO-OUT",
133 [EXTCON_JACK_SPDIF_IN] = {
134 .type = EXTCON_TYPE_JACK,
135 .id = EXTCON_JACK_SPDIF_IN,
136 .name = "SPDIF-IN",
138 [EXTCON_JACK_SPDIF_OUT] = {
139 .type = EXTCON_TYPE_JACK,
140 .id = EXTCON_JACK_SPDIF_OUT,
141 .name = "SPDIF-OUT",
144 /* Display external connector */
145 [EXTCON_DISP_HDMI] = {
146 .type = EXTCON_TYPE_DISP,
147 .id = EXTCON_DISP_HDMI,
148 .name = "HDMI",
150 [EXTCON_DISP_MHL] = {
151 .type = EXTCON_TYPE_DISP,
152 .id = EXTCON_DISP_MHL,
153 .name = "MHL",
155 [EXTCON_DISP_DVI] = {
156 .type = EXTCON_TYPE_DISP,
157 .id = EXTCON_DISP_DVI,
158 .name = "DVI",
160 [EXTCON_DISP_VGA] = {
161 .type = EXTCON_TYPE_DISP,
162 .id = EXTCON_DISP_VGA,
163 .name = "VGA",
165 [EXTCON_DISP_DP] = {
166 .type = EXTCON_TYPE_DISP | EXTCON_TYPE_USB,
167 .id = EXTCON_DISP_DP,
168 .name = "DP",
170 [EXTCON_DISP_HMD] = {
171 .type = EXTCON_TYPE_DISP | EXTCON_TYPE_USB,
172 .id = EXTCON_DISP_HMD,
173 .name = "HMD",
176 /* Miscellaneous external connector */
177 [EXTCON_DOCK] = {
178 .type = EXTCON_TYPE_MISC,
179 .id = EXTCON_DOCK,
180 .name = "DOCK",
182 [EXTCON_JIG] = {
183 .type = EXTCON_TYPE_MISC,
184 .id = EXTCON_JIG,
185 .name = "JIG",
187 [EXTCON_MECHANICAL] = {
188 .type = EXTCON_TYPE_MISC,
189 .id = EXTCON_MECHANICAL,
190 .name = "MECHANICAL",
193 { /* sentinel */ }
197 * struct extcon_cable - An internal data for each cable of extcon device.
198 * @edev: The extcon device
199 * @cable_index: Index of this cable in the edev
200 * @attr_g: Attribute group for the cable
201 * @attr_name: "name" sysfs entry
202 * @attr_state: "state" sysfs entry
203 * @attrs: Array pointing to attr_name and attr_state for attr_g
205 struct extcon_cable {
206 struct extcon_dev *edev;
207 int cable_index;
209 struct attribute_group attr_g;
210 struct device_attribute attr_name;
211 struct device_attribute attr_state;
213 struct attribute *attrs[3]; /* to be fed to attr_g.attrs */
215 union extcon_property_value usb_propval[EXTCON_PROP_USB_CNT];
216 union extcon_property_value chg_propval[EXTCON_PROP_CHG_CNT];
217 union extcon_property_value jack_propval[EXTCON_PROP_JACK_CNT];
218 union extcon_property_value disp_propval[EXTCON_PROP_DISP_CNT];
220 unsigned long usb_bits[BITS_TO_LONGS(EXTCON_PROP_USB_CNT)];
221 unsigned long chg_bits[BITS_TO_LONGS(EXTCON_PROP_CHG_CNT)];
222 unsigned long jack_bits[BITS_TO_LONGS(EXTCON_PROP_JACK_CNT)];
223 unsigned long disp_bits[BITS_TO_LONGS(EXTCON_PROP_DISP_CNT)];
226 static struct class *extcon_class;
227 #if defined(CONFIG_ANDROID)
228 static struct class_compat *switch_class;
229 #endif /* CONFIG_ANDROID */
231 static LIST_HEAD(extcon_dev_list);
232 static DEFINE_MUTEX(extcon_dev_list_lock);
235 * check_mutually_exclusive - Check if new_state violates mutually_exclusive
236 * condition.
237 * @edev: the extcon device
238 * @new_state: new cable attach status for @edev
240 * Returns 0 if nothing violates. Returns the index + 1 for the first
241 * violated condition.
243 static int check_mutually_exclusive(struct extcon_dev *edev, u32 new_state)
245 int i = 0;
247 if (!edev->mutually_exclusive)
248 return 0;
250 for (i = 0; edev->mutually_exclusive[i]; i++) {
251 int weight;
252 u32 correspondants = new_state & edev->mutually_exclusive[i];
254 /* calculate the total number of bits set */
255 weight = hweight32(correspondants);
256 if (weight > 1)
257 return i + 1;
260 return 0;
263 static int find_cable_index_by_id(struct extcon_dev *edev, const unsigned int id)
265 int i;
267 /* Find the the index of extcon cable in edev->supported_cable */
268 for (i = 0; i < edev->max_supported; i++) {
269 if (edev->supported_cable[i] == id)
270 return i;
273 return -EINVAL;
276 static int get_extcon_type(unsigned int prop)
278 switch (prop) {
279 case EXTCON_PROP_USB_MIN ... EXTCON_PROP_USB_MAX:
280 return EXTCON_TYPE_USB;
281 case EXTCON_PROP_CHG_MIN ... EXTCON_PROP_CHG_MAX:
282 return EXTCON_TYPE_CHG;
283 case EXTCON_PROP_JACK_MIN ... EXTCON_PROP_JACK_MAX:
284 return EXTCON_TYPE_JACK;
285 case EXTCON_PROP_DISP_MIN ... EXTCON_PROP_DISP_MAX:
286 return EXTCON_TYPE_DISP;
287 default:
288 return -EINVAL;
292 static bool is_extcon_attached(struct extcon_dev *edev, unsigned int index)
294 return !!(edev->state & BIT(index));
297 static bool is_extcon_changed(struct extcon_dev *edev, int index,
298 bool new_state)
300 int state = !!(edev->state & BIT(index));
301 return (state != new_state);
304 static bool is_extcon_property_supported(unsigned int id, unsigned int prop)
306 int type;
308 /* Check whether the property is supported or not. */
309 type = get_extcon_type(prop);
310 if (type < 0)
311 return false;
313 /* Check whether a specific extcon id supports the property or not. */
314 return !!(extcon_info[id].type & type);
317 static int is_extcon_property_capability(struct extcon_dev *edev,
318 unsigned int id, int index,unsigned int prop)
320 struct extcon_cable *cable;
321 int type, ret;
323 /* Check whether the property is supported or not. */
324 type = get_extcon_type(prop);
325 if (type < 0)
326 return type;
328 cable = &edev->cables[index];
330 switch (type) {
331 case EXTCON_TYPE_USB:
332 ret = test_bit(prop - EXTCON_PROP_USB_MIN, cable->usb_bits);
333 break;
334 case EXTCON_TYPE_CHG:
335 ret = test_bit(prop - EXTCON_PROP_CHG_MIN, cable->chg_bits);
336 break;
337 case EXTCON_TYPE_JACK:
338 ret = test_bit(prop - EXTCON_PROP_JACK_MIN, cable->jack_bits);
339 break;
340 case EXTCON_TYPE_DISP:
341 ret = test_bit(prop - EXTCON_PROP_DISP_MIN, cable->disp_bits);
342 break;
343 default:
344 ret = -EINVAL;
347 return ret;
350 static void init_property(struct extcon_dev *edev, unsigned int id, int index)
352 unsigned int type = extcon_info[id].type;
353 struct extcon_cable *cable = &edev->cables[index];
355 if (EXTCON_TYPE_USB & type)
356 memset(cable->usb_propval, 0, sizeof(cable->usb_propval));
357 if (EXTCON_TYPE_CHG & type)
358 memset(cable->chg_propval, 0, sizeof(cable->chg_propval));
359 if (EXTCON_TYPE_JACK & type)
360 memset(cable->jack_propval, 0, sizeof(cable->jack_propval));
361 if (EXTCON_TYPE_DISP & type)
362 memset(cable->disp_propval, 0, sizeof(cable->disp_propval));
365 static ssize_t state_show(struct device *dev, struct device_attribute *attr,
366 char *buf)
368 int i, count = 0;
369 struct extcon_dev *edev = dev_get_drvdata(dev);
371 if (edev->max_supported == 0)
372 return sprintf(buf, "%u\n", edev->state);
374 for (i = 0; i < edev->max_supported; i++) {
375 count += sprintf(buf + count, "%s=%d\n",
376 extcon_info[edev->supported_cable[i]].name,
377 !!(edev->state & (1 << i)));
380 return count;
382 static DEVICE_ATTR_RO(state);
384 static ssize_t name_show(struct device *dev, struct device_attribute *attr,
385 char *buf)
387 struct extcon_dev *edev = dev_get_drvdata(dev);
389 return sprintf(buf, "%s\n", edev->name);
391 static DEVICE_ATTR_RO(name);
393 static ssize_t cable_name_show(struct device *dev,
394 struct device_attribute *attr, char *buf)
396 struct extcon_cable *cable = container_of(attr, struct extcon_cable,
397 attr_name);
398 int i = cable->cable_index;
400 return sprintf(buf, "%s\n",
401 extcon_info[cable->edev->supported_cable[i]].name);
404 static ssize_t cable_state_show(struct device *dev,
405 struct device_attribute *attr, char *buf)
407 struct extcon_cable *cable = container_of(attr, struct extcon_cable,
408 attr_state);
410 int i = cable->cable_index;
412 return sprintf(buf, "%d\n",
413 extcon_get_state(cable->edev, cable->edev->supported_cable[i]));
417 * extcon_sync() - Synchronize the states for both the attached/detached
418 * @edev: the extcon device that has the cable.
420 * This function send a notification to synchronize the all states of a
421 * specific external connector
423 int extcon_sync(struct extcon_dev *edev, unsigned int id)
425 char name_buf[120];
426 char state_buf[120];
427 char *prop_buf;
428 char *envp[3];
429 int env_offset = 0;
430 int length;
431 int index;
432 int state;
433 unsigned long flags;
435 if (!edev)
436 return -EINVAL;
438 index = find_cable_index_by_id(edev, id);
439 if (index < 0)
440 return index;
442 spin_lock_irqsave(&edev->lock, flags);
444 state = !!(edev->state & BIT(index));
445 raw_notifier_call_chain(&edev->nh[index], state, edev);
447 /* This could be in interrupt handler */
448 prop_buf = (char *)get_zeroed_page(GFP_ATOMIC);
449 if (!prop_buf) {
450 /* Unlock early before uevent */
451 spin_unlock_irqrestore(&edev->lock, flags);
453 dev_err(&edev->dev, "out of memory in extcon_set_state\n");
454 kobject_uevent(&edev->dev.kobj, KOBJ_CHANGE);
456 return -ENOMEM;
459 length = name_show(&edev->dev, NULL, prop_buf);
460 if (length > 0) {
461 if (prop_buf[length - 1] == '\n')
462 prop_buf[length - 1] = 0;
463 snprintf(name_buf, sizeof(name_buf), "NAME=%s", prop_buf);
464 envp[env_offset++] = name_buf;
467 length = state_show(&edev->dev, NULL, prop_buf);
468 if (length > 0) {
469 if (prop_buf[length - 1] == '\n')
470 prop_buf[length - 1] = 0;
471 snprintf(state_buf, sizeof(state_buf), "STATE=%s", prop_buf);
472 envp[env_offset++] = state_buf;
474 envp[env_offset] = NULL;
476 /* Unlock early before uevent */
477 spin_unlock_irqrestore(&edev->lock, flags);
478 kobject_uevent_env(&edev->dev.kobj, KOBJ_CHANGE, envp);
479 free_page((unsigned long)prop_buf);
481 return 0;
483 EXPORT_SYMBOL_GPL(extcon_sync);
486 * extcon_get_state() - Get the state of a external connector.
487 * @edev: the extcon device that has the cable.
488 * @id: the unique id of each external connector in extcon enumeration.
490 int extcon_get_state(struct extcon_dev *edev, const unsigned int id)
492 int index, state;
493 unsigned long flags;
495 if (!edev)
496 return -EINVAL;
498 index = find_cable_index_by_id(edev, id);
499 if (index < 0)
500 return index;
502 spin_lock_irqsave(&edev->lock, flags);
503 state = is_extcon_attached(edev, index);
504 spin_unlock_irqrestore(&edev->lock, flags);
506 return state;
508 EXPORT_SYMBOL_GPL(extcon_get_state);
511 * extcon_set_state() - Set the state of a external connector.
512 * without a notification.
513 * @edev: the extcon device that has the cable.
514 * @id: the unique id of each external connector
515 * in extcon enumeration.
516 * @state: the new cable status. The default semantics is
517 * true: attached / false: detached.
519 * This function only set the state of a external connector without
520 * a notification. To synchronize the data of a external connector,
521 * use extcon_set_state_sync() and extcon_sync().
523 int extcon_set_state(struct extcon_dev *edev, unsigned int id,
524 bool cable_state)
526 unsigned long flags;
527 int index, ret = 0;
529 if (!edev)
530 return -EINVAL;
532 index = find_cable_index_by_id(edev, id);
533 if (index < 0)
534 return index;
536 spin_lock_irqsave(&edev->lock, flags);
538 /* Check whether the external connector's state is changed. */
539 if (!is_extcon_changed(edev, index, cable_state))
540 goto out;
542 if (check_mutually_exclusive(edev,
543 (edev->state & ~BIT(index)) | (cable_state & BIT(index)))) {
544 ret = -EPERM;
545 goto out;
549 * Initialize the value of extcon property before setting
550 * the detached state for an external connector.
552 if (!cable_state)
553 init_property(edev, id, index);
555 /* Update the state for a external connector. */
556 if (cable_state)
557 edev->state |= BIT(index);
558 else
559 edev->state &= ~(BIT(index));
560 out:
561 spin_unlock_irqrestore(&edev->lock, flags);
563 return ret;
565 EXPORT_SYMBOL_GPL(extcon_set_state);
568 * extcon_set_state_sync() - Set the state of a external connector
569 * with a notification.
570 * @edev: the extcon device that has the cable.
571 * @id: the unique id of each external connector
572 * in extcon enumeration.
573 * @state: the new cable status. The default semantics is
574 * true: attached / false: detached.
576 * This function set the state of external connector and synchronize the data
577 * by usning a notification.
579 int extcon_set_state_sync(struct extcon_dev *edev, unsigned int id,
580 bool cable_state)
582 int ret, index;
583 unsigned long flags;
585 index = find_cable_index_by_id(edev, id);
586 if (index < 0)
587 return index;
589 /* Check whether the external connector's state is changed. */
590 spin_lock_irqsave(&edev->lock, flags);
591 ret = is_extcon_changed(edev, index, cable_state);
592 spin_unlock_irqrestore(&edev->lock, flags);
593 if (!ret)
594 return 0;
596 ret = extcon_set_state(edev, id, cable_state);
597 if (ret < 0)
598 return ret;
600 return extcon_sync(edev, id);
602 EXPORT_SYMBOL_GPL(extcon_set_state_sync);
605 * extcon_get_property() - Get the property value of a specific cable.
606 * @edev: the extcon device that has the cable.
607 * @id: the unique id of each external connector
608 * in extcon enumeration.
609 * @prop: the property id among enum extcon_property.
610 * @prop_val: the pointer which store the value of property.
612 * When getting the property value of external connector, the external connector
613 * should be attached. If detached state, function just return 0 without
614 * property value. Also, the each property should be included in the list of
615 * supported properties according to the type of external connectors.
617 * Returns 0 if success or error number if fail
619 int extcon_get_property(struct extcon_dev *edev, unsigned int id,
620 unsigned int prop,
621 union extcon_property_value *prop_val)
623 struct extcon_cable *cable;
624 unsigned long flags;
625 int index, ret = 0;
627 *prop_val = (union extcon_property_value)(0);
629 if (!edev)
630 return -EINVAL;
632 /* Check whether the property is supported or not */
633 if (!is_extcon_property_supported(id, prop))
634 return -EINVAL;
636 /* Find the cable index of external connector by using id */
637 index = find_cable_index_by_id(edev, id);
638 if (index < 0)
639 return index;
641 spin_lock_irqsave(&edev->lock, flags);
643 /* Check whether the property is available or not. */
644 if (!is_extcon_property_capability(edev, id, index, prop)) {
645 spin_unlock_irqrestore(&edev->lock, flags);
646 return -EPERM;
650 * Check whether the external connector is attached.
651 * If external connector is detached, the user can not
652 * get the property value.
654 if (!is_extcon_attached(edev, index)) {
655 spin_unlock_irqrestore(&edev->lock, flags);
656 return 0;
659 cable = &edev->cables[index];
661 /* Get the property value according to extcon type */
662 switch (prop) {
663 case EXTCON_PROP_USB_MIN ... EXTCON_PROP_USB_MAX:
664 *prop_val = cable->usb_propval[prop - EXTCON_PROP_USB_MIN];
665 break;
666 case EXTCON_PROP_CHG_MIN ... EXTCON_PROP_CHG_MAX:
667 *prop_val = cable->chg_propval[prop - EXTCON_PROP_CHG_MIN];
668 break;
669 case EXTCON_PROP_JACK_MIN ... EXTCON_PROP_JACK_MAX:
670 *prop_val = cable->jack_propval[prop - EXTCON_PROP_JACK_MIN];
671 break;
672 case EXTCON_PROP_DISP_MIN ... EXTCON_PROP_DISP_MAX:
673 *prop_val = cable->disp_propval[prop - EXTCON_PROP_DISP_MIN];
674 break;
675 default:
676 ret = -EINVAL;
677 break;
680 spin_unlock_irqrestore(&edev->lock, flags);
682 return ret;
684 EXPORT_SYMBOL_GPL(extcon_get_property);
687 * extcon_set_property() - Set the property value of a specific cable.
688 * @edev: the extcon device that has the cable.
689 * @id: the unique id of each external connector
690 * in extcon enumeration.
691 * @prop: the property id among enum extcon_property.
692 * @prop_val: the pointer including the new value of property.
694 * The each property should be included in the list of supported properties
695 * according to the type of external connectors.
697 * Returns 0 if success or error number if fail
699 int extcon_set_property(struct extcon_dev *edev, unsigned int id,
700 unsigned int prop,
701 union extcon_property_value prop_val)
703 struct extcon_cable *cable;
704 unsigned long flags;
705 int index, ret = 0;
707 if (!edev)
708 return -EINVAL;
710 /* Check whether the property is supported or not */
711 if (!is_extcon_property_supported(id, prop))
712 return -EINVAL;
714 /* Find the cable index of external connector by using id */
715 index = find_cable_index_by_id(edev, id);
716 if (index < 0)
717 return index;
719 spin_lock_irqsave(&edev->lock, flags);
721 /* Check whether the property is available or not. */
722 if (!is_extcon_property_capability(edev, id, index, prop)) {
723 spin_unlock_irqrestore(&edev->lock, flags);
724 return -EPERM;
727 cable = &edev->cables[index];
729 /* Set the property value according to extcon type */
730 switch (prop) {
731 case EXTCON_PROP_USB_MIN ... EXTCON_PROP_USB_MAX:
732 cable->usb_propval[prop - EXTCON_PROP_USB_MIN] = prop_val;
733 break;
734 case EXTCON_PROP_CHG_MIN ... EXTCON_PROP_CHG_MAX:
735 cable->chg_propval[prop - EXTCON_PROP_CHG_MIN] = prop_val;
736 break;
737 case EXTCON_PROP_JACK_MIN ... EXTCON_PROP_JACK_MAX:
738 cable->jack_propval[prop - EXTCON_PROP_JACK_MIN] = prop_val;
739 break;
740 case EXTCON_PROP_DISP_MIN ... EXTCON_PROP_DISP_MAX:
741 cable->disp_propval[prop - EXTCON_PROP_DISP_MIN] = prop_val;
742 break;
743 default:
744 ret = -EINVAL;
745 break;
748 spin_unlock_irqrestore(&edev->lock, flags);
750 return ret;
752 EXPORT_SYMBOL_GPL(extcon_set_property);
755 * extcon_set_property_sync() - Set the property value of a specific cable
756 with a notification.
757 * @prop_val: the pointer including the new value of property.
759 * When setting the property value of external connector, the external connector
760 * should be attached. The each property should be included in the list of
761 * supported properties according to the type of external connectors.
763 * Returns 0 if success or error number if fail
765 int extcon_set_property_sync(struct extcon_dev *edev, unsigned int id,
766 unsigned int prop,
767 union extcon_property_value prop_val)
769 int ret;
771 ret = extcon_set_property(edev, id, prop, prop_val);
772 if (ret < 0)
773 return ret;
775 return extcon_sync(edev, id);
777 EXPORT_SYMBOL_GPL(extcon_set_property_sync);
780 * extcon_get_property_capability() - Get the capability of property
781 * of an external connector.
782 * @edev: the extcon device that has the cable.
783 * @id: the unique id of each external connector
784 * in extcon enumeration.
785 * @prop: the property id among enum extcon_property.
787 * Returns 1 if the property is available or 0 if not available.
789 int extcon_get_property_capability(struct extcon_dev *edev, unsigned int id,
790 unsigned int prop)
792 int index;
794 if (!edev)
795 return -EINVAL;
797 /* Check whether the property is supported or not */
798 if (!is_extcon_property_supported(id, prop))
799 return -EINVAL;
801 /* Find the cable index of external connector by using id */
802 index = find_cable_index_by_id(edev, id);
803 if (index < 0)
804 return index;
806 return is_extcon_property_capability(edev, id, index, prop);
808 EXPORT_SYMBOL_GPL(extcon_get_property_capability);
811 * extcon_set_property_capability() - Set the capability of a property
812 * of an external connector.
813 * @edev: the extcon device that has the cable.
814 * @id: the unique id of each external connector
815 * in extcon enumeration.
816 * @prop: the property id among enum extcon_property.
818 * This function set the capability of a property for an external connector
819 * to mark the bit in capability bitmap which mean the available state of
820 * a property.
822 * Returns 0 if success or error number if fail
824 int extcon_set_property_capability(struct extcon_dev *edev, unsigned int id,
825 unsigned int prop)
827 struct extcon_cable *cable;
828 int index, type, ret = 0;
830 if (!edev)
831 return -EINVAL;
833 /* Check whether the property is supported or not. */
834 if (!is_extcon_property_supported(id, prop))
835 return -EINVAL;
837 /* Find the cable index of external connector by using id. */
838 index = find_cable_index_by_id(edev, id);
839 if (index < 0)
840 return index;
842 type = get_extcon_type(prop);
843 if (type < 0)
844 return type;
846 cable = &edev->cables[index];
848 switch (type) {
849 case EXTCON_TYPE_USB:
850 __set_bit(prop - EXTCON_PROP_USB_MIN, cable->usb_bits);
851 break;
852 case EXTCON_TYPE_CHG:
853 __set_bit(prop - EXTCON_PROP_CHG_MIN, cable->chg_bits);
854 break;
855 case EXTCON_TYPE_JACK:
856 __set_bit(prop - EXTCON_PROP_JACK_MIN, cable->jack_bits);
857 break;
858 case EXTCON_TYPE_DISP:
859 __set_bit(prop - EXTCON_PROP_DISP_MIN, cable->disp_bits);
860 break;
861 default:
862 ret = -EINVAL;
865 return ret;
867 EXPORT_SYMBOL_GPL(extcon_set_property_capability);
870 * extcon_get_extcon_dev() - Get the extcon device instance from the name
871 * @extcon_name: The extcon name provided with extcon_dev_register()
873 struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name)
875 struct extcon_dev *sd;
877 if (!extcon_name)
878 return ERR_PTR(-EINVAL);
880 mutex_lock(&extcon_dev_list_lock);
881 list_for_each_entry(sd, &extcon_dev_list, entry) {
882 if (!strcmp(sd->name, extcon_name))
883 goto out;
885 sd = NULL;
886 out:
887 mutex_unlock(&extcon_dev_list_lock);
888 return sd;
890 EXPORT_SYMBOL_GPL(extcon_get_extcon_dev);
893 * extcon_register_notifier() - Register a notifiee to get notified by
894 * any attach status changes from the extcon.
895 * @edev: the extcon device that has the external connecotr.
896 * @id: the unique id of each external connector in extcon enumeration.
897 * @nb: a notifier block to be registered.
899 * Note that the second parameter given to the callback of nb (val) is
900 * "old_state", not the current state. The current state can be retrieved
901 * by looking at the third pameter (edev pointer)'s state value.
903 int extcon_register_notifier(struct extcon_dev *edev, unsigned int id,
904 struct notifier_block *nb)
906 unsigned long flags;
907 int ret, idx = -EINVAL;
909 if (!edev || !nb)
910 return -EINVAL;
912 idx = find_cable_index_by_id(edev, id);
913 if (idx < 0)
914 return idx;
916 spin_lock_irqsave(&edev->lock, flags);
917 ret = raw_notifier_chain_register(&edev->nh[idx], nb);
918 spin_unlock_irqrestore(&edev->lock, flags);
920 return ret;
922 EXPORT_SYMBOL_GPL(extcon_register_notifier);
925 * extcon_unregister_notifier() - Unregister a notifiee from the extcon device.
926 * @edev: the extcon device that has the external connecotr.
927 * @id: the unique id of each external connector in extcon enumeration.
928 * @nb: a notifier block to be registered.
930 int extcon_unregister_notifier(struct extcon_dev *edev, unsigned int id,
931 struct notifier_block *nb)
933 unsigned long flags;
934 int ret, idx;
936 if (!edev || !nb)
937 return -EINVAL;
939 idx = find_cable_index_by_id(edev, id);
940 if (idx < 0)
941 return idx;
943 spin_lock_irqsave(&edev->lock, flags);
944 ret = raw_notifier_chain_unregister(&edev->nh[idx], nb);
945 spin_unlock_irqrestore(&edev->lock, flags);
947 return ret;
949 EXPORT_SYMBOL_GPL(extcon_unregister_notifier);
951 static struct attribute *extcon_attrs[] = {
952 &dev_attr_state.attr,
953 &dev_attr_name.attr,
954 NULL,
956 ATTRIBUTE_GROUPS(extcon);
958 static int create_extcon_class(void)
960 if (!extcon_class) {
961 extcon_class = class_create(THIS_MODULE, "extcon");
962 if (IS_ERR(extcon_class))
963 return PTR_ERR(extcon_class);
964 extcon_class->dev_groups = extcon_groups;
966 #if defined(CONFIG_ANDROID)
967 switch_class = class_compat_register("switch");
968 if (WARN(!switch_class, "cannot allocate"))
969 return -ENOMEM;
970 #endif /* CONFIG_ANDROID */
973 return 0;
976 static void extcon_dev_release(struct device *dev)
980 static const char *muex_name = "mutually_exclusive";
981 static void dummy_sysfs_dev_release(struct device *dev)
986 * extcon_dev_allocate() - Allocate the memory of extcon device.
987 * @supported_cable: Array of supported extcon ending with EXTCON_NONE.
988 * If supported_cable is NULL, cable name related APIs
989 * are disabled.
991 * This function allocates the memory for extcon device without allocating
992 * memory in each extcon provider driver and initialize default setting for
993 * extcon device.
995 * Return the pointer of extcon device if success or ERR_PTR(err) if fail
997 struct extcon_dev *extcon_dev_allocate(const unsigned int *supported_cable)
999 struct extcon_dev *edev;
1001 if (!supported_cable)
1002 return ERR_PTR(-EINVAL);
1004 edev = kzalloc(sizeof(*edev), GFP_KERNEL);
1005 if (!edev)
1006 return ERR_PTR(-ENOMEM);
1008 edev->max_supported = 0;
1009 edev->supported_cable = supported_cable;
1011 return edev;
1015 * extcon_dev_free() - Free the memory of extcon device.
1016 * @edev: the extcon device to free
1018 void extcon_dev_free(struct extcon_dev *edev)
1020 kfree(edev);
1022 EXPORT_SYMBOL_GPL(extcon_dev_free);
1025 * extcon_dev_register() - Register a new extcon device
1026 * @edev : the new extcon device (should be allocated before calling)
1028 * Among the members of edev struct, please set the "user initializing data"
1029 * in any case and set the "optional callbacks" if required. However, please
1030 * do not set the values of "internal data", which are initialized by
1031 * this function.
1033 int extcon_dev_register(struct extcon_dev *edev)
1035 int ret, index = 0;
1036 static atomic_t edev_no = ATOMIC_INIT(-1);
1038 if (!extcon_class) {
1039 ret = create_extcon_class();
1040 if (ret < 0)
1041 return ret;
1044 if (!edev || !edev->supported_cable)
1045 return -EINVAL;
1047 for (; edev->supported_cable[index] != EXTCON_NONE; index++);
1049 edev->max_supported = index;
1050 if (index > SUPPORTED_CABLE_MAX) {
1051 dev_err(&edev->dev,
1052 "exceed the maximum number of supported cables\n");
1053 return -EINVAL;
1056 edev->dev.class = extcon_class;
1057 edev->dev.release = extcon_dev_release;
1059 edev->name = dev_name(edev->dev.parent);
1060 if (IS_ERR_OR_NULL(edev->name)) {
1061 dev_err(&edev->dev,
1062 "extcon device name is null\n");
1063 return -EINVAL;
1065 dev_set_name(&edev->dev, "extcon%lu",
1066 (unsigned long)atomic_inc_return(&edev_no));
1068 if (edev->max_supported) {
1069 char buf[10];
1070 char *str;
1071 struct extcon_cable *cable;
1073 edev->cables = kzalloc(sizeof(struct extcon_cable) *
1074 edev->max_supported, GFP_KERNEL);
1075 if (!edev->cables) {
1076 ret = -ENOMEM;
1077 goto err_sysfs_alloc;
1079 for (index = 0; index < edev->max_supported; index++) {
1080 cable = &edev->cables[index];
1082 snprintf(buf, 10, "cable.%d", index);
1083 str = kzalloc(sizeof(char) * (strlen(buf) + 1),
1084 GFP_KERNEL);
1085 if (!str) {
1086 for (index--; index >= 0; index--) {
1087 cable = &edev->cables[index];
1088 kfree(cable->attr_g.name);
1090 ret = -ENOMEM;
1092 goto err_alloc_cables;
1094 strcpy(str, buf);
1096 cable->edev = edev;
1097 cable->cable_index = index;
1098 cable->attrs[0] = &cable->attr_name.attr;
1099 cable->attrs[1] = &cable->attr_state.attr;
1100 cable->attrs[2] = NULL;
1101 cable->attr_g.name = str;
1102 cable->attr_g.attrs = cable->attrs;
1104 sysfs_attr_init(&cable->attr_name.attr);
1105 cable->attr_name.attr.name = "name";
1106 cable->attr_name.attr.mode = 0444;
1107 cable->attr_name.show = cable_name_show;
1109 sysfs_attr_init(&cable->attr_state.attr);
1110 cable->attr_state.attr.name = "state";
1111 cable->attr_state.attr.mode = 0444;
1112 cable->attr_state.show = cable_state_show;
1116 if (edev->max_supported && edev->mutually_exclusive) {
1117 char buf[80];
1118 char *name;
1120 /* Count the size of mutually_exclusive array */
1121 for (index = 0; edev->mutually_exclusive[index]; index++)
1124 edev->attrs_muex = kzalloc(sizeof(struct attribute *) *
1125 (index + 1), GFP_KERNEL);
1126 if (!edev->attrs_muex) {
1127 ret = -ENOMEM;
1128 goto err_muex;
1131 edev->d_attrs_muex = kzalloc(sizeof(struct device_attribute) *
1132 index, GFP_KERNEL);
1133 if (!edev->d_attrs_muex) {
1134 ret = -ENOMEM;
1135 kfree(edev->attrs_muex);
1136 goto err_muex;
1139 for (index = 0; edev->mutually_exclusive[index]; index++) {
1140 sprintf(buf, "0x%x", edev->mutually_exclusive[index]);
1141 name = kzalloc(sizeof(char) * (strlen(buf) + 1),
1142 GFP_KERNEL);
1143 if (!name) {
1144 for (index--; index >= 0; index--) {
1145 kfree(edev->d_attrs_muex[index].attr.
1146 name);
1148 kfree(edev->d_attrs_muex);
1149 kfree(edev->attrs_muex);
1150 ret = -ENOMEM;
1151 goto err_muex;
1153 strcpy(name, buf);
1154 sysfs_attr_init(&edev->d_attrs_muex[index].attr);
1155 edev->d_attrs_muex[index].attr.name = name;
1156 edev->d_attrs_muex[index].attr.mode = 0000;
1157 edev->attrs_muex[index] = &edev->d_attrs_muex[index]
1158 .attr;
1160 edev->attr_g_muex.name = muex_name;
1161 edev->attr_g_muex.attrs = edev->attrs_muex;
1165 if (edev->max_supported) {
1166 edev->extcon_dev_type.groups =
1167 kzalloc(sizeof(struct attribute_group *) *
1168 (edev->max_supported + 2), GFP_KERNEL);
1169 if (!edev->extcon_dev_type.groups) {
1170 ret = -ENOMEM;
1171 goto err_alloc_groups;
1174 edev->extcon_dev_type.name = dev_name(&edev->dev);
1175 edev->extcon_dev_type.release = dummy_sysfs_dev_release;
1177 for (index = 0; index < edev->max_supported; index++)
1178 edev->extcon_dev_type.groups[index] =
1179 &edev->cables[index].attr_g;
1180 if (edev->mutually_exclusive)
1181 edev->extcon_dev_type.groups[index] =
1182 &edev->attr_g_muex;
1184 edev->dev.type = &edev->extcon_dev_type;
1187 ret = device_register(&edev->dev);
1188 if (ret) {
1189 put_device(&edev->dev);
1190 goto err_dev;
1192 #if defined(CONFIG_ANDROID)
1193 if (switch_class)
1194 ret = class_compat_create_link(switch_class, &edev->dev, NULL);
1195 #endif /* CONFIG_ANDROID */
1197 spin_lock_init(&edev->lock);
1199 edev->nh = devm_kzalloc(&edev->dev,
1200 sizeof(*edev->nh) * edev->max_supported, GFP_KERNEL);
1201 if (!edev->nh) {
1202 ret = -ENOMEM;
1203 goto err_dev;
1206 for (index = 0; index < edev->max_supported; index++)
1207 RAW_INIT_NOTIFIER_HEAD(&edev->nh[index]);
1209 dev_set_drvdata(&edev->dev, edev);
1210 edev->state = 0;
1212 mutex_lock(&extcon_dev_list_lock);
1213 list_add(&edev->entry, &extcon_dev_list);
1214 mutex_unlock(&extcon_dev_list_lock);
1216 return 0;
1218 err_dev:
1219 if (edev->max_supported)
1220 kfree(edev->extcon_dev_type.groups);
1221 err_alloc_groups:
1222 if (edev->max_supported && edev->mutually_exclusive) {
1223 for (index = 0; edev->mutually_exclusive[index]; index++)
1224 kfree(edev->d_attrs_muex[index].attr.name);
1225 kfree(edev->d_attrs_muex);
1226 kfree(edev->attrs_muex);
1228 err_muex:
1229 for (index = 0; index < edev->max_supported; index++)
1230 kfree(edev->cables[index].attr_g.name);
1231 err_alloc_cables:
1232 if (edev->max_supported)
1233 kfree(edev->cables);
1234 err_sysfs_alloc:
1235 return ret;
1237 EXPORT_SYMBOL_GPL(extcon_dev_register);
1240 * extcon_dev_unregister() - Unregister the extcon device.
1241 * @edev: the extcon device instance to be unregistered.
1243 * Note that this does not call kfree(edev) because edev was not allocated
1244 * by this class.
1246 void extcon_dev_unregister(struct extcon_dev *edev)
1248 int index;
1250 if (!edev)
1251 return;
1253 mutex_lock(&extcon_dev_list_lock);
1254 list_del(&edev->entry);
1255 mutex_unlock(&extcon_dev_list_lock);
1257 if (IS_ERR_OR_NULL(get_device(&edev->dev))) {
1258 dev_err(&edev->dev, "Failed to unregister extcon_dev (%s)\n",
1259 dev_name(&edev->dev));
1260 return;
1263 device_unregister(&edev->dev);
1265 if (edev->mutually_exclusive && edev->max_supported) {
1266 for (index = 0; edev->mutually_exclusive[index];
1267 index++)
1268 kfree(edev->d_attrs_muex[index].attr.name);
1269 kfree(edev->d_attrs_muex);
1270 kfree(edev->attrs_muex);
1273 for (index = 0; index < edev->max_supported; index++)
1274 kfree(edev->cables[index].attr_g.name);
1276 if (edev->max_supported) {
1277 kfree(edev->extcon_dev_type.groups);
1278 kfree(edev->cables);
1281 #if defined(CONFIG_ANDROID)
1282 if (switch_class)
1283 class_compat_remove_link(switch_class, &edev->dev, NULL);
1284 #endif
1285 put_device(&edev->dev);
1287 EXPORT_SYMBOL_GPL(extcon_dev_unregister);
1289 #ifdef CONFIG_OF
1291 * extcon_get_edev_by_phandle - Get the extcon device from devicetree
1292 * @dev - instance to the given device
1293 * @index - index into list of extcon_dev
1295 * return the instance of extcon device
1297 struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev, int index)
1299 struct device_node *node;
1300 struct extcon_dev *edev;
1302 if (!dev)
1303 return ERR_PTR(-EINVAL);
1305 if (!dev->of_node) {
1306 dev_dbg(dev, "device does not have a device node entry\n");
1307 return ERR_PTR(-EINVAL);
1310 node = of_parse_phandle(dev->of_node, "extcon", index);
1311 if (!node) {
1312 dev_dbg(dev, "failed to get phandle in %s node\n",
1313 dev->of_node->full_name);
1314 return ERR_PTR(-ENODEV);
1317 mutex_lock(&extcon_dev_list_lock);
1318 list_for_each_entry(edev, &extcon_dev_list, entry) {
1319 if (edev->dev.parent && edev->dev.parent->of_node == node) {
1320 mutex_unlock(&extcon_dev_list_lock);
1321 of_node_put(node);
1322 return edev;
1325 mutex_unlock(&extcon_dev_list_lock);
1326 of_node_put(node);
1328 return ERR_PTR(-EPROBE_DEFER);
1330 #else
1331 struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev, int index)
1333 return ERR_PTR(-ENOSYS);
1335 #endif /* CONFIG_OF */
1336 EXPORT_SYMBOL_GPL(extcon_get_edev_by_phandle);
1339 * extcon_get_edev_name() - Get the name of the extcon device.
1340 * @edev: the extcon device
1342 const char *extcon_get_edev_name(struct extcon_dev *edev)
1344 return !edev ? NULL : edev->name;
1347 static int __init extcon_class_init(void)
1349 return create_extcon_class();
1351 module_init(extcon_class_init);
1353 static void __exit extcon_class_exit(void)
1355 #if defined(CONFIG_ANDROID)
1356 class_compat_unregister(switch_class);
1357 #endif
1358 class_destroy(extcon_class);
1360 module_exit(extcon_class_exit);
1362 MODULE_AUTHOR("Chanwoo Choi <cw00.choi@samsung.com>");
1363 MODULE_AUTHOR("Mike Lockwood <lockwood@android.com>");
1364 MODULE_AUTHOR("Donggeun Kim <dg77.kim@samsung.com>");
1365 MODULE_AUTHOR("MyungJoo Ham <myungjoo.ham@samsung.com>");
1366 MODULE_DESCRIPTION("External connector (extcon) class driver");
1367 MODULE_LICENSE("GPL");