2 * External connector (extcon) class driver
4 * Copyright (C) 2015 Samsung Electronics
5 * Author: Chanwoo Choi <cw00.choi@samsung.com>
7 * Copyright (C) 2012 Samsung Electronics
8 * Author: Donggeun Kim <dg77.kim@samsung.com>
9 * Author: MyungJoo Ham <myungjoo.ham@samsung.com>
11 * based on switch class driver
12 * Copyright (C) 2008 Google, Inc.
13 * Author: Mike Lockwood <lockwood@android.com>
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.
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.
26 #ifndef __LINUX_EXTCON_H__
27 #define __LINUX_EXTCON_H__
29 #include <linux/device.h>
32 * Define the type of supported external connectors
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 */
41 * Define the unique id of supported external connectors
45 /* USB external connector */
47 #define EXTCON_USB_HOST 2
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
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
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 #define EXTCON_DISP_DP 44 /* Display Port */
74 /* Miscellaneous external connector */
75 #define EXTCON_DOCK 60
77 #define EXTCON_MECHANICAL 62
82 * Define the property of supported external connectors.
84 * When adding the new extcon property, they *must* have
85 * the type/value/default information. Also, you *have to*
86 * modify the EXTCON_PROP_[type]_START/END definitions
87 * which mean the range of the supported properties
88 * for each extcon type.
90 * The naming style of property
91 * : EXTCON_PROP_[type]_[property name]
93 * EXTCON_PROP_USB_[property name] : USB property
94 * EXTCON_PROP_CHG_[property name] : Charger property
95 * EXTCON_PROP_JACK_[property name] : Jack property
96 * EXTCON_PROP_DISP_[property name] : Display property
100 * Properties of EXTCON_TYPE_USB.
102 * - EXTCON_PROP_USB_VBUS
103 * @type: integer (intval)
104 * @value: 0 (low) or 1 (high)
106 * - EXTCON_PROP_USB_TYPEC_POLARITY
107 * @type: integer (intval)
108 * @value: 0 (normal) or 1 (flip)
109 * @default: 0 (normal)
110 * - EXTCON_PROP_USB_SS (SuperSpeed)
111 * @type: integer (intval)
112 * @value: 0 (USB/USB2) or 1 (USB3)
113 * @default: 0 (USB/USB2)
116 #define EXTCON_PROP_USB_VBUS 0
117 #define EXTCON_PROP_USB_TYPEC_POLARITY 1
118 #define EXTCON_PROP_USB_SS 2
120 #define EXTCON_PROP_USB_MIN 0
121 #define EXTCON_PROP_USB_MAX 2
122 #define EXTCON_PROP_USB_CNT (EXTCON_PROP_USB_MAX - EXTCON_PROP_USB_MIN + 1)
124 /* Properties of EXTCON_TYPE_CHG. */
125 #define EXTCON_PROP_CHG_MIN 50
126 #define EXTCON_PROP_CHG_MAX 50
127 #define EXTCON_PROP_CHG_CNT (EXTCON_PROP_CHG_MAX - EXTCON_PROP_CHG_MIN + 1)
129 /* Properties of EXTCON_TYPE_JACK. */
130 #define EXTCON_PROP_JACK_MIN 100
131 #define EXTCON_PROP_JACK_MAX 100
132 #define EXTCON_PROP_JACK_CNT (EXTCON_PROP_JACK_MAX - EXTCON_PROP_JACK_MIN + 1)
134 /* Properties of EXTCON_TYPE_DISP. */
135 #define EXTCON_PROP_DISP_MIN 150
136 #define EXTCON_PROP_DISP_MAX 150
137 #define EXTCON_PROP_DISP_CNT (EXTCON_PROP_DISP_MAX - EXTCON_PROP_DISP_MIN + 1)
140 * Define the type of property's value.
142 * Define the property's value as union type. Because each property
143 * would need the different data type to store it.
145 union extcon_property_value {
146 int intval; /* type : integer (intval) */
152 * struct extcon_dev - An extcon device represents one external connector.
153 * @name: The name of this extcon device. Parent device name is
155 * @supported_cable: Array of supported cable names ending with EXTCON_NONE.
156 * If supported_cable is NULL, cable name related APIs
158 * @mutually_exclusive: Array of mutually exclusive set of cables that cannot
159 * be attached simultaneously. The array should be
160 * ending with NULL or be NULL (no mutually exclusive
161 * cables). For example, if it is { 0x7, 0x30, 0}, then,
162 * {0, 1}, {0, 1, 2}, {0, 2}, {1, 2}, or {4, 5} cannot
163 * be attached simulataneously. {0x7, 0} is equivalent to
164 * {0x3, 0x6, 0x5, 0}. If it is {0xFFFFFFFF, 0}, there
165 * can be no simultaneous connections.
166 * @dev: Device of this extcon.
167 * @state: Attach/detach state of this extcon. Do not provide at
169 * @nh: Notifier for the state change events from this extcon
170 * @entry: To support list of extcon devices so that users can
171 * search for extcon devices based on the extcon name.
173 * @max_supported: Internal value to store the number of cables.
174 * @extcon_dev_type: Device_type struct to provide attribute_groups
175 * customized for each extcon device.
176 * @cables: Sysfs subdirectories. Each represents one cable.
178 * In most cases, users only need to provide "User initializing data" of
179 * this struct when registering an extcon. In some exceptional cases,
180 * optional callbacks may be needed. However, the values in "internal data"
181 * are overwritten by register function.
184 /* Optional user initializing data */
186 const unsigned int *supported_cable;
187 const u32 *mutually_exclusive;
189 /* Internal data. Please do not set. */
191 struct raw_notifier_head *nh;
192 struct list_head entry;
194 spinlock_t lock; /* could be called by irq handler */
197 /* /sys/class/extcon/.../cable.n/... */
198 struct device_type extcon_dev_type;
199 struct extcon_cable *cables;
201 /* /sys/class/extcon/.../mutually_exclusive/... */
202 struct attribute_group attr_g_muex;
203 struct attribute **attrs_muex;
204 struct device_attribute *d_attrs_muex;
207 #if IS_ENABLED(CONFIG_EXTCON)
210 * Following APIs are for notifiers or configurations.
211 * Notifiers are the external port and connection devices.
213 extern int extcon_dev_register(struct extcon_dev *edev);
214 extern void extcon_dev_unregister(struct extcon_dev *edev);
215 extern int devm_extcon_dev_register(struct device *dev,
216 struct extcon_dev *edev);
217 extern void devm_extcon_dev_unregister(struct device *dev,
218 struct extcon_dev *edev);
219 extern struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name);
222 * Following APIs control the memory of extcon device.
224 extern struct extcon_dev *extcon_dev_allocate(const unsigned int *cable);
225 extern void extcon_dev_free(struct extcon_dev *edev);
226 extern struct extcon_dev *devm_extcon_dev_allocate(struct device *dev,
227 const unsigned int *cable);
228 extern void devm_extcon_dev_free(struct device *dev, struct extcon_dev *edev);
231 * get/set_state access each bit of the 32b encoded state value.
232 * They are used to access the status of each cable based on the cable id.
234 extern int extcon_get_state(struct extcon_dev *edev, unsigned int id);
235 extern int extcon_set_state(struct extcon_dev *edev, unsigned int id,
237 extern int extcon_set_state_sync(struct extcon_dev *edev, unsigned int id,
241 * Synchronize the state and property data for a specific external connector.
243 extern int extcon_sync(struct extcon_dev *edev, unsigned int id);
246 * get/set_property access the property value of each external connector.
247 * They are used to access the property of each cable based on the property id.
249 extern int extcon_get_property(struct extcon_dev *edev, unsigned int id,
251 union extcon_property_value *prop_val);
252 extern int extcon_set_property(struct extcon_dev *edev, unsigned int id,
254 union extcon_property_value prop_val);
255 extern int extcon_set_property_sync(struct extcon_dev *edev, unsigned int id,
257 union extcon_property_value prop_val);
260 * get/set_property_capability set the capability of the property for each
261 * external connector. They are used to set the capability of the property
262 * of each external connector based on the id and property.
264 extern int extcon_get_property_capability(struct extcon_dev *edev,
265 unsigned int id, unsigned int prop);
266 extern int extcon_set_property_capability(struct extcon_dev *edev,
267 unsigned int id, unsigned int prop);
270 * Following APIs are to monitor every action of a notifier.
271 * Registrar gets notified for every external port of a connection device.
272 * Probably this could be used to debug an action of notifier; however,
273 * we do not recommend to use this for normal 'notifiee' device drivers who
274 * want to be notified by a specific external port of the notifier.
276 extern int extcon_register_notifier(struct extcon_dev *edev, unsigned int id,
277 struct notifier_block *nb);
278 extern int extcon_unregister_notifier(struct extcon_dev *edev, unsigned int id,
279 struct notifier_block *nb);
280 extern int devm_extcon_register_notifier(struct device *dev,
281 struct extcon_dev *edev, unsigned int id,
282 struct notifier_block *nb);
283 extern void devm_extcon_unregister_notifier(struct device *dev,
284 struct extcon_dev *edev, unsigned int id,
285 struct notifier_block *nb);
288 * Following API get the extcon device from devicetree.
289 * This function use phandle of devicetree to get extcon device directly.
291 extern struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev,
294 /* Following API to get information of extcon device */
295 extern const char *extcon_get_edev_name(struct extcon_dev *edev);
298 #else /* CONFIG_EXTCON */
299 static inline int extcon_dev_register(struct extcon_dev *edev)
304 static inline void extcon_dev_unregister(struct extcon_dev *edev) { }
306 static inline int devm_extcon_dev_register(struct device *dev,
307 struct extcon_dev *edev)
312 static inline void devm_extcon_dev_unregister(struct device *dev,
313 struct extcon_dev *edev) { }
315 static inline struct extcon_dev *extcon_dev_allocate(const unsigned int *cable)
317 return ERR_PTR(-ENOSYS);
320 static inline void extcon_dev_free(struct extcon_dev *edev) { }
322 static inline struct extcon_dev *devm_extcon_dev_allocate(struct device *dev,
323 const unsigned int *cable)
325 return ERR_PTR(-ENOSYS);
328 static inline void devm_extcon_dev_free(struct extcon_dev *edev) { }
331 static inline int extcon_get_state(struct extcon_dev *edev, unsigned int id)
336 static inline int extcon_set_state(struct extcon_dev *edev, unsigned int id,
342 static inline int extcon_set_state_sync(struct extcon_dev *edev, unsigned int id,
348 static inline int extcon_sync(struct extcon_dev *edev, unsigned int id)
353 static inline int extcon_get_property(struct extcon_dev *edev, unsigned int id,
355 union extcon_property_value *prop_val)
359 static inline int extcon_set_property(struct extcon_dev *edev, unsigned int id,
361 union extcon_property_value prop_val)
366 static inline int extcon_set_property_sync(struct extcon_dev *edev,
367 unsigned int id, unsigned int prop,
368 union extcon_property_value prop_val)
373 static inline int extcon_get_property_capability(struct extcon_dev *edev,
374 unsigned int id, unsigned int prop)
379 static inline int extcon_set_property_capability(struct extcon_dev *edev,
380 unsigned int id, unsigned int prop)
385 static inline struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name)
390 static inline int extcon_register_notifier(struct extcon_dev *edev,
392 struct notifier_block *nb)
397 static inline int extcon_unregister_notifier(struct extcon_dev *edev,
399 struct notifier_block *nb)
404 static inline int devm_extcon_register_notifier(struct device *dev,
405 struct extcon_dev *edev, unsigned int id,
406 struct notifier_block *nb)
411 static inline void devm_extcon_unregister_notifier(struct device *dev,
412 struct extcon_dev *edev, unsigned int id,
413 struct notifier_block *nb) { }
415 static inline struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev,
418 return ERR_PTR(-ENODEV);
420 #endif /* CONFIG_EXTCON */
423 * Following structure and API are deprecated. EXTCON remains the function
424 * definition to prevent the build break.
426 struct extcon_specific_cable_nb {
427 struct notifier_block *user_nb;
429 struct extcon_dev *edev;
430 unsigned long previous_value;
433 static inline int extcon_register_interest(struct extcon_specific_cable_nb *obj,
434 const char *extcon_name, const char *cable_name,
435 struct notifier_block *nb)
440 static inline int extcon_unregister_interest(struct extcon_specific_cable_nb
446 static inline int extcon_get_cable_state_(struct extcon_dev *edev, unsigned int id)
448 return extcon_get_state(edev, id);
451 static inline int extcon_set_cable_state_(struct extcon_dev *edev, unsigned int id,
454 return extcon_set_state_sync(edev, id, cable_state);
456 #endif /* __LINUX_EXTCON_H__ */