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