Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/*
2 * External connector (extcon) class driver
3 *
4 * Copyright (C) 2015 Samsung Electronics
5 * Author: Chanwoo Choi <cw00.choi@samsung.com>
6 *
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
29#include <linux/device.h>
30
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
40/*
41 * Define the unique id of supported external connectors
42 */
43#define EXTCON_NONE 0
44
45/* USB external connector */
46#define EXTCON_USB 1
47#define EXTCON_USB_HOST 2
48
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
56#define EXTCON_CHG_WPT 11 /* Wireless Power Transfer */
57
58/* Jack external connector */
59#define EXTCON_JACK_MICROPHONE 20
60#define EXTCON_JACK_HEADPHONE 21
61#define EXTCON_JACK_LINE_IN 22
62#define EXTCON_JACK_LINE_OUT 23
63#define EXTCON_JACK_VIDEO_IN 24
64#define EXTCON_JACK_VIDEO_OUT 25
65#define EXTCON_JACK_SPDIF_IN 26 /* Sony Philips Digital InterFace */
66#define EXTCON_JACK_SPDIF_OUT 27
67
68/* Display external connector */
69#define EXTCON_DISP_HDMI 40 /* High-Definition Multimedia Interface */
70#define EXTCON_DISP_MHL 41 /* Mobile High-Definition Link */
71#define EXTCON_DISP_DVI 42 /* Digital Visual Interface */
72#define EXTCON_DISP_VGA 43 /* Video Graphics Array */
73#define EXTCON_DISP_DP 44 /* Display Port */
74#define EXTCON_DISP_HMD 45 /* Head-Mounted Display */
75
76/* Miscellaneous external connector */
77#define EXTCON_DOCK 60
78#define EXTCON_JIG 61
79#define EXTCON_MECHANICAL 62
80
81#define EXTCON_NUM 63
82
83/*
84 * Define the property of supported external connectors.
85 *
86 * When adding the new extcon property, they *must* have
87 * the type/value/default information. Also, you *have to*
88 * modify the EXTCON_PROP_[type]_START/END definitions
89 * which mean the range of the supported properties
90 * for each extcon type.
91 *
92 * The naming style of property
93 * : EXTCON_PROP_[type]_[property name]
94 *
95 * EXTCON_PROP_USB_[property name] : USB property
96 * EXTCON_PROP_CHG_[property name] : Charger property
97 * EXTCON_PROP_JACK_[property name] : Jack property
98 * EXTCON_PROP_DISP_[property name] : Display property
99 */
100
101/*
102 * Properties of EXTCON_TYPE_USB.
103 *
104 * - EXTCON_PROP_USB_VBUS
105 * @type: integer (intval)
106 * @value: 0 (low) or 1 (high)
107 * @default: 0 (low)
108 * - EXTCON_PROP_USB_TYPEC_POLARITY
109 * @type: integer (intval)
110 * @value: 0 (normal) or 1 (flip)
111 * @default: 0 (normal)
112 * - EXTCON_PROP_USB_SS (SuperSpeed)
113 * @type: integer (intval)
114 * @value: 0 (USB/USB2) or 1 (USB3)
115 * @default: 0 (USB/USB2)
116 *
117 */
118#define EXTCON_PROP_USB_VBUS 0
119#define EXTCON_PROP_USB_TYPEC_POLARITY 1
120#define EXTCON_PROP_USB_SS 2
121
122#define EXTCON_PROP_USB_MIN 0
123#define EXTCON_PROP_USB_MAX 2
124#define EXTCON_PROP_USB_CNT (EXTCON_PROP_USB_MAX - EXTCON_PROP_USB_MIN + 1)
125
126/* Properties of EXTCON_TYPE_CHG. */
127#define EXTCON_PROP_CHG_MIN 50
128#define EXTCON_PROP_CHG_MAX 50
129#define EXTCON_PROP_CHG_CNT (EXTCON_PROP_CHG_MAX - EXTCON_PROP_CHG_MIN + 1)
130
131/* Properties of EXTCON_TYPE_JACK. */
132#define EXTCON_PROP_JACK_MIN 100
133#define EXTCON_PROP_JACK_MAX 100
134#define EXTCON_PROP_JACK_CNT (EXTCON_PROP_JACK_MAX - EXTCON_PROP_JACK_MIN + 1)
135
136/*
137 * Properties of EXTCON_TYPE_DISP.
138 *
139 * - EXTCON_PROP_DISP_HPD (Hot Plug Detect)
140 * @type: integer (intval)
141 * @value: 0 (no hpd) or 1 (hpd)
142 * @default: 0 (no hpd)
143 *
144 */
145#define EXTCON_PROP_DISP_HPD 150
146
147/* Properties of EXTCON_TYPE_DISP. */
148#define EXTCON_PROP_DISP_MIN 150
149#define EXTCON_PROP_DISP_MAX 151
150#define EXTCON_PROP_DISP_CNT (EXTCON_PROP_DISP_MAX - EXTCON_PROP_DISP_MIN + 1)
151
152/*
153 * Define the type of property's value.
154 *
155 * Define the property's value as union type. Because each property
156 * would need the different data type to store it.
157 */
158union extcon_property_value {
159 int intval; /* type : integer (intval) */
160};
161
162struct extcon_cable;
163
164/**
165 * struct extcon_dev - An extcon device represents one external connector.
166 * @name: The name of this extcon device. Parent device name is
167 * used if NULL.
168 * @supported_cable: Array of supported cable names ending with EXTCON_NONE.
169 * If supported_cable is NULL, cable name related APIs
170 * are disabled.
171 * @mutually_exclusive: Array of mutually exclusive set of cables that cannot
172 * be attached simultaneously. The array should be
173 * ending with NULL or be NULL (no mutually exclusive
174 * cables). For example, if it is { 0x7, 0x30, 0}, then,
175 * {0, 1}, {0, 1, 2}, {0, 2}, {1, 2}, or {4, 5} cannot
176 * be attached simulataneously. {0x7, 0} is equivalent to
177 * {0x3, 0x6, 0x5, 0}. If it is {0xFFFFFFFF, 0}, there
178 * can be no simultaneous connections.
179 * @dev: Device of this extcon.
180 * @state: Attach/detach state of this extcon. Do not provide at
181 * register-time.
182 * @nh: Notifier for the state change events from this extcon
183 * @entry: To support list of extcon devices so that users can
184 * search for extcon devices based on the extcon name.
185 * @lock:
186 * @max_supported: Internal value to store the number of cables.
187 * @extcon_dev_type: Device_type struct to provide attribute_groups
188 * customized for each extcon device.
189 * @cables: Sysfs subdirectories. Each represents one cable.
190 *
191 * In most cases, users only need to provide "User initializing data" of
192 * this struct when registering an extcon. In some exceptional cases,
193 * optional callbacks may be needed. However, the values in "internal data"
194 * are overwritten by register function.
195 */
196struct extcon_dev {
197 /* Optional user initializing data */
198 const char *name;
199 const unsigned int *supported_cable;
200 const u32 *mutually_exclusive;
201
202 /* Internal data. Please do not set. */
203 struct device dev;
204 struct raw_notifier_head *nh;
205 struct list_head entry;
206 int max_supported;
207 spinlock_t lock; /* could be called by irq handler */
208 u32 state;
209
210 /* /sys/class/extcon/.../cable.n/... */
211 struct device_type extcon_dev_type;
212 struct extcon_cable *cables;
213
214 /* /sys/class/extcon/.../mutually_exclusive/... */
215 struct attribute_group attr_g_muex;
216 struct attribute **attrs_muex;
217 struct device_attribute *d_attrs_muex;
218};
219
220#if IS_ENABLED(CONFIG_EXTCON)
221
222/*
223 * Following APIs are for notifiers or configurations.
224 * Notifiers are the external port and connection devices.
225 */
226extern int extcon_dev_register(struct extcon_dev *edev);
227extern void extcon_dev_unregister(struct extcon_dev *edev);
228extern int devm_extcon_dev_register(struct device *dev,
229 struct extcon_dev *edev);
230extern void devm_extcon_dev_unregister(struct device *dev,
231 struct extcon_dev *edev);
232extern struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name);
233
234/*
235 * Following APIs control the memory of extcon device.
236 */
237extern struct extcon_dev *extcon_dev_allocate(const unsigned int *cable);
238extern void extcon_dev_free(struct extcon_dev *edev);
239extern struct extcon_dev *devm_extcon_dev_allocate(struct device *dev,
240 const unsigned int *cable);
241extern void devm_extcon_dev_free(struct device *dev, struct extcon_dev *edev);
242
243/*
244 * get/set_state access each bit of the 32b encoded state value.
245 * They are used to access the status of each cable based on the cable id.
246 */
247extern int extcon_get_state(struct extcon_dev *edev, unsigned int id);
248extern int extcon_set_state(struct extcon_dev *edev, unsigned int id,
249 bool cable_state);
250extern int extcon_set_state_sync(struct extcon_dev *edev, unsigned int id,
251 bool cable_state);
252/*
253 * Synchronize the state and property data for a specific external connector.
254 */
255extern int extcon_sync(struct extcon_dev *edev, unsigned int id);
256
257/*
258 * get/set_property access the property value of each external connector.
259 * They are used to access the property of each cable based on the property id.
260 */
261extern int extcon_get_property(struct extcon_dev *edev, unsigned int id,
262 unsigned int prop,
263 union extcon_property_value *prop_val);
264extern int extcon_set_property(struct extcon_dev *edev, unsigned int id,
265 unsigned int prop,
266 union extcon_property_value prop_val);
267extern int extcon_set_property_sync(struct extcon_dev *edev, unsigned int id,
268 unsigned int prop,
269 union extcon_property_value prop_val);
270
271/*
272 * get/set_property_capability set the capability of the property for each
273 * external connector. They are used to set the capability of the property
274 * of each external connector based on the id and property.
275 */
276extern int extcon_get_property_capability(struct extcon_dev *edev,
277 unsigned int id, unsigned int prop);
278extern int extcon_set_property_capability(struct extcon_dev *edev,
279 unsigned int id, unsigned int prop);
280
281/*
282 * Following APIs are to monitor every action of a notifier.
283 * Registrar gets notified for every external port of a connection device.
284 * Probably this could be used to debug an action of notifier; however,
285 * we do not recommend to use this for normal 'notifiee' device drivers who
286 * want to be notified by a specific external port of the notifier.
287 */
288extern int extcon_register_notifier(struct extcon_dev *edev, unsigned int id,
289 struct notifier_block *nb);
290extern int extcon_unregister_notifier(struct extcon_dev *edev, unsigned int id,
291 struct notifier_block *nb);
292extern int devm_extcon_register_notifier(struct device *dev,
293 struct extcon_dev *edev, unsigned int id,
294 struct notifier_block *nb);
295extern void devm_extcon_unregister_notifier(struct device *dev,
296 struct extcon_dev *edev, unsigned int id,
297 struct notifier_block *nb);
298
299/*
300 * Following API get the extcon device from devicetree.
301 * This function use phandle of devicetree to get extcon device directly.
302 */
303extern struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev,
304 int index);
305
306/* Following API to get information of extcon device */
307extern const char *extcon_get_edev_name(struct extcon_dev *edev);
308
309
310#else /* CONFIG_EXTCON */
311static inline int extcon_dev_register(struct extcon_dev *edev)
312{
313 return 0;
314}
315
316static inline void extcon_dev_unregister(struct extcon_dev *edev) { }
317
318static inline int devm_extcon_dev_register(struct device *dev,
319 struct extcon_dev *edev)
320{
321 return -EINVAL;
322}
323
324static inline void devm_extcon_dev_unregister(struct device *dev,
325 struct extcon_dev *edev) { }
326
327static inline struct extcon_dev *extcon_dev_allocate(const unsigned int *cable)
328{
329 return ERR_PTR(-ENOSYS);
330}
331
332static inline void extcon_dev_free(struct extcon_dev *edev) { }
333
334static inline struct extcon_dev *devm_extcon_dev_allocate(struct device *dev,
335 const unsigned int *cable)
336{
337 return ERR_PTR(-ENOSYS);
338}
339
340static inline void devm_extcon_dev_free(struct extcon_dev *edev) { }
341
342
343static inline int extcon_get_state(struct extcon_dev *edev, unsigned int id)
344{
345 return 0;
346}
347
348static inline int extcon_set_state(struct extcon_dev *edev, unsigned int id,
349 bool cable_state)
350{
351 return 0;
352}
353
354static inline int extcon_set_state_sync(struct extcon_dev *edev, unsigned int id,
355 bool cable_state)
356{
357 return 0;
358}
359
360static inline int extcon_sync(struct extcon_dev *edev, unsigned int id)
361{
362 return 0;
363}
364
365static inline int extcon_get_property(struct extcon_dev *edev, unsigned int id,
366 unsigned int prop,
367 union extcon_property_value *prop_val)
368{
369 return 0;
370}
371static inline int extcon_set_property(struct extcon_dev *edev, unsigned int id,
372 unsigned int prop,
373 union extcon_property_value prop_val)
374{
375 return 0;
376}
377
378static inline int extcon_set_property_sync(struct extcon_dev *edev,
379 unsigned int id, unsigned int prop,
380 union extcon_property_value prop_val)
381{
382 return 0;
383}
384
385static inline int extcon_get_property_capability(struct extcon_dev *edev,
386 unsigned int id, unsigned int prop)
387{
388 return 0;
389}
390
391static inline int extcon_set_property_capability(struct extcon_dev *edev,
392 unsigned int id, unsigned int prop)
393{
394 return 0;
395}
396
397static inline struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name)
398{
399 return NULL;
400}
401
402static inline int extcon_register_notifier(struct extcon_dev *edev,
403 unsigned int id,
404 struct notifier_block *nb)
405{
406 return 0;
407}
408
409static inline int extcon_unregister_notifier(struct extcon_dev *edev,
410 unsigned int id,
411 struct notifier_block *nb)
412{
413 return 0;
414}
415
416static inline int devm_extcon_register_notifier(struct device *dev,
417 struct extcon_dev *edev, unsigned int id,
418 struct notifier_block *nb)
419{
420 return -ENOSYS;
421}
422
423static inline void devm_extcon_unregister_notifier(struct device *dev,
424 struct extcon_dev *edev, unsigned int id,
425 struct notifier_block *nb) { }
426
427static inline struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev,
428 int index)
429{
430 return ERR_PTR(-ENODEV);
431}
432#endif /* CONFIG_EXTCON */
433
434/*
435 * Following structure and API are deprecated. EXTCON remains the function
436 * definition to prevent the build break.
437 */
438struct extcon_specific_cable_nb {
439 struct notifier_block *user_nb;
440 int cable_index;
441 struct extcon_dev *edev;
442 unsigned long previous_value;
443};
444
445static inline int extcon_register_interest(struct extcon_specific_cable_nb *obj,
446 const char *extcon_name, const char *cable_name,
447 struct notifier_block *nb)
448{
449 return -EINVAL;
450}
451
452static inline int extcon_unregister_interest(struct extcon_specific_cable_nb
453 *obj)
454{
455 return -EINVAL;
456}
457
458static inline int extcon_get_cable_state_(struct extcon_dev *edev, unsigned int id)
459{
460 return extcon_get_state(edev, id);
461}
462
463static inline int extcon_set_cable_state_(struct extcon_dev *edev, unsigned int id,
464 bool cable_state)
465{
466 return extcon_set_state_sync(edev, id, cable_state);
467}
468#endif /* __LINUX_EXTCON_H__ */