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