/* SPDX-License-Identifier: GPL-2.0-only */ /* * External Connector (extcon) framework * - linux/include/linux/extcon.h for extcon consumer device driver. * * Copyright (C) 2015 Samsung Electronics * Author: Chanwoo Choi <[email protected]> * * Copyright (C) 2012 Samsung Electronics * Author: Donggeun Kim <[email protected]> * Author: MyungJoo Ham <[email protected]> * * based on switch class driver * Copyright (C) 2008 Google, Inc. * Author: Mike Lockwood <[email protected]> */ #ifndef __LINUX_EXTCON_H__ #define __LINUX_EXTCON_H__ #include <linux/device.h> /* * Define the type of supported external connectors */ #define EXTCON_TYPE_USB … #define EXTCON_TYPE_CHG … #define EXTCON_TYPE_JACK … #define EXTCON_TYPE_DISP … #define EXTCON_TYPE_MISC … /* * Define the unique id of supported external connectors */ #define EXTCON_NONE … /* USB external connector */ #define EXTCON_USB … #define EXTCON_USB_HOST … /* * Charging external connector * * When one SDP charger connector was reported, we should also report * the USB connector, which means EXTCON_CHG_USB_SDP should always * appear together with EXTCON_USB. The same as ACA charger connector, * EXTCON_CHG_USB_ACA would normally appear with EXTCON_USB_HOST. * * The EXTCON_CHG_USB_SLOW connector can provide at least 500mA of * current at 5V. The EXTCON_CHG_USB_FAST connector can provide at * least 1A of current at 5V. */ #define EXTCON_CHG_USB_SDP … #define EXTCON_CHG_USB_DCP … #define EXTCON_CHG_USB_CDP … #define EXTCON_CHG_USB_ACA … #define EXTCON_CHG_USB_FAST … #define EXTCON_CHG_USB_SLOW … #define EXTCON_CHG_WPT … #define EXTCON_CHG_USB_PD … /* Jack external connector */ #define EXTCON_JACK_MICROPHONE … #define EXTCON_JACK_HEADPHONE … #define EXTCON_JACK_LINE_IN … #define EXTCON_JACK_LINE_OUT … #define EXTCON_JACK_VIDEO_IN … #define EXTCON_JACK_VIDEO_OUT … #define EXTCON_JACK_SPDIF_IN … #define EXTCON_JACK_SPDIF_OUT … /* Display external connector */ #define EXTCON_DISP_HDMI … #define EXTCON_DISP_MHL … #define EXTCON_DISP_DVI … #define EXTCON_DISP_VGA … #define EXTCON_DISP_DP … #define EXTCON_DISP_HMD … #define EXTCON_DISP_CVBS … #define EXTCON_DISP_EDP … /* Miscellaneous external connector */ #define EXTCON_DOCK … #define EXTCON_JIG … #define EXTCON_MECHANICAL … #define EXTCON_NUM … /* * Define the properties 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 … #define EXTCON_PROP_USB_TYPEC_POLARITY … #define EXTCON_PROP_USB_SS … #define EXTCON_PROP_USB_MIN … #define EXTCON_PROP_USB_MAX … #define EXTCON_PROP_USB_CNT … /* Properties of EXTCON_TYPE_CHG. */ #define EXTCON_PROP_CHG_MIN … #define EXTCON_PROP_CHG_MAX … #define EXTCON_PROP_CHG_CNT … /* Properties of EXTCON_TYPE_JACK. */ #define EXTCON_PROP_JACK_MIN … #define EXTCON_PROP_JACK_MAX … #define EXTCON_PROP_JACK_CNT … /* * 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 … /* Properties of EXTCON_TYPE_DISP. */ #define EXTCON_PROP_DISP_MIN … #define EXTCON_PROP_DISP_MAX … #define EXTCON_PROP_DISP_CNT … /* * 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. */ extcon_property_value; struct extcon_dev; #if IS_ENABLED(CONFIG_EXTCON) /* * Following APIs get the connected state of each external connector. * The 'id' argument indicates the defined external connector. */ int extcon_get_state(struct extcon_dev *edev, unsigned int id); /* * Following APIs get the property of each external connector. * The 'id' argument indicates the defined external connector * and the 'prop' indicates the extcon property. * * And extcon_get_property_capability() get the capability of the property * for each external connector. They are used to get the capability of the * property of each external connector based on the id and property. */ int extcon_get_property(struct extcon_dev *edev, unsigned int id, unsigned int prop, union extcon_property_value *prop_val); int extcon_get_property_capability(struct extcon_dev *edev, unsigned int id, unsigned int prop); /* * Following APIs register the notifier block in order to detect * the change of both state and property value for each external connector. * * extcon_register_notifier(*edev, id, *nb) : Register a notifier block * for specific external connector of the extcon. * extcon_register_notifier_all(*edev, *nb) : Register a notifier block * for all supported external connectors of the extcon. */ int extcon_register_notifier(struct extcon_dev *edev, unsigned int id, struct notifier_block *nb); int extcon_unregister_notifier(struct extcon_dev *edev, unsigned int id, struct notifier_block *nb); int devm_extcon_register_notifier(struct device *dev, struct extcon_dev *edev, unsigned int id, struct notifier_block *nb); void devm_extcon_unregister_notifier(struct device *dev, struct extcon_dev *edev, unsigned int id, struct notifier_block *nb); int extcon_register_notifier_all(struct extcon_dev *edev, struct notifier_block *nb); int extcon_unregister_notifier_all(struct extcon_dev *edev, struct notifier_block *nb); int devm_extcon_register_notifier_all(struct device *dev, struct extcon_dev *edev, struct notifier_block *nb); void devm_extcon_unregister_notifier_all(struct device *dev, struct extcon_dev *edev, struct notifier_block *nb); /* * Following APIs get the extcon_dev from devicetree or by through extcon name. */ struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name); struct extcon_dev *extcon_find_edev_by_node(struct device_node *node); struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev, int index); /* Following API get the name of extcon device. */ const char *extcon_get_edev_name(struct extcon_dev *edev); #else /* CONFIG_EXTCON */ static inline int extcon_get_state(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_get_property_capability(struct extcon_dev *edev, unsigned int id, unsigned int prop) { return 0; } 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 int extcon_register_notifier_all(struct extcon_dev *edev, struct notifier_block *nb) { return 0; } static inline int extcon_unregister_notifier_all(struct extcon_dev *edev, struct notifier_block *nb) { return 0; } static inline int devm_extcon_register_notifier_all(struct device *dev, struct extcon_dev *edev, struct notifier_block *nb) { return 0; } static inline void devm_extcon_unregister_notifier_all(struct device *dev, struct extcon_dev *edev, struct notifier_block *nb) { } static inline struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name) { return NULL; } static inline struct extcon_dev *extcon_find_edev_by_node(struct device_node *node) { return ERR_PTR(-ENODEV); } static inline struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev, int index) { return ERR_PTR(-ENODEV); } static inline const char *extcon_get_edev_name(struct extcon_dev *edev) { return NULL; } #endif /* CONFIG_EXTCON */ /* * Following structure and API are deprecated. EXTCON remains the function * definition to prevent the build break. */ struct extcon_specific_cable_nb { … }; #endif /* __LINUX_EXTCON_H__ */
Codebase Browser
linux