Commit | Line | Data |
---|---|---|
de55d871 MH |
1 | /* |
2 | * External connector (extcon) class driver | |
3 | * | |
4 | * Copyright (C) 2012 Samsung Electronics | |
5 | * Author: Donggeun Kim <dg77.kim@samsung.com> | |
6 | * Author: MyungJoo Ham <myungjoo.ham@samsung.com> | |
7 | * | |
8 | * based on switch class driver | |
9 | * Copyright (C) 2008 Google, Inc. | |
10 | * Author: Mike Lockwood <lockwood@android.com> | |
11 | * | |
12 | * This software is licensed under the terms of the GNU General Public | |
13 | * License version 2, as published by the Free Software Foundation, and | |
14 | * may be copied, distributed, and modified under those terms. | |
15 | * | |
16 | * This program is distributed in the hope that it will be useful, | |
17 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | * GNU General Public License for more details. | |
20 | * | |
21 | */ | |
22 | ||
23 | #ifndef __LINUX_EXTCON_H__ | |
24 | #define __LINUX_EXTCON_H__ | |
25 | ||
d851718f | 26 | #include <linux/device.h> |
74c5d09b | 27 | #include <linux/notifier.h> |
d851718f | 28 | #include <linux/sysfs.h> |
806d9dd7 MH |
29 | |
30 | #define SUPPORTED_CABLE_MAX 32 | |
31 | #define CABLE_NAME_MAX 30 | |
32 | ||
33 | /* | |
34 | * The standard cable name is to help support general notifier | |
c338bb03 | 35 | * and notifiee device drivers to share the common names. |
806d9dd7 MH |
36 | * Please use standard cable names unless your notifier device has |
37 | * a very unique and abnormal cable or | |
38 | * the cable type is supposed to be used with only one unique | |
c338bb03 | 39 | * pair of notifier/notifiee devices. |
806d9dd7 MH |
40 | * |
41 | * Please add any other "standard" cables used with extcon dev. | |
42 | * | |
43 | * You may add a dot and number to specify version or specification | |
44 | * of the specific cable if it is required. (e.g., "Fast-charger.18" | |
45 | * and "Fast-charger.10" for 1.8A and 1.0A chargers) | |
c338bb03 PM |
46 | * However, the notifiee and notifier should be able to handle such |
47 | * string and if the notifiee can negotiate the protocol or identify, | |
806d9dd7 MH |
48 | * you don't need such convention. This convention is helpful when |
49 | * notifier can distinguish but notifiee cannot. | |
50 | */ | |
51 | enum extcon_cable_name { | |
52 | EXTCON_USB = 0, | |
53 | EXTCON_USB_HOST, | |
a75e1c73 | 54 | EXTCON_TA, /* Travel Adaptor */ |
806d9dd7 MH |
55 | EXTCON_FAST_CHARGER, |
56 | EXTCON_SLOW_CHARGER, | |
a75e1c73 | 57 | EXTCON_CHARGE_DOWNSTREAM, /* Charging an external device */ |
806d9dd7 MH |
58 | EXTCON_HDMI, |
59 | EXTCON_MHL, | |
60 | EXTCON_DVI, | |
61 | EXTCON_VGA, | |
62 | EXTCON_DOCK, | |
63 | EXTCON_LINE_IN, | |
64 | EXTCON_LINE_OUT, | |
65 | EXTCON_MIC_IN, | |
66 | EXTCON_HEADPHONE_OUT, | |
67 | EXTCON_SPDIF_IN, | |
68 | EXTCON_SPDIF_OUT, | |
69 | EXTCON_VIDEO_IN, | |
70 | EXTCON_VIDEO_OUT, | |
0e1507c8 | 71 | EXTCON_MECHANICAL, |
806d9dd7 | 72 | }; |
0cf6ad8a | 73 | extern const char extcon_cable_name[][CABLE_NAME_MAX + 1]; |
806d9dd7 MH |
74 | |
75 | struct extcon_cable; | |
76 | ||
de55d871 MH |
77 | /** |
78 | * struct extcon_dev - An extcon device represents one external connector. | |
a75e1c73 CC |
79 | * @name: The name of this extcon device. Parent device name is |
80 | * used if NULL. | |
df072eb9 | 81 | * @supported_cable: Array of supported cable names ending with NULL. |
806d9dd7 MH |
82 | * If supported_cable is NULL, cable name related APIs |
83 | * are disabled. | |
df072eb9 | 84 | * @mutually_exclusive: Array of mutually exclusive set of cables that cannot |
bde68e60 MH |
85 | * be attached simultaneously. The array should be |
86 | * ending with NULL or be NULL (no mutually exclusive | |
87 | * cables). For example, if it is { 0x7, 0x30, 0}, then, | |
88 | * {0, 1}, {0, 1, 2}, {0, 2}, {1, 2}, or {4, 5} cannot | |
89 | * be attached simulataneously. {0x7, 0} is equivalent to | |
90 | * {0x3, 0x6, 0x5, 0}. If it is {0xFFFFFFFF, 0}, there | |
91 | * can be no simultaneous connections. | |
a75e1c73 CC |
92 | * @print_name: An optional callback to override the method to print the |
93 | * name of the extcon device. | |
df072eb9 | 94 | * @print_state: An optional callback to override the method to print the |
a75e1c73 | 95 | * status of the extcon device. |
dae61651 | 96 | * @dev: Device of this extcon. |
a75e1c73 CC |
97 | * @state: Attach/detach state of this extcon. Do not provide at |
98 | * register-time. | |
99 | * @nh: Notifier for the state change events from this extcon | |
100 | * @entry: To support list of extcon devices so that users can search | |
101 | * for extcon devices based on the extcon name. | |
df072eb9 MH |
102 | * @lock: |
103 | * @max_supported: Internal value to store the number of cables. | |
104 | * @extcon_dev_type: Device_type struct to provide attribute_groups | |
806d9dd7 | 105 | * customized for each extcon device. |
a75e1c73 | 106 | * @cables: Sysfs subdirectories. Each represents one cable. |
de55d871 MH |
107 | * |
108 | * In most cases, users only need to provide "User initializing data" of | |
109 | * this struct when registering an extcon. In some exceptional cases, | |
110 | * optional callbacks may be needed. However, the values in "internal data" | |
111 | * are overwritten by register function. | |
112 | */ | |
113 | struct extcon_dev { | |
a75e1c73 CC |
114 | /* Optional user initializing data */ |
115 | const char *name; | |
806d9dd7 | 116 | const char **supported_cable; |
a75e1c73 | 117 | const u32 *mutually_exclusive; |
de55d871 | 118 | |
a75e1c73 | 119 | /* Optional callbacks to override class functions */ |
de55d871 MH |
120 | ssize_t (*print_name)(struct extcon_dev *edev, char *buf); |
121 | ssize_t (*print_state)(struct extcon_dev *edev, char *buf); | |
122 | ||
a75e1c73 | 123 | /* Internal data. Please do not set. */ |
dae61651 | 124 | struct device dev; |
74c5d09b DK |
125 | struct raw_notifier_head nh; |
126 | struct list_head entry; | |
806d9dd7 | 127 | int max_supported; |
a75e1c73 CC |
128 | spinlock_t lock; /* could be called by irq handler */ |
129 | u32 state; | |
806d9dd7 MH |
130 | |
131 | /* /sys/class/extcon/.../cable.n/... */ | |
132 | struct device_type extcon_dev_type; | |
133 | struct extcon_cable *cables; | |
a75e1c73 | 134 | |
bde68e60 MH |
135 | /* /sys/class/extcon/.../mutually_exclusive/... */ |
136 | struct attribute_group attr_g_muex; | |
137 | struct attribute **attrs_muex; | |
138 | struct device_attribute *d_attrs_muex; | |
806d9dd7 MH |
139 | }; |
140 | ||
141 | /** | |
a75e1c73 CC |
142 | * struct extcon_cable - An internal data for each cable of extcon device. |
143 | * @edev: The extcon device | |
df072eb9 | 144 | * @cable_index: Index of this cable in the edev |
a75e1c73 CC |
145 | * @attr_g: Attribute group for the cable |
146 | * @attr_name: "name" sysfs entry | |
147 | * @attr_state: "state" sysfs entry | |
148 | * @attrs: Array pointing to attr_name and attr_state for attr_g | |
806d9dd7 MH |
149 | */ |
150 | struct extcon_cable { | |
151 | struct extcon_dev *edev; | |
152 | int cable_index; | |
153 | ||
154 | struct attribute_group attr_g; | |
155 | struct device_attribute attr_name; | |
156 | struct device_attribute attr_state; | |
157 | ||
158 | struct attribute *attrs[3]; /* to be fed to attr_g.attrs */ | |
159 | }; | |
160 | ||
161 | /** | |
162 | * struct extcon_specific_cable_nb - An internal data for | |
a75e1c73 CC |
163 | * extcon_register_interest(). |
164 | * @internal_nb: A notifier block bridging extcon notifier | |
165 | * and cable notifier. | |
166 | * @user_nb: user provided notifier block for events from | |
167 | * a specific cable. | |
df072eb9 | 168 | * @cable_index: the target cable. |
a75e1c73 | 169 | * @edev: the target extcon device. |
df072eb9 | 170 | * @previous_value: the saved previous event value. |
806d9dd7 MH |
171 | */ |
172 | struct extcon_specific_cable_nb { | |
173 | struct notifier_block internal_nb; | |
174 | struct notifier_block *user_nb; | |
175 | int cable_index; | |
176 | struct extcon_dev *edev; | |
177 | unsigned long previous_value; | |
de55d871 MH |
178 | }; |
179 | ||
180 | #if IS_ENABLED(CONFIG_EXTCON) | |
74c5d09b DK |
181 | |
182 | /* | |
183 | * Following APIs are for notifiers or configurations. | |
184 | * Notifiers are the external port and connection devices. | |
185 | */ | |
42d7d753 | 186 | extern int extcon_dev_register(struct extcon_dev *edev); |
de55d871 | 187 | extern void extcon_dev_unregister(struct extcon_dev *edev); |
74c5d09b | 188 | extern struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name); |
de55d871 | 189 | |
806d9dd7 MH |
190 | /* |
191 | * get/set/update_state access the 32b encoded state value, which represents | |
192 | * states of all possible cables of the multistate port. For example, if one | |
193 | * calls extcon_set_state(edev, 0x7), it may mean that all the three cables | |
194 | * are attached to the port. | |
195 | */ | |
de55d871 MH |
196 | static inline u32 extcon_get_state(struct extcon_dev *edev) |
197 | { | |
198 | return edev->state; | |
199 | } | |
200 | ||
bde68e60 MH |
201 | extern int extcon_set_state(struct extcon_dev *edev, u32 state); |
202 | extern int extcon_update_state(struct extcon_dev *edev, u32 mask, u32 state); | |
806d9dd7 MH |
203 | |
204 | /* | |
205 | * get/set_cable_state access each bit of the 32b encoded state value. | |
206 | * They are used to access the status of each cable based on the cable_name | |
c338bb03 | 207 | * or cable_index, which is retrieved by extcon_find_cable_index |
806d9dd7 MH |
208 | */ |
209 | extern int extcon_find_cable_index(struct extcon_dev *sdev, | |
210 | const char *cable_name); | |
211 | extern int extcon_get_cable_state_(struct extcon_dev *edev, int cable_index); | |
212 | extern int extcon_set_cable_state_(struct extcon_dev *edev, int cable_index, | |
213 | bool cable_state); | |
214 | ||
215 | extern int extcon_get_cable_state(struct extcon_dev *edev, | |
216 | const char *cable_name); | |
217 | extern int extcon_set_cable_state(struct extcon_dev *edev, | |
218 | const char *cable_name, bool cable_state); | |
219 | ||
220 | /* | |
221 | * Following APIs are for notifiees (those who want to be notified) | |
222 | * to register a callback for events from a specific cable of the extcon. | |
223 | * Notifiees are the connected device drivers wanting to get notified by | |
224 | * a specific external port of a connection device. | |
225 | */ | |
226 | extern int extcon_register_interest(struct extcon_specific_cable_nb *obj, | |
227 | const char *extcon_name, | |
228 | const char *cable_name, | |
229 | struct notifier_block *nb); | |
230 | extern int extcon_unregister_interest(struct extcon_specific_cable_nb *nb); | |
74c5d09b DK |
231 | |
232 | /* | |
233 | * Following APIs are to monitor every action of a notifier. | |
c338bb03 | 234 | * Registrar gets notified for every external port of a connection device. |
806d9dd7 | 235 | * Probably this could be used to debug an action of notifier; however, |
c338bb03 | 236 | * we do not recommend to use this for normal 'notifiee' device drivers who |
806d9dd7 | 237 | * want to be notified by a specific external port of the notifier. |
74c5d09b DK |
238 | */ |
239 | extern int extcon_register_notifier(struct extcon_dev *edev, | |
240 | struct notifier_block *nb); | |
241 | extern int extcon_unregister_notifier(struct extcon_dev *edev, | |
242 | struct notifier_block *nb); | |
de55d871 | 243 | #else /* CONFIG_EXTCON */ |
42d7d753 | 244 | static inline int extcon_dev_register(struct extcon_dev *edev) |
de55d871 MH |
245 | { |
246 | return 0; | |
247 | } | |
248 | ||
249 | static inline void extcon_dev_unregister(struct extcon_dev *edev) { } | |
250 | ||
251 | static inline u32 extcon_get_state(struct extcon_dev *edev) | |
252 | { | |
253 | return 0; | |
254 | } | |
255 | ||
bde68e60 MH |
256 | static inline int extcon_set_state(struct extcon_dev *edev, u32 state) |
257 | { | |
258 | return 0; | |
259 | } | |
806d9dd7 | 260 | |
bde68e60 | 261 | static inline int extcon_update_state(struct extcon_dev *edev, u32 mask, |
806d9dd7 | 262 | u32 state) |
bde68e60 MH |
263 | { |
264 | return 0; | |
265 | } | |
806d9dd7 MH |
266 | |
267 | static inline int extcon_find_cable_index(struct extcon_dev *edev, | |
268 | const char *cable_name) | |
269 | { | |
270 | return 0; | |
271 | } | |
272 | ||
273 | static inline int extcon_get_cable_state_(struct extcon_dev *edev, | |
274 | int cable_index) | |
275 | { | |
276 | return 0; | |
277 | } | |
278 | ||
279 | static inline int extcon_set_cable_state_(struct extcon_dev *edev, | |
280 | int cable_index, bool cable_state) | |
281 | { | |
282 | return 0; | |
283 | } | |
284 | ||
285 | static inline int extcon_get_cable_state(struct extcon_dev *edev, | |
286 | const char *cable_name) | |
287 | { | |
288 | return 0; | |
289 | } | |
290 | ||
291 | static inline int extcon_set_cable_state(struct extcon_dev *edev, | |
292 | const char *cable_name, int state) | |
293 | { | |
294 | return 0; | |
295 | } | |
296 | ||
74c5d09b DK |
297 | static inline struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name) |
298 | { | |
299 | return NULL; | |
300 | } | |
301 | ||
302 | static inline int extcon_register_notifier(struct extcon_dev *edev, | |
303 | struct notifier_block *nb) | |
304 | { | |
305 | return 0; | |
306 | } | |
307 | ||
308 | static inline int extcon_unregister_notifier(struct extcon_dev *edev, | |
309 | struct notifier_block *nb) | |
310 | { | |
311 | return 0; | |
312 | } | |
313 | ||
806d9dd7 MH |
314 | static inline int extcon_register_interest(struct extcon_specific_cable_nb *obj, |
315 | const char *extcon_name, | |
316 | const char *cable_name, | |
317 | struct notifier_block *nb) | |
318 | { | |
319 | return 0; | |
320 | } | |
321 | ||
322 | static inline int extcon_unregister_interest(struct extcon_specific_cable_nb | |
323 | *obj) | |
324 | { | |
325 | return 0; | |
326 | } | |
de55d871 MH |
327 | #endif /* CONFIG_EXTCON */ |
328 | #endif /* __LINUX_EXTCON_H__ */ |