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