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