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