xref: /linux/drivers/extcon/extcon.h (revision 3839a7460721b87501134697b7b90c45dcc7825d)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __LINUX_EXTCON_INTERNAL_H__
3 #define __LINUX_EXTCON_INTERNAL_H__
4 
5 #include <linux/extcon-provider.h>
6 
7 /**
8  * struct extcon_dev - An extcon device represents one external connector.
9  * @name:		The name of this extcon device. Parent device name is
10  *			used if NULL.
11  * @supported_cable:	Array of supported cable names ending with EXTCON_NONE.
12  *			If supported_cable is NULL, cable name related APIs
13  *			are disabled.
14  * @mutually_exclusive:	Array of mutually exclusive set of cables that cannot
15  *			be attached simultaneously. The array should be
16  *			ending with NULL or be NULL (no mutually exclusive
17  *			cables). For example, if it is { 0x7, 0x30, 0}, then,
18  *			{0, 1}, {0, 1, 2}, {0, 2}, {1, 2}, or {4, 5} cannot
19  *			be attached simulataneously. {0x7, 0} is equivalent to
20  *			{0x3, 0x6, 0x5, 0}. If it is {0xFFFFFFFF, 0}, there
21  *			can be no simultaneous connections.
22  * @dev:		Device of this extcon.
23  * @state:		Attach/detach state of this extcon. Do not provide at
24  *			register-time.
25  * @nh_all:		Notifier for the state change events for all supported
26  *			external connectors from this extcon.
27  * @nh:			Notifier for the state change events from this extcon
28  * @entry:		To support list of extcon devices so that users can
29  *			search for extcon devices based on the extcon name.
30  * @lock:
31  * @max_supported:	Internal value to store the number of cables.
32  * @extcon_dev_type:	Device_type struct to provide attribute_groups
33  *			customized for each extcon device.
34  * @cables:		Sysfs subdirectories. Each represents one cable.
35  *
36  * In most cases, users only need to provide "User initializing data" of
37  * this struct when registering an extcon. In some exceptional cases,
38  * optional callbacks may be needed. However, the values in "internal data"
39  * are overwritten by register function.
40  */
41 struct extcon_dev {
42 	/* Optional user initializing data */
43 	const char *name;
44 	const unsigned int *supported_cable;
45 	const u32 *mutually_exclusive;
46 
47 	/* Internal data. Please do not set. */
48 	struct device dev;
49 	struct raw_notifier_head nh_all;
50 	struct raw_notifier_head *nh;
51 	struct list_head entry;
52 	int max_supported;
53 	spinlock_t lock;	/* could be called by irq handler */
54 	u32 state;
55 
56 	/* /sys/class/extcon/.../cable.n/... */
57 	struct device_type extcon_dev_type;
58 	struct extcon_cable *cables;
59 
60 	/* /sys/class/extcon/.../mutually_exclusive/... */
61 	struct attribute_group attr_g_muex;
62 	struct attribute **attrs_muex;
63 	struct device_attribute *d_attrs_muex;
64 };
65 
66 #endif /* __LINUX_EXTCON_INTERNAL_H__ */
67