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 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 #if IS_ENABLED(CONFIG_EXTCON)
 139
 140 /*
 141  * Following APIs are for notifiers or configurations.
 142  * Notifiers are the external port and connection devices.
 143  */
 144 extern int extcon_dev_register(struct extcon_dev *edev);
 145 extern void extcon_dev_unregister(struct extcon_dev *edev);
 146 extern int devm_extcon_dev_register(struct device *dev,
 147                                     struct extcon_dev *edev);
 148 extern void devm_extcon_dev_unregister(struct device *dev,
 149                                        struct extcon_dev *edev);
 150 extern struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name);
 151
 152 /*
 153  * Following APIs control the memory of extcon device.
 154  */
 155 extern struct extcon_dev *extcon_dev_allocate(const unsigned int *cable);
 156 extern void extcon_dev_free(struct extcon_dev *edev);
 157 extern struct extcon_dev *devm_extcon_dev_allocate(struct device *dev,
 158                                                    const unsigned int *cable);
 159 extern void devm_extcon_dev_free(struct device *dev, struct extcon_dev *edev);
 160
 161 /*
 162  * get/set_cable_state access each bit of the 32b encoded state value.
 163  * They are used to access the status of each cable based on the cable id.
 164  */
 165 extern int extcon_get_cable_state_(struct extcon_dev *edev, unsigned int id);
 166 extern int extcon_set_cable_state_(struct extcon_dev *edev, unsigned int id,
 167                                    bool cable_state);
 168
 169 /*
 170  * Following APIs are to monitor every action of a notifier.
 171  * Registrar gets notified for every external port of a connection device.
 172  * Probably this could be used to debug an action of notifier; however,
 173  * we do not recommend to use this for normal 'notifiee' device drivers who
 174  * want to be notified by a specific external port of the notifier.
 175  */
 176 extern int extcon_register_notifier(struct extcon_dev *edev, unsigned int id,
 177                                     struct notifier_block *nb);
 178 extern int extcon_unregister_notifier(struct extcon_dev *edev, unsigned int id,
 179                                     struct notifier_block *nb);
 180 extern int devm_extcon_register_notifier(struct device *dev,
 181                                 struct extcon_dev *edev, unsigned int id,
 182                                 struct notifier_block *nb);
 183 extern void devm_extcon_unregister_notifier(struct device *dev,
 184                                 struct extcon_dev *edev, unsigned int id,
 185                                 struct notifier_block *nb);
 186
 187 /*
 188  * Following API get the extcon device from devicetree.
 189  * This function use phandle of devicetree to get extcon device directly.
 190  */
 191 extern struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev,
 192                                                      int index);
 193
 194 /* Following API to get information of extcon device */
 195 extern const char *extcon_get_edev_name(struct extcon_dev *edev);
 196
 197
 198 #else /* CONFIG_EXTCON */
 199 static inline int extcon_dev_register(struct extcon_dev *edev)
 200 {
 201         return 0;
 202 }
 203
 204 static inline void extcon_dev_unregister(struct extcon_dev *edev) { }
 205
 206 static inline int devm_extcon_dev_register(struct device *dev,
 207                                            struct extcon_dev *edev)
 208 {
 209         return -EINVAL;
 210 }
 211
 212 static inline void devm_extcon_dev_unregister(struct device *dev,
 213                                               struct extcon_dev *edev) { }
 214
 215 static inline struct extcon_dev *extcon_dev_allocate(const unsigned int *cable)
 216 {
 217         return ERR_PTR(-ENOSYS);
 218 }
 219
 220 static inline void extcon_dev_free(struct extcon_dev *edev) { }
 221
 222 static inline struct extcon_dev *devm_extcon_dev_allocate(struct device *dev,
 223                                                 const unsigned int *cable)
 224 {
 225         return ERR_PTR(-ENOSYS);
 226 }
 227
 228 static inline void devm_extcon_dev_free(struct extcon_dev *edev) { }
 229
 230 static inline int extcon_get_cable_state_(struct extcon_dev *edev,
 231                                           unsigned int id)
 232 {
 233         return 0;
 234 }
 235
 236 static inline int extcon_set_cable_state_(struct extcon_dev *edev,
 237                                           unsigned int id, bool cable_state)
 238 {
 239         return 0;
 240 }
 241
 242 static inline struct extcon_dev *extcon_get_extcon_dev(const char *extcon_name)
 243 {
 244         return NULL;
 245 }
 246
 247 static inline int extcon_register_notifier(struct extcon_dev *edev,
 248                                         unsigned int id,
 249                                         struct notifier_block *nb)
 250 {
 251         return 0;
 252 }
 253
 254 static inline int extcon_unregister_notifier(struct extcon_dev *edev,
 255                                         unsigned int id,
 256                                         struct notifier_block *nb)
 257 {
 258         return 0;
 259 }
 260
 261 static inline int devm_extcon_register_notifier(struct device *dev,
 262                                 struct extcon_dev *edev, unsigned int id,
 263                                 struct notifier_block *nb)
 264 {
 265         return -ENOSYS;
 266 }
 267
 268 static inline  void devm_extcon_unregister_notifier(struct device *dev,
 269                                 struct extcon_dev *edev, unsigned int id,
 270                                 struct notifier_block *nb) { }
 271
 272 static inline struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev,
 273                                                             int index)
 274 {
 275         return ERR_PTR(-ENODEV);
 276 }
 277 #endif /* CONFIG_EXTCON */
 278
 279 /*
 280  * Following structure and API are deprecated. EXTCON remains the function
 281  * definition to prevent the build break.
 282  */
 283 struct extcon_specific_cable_nb {
 284        struct notifier_block *user_nb;
 285        int cable_index;
 286        struct extcon_dev *edev;
 287        unsigned long previous_value;
 288 };
 289
 290 static inline int extcon_register_interest(struct extcon_specific_cable_nb *obj,
 291                         const char *extcon_name, const char *cable_name,
 292                         struct notifier_block *nb)
 293 {
 294         return -EINVAL;
 295 }
 296
 297 static inline int extcon_unregister_interest(struct extcon_specific_cable_nb
 298                                                     *obj)
 299 {
 300         return -EINVAL;
 301 }
 302 #endif /* __LINUX_EXTCON_H__ */