[linux-2.6-block.git] / include / linux / extcon.h

/*
 *  External connector (extcon) class driver
 *
 * Copyright (C) 2015 Samsung Electronics
 * Author: Chanwoo Choi <cw00.choi@samsung.com>
 *
 * Copyright (C) 2012 Samsung Electronics
 * Author: Donggeun Kim <dg77.kim@samsung.com>
 * Author: MyungJoo Ham <myungjoo.ham@samsung.com>
 *
 * based on switch class driver
 * Copyright (C) 2008 Google, Inc.
 * Author: Mike Lockwood <lockwood@android.com>
 *
 * This software is licensed under the terms of the GNU General Public
 * License version 2, as published by the Free Software Foundation, and
 * may be copied, distributed, and modified under those terms.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
*/

#ifndef __LINUX_EXTCON_H__
#define __LINUX_EXTCON_H__

#include <linux/device.h>

/*
 * Define the type of supported external connectors
 */
#define EXTCON_TYPE_USB		BIT(0)	/* USB connector */
#define EXTCON_TYPE_CHG		BIT(1)	/* Charger connector */
#define EXTCON_TYPE_JACK	BIT(2)	/* Jack connector */
#define EXTCON_TYPE_DISP	BIT(3)	/* Display connector */
#define EXTCON_TYPE_MISC	BIT(4)	/* Miscellaneous connector */

/*
 * Define the unique id of supported external connectors
 */
#define EXTCON_NONE		0

/* USB external connector */
#define EXTCON_USB		1
#define EXTCON_USB_HOST		2

/* Charging external connector */
#define EXTCON_CHG_USB_SDP	5	/* Standard Downstream Port */
#define EXTCON_CHG_USB_DCP	6	/* Dedicated Charging Port */
#define EXTCON_CHG_USB_CDP	7	/* Charging Downstream Port */
#define EXTCON_CHG_USB_ACA	8	/* Accessory Charger Adapter */
#define EXTCON_CHG_USB_FAST	9
#define EXTCON_CHG_USB_SLOW	10

/* Jack external connector */
#define EXTCON_JACK_MICROPHONE	20
#define EXTCON_JACK_HEADPHONE	21
#define EXTCON_JACK_LINE_IN	22
#define EXTCON_JACK_LINE_OUT	23
#define EXTCON_JACK_VIDEO_IN	24
#define EXTCON_JACK_VIDEO_OUT	25
#define EXTCON_JACK_SPDIF_IN	26	/* Sony Philips Digital InterFace */
#define EXTCON_JACK_SPDIF_OUT	27

/* Display external connector */
#define EXTCON_DISP_HDMI	40	/* High-Definition Multimedia Interface */
#define EXTCON_DISP_MHL		41	/* Mobile High-Definition Link */
#define EXTCON_DISP_DVI		42	/* Digital Visual Interface */
#define EXTCON_DISP_VGA		43	/* Video Graphics Array */

/* Miscellaneous external connector */
#define EXTCON_DOCK		60
#define EXTCON_JIG		61
#define EXTCON_MECHANICAL	62

#define EXTCON_NUM		63

/*
 * Define the property of supported external connectors.
 *
 * When adding the new extcon property, they *must* have
 * the type/value/default information. Also, you *have to*
 * modify the EXTCON_PROP_[type]_START/END definitions
 * which mean the range of the supported properties
 * for each extcon type.
 *
 * The naming style of property
 * : EXTCON_PROP_[type]_[property name]
 *
 * EXTCON_PROP_USB_[property name]	: USB property
 * EXTCON_PROP_CHG_[property name]	: Charger property
 * EXTCON_PROP_JACK_[property name]	: Jack property
 * EXTCON_PROP_DISP_[property name]	: Display property
 */

/*
 * Properties of EXTCON_TYPE_USB.
 *
 * - EXTCON_PROP_USB_VBUS
 * @type:	integer (intval)
 * @value:	0 (low) or 1 (high)
 * @default:	0 (low)
 */
#define EXTCON_PROP_USB_VBUS		0

#define EXTCON_PROP_USB_MIN		0
#define EXTCON_PROP_USB_MAX		0
#define EXTCON_PROP_USB_CNT	(EXTCON_PROP_USB_MAX - EXTCON_PROP_USB_MIN + 1)

