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