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