/* Properties of EXTCON_TYPE_CHG. */
#define EXTCON_PROP_CHG_MIN		50
#define EXTCON_PROP_CHG_MAX		50
#define EXTCON_PROP_CHG_CNT	(EXTCON_PROP_CHG_MAX - EXTCON_PROP_CHG_MIN + 1)

/* Properties of EXTCON_TYPE_JACK. */
#define EXTCON_PROP_JACK_MIN		100
#define EXTCON_PROP_JACK_MAX		100
#define EXTCON_PROP_JACK_CNT (EXTCON_PROP_JACK_MAX - EXTCON_PROP_JACK_MIN + 1)

/* Properties of EXTCON_TYPE_DISP. */
#define EXTCON_PROP_DISP_MIN		150
#define EXTCON_PROP_DISP_MAX		150
#define EXTCON_PROP_DISP_CNT (EXTCON_PROP_DISP_MAX - EXTCON_PROP_DISP_MIN + 1)

/*
 * Define the type of property's value.
 *
 * Define the property's value as union type. Because each property
 * would need the different data type to store it.
 */
union extcon_property_value {
	int intval;	/* type : integer (intval) */
};

struct extcon_cable;

/**
 * struct extcon_dev - An extcon device represents one external connector.
 * @name:		The name of this extcon device. Parent device name is
 *			used if NULL.
 * @supported_cable:	Array of supported cable names ending with EXTCON_NONE.
 *			If supported_cable is NULL, cable name related APIs
 *			are disabled.
 * @mutually_exclusive:	Array of mutually exclusive set of cables that cannot
 *			be attached simultaneously. The array should be
 *			ending with NULL or be NULL (no mutually exclusive
 *			cables). For example, if it is { 0x7, 0x30, 0}, then,
 *			{0, 1}, {0, 1, 2}, {0, 2}, {1, 2}, or {4, 5} cannot
 *			be attached simulataneously. {0x7, 0} is equivalent to
 *			{0x3, 0x6, 0x5, 0}. If it is {0xFFFFFFFF, 0}, there
 *			can be no simultaneous connections.
 * @dev:		Device of this extcon.
 * @state:		Attach/detach state of this extcon. Do not provide at
 *			register-time.
 * @nh:			Notifier for the state change events from this extcon
 * @entry:		To support list of extcon devices so that users can
 *			search for extcon devices based on the extcon name.
 * @lock:
 * @max_supported:	Internal value to store the number of cables.
 * @extcon_dev_type:	Device_type struct to provide attribute_groups
 *			customized for each extcon device.
 * @cables:		Sysfs subdirectories. Each represents one cable.
 *
 * In most cases, users only need to provide "User initializing data" of
 * this struct when registering an extcon. In some exceptional cases,
 * optional callbacks may be needed. However, the values in "internal data"
 * are overwritten by register function.
 */
struct extcon_dev {
	/* Optional user initializing data */
	const char *name;
	const unsigned int *supported_cable;
	const u32 *mutually_exclusive;

	/* Internal data. Please do not set. */
	struct device dev;
	struct raw_notifier_head *nh;
	struct list_head entry;
	int max_supported;
	spinlock_t lock;	/* could be called by irq handler */
	u32 state;

	/* /sys/class/extcon/.../cable.n/... */
	struct device_type extcon_dev_type;
	struct extcon_cable *cables;

	/* /sys/class/extcon/.../mutually_exclusive/... */
	struct attribute_group attr_g_muex;
	struct attribute **attrs_muex;
	struct device_attribute *d_attrs_muex;
};

#if IS_ENABLED(CONFIG_EXTCON)

/*
 * Following APIs are for notifiers or configurations.
 * Notifiers are the external port and connection devices.
 */
extern int extcon_dev_register(struct extcon_dev *edev);
extern void extcon_dev_unregister(struct extcon_dev *edev);
extern int devm_extcon_dev_register(struct device *dev,
				    struct extcon_dev *edev);
extern void devm_extcon_dev_unregister(struct device *dev,
				       struct extcon_dev *edev);
extern struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name);

/*
 * Following APIs control the memory of extcon device.
 */
extern struct extcon_dev *extcon_dev_allocate(const unsigned int *cable);
extern void extcon_dev_free(struct extcon_dev *edev);
extern struct extcon_dev *devm_extcon_dev_allocate(struct device *dev,
						   const unsigned int *cable);
extern void devm_extcon_dev_free(struct device *dev, struct extcon_dev *edev);

/*
 * get/set_cable_state access each bit of the 32b encoded state value.
 * They are used to access the status of each cable based on the cable id.
 */
