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 */
73 /* Miscellaneous external connector */
74 #define EXTCON_DOCK 60
76 #define EXTCON_MECHANICAL 62
81 * Define the property of supported external connectors.
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.
89 * The naming style of property
90 * : EXTCON_PROP_[type]_[property name]
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
99 * Properties of EXTCON_TYPE_USB.
101 * - EXTCON_PROP_USB_VBUS
102 * @type: integer (intval)
103 * @value: 0 (low) or 1 (high)
106 #define EXTCON_PROP_USB_VBUS 0
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)
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)
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)
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)
128 * Define the type of property's value.
130 * Define the property's value as union type. Because each property
131 * would need the different data type to store it.
133 union extcon_property_value
{
134 int intval
; /* type : integer (intval) */
140 * struct extcon_dev - An extcon device represents one external connector.
141 * @name: The name of this extcon device. Parent device name is
143 * @supported_cable: Array of supported cable names ending with EXTCON_NONE.
144 * If supported_cable is NULL, cable name related APIs
146 * @mutually_exclusive: Array of mutually exclusive set of cables that cannot
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.
154 * @dev: Device of this extcon.
155 * @state: Attach/detach state of this extcon. Do not provide at
157 * @nh: Notifier for the state change events from this extcon
158 * @entry: To support list of extcon devices so that users can
159 * search for extcon devices based on the extcon name.
161 * @max_supported: Internal value to store the number of cables.
162 * @extcon_dev_type: Device_type struct to provide attribute_groups
163 * customized for each extcon device.
164 * @cables: Sysfs subdirectories. Each represents one cable.
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.
172 /* Optional user initializing data */
174 const unsigned int *supported_cable
;
175 const u32
*mutually_exclusive
;
177 /* Internal data. Please do not set. */
179 struct raw_notifier_head
*nh
;
180 struct list_head entry
;
182 spinlock_t lock
; /* could be called by irq handler */
185 /* /sys/class/extcon/.../cable.n/... */
186 struct device_type extcon_dev_type
;
187 struct extcon_cable
*cables
;
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
;
195 #if IS_ENABLED(CONFIG_EXTCON)
198 * Following APIs are for notifiers or configurations.
199 * Notifiers are the external port and connection devices.
201 extern int extcon_dev_register(struct extcon_dev
*edev
);
202 extern void extcon_dev_unregister(struct extcon_dev
*edev
);
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
);
207 extern struct extcon_dev
*extcon_get_extcon_dev(const char *extcon_name
);
210 * Following APIs control the memory of extcon device.
212 extern struct extcon_dev
*extcon_dev_allocate(const unsigned int *cable
);
213 extern void extcon_dev_free(struct extcon_dev
*edev
);
214 extern struct extcon_dev
*devm_extcon_dev_allocate(struct device
*dev
,
215 const unsigned int *cable
);
216 extern void devm_extcon_dev_free(struct device
*dev
, struct extcon_dev
*edev
);
219 * get/set_cable_state access each bit of the 32b encoded state value.
220 * They are used to access the status of each cable based on the cable id.
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
,
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.
230 extern int extcon_get_property(struct extcon_dev
*edev
, unsigned int id
,
232 union extcon_property_value
*prop_val
);
233 extern int extcon_set_property(struct extcon_dev
*edev
, unsigned int id
,
235 union extcon_property_value prop_val
);
238 * get/set_property_capability set the capability of the property for each
239 * external connector. They are used to set the capability of the property
240 * of each external connector based on the id and property.
242 extern int extcon_get_property_capability(struct extcon_dev
*edev
,
243 unsigned int id
, unsigned int prop
);
244 extern int extcon_set_property_capability(struct extcon_dev
*edev
,
245 unsigned int id
, unsigned int prop
);
248 * Following APIs are to monitor every action of a notifier.
249 * Registrar gets notified for every external port of a connection device.
250 * Probably this could be used to debug an action of notifier; however,
251 * we do not recommend to use this for normal 'notifiee' device drivers who
252 * want to be notified by a specific external port of the notifier.
254 extern int extcon_register_notifier(struct extcon_dev
*edev
, unsigned int id
,
255 struct notifier_block
*nb
);
256 extern int extcon_unregister_notifier(struct extcon_dev
*edev
, unsigned int id
,
257 struct notifier_block
*nb
);
258 extern int devm_extcon_register_notifier(struct device
*dev
,
259 struct extcon_dev
*edev
, unsigned int id
,
260 struct notifier_block
*nb
);
261 extern void devm_extcon_unregister_notifier(struct device
*dev
,
262 struct extcon_dev
*edev
, unsigned int id
,
263 struct notifier_block
*nb
);
266 * Following API get the extcon device from devicetree.
267 * This function use phandle of devicetree to get extcon device directly.
269 extern struct extcon_dev
*extcon_get_edev_by_phandle(struct device
*dev
,
272 /* Following API to get information of extcon device */
273 extern const char *extcon_get_edev_name(struct extcon_dev
*edev
);
276 #else /* CONFIG_EXTCON */
277 static inline int extcon_dev_register(struct extcon_dev
*edev
)
282 static inline void extcon_dev_unregister(struct extcon_dev
*edev
) { }
284 static inline int devm_extcon_dev_register(struct device
*dev
,
285 struct extcon_dev
*edev
)
290 static inline void devm_extcon_dev_unregister(struct device
*dev
,
291 struct extcon_dev
*edev
) { }
293 static inline struct extcon_dev
*extcon_dev_allocate(const unsigned int *cable
)
295 return ERR_PTR(-ENOSYS
);
298 static inline void extcon_dev_free(struct extcon_dev
*edev
) { }
300 static inline struct extcon_dev
*devm_extcon_dev_allocate(struct device
*dev
,
301 const unsigned int *cable
)
303 return ERR_PTR(-ENOSYS
);
306 static inline void devm_extcon_dev_free(struct extcon_dev
*edev
) { }
308 static inline int extcon_get_cable_state_(struct extcon_dev
*edev
,
314 static inline int extcon_set_cable_state_(struct extcon_dev
*edev
,
315 unsigned int id
, bool cable_state
)
320 static inline int extcon_get_property(struct extcon_dev
*edev
, unsigned int id
,
322 union extcon_property_value
*prop_val
)
326 static inline int extcon_set_property(struct extcon_dev
*edev
, unsigned int id
,
328 union extcon_property_value prop_val
)
333 static inline int extcon_get_property_capability(struct extcon_dev
*edev
,
334 unsigned int id
, unsigned int prop
)
339 static inline int extcon_set_property_capability(struct extcon_dev
*edev
,
340 unsigned int id
, unsigned int prop
)
345 static inline struct extcon_dev
*extcon_get_extcon_dev(const char *extcon_name
)
350 static inline int extcon_register_notifier(struct extcon_dev
*edev
,
352 struct notifier_block
*nb
)
357 static inline int extcon_unregister_notifier(struct extcon_dev
*edev
,
359 struct notifier_block
*nb
)
364 static inline int devm_extcon_register_notifier(struct device
*dev
,
365 struct extcon_dev
*edev
, unsigned int id
,
366 struct notifier_block
*nb
)
371 static inline void devm_extcon_unregister_notifier(struct device
*dev
,
372 struct extcon_dev
*edev
, unsigned int id
,
373 struct notifier_block
*nb
) { }
375 static inline struct extcon_dev
*extcon_get_edev_by_phandle(struct device
*dev
,
378 return ERR_PTR(-ENODEV
);
380 #endif /* CONFIG_EXTCON */
383 * Following structure and API are deprecated. EXTCON remains the function
384 * definition to prevent the build break.
386 struct extcon_specific_cable_nb
{
387 struct notifier_block
*user_nb
;
389 struct extcon_dev
*edev
;
390 unsigned long previous_value
;
393 static inline int extcon_register_interest(struct extcon_specific_cable_nb
*obj
,
394 const char *extcon_name
, const char *cable_name
,
395 struct notifier_block
*nb
)
400 static inline int extcon_unregister_interest(struct extcon_specific_cable_nb
405 #endif /* __LINUX_EXTCON_H__ */