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
56 #define EXTCON_CHG_WPT 11 /* Wireless Power Transfer */
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
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 */
76 /* Miscellaneous external connector */
77 #define EXTCON_DOCK 60
79 #define EXTCON_MECHANICAL 62
84 * Define the property of supported external connectors.
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.
92 * The naming style of property
93 * : EXTCON_PROP_[type]_[property name]
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
102 * Properties of EXTCON_TYPE_USB.
104 * - EXTCON_PROP_USB_VBUS
105 * @type: integer (intval)
106 * @value: 0 (low) or 1 (high)
108 * - EXTCON_PROP_USB_TYPEC_POLARITY
109 * @type: integer (intval)
110 * @value: 0 (normal) or 1 (flip)
111 * @default: 0 (normal)
113 #define EXTCON_PROP_USB_VBUS 0
114 #define EXTCON_PROP_USB_TYPEC_POLARITY 1
116 #define EXTCON_PROP_USB_MIN 0
117 #define EXTCON_PROP_USB_MAX 1
118 #define EXTCON_PROP_USB_CNT (EXTCON_PROP_USB_MAX - EXTCON_PROP_USB_MIN + 1)
120 /* Properties of EXTCON_TYPE_CHG. */
121 #define EXTCON_PROP_CHG_MIN 50
122 #define EXTCON_PROP_CHG_MAX 50
123 #define EXTCON_PROP_CHG_CNT (EXTCON_PROP_CHG_MAX - EXTCON_PROP_CHG_MIN + 1)
125 /* Properties of EXTCON_TYPE_JACK. */
126 #define EXTCON_PROP_JACK_MIN 100
127 #define EXTCON_PROP_JACK_MAX 100
128 #define EXTCON_PROP_JACK_CNT (EXTCON_PROP_JACK_MAX - EXTCON_PROP_JACK_MIN + 1)
130 /* Properties of EXTCON_TYPE_DISP. */
131 #define EXTCON_PROP_DISP_MIN 150
132 #define EXTCON_PROP_DISP_MAX 150
133 #define EXTCON_PROP_DISP_CNT (EXTCON_PROP_DISP_MAX - EXTCON_PROP_DISP_MIN + 1)
136 * Define the type of property's value.
138 * Define the property's value as union type. Because each property
139 * would need the different data type to store it.
141 union extcon_property_value {
142 int intval; /* type : integer (intval) */
148 * struct extcon_dev - An extcon device represents one external connector.
149 * @name: The name of this extcon device. Parent device name is
151 * @supported_cable: Array of supported cable names ending with EXTCON_NONE.
152 * If supported_cable is NULL, cable name related APIs
154 * @mutually_exclusive: Array of mutually exclusive set of cables that cannot
155 * be attached simultaneously. The array should be
156 * ending with NULL or be NULL (no mutually exclusive
157 * cables). For example, if it is { 0x7, 0x30, 0}, then,
158 * {0, 1}, {0, 1, 2}, {0, 2}, {1, 2}, or {4, 5} cannot
159 * be attached simulataneously. {0x7, 0} is equivalent to
160 * {0x3, 0x6, 0x5, 0}. If it is {0xFFFFFFFF, 0}, there
161 * can be no simultaneous connections.
162 * @dev: Device of this extcon.
163 * @state: Attach/detach state of this extcon. Do not provide at
165 * @nh: Notifier for the state change events from this extcon
166 * @entry: To support list of extcon devices so that users can
167 * search for extcon devices based on the extcon name.
169 * @max_supported: Internal value to store the number of cables.
170 * @extcon_dev_type: Device_type struct to provide attribute_groups
171 * customized for each extcon device.
172 * @cables: Sysfs subdirectories. Each represents one cable.
174 * In most cases, users only need to provide "User initializing data" of
175 * this struct when registering an extcon. In some exceptional cases,
176 * optional callbacks may be needed. However, the values in "internal data"
177 * are overwritten by register function.
180 /* Optional user initializing data */
182 const unsigned int *supported_cable;
183 const u32 *mutually_exclusive;
185 /* Internal data. Please do not set. */
187 struct raw_notifier_head *nh;
188 struct list_head entry;
190 spinlock_t lock; /* could be called by irq handler */
193 /* /sys/class/extcon/.../cable.n/... */
194 struct device_type extcon_dev_type;
195 struct extcon_cable *cables;
197 /* /sys/class/extcon/.../mutually_exclusive/... */
198 struct attribute_group attr_g_muex;
199 struct attribute **attrs_muex;
200 struct device_attribute *d_attrs_muex;
203 #if IS_ENABLED(CONFIG_EXTCON)
206 * Following APIs are for notifiers or configurations.
207 * Notifiers are the external port and connection devices.
209 extern int extcon_dev_register(struct extcon_dev *edev);
210 extern void extcon_dev_unregister(struct extcon_dev *edev);
211 extern int devm_extcon_dev_register(struct device *dev,
212 struct extcon_dev *edev);
213 extern void devm_extcon_dev_unregister(struct device *dev,
214 struct extcon_dev *edev);
215 extern struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name);
218 * Following APIs control the memory of extcon device.
220 extern struct extcon_dev *extcon_dev_allocate(const unsigned int *cable);
221 extern void extcon_dev_free(struct extcon_dev *edev);
222 extern struct extcon_dev *devm_extcon_dev_allocate(struct device *dev,
223 const unsigned int *cable);
224 extern void devm_extcon_dev_free(struct device *dev, struct extcon_dev *edev);
227 * get/set_state access each bit of the 32b encoded state value.
228 * They are used to access the status of each cable based on the cable id.
230 extern int extcon_get_state(struct extcon_dev *edev, unsigned int id);
231 extern int extcon_set_state(struct extcon_dev *edev, unsigned int id,
233 extern int extcon_set_state_sync(struct extcon_dev *edev, unsigned int id,
237 * Synchronize the state and property data for a specific external connector.
239 extern int extcon_sync(struct extcon_dev *edev, unsigned int id);
242 * get/set_property access the property value of each external connector.
243 * They are used to access the property of each cable based on the property id.
245 extern int extcon_get_property(struct extcon_dev *edev, unsigned int id,
247 union extcon_property_value *prop_val);
248 extern int extcon_set_property(struct extcon_dev *edev, unsigned int id,
250 union extcon_property_value prop_val);
251 extern int extcon_set_property_sync(struct extcon_dev *edev, unsigned int id,
253 union extcon_property_value prop_val);
256 * get/set_property_capability set the capability of the property for each
257 * external connector. They are used to set the capability of the property
258 * of each external connector based on the id and property.
260 extern int extcon_get_property_capability(struct extcon_dev *edev,
261 unsigned int id, unsigned int prop);
262 extern int extcon_set_property_capability(struct extcon_dev *edev,
263 unsigned int id, unsigned int prop);
266 * Following APIs are to monitor every action of a notifier.
267 * Registrar gets notified for every external port of a connection device.
268 * Probably this could be used to debug an action of notifier; however,
269 * we do not recommend to use this for normal 'notifiee' device drivers who
270 * want to be notified by a specific external port of the notifier.
272 extern int extcon_register_notifier(struct extcon_dev *edev, unsigned int id,
273 struct notifier_block *nb);
274 extern int extcon_unregister_notifier(struct extcon_dev *edev, unsigned int id,
275 struct notifier_block *nb);
276 extern int devm_extcon_register_notifier(struct device *dev,
277 struct extcon_dev *edev, unsigned int id,
278 struct notifier_block *nb);
279 extern void devm_extcon_unregister_notifier(struct device *dev,
280 struct extcon_dev *edev, unsigned int id,
281 struct notifier_block *nb);
284 * Following API get the extcon device from devicetree.
285 * This function use phandle of devicetree to get extcon device directly.
287 extern struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev,
290 /* Following API to get information of extcon device */
291 extern const char *extcon_get_edev_name(struct extcon_dev *edev);
294 #else /* CONFIG_EXTCON */
295 static inline int extcon_dev_register(struct extcon_dev *edev)
300 static inline void extcon_dev_unregister(struct extcon_dev *edev) { }
302 static inline int devm_extcon_dev_register(struct device *dev,
303 struct extcon_dev *edev)
308 static inline void devm_extcon_dev_unregister(struct device *dev,
309 struct extcon_dev *edev) { }
311 static inline struct extcon_dev *extcon_dev_allocate(const unsigned int *cable)
313 return ERR_PTR(-ENOSYS);
316 static inline void extcon_dev_free(struct extcon_dev *edev) { }
318 static inline struct extcon_dev *devm_extcon_dev_allocate(struct device *dev,
319 const unsigned int *cable)
321 return ERR_PTR(-ENOSYS);
324 static inline void devm_extcon_dev_free(struct extcon_dev *edev) { }
327 static inline int extcon_get_state(struct extcon_dev *edev, unsigned int id)
332 static inline int extcon_set_state(struct extcon_dev *edev, unsigned int id,
338 static inline int extcon_set_state_sync(struct extcon_dev *edev, unsigned int id,
344 static inline int extcon_sync(struct extcon_dev *edev, unsigned int id)
349 static inline int extcon_get_property(struct extcon_dev *edev, unsigned int id,
351 union extcon_property_value *prop_val)
355 static inline int extcon_set_property(struct extcon_dev *edev, unsigned int id,
357 union extcon_property_value prop_val)
362 static inline int extcon_set_property_sync(struct extcon_dev *edev,
363 unsigned int id, unsigned int prop,
364 union extcon_property_value prop_val)
369 static inline int extcon_get_property_capability(struct extcon_dev *edev,
370 unsigned int id, unsigned int prop)
375 static inline int extcon_set_property_capability(struct extcon_dev *edev,
376 unsigned int id, unsigned int prop)
381 static inline struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name)
386 static inline int extcon_register_notifier(struct extcon_dev *edev,
388 struct notifier_block *nb)
393 static inline int extcon_unregister_notifier(struct extcon_dev *edev,
395 struct notifier_block *nb)
400 static inline int devm_extcon_register_notifier(struct device *dev,
401 struct extcon_dev *edev, unsigned int id,
402 struct notifier_block *nb)
407 static inline void devm_extcon_unregister_notifier(struct device *dev,
408 struct extcon_dev *edev, unsigned int id,
409 struct notifier_block *nb) { }
411 static inline struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev,
414 return ERR_PTR(-ENODEV);
416 #endif /* CONFIG_EXTCON */
419 * Following structure and API are deprecated. EXTCON remains the function
420 * definition to prevent the build break.
422 struct extcon_specific_cable_nb {
423 struct notifier_block *user_nb;
425 struct extcon_dev *edev;
426 unsigned long previous_value;
429 static inline int extcon_register_interest(struct extcon_specific_cable_nb *obj,
430 const char *extcon_name, const char *cable_name,
431 struct notifier_block *nb)
436 static inline int extcon_unregister_interest(struct extcon_specific_cable_nb
442 static inline int extcon_get_cable_state_(struct extcon_dev *edev, unsigned int id)
444 return extcon_get_state(edev, id);
447 static inline int extcon_set_cable_state_(struct extcon_dev *edev, unsigned int id,
450 return extcon_set_state_sync(edev, id, cable_state);
452 #endif /* __LINUX_EXTCON_H__ */