extern int extcon_get_cable_state_(struct extcon_dev *edev, unsigned int id);
extern int extcon_set_cable_state_(struct extcon_dev *edev, unsigned int id,
				   bool cable_state);

/*
 * get/set_property access the property value of each external connector.
 * They are used to access the property of each cable based on the property id.
 */
extern int extcon_get_property(struct extcon_dev *edev, unsigned int id,
				unsigned int prop,
				union extcon_property_value *prop_val);
extern int extcon_set_property(struct extcon_dev *edev, unsigned int id,
				unsigned int prop,
				union extcon_property_value prop_val);

/*
 * get/set_property_capability set the capability of the property for each
 * external connector. They are used to set the capability of the property
 * of each external connector based on the id and property.
 */
extern int extcon_get_property_capability(struct extcon_dev *edev,
				unsigned int id, unsigned int prop);
extern int extcon_set_property_capability(struct extcon_dev *edev,
				unsigned int id, unsigned int prop);

/*
 * Following APIs are to monitor every action of a notifier.
 * Registrar gets notified for every external port of a connection device.
 * Probably this could be used to debug an action of notifier; however,
 * we do not recommend to use this for normal 'notifiee' device drivers who
 * want to be notified by a specific external port of the notifier.
 */
extern int extcon_register_notifier(struct extcon_dev *edev, unsigned int id,
				    struct notifier_block *nb);
extern int extcon_unregister_notifier(struct extcon_dev *edev, unsigned int id,
				    struct notifier_block *nb);
extern int devm_extcon_register_notifier(struct device *dev,
				struct extcon_dev *edev, unsigned int id,
				struct notifier_block *nb);
extern void devm_extcon_unregister_notifier(struct device *dev,
				struct extcon_dev *edev, unsigned int id,
				struct notifier_block *nb);

/*
 * Following API get the extcon device from devicetree.
 * This function use phandle of devicetree to get extcon device directly.
 */
extern struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev,
						     int index);

/* Following API to get information of extcon device */
extern const char *extcon_get_edev_name(struct extcon_dev *edev);


#else /* CONFIG_EXTCON */
static inline int extcon_dev_register(struct extcon_dev *edev)
{
	return 0;
}

static inline void extcon_dev_unregister(struct extcon_dev *edev) { }

static inline int devm_extcon_dev_register(struct device *dev,
					   struct extcon_dev *edev)
{
	return -EINVAL;
}

static inline void devm_extcon_dev_unregister(struct device *dev,
					      struct extcon_dev *edev) { }

static inline struct extcon_dev *extcon_dev_allocate(const unsigned int *cable)
{
	return ERR_PTR(-ENOSYS);
}

static inline void extcon_dev_free(struct extcon_dev *edev) { }

static inline struct extcon_dev *devm_extcon_dev_allocate(struct device *dev,
						const unsigned int *cable)
{
	return ERR_PTR(-ENOSYS);
}

static inline void devm_extcon_dev_free(struct extcon_dev *edev) { }

static inline int extcon_get_cable_state_(struct extcon_dev *edev,
					  unsigned int id)
{
	return 0;
}

static inline int extcon_set_cable_state_(struct extcon_dev *edev,
					  unsigned int id, bool cable_state)
{
	return 0;
}

static inline int extcon_get_property(struct extcon_dev *edev, unsigned int id,
					unsigned int prop,
					union extcon_property_value *prop_val)
{
	return 0;
}
static inline int extcon_set_property(struct extcon_dev *edev, unsigned int id,
					unsigned int prop,
					union extcon_property_value prop_val)
{
	return 0;
}

static inline int extcon_get_property_capability(struct extcon_dev *edev,
					unsigned int id, unsigned int prop)
{
	return 0;
}

static inline int extcon_set_property_capability(struct extcon_dev *edev,
					unsigned int id, unsigned int prop)
{
	return 0;
}

static inline struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name)
{
	return NULL;
}

static inline int extcon_register_notifier(struct extcon_dev *edev,
					unsigned int id,
					struct notifier_block *nb)
{
	return 0;
}

static inline int extcon_unregister_notifier(struct extcon_dev *edev,
					unsigned int id,
					struct notifier_block *nb)
{
	return 0;
}

static inline int devm_extcon_register_notifier(struct device *dev,
				struct extcon_dev *edev, unsigned int id,
				struct notifier_block *nb)
{
	return -ENOSYS;
}

