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/init.h>
20 #include <linux/device.h>
22 #include <linux/err.h>
24 #include <linux/slab.h>
25 #include <linux/sysfs.h>
29 #define SUPPORTED_CABLE_MAX 32
31 static const struct __extcon_info
{
38 .type
= EXTCON_TYPE_MISC
,
43 /* USB external connector */
45 .type
= EXTCON_TYPE_USB
,
50 .type
= EXTCON_TYPE_USB
,
51 .id
= EXTCON_USB_HOST
,
55 /* Charging external connector */
56 [EXTCON_CHG_USB_SDP
] = {
57 .type
= EXTCON_TYPE_CHG
| EXTCON_TYPE_USB
,
58 .id
= EXTCON_CHG_USB_SDP
,
61 [EXTCON_CHG_USB_DCP
] = {
62 .type
= EXTCON_TYPE_CHG
| EXTCON_TYPE_USB
,
63 .id
= EXTCON_CHG_USB_DCP
,
66 [EXTCON_CHG_USB_CDP
] = {
67 .type
= EXTCON_TYPE_CHG
| EXTCON_TYPE_USB
,
68 .id
= EXTCON_CHG_USB_CDP
,
71 [EXTCON_CHG_USB_ACA
] = {
72 .type
= EXTCON_TYPE_CHG
| EXTCON_TYPE_USB
,
73 .id
= EXTCON_CHG_USB_ACA
,
76 [EXTCON_CHG_USB_FAST
] = {
77 .type
= EXTCON_TYPE_CHG
| EXTCON_TYPE_USB
,
78 .id
= EXTCON_CHG_USB_FAST
,
79 .name
= "FAST-CHARGER",
81 [EXTCON_CHG_USB_SLOW
] = {
82 .type
= EXTCON_TYPE_CHG
| EXTCON_TYPE_USB
,
83 .id
= EXTCON_CHG_USB_SLOW
,
84 .name
= "SLOW-CHARGER",
87 .type
= EXTCON_TYPE_CHG
,
91 [EXTCON_CHG_USB_PD
] = {
92 .type
= EXTCON_TYPE_CHG
| EXTCON_TYPE_USB
,
93 .id
= EXTCON_CHG_USB_PD
,
97 /* Jack external connector */
98 [EXTCON_JACK_MICROPHONE
] = {
99 .type
= EXTCON_TYPE_JACK
,
100 .id
= EXTCON_JACK_MICROPHONE
,
101 .name
= "MICROPHONE",
103 [EXTCON_JACK_HEADPHONE
] = {
104 .type
= EXTCON_TYPE_JACK
,
105 .id
= EXTCON_JACK_HEADPHONE
,
108 [EXTCON_JACK_LINE_IN
] = {
109 .type
= EXTCON_TYPE_JACK
,
110 .id
= EXTCON_JACK_LINE_IN
,
113 [EXTCON_JACK_LINE_OUT
] = {
114 .type
= EXTCON_TYPE_JACK
,
115 .id
= EXTCON_JACK_LINE_OUT
,
118 [EXTCON_JACK_VIDEO_IN
] = {
119 .type
= EXTCON_TYPE_JACK
,
120 .id
= EXTCON_JACK_VIDEO_IN
,
123 [EXTCON_JACK_VIDEO_OUT
] = {
124 .type
= EXTCON_TYPE_JACK
,
125 .id
= EXTCON_JACK_VIDEO_OUT
,
128 [EXTCON_JACK_SPDIF_IN
] = {
129 .type
= EXTCON_TYPE_JACK
,
130 .id
= EXTCON_JACK_SPDIF_IN
,
133 [EXTCON_JACK_SPDIF_OUT
] = {
134 .type
= EXTCON_TYPE_JACK
,
135 .id
= EXTCON_JACK_SPDIF_OUT
,
139 /* Display external connector */
140 [EXTCON_DISP_HDMI
] = {
141 .type
= EXTCON_TYPE_DISP
,
142 .id
= EXTCON_DISP_HDMI
,
145 [EXTCON_DISP_MHL
] = {
146 .type
= EXTCON_TYPE_DISP
,
147 .id
= EXTCON_DISP_MHL
,
150 [EXTCON_DISP_DVI
] = {
151 .type
= EXTCON_TYPE_DISP
,
152 .id
= EXTCON_DISP_DVI
,
155 [EXTCON_DISP_VGA
] = {
156 .type
= EXTCON_TYPE_DISP
,
157 .id
= EXTCON_DISP_VGA
,
161 .type
= EXTCON_TYPE_DISP
| EXTCON_TYPE_USB
,
162 .id
= EXTCON_DISP_DP
,
165 [EXTCON_DISP_HMD
] = {
166 .type
= EXTCON_TYPE_DISP
| EXTCON_TYPE_USB
,
167 .id
= EXTCON_DISP_HMD
,
171 /* Miscellaneous external connector */
173 .type
= EXTCON_TYPE_MISC
,
178 .type
= EXTCON_TYPE_MISC
,
182 [EXTCON_MECHANICAL
] = {
183 .type
= EXTCON_TYPE_MISC
,
184 .id
= EXTCON_MECHANICAL
,
185 .name
= "MECHANICAL",
192 * struct extcon_cable - An internal data for an external connector.
193 * @edev: the extcon device
194 * @cable_index: the index of this cable in the edev
195 * @attr_g: the attribute group for the cable
196 * @attr_name: "name" sysfs entry
197 * @attr_state: "state" sysfs entry
198 * @attrs: the array pointing to attr_name and attr_state for attr_g
200 struct extcon_cable
{
201 struct extcon_dev
*edev
;
204 struct attribute_group attr_g
;
205 struct device_attribute attr_name
;
206 struct device_attribute attr_state
;
208 struct attribute
*attrs
[3]; /* to be fed to attr_g.attrs */
210 union extcon_property_value usb_propval
[EXTCON_PROP_USB_CNT
];
211 union extcon_property_value chg_propval
[EXTCON_PROP_CHG_CNT
];
212 union extcon_property_value jack_propval
[EXTCON_PROP_JACK_CNT
];
213 union extcon_property_value disp_propval
[EXTCON_PROP_DISP_CNT
];
215 unsigned long usb_bits
[BITS_TO_LONGS(EXTCON_PROP_USB_CNT
)];
216 unsigned long chg_bits
[BITS_TO_LONGS(EXTCON_PROP_CHG_CNT
)];
217 unsigned long jack_bits
[BITS_TO_LONGS(EXTCON_PROP_JACK_CNT
)];
218 unsigned long disp_bits
[BITS_TO_LONGS(EXTCON_PROP_DISP_CNT
)];
221 static struct class *extcon_class
;
223 static LIST_HEAD(extcon_dev_list
);
224 static DEFINE_MUTEX(extcon_dev_list_lock
);
226 static int check_mutually_exclusive(struct extcon_dev
*edev
, u32 new_state
)
230 if (!edev
->mutually_exclusive
)
233 for (i
= 0; edev
->mutually_exclusive
[i
]; i
++) {
235 u32 correspondants
= new_state
& edev
->mutually_exclusive
[i
];
237 /* calculate the total number of bits set */
238 weight
= hweight32(correspondants
);
246 static int find_cable_index_by_id(struct extcon_dev
*edev
, const unsigned int id
)
250 /* Find the the index of extcon cable in edev->supported_cable */
251 for (i
= 0; i
< edev
->max_supported
; i
++) {
252 if (edev
->supported_cable
[i
] == id
)
259 static int get_extcon_type(unsigned int prop
)
262 case EXTCON_PROP_USB_MIN
... EXTCON_PROP_USB_MAX
:
263 return EXTCON_TYPE_USB
;
264 case EXTCON_PROP_CHG_MIN
... EXTCON_PROP_CHG_MAX
:
265 return EXTCON_TYPE_CHG
;
266 case EXTCON_PROP_JACK_MIN
... EXTCON_PROP_JACK_MAX
:
267 return EXTCON_TYPE_JACK
;
268 case EXTCON_PROP_DISP_MIN
... EXTCON_PROP_DISP_MAX
:
269 return EXTCON_TYPE_DISP
;
275 static bool is_extcon_attached(struct extcon_dev
*edev
, unsigned int index
)
277 return !!(edev
->state
& BIT(index
));
280 static bool is_extcon_changed(struct extcon_dev
*edev
, int index
,
283 int state
= !!(edev
->state
& BIT(index
));
284 return (state
!= new_state
);
287 static bool is_extcon_property_supported(unsigned int id
, unsigned int prop
)
291 /* Check whether the property is supported or not. */
292 type
= get_extcon_type(prop
);
296 /* Check whether a specific extcon id supports the property or not. */
297 return !!(extcon_info
[id
].type
& type
);
300 static int is_extcon_property_capability(struct extcon_dev
*edev
,
301 unsigned int id
, int index
,unsigned int prop
)
303 struct extcon_cable
*cable
;
306 /* Check whether the property is supported or not. */
307 type
= get_extcon_type(prop
);
311 cable
= &edev
->cables
[index
];
314 case EXTCON_TYPE_USB
:
315 ret
= test_bit(prop
- EXTCON_PROP_USB_MIN
, cable
->usb_bits
);
317 case EXTCON_TYPE_CHG
:
318 ret
= test_bit(prop
- EXTCON_PROP_CHG_MIN
, cable
->chg_bits
);
320 case EXTCON_TYPE_JACK
:
321 ret
= test_bit(prop
- EXTCON_PROP_JACK_MIN
, cable
->jack_bits
);
323 case EXTCON_TYPE_DISP
:
324 ret
= test_bit(prop
- EXTCON_PROP_DISP_MIN
, cable
->disp_bits
);
333 static void init_property(struct extcon_dev
*edev
, unsigned int id
, int index
)
335 unsigned int type
= extcon_info
[id
].type
;
336 struct extcon_cable
*cable
= &edev
->cables
[index
];
338 if (EXTCON_TYPE_USB
& type
)
339 memset(cable
->usb_propval
, 0, sizeof(cable
->usb_propval
));
340 if (EXTCON_TYPE_CHG
& type
)
341 memset(cable
->chg_propval
, 0, sizeof(cable
->chg_propval
));
342 if (EXTCON_TYPE_JACK
& type
)
343 memset(cable
->jack_propval
, 0, sizeof(cable
->jack_propval
));
344 if (EXTCON_TYPE_DISP
& type
)
345 memset(cable
->disp_propval
, 0, sizeof(cable
->disp_propval
));
348 static ssize_t
state_show(struct device
*dev
, struct device_attribute
*attr
,
352 struct extcon_dev
*edev
= dev_get_drvdata(dev
);
354 if (edev
->max_supported
== 0)
355 return sprintf(buf
, "%u\n", edev
->state
);
357 for (i
= 0; i
< edev
->max_supported
; i
++) {
358 count
+= sprintf(buf
+ count
, "%s=%d\n",
359 extcon_info
[edev
->supported_cable
[i
]].name
,
360 !!(edev
->state
& BIT(i
)));
365 static DEVICE_ATTR_RO(state
);
367 static ssize_t
name_show(struct device
*dev
, struct device_attribute
*attr
,
370 struct extcon_dev
*edev
= dev_get_drvdata(dev
);
372 return sprintf(buf
, "%s\n", edev
->name
);
374 static DEVICE_ATTR_RO(name
);
376 static ssize_t
cable_name_show(struct device
*dev
,
377 struct device_attribute
*attr
, char *buf
)
379 struct extcon_cable
*cable
= container_of(attr
, struct extcon_cable
,
381 int i
= cable
->cable_index
;
383 return sprintf(buf
, "%s\n",
384 extcon_info
[cable
->edev
->supported_cable
[i
]].name
);
387 static ssize_t
cable_state_show(struct device
*dev
,
388 struct device_attribute
*attr
, char *buf
)
390 struct extcon_cable
*cable
= container_of(attr
, struct extcon_cable
,
393 int i
= cable
->cable_index
;
395 return sprintf(buf
, "%d\n",
396 extcon_get_state(cable
->edev
, cable
->edev
->supported_cable
[i
]));
400 * extcon_sync() - Synchronize the state for an external connector.
401 * @edev: the extcon device
403 * Note that this function send a notification in order to synchronize
404 * the state and property of an external connector.
406 * Returns 0 if success or error number if fail.
408 int extcon_sync(struct extcon_dev
*edev
, unsigned int id
)
423 index
= find_cable_index_by_id(edev
, id
);
427 spin_lock_irqsave(&edev
->lock
, flags
);
428 state
= !!(edev
->state
& BIT(index
));
429 spin_unlock_irqrestore(&edev
->lock
, flags
);
432 * Call functions in a raw notifier chain for the specific one
433 * external connector.
435 raw_notifier_call_chain(&edev
->nh
[index
], state
, edev
);
438 * Call functions in a raw notifier chain for the all supported
439 * external connectors.
441 raw_notifier_call_chain(&edev
->nh_all
, state
, edev
);
443 spin_lock_irqsave(&edev
->lock
, flags
);
444 /* This could be in interrupt handler */
445 prop_buf
= (char *)get_zeroed_page(GFP_ATOMIC
);
447 /* Unlock early before uevent */
448 spin_unlock_irqrestore(&edev
->lock
, flags
);
450 dev_err(&edev
->dev
, "out of memory in extcon_set_state\n");
451 kobject_uevent(&edev
->dev
.kobj
, KOBJ_CHANGE
);
456 length
= name_show(&edev
->dev
, NULL
, prop_buf
);
458 if (prop_buf
[length
- 1] == '\n')
459 prop_buf
[length
- 1] = 0;
460 snprintf(name_buf
, sizeof(name_buf
), "NAME=%s", prop_buf
);
461 envp
[env_offset
++] = name_buf
;
464 length
= state_show(&edev
->dev
, NULL
, prop_buf
);
466 if (prop_buf
[length
- 1] == '\n')
467 prop_buf
[length
- 1] = 0;
468 snprintf(state_buf
, sizeof(state_buf
), "STATE=%s", prop_buf
);
469 envp
[env_offset
++] = state_buf
;
471 envp
[env_offset
] = NULL
;
473 /* Unlock early before uevent */
474 spin_unlock_irqrestore(&edev
->lock
, flags
);
475 kobject_uevent_env(&edev
->dev
.kobj
, KOBJ_CHANGE
, envp
);
476 free_page((unsigned long)prop_buf
);
480 EXPORT_SYMBOL_GPL(extcon_sync
);
483 * extcon_get_state() - Get the state of an external connector.
484 * @edev: the extcon device
485 * @id: the unique id indicating an external connector
487 * Returns 0 if success or error number if fail.
489 int extcon_get_state(struct extcon_dev
*edev
, const unsigned int id
)
497 index
= find_cable_index_by_id(edev
, id
);
501 spin_lock_irqsave(&edev
->lock
, flags
);
502 state
= is_extcon_attached(edev
, index
);
503 spin_unlock_irqrestore(&edev
->lock
, flags
);
507 EXPORT_SYMBOL_GPL(extcon_get_state
);
510 * extcon_set_state() - Set the state of an external connector.
511 * @edev: the extcon device
512 * @id: the unique id indicating an external connector
513 * @state: the new state of an external connector.
514 * the default semantics is true: attached / false: detached.
516 * Note that this function set the state of an external connector without
517 * a notification. To synchronize the state of an external connector,
518 * have to use extcon_set_state_sync() and extcon_sync().
520 * Returns 0 if success or error number if fail.
522 int extcon_set_state(struct extcon_dev
*edev
, unsigned int id
, bool state
)
530 index
= find_cable_index_by_id(edev
, id
);
534 spin_lock_irqsave(&edev
->lock
, flags
);
536 /* Check whether the external connector's state is changed. */
537 if (!is_extcon_changed(edev
, index
, state
))
540 if (check_mutually_exclusive(edev
,
541 (edev
->state
& ~BIT(index
)) | (state
& BIT(index
)))) {
547 * Initialize the value of extcon property before setting
548 * the detached state for an external connector.
551 init_property(edev
, id
, index
);
553 /* Update the state for an external connector. */
555 edev
->state
|= BIT(index
);
557 edev
->state
&= ~(BIT(index
));
559 spin_unlock_irqrestore(&edev
->lock
, flags
);
563 EXPORT_SYMBOL_GPL(extcon_set_state
);
566 * extcon_set_state_sync() - Set the state of an external connector with sync.
567 * @edev: the extcon device
568 * @id: the unique id indicating an external connector
569 * @state: the new state of external connector.
570 * the default semantics is true: attached / false: detached.
572 * Note that this function set the state of external connector
573 * and synchronize the state by sending a notification.
575 * Returns 0 if success or error number if fail.
577 int extcon_set_state_sync(struct extcon_dev
*edev
, unsigned int id
, bool state
)
582 index
= find_cable_index_by_id(edev
, id
);
586 /* Check whether the external connector's state is changed. */
587 spin_lock_irqsave(&edev
->lock
, flags
);
588 ret
= is_extcon_changed(edev
, index
, state
);
589 spin_unlock_irqrestore(&edev
->lock
, flags
);
593 ret
= extcon_set_state(edev
, id
, state
);
597 return extcon_sync(edev
, id
);
599 EXPORT_SYMBOL_GPL(extcon_set_state_sync
);
602 * extcon_get_property() - Get the property value of an external connector.
603 * @edev: the extcon device
604 * @id: the unique id indicating an external connector
605 * @prop: the property id indicating an extcon property
606 * @prop_val: the pointer which store the value of extcon property
608 * Note that when getting the property value of external connector,
609 * the external connector should be attached. If detached state, function
610 * return 0 without property value. Also, the each property should be
611 * included in the list of supported properties according to extcon type.
613 * Returns 0 if success or error number if fail.
615 int extcon_get_property(struct extcon_dev
*edev
, unsigned int id
,
617 union extcon_property_value
*prop_val
)
619 struct extcon_cable
*cable
;
623 *prop_val
= (union extcon_property_value
){0};
628 /* Check whether the property is supported or not */
629 if (!is_extcon_property_supported(id
, prop
))
632 /* Find the cable index of external connector by using id */
633 index
= find_cable_index_by_id(edev
, id
);
637 spin_lock_irqsave(&edev
->lock
, flags
);
639 /* Check whether the property is available or not. */
640 if (!is_extcon_property_capability(edev
, id
, index
, prop
)) {
641 spin_unlock_irqrestore(&edev
->lock
, flags
);
646 * Check whether the external connector is attached.
647 * If external connector is detached, the user can not
648 * get the property value.
650 if (!is_extcon_attached(edev
, index
)) {
651 spin_unlock_irqrestore(&edev
->lock
, flags
);
655 cable
= &edev
->cables
[index
];
657 /* Get the property value according to extcon type */
659 case EXTCON_PROP_USB_MIN
... EXTCON_PROP_USB_MAX
:
660 *prop_val
= cable
->usb_propval
[prop
- EXTCON_PROP_USB_MIN
];
662 case EXTCON_PROP_CHG_MIN
... EXTCON_PROP_CHG_MAX
:
663 *prop_val
= cable
->chg_propval
[prop
- EXTCON_PROP_CHG_MIN
];
665 case EXTCON_PROP_JACK_MIN
... EXTCON_PROP_JACK_MAX
:
666 *prop_val
= cable
->jack_propval
[prop
- EXTCON_PROP_JACK_MIN
];
668 case EXTCON_PROP_DISP_MIN
... EXTCON_PROP_DISP_MAX
:
669 *prop_val
= cable
->disp_propval
[prop
- EXTCON_PROP_DISP_MIN
];
676 spin_unlock_irqrestore(&edev
->lock
, flags
);
680 EXPORT_SYMBOL_GPL(extcon_get_property
);
683 * extcon_set_property() - Set the property value of an external connector.
684 * @edev: the extcon device
685 * @id: the unique id indicating an external connector
686 * @prop: the property id indicating an extcon property
687 * @prop_val: the pointer including the new value of extcon property
689 * Note that each property should be included in the list of supported
690 * properties according to the extcon type.
692 * Returns 0 if success or error number if fail.
694 int extcon_set_property(struct extcon_dev
*edev
, unsigned int id
,
696 union extcon_property_value prop_val
)
698 struct extcon_cable
*cable
;
705 /* Check whether the property is supported or not */
706 if (!is_extcon_property_supported(id
, prop
))
709 /* Find the cable index of external connector by using id */
710 index
= find_cable_index_by_id(edev
, id
);
714 spin_lock_irqsave(&edev
->lock
, flags
);
716 /* Check whether the property is available or not. */
717 if (!is_extcon_property_capability(edev
, id
, index
, prop
)) {
718 spin_unlock_irqrestore(&edev
->lock
, flags
);
722 cable
= &edev
->cables
[index
];
724 /* Set the property value according to extcon type */
726 case EXTCON_PROP_USB_MIN
... EXTCON_PROP_USB_MAX
:
727 cable
->usb_propval
[prop
- EXTCON_PROP_USB_MIN
] = prop_val
;
729 case EXTCON_PROP_CHG_MIN
... EXTCON_PROP_CHG_MAX
:
730 cable
->chg_propval
[prop
- EXTCON_PROP_CHG_MIN
] = prop_val
;
732 case EXTCON_PROP_JACK_MIN
... EXTCON_PROP_JACK_MAX
:
733 cable
->jack_propval
[prop
- EXTCON_PROP_JACK_MIN
] = prop_val
;
735 case EXTCON_PROP_DISP_MIN
... EXTCON_PROP_DISP_MAX
:
736 cable
->disp_propval
[prop
- EXTCON_PROP_DISP_MIN
] = prop_val
;
743 spin_unlock_irqrestore(&edev
->lock
, flags
);
747 EXPORT_SYMBOL_GPL(extcon_set_property
);
750 * extcon_set_property_sync() - Set property of an external connector with sync.
751 * @prop_val: the pointer including the new value of extcon property
753 * Note that when setting the property value of external connector,
754 * the external connector should be attached. The each property should
755 * be included in the list of supported properties according to extcon type.
757 * Returns 0 if success or error number if fail.
759 int extcon_set_property_sync(struct extcon_dev
*edev
, unsigned int id
,
761 union extcon_property_value prop_val
)
765 ret
= extcon_set_property(edev
, id
, prop
, prop_val
);
769 return extcon_sync(edev
, id
);
771 EXPORT_SYMBOL_GPL(extcon_set_property_sync
);
774 * extcon_get_property_capability() - Get the capability of the property
775 * for an external connector.
776 * @edev: the extcon device
777 * @id: the unique id indicating an external connector
778 * @prop: the property id indicating an extcon property
780 * Returns 1 if the property is available or 0 if not available.
782 int extcon_get_property_capability(struct extcon_dev
*edev
, unsigned int id
,
790 /* Check whether the property is supported or not */
791 if (!is_extcon_property_supported(id
, prop
))
794 /* Find the cable index of external connector by using id */
795 index
= find_cable_index_by_id(edev
, id
);
799 return is_extcon_property_capability(edev
, id
, index
, prop
);
801 EXPORT_SYMBOL_GPL(extcon_get_property_capability
);
804 * extcon_set_property_capability() - Set the capability of the property
805 * for an external connector.
806 * @edev: the extcon device
807 * @id: the unique id indicating an external connector
808 * @prop: the property id indicating an extcon property
810 * Note that this function set the capability of the property
811 * for an external connector in order to mark the bit in capability
812 * bitmap which mean the available state of the property.
814 * Returns 0 if success or error number if fail.
816 int extcon_set_property_capability(struct extcon_dev
*edev
, unsigned int id
,
819 struct extcon_cable
*cable
;
820 int index
, type
, ret
= 0;
825 /* Check whether the property is supported or not. */
826 if (!is_extcon_property_supported(id
, prop
))
829 /* Find the cable index of external connector by using id. */
830 index
= find_cable_index_by_id(edev
, id
);
834 type
= get_extcon_type(prop
);
838 cable
= &edev
->cables
[index
];
841 case EXTCON_TYPE_USB
:
842 __set_bit(prop
- EXTCON_PROP_USB_MIN
, cable
->usb_bits
);
844 case EXTCON_TYPE_CHG
:
845 __set_bit(prop
- EXTCON_PROP_CHG_MIN
, cable
->chg_bits
);
847 case EXTCON_TYPE_JACK
:
848 __set_bit(prop
- EXTCON_PROP_JACK_MIN
, cable
->jack_bits
);
850 case EXTCON_TYPE_DISP
:
851 __set_bit(prop
- EXTCON_PROP_DISP_MIN
, cable
->disp_bits
);
859 EXPORT_SYMBOL_GPL(extcon_set_property_capability
);
862 * extcon_get_extcon_dev() - Get the extcon device instance from the name.
863 * @extcon_name: the extcon name provided with extcon_dev_register()
865 * Return the pointer of extcon device if success or ERR_PTR(err) if fail.
867 struct extcon_dev
*extcon_get_extcon_dev(const char *extcon_name
)
869 struct extcon_dev
*sd
;
872 return ERR_PTR(-EINVAL
);
874 mutex_lock(&extcon_dev_list_lock
);
875 list_for_each_entry(sd
, &extcon_dev_list
, entry
) {
876 if (!strcmp(sd
->name
, extcon_name
))
881 mutex_unlock(&extcon_dev_list_lock
);
884 EXPORT_SYMBOL_GPL(extcon_get_extcon_dev
);
887 * extcon_register_notifier() - Register a notifier block to get notified by
888 * any state changes from the extcon.
889 * @edev: the extcon device
890 * @id: the unique id indicating an external connector
891 * @nb: a notifier block to be registered
893 * Note that the second parameter given to the callback of nb (val) is
894 * the current state of an external connector and the third pameter
895 * is the pointer of extcon device.
897 * Returns 0 if success or error number if fail.
899 int extcon_register_notifier(struct extcon_dev
*edev
, unsigned int id
,
900 struct notifier_block
*nb
)
903 int ret
, idx
= -EINVAL
;
908 idx
= find_cable_index_by_id(edev
, id
);
912 spin_lock_irqsave(&edev
->lock
, flags
);
913 ret
= raw_notifier_chain_register(&edev
->nh
[idx
], nb
);
914 spin_unlock_irqrestore(&edev
->lock
, flags
);
918 EXPORT_SYMBOL_GPL(extcon_register_notifier
);
921 * extcon_unregister_notifier() - Unregister a notifier block from the extcon.
922 * @edev: the extcon device
923 * @id: the unique id indicating an external connector
924 * @nb: a notifier block to be registered
926 * Returns 0 if success or error number if fail.
928 int extcon_unregister_notifier(struct extcon_dev
*edev
, unsigned int id
,
929 struct notifier_block
*nb
)
937 idx
= find_cable_index_by_id(edev
, id
);
941 spin_lock_irqsave(&edev
->lock
, flags
);
942 ret
= raw_notifier_chain_unregister(&edev
->nh
[idx
], nb
);
943 spin_unlock_irqrestore(&edev
->lock
, flags
);
947 EXPORT_SYMBOL_GPL(extcon_unregister_notifier
);
950 * extcon_register_notifier_all() - Register a notifier block for all connectors.
951 * @edev: the extcon device
952 * @nb: a notifier block to be registered
954 * Note that this function registers a notifier block in order to receive
955 * the state change of all supported external connectors from extcon device.
956 * And the second parameter given to the callback of nb (val) is
957 * the current state and the third pameter is the pointer of extcon device.
959 * Returns 0 if success or error number if fail.
961 int extcon_register_notifier_all(struct extcon_dev
*edev
,
962 struct notifier_block
*nb
)
970 spin_lock_irqsave(&edev
->lock
, flags
);
971 ret
= raw_notifier_chain_register(&edev
->nh_all
, nb
);
972 spin_unlock_irqrestore(&edev
->lock
, flags
);
976 EXPORT_SYMBOL_GPL(extcon_register_notifier_all
);
979 * extcon_unregister_notifier_all() - Unregister a notifier block from extcon.
980 * @edev: the extcon device
981 * @nb: a notifier block to be registered
983 * Returns 0 if success or error number if fail.
985 int extcon_unregister_notifier_all(struct extcon_dev
*edev
,
986 struct notifier_block
*nb
)
994 spin_lock_irqsave(&edev
->lock
, flags
);
995 ret
= raw_notifier_chain_unregister(&edev
->nh_all
, nb
);
996 spin_unlock_irqrestore(&edev
->lock
, flags
);
1000 EXPORT_SYMBOL_GPL(extcon_unregister_notifier_all
);
1002 static struct attribute
*extcon_attrs
[] = {
1003 &dev_attr_state
.attr
,
1004 &dev_attr_name
.attr
,
1007 ATTRIBUTE_GROUPS(extcon
);
1009 static int create_extcon_class(void)
1011 if (!extcon_class
) {
1012 extcon_class
= class_create(THIS_MODULE
, "extcon");
1013 if (IS_ERR(extcon_class
))
1014 return PTR_ERR(extcon_class
);
1015 extcon_class
->dev_groups
= extcon_groups
;
1021 static void extcon_dev_release(struct device
*dev
)
1025 static const char *muex_name
= "mutually_exclusive";
1026 static void dummy_sysfs_dev_release(struct device
*dev
)
1031 * extcon_dev_allocate() - Allocate the memory of extcon device.
1032 * @supported_cable: the array of the supported external connectors
1033 * ending with EXTCON_NONE.
1035 * Note that this function allocates the memory for extcon device
1036 * and initialize default setting for the extcon device.
1038 * Returns the pointer memory of allocated extcon_dev if success
1039 * or ERR_PTR(err) if fail.
1041 struct extcon_dev
*extcon_dev_allocate(const unsigned int *supported_cable
)
1043 struct extcon_dev
*edev
;
1045 if (!supported_cable
)
1046 return ERR_PTR(-EINVAL
);
1048 edev
= kzalloc(sizeof(*edev
), GFP_KERNEL
);
1050 return ERR_PTR(-ENOMEM
);
1052 edev
->max_supported
= 0;
1053 edev
->supported_cable
= supported_cable
;
1059 * extcon_dev_free() - Free the memory of extcon device.
1060 * @edev: the extcon device
1062 void extcon_dev_free(struct extcon_dev
*edev
)
1066 EXPORT_SYMBOL_GPL(extcon_dev_free
);
1069 * extcon_dev_register() - Register an new extcon device
1070 * @edev: the extcon device to be registered
1072 * Among the members of edev struct, please set the "user initializing data"
1073 * do not set the values of "internal data", which are initialized by
1076 * Note that before calling this funciton, have to allocate the memory
1077 * of an extcon device by using the extcon_dev_allocate(). And the extcon
1078 * dev should include the supported_cable information.
1080 * Returns 0 if success or error number if fail.
1082 int extcon_dev_register(struct extcon_dev
*edev
)
1085 static atomic_t edev_no
= ATOMIC_INIT(-1);
1087 if (!extcon_class
) {
1088 ret
= create_extcon_class();
1093 if (!edev
|| !edev
->supported_cable
)
1096 for (; edev
->supported_cable
[index
] != EXTCON_NONE
; index
++);
1098 edev
->max_supported
= index
;
1099 if (index
> SUPPORTED_CABLE_MAX
) {
1101 "exceed the maximum number of supported cables\n");
1105 edev
->dev
.class = extcon_class
;
1106 edev
->dev
.release
= extcon_dev_release
;
1108 edev
->name
= dev_name(edev
->dev
.parent
);
1109 if (IS_ERR_OR_NULL(edev
->name
)) {
1111 "extcon device name is null\n");
1114 dev_set_name(&edev
->dev
, "extcon%lu",
1115 (unsigned long)atomic_inc_return(&edev_no
));
1117 if (edev
->max_supported
) {
1119 struct extcon_cable
*cable
;
1121 edev
->cables
= kcalloc(edev
->max_supported
,
1122 sizeof(struct extcon_cable
),
1124 if (!edev
->cables
) {
1126 goto err_sysfs_alloc
;
1128 for (index
= 0; index
< edev
->max_supported
; index
++) {
1129 cable
= &edev
->cables
[index
];
1131 str
= kasprintf(GFP_KERNEL
, "cable.%d", index
);
1133 for (index
--; index
>= 0; index
--) {
1134 cable
= &edev
->cables
[index
];
1135 kfree(cable
->attr_g
.name
);
1139 goto err_alloc_cables
;
1143 cable
->cable_index
= index
;
1144 cable
->attrs
[0] = &cable
->attr_name
.attr
;
1145 cable
->attrs
[1] = &cable
->attr_state
.attr
;
1146 cable
->attrs
[2] = NULL
;
1147 cable
->attr_g
.name
= str
;
1148 cable
->attr_g
.attrs
= cable
->attrs
;
1150 sysfs_attr_init(&cable
->attr_name
.attr
);
1151 cable
->attr_name
.attr
.name
= "name";
1152 cable
->attr_name
.attr
.mode
= 0444;
1153 cable
->attr_name
.show
= cable_name_show
;
1155 sysfs_attr_init(&cable
->attr_state
.attr
);
1156 cable
->attr_state
.attr
.name
= "state";
1157 cable
->attr_state
.attr
.mode
= 0444;
1158 cable
->attr_state
.show
= cable_state_show
;
1162 if (edev
->max_supported
&& edev
->mutually_exclusive
) {
1165 /* Count the size of mutually_exclusive array */
1166 for (index
= 0; edev
->mutually_exclusive
[index
]; index
++)
1169 edev
->attrs_muex
= kcalloc(index
+ 1,
1170 sizeof(struct attribute
*),
1172 if (!edev
->attrs_muex
) {
1177 edev
->d_attrs_muex
= kcalloc(index
,
1178 sizeof(struct device_attribute
),
1180 if (!edev
->d_attrs_muex
) {
1182 kfree(edev
->attrs_muex
);
1186 for (index
= 0; edev
->mutually_exclusive
[index
]; index
++) {
1187 name
= kasprintf(GFP_KERNEL
, "0x%x",
1188 edev
->mutually_exclusive
[index
]);
1190 for (index
--; index
>= 0; index
--) {
1191 kfree(edev
->d_attrs_muex
[index
].attr
.
1194 kfree(edev
->d_attrs_muex
);
1195 kfree(edev
->attrs_muex
);
1199 sysfs_attr_init(&edev
->d_attrs_muex
[index
].attr
);
1200 edev
->d_attrs_muex
[index
].attr
.name
= name
;
1201 edev
->d_attrs_muex
[index
].attr
.mode
= 0000;
1202 edev
->attrs_muex
[index
] = &edev
->d_attrs_muex
[index
]
1205 edev
->attr_g_muex
.name
= muex_name
;
1206 edev
->attr_g_muex
.attrs
= edev
->attrs_muex
;
1210 if (edev
->max_supported
) {
1211 edev
->extcon_dev_type
.groups
=
1212 kcalloc(edev
->max_supported
+ 2,
1213 sizeof(struct attribute_group
*),
1215 if (!edev
->extcon_dev_type
.groups
) {
1217 goto err_alloc_groups
;
1220 edev
->extcon_dev_type
.name
= dev_name(&edev
->dev
);
1221 edev
->extcon_dev_type
.release
= dummy_sysfs_dev_release
;
1223 for (index
= 0; index
< edev
->max_supported
; index
++)
1224 edev
->extcon_dev_type
.groups
[index
] =
1225 &edev
->cables
[index
].attr_g
;
1226 if (edev
->mutually_exclusive
)
1227 edev
->extcon_dev_type
.groups
[index
] =
1230 edev
->dev
.type
= &edev
->extcon_dev_type
;
1233 ret
= device_register(&edev
->dev
);
1235 put_device(&edev
->dev
);
1239 spin_lock_init(&edev
->lock
);
1240 edev
->nh
= devm_kcalloc(&edev
->dev
, edev
->max_supported
,
1241 sizeof(*edev
->nh
), GFP_KERNEL
);
1247 for (index
= 0; index
< edev
->max_supported
; index
++)
1248 RAW_INIT_NOTIFIER_HEAD(&edev
->nh
[index
]);
1250 RAW_INIT_NOTIFIER_HEAD(&edev
->nh_all
);
1252 dev_set_drvdata(&edev
->dev
, edev
);
1255 mutex_lock(&extcon_dev_list_lock
);
1256 list_add(&edev
->entry
, &extcon_dev_list
);
1257 mutex_unlock(&extcon_dev_list_lock
);
1262 if (edev
->max_supported
)
1263 kfree(edev
->extcon_dev_type
.groups
);
1265 if (edev
->max_supported
&& edev
->mutually_exclusive
) {
1266 for (index
= 0; edev
->mutually_exclusive
[index
]; index
++)
1267 kfree(edev
->d_attrs_muex
[index
].attr
.name
);
1268 kfree(edev
->d_attrs_muex
);
1269 kfree(edev
->attrs_muex
);
1272 for (index
= 0; index
< edev
->max_supported
; index
++)
1273 kfree(edev
->cables
[index
].attr_g
.name
);
1275 if (edev
->max_supported
)
1276 kfree(edev
->cables
);
1280 EXPORT_SYMBOL_GPL(extcon_dev_register
);
1283 * extcon_dev_unregister() - Unregister the extcon device.
1284 * @edev: the extcon device to be unregistered.
1286 * Note that this does not call kfree(edev) because edev was not allocated
1289 void extcon_dev_unregister(struct extcon_dev
*edev
)
1296 mutex_lock(&extcon_dev_list_lock
);
1297 list_del(&edev
->entry
);
1298 mutex_unlock(&extcon_dev_list_lock
);
1300 if (IS_ERR_OR_NULL(get_device(&edev
->dev
))) {
1301 dev_err(&edev
->dev
, "Failed to unregister extcon_dev (%s)\n",
1302 dev_name(&edev
->dev
));
1306 device_unregister(&edev
->dev
);
1308 if (edev
->mutually_exclusive
&& edev
->max_supported
) {
1309 for (index
= 0; edev
->mutually_exclusive
[index
];
1311 kfree(edev
->d_attrs_muex
[index
].attr
.name
);
1312 kfree(edev
->d_attrs_muex
);
1313 kfree(edev
->attrs_muex
);
1316 for (index
= 0; index
< edev
->max_supported
; index
++)
1317 kfree(edev
->cables
[index
].attr_g
.name
);
1319 if (edev
->max_supported
) {
1320 kfree(edev
->extcon_dev_type
.groups
);
1321 kfree(edev
->cables
);
1324 put_device(&edev
->dev
);
1326 EXPORT_SYMBOL_GPL(extcon_dev_unregister
);
1331 * extcon_find_edev_by_node - Find the extcon device from devicetree.
1332 * @node : OF node identifying edev
1334 * Return the pointer of extcon device if success or ERR_PTR(err) if fail.
1336 struct extcon_dev
*extcon_find_edev_by_node(struct device_node
*node
)
1338 struct extcon_dev
*edev
;
1340 mutex_lock(&extcon_dev_list_lock
);
1341 list_for_each_entry(edev
, &extcon_dev_list
, entry
)
1342 if (edev
->dev
.parent
&& edev
->dev
.parent
->of_node
== node
)
1344 edev
= ERR_PTR(-EPROBE_DEFER
);
1346 mutex_unlock(&extcon_dev_list_lock
);
1352 * extcon_get_edev_by_phandle - Get the extcon device from devicetree.
1353 * @dev : the instance to the given device
1354 * @index : the index into list of extcon_dev
1356 * Return the pointer of extcon device if success or ERR_PTR(err) if fail.
1358 struct extcon_dev
*extcon_get_edev_by_phandle(struct device
*dev
, int index
)
1360 struct device_node
*node
;
1361 struct extcon_dev
*edev
;
1364 return ERR_PTR(-EINVAL
);
1366 if (!dev
->of_node
) {
1367 dev_dbg(dev
, "device does not have a device node entry\n");
1368 return ERR_PTR(-EINVAL
);
1371 node
= of_parse_phandle(dev
->of_node
, "extcon", index
);
1373 dev_dbg(dev
, "failed to get phandle in %pOF node\n",
1375 return ERR_PTR(-ENODEV
);
1378 edev
= extcon_find_edev_by_node(node
);
1386 struct extcon_dev
*extcon_find_edev_by_node(struct device_node
*node
)
1388 return ERR_PTR(-ENOSYS
);
1391 struct extcon_dev
*extcon_get_edev_by_phandle(struct device
*dev
, int index
)
1393 return ERR_PTR(-ENOSYS
);
1396 #endif /* CONFIG_OF */
1398 EXPORT_SYMBOL_GPL(extcon_find_edev_by_node
);
1399 EXPORT_SYMBOL_GPL(extcon_get_edev_by_phandle
);
1402 * extcon_get_edev_name() - Get the name of the extcon device.
1403 * @edev: the extcon device
1405 const char *extcon_get_edev_name(struct extcon_dev
*edev
)
1407 return !edev
? NULL
: edev
->name
;
1410 static int __init
extcon_class_init(void)
1412 return create_extcon_class();
1414 module_init(extcon_class_init
);
1416 static void __exit
extcon_class_exit(void)
1418 class_destroy(extcon_class
);
1420 module_exit(extcon_class_exit
);
1422 MODULE_AUTHOR("Chanwoo Choi <cw00.choi@samsung.com>");
1423 MODULE_AUTHOR("MyungJoo Ham <myungjoo.ham@samsung.com>");
1424 MODULE_DESCRIPTION("External Connector (extcon) framework");
1425 MODULE_LICENSE("GPL v2");