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>
33 #include <linux/extcon.h>
35 #include <linux/slab.h>
36 #include <linux/sysfs.h>
38 #define SUPPORTED_CABLE_MAX 32
39 #define CABLE_NAME_MAX 30
41 static const char *extcon_name[] = {
42 [EXTCON_NONE] = "NONE",
44 /* USB external connector */
46 [EXTCON_USB_HOST] = "USB-HOST",
48 /* Charging external connector */
49 [EXTCON_CHG_USB_SDP] = "SDP",
50 [EXTCON_CHG_USB_DCP] = "DCP",
51 [EXTCON_CHG_USB_CDP] = "CDP",
52 [EXTCON_CHG_USB_ACA] = "ACA",
53 [EXTCON_CHG_USB_FAST] = "FAST-CHARGER",
54 [EXTCON_CHG_USB_SLOW] = "SLOW-CHARGER",
56 /* Jack external connector */
57 [EXTCON_JACK_MICROPHONE] = "MICROPHONE",
58 [EXTCON_JACK_HEADPHONE] = "HEADPHONE",
59 [EXTCON_JACK_LINE_IN] = "LINE-IN",
60 [EXTCON_JACK_LINE_OUT] = "LINE-OUT",
61 [EXTCON_JACK_VIDEO_IN] = "VIDEO-IN",
62 [EXTCON_JACK_VIDEO_OUT] = "VIDEO-OUT",
63 [EXTCON_JACK_SPDIF_IN] = "SPDIF-IN",
64 [EXTCON_JACK_SPDIF_OUT] = "SPDIF-OUT",
66 /* Display external connector */
67 [EXTCON_DISP_HDMI] = "HDMI",
68 [EXTCON_DISP_MHL] = "MHL",
69 [EXTCON_DISP_DVI] = "DVI",
70 [EXTCON_DISP_VGA] = "VGA",
72 /* Miscellaneous external connector */
73 [EXTCON_DOCK] = "DOCK",
75 [EXTCON_MECHANICAL] = "MECHANICAL",
81 * struct extcon_cable - An internal data for each cable of extcon device.
82 * @edev: The extcon device
83 * @cable_index: Index of this cable in the edev
84 * @attr_g: Attribute group for the cable
85 * @attr_name: "name" sysfs entry
86 * @attr_state: "state" sysfs entry
87 * @attrs: Array pointing to attr_name and attr_state for attr_g
90 struct extcon_dev *edev;
93 struct attribute_group attr_g;
94 struct device_attribute attr_name;
95 struct device_attribute attr_state;
97 struct attribute *attrs[3]; /* to be fed to attr_g.attrs */
100 static struct class *extcon_class;
101 #if defined(CONFIG_ANDROID)
102 static struct class_compat *switch_class;
103 #endif /* CONFIG_ANDROID */
105 static LIST_HEAD(extcon_dev_list);
106 static DEFINE_MUTEX(extcon_dev_list_lock);
109 * check_mutually_exclusive - Check if new_state violates mutually_exclusive
111 * @edev: the extcon device
112 * @new_state: new cable attach status for @edev
114 * Returns 0 if nothing violates. Returns the index + 1 for the first
115 * violated condition.
117 static int check_mutually_exclusive(struct extcon_dev *edev, u32 new_state)
121 if (!edev->mutually_exclusive)
124 for (i = 0; edev->mutually_exclusive[i]; i++) {
126 u32 correspondants = new_state & edev->mutually_exclusive[i];
128 /* calculate the total number of bits set */
129 weight = hweight32(correspondants);
137 static int find_cable_index_by_id(struct extcon_dev *edev, const unsigned int id)
141 /* Find the the index of extcon cable in edev->supported_cable */
142 for (i = 0; i < edev->max_supported; i++) {
143 if (edev->supported_cable[i] == id)
150 static bool is_extcon_changed(u32 prev, u32 new, int idx, bool *attached)
152 if (((prev >> idx) & 0x1) != ((new >> idx) & 0x1)) {
153 *attached = ((new >> idx) & 0x1) ? true : false;
160 static ssize_t state_show(struct device *dev, struct device_attribute *attr,
164 struct extcon_dev *edev = dev_get_drvdata(dev);
166 if (edev->max_supported == 0)
167 return sprintf(buf, "%u\n", edev->state);
169 for (i = 0; i < edev->max_supported; i++) {
170 count += sprintf(buf + count, "%s=%d\n",
171 extcon_name[edev->supported_cable[i]],
172 !!(edev->state & (1 << i)));
177 static DEVICE_ATTR_RO(state);
179 static ssize_t name_show(struct device *dev, struct device_attribute *attr,
182 struct extcon_dev *edev = dev_get_drvdata(dev);
184 return sprintf(buf, "%s\n", edev->name);
186 static DEVICE_ATTR_RO(name);
188 static ssize_t cable_name_show(struct device *dev,
189 struct device_attribute *attr, char *buf)
191 struct extcon_cable *cable = container_of(attr, struct extcon_cable,
193 int i = cable->cable_index;
195 return sprintf(buf, "%s\n",
196 extcon_name[cable->edev->supported_cable[i]]);
199 static ssize_t cable_state_show(struct device *dev,
200 struct device_attribute *attr, char *buf)
202 struct extcon_cable *cable = container_of(attr, struct extcon_cable,
205 int i = cable->cable_index;
207 return sprintf(buf, "%d\n",
208 extcon_get_cable_state_(cable->edev,
209 cable->edev->supported_cable[i]));
213 * extcon_update_state() - Update the cable attach states of the extcon device
214 * only for the masked bits.
215 * @edev: the extcon device
216 * @mask: the bit mask to designate updated bits.
217 * @state: new cable attach status for @edev
219 * Changing the state sends uevent with environment variable containing
220 * the name of extcon device (envp[0]) and the state output (envp[1]).
221 * Tizen uses this format for extcon device to get events from ports.
222 * Android uses this format as well.
224 * Note that the notifier provides which bits are changed in the state
225 * variable with the val parameter (second) to the callback.
227 int extcon_update_state(struct extcon_dev *edev, u32 mask, u32 state)
242 spin_lock_irqsave(&edev->lock, flags);
244 if (edev->state != ((edev->state & ~mask) | (state & mask))) {
247 if (check_mutually_exclusive(edev, (edev->state & ~mask) |
249 spin_unlock_irqrestore(&edev->lock, flags);
253 old_state = edev->state;
254 edev->state &= ~mask;
255 edev->state |= state & mask;
257 for (index = 0; index < edev->max_supported; index++) {
258 if (is_extcon_changed(old_state, edev->state, index,
260 raw_notifier_call_chain(&edev->nh[index],
264 /* This could be in interrupt handler */
265 prop_buf = (char *)get_zeroed_page(GFP_ATOMIC);
267 length = name_show(&edev->dev, NULL, prop_buf);
269 if (prop_buf[length - 1] == '\n')
270 prop_buf[length - 1] = 0;
271 snprintf(name_buf, sizeof(name_buf),
272 "NAME=%s", prop_buf);
273 envp[env_offset++] = name_buf;
275 length = state_show(&edev->dev, NULL, prop_buf);
277 if (prop_buf[length - 1] == '\n')
278 prop_buf[length - 1] = 0;
279 snprintf(state_buf, sizeof(state_buf),
280 "STATE=%s", prop_buf);
281 envp[env_offset++] = state_buf;
283 envp[env_offset] = NULL;
284 /* Unlock early before uevent */
285 spin_unlock_irqrestore(&edev->lock, flags);
287 kobject_uevent_env(&edev->dev.kobj, KOBJ_CHANGE, envp);
288 free_page((unsigned long)prop_buf);
290 /* Unlock early before uevent */
291 spin_unlock_irqrestore(&edev->lock, flags);
293 dev_err(&edev->dev, "out of memory in extcon_set_state\n");
294 kobject_uevent(&edev->dev.kobj, KOBJ_CHANGE);
298 spin_unlock_irqrestore(&edev->lock, flags);
303 EXPORT_SYMBOL_GPL(extcon_update_state);
306 * extcon_set_state() - Set the cable attach states of the extcon device.
307 * @edev: the extcon device
308 * @state: new cable attach status for @edev
310 * Note that notifier provides which bits are changed in the state
311 * variable with the val parameter (second) to the callback.
313 int extcon_set_state(struct extcon_dev *edev, u32 state)
318 return extcon_update_state(edev, 0xffffffff, state);
320 EXPORT_SYMBOL_GPL(extcon_set_state);
323 * extcon_get_cable_state_() - Get the status of a specific cable.
324 * @edev: the extcon device that has the cable.
325 * @id: the unique id of each external connector in extcon enumeration.
327 int extcon_get_cable_state_(struct extcon_dev *edev, const unsigned int id)
334 index = find_cable_index_by_id(edev, id);
338 if (edev->max_supported && edev->max_supported <= index)
341 return !!(edev->state & (1 << index));
343 EXPORT_SYMBOL_GPL(extcon_get_cable_state_);
346 * extcon_set_cable_state_() - Set the status of a specific cable.
347 * @edev: the extcon device that has the cable.
348 * @id: the unique id of each external connector
349 * in extcon enumeration.
350 * @state: the new cable status. The default semantics is
351 * true: attached / false: detached.
353 int extcon_set_cable_state_(struct extcon_dev *edev, unsigned int id,
362 index = find_cable_index_by_id(edev, id);
366 if (edev->max_supported && edev->max_supported <= index)
369 state = cable_state ? (1 << index) : 0;
370 return extcon_update_state(edev, 1 << index, state);
372 EXPORT_SYMBOL_GPL(extcon_set_cable_state_);
375 * extcon_get_extcon_dev() - Get the extcon device instance from the name
376 * @extcon_name: The extcon name provided with extcon_dev_register()
378 struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name)
380 struct extcon_dev *sd;
383 return ERR_PTR(-EINVAL);
385 mutex_lock(&extcon_dev_list_lock);
386 list_for_each_entry(sd, &extcon_dev_list, entry) {
387 if (!strcmp(sd->name, extcon_name))
392 mutex_unlock(&extcon_dev_list_lock);
395 EXPORT_SYMBOL_GPL(extcon_get_extcon_dev);
398 * extcon_register_notifier() - Register a notifiee to get notified by
399 * any attach status changes from the extcon.
400 * @edev: the extcon device that has the external connecotr.
401 * @id: the unique id of each external connector in extcon enumeration.
402 * @nb: a notifier block to be registered.
404 * Note that the second parameter given to the callback of nb (val) is
405 * "old_state", not the current state. The current state can be retrieved
406 * by looking at the third pameter (edev pointer)'s state value.
408 int extcon_register_notifier(struct extcon_dev *edev, unsigned int id,
409 struct notifier_block *nb)
418 idx = find_cable_index_by_id(edev, id);
422 spin_lock_irqsave(&edev->lock, flags);
423 ret = raw_notifier_chain_register(&edev->nh[idx], nb);
424 spin_unlock_irqrestore(&edev->lock, flags);
426 struct extcon_dev *extd;
428 mutex_lock(&extcon_dev_list_lock);
429 list_for_each_entry(extd, &extcon_dev_list, entry) {
430 idx = find_cable_index_by_id(extd, id);
434 mutex_unlock(&extcon_dev_list_lock);
438 return extcon_register_notifier(extd, id, nb);
446 EXPORT_SYMBOL_GPL(extcon_register_notifier);
449 * extcon_unregister_notifier() - Unregister a notifiee from the extcon device.
450 * @edev: the extcon device that has the external connecotr.
451 * @id: the unique id of each external connector in extcon enumeration.
452 * @nb: a notifier block to be registered.
454 int extcon_unregister_notifier(struct extcon_dev *edev, unsigned int id,
455 struct notifier_block *nb)
463 idx = find_cable_index_by_id(edev, id);
467 spin_lock_irqsave(&edev->lock, flags);
468 ret = raw_notifier_chain_unregister(&edev->nh[idx], nb);
469 spin_unlock_irqrestore(&edev->lock, flags);
473 EXPORT_SYMBOL_GPL(extcon_unregister_notifier);
475 static struct attribute *extcon_attrs[] = {
476 &dev_attr_state.attr,
480 ATTRIBUTE_GROUPS(extcon);
482 static int create_extcon_class(void)
485 extcon_class = class_create(THIS_MODULE, "extcon");
486 if (IS_ERR(extcon_class))
487 return PTR_ERR(extcon_class);
488 extcon_class->dev_groups = extcon_groups;
490 #if defined(CONFIG_ANDROID) && !defined(CONFIG_SWITCH)
491 switch_class = class_compat_register("switch");
492 if (WARN(!switch_class, "cannot allocate"))
494 #endif /* CONFIG_ANDROID */
500 static void extcon_dev_release(struct device *dev)
504 static const char *muex_name = "mutually_exclusive";
505 static void dummy_sysfs_dev_release(struct device *dev)
510 * extcon_dev_allocate() - Allocate the memory of extcon device.
511 * @supported_cable: Array of supported extcon ending with EXTCON_NONE.
512 * If supported_cable is NULL, cable name related APIs
515 * This function allocates the memory for extcon device without allocating
516 * memory in each extcon provider driver and initialize default setting for
519 * Return the pointer of extcon device if success or ERR_PTR(err) if fail
521 struct extcon_dev *extcon_dev_allocate(const unsigned int *supported_cable)
523 struct extcon_dev *edev;
525 if (!supported_cable)
526 return ERR_PTR(-EINVAL);
528 edev = kzalloc(sizeof(*edev), GFP_KERNEL);
530 return ERR_PTR(-ENOMEM);
532 edev->max_supported = 0;
533 edev->supported_cable = supported_cable;
539 * extcon_dev_free() - Free the memory of extcon device.
540 * @edev: the extcon device to free
542 void extcon_dev_free(struct extcon_dev *edev)
546 EXPORT_SYMBOL_GPL(extcon_dev_free);
549 * extcon_dev_register() - Register a new extcon device
550 * @edev : the new extcon device (should be allocated before calling)
552 * Among the members of edev struct, please set the "user initializing data"
553 * in any case and set the "optional callbacks" if required. However, please
554 * do not set the values of "internal data", which are initialized by
557 int extcon_dev_register(struct extcon_dev *edev)
560 static atomic_t edev_no = ATOMIC_INIT(-1);
563 ret = create_extcon_class();
568 if (!edev || !edev->supported_cable)
571 for (; edev->supported_cable[index] != EXTCON_NONE; index++);
573 edev->max_supported = index;
574 if (index > SUPPORTED_CABLE_MAX) {
576 "exceed the maximum number of supported cables\n");
580 edev->dev.class = extcon_class;
581 edev->dev.release = extcon_dev_release;
583 edev->name = dev_name(edev->dev.parent);
584 if (IS_ERR_OR_NULL(edev->name)) {
586 "extcon device name is null\n");
589 dev_set_name(&edev->dev, "extcon%lu",
590 (unsigned long)atomic_inc_return(&edev_no));
592 if (edev->max_supported) {
595 struct extcon_cable *cable;
597 edev->cables = kzalloc(sizeof(struct extcon_cable) *
598 edev->max_supported, GFP_KERNEL);
601 goto err_sysfs_alloc;
603 for (index = 0; index < edev->max_supported; index++) {
604 cable = &edev->cables[index];
606 snprintf(buf, 10, "cable.%d", index);
607 str = kzalloc(sizeof(char) * (strlen(buf) + 1),
610 for (index--; index >= 0; index--) {
611 cable = &edev->cables[index];
612 kfree(cable->attr_g.name);
616 goto err_alloc_cables;
621 cable->cable_index = index;
622 cable->attrs[0] = &cable->attr_name.attr;
623 cable->attrs[1] = &cable->attr_state.attr;
624 cable->attrs[2] = NULL;
625 cable->attr_g.name = str;
626 cable->attr_g.attrs = cable->attrs;
628 sysfs_attr_init(&cable->attr_name.attr);
629 cable->attr_name.attr.name = "name";
630 cable->attr_name.attr.mode = 0444;
631 cable->attr_name.show = cable_name_show;
633 sysfs_attr_init(&cable->attr_state.attr);
634 cable->attr_state.attr.name = "state";
635 cable->attr_state.attr.mode = 0444;
636 cable->attr_state.show = cable_state_show;
640 if (edev->max_supported && edev->mutually_exclusive) {
644 /* Count the size of mutually_exclusive array */
645 for (index = 0; edev->mutually_exclusive[index]; index++)
648 edev->attrs_muex = kzalloc(sizeof(struct attribute *) *
649 (index + 1), GFP_KERNEL);
650 if (!edev->attrs_muex) {
655 edev->d_attrs_muex = kzalloc(sizeof(struct device_attribute) *
657 if (!edev->d_attrs_muex) {
659 kfree(edev->attrs_muex);
663 for (index = 0; edev->mutually_exclusive[index]; index++) {
664 sprintf(buf, "0x%x", edev->mutually_exclusive[index]);
665 name = kzalloc(sizeof(char) * (strlen(buf) + 1),
668 for (index--; index >= 0; index--) {
669 kfree(edev->d_attrs_muex[index].attr.
672 kfree(edev->d_attrs_muex);
673 kfree(edev->attrs_muex);
678 sysfs_attr_init(&edev->d_attrs_muex[index].attr);
679 edev->d_attrs_muex[index].attr.name = name;
680 edev->d_attrs_muex[index].attr.mode = 0000;
681 edev->attrs_muex[index] = &edev->d_attrs_muex[index]
684 edev->attr_g_muex.name = muex_name;
685 edev->attr_g_muex.attrs = edev->attrs_muex;
689 if (edev->max_supported) {
690 edev->extcon_dev_type.groups =
691 kzalloc(sizeof(struct attribute_group *) *
692 (edev->max_supported + 2), GFP_KERNEL);
693 if (!edev->extcon_dev_type.groups) {
695 goto err_alloc_groups;
698 edev->extcon_dev_type.name = dev_name(&edev->dev);
699 edev->extcon_dev_type.release = dummy_sysfs_dev_release;
701 for (index = 0; index < edev->max_supported; index++)
702 edev->extcon_dev_type.groups[index] =
703 &edev->cables[index].attr_g;
704 if (edev->mutually_exclusive)
705 edev->extcon_dev_type.groups[index] =
708 edev->dev.type = &edev->extcon_dev_type;
711 ret = device_register(&edev->dev);
713 put_device(&edev->dev);
716 #if defined(CONFIG_ANDROID)
718 ret = class_compat_create_link(switch_class, &edev->dev, NULL);
719 #endif /* CONFIG_ANDROID */
721 spin_lock_init(&edev->lock);
723 edev->nh = devm_kzalloc(&edev->dev,
724 sizeof(*edev->nh) * edev->max_supported, GFP_KERNEL);
730 for (index = 0; index < edev->max_supported; index++)
731 RAW_INIT_NOTIFIER_HEAD(&edev->nh[index]);
733 dev_set_drvdata(&edev->dev, edev);
736 mutex_lock(&extcon_dev_list_lock);
737 list_add(&edev->entry, &extcon_dev_list);
738 mutex_unlock(&extcon_dev_list_lock);
743 if (edev->max_supported)
744 kfree(edev->extcon_dev_type.groups);
746 if (edev->max_supported && edev->mutually_exclusive) {
747 for (index = 0; edev->mutually_exclusive[index]; index++)
748 kfree(edev->d_attrs_muex[index].attr.name);
749 kfree(edev->d_attrs_muex);
750 kfree(edev->attrs_muex);
753 for (index = 0; index < edev->max_supported; index++)
754 kfree(edev->cables[index].attr_g.name);
756 if (edev->max_supported)
761 EXPORT_SYMBOL_GPL(extcon_dev_register);
764 * extcon_dev_unregister() - Unregister the extcon device.
765 * @edev: the extcon device instance to be unregistered.
767 * Note that this does not call kfree(edev) because edev was not allocated
770 void extcon_dev_unregister(struct extcon_dev *edev)
777 mutex_lock(&extcon_dev_list_lock);
778 list_del(&edev->entry);
779 mutex_unlock(&extcon_dev_list_lock);
781 if (IS_ERR_OR_NULL(get_device(&edev->dev))) {
782 dev_err(&edev->dev, "Failed to unregister extcon_dev (%s)\n",
783 dev_name(&edev->dev));
787 device_unregister(&edev->dev);
789 if (edev->mutually_exclusive && edev->max_supported) {
790 for (index = 0; edev->mutually_exclusive[index];
792 kfree(edev->d_attrs_muex[index].attr.name);
793 kfree(edev->d_attrs_muex);
794 kfree(edev->attrs_muex);
797 for (index = 0; index < edev->max_supported; index++)
798 kfree(edev->cables[index].attr_g.name);
800 if (edev->max_supported) {
801 kfree(edev->extcon_dev_type.groups);
805 #if defined(CONFIG_ANDROID)
807 class_compat_remove_link(switch_class, &edev->dev, NULL);
809 put_device(&edev->dev);
811 EXPORT_SYMBOL_GPL(extcon_dev_unregister);
815 * extcon_get_edev_by_phandle - Get the extcon device from devicetree
816 * @dev - instance to the given device
817 * @index - index into list of extcon_dev
819 * return the instance of extcon device
821 struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev, int index)
823 struct device_node *node;
824 struct extcon_dev *edev;
827 return ERR_PTR(-EINVAL);
830 dev_dbg(dev, "device does not have a device node entry\n");
831 return ERR_PTR(-EINVAL);
834 node = of_parse_phandle(dev->of_node, "extcon", index);
836 dev_dbg(dev, "failed to get phandle in %s node\n",
837 dev->of_node->full_name);
838 return ERR_PTR(-ENODEV);
841 mutex_lock(&extcon_dev_list_lock);
842 list_for_each_entry(edev, &extcon_dev_list, entry) {
843 if (edev->dev.parent && edev->dev.parent->of_node == node) {
844 mutex_unlock(&extcon_dev_list_lock);
849 mutex_unlock(&extcon_dev_list_lock);
852 return ERR_PTR(-EPROBE_DEFER);
855 struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev, int index)
857 return ERR_PTR(-ENOSYS);
859 #endif /* CONFIG_OF */
860 EXPORT_SYMBOL_GPL(extcon_get_edev_by_phandle);
863 * extcon_get_edev_name() - Get the name of the extcon device.
864 * @edev: the extcon device
866 const char *extcon_get_edev_name(struct extcon_dev *edev)
868 return !edev ? NULL : edev->name;
871 static int __init extcon_class_init(void)
873 return create_extcon_class();
875 module_init(extcon_class_init);
877 static void __exit extcon_class_exit(void)
879 #if defined(CONFIG_ANDROID)
880 class_compat_unregister(switch_class);
882 class_destroy(extcon_class);
884 module_exit(extcon_class_exit);
886 MODULE_AUTHOR("Chanwoo Choi <cw00.choi@samsung.com>");
887 MODULE_AUTHOR("Mike Lockwood <lockwood@android.com>");
888 MODULE_AUTHOR("Donggeun Kim <dg77.kim@samsung.com>");
889 MODULE_AUTHOR("MyungJoo Ham <myungjoo.ham@samsung.com>");
890 MODULE_DESCRIPTION("External connector (extcon) class driver");
891 MODULE_LICENSE("GPL");