static inline  void devm_extcon_unregister_notifier(struct device *dev,
				struct extcon_dev *edev, unsigned int id,
				struct notifier_block *nb) { }

static inline struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev,
							    int index)
{
	return ERR_PTR(-ENODEV);
}
#endif /* CONFIG_EXTCON */

/*
 * Following structure and API are deprecated. EXTCON remains the function
 * definition to prevent the build break.
 */
struct extcon_specific_cable_nb {
       struct notifier_block *user_nb;
       int cable_index;
       struct extcon_dev *edev;
       unsigned long previous_value;
};

static inline int extcon_register_interest(struct extcon_specific_cable_nb *obj,
			const char *extcon_name, const char *cable_name,
			struct notifier_block *nb)
{
	return -EINVAL;
}

static inline int extcon_unregister_interest(struct extcon_specific_cable_nb
						    *obj)
{
	return -EINVAL;
}
#endif /* __LINUX_EXTCON_H__ */
Commit	Line	Data
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
505cf01f CC	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
73b6ecdb CC	40	/*
	41	* Define the unique id of supported external connectors
	42	*/
11eecf91	43	#define EXTCON_NONE 0
73b6ecdb	44
11eecf91 CC	45	/* USB external connector */
	46	#define EXTCON_USB 1
	47	#define EXTCON_USB_HOST 2
73b6ecdb	48
11eecf91 CC	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
73b6ecdb	56
11eecf91 CC	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
73b6ecdb	66
11eecf91 CC	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
	73	/* Miscellaneous external connector */
	74	#define EXTCON_DOCK 60
	75	#define EXTCON_JIG 61
	76	#define EXTCON_MECHANICAL 62
	77
	78	#define EXTCON_NUM 63
806d9dd7	79
067c1652 CC	80	/*
	81	* Define the property of supported external connectors.
	82	*
	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.
	88	*
	89	* The naming style of property
	90	* : EXTCON_PROP_[type]_[property name]
	91	*
	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
	96	*/
	97
	98	/*
	99	* Properties of EXTCON_TYPE_USB.
	100	*
	101	* - EXTCON_PROP_USB_VBUS
	102	* @type: integer (intval)
	103	* @value: 0 (low) or 1 (high)
	104	* @default: 0 (low)
	105	*/
	106	#define EXTCON_PROP_USB_VBUS 0
	107
	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)
	111
	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)
	116
	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)
	121
	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)
	126
	127	/*
	128	* Define the type of property's value.
	129	*
	130	* Define the property's value as union type. Because each property
	131	* would need the different data type to store it.
	132	*/
	133	union extcon_property_value {
	134	int intval; /* type : integer (intval) */
	135	};
	136
806d9dd7 MH	137	struct extcon_cable;
806d9dd7 MH	138
de55d871 MH	139	/**
de55d871 MH	140	* struct extcon_dev - An extcon device represents one external connector.
a75e1c73 CC	141	* @name: The name of this extcon device. Parent device name is
a75e1c73 CC	142	* used if NULL.
2a9de9c0	143	* @supported_cable: Array of supported cable names ending with EXTCON_NONE.
806d9dd7 MH	144	* If supported_cable is NULL, cable name related APIs
806d9dd7 MH	145	* are disabled.
df072eb9	146	* @mutually_exclusive: Array of mutually exclusive set of cables that cannot
bde68e60 MH	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.
dae61651	154	* @dev: Device of this extcon.
a75e1c73 CC	155	* @state: Attach/detach state of this extcon. Do not provide at
	156	* register-time.
	157	* @nh: Notifier for the state change events from this extcon
b9ec23c0 CC	158	* @entry: To support list of extcon devices so that users can
b9ec23c0 CC	159	* search for extcon devices based on the extcon name.
df072eb9 MH	160	* @lock:
	161	* @max_supported: Internal value to store the number of cables.
	162	* @extcon_dev_type: Device_type struct to provide attribute_groups
806d9dd7	163	* customized for each extcon device.
a75e1c73	164	* @cables: Sysfs subdirectories. Each represents one cable.
de55d871 MH	165	*
	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.
	170	*/
	171	struct extcon_dev {
a75e1c73 CC	172	/* Optional user initializing data */
a75e1c73 CC	173	const char *name;
73b6ecdb	174	const unsigned int *supported_cable;
a75e1c73	175	const u32 *mutually_exclusive;
de55d871	176
a75e1c73	177	/* Internal data. Please do not set. */
dae61651	178	struct device dev;
046050f6	179	struct raw_notifier_head *nh;
74c5d09b	180	struct list_head entry;
806d9dd7	181	int max_supported;
a75e1c73 CC	182	spinlock_t lock; /* could be called by irq handler */
a75e1c73 CC	183	u32 state;
806d9dd7 MH	184
	185	/* /sys/class/extcon/.../cable.n/... */
	186	struct device_type extcon_dev_type;
	187	struct extcon_cable *cables;
a75e1c73	188
bde68e60 MH	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;
806d9dd7 MH	193	};
806d9dd7 MH	194
de55d871	195	#if IS_ENABLED(CONFIG_EXTCON)
74c5d09b DK	196
	197	/*
	198	* Following APIs are for notifiers or configurations.
	199	* Notifiers are the external port and connection devices.
	200	*/
