[deliverable/linux.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
#define EXTCON_CHG_WPT		11	/* Wireless Power Transfer */

/* 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 */
#define EXTCON_DISP_DP		44	/* Display Port */
#define EXTCON_DISP_HMD		45	/* Head-Mounted Display */

/* 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)
 * - EXTCON_PROP_USB_TYPEC_POLARITY
 * @type:	integer (intval)
 * @value:	0 (normal) or 1 (flip)
 * @default:	0 (normal)
 * - EXTCON_PROP_USB_SS (SuperSpeed)
 * @type:       integer (intval)
 * @value:      0 (USB/USB2) or 1 (USB3)
 * @default:    0 (USB/USB2)
 *
 */
#define EXTCON_PROP_USB_VBUS		0
#define EXTCON_PROP_USB_TYPEC_POLARITY	1
#define EXTCON_PROP_USB_SS		2

#define EXTCON_PROP_USB_MIN		0
#define EXTCON_PROP_USB_MAX		2
#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.
 *
 * - EXTCON_PROP_DISP_HPD (Hot Plug Detect)
 * @type:       integer (intval)
 * @value:      0 (no hpd) or 1 (hpd)
 * @default:    0 (no hpd)
 *
 */
#define EXTCON_PROP_DISP_HPD		150

/* Properties of EXTCON_TYPE_DISP. */
#define EXTCON_PROP_DISP_MIN		150
#define EXTCON_PROP_DISP_MAX		151
#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_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_state(struct extcon_dev *edev, unsigned int id);
extern int extcon_set_state(struct extcon_dev *edev, unsigned int id,
				   bool cable_state);
extern int extcon_set_state_sync(struct extcon_dev *edev, unsigned int id,
				bool cable_state);

/*
 * Synchronize the state and property data for a specific external connector.
 */
extern int extcon_sync(struct extcon_dev *edev, unsigned int id);

/*
 * 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);
extern int extcon_set_property_sync(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_state(struct extcon_dev *edev, unsigned int id)
{
	return 0;
}

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

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

static inline int extcon_sync(struct extcon_dev *edev, unsigned int id)
{
	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_set_property_sync(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;
}

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

static inline int extcon_set_cable_state_(struct extcon_dev *edev, unsigned int id,
				   bool cable_state)
{
	return extcon_set_state_sync(edev, id, cable_state);
}
#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
55e4e2f1 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
7fe95fb8	56	#define EXTCON_CHG_WPT 11 /* Wireless Power Transfer */
73b6ecdb	57
11eecf91 CC	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
73b6ecdb	67
11eecf91 CC	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 */
2164188d	73	#define EXTCON_DISP_DP 44 /* Display Port */
9c0595d6	74	#define EXTCON_DISP_HMD 45 /* Head-Mounted Display */
11eecf91 CC	75
	76	/* Miscellaneous external connector */
	77	#define EXTCON_DOCK 60
	78	#define EXTCON_JIG 61
	79	#define EXTCON_MECHANICAL 62
	80
	81	#define EXTCON_NUM 63
806d9dd7	82
792e7e9e CC	83	/*
	84	* Define the property of supported external connectors.
	85	*
	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.
	91	*
	92	* The naming style of property
	93	* : EXTCON_PROP_[type]_[property name]
	94	*
	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
	99	*/
	100
	101	/*
	102	* Properties of EXTCON_TYPE_USB.
	103	*
	104	* - EXTCON_PROP_USB_VBUS
	105	* @type: integer (intval)
	106	* @value: 0 (low) or 1 (high)
	107	* @default: 0 (low)
2164188d CZ	108	* - EXTCON_PROP_USB_TYPEC_POLARITY
	109	* @type: integer (intval)
	110	* @value: 0 (normal) or 1 (flip)
	111	* @default: 0 (normal)
8457a1b4 GR	112	* - EXTCON_PROP_USB_SS (SuperSpeed)
	113	* @type: integer (intval)
	114	* @value: 0 (USB/USB2) or 1 (USB3)
	115	* @default: 0 (USB/USB2)
	116	*
792e7e9e CC	117	*/
792e7e9e CC	118	#define EXTCON_PROP_USB_VBUS 0
2164188d	119	#define EXTCON_PROP_USB_TYPEC_POLARITY 1
8457a1b4	120	#define EXTCON_PROP_USB_SS 2
792e7e9e CC	121
792e7e9e CC	122	#define EXTCON_PROP_USB_MIN 0
8457a1b4	123	#define EXTCON_PROP_USB_MAX 2
792e7e9e CC	124	#define EXTCON_PROP_USB_CNT (EXTCON_PROP_USB_MAX - EXTCON_PROP_USB_MIN + 1)
	125
	126	/* Properties of EXTCON_TYPE_CHG. */
	127	#define EXTCON_PROP_CHG_MIN 50
	128	#define EXTCON_PROP_CHG_MAX 50
	129	#define EXTCON_PROP_CHG_CNT (EXTCON_PROP_CHG_MAX - EXTCON_PROP_CHG_MIN + 1)
	130
	131	/* Properties of EXTCON_TYPE_JACK. */
	132	#define EXTCON_PROP_JACK_MIN 100
	133	#define EXTCON_PROP_JACK_MAX 100
	134	#define EXTCON_PROP_JACK_CNT (EXTCON_PROP_JACK_MAX - EXTCON_PROP_JACK_MIN + 1)
	135
c7914e8d CZ	136	/*
	137	* Properties of EXTCON_TYPE_DISP.
	138	*
	139	* - EXTCON_PROP_DISP_HPD (Hot Plug Detect)
	140	* @type: integer (intval)
	141	* @value: 0 (no hpd) or 1 (hpd)
	142	* @default: 0 (no hpd)
	143	*
	144	*/
	145	#define EXTCON_PROP_DISP_HPD 150
	146
792e7e9e CC	147	/* Properties of EXTCON_TYPE_DISP. */
792e7e9e CC	148	#define EXTCON_PROP_DISP_MIN 150
c7914e8d	149	#define EXTCON_PROP_DISP_MAX 151
792e7e9e CC	150	#define EXTCON_PROP_DISP_CNT (EXTCON_PROP_DISP_MAX - EXTCON_PROP_DISP_MIN + 1)
	151
	152	/*
	153	* Define the type of property's value.
	154	*
	155	* Define the property's value as union type. Because each property
	156	* would need the different data type to store it.
	157	*/
	158	union extcon_property_value {
	159	int intval; /* type : integer (intval) */
	160	};
	161
806d9dd7 MH	162	struct extcon_cable;
806d9dd7 MH	163
de55d871 MH	164	/**
de55d871 MH	165	* struct extcon_dev - An extcon device represents one external connector.
a75e1c73 CC	166	* @name: The name of this extcon device. Parent device name is
a75e1c73 CC	167	* used if NULL.
2a9de9c0	168	* @supported_cable: Array of supported cable names ending with EXTCON_NONE.
806d9dd7 MH	169	* If supported_cable is NULL, cable name related APIs
806d9dd7 MH	170	* are disabled.
df072eb9	171	* @mutually_exclusive: Array of mutually exclusive set of cables that cannot
bde68e60 MH	172	* be attached simultaneously. The array should be
	173	* ending with NULL or be NULL (no mutually exclusive
	174	* cables). For example, if it is { 0x7, 0x30, 0}, then,
	175	* {0, 1}, {0, 1, 2}, {0, 2}, {1, 2}, or {4, 5} cannot
	176	* be attached simulataneously. {0x7, 0} is equivalent to
	177	* {0x3, 0x6, 0x5, 0}. If it is {0xFFFFFFFF, 0}, there
	178	* can be no simultaneous connections.
dae61651	179	* @dev: Device of this extcon.
a75e1c73 CC	180	* @state: Attach/detach state of this extcon. Do not provide at
	181	* register-time.
	182	* @nh: Notifier for the state change events from this extcon
b9ec23c0 CC	183	* @entry: To support list of extcon devices so that users can
b9ec23c0 CC	184	* search for extcon devices based on the extcon name.
df072eb9 MH	185	* @lock:
	186	* @max_supported: Internal value to store the number of cables.
	187	* @extcon_dev_type: Device_type struct to provide attribute_groups
806d9dd7	188	* customized for each extcon device.
a75e1c73	189	* @cables: Sysfs subdirectories. Each represents one cable.
de55d871 MH	190	*
	191	* In most cases, users only need to provide "User initializing data" of
	192	* this struct when registering an extcon. In some exceptional cases,
	193	* optional callbacks may be needed. However, the values in "internal data"
	194	* are overwritten by register function.
	195	*/
	196	struct extcon_dev {
a75e1c73 CC	197	/* Optional user initializing data */
a75e1c73 CC	198	const char *name;
73b6ecdb	199	const unsigned int *supported_cable;
a75e1c73	200	const u32 *mutually_exclusive;
de55d871	201
a75e1c73	202	/* Internal data. Please do not set. */
dae61651	203	struct device dev;
046050f6	204	struct raw_notifier_head *nh;
74c5d09b	205	struct list_head entry;
806d9dd7	206	int max_supported;
a75e1c73 CC	207	spinlock_t lock; /* could be called by irq handler */
a75e1c73 CC	208	u32 state;
806d9dd7 MH	209
	210	/* /sys/class/extcon/.../cable.n/... */
	211	struct device_type extcon_dev_type;
	212	struct extcon_cable *cables;
a75e1c73	213
bde68e60 MH	214	/* /sys/class/extcon/.../mutually_exclusive/... */
	215	struct attribute_group attr_g_muex;
	216	struct attribute **attrs_muex;
	217	struct device_attribute *d_attrs_muex;
806d9dd7 MH	218	};
806d9dd7 MH	219
de55d871	220	#if IS_ENABLED(CONFIG_EXTCON)
74c5d09b DK	221
	222	/*
	223	* Following APIs are for notifiers or configurations.
	224	* Notifiers are the external port and connection devices.
	225	*/
42d7d753	226	extern int extcon_dev_register(struct extcon_dev *edev);
de55d871	227	extern void extcon_dev_unregister(struct extcon_dev *edev);
1111244f SW	228	extern int devm_extcon_dev_register(struct device *dev,
	229	struct extcon_dev *edev);
	230	extern void devm_extcon_dev_unregister(struct device *dev,
	231	struct extcon_dev *edev);
74c5d09b	232	extern struct extcon_dev extcon_get_extcon_dev(const char extcon_name);
de55d871	233
a9af6522 CC	234	/*
	235	* Following APIs control the memory of extcon device.
	236	*/
73b6ecdb	237	extern struct extcon_dev extcon_dev_allocate(const unsigned int cable);
a9af6522	238	extern void extcon_dev_free(struct extcon_dev *edev);
739ba1bf	239	extern struct extcon_dev devm_extcon_dev_allocate(struct device dev,
73b6ecdb	240	const unsigned int *cable);
739ba1bf	241	extern void devm_extcon_dev_free(struct device dev, struct extcon_dev edev);
a9af6522	242
806d9dd7	243	/*
575c2b86	244	* get/set_state access each bit of the 32b encoded state value.
bc921260	245	* They are used to access the status of each cable based on the cable id.
806d9dd7	246	*/
575c2b86 CC	247	extern int extcon_get_state(struct extcon_dev *edev, unsigned int id);
575c2b86 CC	248	extern int extcon_set_state(struct extcon_dev *edev, unsigned int id,
806d9dd7	249	bool cable_state);
ab11af04 CC	250	extern int extcon_set_state_sync(struct extcon_dev *edev, unsigned int id,
	251	bool cable_state);
	252
	253	/*
	254	* Synchronize the state and property data for a specific external connector.
	255	*/
	256	extern int extcon_sync(struct extcon_dev *edev, unsigned int id);
806d9dd7	257
792e7e9e CC	258	/*
	259	* get/set_property access the property value of each external connector.
	260	* They are used to access the property of each cable based on the property id.
	261	*/
	262	extern int extcon_get_property(struct extcon_dev *edev, unsigned int id,
	263	unsigned int prop,
	264	union extcon_property_value *prop_val);
	265	extern int extcon_set_property(struct extcon_dev *edev, unsigned int id,
	266	unsigned int prop,
	267	union extcon_property_value prop_val);
ab11af04 CC	268	extern int extcon_set_property_sync(struct extcon_dev *edev, unsigned int id,
	269	unsigned int prop,
	270	union extcon_property_value prop_val);
792e7e9e	271
7f2a0a16 CC	272	/*
	273	* get/set_property_capability set the capability of the property for each
	274	* external connector. They are used to set the capability of the property
	275	* of each external connector based on the id and property.
	276	*/
	277	extern int extcon_get_property_capability(struct extcon_dev *edev,
	278	unsigned int id, unsigned int prop);
	279	extern int extcon_set_property_capability(struct extcon_dev *edev,
	280	unsigned int id, unsigned int prop);
	281
74c5d09b DK	282	/*
74c5d09b DK	283	* Following APIs are to monitor every action of a notifier.
c338bb03	284	* Registrar gets notified for every external port of a connection device.
806d9dd7	285	* Probably this could be used to debug an action of notifier; however,
c338bb03	286	* we do not recommend to use this for normal 'notifiee' device drivers who
806d9dd7	287	* want to be notified by a specific external port of the notifier.
74c5d09b	288	*/
73b6ecdb	289	extern int extcon_register_notifier(struct extcon_dev *edev, unsigned int id,
046050f6	290	struct notifier_block *nb);
73b6ecdb	291	extern int extcon_unregister_notifier(struct extcon_dev *edev, unsigned int id,
74c5d09b	292	struct notifier_block *nb);
58f38656 CC	293	extern int devm_extcon_register_notifier(struct device *dev,
	294	struct extcon_dev *edev, unsigned int id,
	295	struct notifier_block *nb);
	296	extern void devm_extcon_unregister_notifier(struct device *dev,
	297	struct extcon_dev *edev, unsigned int id,
	298	struct notifier_block *nb);
1ad94ffe CC	299
	300	/*
	301	* Following API get the extcon device from devicetree.
	302	* This function use phandle of devicetree to get extcon device directly.
	303	*/
b9ec23c0 CC	304	extern struct extcon_dev extcon_get_edev_by_phandle(struct device dev,
b9ec23c0 CC	305	int index);
707d7550 CC	306
	307	/* Following API to get information of extcon device */
	308	extern const char extcon_get_edev_name(struct extcon_dev edev);
	309
830ae442	310
de55d871	311	#else /* CONFIG_EXTCON */
42d7d753	312	static inline int extcon_dev_register(struct extcon_dev *edev)
de55d871 MH	313	{
	314	return 0;
	315	}
	316
	317	static inline void extcon_dev_unregister(struct extcon_dev *edev) { }
	318
1111244f SW	319	static inline int devm_extcon_dev_register(struct device *dev,
	320	struct extcon_dev *edev)
	321	{
	322	return -EINVAL;
	323	}
	324
	325	static inline void devm_extcon_dev_unregister(struct device *dev,
	326	struct extcon_dev *edev) { }
	327
73b6ecdb	328	static inline struct extcon_dev extcon_dev_allocate(const unsigned int cable)
a9af6522 CC	329	{
	330	return ERR_PTR(-ENOSYS);
	331	}
	332
	333	static inline void extcon_dev_free(struct extcon_dev *edev) { }
	334
739ba1bf	335	static inline struct extcon_dev devm_extcon_dev_allocate(struct device dev,
73b6ecdb	336	const unsigned int *cable)
739ba1bf CC	337	{
	338	return ERR_PTR(-ENOSYS);
	339	}
	340
	341	static inline void devm_extcon_dev_free(struct extcon_dev *edev) { }
	342
575c2b86 CC	343
575c2b86 CC	344	static inline int extcon_get_state(struct extcon_dev *edev, unsigned int id)
806d9dd7 MH	345	{
	346	return 0;
	347	}
	348
575c2b86 CC	349	static inline int extcon_set_state(struct extcon_dev *edev, unsigned int id,
575c2b86 CC	350	bool cable_state)
806d9dd7 MH	351	{
	352	return 0;
	353	}
	354
ab11af04 CC	355	static inline int extcon_set_state_sync(struct extcon_dev *edev, unsigned int id,
	356	bool cable_state)
	357	{
	358	return 0;
	359	}
	360
	361	static inline int extcon_sync(struct extcon_dev *edev, unsigned int id)
	362	{
	363	return 0;
	364	}
	365
792e7e9e CC	366	static inline int extcon_get_property(struct extcon_dev *edev, unsigned int id,
	367	unsigned int prop,
	368	union extcon_property_value *prop_val)
	369	{
	370	return 0;
	371	}
	372	static inline int extcon_set_property(struct extcon_dev *edev, unsigned int id,
	373	unsigned int prop,
	374	union extcon_property_value prop_val)
	375	{
	376	return 0;
	377	}
	378
ab11af04 CC	379	static inline int extcon_set_property_sync(struct extcon_dev *edev,
	380	unsigned int id, unsigned int prop,
	381	union extcon_property_value prop_val)
	382	{
	383	return 0;
	384	}
	385
7f2a0a16 CC	386	static inline int extcon_get_property_capability(struct extcon_dev *edev,
	387	unsigned int id, unsigned int prop)
	388	{
	389	return 0;
	390	}
	391
	392	static inline int extcon_set_property_capability(struct extcon_dev *edev,
	393	unsigned int id, unsigned int prop)
	394	{
	395	return 0;
	396	}
	397
74c5d09b DK	398	static inline struct extcon_dev extcon_get_extcon_dev(const char extcon_name)
	399	{
	400	return NULL;
	401	}
	402
	403	static inline int extcon_register_notifier(struct extcon_dev *edev,
73b6ecdb	404	unsigned int id,
046050f6	405	struct notifier_block *nb)
74c5d09b DK	406	{
	407	return 0;
	408	}
	409
	410	static inline int extcon_unregister_notifier(struct extcon_dev *edev,
73b6ecdb	411	unsigned int id,
046050f6	412	struct notifier_block *nb)
74c5d09b DK	413	{
	414	return 0;
	415	}
	416
58f38656 CC	417	static inline int devm_extcon_register_notifier(struct device *dev,
	418	struct extcon_dev *edev, unsigned int id,
	419	struct notifier_block *nb)
	420	{
	421	return -ENOSYS;
	422	}
	423
	424	static inline void devm_extcon_unregister_notifier(struct device *dev,
	425	struct extcon_dev *edev, unsigned int id,
	426	struct notifier_block *nb) { }
	427
830ae442 CC	428	static inline struct extcon_dev extcon_get_edev_by_phandle(struct device dev,
830ae442 CC	429	int index)
806d9dd7	430	{
830ae442	431	return ERR_PTR(-ENODEV);
806d9dd7	432	}
830ae442	433	#endif /* CONFIG_EXTCON */
806d9dd7	434
830ae442 CC	435	/*
	436	* Following structure and API are deprecated. EXTCON remains the function
	437	* definition to prevent the build break.
	438	*/
	439	struct extcon_specific_cable_nb {
	440	struct notifier_block *user_nb;
	441	int cable_index;
	442	struct extcon_dev *edev;
	443	unsigned long previous_value;
	444	};
	445
	446	static inline int extcon_register_interest(struct extcon_specific_cable_nb *obj,
	447	const char extcon_name, const char cable_name,
	448	struct notifier_block *nb)
806d9dd7	449	{
830ae442	450	return -EINVAL;
806d9dd7	451	}
1ad94ffe	452
830ae442 CC	453	static inline int extcon_unregister_interest(struct extcon_specific_cable_nb
830ae442 CC	454	*obj)
1ad94ffe	455	{
830ae442	456	return -EINVAL;
1ad94ffe	457	}
575c2b86 CC	458
	459	static inline int extcon_get_cable_state_(struct extcon_dev *edev, unsigned int id)
	460	{
	461	return extcon_get_state(edev, id);
	462	}
	463
	464	static inline int extcon_set_cable_state_(struct extcon_dev *edev, unsigned int id,
	465	bool cable_state)
	466	{
ab11af04	467	return extcon_set_state_sync(edev, id, cable_state);
575c2b86	468	}
de55d871	469	#endif /* __LINUX_EXTCON_H__ */