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> |
806d9dd7 | 30 | |
55e4e2f1 CC |
31 | /* |
32 | * Define the type of supported external connectors | |
33 | */ | |
34 | #define EXTCON_TYPE_USB BIT(0) /* USB connector */ | |
35 | #define EXTCON_TYPE_CHG BIT(1) /* Charger connector */ | |
36 | #define EXTCON_TYPE_JACK BIT(2) /* Jack connector */ | |
37 | #define EXTCON_TYPE_DISP BIT(3) /* Display connector */ | |
38 | #define EXTCON_TYPE_MISC BIT(4) /* Miscellaneous connector */ | |
39 | ||
73b6ecdb CC |
40 | /* |
41 | * Define the unique id of supported external connectors | |
42 | */ | |
11eecf91 | 43 | #define EXTCON_NONE 0 |
73b6ecdb | 44 | |
11eecf91 CC |
45 | /* USB external connector */ |
46 | #define EXTCON_USB 1 | |
47 | #define EXTCON_USB_HOST 2 | |
73b6ecdb | 48 | |
11eecf91 CC |
49 | /* Charging external connector */ |
50 | #define EXTCON_CHG_USB_SDP 5 /* Standard Downstream Port */ | |
51 | #define EXTCON_CHG_USB_DCP 6 /* Dedicated Charging Port */ | |
52 | #define EXTCON_CHG_USB_CDP 7 /* Charging Downstream Port */ | |
53 | #define EXTCON_CHG_USB_ACA 8 /* Accessory Charger Adapter */ | |
54 | #define EXTCON_CHG_USB_FAST 9 | |
55 | #define EXTCON_CHG_USB_SLOW 10 | |
73b6ecdb | 56 | |
11eecf91 CC |
57 | /* Jack external connector */ |
58 | #define EXTCON_JACK_MICROPHONE 20 | |
59 | #define EXTCON_JACK_HEADPHONE 21 | |
60 | #define EXTCON_JACK_LINE_IN 22 | |
61 | #define EXTCON_JACK_LINE_OUT 23 | |
62 | #define EXTCON_JACK_VIDEO_IN 24 | |
63 | #define EXTCON_JACK_VIDEO_OUT 25 | |
64 | #define EXTCON_JACK_SPDIF_IN 26 /* Sony Philips Digital InterFace */ | |
65 | #define EXTCON_JACK_SPDIF_OUT 27 | |
73b6ecdb | 66 | |
11eecf91 CC |
67 | /* Display external connector */ |
68 | #define EXTCON_DISP_HDMI 40 /* High-Definition Multimedia Interface */ | |
69 | #define EXTCON_DISP_MHL 41 /* Mobile High-Definition Link */ | |
70 | #define EXTCON_DISP_DVI 42 /* Digital Visual Interface */ | |
71 | #define EXTCON_DISP_VGA 43 /* Video Graphics Array */ | |
72 | ||
73 | /* Miscellaneous external connector */ | |
74 | #define EXTCON_DOCK 60 | |
75 | #define EXTCON_JIG 61 | |
76 | #define EXTCON_MECHANICAL 62 | |
77 | ||
78 | #define EXTCON_NUM 63 | |
806d9dd7 | 79 | |
792e7e9e CC |
80 | /* |
81 | * Define the property of supported external connectors. | |
82 | * | |
83 | * When adding the new extcon property, they *must* have | |
84 | * the type/value/default information. Also, you *have to* | |
85 | * modify the EXTCON_PROP_[type]_START/END definitions | |
86 | * which mean the range of the supported properties | |
87 | * for each extcon type. | |
88 | * | |
89 | * The naming style of property | |
90 | * : EXTCON_PROP_[type]_[property name] | |
91 | * | |
92 | * EXTCON_PROP_USB_[property name] : USB property | |
93 | * EXTCON_PROP_CHG_[property name] : Charger property | |
94 | * EXTCON_PROP_JACK_[property name] : Jack property | |
95 | * EXTCON_PROP_DISP_[property name] : Display property | |
96 | */ | |
97 | ||
98 | /* | |
99 | * Properties of EXTCON_TYPE_USB. | |
100 | * | |
101 | * - EXTCON_PROP_USB_VBUS | |
102 | * @type: integer (intval) | |
103 | * @value: 0 (low) or 1 (high) | |
104 | * @default: 0 (low) | |
105 | */ | |
106 | #define EXTCON_PROP_USB_VBUS 0 | |
107 | ||
108 | #define EXTCON_PROP_USB_MIN 0 | |
109 | #define EXTCON_PROP_USB_MAX 0 | |
110 | #define EXTCON_PROP_USB_CNT (EXTCON_PROP_USB_MAX - EXTCON_PROP_USB_MIN + 1) | |
111 | ||
112 | /* Properties of EXTCON_TYPE_CHG. */ | |
113 | #define EXTCON_PROP_CHG_MIN 50 | |
114 | #define EXTCON_PROP_CHG_MAX 50 | |
115 | #define EXTCON_PROP_CHG_CNT (EXTCON_PROP_CHG_MAX - EXTCON_PROP_CHG_MIN + 1) | |
116 | ||
117 | /* Properties of EXTCON_TYPE_JACK. */ | |
118 | #define EXTCON_PROP_JACK_MIN 100 | |
119 | #define EXTCON_PROP_JACK_MAX 100 | |
120 | #define EXTCON_PROP_JACK_CNT (EXTCON_PROP_JACK_MAX - EXTCON_PROP_JACK_MIN + 1) | |
121 | ||
122 | /* Properties of EXTCON_TYPE_DISP. */ | |
123 | #define EXTCON_PROP_DISP_MIN 150 | |
124 | #define EXTCON_PROP_DISP_MAX 150 | |
125 | #define EXTCON_PROP_DISP_CNT (EXTCON_PROP_DISP_MAX - EXTCON_PROP_DISP_MIN + 1) | |
126 | ||
127 | /* | |
128 | * Define the type of property's value. | |
129 | * | |
130 | * Define the property's value as union type. Because each property | |
131 | * would need the different data type to store it. | |
132 | */ | |
133 | union extcon_property_value { | |
134 | int intval; /* type : integer (intval) */ | |
135 | }; | |
136 | ||
806d9dd7 MH |
137 | struct extcon_cable; |
138 | ||
de55d871 MH |
139 | /** |
140 | * struct extcon_dev - An extcon device represents one external connector. | |
a75e1c73 CC |
141 | * @name: The name of this extcon device. Parent device name is |
142 | * used if NULL. | |
2a9de9c0 | 143 | * @supported_cable: Array of supported cable names ending with EXTCON_NONE. |
806d9dd7 MH |
144 | * If supported_cable is NULL, cable name related APIs |
145 | * are disabled. | |
df072eb9 | 146 | * @mutually_exclusive: Array of mutually exclusive set of cables that cannot |
bde68e60 MH |
147 | * be attached simultaneously. The array should be |
148 | * ending with NULL or be NULL (no mutually exclusive | |
149 | * cables). For example, if it is { 0x7, 0x30, 0}, then, | |
150 | * {0, 1}, {0, 1, 2}, {0, 2}, {1, 2}, or {4, 5} cannot | |
151 | * be attached simulataneously. {0x7, 0} is equivalent to | |
152 | * {0x3, 0x6, 0x5, 0}. If it is {0xFFFFFFFF, 0}, there | |
153 | * can be no simultaneous connections. | |
dae61651 | 154 | * @dev: Device of this extcon. |
a75e1c73 CC |
155 | * @state: Attach/detach state of this extcon. Do not provide at |
156 | * register-time. | |
157 | * @nh: Notifier for the state change events from this extcon | |
b9ec23c0 CC |
158 | * @entry: To support list of extcon devices so that users can |
159 | * search for extcon devices based on the extcon name. | |
df072eb9 MH |
160 | * @lock: |
161 | * @max_supported: Internal value to store the number of cables. | |
162 | * @extcon_dev_type: Device_type struct to provide attribute_groups | |
806d9dd7 | 163 | * customized for each extcon device. |
a75e1c73 | 164 | * @cables: Sysfs subdirectories. Each represents one cable. |
de55d871 MH |
165 | * |
166 | * In most cases, users only need to provide "User initializing data" of | |
167 | * this struct when registering an extcon. In some exceptional cases, | |
168 | * optional callbacks may be needed. However, the values in "internal data" | |
169 | * are overwritten by register function. | |
170 | */ | |
171 | struct extcon_dev { | |
a75e1c73 CC |
172 | /* Optional user initializing data */ |
173 | const char *name; | |
73b6ecdb | 174 | const unsigned int *supported_cable; |
a75e1c73 | 175 | const u32 *mutually_exclusive; |
de55d871 | 176 | |
a75e1c73 | 177 | /* Internal data. Please do not set. */ |
dae61651 | 178 | struct device dev; |
046050f6 | 179 | struct raw_notifier_head *nh; |
74c5d09b | 180 | struct list_head entry; |
806d9dd7 | 181 | int max_supported; |
a75e1c73 CC |
182 | spinlock_t lock; /* could be called by irq handler */ |
183 | u32 state; | |
806d9dd7 MH |
184 | |
185 | /* /sys/class/extcon/.../cable.n/... */ | |
186 | struct device_type extcon_dev_type; | |
187 | struct extcon_cable *cables; | |
a75e1c73 | 188 | |
bde68e60 MH |
189 | /* /sys/class/extcon/.../mutually_exclusive/... */ |
190 | struct attribute_group attr_g_muex; | |
191 | struct attribute **attrs_muex; | |
192 | struct device_attribute *d_attrs_muex; | |
806d9dd7 MH |
193 | }; |
194 | ||
de55d871 | 195 | #if IS_ENABLED(CONFIG_EXTCON) |
74c5d09b DK |
196 | |
197 | /* | |
198 | * Following APIs are for notifiers or configurations. | |
199 | * Notifiers are the external port and connection devices. | |
200 | */ | |
42d7d753 | 201 | extern int extcon_dev_register(struct extcon_dev *edev); |
de55d871 | 202 | extern void extcon_dev_unregister(struct extcon_dev *edev); |
1111244f SW |
203 | extern int devm_extcon_dev_register(struct device *dev, |
204 | struct extcon_dev *edev); | |
205 | extern void devm_extcon_dev_unregister(struct device *dev, | |
206 | struct extcon_dev *edev); | |
74c5d09b | 207 | extern struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name); |
de55d871 | 208 | |
a9af6522 CC |
209 | /* |
210 | * Following APIs control the memory of extcon device. | |
211 | */ | |
73b6ecdb | 212 | extern struct extcon_dev *extcon_dev_allocate(const unsigned int *cable); |
a9af6522 | 213 | extern void extcon_dev_free(struct extcon_dev *edev); |
739ba1bf | 214 | extern struct extcon_dev *devm_extcon_dev_allocate(struct device *dev, |
73b6ecdb | 215 | const unsigned int *cable); |
739ba1bf | 216 | extern void devm_extcon_dev_free(struct device *dev, struct extcon_dev *edev); |
a9af6522 | 217 | |
806d9dd7 MH |
218 | /* |
219 | * get/set_cable_state access each bit of the 32b encoded state value. | |
bc921260 | 220 | * They are used to access the status of each cable based on the cable id. |
806d9dd7 | 221 | */ |
73b6ecdb CC |
222 | extern int extcon_get_cable_state_(struct extcon_dev *edev, unsigned int id); |
223 | extern int extcon_set_cable_state_(struct extcon_dev *edev, unsigned int id, | |
806d9dd7 MH |
224 | bool cable_state); |
225 | ||
792e7e9e CC |
226 | /* |
227 | * get/set_property access the property value of each external connector. | |
228 | * They are used to access the property of each cable based on the property id. | |
229 | */ | |
230 | extern int extcon_get_property(struct extcon_dev *edev, unsigned int id, | |
231 | unsigned int prop, | |
232 | union extcon_property_value *prop_val); | |
233 | extern int extcon_set_property(struct extcon_dev *edev, unsigned int id, | |
234 | unsigned int prop, | |
235 | union extcon_property_value prop_val); | |
236 | ||
74c5d09b DK |
237 | /* |
238 | * Following APIs are to monitor every action of a notifier. | |
c338bb03 | 239 | * Registrar gets notified for every external port of a connection device. |
806d9dd7 | 240 | * Probably this could be used to debug an action of notifier; however, |
c338bb03 | 241 | * we do not recommend to use this for normal 'notifiee' device drivers who |
806d9dd7 | 242 | * want to be notified by a specific external port of the notifier. |
74c5d09b | 243 | */ |
73b6ecdb | 244 | extern int extcon_register_notifier(struct extcon_dev *edev, unsigned int id, |
046050f6 | 245 | struct notifier_block *nb); |
73b6ecdb | 246 | extern int extcon_unregister_notifier(struct extcon_dev *edev, unsigned int id, |
74c5d09b | 247 | struct notifier_block *nb); |
58f38656 CC |
248 | extern int devm_extcon_register_notifier(struct device *dev, |
249 | struct extcon_dev *edev, unsigned int id, | |
250 | struct notifier_block *nb); | |
251 | extern void devm_extcon_unregister_notifier(struct device *dev, | |
252 | struct extcon_dev *edev, unsigned int id, | |
253 | struct notifier_block *nb); | |
1ad94ffe CC |
254 | |
255 | /* | |
256 | * Following API get the extcon device from devicetree. | |
257 | * This function use phandle of devicetree to get extcon device directly. | |
258 | */ | |
b9ec23c0 CC |
259 | extern struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev, |
260 | int index); | |
707d7550 CC |
261 | |
262 | /* Following API to get information of extcon device */ | |
263 | extern const char *extcon_get_edev_name(struct extcon_dev *edev); | |
264 | ||
830ae442 | 265 | |
de55d871 | 266 | #else /* CONFIG_EXTCON */ |
42d7d753 | 267 | static inline int extcon_dev_register(struct extcon_dev *edev) |
de55d871 MH |
268 | { |
269 | return 0; | |
270 | } | |
271 | ||
272 | static inline void extcon_dev_unregister(struct extcon_dev *edev) { } | |
273 | ||
1111244f SW |
274 | static inline int devm_extcon_dev_register(struct device *dev, |
275 | struct extcon_dev *edev) | |
276 | { | |
277 | return -EINVAL; | |
278 | } | |
279 | ||
280 | static inline void devm_extcon_dev_unregister(struct device *dev, | |
281 | struct extcon_dev *edev) { } | |
282 | ||
73b6ecdb | 283 | static inline struct extcon_dev *extcon_dev_allocate(const unsigned int *cable) |
a9af6522 CC |
284 | { |
285 | return ERR_PTR(-ENOSYS); | |
286 | } | |
287 | ||
288 | static inline void extcon_dev_free(struct extcon_dev *edev) { } | |
289 | ||
739ba1bf | 290 | static inline struct extcon_dev *devm_extcon_dev_allocate(struct device *dev, |
73b6ecdb | 291 | const unsigned int *cable) |
739ba1bf CC |
292 | { |
293 | return ERR_PTR(-ENOSYS); | |
294 | } | |
295 | ||
296 | static inline void devm_extcon_dev_free(struct extcon_dev *edev) { } | |
297 | ||
806d9dd7 | 298 | static inline int extcon_get_cable_state_(struct extcon_dev *edev, |
73b6ecdb | 299 | unsigned int id) |
806d9dd7 MH |
300 | { |
301 | return 0; | |
302 | } | |
303 | ||
304 | static inline int extcon_set_cable_state_(struct extcon_dev *edev, | |
73b6ecdb | 305 | unsigned int id, bool cable_state) |
806d9dd7 MH |
306 | { |
307 | return 0; | |
308 | } | |
309 | ||
792e7e9e CC |
310 | static inline int extcon_get_property(struct extcon_dev *edev, unsigned int id, |
311 | unsigned int prop, | |
312 | union extcon_property_value *prop_val) | |
313 | { | |
314 | return 0; | |
315 | } | |
316 | static inline int extcon_set_property(struct extcon_dev *edev, unsigned int id, | |
317 | unsigned int prop, | |
318 | union extcon_property_value prop_val) | |
319 | { | |
320 | return 0; | |
321 | } | |
322 | ||
74c5d09b DK |
323 | static inline struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name) |
324 | { | |
325 | return NULL; | |
326 | } | |
327 | ||
328 | static inline int extcon_register_notifier(struct extcon_dev *edev, | |
73b6ecdb | 329 | unsigned int id, |
046050f6 | 330 | struct notifier_block *nb) |
74c5d09b DK |
331 | { |
332 | return 0; | |
333 | } | |
334 | ||
335 | static inline int extcon_unregister_notifier(struct extcon_dev *edev, | |
73b6ecdb | 336 | unsigned int id, |
046050f6 | 337 | struct notifier_block *nb) |
74c5d09b DK |
338 | { |
339 | return 0; | |
340 | } | |
341 | ||
58f38656 CC |
342 | static inline int devm_extcon_register_notifier(struct device *dev, |
343 | struct extcon_dev *edev, unsigned int id, | |
344 | struct notifier_block *nb) | |
345 | { | |
346 | return -ENOSYS; | |
347 | } | |
348 | ||
349 | static inline void devm_extcon_unregister_notifier(struct device *dev, | |
350 | struct extcon_dev *edev, unsigned int id, | |
351 | struct notifier_block *nb) { } | |
352 | ||
830ae442 CC |
353 | static inline struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev, |
354 | int index) | |
806d9dd7 | 355 | { |
830ae442 | 356 | return ERR_PTR(-ENODEV); |
806d9dd7 | 357 | } |
830ae442 | 358 | #endif /* CONFIG_EXTCON */ |
806d9dd7 | 359 | |
830ae442 CC |
360 | /* |
361 | * Following structure and API are deprecated. EXTCON remains the function | |
362 | * definition to prevent the build break. | |
363 | */ | |
364 | struct extcon_specific_cable_nb { | |
365 | struct notifier_block *user_nb; | |
366 | int cable_index; | |
367 | struct extcon_dev *edev; | |
368 | unsigned long previous_value; | |
369 | }; | |
370 | ||
371 | static inline int extcon_register_interest(struct extcon_specific_cable_nb *obj, | |
372 | const char *extcon_name, const char *cable_name, | |
373 | struct notifier_block *nb) | |
806d9dd7 | 374 | { |
830ae442 | 375 | return -EINVAL; |
806d9dd7 | 376 | } |
1ad94ffe | 377 | |
830ae442 CC |
378 | static inline int extcon_unregister_interest(struct extcon_specific_cable_nb |
379 | *obj) | |
1ad94ffe | 380 | { |
830ae442 | 381 | return -EINVAL; |
1ad94ffe | 382 | } |
de55d871 | 383 | #endif /* __LINUX_EXTCON_H__ */ |