42d7d753	201	extern int extcon_dev_register(struct extcon_dev *edev);
de55d871	202	extern void extcon_dev_unregister(struct extcon_dev *edev);
1111244f SW	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);
74c5d09b	207	extern struct extcon_dev extcon_get_extcon_dev(const char extcon_name);
de55d871	208
a9af6522 CC	209	/*
	210	* Following APIs control the memory of extcon device.
	211	*/
73b6ecdb	212	extern struct extcon_dev extcon_dev_allocate(const unsigned int cable);
a9af6522	213	extern void extcon_dev_free(struct extcon_dev *edev);
739ba1bf	214	extern struct extcon_dev devm_extcon_dev_allocate(struct device dev,
73b6ecdb	215	const unsigned int *cable);
739ba1bf	216	extern void devm_extcon_dev_free(struct device dev, struct extcon_dev edev);
a9af6522	217
806d9dd7 MH	218	/*
806d9dd7 MH	219	* get/set_cable_state access each bit of the 32b encoded state value.
bc921260	220	* They are used to access the status of each cable based on the cable id.
806d9dd7	221	*/
73b6ecdb CC	222	extern int extcon_get_cable_state_(struct extcon_dev *edev, unsigned int id);
73b6ecdb CC	223	extern int extcon_set_cable_state_(struct extcon_dev *edev, unsigned int id,
806d9dd7 MH	224	bool cable_state);
806d9dd7 MH	225
067c1652 CC	226	/*
	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.
	229	*/
	230	extern int extcon_get_property(struct extcon_dev *edev, unsigned int id,
	231	unsigned int prop,
	232	union extcon_property_value *prop_val);
	233	extern int extcon_set_property(struct extcon_dev *edev, unsigned int id,
	234	unsigned int prop,
	235	union extcon_property_value prop_val);
	236
ceaa98f4 CC	237	/*
	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.
	241	*/
	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);
	246
74c5d09b DK	247	/*
74c5d09b DK	248	* Following APIs are to monitor every action of a notifier.
c338bb03	249	* Registrar gets notified for every external port of a connection device.
806d9dd7	250	* Probably this could be used to debug an action of notifier; however,
c338bb03	251	* we do not recommend to use this for normal 'notifiee' device drivers who
806d9dd7	252	* want to be notified by a specific external port of the notifier.
74c5d09b	253	*/
73b6ecdb	254	extern int extcon_register_notifier(struct extcon_dev *edev, unsigned int id,
046050f6	255	struct notifier_block *nb);
73b6ecdb	256	extern int extcon_unregister_notifier(struct extcon_dev *edev, unsigned int id,
74c5d09b	257	struct notifier_block *nb);
58f38656 CC	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);
1ad94ffe CC	264
	265	/*
	266	* Following API get the extcon device from devicetree.
	267	* This function use phandle of devicetree to get extcon device directly.
	268	*/
b9ec23c0 CC	269	extern struct extcon_dev extcon_get_edev_by_phandle(struct device dev,
b9ec23c0 CC	270	int index);
707d7550 CC	271
	272	/* Following API to get information of extcon device */
	273	extern const char extcon_get_edev_name(struct extcon_dev edev);
	274
830ae442	275
de55d871	276	#else /* CONFIG_EXTCON */
42d7d753	277	static inline int extcon_dev_register(struct extcon_dev *edev)
de55d871 MH	278	{
	279	return 0;
	280	}
	281
	282	static inline void extcon_dev_unregister(struct extcon_dev *edev) { }
	283
