1 /* 2 * External connector (extcon) class driver 3 * 4 * Copyright (C) 2015 Samsung Electronics 5 * Author: Chanwoo Choi <[email protected]> 6 * 7 * Copyright (C) 2012 Samsung Electronics 8 * Author: Donggeun Kim <[email protected]> 9 * Author: MyungJoo Ham <[email protected]> 10 * 11 * based on switch class driver 12 * Copyright (C) 2008 Google, Inc. 13 * Author: Mike Lockwood <[email protected]> 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 29 #include <linux/device.h> 30 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 40 /* 41 * Define the unique id of supported external connectors 42 */ 43 #define EXTCON_NONE 0 44 45 /* USB external connector */ 46 #define EXTCON_USB 1 47 #define EXTCON_USB_HOST 2 48 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 56 #define EXTCON_CHG_WPT 11 /* Wireless Power Transfer */ 57 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 67 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 */ 73 #define EXTCON_DISP_DP 44 /* Display Port */ 74 #define EXTCON_DISP_HMD 45 /* Head-Mounted Display */ 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 82 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) 108 * - EXTCON_PROP_USB_TYPEC_POLARITY 109 * @type: integer (intval) 110 * @value: 0 (normal) or 1 (flip) 111 * @default: 0 (normal) 112 * - EXTCON_PROP_USB_SS (SuperSpeed) 113 * @type: integer (intval) 114 * @value: 0 (USB/USB2) or 1 (USB3) 115 * @default: 0 (USB/USB2) 116 * 117 */ 118 #define EXTCON_PROP_USB_VBUS 0 119 #define EXTCON_PROP_USB_TYPEC_POLARITY 1 120 #define EXTCON_PROP_USB_SS 2 121 122 #define EXTCON_PROP_USB_MIN 0 123 #define EXTCON_PROP_USB_MAX 2 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 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 147 /* Properties of EXTCON_TYPE_DISP. */ 148 #define EXTCON_PROP_DISP_MIN 150 149 #define EXTCON_PROP_DISP_MAX 151 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 162 struct extcon_cable; 163 164 /** 165 * struct extcon_dev - An extcon device represents one external connector. 166 * @name: The name of this extcon device. Parent device name is 167 * used if NULL. 168 * @supported_cable: Array of supported cable names ending with EXTCON_NONE. 169 * If supported_cable is NULL, cable name related APIs 170 * are disabled. 171 * @mutually_exclusive: Array of mutually exclusive set of cables that cannot 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. 179 * @dev: Device of this extcon. 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 183 * @entry: To support list of extcon devices so that users can 184 * search for extcon devices based on the extcon name. 185 * @lock: 186 * @max_supported: Internal value to store the number of cables. 187 * @extcon_dev_type: Device_type struct to provide attribute_groups 188 * customized for each extcon device. 189 * @cables: Sysfs subdirectories. Each represents one cable. 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 { 197 /* Optional user initializing data */ 198 const char *name; 199 const unsigned int *supported_cable; 200 const u32 *mutually_exclusive; 201 202 /* Internal data. Please do not set. */ 203 struct device dev; 204 struct raw_notifier_head *nh; 205 struct list_head entry; 206 int max_supported; 207 spinlock_t lock; /* could be called by irq handler */ 208 u32 state; 209 210 /* /sys/class/extcon/.../cable.n/... */ 211 struct device_type extcon_dev_type; 212 struct extcon_cable *cables; 213 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; 218 }; 219 220 #if IS_ENABLED(CONFIG_EXTCON) 221 222 /* 223 * Following APIs are for notifiers or configurations. 224 * Notifiers are the external port and connection devices. 225 */ 226 extern int extcon_dev_register(struct extcon_dev *edev); 227 extern void extcon_dev_unregister(struct extcon_dev *edev); 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); 232 extern struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name); 233 234 /* 235 * Following APIs control the memory of extcon device. 236 */ 237 extern struct extcon_dev *extcon_dev_allocate(const unsigned int *cable); 238 extern void extcon_dev_free(struct extcon_dev *edev); 239 extern struct extcon_dev *devm_extcon_dev_allocate(struct device *dev, 240 const unsigned int *cable); 241 extern void devm_extcon_dev_free(struct device *dev, struct extcon_dev *edev); 242 243 /* 244 * get/set_state access each bit of the 32b encoded state value. 245 * They are used to access the status of each cable based on the cable id. 246 */ 247 extern int extcon_get_state(struct extcon_dev *edev, unsigned int id); 248 extern int extcon_set_state(struct extcon_dev *edev, unsigned int id, 249 bool cable_state); 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); 257 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); 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); 271 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 282 /* 283 * Following APIs are to monitor every action of a notifier. 284 * Registrar gets notified for every external port of a connection device. 285 * Probably this could be used to debug an action of notifier; however, 286 * we do not recommend to use this for normal 'notifiee' device drivers who 287 * want to be notified by a specific external port of the notifier. 288 */ 289 extern int extcon_register_notifier(struct extcon_dev *edev, unsigned int id, 290 struct notifier_block *nb); 291 extern int extcon_unregister_notifier(struct extcon_dev *edev, unsigned int id, 292 struct notifier_block *nb); 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); 299 300 /* 301 * Following API get the extcon device from devicetree. 302 * This function use phandle of devicetree to get extcon device directly. 303 */ 304 extern struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev, 305 int index); 306 307 /* Following API to get information of extcon device */ 308 extern const char *extcon_get_edev_name(struct extcon_dev *edev); 309 310 311 #else /* CONFIG_EXTCON */ 312 static inline int extcon_dev_register(struct extcon_dev *edev) 313 { 314 return 0; 315 } 316 317 static inline void extcon_dev_unregister(struct extcon_dev *edev) { } 318 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 328 static inline struct extcon_dev *extcon_dev_allocate(const unsigned int *cable) 329 { 330 return ERR_PTR(-ENOSYS); 331 } 332 333 static inline void extcon_dev_free(struct extcon_dev *edev) { } 334 335 static inline struct extcon_dev *devm_extcon_dev_allocate(struct device *dev, 336 const unsigned int *cable) 337 { 338 return ERR_PTR(-ENOSYS); 339 } 340 341 static inline void devm_extcon_dev_free(struct extcon_dev *edev) { } 342 343 344 static inline int extcon_get_state(struct extcon_dev *edev, unsigned int id) 345 { 346 return 0; 347 } 348 349 static inline int extcon_set_state(struct extcon_dev *edev, unsigned int id, 350 bool cable_state) 351 { 352 return 0; 353 } 354 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 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 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 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 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, 404 unsigned int id, 405 struct notifier_block *nb) 406 { 407 return 0; 408 } 409 410 static inline int extcon_unregister_notifier(struct extcon_dev *edev, 411 unsigned int id, 412 struct notifier_block *nb) 413 { 414 return 0; 415 } 416 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 428 static inline struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev, 429 int index) 430 { 431 return ERR_PTR(-ENODEV); 432 } 433 #endif /* CONFIG_EXTCON */ 434 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) 449 { 450 return -EINVAL; 451 } 452 453 static inline int extcon_unregister_interest(struct extcon_specific_cable_nb 454 *obj) 455 { 456 return -EINVAL; 457 } 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 { 467 return extcon_set_state_sync(edev, id, cable_state); 468 } 469 #endif /* __LINUX_EXTCON_H__ */ 470