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