1 // SPDX-License-Identifier: GPL-2.0-only
3 * drivers/extcon/extcon.c - External Connector (extcon) framework.
5 * Copyright (C) 2015 Samsung Electronics
6 * Author: Chanwoo Choi <cw00.choi@samsung.com>
8 * Copyright (C) 2012 Samsung Electronics
9 * Author: Donggeun Kim <dg77.kim@samsung.com>
10 * Author: MyungJoo Ham <myungjoo.ham@samsung.com>
12 * based on android/drivers/switch/switch_class.c
13 * Copyright (C) 2008 Google, Inc.
14 * Author: Mike Lockwood <lockwood@android.com>
17 #include <linux/module.h>
18 #include <linux/types.h>
19 #include <linux/idr.h>
20 #include <linux/init.h>
21 #include <linux/device.h>
23 #include <linux/err.h>
25 #include <linux/slab.h>
26 #include <linux/sysfs.h>
30 #define SUPPORTED_CABLE_MAX 32
32 static const struct __extcon_info {
39 .type = EXTCON_TYPE_MISC,
44 /* USB external connector */
46 .type = EXTCON_TYPE_USB,
51 .type = EXTCON_TYPE_USB,
52 .id = EXTCON_USB_HOST,
56 /* Charging external connector */
57 [EXTCON_CHG_USB_SDP] = {
58 .type = EXTCON_TYPE_CHG | EXTCON_TYPE_USB,
59 .id = EXTCON_CHG_USB_SDP,
62 [EXTCON_CHG_USB_DCP] = {
63 .type = EXTCON_TYPE_CHG | EXTCON_TYPE_USB,
64 .id = EXTCON_CHG_USB_DCP,
67 [EXTCON_CHG_USB_CDP] = {
68 .type = EXTCON_TYPE_CHG | EXTCON_TYPE_USB,
69 .id = EXTCON_CHG_USB_CDP,
72 [EXTCON_CHG_USB_ACA] = {
73 .type = EXTCON_TYPE_CHG | EXTCON_TYPE_USB,
74 .id = EXTCON_CHG_USB_ACA,
77 [EXTCON_CHG_USB_FAST] = {
78 .type = EXTCON_TYPE_CHG | EXTCON_TYPE_USB,
79 .id = EXTCON_CHG_USB_FAST,
80 .name = "FAST-CHARGER",
82 [EXTCON_CHG_USB_SLOW] = {
83 .type = EXTCON_TYPE_CHG | EXTCON_TYPE_USB,
84 .id = EXTCON_CHG_USB_SLOW,
85 .name = "SLOW-CHARGER",
88 .type = EXTCON_TYPE_CHG,
92 [EXTCON_CHG_USB_PD] = {
93 .type = EXTCON_TYPE_CHG | EXTCON_TYPE_USB,
94 .id = EXTCON_CHG_USB_PD,
98 /* Jack external connector */
99 [EXTCON_JACK_MICROPHONE] = {
100 .type = EXTCON_TYPE_JACK,
101 .id = EXTCON_JACK_MICROPHONE,
102 .name = "MICROPHONE",
104 [EXTCON_JACK_HEADPHONE] = {
105 .type = EXTCON_TYPE_JACK,
106 .id = EXTCON_JACK_HEADPHONE,
109 [EXTCON_JACK_LINE_IN] = {
110 .type = EXTCON_TYPE_JACK,
111 .id = EXTCON_JACK_LINE_IN,
114 [EXTCON_JACK_LINE_OUT] = {
115 .type = EXTCON_TYPE_JACK,
116 .id = EXTCON_JACK_LINE_OUT,
119 [EXTCON_JACK_VIDEO_IN] = {
120 .type = EXTCON_TYPE_JACK,
121 .id = EXTCON_JACK_VIDEO_IN,
124 [EXTCON_JACK_VIDEO_OUT] = {
125 .type = EXTCON_TYPE_JACK,
126 .id = EXTCON_JACK_VIDEO_OUT,
129 [EXTCON_JACK_SPDIF_IN] = {
130 .type = EXTCON_TYPE_JACK,
131 .id = EXTCON_JACK_SPDIF_IN,
134 [EXTCON_JACK_SPDIF_OUT] = {
135 .type = EXTCON_TYPE_JACK,
136 .id = EXTCON_JACK_SPDIF_OUT,
140 /* Display external connector */
141 [EXTCON_DISP_HDMI] = {
142 .type = EXTCON_TYPE_DISP,
143 .id = EXTCON_DISP_HDMI,
146 [EXTCON_DISP_MHL] = {
147 .type = EXTCON_TYPE_DISP,
148 .id = EXTCON_DISP_MHL,
151 [EXTCON_DISP_DVI] = {
152 .type = EXTCON_TYPE_DISP,
153 .id = EXTCON_DISP_DVI,
156 [EXTCON_DISP_VGA] = {
157 .type = EXTCON_TYPE_DISP,
158 .id = EXTCON_DISP_VGA,
162 .type = EXTCON_TYPE_DISP | EXTCON_TYPE_USB,
163 .id = EXTCON_DISP_DP,
166 [EXTCON_DISP_HMD] = {
167 .type = EXTCON_TYPE_DISP | EXTCON_TYPE_USB,
168 .id = EXTCON_DISP_HMD,
171 [EXTCON_DISP_CVBS] = {
172 .type = EXTCON_TYPE_DISP,
173 .id = EXTCON_DISP_CVBS,
176 [EXTCON_DISP_EDP] = {
177 .type = EXTCON_TYPE_DISP,
178 .id = EXTCON_DISP_EDP,
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 an external connector.
204 * @edev: the extcon device
205 * @cable_index: the index of this cable in the edev
206 * @attr_g: the attribute group for the cable
207 * @attr_name: "name" sysfs entry
208 * @attr_state: "state" sysfs entry
209 * @attrs: the array pointing to attr_name and attr_state for attr_g
210 * @usb_propval: the array of USB connector properties
211 * @chg_propval: the array of charger connector properties
212 * @jack_propval: the array of jack connector properties
213 * @disp_propval: the array of display connector properties
214 * @usb_bits: the bit array of the USB connector property capabilities
215 * @chg_bits: the bit array of the charger connector property capabilities
216 * @jack_bits: the bit array of the jack connector property capabilities
217 * @disp_bits: the bit array of the display connector property capabilities
219 struct extcon_cable {
220 struct extcon_dev *edev;
223 struct attribute_group attr_g;
224 struct device_attribute attr_name;
225 struct device_attribute attr_state;
227 struct attribute *attrs[3]; /* to be fed to attr_g.attrs */
229 union extcon_property_value usb_propval[EXTCON_PROP_USB_CNT];
230 union extcon_property_value chg_propval[EXTCON_PROP_CHG_CNT];
231 union extcon_property_value jack_propval[EXTCON_PROP_JACK_CNT];
232 union extcon_property_value disp_propval[EXTCON_PROP_DISP_CNT];
234 DECLARE_BITMAP(usb_bits, EXTCON_PROP_USB_CNT);
235 DECLARE_BITMAP(chg_bits, EXTCON_PROP_CHG_CNT);
236 DECLARE_BITMAP(jack_bits, EXTCON_PROP_JACK_CNT);
237 DECLARE_BITMAP(disp_bits, EXTCON_PROP_DISP_CNT);
240 static struct class *extcon_class;
242 static DEFINE_IDA(extcon_dev_ids);
243 static LIST_HEAD(extcon_dev_list);
244 static DEFINE_MUTEX(extcon_dev_list_lock);
246 static int check_mutually_exclusive(struct extcon_dev *edev, u32 new_state)
250 if (!edev->mutually_exclusive)
253 for (i = 0; edev->mutually_exclusive[i]; i++) {
255 u32 correspondants = new_state & edev->mutually_exclusive[i];
257 /* calculate the total number of bits set */
258 weight = hweight32(correspondants);
266 static int find_cable_index_by_id(struct extcon_dev *edev, const unsigned int id)
270 /* Find the index of extcon cable in edev->supported_cable */
271 for (i = 0; i < edev->max_supported; i++) {
272 if (edev->supported_cable[i] == id)
279 static int get_extcon_type(unsigned int prop)
282 case EXTCON_PROP_USB_MIN ... EXTCON_PROP_USB_MAX:
283 return EXTCON_TYPE_USB;
284 case EXTCON_PROP_CHG_MIN ... EXTCON_PROP_CHG_MAX:
285 return EXTCON_TYPE_CHG;
286 case EXTCON_PROP_JACK_MIN ... EXTCON_PROP_JACK_MAX:
287 return EXTCON_TYPE_JACK;
288 case EXTCON_PROP_DISP_MIN ... EXTCON_PROP_DISP_MAX:
289 return EXTCON_TYPE_DISP;
295 static bool is_extcon_attached(struct extcon_dev *edev, unsigned int index)
297 return !!(edev->state & BIT(index));
300 static bool is_extcon_changed(struct extcon_dev *edev, int index,
303 int state = !!(edev->state & BIT(index));
304 return (state != new_state);
307 static bool is_extcon_property_supported(unsigned int id, unsigned int prop)
311 /* Check whether the property is supported or not. */
312 type = get_extcon_type(prop);
316 /* Check whether a specific extcon id supports the property or not. */
317 return !!(extcon_info[id].type & type);
320 static int is_extcon_property_capability(struct extcon_dev *edev,
321 unsigned int id, int index,unsigned int prop)
323 struct extcon_cable *cable;
326 /* Check whether the property is supported or not. */
327 type = get_extcon_type(prop);
331 cable = &edev->cables[index];
334 case EXTCON_TYPE_USB:
335 ret = test_bit(prop - EXTCON_PROP_USB_MIN, cable->usb_bits);
337 case EXTCON_TYPE_CHG:
338 ret = test_bit(prop - EXTCON_PROP_CHG_MIN, cable->chg_bits);
340 case EXTCON_TYPE_JACK:
341 ret = test_bit(prop - EXTCON_PROP_JACK_MIN, cable->jack_bits);
343 case EXTCON_TYPE_DISP:
344 ret = test_bit(prop - EXTCON_PROP_DISP_MIN, cable->disp_bits);
353 static void init_property(struct extcon_dev *edev, unsigned int id, int index)
355 unsigned int type = extcon_info[id].type;
356 struct extcon_cable *cable = &edev->cables[index];
358 if (EXTCON_TYPE_USB & type)
359 memset(cable->usb_propval, 0, sizeof(cable->usb_propval));
360 if (EXTCON_TYPE_CHG & type)
361 memset(cable->chg_propval, 0, sizeof(cable->chg_propval));
362 if (EXTCON_TYPE_JACK & type)
363 memset(cable->jack_propval, 0, sizeof(cable->jack_propval));
364 if (EXTCON_TYPE_DISP & type)
365 memset(cable->disp_propval, 0, sizeof(cable->disp_propval));
368 static ssize_t state_show(struct device *dev, struct device_attribute *attr,
372 struct extcon_dev *edev = dev_get_drvdata(dev);
374 if (edev->max_supported == 0)
375 return sysfs_emit(buf, "%u\n", edev->state);
377 for (i = 0; i < edev->max_supported; i++) {
378 count += sysfs_emit_at(buf, count, "%s=%d\n",
379 extcon_info[edev->supported_cable[i]].name,
380 !!(edev->state & BIT(i)));
385 static DEVICE_ATTR_RO(state);
387 static ssize_t name_show(struct device *dev, struct device_attribute *attr,
390 struct extcon_dev *edev = dev_get_drvdata(dev);
392 return sysfs_emit(buf, "%s\n", edev->name);
394 static DEVICE_ATTR_RO(name);
396 static ssize_t cable_name_show(struct device *dev,
397 struct device_attribute *attr, char *buf)
399 struct extcon_cable *cable = container_of(attr, struct extcon_cable,
401 int i = cable->cable_index;
403 return sysfs_emit(buf, "%s\n",
404 extcon_info[cable->edev->supported_cable[i]].name);
407 static ssize_t cable_state_show(struct device *dev,
408 struct device_attribute *attr, char *buf)
410 struct extcon_cable *cable = container_of(attr, struct extcon_cable,
413 int i = cable->cable_index;
415 return sysfs_emit(buf, "%d\n",
416 extcon_get_state(cable->edev, cable->edev->supported_cable[i]));
420 * extcon_sync() - Synchronize the state for an external connector.
421 * @edev: the extcon device
422 * @id: the unique id indicating an external connector
424 * Note that this function send a notification in order to synchronize
425 * the state and property of an external connector.
427 * Returns 0 if success or error number if fail.
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);
449 state = !!(edev->state & BIT(index));
450 spin_unlock_irqrestore(&edev->lock, flags);
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 spin_lock_irqsave(&edev->lock, flags);
465 /* This could be in interrupt handler */
466 prop_buf = (char *)get_zeroed_page(GFP_ATOMIC);
468 /* Unlock early before uevent */
469 spin_unlock_irqrestore(&edev->lock, flags);
471 dev_err(&edev->dev, "out of memory in extcon_set_state\n");
472 kobject_uevent(&edev->dev.kobj, KOBJ_CHANGE);
477 length = name_show(&edev->dev, NULL, prop_buf);
479 if (prop_buf[length - 1] == '\n')
480 prop_buf[length - 1] = 0;
481 snprintf(name_buf, sizeof(name_buf), "NAME=%s", prop_buf);
482 envp[env_offset++] = name_buf;
485 length = state_show(&edev->dev, NULL, prop_buf);
487 if (prop_buf[length - 1] == '\n')
488 prop_buf[length - 1] = 0;
489 snprintf(state_buf, sizeof(state_buf), "STATE=%s", prop_buf);
490 envp[env_offset++] = state_buf;
492 envp[env_offset] = NULL;
494 /* Unlock early before uevent */
495 spin_unlock_irqrestore(&edev->lock, flags);
496 kobject_uevent_env(&edev->dev.kobj, KOBJ_CHANGE, envp);
497 free_page((unsigned long)prop_buf);
501 EXPORT_SYMBOL_GPL(extcon_sync);
504 * extcon_get_state() - Get the state of an external connector.
505 * @edev: the extcon device
506 * @id: the unique id indicating an external connector
508 * Returns 0 if success or error number if fail.
510 int extcon_get_state(struct extcon_dev *edev, const unsigned int id)
518 index = find_cable_index_by_id(edev, id);
522 spin_lock_irqsave(&edev->lock, flags);
523 state = is_extcon_attached(edev, index);
524 spin_unlock_irqrestore(&edev->lock, flags);
528 EXPORT_SYMBOL_GPL(extcon_get_state);
531 * extcon_set_state() - Set the state of an external connector.
532 * @edev: the extcon device
533 * @id: the unique id indicating an external connector
534 * @state: the new state of an external connector.
535 * the default semantics is true: attached / false: detached.
537 * Note that this function set the state of an external connector without
538 * a notification. To synchronize the state of an external connector,
539 * have to use extcon_set_state_sync() and extcon_sync().
541 * Returns 0 if success or error number if fail.
543 int extcon_set_state(struct extcon_dev *edev, unsigned int id, bool state)
551 index = find_cable_index_by_id(edev, id);
555 spin_lock_irqsave(&edev->lock, flags);
557 /* Check whether the external connector's state is changed. */
558 if (!is_extcon_changed(edev, index, state))
561 if (check_mutually_exclusive(edev,
562 (edev->state & ~BIT(index)) | (state & BIT(index)))) {
568 * Initialize the value of extcon property before setting
569 * the detached state for an external connector.
572 init_property(edev, id, index);
574 /* Update the state for an external connector. */
576 edev->state |= BIT(index);
578 edev->state &= ~(BIT(index));
580 spin_unlock_irqrestore(&edev->lock, flags);
584 EXPORT_SYMBOL_GPL(extcon_set_state);
587 * extcon_set_state_sync() - Set the state of an external connector with sync.
588 * @edev: the extcon device
589 * @id: the unique id indicating an external connector
590 * @state: the new state of external connector.
591 * the default semantics is true: attached / false: detached.
593 * Note that this function set the state of external connector
594 * and synchronize the state by sending a notification.
596 * Returns 0 if success or error number if fail.
598 int extcon_set_state_sync(struct extcon_dev *edev, unsigned int id, bool state)
602 ret = extcon_set_state(edev, id, state);
606 return extcon_sync(edev, id);
608 EXPORT_SYMBOL_GPL(extcon_set_state_sync);
611 * extcon_get_property() - Get the property value of an external connector.
612 * @edev: the extcon device
613 * @id: the unique id indicating an external connector
614 * @prop: the property id indicating an extcon property
615 * @prop_val: the pointer which store the value of extcon property
617 * Note that when getting the property value of external connector,
618 * the external connector should be attached. If detached state, function
619 * return 0 without property value. Also, the each property should be
620 * included in the list of supported properties according to extcon type.
622 * Returns 0 if success or error number if fail.
624 int extcon_get_property(struct extcon_dev *edev, unsigned int id,
626 union extcon_property_value *prop_val)
628 struct extcon_cable *cable;
632 *prop_val = (union extcon_property_value){0};
637 /* Check whether the property is supported or not */
638 if (!is_extcon_property_supported(id, prop))
641 /* Find the cable index of external connector by using id */
642 index = find_cable_index_by_id(edev, id);
646 spin_lock_irqsave(&edev->lock, flags);
648 /* Check whether the property is available or not. */
649 if (!is_extcon_property_capability(edev, id, index, prop)) {
650 spin_unlock_irqrestore(&edev->lock, flags);
655 * Check whether the external connector is attached.
656 * If external connector is detached, the user can not
657 * get the property value.
659 if (!is_extcon_attached(edev, index)) {
660 spin_unlock_irqrestore(&edev->lock, flags);
664 cable = &edev->cables[index];
666 /* Get the property value according to extcon type */
668 case EXTCON_PROP_USB_MIN ... EXTCON_PROP_USB_MAX:
669 *prop_val = cable->usb_propval[prop - EXTCON_PROP_USB_MIN];
671 case EXTCON_PROP_CHG_MIN ... EXTCON_PROP_CHG_MAX:
672 *prop_val = cable->chg_propval[prop - EXTCON_PROP_CHG_MIN];
674 case EXTCON_PROP_JACK_MIN ... EXTCON_PROP_JACK_MAX:
675 *prop_val = cable->jack_propval[prop - EXTCON_PROP_JACK_MIN];
677 case EXTCON_PROP_DISP_MIN ... EXTCON_PROP_DISP_MAX:
678 *prop_val = cable->disp_propval[prop - EXTCON_PROP_DISP_MIN];
685 spin_unlock_irqrestore(&edev->lock, flags);
689 EXPORT_SYMBOL_GPL(extcon_get_property);
692 * extcon_set_property() - Set the property value of an external connector.
693 * @edev: the extcon device
694 * @id: the unique id indicating an external connector
695 * @prop: the property id indicating an extcon property
696 * @prop_val: the pointer including the new value of extcon property
698 * Note that each property should be included in the list of supported
699 * properties according to the extcon type.
701 * Returns 0 if success or error number if fail.
703 int extcon_set_property(struct extcon_dev *edev, unsigned int id,
705 union extcon_property_value prop_val)
707 struct extcon_cable *cable;
714 /* Check whether the property is supported or not */
715 if (!is_extcon_property_supported(id, prop))
718 /* Find the cable index of external connector by using id */
719 index = find_cable_index_by_id(edev, id);
723 spin_lock_irqsave(&edev->lock, flags);
725 /* Check whether the property is available or not. */
726 if (!is_extcon_property_capability(edev, id, index, prop)) {
727 spin_unlock_irqrestore(&edev->lock, flags);
731 cable = &edev->cables[index];
733 /* Set the property value according to extcon type */
735 case EXTCON_PROP_USB_MIN ... EXTCON_PROP_USB_MAX:
736 cable->usb_propval[prop - EXTCON_PROP_USB_MIN] = prop_val;
738 case EXTCON_PROP_CHG_MIN ... EXTCON_PROP_CHG_MAX:
739 cable->chg_propval[prop - EXTCON_PROP_CHG_MIN] = prop_val;
741 case EXTCON_PROP_JACK_MIN ... EXTCON_PROP_JACK_MAX:
742 cable->jack_propval[prop - EXTCON_PROP_JACK_MIN] = prop_val;
744 case EXTCON_PROP_DISP_MIN ... EXTCON_PROP_DISP_MAX:
745 cable->disp_propval[prop - EXTCON_PROP_DISP_MIN] = prop_val;
752 spin_unlock_irqrestore(&edev->lock, flags);
756 EXPORT_SYMBOL_GPL(extcon_set_property);
759 * extcon_set_property_sync() - Set property of an external connector with sync.
760 * @edev: the extcon device
761 * @id: the unique id indicating an external connector
762 * @prop: the property id indicating an extcon property
763 * @prop_val: the pointer including the new value of extcon property
765 * Note that when setting the property value of external connector,
766 * the external connector should be attached. The each property should
767 * be included in the list of supported properties according to extcon type.
769 * Returns 0 if success or error number if fail.
771 int extcon_set_property_sync(struct extcon_dev *edev, unsigned int id,
773 union extcon_property_value prop_val)
777 ret = extcon_set_property(edev, id, prop, prop_val);
781 return extcon_sync(edev, id);
783 EXPORT_SYMBOL_GPL(extcon_set_property_sync);
786 * extcon_get_property_capability() - Get the capability of the property
787 * for an external connector.
788 * @edev: the extcon device
789 * @id: the unique id indicating an external connector
790 * @prop: the property id indicating an extcon property
792 * Returns 1 if the property is available or 0 if not available.
794 int extcon_get_property_capability(struct extcon_dev *edev, unsigned int id,
802 /* Check whether the property is supported or not */
803 if (!is_extcon_property_supported(id, prop))
806 /* Find the cable index of external connector by using id */
807 index = find_cable_index_by_id(edev, id);
811 return is_extcon_property_capability(edev, id, index, prop);
813 EXPORT_SYMBOL_GPL(extcon_get_property_capability);
816 * extcon_set_property_capability() - Set the capability of the property
817 * for an external connector.
818 * @edev: the extcon device
819 * @id: the unique id indicating an external connector
820 * @prop: the property id indicating an extcon property
822 * Note that this function set the capability of the property
823 * for an external connector in order to mark the bit in capability
824 * bitmap which mean the available state of the property.
826 * Returns 0 if success or error number if fail.
828 int extcon_set_property_capability(struct extcon_dev *edev, unsigned int id,
831 struct extcon_cable *cable;
832 int index, type, ret = 0;
837 /* Check whether the property is supported or not. */
838 if (!is_extcon_property_supported(id, prop))
841 /* Find the cable index of external connector by using id. */
842 index = find_cable_index_by_id(edev, id);
846 type = get_extcon_type(prop);
850 cable = &edev->cables[index];
853 case EXTCON_TYPE_USB:
854 __set_bit(prop - EXTCON_PROP_USB_MIN, cable->usb_bits);
856 case EXTCON_TYPE_CHG:
857 __set_bit(prop - EXTCON_PROP_CHG_MIN, cable->chg_bits);
859 case EXTCON_TYPE_JACK:
860 __set_bit(prop - EXTCON_PROP_JACK_MIN, cable->jack_bits);
862 case EXTCON_TYPE_DISP:
863 __set_bit(prop - EXTCON_PROP_DISP_MIN, cable->disp_bits);
871 EXPORT_SYMBOL_GPL(extcon_set_property_capability);
874 * extcon_get_extcon_dev() - Get the extcon device instance from the name.
875 * @extcon_name: the extcon name provided with extcon_dev_register()
877 * Return the pointer of extcon device if success or ERR_PTR(err) if fail.
878 * NOTE: This function returns -EPROBE_DEFER so it may only be called from
881 struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name)
883 struct extcon_dev *sd;
886 return ERR_PTR(-EINVAL);
888 mutex_lock(&extcon_dev_list_lock);
889 list_for_each_entry(sd, &extcon_dev_list, entry) {
890 if (!strcmp(sd->name, extcon_name))
893 sd = ERR_PTR(-EPROBE_DEFER);
895 mutex_unlock(&extcon_dev_list_lock);
898 EXPORT_SYMBOL_GPL(extcon_get_extcon_dev);
901 * extcon_register_notifier() - Register a notifier block to get notified by
902 * any state changes from the extcon.
903 * @edev: the extcon device
904 * @id: the unique id indicating an external connector
905 * @nb: a notifier block to be registered
907 * Note that the second parameter given to the callback of nb (val) is
908 * the current state of an external connector and the third pameter
909 * is the pointer of extcon device.
911 * Returns 0 if success or error number if fail.
913 int extcon_register_notifier(struct extcon_dev *edev, unsigned int id,
914 struct notifier_block *nb)
922 idx = find_cable_index_by_id(edev, id);
926 spin_lock_irqsave(&edev->lock, flags);
927 ret = raw_notifier_chain_register(&edev->nh[idx], nb);
928 spin_unlock_irqrestore(&edev->lock, flags);
932 EXPORT_SYMBOL_GPL(extcon_register_notifier);
935 * extcon_unregister_notifier() - Unregister a notifier block from the extcon.
936 * @edev: the extcon device
937 * @id: the unique id indicating an external connector
938 * @nb: a notifier block to be registered
940 * Returns 0 if success or error number if fail.
942 int extcon_unregister_notifier(struct extcon_dev *edev, unsigned int id,
943 struct notifier_block *nb)
951 idx = find_cable_index_by_id(edev, id);
955 spin_lock_irqsave(&edev->lock, flags);
956 ret = raw_notifier_chain_unregister(&edev->nh[idx], nb);
957 spin_unlock_irqrestore(&edev->lock, flags);
961 EXPORT_SYMBOL_GPL(extcon_unregister_notifier);
964 * extcon_register_notifier_all() - Register a notifier block for all connectors.
965 * @edev: the extcon device
966 * @nb: a notifier block to be registered
968 * Note that this function registers a notifier block in order to receive
969 * the state change of all supported external connectors from extcon device.
970 * And the second parameter given to the callback of nb (val) is
971 * the current state and the third pameter is the pointer of extcon device.
973 * Returns 0 if success or error number if fail.
975 int extcon_register_notifier_all(struct extcon_dev *edev,
976 struct notifier_block *nb)
984 spin_lock_irqsave(&edev->lock, flags);
985 ret = raw_notifier_chain_register(&edev->nh_all, nb);
986 spin_unlock_irqrestore(&edev->lock, flags);
990 EXPORT_SYMBOL_GPL(extcon_register_notifier_all);
993 * extcon_unregister_notifier_all() - Unregister a notifier block from extcon.
994 * @edev: the extcon device
995 * @nb: a notifier block to be registered
997 * Returns 0 if success or error number if fail.
999 int extcon_unregister_notifier_all(struct extcon_dev *edev,
1000 struct notifier_block *nb)
1002 unsigned long flags;
1008 spin_lock_irqsave(&edev->lock, flags);
1009 ret = raw_notifier_chain_unregister(&edev->nh_all, nb);
1010 spin_unlock_irqrestore(&edev->lock, flags);
1014 EXPORT_SYMBOL_GPL(extcon_unregister_notifier_all);
1016 static struct attribute *extcon_attrs[] = {
1017 &dev_attr_state.attr,
1018 &dev_attr_name.attr,
1021 ATTRIBUTE_GROUPS(extcon);
1023 static int create_extcon_class(void)
1028 extcon_class = class_create("extcon");
1029 if (IS_ERR(extcon_class))
1030 return PTR_ERR(extcon_class);
1031 extcon_class->dev_groups = extcon_groups;
1036 static void extcon_dev_release(struct device *dev)
1040 static const char *muex_name = "mutually_exclusive";
1041 static void dummy_sysfs_dev_release(struct device *dev)
1046 * extcon_dev_allocate() - Allocate the memory of extcon device.
1047 * @supported_cable: the array of the supported external connectors
1048 * ending with EXTCON_NONE.
1050 * Note that this function allocates the memory for extcon device
1051 * and initialize default setting for the extcon device.
1053 * Returns the pointer memory of allocated extcon_dev if success
1054 * or ERR_PTR(err) if fail.
1056 struct extcon_dev *extcon_dev_allocate(const unsigned int *supported_cable)
1058 struct extcon_dev *edev;
1060 if (!supported_cable)
1061 return ERR_PTR(-EINVAL);
1063 edev = kzalloc(sizeof(*edev), GFP_KERNEL);
1065 return ERR_PTR(-ENOMEM);
1067 edev->max_supported = 0;
1068 edev->supported_cable = supported_cable;
1074 * extcon_dev_free() - Free the memory of extcon device.
1075 * @edev: the extcon device
1077 void extcon_dev_free(struct extcon_dev *edev)
1081 EXPORT_SYMBOL_GPL(extcon_dev_free);
1084 * extcon_alloc_cables() - alloc the cables for extcon device
1085 * @edev: extcon device which has cables
1087 * Returns 0 if success or error number if fail.
1089 static int extcon_alloc_cables(struct extcon_dev *edev)
1093 struct extcon_cable *cable;
1098 if (!edev->max_supported)
1101 edev->cables = kcalloc(edev->max_supported, sizeof(*edev->cables),
1106 for (index = 0; index < edev->max_supported; index++) {
1107 cable = &edev->cables[index];
1109 str = kasprintf(GFP_KERNEL, "cable.%d", index);
1111 for (index--; index >= 0; index--) {
1112 cable = &edev->cables[index];
1113 kfree(cable->attr_g.name);
1116 kfree(edev->cables);
1121 cable->cable_index = index;
1122 cable->attrs[0] = &cable->attr_name.attr;
1123 cable->attrs[1] = &cable->attr_state.attr;
1124 cable->attrs[2] = NULL;
1125 cable->attr_g.name = str;
1126 cable->attr_g.attrs = cable->attrs;
1128 sysfs_attr_init(&cable->attr_name.attr);
1129 cable->attr_name.attr.name = "name";
1130 cable->attr_name.attr.mode = 0444;
1131 cable->attr_name.show = cable_name_show;
1133 sysfs_attr_init(&cable->attr_state.attr);
1134 cable->attr_state.attr.name = "state";
1135 cable->attr_state.attr.mode = 0444;
1136 cable->attr_state.show = cable_state_show;
1143 * extcon_alloc_muex() - alloc the mutual exclusive for extcon device
1144 * @edev: extcon device
1146 * Returns 0 if success or error number if fail.
1148 static int extcon_alloc_muex(struct extcon_dev *edev)
1156 if (!(edev->max_supported && edev->mutually_exclusive))
1159 /* Count the size of mutually_exclusive array */
1160 for (index = 0; edev->mutually_exclusive[index]; index++)
1163 edev->attrs_muex = kcalloc(index + 1, sizeof(*edev->attrs_muex),
1165 if (!edev->attrs_muex)
1168 edev->d_attrs_muex = kcalloc(index, sizeof(*edev->d_attrs_muex),
1170 if (!edev->d_attrs_muex) {
1171 kfree(edev->attrs_muex);
1175 for (index = 0; edev->mutually_exclusive[index]; index++) {
1176 name = kasprintf(GFP_KERNEL, "0x%x",
1177 edev->mutually_exclusive[index]);
1179 for (index--; index >= 0; index--)
1180 kfree(edev->d_attrs_muex[index].attr.name);
1182 kfree(edev->d_attrs_muex);
1183 kfree(edev->attrs_muex);
1186 sysfs_attr_init(&edev->d_attrs_muex[index].attr);
1187 edev->d_attrs_muex[index].attr.name = name;
1188 edev->d_attrs_muex[index].attr.mode = 0000;
1189 edev->attrs_muex[index] = &edev->d_attrs_muex[index].attr;
1191 edev->attr_g_muex.name = muex_name;
1192 edev->attr_g_muex.attrs = edev->attrs_muex;
1198 * extcon_alloc_groups() - alloc the groups for extcon device
1199 * @edev: extcon device
1201 * Returns 0 if success or error number if fail.
1203 static int extcon_alloc_groups(struct extcon_dev *edev)
1210 if (!edev->max_supported)
1213 edev->extcon_dev_type.groups = kcalloc(edev->max_supported + 2,
1214 sizeof(*edev->extcon_dev_type.groups),
1216 if (!edev->extcon_dev_type.groups)
1219 edev->extcon_dev_type.name = dev_name(&edev->dev);
1220 edev->extcon_dev_type.release = dummy_sysfs_dev_release;
1222 for (index = 0; index < edev->max_supported; index++)
1223 edev->extcon_dev_type.groups[index] = &edev->cables[index].attr_g;
1225 if (edev->mutually_exclusive)
1226 edev->extcon_dev_type.groups[index] = &edev->attr_g_muex;
1228 edev->dev.type = &edev->extcon_dev_type;
1234 * extcon_dev_register() - Register an new extcon device
1235 * @edev: the extcon device to be registered
1237 * Among the members of edev struct, please set the "user initializing data"
1238 * do not set the values of "internal data", which are initialized by
1241 * Note that before calling this funciton, have to allocate the memory
1242 * of an extcon device by using the extcon_dev_allocate(). And the extcon
1243 * dev should include the supported_cable information.
1245 * Returns 0 if success or error number if fail.
1247 int extcon_dev_register(struct extcon_dev *edev)
1251 ret = create_extcon_class();
1255 if (!edev || !edev->supported_cable)
1258 for (index = 0; edev->supported_cable[index] != EXTCON_NONE; index++);
1260 edev->max_supported = index;
1261 if (index > SUPPORTED_CABLE_MAX) {
1263 "exceed the maximum number of supported cables\n");
1267 edev->dev.class = extcon_class;
1268 edev->dev.release = extcon_dev_release;
1270 edev->name = dev_name(edev->dev.parent);
1271 if (IS_ERR_OR_NULL(edev->name)) {
1273 "extcon device name is null\n");
1277 ret = ida_alloc(&extcon_dev_ids, GFP_KERNEL);
1283 dev_set_name(&edev->dev, "extcon%d", edev->id);
1285 ret = extcon_alloc_cables(edev);
1287 goto err_alloc_cables;
1289 ret = extcon_alloc_muex(edev);
1291 goto err_alloc_muex;
1293 ret = extcon_alloc_groups(edev);
1295 goto err_alloc_groups;
1297 spin_lock_init(&edev->lock);
1298 if (edev->max_supported) {
1299 edev->nh = kcalloc(edev->max_supported, sizeof(*edev->nh),
1307 for (index = 0; index < edev->max_supported; index++)
1308 RAW_INIT_NOTIFIER_HEAD(&edev->nh[index]);
1310 RAW_INIT_NOTIFIER_HEAD(&edev->nh_all);
1312 dev_set_drvdata(&edev->dev, edev);
1315 ret = device_register(&edev->dev);
1317 put_device(&edev->dev);
1321 mutex_lock(&extcon_dev_list_lock);
1322 list_add(&edev->entry, &extcon_dev_list);
1323 mutex_unlock(&extcon_dev_list_lock);
1328 if (edev->max_supported)
1331 if (edev->max_supported)
1332 kfree(edev->extcon_dev_type.groups);
1334 if (edev->max_supported && edev->mutually_exclusive) {
1335 for (index = 0; edev->mutually_exclusive[index]; index++)
1336 kfree(edev->d_attrs_muex[index].attr.name);
1337 kfree(edev->d_attrs_muex);
1338 kfree(edev->attrs_muex);
1341 for (index = 0; index < edev->max_supported; index++)
1342 kfree(edev->cables[index].attr_g.name);
1343 if (edev->max_supported)
1344 kfree(edev->cables);
1346 ida_free(&extcon_dev_ids, edev->id);
1350 EXPORT_SYMBOL_GPL(extcon_dev_register);
1353 * extcon_dev_unregister() - Unregister the extcon device.
1354 * @edev: the extcon device to be unregistered.
1356 * Note that this does not call kfree(edev) because edev was not allocated
1359 void extcon_dev_unregister(struct extcon_dev *edev)
1366 mutex_lock(&extcon_dev_list_lock);
1367 list_del(&edev->entry);
1368 mutex_unlock(&extcon_dev_list_lock);
1370 if (!get_device(&edev->dev)) {
1371 dev_err(&edev->dev, "Failed to unregister extcon_dev\n");
1375 ida_free(&extcon_dev_ids, edev->id);
1377 device_unregister(&edev->dev);
1379 if (edev->mutually_exclusive && edev->max_supported) {
1380 for (index = 0; edev->mutually_exclusive[index];
1382 kfree(edev->d_attrs_muex[index].attr.name);
1383 kfree(edev->d_attrs_muex);
1384 kfree(edev->attrs_muex);
1387 for (index = 0; index < edev->max_supported; index++)
1388 kfree(edev->cables[index].attr_g.name);
1390 if (edev->max_supported) {
1391 kfree(edev->extcon_dev_type.groups);
1392 kfree(edev->cables);
1396 put_device(&edev->dev);
1398 EXPORT_SYMBOL_GPL(extcon_dev_unregister);
1403 * extcon_find_edev_by_node - Find the extcon device from devicetree.
1404 * @node : OF node identifying edev
1406 * Return the pointer of extcon device if success or ERR_PTR(err) if fail.
1408 struct extcon_dev *extcon_find_edev_by_node(struct device_node *node)
1410 struct extcon_dev *edev;
1412 mutex_lock(&extcon_dev_list_lock);
1413 list_for_each_entry(edev, &extcon_dev_list, entry)
1414 if (edev->dev.parent && device_match_of_node(edev->dev.parent, node))
1416 edev = ERR_PTR(-EPROBE_DEFER);
1418 mutex_unlock(&extcon_dev_list_lock);
1424 * extcon_get_edev_by_phandle - Get the extcon device from devicetree.
1425 * @dev : the instance to the given device
1426 * @index : the index into list of extcon_dev
1428 * Return the pointer of extcon device if success or ERR_PTR(err) if fail.
1430 struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev, int index)
1432 struct device_node *node, *np = dev_of_node(dev);
1433 struct extcon_dev *edev;
1436 dev_dbg(dev, "device does not have a device node entry\n");
1437 return ERR_PTR(-EINVAL);
1440 node = of_parse_phandle(np, "extcon", index);
1442 dev_dbg(dev, "failed to get phandle in %pOF node\n", np);
1443 return ERR_PTR(-ENODEV);
1446 edev = extcon_find_edev_by_node(node);
1454 struct extcon_dev *extcon_find_edev_by_node(struct device_node *node)
1456 return ERR_PTR(-ENOSYS);
1459 struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev, int index)
1461 return ERR_PTR(-ENOSYS);
1464 #endif /* CONFIG_OF */
1466 EXPORT_SYMBOL_GPL(extcon_find_edev_by_node);
1467 EXPORT_SYMBOL_GPL(extcon_get_edev_by_phandle);
1470 * extcon_get_edev_name() - Get the name of the extcon device.
1471 * @edev: the extcon device
1473 const char *extcon_get_edev_name(struct extcon_dev *edev)
1475 return !edev ? NULL : edev->name;
1477 EXPORT_SYMBOL_GPL(extcon_get_edev_name);
1479 static int __init extcon_class_init(void)
1481 return create_extcon_class();
1483 module_init(extcon_class_init);
1485 static void __exit extcon_class_exit(void)
1487 class_destroy(extcon_class);
1489 module_exit(extcon_class_exit);
1491 MODULE_AUTHOR("Chanwoo Choi <cw00.choi@samsung.com>");
1492 MODULE_AUTHOR("MyungJoo Ham <myungjoo.ham@samsung.com>");
1493 MODULE_DESCRIPTION("External Connector (extcon) framework");
1494 MODULE_LICENSE("GPL v2");