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>
32 #include <linux/err.h>
34 #include <linux/slab.h>
35 #include <linux/sysfs.h>
39 #define SUPPORTED_CABLE_MAX 32
40 #define CABLE_NAME_MAX 30
42 struct __extcon_info {
49 .type = EXTCON_TYPE_MISC,
54 /* USB external connector */
56 .type = EXTCON_TYPE_USB,
61 .type = EXTCON_TYPE_USB,
62 .id = EXTCON_USB_HOST,
66 /* Charging external connector */
67 [EXTCON_CHG_USB_SDP] = {
68 .type = EXTCON_TYPE_CHG | EXTCON_TYPE_USB,
69 .id = EXTCON_CHG_USB_SDP,
72 [EXTCON_CHG_USB_DCP] = {
73 .type = EXTCON_TYPE_CHG | EXTCON_TYPE_USB,
74 .id = EXTCON_CHG_USB_DCP,
77 [EXTCON_CHG_USB_CDP] = {
78 .type = EXTCON_TYPE_CHG | EXTCON_TYPE_USB,
79 .id = EXTCON_CHG_USB_CDP,
82 [EXTCON_CHG_USB_ACA] = {
83 .type = EXTCON_TYPE_CHG | EXTCON_TYPE_USB,
84 .id = EXTCON_CHG_USB_ACA,
87 [EXTCON_CHG_USB_FAST] = {
88 .type = EXTCON_TYPE_CHG | EXTCON_TYPE_USB,
89 .id = EXTCON_CHG_USB_FAST,
90 .name = "FAST-CHARGER",
92 [EXTCON_CHG_USB_SLOW] = {
93 .type = EXTCON_TYPE_CHG | EXTCON_TYPE_USB,
94 .id = EXTCON_CHG_USB_SLOW,
95 .name = "SLOW-CHARGER",
98 .type = EXTCON_TYPE_CHG,
102 [EXTCON_CHG_USB_PD] = {
103 .type = EXTCON_TYPE_CHG | EXTCON_TYPE_USB,
104 .id = EXTCON_CHG_USB_PD,
108 /* Jack external connector */
109 [EXTCON_JACK_MICROPHONE] = {
110 .type = EXTCON_TYPE_JACK,
111 .id = EXTCON_JACK_MICROPHONE,
112 .name = "MICROPHONE",
114 [EXTCON_JACK_HEADPHONE] = {
115 .type = EXTCON_TYPE_JACK,
116 .id = EXTCON_JACK_HEADPHONE,
119 [EXTCON_JACK_LINE_IN] = {
120 .type = EXTCON_TYPE_JACK,
121 .id = EXTCON_JACK_LINE_IN,
124 [EXTCON_JACK_LINE_OUT] = {
125 .type = EXTCON_TYPE_JACK,
126 .id = EXTCON_JACK_LINE_OUT,
129 [EXTCON_JACK_VIDEO_IN] = {
130 .type = EXTCON_TYPE_JACK,
131 .id = EXTCON_JACK_VIDEO_IN,
134 [EXTCON_JACK_VIDEO_OUT] = {
135 .type = EXTCON_TYPE_JACK,
136 .id = EXTCON_JACK_VIDEO_OUT,
139 [EXTCON_JACK_SPDIF_IN] = {
140 .type = EXTCON_TYPE_JACK,
141 .id = EXTCON_JACK_SPDIF_IN,
144 [EXTCON_JACK_SPDIF_OUT] = {
145 .type = EXTCON_TYPE_JACK,
146 .id = EXTCON_JACK_SPDIF_OUT,
150 /* Display external connector */
151 [EXTCON_DISP_HDMI] = {
152 .type = EXTCON_TYPE_DISP,
153 .id = EXTCON_DISP_HDMI,
156 [EXTCON_DISP_MHL] = {
157 .type = EXTCON_TYPE_DISP,
158 .id = EXTCON_DISP_MHL,
161 [EXTCON_DISP_DVI] = {
162 .type = EXTCON_TYPE_DISP,
163 .id = EXTCON_DISP_DVI,
166 [EXTCON_DISP_VGA] = {
167 .type = EXTCON_TYPE_DISP,
168 .id = EXTCON_DISP_VGA,
172 .type = EXTCON_TYPE_DISP | EXTCON_TYPE_USB,
173 .id = EXTCON_DISP_DP,
176 [EXTCON_DISP_HMD] = {
177 .type = EXTCON_TYPE_DISP | EXTCON_TYPE_USB,
178 .id = EXTCON_DISP_HMD,
182 /* Miscellaneous external connector */
184 .type = EXTCON_TYPE_MISC,
189 .type = EXTCON_TYPE_MISC,
193 [EXTCON_MECHANICAL] = {
194 .type = EXTCON_TYPE_MISC,
195 .id = EXTCON_MECHANICAL,
196 .name = "MECHANICAL",
203 * struct extcon_cable - An internal data for each cable of extcon device.
204 * @edev: The extcon device
205 * @cable_index: Index of this cable in the edev
206 * @attr_g: Attribute group for the cable
207 * @attr_name: "name" sysfs entry
208 * @attr_state: "state" sysfs entry
209 * @attrs: Array pointing to attr_name and attr_state for attr_g
211 struct extcon_cable {
212 struct extcon_dev *edev;
215 struct attribute_group attr_g;
216 struct device_attribute attr_name;
217 struct device_attribute attr_state;
219 struct attribute *attrs[3]; /* to be fed to attr_g.attrs */
221 union extcon_property_value usb_propval[EXTCON_PROP_USB_CNT];
222 union extcon_property_value chg_propval[EXTCON_PROP_CHG_CNT];
223 union extcon_property_value jack_propval[EXTCON_PROP_JACK_CNT];
224 union extcon_property_value disp_propval[EXTCON_PROP_DISP_CNT];
226 unsigned long usb_bits[BITS_TO_LONGS(EXTCON_PROP_USB_CNT)];
227 unsigned long chg_bits[BITS_TO_LONGS(EXTCON_PROP_CHG_CNT)];
228 unsigned long jack_bits[BITS_TO_LONGS(EXTCON_PROP_JACK_CNT)];
229 unsigned long disp_bits[BITS_TO_LONGS(EXTCON_PROP_DISP_CNT)];
232 static struct class *extcon_class;
233 #if defined(CONFIG_ANDROID)
234 static struct class_compat *switch_class;
235 #endif /* CONFIG_ANDROID */
237 static LIST_HEAD(extcon_dev_list);
238 static DEFINE_MUTEX(extcon_dev_list_lock);
241 * check_mutually_exclusive - Check if new_state violates mutually_exclusive
243 * @edev: the extcon device
244 * @new_state: new cable attach status for @edev
246 * Returns 0 if nothing violates. Returns the index + 1 for the first
247 * violated condition.
249 static int check_mutually_exclusive(struct extcon_dev *edev, u32 new_state)
253 if (!edev->mutually_exclusive)
256 for (i = 0; edev->mutually_exclusive[i]; i++) {
258 u32 correspondants = new_state & edev->mutually_exclusive[i];
260 /* calculate the total number of bits set */
261 weight = hweight32(correspondants);
269 static int find_cable_index_by_id(struct extcon_dev *edev, const unsigned int id)
273 /* Find the the index of extcon cable in edev->supported_cable */
274 for (i = 0; i < edev->max_supported; i++) {
275 if (edev->supported_cable[i] == id)
282 static int get_extcon_type(unsigned int prop)
285 case EXTCON_PROP_USB_MIN ... EXTCON_PROP_USB_MAX:
286 return EXTCON_TYPE_USB;
287 case EXTCON_PROP_CHG_MIN ... EXTCON_PROP_CHG_MAX:
288 return EXTCON_TYPE_CHG;
289 case EXTCON_PROP_JACK_MIN ... EXTCON_PROP_JACK_MAX:
290 return EXTCON_TYPE_JACK;
291 case EXTCON_PROP_DISP_MIN ... EXTCON_PROP_DISP_MAX:
292 return EXTCON_TYPE_DISP;
298 static bool is_extcon_attached(struct extcon_dev *edev, unsigned int index)
300 return !!(edev->state & BIT(index));
303 static bool is_extcon_changed(struct extcon_dev *edev, int index,
306 int state = !!(edev->state & BIT(index));
307 return (state != new_state);
310 static bool is_extcon_property_supported(unsigned int id, unsigned int prop)
314 /* Check whether the property is supported or not. */
315 type = get_extcon_type(prop);
319 /* Check whether a specific extcon id supports the property or not. */
320 return !!(extcon_info[id].type & type);
323 static int is_extcon_property_capability(struct extcon_dev *edev,
324 unsigned int id, int index,unsigned int prop)
326 struct extcon_cable *cable;
329 /* Check whether the property is supported or not. */
330 type = get_extcon_type(prop);
334 cable = &edev->cables[index];
337 case EXTCON_TYPE_USB:
338 ret = test_bit(prop - EXTCON_PROP_USB_MIN, cable->usb_bits);
340 case EXTCON_TYPE_CHG:
341 ret = test_bit(prop - EXTCON_PROP_CHG_MIN, cable->chg_bits);
343 case EXTCON_TYPE_JACK:
344 ret = test_bit(prop - EXTCON_PROP_JACK_MIN, cable->jack_bits);
346 case EXTCON_TYPE_DISP:
347 ret = test_bit(prop - EXTCON_PROP_DISP_MIN, cable->disp_bits);
356 static void init_property(struct extcon_dev *edev, unsigned int id, int index)
358 unsigned int type = extcon_info[id].type;
359 struct extcon_cable *cable = &edev->cables[index];
361 if (EXTCON_TYPE_USB & type)
362 memset(cable->usb_propval, 0, sizeof(cable->usb_propval));
363 if (EXTCON_TYPE_CHG & type)
364 memset(cable->chg_propval, 0, sizeof(cable->chg_propval));
365 if (EXTCON_TYPE_JACK & type)
366 memset(cable->jack_propval, 0, sizeof(cable->jack_propval));
367 if (EXTCON_TYPE_DISP & type)
368 memset(cable->disp_propval, 0, sizeof(cable->disp_propval));
371 static ssize_t state_show(struct device *dev, struct device_attribute *attr,
375 struct extcon_dev *edev = dev_get_drvdata(dev);
377 if (edev->max_supported == 0)
378 return sprintf(buf, "%u\n", edev->state);
380 for (i = 0; i < edev->max_supported; i++) {
381 count += sprintf(buf + count, "%s=%d\n",
382 extcon_info[edev->supported_cable[i]].name,
383 !!(edev->state & (1 << i)));
388 static DEVICE_ATTR_RO(state);
390 static ssize_t name_show(struct device *dev, struct device_attribute *attr,
393 struct extcon_dev *edev = dev_get_drvdata(dev);
395 return sprintf(buf, "%s\n", edev->name);
397 static DEVICE_ATTR_RO(name);
399 static ssize_t cable_name_show(struct device *dev,
400 struct device_attribute *attr, char *buf)
402 struct extcon_cable *cable = container_of(attr, struct extcon_cable,
404 int i = cable->cable_index;
406 return sprintf(buf, "%s\n",
407 extcon_info[cable->edev->supported_cable[i]].name);
410 static ssize_t cable_state_show(struct device *dev,
411 struct device_attribute *attr, char *buf)
413 struct extcon_cable *cable = container_of(attr, struct extcon_cable,
416 int i = cable->cable_index;
418 return sprintf(buf, "%d\n",
419 extcon_get_state(cable->edev, cable->edev->supported_cable[i]));
423 * extcon_sync() - Synchronize the states for both the attached/detached
424 * @edev: the extcon device that has the cable.
426 * This function send a notification to synchronize the all states of a
427 * specific external connector
429 int extcon_sync(struct extcon_dev *edev, unsigned int id)
444 index = find_cable_index_by_id(edev, id);
448 spin_lock_irqsave(&edev->lock, flags);
450 state = !!(edev->state & BIT(index));
453 * Call functions in a raw notifier chain for the specific one
454 * external connector.
456 raw_notifier_call_chain(&edev->nh[index], state, edev);
459 * Call functions in a raw notifier chain for the all supported
460 * external connectors.
462 raw_notifier_call_chain(&edev->nh_all, state, edev);
464 /* This could be in interrupt handler */
465 prop_buf = (char *)get_zeroed_page(GFP_ATOMIC);
467 /* Unlock early before uevent */
468 spin_unlock_irqrestore(&edev->lock, flags);
470 dev_err(&edev->dev, "out of memory in extcon_set_state\n");
471 kobject_uevent(&edev->dev.kobj, KOBJ_CHANGE);
476 length = name_show(&edev->dev, NULL, prop_buf);
478 if (prop_buf[length - 1] == '\n')
479 prop_buf[length - 1] = 0;
480 snprintf(name_buf, sizeof(name_buf), "NAME=%s", prop_buf);
481 envp[env_offset++] = name_buf;
484 length = state_show(&edev->dev, NULL, prop_buf);
486 if (prop_buf[length - 1] == '\n')
487 prop_buf[length - 1] = 0;
488 snprintf(state_buf, sizeof(state_buf), "STATE=%s", prop_buf);
489 envp[env_offset++] = state_buf;
491 envp[env_offset] = NULL;
493 /* Unlock early before uevent */
494 spin_unlock_irqrestore(&edev->lock, flags);
495 kobject_uevent_env(&edev->dev.kobj, KOBJ_CHANGE, envp);
496 free_page((unsigned long)prop_buf);
500 EXPORT_SYMBOL_GPL(extcon_sync);
503 * extcon_get_state() - Get the state of a external connector.
504 * @edev: the extcon device that has the cable.
505 * @id: the unique id of each external connector in extcon enumeration.
507 int extcon_get_state(struct extcon_dev *edev, const unsigned int id)
515 index = find_cable_index_by_id(edev, id);
519 spin_lock_irqsave(&edev->lock, flags);
520 state = is_extcon_attached(edev, index);
521 spin_unlock_irqrestore(&edev->lock, flags);
525 EXPORT_SYMBOL_GPL(extcon_get_state);
528 * extcon_set_state() - Set the state of a external connector.
529 * without a notification.
530 * @edev: the extcon device that has the cable.
531 * @id: the unique id of each external connector
532 * in extcon enumeration.
533 * @state: the new cable status. The default semantics is
534 * true: attached / false: detached.
536 * This function only set the state of a external connector without
537 * a notification. To synchronize the data of a external connector,
538 * use extcon_set_state_sync() and extcon_sync().
540 int extcon_set_state(struct extcon_dev *edev, unsigned int id,
549 index = find_cable_index_by_id(edev, id);
553 spin_lock_irqsave(&edev->lock, flags);
555 /* Check whether the external connector's state is changed. */
556 if (!is_extcon_changed(edev, index, cable_state))
559 if (check_mutually_exclusive(edev,
560 (edev->state & ~BIT(index)) | (cable_state & BIT(index)))) {
566 * Initialize the value of extcon property before setting
567 * the detached state for an external connector.
570 init_property(edev, id, index);
572 /* Update the state for a external connector. */
574 edev->state |= BIT(index);
576 edev->state &= ~(BIT(index));
578 spin_unlock_irqrestore(&edev->lock, flags);
582 EXPORT_SYMBOL_GPL(extcon_set_state);
585 * extcon_set_state_sync() - Set the state of a external connector
586 * with a notification.
587 * @edev: the extcon device that has the cable.
588 * @id: the unique id of each external connector
589 * in extcon enumeration.
590 * @state: the new cable status. The default semantics is
591 * true: attached / false: detached.
593 * This function set the state of external connector and synchronize the data
594 * by usning a notification.
596 int extcon_set_state_sync(struct extcon_dev *edev, unsigned int id,
602 index = find_cable_index_by_id(edev, id);
606 /* Check whether the external connector's state is changed. */
607 spin_lock_irqsave(&edev->lock, flags);
608 ret = is_extcon_changed(edev, index, cable_state);
609 spin_unlock_irqrestore(&edev->lock, flags);
613 ret = extcon_set_state(edev, id, cable_state);
617 return extcon_sync(edev, id);
619 EXPORT_SYMBOL_GPL(extcon_set_state_sync);
622 * extcon_get_property() - Get the property value of a specific cable.
623 * @edev: the extcon device that has the cable.
624 * @id: the unique id of each external connector
625 * in extcon enumeration.
626 * @prop: the property id among enum extcon_property.
627 * @prop_val: the pointer which store the value of property.
629 * When getting the property value of external connector, the external connector
630 * should be attached. If detached state, function just return 0 without
631 * property value. Also, the each property should be included in the list of
632 * supported properties according to the type of external connectors.
634 * Returns 0 if success or error number if fail
636 int extcon_get_property(struct extcon_dev *edev, unsigned int id,
638 union extcon_property_value *prop_val)
640 struct extcon_cable *cable;
644 *prop_val = (union extcon_property_value)(0);
649 /* Check whether the property is supported or not */
650 if (!is_extcon_property_supported(id, prop))
653 /* Find the cable index of external connector by using id */
654 index = find_cable_index_by_id(edev, id);
658 spin_lock_irqsave(&edev->lock, flags);
660 /* Check whether the property is available or not. */
661 if (!is_extcon_property_capability(edev, id, index, prop)) {
662 spin_unlock_irqrestore(&edev->lock, flags);
667 * Check whether the external connector is attached.
668 * If external connector is detached, the user can not
669 * get the property value.
671 if (!is_extcon_attached(edev, index)) {
672 spin_unlock_irqrestore(&edev->lock, flags);
676 cable = &edev->cables[index];
678 /* Get the property value according to extcon type */
680 case EXTCON_PROP_USB_MIN ... EXTCON_PROP_USB_MAX:
681 *prop_val = cable->usb_propval[prop - EXTCON_PROP_USB_MIN];
683 case EXTCON_PROP_CHG_MIN ... EXTCON_PROP_CHG_MAX:
684 *prop_val = cable->chg_propval[prop - EXTCON_PROP_CHG_MIN];
686 case EXTCON_PROP_JACK_MIN ... EXTCON_PROP_JACK_MAX:
687 *prop_val = cable->jack_propval[prop - EXTCON_PROP_JACK_MIN];
689 case EXTCON_PROP_DISP_MIN ... EXTCON_PROP_DISP_MAX:
690 *prop_val = cable->disp_propval[prop - EXTCON_PROP_DISP_MIN];
697 spin_unlock_irqrestore(&edev->lock, flags);
701 EXPORT_SYMBOL_GPL(extcon_get_property);
704 * extcon_set_property() - Set the property value of a specific cable.
705 * @edev: the extcon device that has the cable.
706 * @id: the unique id of each external connector
707 * in extcon enumeration.
708 * @prop: the property id among enum extcon_property.
709 * @prop_val: the pointer including the new value of property.
711 * The each property should be included in the list of supported properties
712 * according to the type of external connectors.
714 * Returns 0 if success or error number if fail
716 int extcon_set_property(struct extcon_dev *edev, unsigned int id,
718 union extcon_property_value prop_val)
720 struct extcon_cable *cable;
727 /* Check whether the property is supported or not */
728 if (!is_extcon_property_supported(id, prop))
731 /* Find the cable index of external connector by using id */
732 index = find_cable_index_by_id(edev, id);
736 spin_lock_irqsave(&edev->lock, flags);
738 /* Check whether the property is available or not. */
739 if (!is_extcon_property_capability(edev, id, index, prop)) {
740 spin_unlock_irqrestore(&edev->lock, flags);
744 cable = &edev->cables[index];
746 /* Set the property value according to extcon type */
748 case EXTCON_PROP_USB_MIN ... EXTCON_PROP_USB_MAX:
749 cable->usb_propval[prop - EXTCON_PROP_USB_MIN] = prop_val;
751 case EXTCON_PROP_CHG_MIN ... EXTCON_PROP_CHG_MAX:
752 cable->chg_propval[prop - EXTCON_PROP_CHG_MIN] = prop_val;
754 case EXTCON_PROP_JACK_MIN ... EXTCON_PROP_JACK_MAX:
755 cable->jack_propval[prop - EXTCON_PROP_JACK_MIN] = prop_val;
757 case EXTCON_PROP_DISP_MIN ... EXTCON_PROP_DISP_MAX:
758 cable->disp_propval[prop - EXTCON_PROP_DISP_MIN] = prop_val;
765 spin_unlock_irqrestore(&edev->lock, flags);
769 EXPORT_SYMBOL_GPL(extcon_set_property);
772 * extcon_set_property_sync() - Set the property value of a specific cable
774 * @prop_val: the pointer including the new value of property.
776 * When setting the property value of external connector, the external connector
777 * should be attached. The each property should be included in the list of
778 * supported properties according to the type of external connectors.
780 * Returns 0 if success or error number if fail
782 int extcon_set_property_sync(struct extcon_dev *edev, unsigned int id,
784 union extcon_property_value prop_val)
788 ret = extcon_set_property(edev, id, prop, prop_val);
792 return extcon_sync(edev, id);
794 EXPORT_SYMBOL_GPL(extcon_set_property_sync);
797 * extcon_get_property_capability() - Get the capability of property
798 * of an external connector.
799 * @edev: the extcon device that has the cable.
800 * @id: the unique id of each external connector
801 * in extcon enumeration.
802 * @prop: the property id among enum extcon_property.
804 * Returns 1 if the property is available or 0 if not available.
806 int extcon_get_property_capability(struct extcon_dev *edev, unsigned int id,
814 /* Check whether the property is supported or not */
815 if (!is_extcon_property_supported(id, prop))
818 /* Find the cable index of external connector by using id */
819 index = find_cable_index_by_id(edev, id);
823 return is_extcon_property_capability(edev, id, index, prop);
825 EXPORT_SYMBOL_GPL(extcon_get_property_capability);
828 * extcon_set_property_capability() - Set the capability of a property
829 * of an external connector.
830 * @edev: the extcon device that has the cable.
831 * @id: the unique id of each external connector
832 * in extcon enumeration.
833 * @prop: the property id among enum extcon_property.
835 * This function set the capability of a property for an external connector
836 * to mark the bit in capability bitmap which mean the available state of
839 * Returns 0 if success or error number if fail
841 int extcon_set_property_capability(struct extcon_dev *edev, unsigned int id,
844 struct extcon_cable *cable;
845 int index, type, ret = 0;
850 /* Check whether the property is supported or not. */
851 if (!is_extcon_property_supported(id, prop))
854 /* Find the cable index of external connector by using id. */
855 index = find_cable_index_by_id(edev, id);
859 type = get_extcon_type(prop);
863 cable = &edev->cables[index];
866 case EXTCON_TYPE_USB:
867 __set_bit(prop - EXTCON_PROP_USB_MIN, cable->usb_bits);
869 case EXTCON_TYPE_CHG:
870 __set_bit(prop - EXTCON_PROP_CHG_MIN, cable->chg_bits);
872 case EXTCON_TYPE_JACK:
873 __set_bit(prop - EXTCON_PROP_JACK_MIN, cable->jack_bits);
875 case EXTCON_TYPE_DISP:
876 __set_bit(prop - EXTCON_PROP_DISP_MIN, cable->disp_bits);
884 EXPORT_SYMBOL_GPL(extcon_set_property_capability);
887 * extcon_get_extcon_dev() - Get the extcon device instance from the name
888 * @extcon_name: The extcon name provided with extcon_dev_register()
890 struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name)
892 struct extcon_dev *sd;
895 return ERR_PTR(-EINVAL);
897 mutex_lock(&extcon_dev_list_lock);
898 list_for_each_entry(sd, &extcon_dev_list, entry) {
899 if (!strcmp(sd->name, extcon_name))
904 mutex_unlock(&extcon_dev_list_lock);
907 EXPORT_SYMBOL_GPL(extcon_get_extcon_dev);
910 * extcon_register_notifier() - Register a notifiee to get notified by
911 * any attach status changes from the extcon.
912 * @edev: the extcon device that has the external connecotr.
913 * @id: the unique id of each external connector in extcon enumeration.
914 * @nb: a notifier block to be registered.
916 * Note that the second parameter given to the callback of nb (val) is
917 * "old_state", not the current state. The current state can be retrieved
918 * by looking at the third pameter (edev pointer)'s state value.
920 int extcon_register_notifier(struct extcon_dev *edev, unsigned int id,
921 struct notifier_block *nb)
924 int ret, idx = -EINVAL;
929 idx = find_cable_index_by_id(edev, id);
933 spin_lock_irqsave(&edev->lock, flags);
934 ret = raw_notifier_chain_register(&edev->nh[idx], nb);
935 spin_unlock_irqrestore(&edev->lock, flags);
939 EXPORT_SYMBOL_GPL(extcon_register_notifier);
942 * extcon_unregister_notifier() - Unregister a notifiee from the extcon device.
943 * @edev: the extcon device that has the external connecotr.
944 * @id: the unique id of each external connector in extcon enumeration.
945 * @nb: a notifier block to be registered.
947 int extcon_unregister_notifier(struct extcon_dev *edev, unsigned int id,
948 struct notifier_block *nb)
956 idx = find_cable_index_by_id(edev, id);
960 spin_lock_irqsave(&edev->lock, flags);
961 ret = raw_notifier_chain_unregister(&edev->nh[idx], nb);
962 spin_unlock_irqrestore(&edev->lock, flags);
966 EXPORT_SYMBOL_GPL(extcon_unregister_notifier);
969 * extcon_register_notifier_all() - Register a notifier block for all connectors
970 * @edev: the extcon device that has the external connecotr.
971 * @nb: a notifier block to be registered.
973 * This fucntion registers a notifier block in order to receive the state
974 * change of all supported external connectors from extcon device.
975 * And The second parameter given to the callback of nb (val) is
976 * the current state and third parameter is the edev pointer.
978 * Returns 0 if success or error number if fail
980 int extcon_register_notifier_all(struct extcon_dev *edev,
981 struct notifier_block *nb)
989 spin_lock_irqsave(&edev->lock, flags);
990 ret = raw_notifier_chain_register(&edev->nh_all, nb);
991 spin_unlock_irqrestore(&edev->lock, flags);
995 EXPORT_SYMBOL_GPL(extcon_register_notifier_all);
998 * extcon_unregister_notifier_all() - Unregister a notifier block from extcon.
999 * @edev: the extcon device that has the external connecotr.
1000 * @nb: a notifier block to be registered.
1002 * Returns 0 if success or error number if fail
1004 int extcon_unregister_notifier_all(struct extcon_dev *edev,
1005 struct notifier_block *nb)
1007 unsigned long flags;
1013 spin_lock_irqsave(&edev->lock, flags);
1014 ret = raw_notifier_chain_unregister(&edev->nh_all, nb);
1015 spin_unlock_irqrestore(&edev->lock, flags);
1019 EXPORT_SYMBOL_GPL(extcon_unregister_notifier_all);
1021 static struct attribute *extcon_attrs[] = {
1022 &dev_attr_state.attr,
1023 &dev_attr_name.attr,
1026 ATTRIBUTE_GROUPS(extcon);
1028 static int create_extcon_class(void)
1030 if (!extcon_class) {
1031 extcon_class = class_create(THIS_MODULE, "extcon");
1032 if (IS_ERR(extcon_class))
1033 return PTR_ERR(extcon_class);
1034 extcon_class->dev_groups = extcon_groups;
1036 #if defined(CONFIG_ANDROID)
1037 switch_class = class_compat_register("switch");
1038 if (WARN(!switch_class, "cannot allocate"))
1040 #endif /* CONFIG_ANDROID */
1046 static void extcon_dev_release(struct device *dev)
1050 static const char *muex_name = "mutually_exclusive";
1051 static void dummy_sysfs_dev_release(struct device *dev)
1056 * extcon_dev_allocate() - Allocate the memory of extcon device.
1057 * @supported_cable: Array of supported extcon ending with EXTCON_NONE.
1058 * If supported_cable is NULL, cable name related APIs
1061 * This function allocates the memory for extcon device without allocating
1062 * memory in each extcon provider driver and initialize default setting for
1065 * Return the pointer of extcon device if success or ERR_PTR(err) if fail
1067 struct extcon_dev *extcon_dev_allocate(const unsigned int *supported_cable)
1069 struct extcon_dev *edev;
1071 if (!supported_cable)
1072 return ERR_PTR(-EINVAL);
1074 edev = kzalloc(sizeof(*edev), GFP_KERNEL);
1076 return ERR_PTR(-ENOMEM);
1078 edev->max_supported = 0;
1079 edev->supported_cable = supported_cable;
1085 * extcon_dev_free() - Free the memory of extcon device.
1086 * @edev: the extcon device to free
1088 void extcon_dev_free(struct extcon_dev *edev)
1092 EXPORT_SYMBOL_GPL(extcon_dev_free);
1095 * extcon_dev_register() - Register a new extcon device
1096 * @edev : the new extcon device (should be allocated before calling)
1098 * Among the members of edev struct, please set the "user initializing data"
1099 * in any case and set the "optional callbacks" if required. However, please
1100 * do not set the values of "internal data", which are initialized by
1103 int extcon_dev_register(struct extcon_dev *edev)
1106 static atomic_t edev_no = ATOMIC_INIT(-1);
1108 if (!extcon_class) {
1109 ret = create_extcon_class();
1114 if (!edev || !edev->supported_cable)
1117 for (; edev->supported_cable[index] != EXTCON_NONE; index++);
1119 edev->max_supported = index;
1120 if (index > SUPPORTED_CABLE_MAX) {
1122 "exceed the maximum number of supported cables\n");
1126 edev->dev.class = extcon_class;
1127 edev->dev.release = extcon_dev_release;
1129 edev->name = dev_name(edev->dev.parent);
1130 if (IS_ERR_OR_NULL(edev->name)) {
1132 "extcon device name is null\n");
1135 dev_set_name(&edev->dev, "extcon%lu",
1136 (unsigned long)atomic_inc_return(&edev_no));
1138 if (edev->max_supported) {
1141 struct extcon_cable *cable;
1143 edev->cables = kzalloc(sizeof(struct extcon_cable) *
1144 edev->max_supported, GFP_KERNEL);
1145 if (!edev->cables) {
1147 goto err_sysfs_alloc;
1149 for (index = 0; index < edev->max_supported; index++) {
1150 cable = &edev->cables[index];
1152 snprintf(buf, 10, "cable.%d", index);
1153 str = kzalloc(sizeof(char) * (strlen(buf) + 1),
1156 for (index--; index >= 0; index--) {
1157 cable = &edev->cables[index];
1158 kfree(cable->attr_g.name);
1162 goto err_alloc_cables;
1167 cable->cable_index = index;
1168 cable->attrs[0] = &cable->attr_name.attr;
1169 cable->attrs[1] = &cable->attr_state.attr;
1170 cable->attrs[2] = NULL;
1171 cable->attr_g.name = str;
1172 cable->attr_g.attrs = cable->attrs;
1174 sysfs_attr_init(&cable->attr_name.attr);
1175 cable->attr_name.attr.name = "name";
1176 cable->attr_name.attr.mode = 0444;
1177 cable->attr_name.show = cable_name_show;
1179 sysfs_attr_init(&cable->attr_state.attr);
1180 cable->attr_state.attr.name = "state";
1181 cable->attr_state.attr.mode = 0444;
1182 cable->attr_state.show = cable_state_show;
1186 if (edev->max_supported && edev->mutually_exclusive) {
1190 /* Count the size of mutually_exclusive array */
1191 for (index = 0; edev->mutually_exclusive[index]; index++)
1194 edev->attrs_muex = kzalloc(sizeof(struct attribute *) *
1195 (index + 1), GFP_KERNEL);
1196 if (!edev->attrs_muex) {
1201 edev->d_attrs_muex = kzalloc(sizeof(struct device_attribute) *
1203 if (!edev->d_attrs_muex) {
1205 kfree(edev->attrs_muex);
1209 for (index = 0; edev->mutually_exclusive[index]; index++) {
1210 sprintf(buf, "0x%x", edev->mutually_exclusive[index]);
1211 name = kzalloc(sizeof(char) * (strlen(buf) + 1),
1214 for (index--; index >= 0; index--) {
1215 kfree(edev->d_attrs_muex[index].attr.
1218 kfree(edev->d_attrs_muex);
1219 kfree(edev->attrs_muex);
1224 sysfs_attr_init(&edev->d_attrs_muex[index].attr);
1225 edev->d_attrs_muex[index].attr.name = name;
1226 edev->d_attrs_muex[index].attr.mode = 0000;
1227 edev->attrs_muex[index] = &edev->d_attrs_muex[index]
1230 edev->attr_g_muex.name = muex_name;
1231 edev->attr_g_muex.attrs = edev->attrs_muex;
1235 if (edev->max_supported) {
1236 edev->extcon_dev_type.groups =
1237 kzalloc(sizeof(struct attribute_group *) *
1238 (edev->max_supported + 2), GFP_KERNEL);
1239 if (!edev->extcon_dev_type.groups) {
1241 goto err_alloc_groups;
1244 edev->extcon_dev_type.name = dev_name(&edev->dev);
1245 edev->extcon_dev_type.release = dummy_sysfs_dev_release;
1247 for (index = 0; index < edev->max_supported; index++)
1248 edev->extcon_dev_type.groups[index] =
1249 &edev->cables[index].attr_g;
1250 if (edev->mutually_exclusive)
1251 edev->extcon_dev_type.groups[index] =
1254 edev->dev.type = &edev->extcon_dev_type;
1257 ret = device_register(&edev->dev);
1259 put_device(&edev->dev);
1262 #if defined(CONFIG_ANDROID)
1264 ret = class_compat_create_link(switch_class, &edev->dev, NULL);
1265 #endif /* CONFIG_ANDROID */
1267 spin_lock_init(&edev->lock);
1269 edev->nh = devm_kzalloc(&edev->dev,
1270 sizeof(*edev->nh) * edev->max_supported, GFP_KERNEL);
1276 for (index = 0; index < edev->max_supported; index++)
1277 RAW_INIT_NOTIFIER_HEAD(&edev->nh[index]);
1279 RAW_INIT_NOTIFIER_HEAD(&edev->nh_all);
1281 dev_set_drvdata(&edev->dev, edev);
1284 mutex_lock(&extcon_dev_list_lock);
1285 list_add(&edev->entry, &extcon_dev_list);
1286 mutex_unlock(&extcon_dev_list_lock);
1291 if (edev->max_supported)
1292 kfree(edev->extcon_dev_type.groups);
1294 if (edev->max_supported && edev->mutually_exclusive) {
1295 for (index = 0; edev->mutually_exclusive[index]; index++)
1296 kfree(edev->d_attrs_muex[index].attr.name);
1297 kfree(edev->d_attrs_muex);
1298 kfree(edev->attrs_muex);
1301 for (index = 0; index < edev->max_supported; index++)
1302 kfree(edev->cables[index].attr_g.name);
1304 if (edev->max_supported)
1305 kfree(edev->cables);
1309 EXPORT_SYMBOL_GPL(extcon_dev_register);
1312 * extcon_dev_unregister() - Unregister the extcon device.
1313 * @edev: the extcon device instance to be unregistered.
1315 * Note that this does not call kfree(edev) because edev was not allocated
1318 void extcon_dev_unregister(struct extcon_dev *edev)
1325 mutex_lock(&extcon_dev_list_lock);
1326 list_del(&edev->entry);
1327 mutex_unlock(&extcon_dev_list_lock);
1329 if (IS_ERR_OR_NULL(get_device(&edev->dev))) {
1330 dev_err(&edev->dev, "Failed to unregister extcon_dev (%s)\n",
1331 dev_name(&edev->dev));
1335 device_unregister(&edev->dev);
1337 if (edev->mutually_exclusive && edev->max_supported) {
1338 for (index = 0; edev->mutually_exclusive[index];
1340 kfree(edev->d_attrs_muex[index].attr.name);
1341 kfree(edev->d_attrs_muex);
1342 kfree(edev->attrs_muex);
1345 for (index = 0; index < edev->max_supported; index++)
1346 kfree(edev->cables[index].attr_g.name);
1348 if (edev->max_supported) {
1349 kfree(edev->extcon_dev_type.groups);
1350 kfree(edev->cables);
1353 #if defined(CONFIG_ANDROID)
1355 class_compat_remove_link(switch_class, &edev->dev, NULL);
1357 put_device(&edev->dev);
1359 EXPORT_SYMBOL_GPL(extcon_dev_unregister);
1363 * extcon_get_edev_by_phandle - Get the extcon device from devicetree
1364 * @dev - instance to the given device
1365 * @index - index into list of extcon_dev
1367 * return the instance of extcon device
1369 struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev, int index)
1371 struct device_node *node;
1372 struct extcon_dev *edev;
1375 return ERR_PTR(-EINVAL);
1377 if (!dev->of_node) {
1378 dev_dbg(dev, "device does not have a device node entry\n");
1379 return ERR_PTR(-EINVAL);
1382 node = of_parse_phandle(dev->of_node, "extcon", index);
1384 dev_dbg(dev, "failed to get phandle in %s node\n",
1385 dev->of_node->full_name);
1386 return ERR_PTR(-ENODEV);
1389 mutex_lock(&extcon_dev_list_lock);
1390 list_for_each_entry(edev, &extcon_dev_list, entry) {
1391 if (edev->dev.parent && edev->dev.parent->of_node == node) {
1392 mutex_unlock(&extcon_dev_list_lock);
1397 mutex_unlock(&extcon_dev_list_lock);
1400 return ERR_PTR(-EPROBE_DEFER);
1403 struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev, int index)
1405 return ERR_PTR(-ENOSYS);
1407 #endif /* CONFIG_OF */
1408 EXPORT_SYMBOL_GPL(extcon_get_edev_by_phandle);
1411 * extcon_get_edev_name() - Get the name of the extcon device.
1412 * @edev: the extcon device
1414 const char *extcon_get_edev_name(struct extcon_dev *edev)
1416 return !edev ? NULL : edev->name;
1419 static int __init extcon_class_init(void)
1421 return create_extcon_class();
1423 module_init(extcon_class_init);
1425 static void __exit extcon_class_exit(void)
1427 #if defined(CONFIG_ANDROID)
1428 class_compat_unregister(switch_class);
1430 class_destroy(extcon_class);
1432 module_exit(extcon_class_exit);
1434 MODULE_AUTHOR("Chanwoo Choi <cw00.choi@samsung.com>");
1435 MODULE_AUTHOR("Mike Lockwood <lockwood@android.com>");
1436 MODULE_AUTHOR("Donggeun Kim <dg77.kim@samsung.com>");
1437 MODULE_AUTHOR("MyungJoo Ham <myungjoo.ham@samsung.com>");
1438 MODULE_DESCRIPTION("External connector (extcon) class driver");
1439 MODULE_LICENSE("GPL");