1111244f SW	284	static inline int devm_extcon_dev_register(struct device *dev,
	285	struct extcon_dev *edev)
	286	{
	287	return -EINVAL;
	288	}
	289
	290	static inline void devm_extcon_dev_unregister(struct device *dev,
	291	struct extcon_dev *edev) { }
	292
73b6ecdb	293	static inline struct extcon_dev extcon_dev_allocate(const unsigned int cable)
a9af6522 CC	294	{
	295	return ERR_PTR(-ENOSYS);
	296	}
	297
	298	static inline void extcon_dev_free(struct extcon_dev *edev) { }
	299
739ba1bf	300	static inline struct extcon_dev devm_extcon_dev_allocate(struct device dev,
73b6ecdb	301	const unsigned int *cable)
739ba1bf CC	302	{
	303	return ERR_PTR(-ENOSYS);
	304	}
	305
	306	static inline void devm_extcon_dev_free(struct extcon_dev *edev) { }
	307
806d9dd7	308	static inline int extcon_get_cable_state_(struct extcon_dev *edev,
73b6ecdb	309	unsigned int id)
806d9dd7 MH	310	{
	311	return 0;
	312	}
	313
	314	static inline int extcon_set_cable_state_(struct extcon_dev *edev,
73b6ecdb	315	unsigned int id, bool cable_state)
806d9dd7 MH	316	{
	317	return 0;
	318	}
	319
067c1652 CC	320	static inline int extcon_get_property(struct extcon_dev *edev, unsigned int id,
	321	unsigned int prop,
	322	union extcon_property_value *prop_val)
	323	{
	324	return 0;
	325	}
	326	static inline int extcon_set_property(struct extcon_dev *edev, unsigned int id,
	327	unsigned int prop,
	328	union extcon_property_value prop_val)
	329	{
	330	return 0;
	331	}
	332
ceaa98f4 CC	333	static inline int extcon_get_property_capability(struct extcon_dev *edev,
	334	unsigned int id, unsigned int prop)
	335	{
	336	return 0;
	337	}
	338
	339	static inline int extcon_set_property_capability(struct extcon_dev *edev,
	340	unsigned int id, unsigned int prop)
	341	{
	342	return 0;
	343	}
	344
74c5d09b DK	345	static inline struct extcon_dev extcon_get_extcon_dev(const char extcon_name)
	346	{
	347	return NULL;
	348	}
	349
	350	static inline int extcon_register_notifier(struct extcon_dev *edev,
73b6ecdb	351	unsigned int id,
046050f6	352	struct notifier_block *nb)
74c5d09b DK	353	{
	354	return 0;
	355	}
	356
	357	static inline int extcon_unregister_notifier(struct extcon_dev *edev,
73b6ecdb	358	unsigned int id,
046050f6	359	struct notifier_block *nb)
74c5d09b DK	360	{
	361	return 0;
	362	}
	363
58f38656 CC	364	static inline int devm_extcon_register_notifier(struct device *dev,
	365	struct extcon_dev *edev, unsigned int id,
	366	struct notifier_block *nb)
	367	{
	368	return -ENOSYS;
	369	}
	370
	371	static inline void devm_extcon_unregister_notifier(struct device *dev,
	372	struct extcon_dev *edev, unsigned int id,
	373	struct notifier_block *nb) { }
	374
830ae442 CC	375	static inline struct extcon_dev extcon_get_edev_by_phandle(struct device dev,
830ae442 CC	376	int index)
806d9dd7	377	{
830ae442	378	return ERR_PTR(-ENODEV);
806d9dd7	379	}
830ae442	380	#endif /* CONFIG_EXTCON */
806d9dd7	381
830ae442 CC	382	/*
	383	* Following structure and API are deprecated. EXTCON remains the function
	384	* definition to prevent the build break.
	385	*/
	386	struct extcon_specific_cable_nb {
	387	struct notifier_block *user_nb;
	388	int cable_index;
	389	struct extcon_dev *edev;
	390	unsigned long previous_value;
	391	};
	392
	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)
806d9dd7	396	{
830ae442	397	return -EINVAL;
806d9dd7	398	}
1ad94ffe	399
830ae442 CC	400	static inline int extcon_unregister_interest(struct extcon_specific_cable_nb
830ae442 CC	401	*obj)
1ad94ffe	402	{
830ae442	403	return -EINVAL;
1ad94ffe	404	}
de55d871	405	#endif /* __LINUX_EXTCON_H__ */