include/linux/extcon.h

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