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 unique id of supported external connectors
  33  */
  34 #define EXTCON_NONE             0
  35
  36 /* USB external connector */
  37 #define EXTCON_USB              1
  38 #define EXTCON_USB_HOST         2
  39
  40 /* Charging external connector */
  41 #define EXTCON_CHG_USB_SDP      5       /* Standard Downstream Port */
  42 #define EXTCON_CHG_USB_DCP      6       /* Dedicated Charging Port */
  43 #define EXTCON_CHG_USB_CDP      7       /* Charging Downstream Port */
  44 #define EXTCON_CHG_USB_ACA      8       /* Accessory Charger Adapter */
  45 #define EXTCON_CHG_USB_FAST     9
  46 #define EXTCON_CHG_USB_SLOW     10
  47
  48 /* Jack external connector */
  49 #define EXTCON_JACK_MICROPHONE  20
  50 #define EXTCON_JACK_HEADPHONE   21
  51 #define EXTCON_JACK_LINE_IN     22
  52 #define EXTCON_JACK_LINE_OUT    23
  53 #define EXTCON_JACK_VIDEO_IN    24
  54 #define EXTCON_JACK_VIDEO_OUT   25
  55 #define EXTCON_JACK_SPDIF_IN    26      /* Sony Philips Digital InterFace */
  56 #define EXTCON_JACK_SPDIF_OUT   27
  57
  58 /* connector orientation 0 - CC1, 1 - CC2 */
  59 #define EXTCON_USB_CC           28
  60
  61 /* connector speed 0 - High Speed, 1 - super speed */
  62 #define EXTCON_USB_SPEED        29
  63
  64 /* connector type C current 0 - default current, 1 - medium or high current */
  65 #define EXTCON_USB_TYPEC_MED_HIGH_CURRENT       30
  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 struct extcon_cable;
  81
  82 /**
  83  * struct extcon_dev - An extcon device represents one external connector.
  84  * @name:               The name of this extcon device. Parent device name is
  85  *                      used if NULL.
  86  * @supported_cable:    Array of supported cable names ending with EXTCON_NONE.
  87  *                      If supported_cable is NULL, cable name related APIs
  88  *                      are disabled.
  89  * @mutually_exclusive: Array of mutually exclusive set of cables that cannot
  90  *                      be attached simultaneously. The array should be
  91  *                      ending with NULL or be NULL (no mutually exclusive
  92  *                      cables). For example, if it is { 0x7, 0x30, 0}, then,
  93  *                      {0, 1}, {0, 1, 2}, {0, 2}, {1, 2}, or {4, 5} cannot
  94  *                      be attached simulataneously. {0x7, 0} is equivalent to
  95  *                      {0x3, 0x6, 0x5, 0}. If it is {0xFFFFFFFF, 0}, there
  96  *                      can be no simultaneous connections.
  97  * @dev:                Device of this extcon.
  98  * @state:              Attach/detach state of this extcon. Do not provide at
  99  *                      register-time.
 100  * @nh:                 Notifier for the state change events from this extcon
 101  * @entry:              To support list of extcon devices so that users can
 102  *                      search for extcon devices based on the extcon name.
 103  * @lock:
 104  * @max_supported:      Internal value to store the number of cables.
 105  * @extcon_dev_type:    Device_type struct to provide attribute_groups
 106  *                      customized for each extcon device.
 107  * @cables:             Sysfs subdirectories. Each represents one cable.
 108  *
 109  * In most cases, users only need to provide "User initializing data" of
 110  * this struct when registering an extcon. In some exceptional cases,
 111  * optional callbacks may be needed. However, the values in "internal data"
 112  * are overwritten by register function.
 113  */
 114 struct extcon_dev {
 115         /* Optional user initializing data */
 116         const char *name;
 117         const unsigned int *supported_cable;
 118         const u32 *mutually_exclusive;
 119
 120         /* Internal data. Please do not set. */
 121         struct device dev;
 122         struct raw_notifier_head *nh;
 123         struct list_head entry;
 124         int max_supported;
 125         spinlock_t lock;        /* could be called by irq handler */
 126         u32 state;
 127
 128         /* /sys/class/extcon/.../cable.n/... */
 129         struct device_type extcon_dev_type;
 130         struct extcon_cable *cables;
 131
 132         /* /sys/class/extcon/.../mutually_exclusive/... */
 133         struct attribute_group attr_g_muex;
 134         struct attribute **attrs_muex;
 135         struct device_attribute *d_attrs_muex;
 136 };
 137
 138 /**
 139  * struct extcon_cable - An internal data for each cable of extcon device.
 140  * @edev:               The extcon device
 141  * @cable_index:        Index of this cable in the edev
 142  * @attr_g:             Attribute group for the cable
 143  * @attr_name:          "name" sysfs entry
 144  * @attr_state:         "state" sysfs entry
 145  * @attrs:              Array pointing to attr_name and attr_state for attr_g
 146  */
 147 struct extcon_cable {
 148         struct extcon_dev *edev;
 149         int cable_index;
 150
 151         struct attribute_group attr_g;
 152         struct device_attribute attr_name;
 153         struct device_attribute attr_state;
 154
 155         struct attribute *attrs[3]; /* to be fed to attr_g.attrs */
 156 };
 157
 158 /**
 159  * struct extcon_specific_cable_nb - An internal data for
 160  *                                   extcon_register_interest().
 161  * @user_nb:            user provided notifier block for events from
 162  *                      a specific cable.
 163  * @cable_index:        the target cable.
 164  * @edev:               the target extcon device.
 165  * @previous_value:     the saved previous event value.
 166  */
 167 struct extcon_specific_cable_nb {
 168         struct notifier_block *user_nb;
 169         int cable_index;
 170         struct extcon_dev *edev;
 171         unsigned long previous_value;
 172 };
 173
 174 #if IS_ENABLED(CONFIG_EXTCON)
 175
 176 /*
 177  * Following APIs are for notifiers or configurations.
 178  * Notifiers are the external port and connection devices.
 179  */
 180 extern int extcon_dev_register(struct extcon_dev *edev);
 181 extern void extcon_dev_unregister(struct extcon_dev *edev);
 182 extern int devm_extcon_dev_register(struct device *dev,
 183                                     struct extcon_dev *edev);
 184 extern void devm_extcon_dev_unregister(struct device *dev,
 185                                        struct extcon_dev *edev);
 186 extern struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name);
 187
 188 /*
 189  * Following APIs control the memory of extcon device.
 190  */
 191 extern struct extcon_dev *extcon_dev_allocate(const unsigned int *cable);
 192 extern void extcon_dev_free(struct extcon_dev *edev);
 193 extern struct extcon_dev *devm_extcon_dev_allocate(struct device *dev,
 194                                                    const unsigned int *cable);
 195 extern void devm_extcon_dev_free(struct device *dev, struct extcon_dev *edev);
 196
 197 /*
 198  * get/set/update_state access the 32b encoded state value, which represents
 199  * states of all possible cables of the multistate port. For example, if one
 200  * calls extcon_set_state(edev, 0x7), it may mean that all the three cables
 201  * are attached to the port.
 202  */
 203 static inline u32 extcon_get_state(struct extcon_dev *edev)
 204 {
 205         return edev->state;
 206 }
 207
 208 extern int extcon_set_state(struct extcon_dev *edev, u32 state);
 209 extern int extcon_update_state(struct extcon_dev *edev, u32 mask, u32 state);
 210
 211 /*
 212  * get/set_cable_state access each bit of the 32b encoded state value.
 213  * They are used to access the status of each cable based on the cable_name.
 214  */
 215 extern int extcon_get_cable_state_(struct extcon_dev *edev, unsigned int id);
 216 extern int extcon_set_cable_state_(struct extcon_dev *edev, unsigned int id,
 217                                    bool cable_state);
 218
 219 extern int extcon_get_cable_state(struct extcon_dev *edev,
 220                                   const char *cable_name);
 221 extern int extcon_set_cable_state(struct extcon_dev *edev,
 222                                   const char *cable_name, bool cable_state);
 223
 224 /*
 225  * Following APIs are for notifiees (those who want to be notified)
 226  * to register a callback for events from a specific cable of the extcon.
 227  * Notifiees are the connected device drivers wanting to get notified by
 228  * a specific external port of a connection device.
 229  */
 230 extern int extcon_register_interest(struct extcon_specific_cable_nb *obj,
 231                                     const char *extcon_name,
 232                                     const char *cable_name,
 233                                     struct notifier_block *nb);
 234 extern int extcon_unregister_interest(struct extcon_specific_cable_nb *nb);
 235
 236 /*
 237  * Following APIs are to monitor every action of a notifier.
 238  * Registrar gets notified for every external port of a connection device.
 239  * Probably this could be used to debug an action of notifier; however,
 240  * we do not recommend to use this for normal 'notifiee' device drivers who
 241  * want to be notified by a specific external port of the notifier.
 242  */
 243 extern int extcon_register_notifier(struct extcon_dev *edev, unsigned int id,
 244                                     struct notifier_block *nb);
 245 extern int extcon_unregister_notifier(struct extcon_dev *edev, unsigned int id,
 246                                     struct notifier_block *nb);
 247
 248 /*
 249  * Following API get the extcon device from devicetree.
 250  * This function use phandle of devicetree to get extcon device directly.
 251  */
 252 extern struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev,
 253                                                      int index);
 254
 255 /* Following API to get information of extcon device */
 256 extern const char *extcon_get_edev_name(struct extcon_dev *edev);
 257
 258 #else /* CONFIG_EXTCON */
 259 static inline int extcon_dev_register(struct extcon_dev *edev)
 260 {
 261         return 0;
 262 }
 263
 264 static inline void extcon_dev_unregister(struct extcon_dev *edev) { }
 265
 266 static inline int devm_extcon_dev_register(struct device *dev,
 267                                            struct extcon_dev *edev)
 268 {
 269         return -EINVAL;
 270 }
 271
 272 static inline void devm_extcon_dev_unregister(struct device *dev,
 273                                               struct extcon_dev *edev) { }
 274
 275 static inline struct extcon_dev *extcon_dev_allocate(const unsigned int *cable)
 276 {
 277         return ERR_PTR(-ENOSYS);
 278 }
 279
 280 static inline void extcon_dev_free(struct extcon_dev *edev) { }
 281
 282 static inline struct extcon_dev *devm_extcon_dev_allocate(struct device *dev,
 283                                                 const unsigned int *cable)
 284 {
 285         return ERR_PTR(-ENOSYS);
 286 }
 287
 288 static inline void devm_extcon_dev_free(struct extcon_dev *edev) { }
 289
 290 static inline u32 extcon_get_state(struct extcon_dev *edev)
 291 {
 292         return 0;
 293 }
 294
 295 static inline int extcon_set_state(struct extcon_dev *edev, u32 state)
 296 {
 297         return 0;
 298 }
 299
 300 static inline int extcon_update_state(struct extcon_dev *edev, u32 mask,
 301                                        u32 state)
 302 {
 303         return 0;
 304 }
 305
 306 static inline int extcon_get_cable_state_(struct extcon_dev *edev,
 307                                           unsigned int id)
 308 {
 309         return 0;
 310 }
 311
 312 static inline int extcon_set_cable_state_(struct extcon_dev *edev,
 313                                           unsigned int id, bool cable_state)
 314 {
 315         return 0;
 316 }
 317
 318 static inline int extcon_get_cable_state(struct extcon_dev *edev,
 319                         const char *cable_name)
 320 {
 321         return 0;
 322 }
 323
 324 static inline int extcon_set_cable_state(struct extcon_dev *edev,
 325                         const char *cable_name, int state)
 326 {
 327         return 0;
 328 }
 329
 330 static inline struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name)
 331 {
 332         return NULL;
 333 }
 334
 335 static inline int extcon_register_notifier(struct extcon_dev *edev,
 336                                         unsigned int id,
 337                                         struct notifier_block *nb)
 338 {
 339         return 0;
 340 }
 341
 342 static inline int extcon_unregister_notifier(struct extcon_dev *edev,
 343                                         unsigned int id,
 344                                         struct notifier_block *nb)
 345 {
 346         return 0;
 347 }
 348
 349 static inline int extcon_register_interest(struct extcon_specific_cable_nb *obj,
 350                                            const char *extcon_name,
 351                                            const char *cable_name,
 352                                            struct notifier_block *nb)
 353 {
 354         return 0;
 355 }
 356
 357 static inline int extcon_unregister_interest(struct extcon_specific_cable_nb
 358                                                     *obj)
 359 {
 360         return 0;
 361 }
 362
 363 static inline struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev,
 364                                                             int index)
 365 {
 366         return ERR_PTR(-ENODEV);
 367 }
 368 #endif /* CONFIG_EXTCON */
 369 #endif /* __LINUX_EXTCON_H__ */