extcon: Remove duplicate header file in extcon.h
[deliverable/linux.git] / include / linux / extcon.h
CommitLineData
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
73b6ecdb
CC
31/*
32 * Define the unique id of supported external connectors
33 */
34#define EXTCON_NONE 0
35
36#define EXTCON_USB 1 /* USB connector */
37#define EXTCON_USB_HOST 2
38
39#define EXTCON_TA 3 /* Charger connector */
40#define EXTCON_FAST_CHARGER 4
41#define EXTCON_SLOW_CHARGER 5
42#define EXTCON_CHARGE_DOWNSTREAM 6
43
44#define EXTCON_LINE_IN 7 /* Audio/Video connector */
45#define EXTCON_LINE_OUT 8
46#define EXTCON_MICROPHONE 9
47#define EXTCON_HEADPHONE 10
48#define EXTCON_HDMI 11
49#define EXTCON_MHL 12
50#define EXTCON_DVI 13
51#define EXTCON_VGA 14
52#define EXTCON_SPDIF_IN 15
53#define EXTCON_SPDIF_OUT 16
54#define EXTCON_VIDEO_IN 17
55#define EXTCON_VIDEO_OUT 18
56
57#define EXTCON_DOCK 19 /* Misc connector */
58#define EXTCON_JIG 20
59#define EXTCON_MECHANICAL 21
806d9dd7
MH
60
61struct extcon_cable;
62
de55d871
MH
63/**
64 * struct extcon_dev - An extcon device represents one external connector.
a75e1c73
CC
65 * @name: The name of this extcon device. Parent device name is
66 * used if NULL.
2a9de9c0 67 * @supported_cable: Array of supported cable names ending with EXTCON_NONE.
806d9dd7
MH
68 * If supported_cable is NULL, cable name related APIs
69 * are disabled.
df072eb9 70 * @mutually_exclusive: Array of mutually exclusive set of cables that cannot
bde68e60
MH
71 * be attached simultaneously. The array should be
72 * ending with NULL or be NULL (no mutually exclusive
73 * cables). For example, if it is { 0x7, 0x30, 0}, then,
74 * {0, 1}, {0, 1, 2}, {0, 2}, {1, 2}, or {4, 5} cannot
75 * be attached simulataneously. {0x7, 0} is equivalent to
76 * {0x3, 0x6, 0x5, 0}. If it is {0xFFFFFFFF, 0}, there
77 * can be no simultaneous connections.
df072eb9 78 * @print_state: An optional callback to override the method to print the
a75e1c73 79 * status of the extcon device.
dae61651 80 * @dev: Device of this extcon.
a75e1c73
CC
81 * @state: Attach/detach state of this extcon. Do not provide at
82 * register-time.
83 * @nh: Notifier for the state change events from this extcon
b9ec23c0
CC
84 * @entry: To support list of extcon devices so that users can
85 * search for extcon devices based on the extcon name.
df072eb9
MH
86 * @lock:
87 * @max_supported: Internal value to store the number of cables.
88 * @extcon_dev_type: Device_type struct to provide attribute_groups
806d9dd7 89 * customized for each extcon device.
a75e1c73 90 * @cables: Sysfs subdirectories. Each represents one cable.
de55d871
MH
91 *
92 * In most cases, users only need to provide "User initializing data" of
93 * this struct when registering an extcon. In some exceptional cases,
94 * optional callbacks may be needed. However, the values in "internal data"
95 * are overwritten by register function.
96 */
97struct extcon_dev {
a75e1c73
CC
98 /* Optional user initializing data */
99 const char *name;
73b6ecdb 100 const unsigned int *supported_cable;
a75e1c73 101 const u32 *mutually_exclusive;
de55d871 102
a75e1c73 103 /* Optional callbacks to override class functions */
de55d871
MH
104 ssize_t (*print_state)(struct extcon_dev *edev, char *buf);
105
a75e1c73 106 /* Internal data. Please do not set. */
dae61651 107 struct device dev;
046050f6 108 struct raw_notifier_head *nh;
74c5d09b 109 struct list_head entry;
806d9dd7 110 int max_supported;
a75e1c73
CC
111 spinlock_t lock; /* could be called by irq handler */
112 u32 state;
806d9dd7
MH
113
114 /* /sys/class/extcon/.../cable.n/... */
115 struct device_type extcon_dev_type;
116 struct extcon_cable *cables;
a75e1c73 117
bde68e60
MH
118 /* /sys/class/extcon/.../mutually_exclusive/... */
119 struct attribute_group attr_g_muex;
120 struct attribute **attrs_muex;
121 struct device_attribute *d_attrs_muex;
806d9dd7
MH
122};
123
124/**
a75e1c73
CC
125 * struct extcon_cable - An internal data for each cable of extcon device.
126 * @edev: The extcon device
df072eb9 127 * @cable_index: Index of this cable in the edev
a75e1c73
CC
128 * @attr_g: Attribute group for the cable
129 * @attr_name: "name" sysfs entry
130 * @attr_state: "state" sysfs entry
131 * @attrs: Array pointing to attr_name and attr_state for attr_g
806d9dd7
MH
132 */
133struct extcon_cable {
134 struct extcon_dev *edev;
135 int cable_index;
136
137 struct attribute_group attr_g;
138 struct device_attribute attr_name;
139 struct device_attribute attr_state;
140
141 struct attribute *attrs[3]; /* to be fed to attr_g.attrs */
142};
143
144/**
145 * struct extcon_specific_cable_nb - An internal data for
a75e1c73 146 * extcon_register_interest().
a75e1c73
CC
147 * @user_nb: user provided notifier block for events from
148 * a specific cable.
df072eb9 149 * @cable_index: the target cable.
a75e1c73 150 * @edev: the target extcon device.
df072eb9 151 * @previous_value: the saved previous event value.
806d9dd7
MH
152 */
153struct extcon_specific_cable_nb {
806d9dd7
MH
154 struct notifier_block *user_nb;
155 int cable_index;
156 struct extcon_dev *edev;
157 unsigned long previous_value;
de55d871
MH
158};
159
160#if IS_ENABLED(CONFIG_EXTCON)
74c5d09b
DK
161
162/*
163 * Following APIs are for notifiers or configurations.
164 * Notifiers are the external port and connection devices.
165 */
42d7d753 166extern int extcon_dev_register(struct extcon_dev *edev);
de55d871 167extern void extcon_dev_unregister(struct extcon_dev *edev);
1111244f
SW
168extern int devm_extcon_dev_register(struct device *dev,
169 struct extcon_dev *edev);
170extern void devm_extcon_dev_unregister(struct device *dev,
171 struct extcon_dev *edev);
74c5d09b 172extern struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name);
de55d871 173
a9af6522
CC
174/*
175 * Following APIs control the memory of extcon device.
176 */
73b6ecdb 177extern struct extcon_dev *extcon_dev_allocate(const unsigned int *cable);
a9af6522 178extern void extcon_dev_free(struct extcon_dev *edev);
739ba1bf 179extern struct extcon_dev *devm_extcon_dev_allocate(struct device *dev,
73b6ecdb 180 const unsigned int *cable);
739ba1bf 181extern void devm_extcon_dev_free(struct device *dev, struct extcon_dev *edev);
a9af6522 182
806d9dd7
MH
183/*
184 * get/set/update_state access the 32b encoded state value, which represents
185 * states of all possible cables of the multistate port. For example, if one
186 * calls extcon_set_state(edev, 0x7), it may mean that all the three cables
187 * are attached to the port.
188 */
de55d871
MH
189static inline u32 extcon_get_state(struct extcon_dev *edev)
190{
191 return edev->state;
192}
193
bde68e60
MH
194extern int extcon_set_state(struct extcon_dev *edev, u32 state);
195extern int extcon_update_state(struct extcon_dev *edev, u32 mask, u32 state);
806d9dd7
MH
196
197/*
198 * get/set_cable_state access each bit of the 32b encoded state value.
2a9de9c0 199 * They are used to access the status of each cable based on the cable_name.
806d9dd7 200 */
73b6ecdb
CC
201extern int extcon_get_cable_state_(struct extcon_dev *edev, unsigned int id);
202extern int extcon_set_cable_state_(struct extcon_dev *edev, unsigned int id,
806d9dd7
MH
203 bool cable_state);
204
205extern int extcon_get_cable_state(struct extcon_dev *edev,
206 const char *cable_name);
207extern int extcon_set_cable_state(struct extcon_dev *edev,
208 const char *cable_name, bool cable_state);
209
210/*
211 * Following APIs are for notifiees (those who want to be notified)
212 * to register a callback for events from a specific cable of the extcon.
213 * Notifiees are the connected device drivers wanting to get notified by
214 * a specific external port of a connection device.
215 */
216extern int extcon_register_interest(struct extcon_specific_cable_nb *obj,
217 const char *extcon_name,
218 const char *cable_name,
219 struct notifier_block *nb);
220extern int extcon_unregister_interest(struct extcon_specific_cable_nb *nb);
74c5d09b
DK
221
222/*
223 * Following APIs are to monitor every action of a notifier.
c338bb03 224 * Registrar gets notified for every external port of a connection device.
806d9dd7 225 * Probably this could be used to debug an action of notifier; however,
c338bb03 226 * we do not recommend to use this for normal 'notifiee' device drivers who
806d9dd7 227 * want to be notified by a specific external port of the notifier.
74c5d09b 228 */
73b6ecdb 229extern int extcon_register_notifier(struct extcon_dev *edev, unsigned int id,
046050f6 230 struct notifier_block *nb);
73b6ecdb 231extern int extcon_unregister_notifier(struct extcon_dev *edev, unsigned int id,
74c5d09b 232 struct notifier_block *nb);
1ad94ffe
CC
233
234/*
235 * Following API get the extcon device from devicetree.
236 * This function use phandle of devicetree to get extcon device directly.
237 */
b9ec23c0
CC
238extern struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev,
239 int index);
707d7550
CC
240
241/* Following API to get information of extcon device */
242extern const char *extcon_get_edev_name(struct extcon_dev *edev);
243
de55d871 244#else /* CONFIG_EXTCON */
42d7d753 245static inline int extcon_dev_register(struct extcon_dev *edev)
de55d871
MH
246{
247 return 0;
248}
249
250static inline void extcon_dev_unregister(struct extcon_dev *edev) { }
251
1111244f
SW
252static inline int devm_extcon_dev_register(struct device *dev,
253 struct extcon_dev *edev)
254{
255 return -EINVAL;
256}
257
258static inline void devm_extcon_dev_unregister(struct device *dev,
259 struct extcon_dev *edev) { }
260
73b6ecdb 261static inline struct extcon_dev *extcon_dev_allocate(const unsigned int *cable)
a9af6522
CC
262{
263 return ERR_PTR(-ENOSYS);
264}
265
266static inline void extcon_dev_free(struct extcon_dev *edev) { }
267
739ba1bf 268static inline struct extcon_dev *devm_extcon_dev_allocate(struct device *dev,
73b6ecdb 269 const unsigned int *cable)
739ba1bf
CC
270{
271 return ERR_PTR(-ENOSYS);
272}
273
274static inline void devm_extcon_dev_free(struct extcon_dev *edev) { }
275
de55d871
MH
276static inline u32 extcon_get_state(struct extcon_dev *edev)
277{
278 return 0;
279}
280
bde68e60
MH
281static inline int extcon_set_state(struct extcon_dev *edev, u32 state)
282{
283 return 0;
284}
806d9dd7 285
bde68e60 286static inline int extcon_update_state(struct extcon_dev *edev, u32 mask,
806d9dd7 287 u32 state)
bde68e60
MH
288{
289 return 0;
290}
806d9dd7 291
806d9dd7 292static inline int extcon_get_cable_state_(struct extcon_dev *edev,
73b6ecdb 293 unsigned int id)
806d9dd7
MH
294{
295 return 0;
296}
297
298static inline int extcon_set_cable_state_(struct extcon_dev *edev,
73b6ecdb 299 unsigned int id, bool cable_state)
806d9dd7
MH
300{
301 return 0;
302}
303
304static inline int extcon_get_cable_state(struct extcon_dev *edev,
305 const char *cable_name)
306{
307 return 0;
308}
309
310static inline int extcon_set_cable_state(struct extcon_dev *edev,
311 const char *cable_name, int state)
312{
313 return 0;
314}
315
74c5d09b
DK
316static inline struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name)
317{
318 return NULL;
319}
320
321static inline int extcon_register_notifier(struct extcon_dev *edev,
73b6ecdb 322 unsigned int id,
046050f6 323 struct notifier_block *nb)
74c5d09b
DK
324{
325 return 0;
326}
327
328static inline int extcon_unregister_notifier(struct extcon_dev *edev,
73b6ecdb 329 unsigned int id,
046050f6 330 struct notifier_block *nb)
74c5d09b
DK
331{
332 return 0;
333}
334
806d9dd7
MH
335static inline int extcon_register_interest(struct extcon_specific_cable_nb *obj,
336 const char *extcon_name,
337 const char *cable_name,
338 struct notifier_block *nb)
339{
340 return 0;
341}
342
343static inline int extcon_unregister_interest(struct extcon_specific_cable_nb
344 *obj)
345{
346 return 0;
347}
1ad94ffe
CC
348
349static inline struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev,
350 int index)
351{
352 return ERR_PTR(-ENODEV);
353}
de55d871
MH
354#endif /* CONFIG_EXTCON */
355#endif /* __LINUX_EXTCON_H__ */
This page took 0.279034 seconds and 5 git commands to generate.