extcon: remove EXTCON_PROP_USB_ID property
[firefly-linux-kernel-4.4.55.git] / include / linux / extcon.h
index 7abf674c388c488ab0a0b97ea63a689d93af3d4e..ad7a1606a7f3bab3b0c3cb208e6a8b8e0ada437b 100644 (file)
 
 #include <linux/device.h>
 
+/*
+ * Define the type of supported external connectors
+ */
+#define EXTCON_TYPE_USB                BIT(0)  /* USB connector */
+#define EXTCON_TYPE_CHG                BIT(1)  /* Charger connector */
+#define EXTCON_TYPE_JACK       BIT(2)  /* Jack connector */
+#define EXTCON_TYPE_DISP       BIT(3)  /* Display connector */
+#define EXTCON_TYPE_MISC       BIT(4)  /* Miscellaneous connector */
+
 /*
  * Define the unique id of supported external connectors
  */
@@ -60,6 +69,7 @@
 #define EXTCON_DISP_MHL                41      /* Mobile High-Definition Link */
 #define EXTCON_DISP_DVI                42      /* Digital Visual Interface */
 #define EXTCON_DISP_VGA                43      /* Video Graphics Array */
+#define EXTCON_DISP_DP         44      /* Display Port */
 
 /* Miscellaneous external connector */
 #define EXTCON_DOCK            60
 
 #define EXTCON_NUM             63
 
+/*
+ * Define the property of supported external connectors.
+ *
+ * When adding the new extcon property, they *must* have
+ * the type/value/default information. Also, you *have to*
+ * modify the EXTCON_PROP_[type]_START/END definitions
+ * which mean the range of the supported properties
+ * for each extcon type.
+ *
+ * The naming style of property
+ * : EXTCON_PROP_[type]_[property name]
+ *
+ * EXTCON_PROP_USB_[property name]     : USB property
+ * EXTCON_PROP_CHG_[property name]     : Charger property
+ * EXTCON_PROP_JACK_[property name]    : Jack property
+ * EXTCON_PROP_DISP_[property name]    : Display property
+ */
+
+/*
+ * Properties of EXTCON_TYPE_USB.
+ *
+ * - EXTCON_PROP_USB_VBUS
+ * @type:      integer (intval)
+ * @value:     0 (low) or 1 (high)
+ * @default:   0 (low)
+ * - EXTCON_PROP_USB_TYPEC_POLARITY
+ * @type:      integer (intval)
+ * @value:     0 (normal) or 1 (flip)
+ * @default:   0 (normal)
+ */
+#define EXTCON_PROP_USB_VBUS           0
+#define EXTCON_PROP_USB_TYPEC_POLARITY 1
+
+#define EXTCON_PROP_USB_MIN            0
+#define EXTCON_PROP_USB_MAX            1
+#define EXTCON_PROP_USB_CNT    (EXTCON_PROP_USB_MAX - EXTCON_PROP_USB_MIN + 1)
+
+/* Properties of EXTCON_TYPE_CHG. */
+#define EXTCON_PROP_CHG_MIN            50
+#define EXTCON_PROP_CHG_MAX            50
+#define EXTCON_PROP_CHG_CNT    (EXTCON_PROP_CHG_MAX - EXTCON_PROP_CHG_MIN + 1)
+
+/* Properties of EXTCON_TYPE_JACK. */
+#define EXTCON_PROP_JACK_MIN           100
+#define EXTCON_PROP_JACK_MAX           100
+#define EXTCON_PROP_JACK_CNT (EXTCON_PROP_JACK_MAX - EXTCON_PROP_JACK_MIN + 1)
+
+/* Properties of EXTCON_TYPE_DISP. */
+#define EXTCON_PROP_DISP_MIN           150
+#define EXTCON_PROP_DISP_MAX           150
+#define EXTCON_PROP_DISP_CNT (EXTCON_PROP_DISP_MAX - EXTCON_PROP_DISP_MIN + 1)
+
+/*
+ * Define the type of property's value.
+ *
+ * Define the property's value as union type. Because each property
+ * would need the different data type to store it.
+ */
+union extcon_property_value {
+       int intval;     /* type : integer (intval) */
+};
+
 struct extcon_cable;
 
 /**
@@ -126,42 +198,6 @@ struct extcon_dev {
        struct device_attribute *d_attrs_muex;
 };
 
-/**
- * struct extcon_cable - An internal data for each cable of extcon device.
- * @edev:              The extcon device
- * @cable_index:       Index of this cable in the edev
- * @attr_g:            Attribute group for the cable
- * @attr_name:         "name" sysfs entry
- * @attr_state:                "state" sysfs entry
- * @attrs:             Array pointing to attr_name and attr_state for attr_g
- */
-struct extcon_cable {
-       struct extcon_dev *edev;
-       int cable_index;
-
-       struct attribute_group attr_g;
-       struct device_attribute attr_name;
-       struct device_attribute attr_state;
-
-       struct attribute *attrs[3]; /* to be fed to attr_g.attrs */
-};
-
-/**
- * struct extcon_specific_cable_nb - An internal data for
- *                                  extcon_register_interest().
- * @user_nb:           user provided notifier block for events from
- *                     a specific cable.
- * @cable_index:       the target cable.
- * @edev:              the target extcon device.
- * @previous_value:    the saved previous event value.
- */
-struct extcon_specific_cable_nb {
-       struct notifier_block *user_nb;
-       int cable_index;
-       struct extcon_dev *edev;
-       unsigned long previous_value;
-};
-
 #if IS_ENABLED(CONFIG_EXTCON)
 
 /*
@@ -186,43 +222,43 @@ extern struct extcon_dev *devm_extcon_dev_allocate(struct device *dev,
 extern void devm_extcon_dev_free(struct device *dev, struct extcon_dev *edev);
 
 /*
- * get/set/update_state access the 32b encoded state value, which represents
- * states of all possible cables of the multistate port. For example, if one
- * calls extcon_set_state(edev, 0x7), it may mean that all the three cables
- * are attached to the port.
+ * get/set_state access each bit of the 32b encoded state value.
+ * They are used to access the status of each cable based on the cable id.
  */
-static inline u32 extcon_get_state(struct extcon_dev *edev)
-{
-       return edev->state;
-}
-
-extern int extcon_set_state(struct extcon_dev *edev, u32 state);
-extern int extcon_update_state(struct extcon_dev *edev, u32 mask, u32 state);
+extern int extcon_get_state(struct extcon_dev *edev, unsigned int id);
+extern int extcon_set_state(struct extcon_dev *edev, unsigned int id,
+                                  bool cable_state);
+extern int extcon_set_state_sync(struct extcon_dev *edev, unsigned int id,
+                               bool cable_state);
 
 /*
- * get/set_cable_state access each bit of the 32b encoded state value.
- * They are used to access the status of each cable based on the cable_name.
+ * Synchronize the state and property data for a specific external connector.
  */
-extern int extcon_get_cable_state_(struct extcon_dev *edev, unsigned int id);
-extern int extcon_set_cable_state_(struct extcon_dev *edev, unsigned int id,
-                                  bool cable_state);
+extern int extcon_sync(struct extcon_dev *edev, unsigned int id);
 
-extern int extcon_get_cable_state(struct extcon_dev *edev,
-                                 const char *cable_name);
-extern int extcon_set_cable_state(struct extcon_dev *edev,
-                                 const char *cable_name, bool cable_state);
+/*
+ * get/set_property access the property value of each external connector.
+ * They are used to access the property of each cable based on the property id.
+ */
+extern int extcon_get_property(struct extcon_dev *edev, unsigned int id,
+                               unsigned int prop,
+                               union extcon_property_value *prop_val);
+extern int extcon_set_property(struct extcon_dev *edev, unsigned int id,
+                               unsigned int prop,
+                               union extcon_property_value prop_val);
+extern int extcon_set_property_sync(struct extcon_dev *edev, unsigned int id,
+                               unsigned int prop,
+                               union extcon_property_value prop_val);
 
 /*
- * Following APIs are for notifiees (those who want to be notified)
- * to register a callback for events from a specific cable of the extcon.
- * Notifiees are the connected device drivers wanting to get notified by
- * a specific external port of a connection device.
+ * get/set_property_capability set the capability of the property for each
+ * external connector. They are used to set the capability of the property
+ * of each external connector based on the id and property.
  */
-extern int extcon_register_interest(struct extcon_specific_cable_nb *obj,
-                                   const char *extcon_name,
-                                   const char *cable_name,
-                                   struct notifier_block *nb);
-extern int extcon_unregister_interest(struct extcon_specific_cable_nb *nb);
+extern int extcon_get_property_capability(struct extcon_dev *edev,
+                               unsigned int id, unsigned int prop);
+extern int extcon_set_property_capability(struct extcon_dev *edev,
+                               unsigned int id, unsigned int prop);
 
 /*
  * Following APIs are to monitor every action of a notifier.
@@ -235,6 +271,12 @@ extern int extcon_register_notifier(struct extcon_dev *edev, unsigned int id,
                                    struct notifier_block *nb);
 extern int extcon_unregister_notifier(struct extcon_dev *edev, unsigned int id,
                                    struct notifier_block *nb);
+extern int devm_extcon_register_notifier(struct device *dev,
+                               struct extcon_dev *edev, unsigned int id,
+                               struct notifier_block *nb);
+extern void devm_extcon_unregister_notifier(struct device *dev,
+                               struct extcon_dev *edev, unsigned int id,
+                               struct notifier_block *nb);
 
 /*
  * Following API get the extcon device from devicetree.
@@ -246,6 +288,7 @@ extern struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev,
 /* Following API to get information of extcon device */
 extern const char *extcon_get_edev_name(struct extcon_dev *edev);
 
+
 #else /* CONFIG_EXTCON */
 static inline int extcon_dev_register(struct extcon_dev *edev)
 {
@@ -278,42 +321,57 @@ static inline struct extcon_dev *devm_extcon_dev_allocate(struct device *dev,
 
 static inline void devm_extcon_dev_free(struct extcon_dev *edev) { }
 
-static inline u32 extcon_get_state(struct extcon_dev *edev)
+
+static inline int extcon_get_state(struct extcon_dev *edev, unsigned int id)
 {
        return 0;
 }
 
-static inline int extcon_set_state(struct extcon_dev *edev, u32 state)
+static inline int extcon_set_state(struct extcon_dev *edev, unsigned int id,
+                               bool cable_state)
 {
        return 0;
 }
 
-static inline int extcon_update_state(struct extcon_dev *edev, u32 mask,
-                                      u32 state)
+static inline int extcon_set_state_sync(struct extcon_dev *edev, unsigned int id,
+                               bool cable_state)
 {
        return 0;
 }
 
-static inline int extcon_get_cable_state_(struct extcon_dev *edev,
-                                         unsigned int id)
+static inline int extcon_sync(struct extcon_dev *edev, unsigned int id)
 {
        return 0;
 }
 
-static inline int extcon_set_cable_state_(struct extcon_dev *edev,
-                                         unsigned int id, bool cable_state)
+static inline int extcon_get_property(struct extcon_dev *edev, unsigned int id,
+                                       unsigned int prop,
+                                       union extcon_property_value *prop_val)
+{
+       return 0;
+}
+static inline int extcon_set_property(struct extcon_dev *edev, unsigned int id,
+                                       unsigned int prop,
+                                       union extcon_property_value prop_val)
 {
        return 0;
 }
 
-static inline int extcon_get_cable_state(struct extcon_dev *edev,
-                       const char *cable_name)
+static inline int extcon_set_property_sync(struct extcon_dev *edev,
+                                       unsigned int id, unsigned int prop,
+                                       union extcon_property_value prop_val)
 {
        return 0;
 }
 
-static inline int extcon_set_cable_state(struct extcon_dev *edev,
-                       const char *cable_name, int state)
+static inline int extcon_get_property_capability(struct extcon_dev *edev,
+                                       unsigned int id, unsigned int prop)
+{
+       return 0;
+}
+
+static inline int extcon_set_property_capability(struct extcon_dev *edev,
+                                       unsigned int id, unsigned int prop)
 {
        return 0;
 }
@@ -337,24 +395,56 @@ static inline int extcon_unregister_notifier(struct extcon_dev *edev,
        return 0;
 }
 
+static inline int devm_extcon_register_notifier(struct device *dev,
+                               struct extcon_dev *edev, unsigned int id,
+                               struct notifier_block *nb)
+{
+       return -ENOSYS;
+}
+
+static inline  void devm_extcon_unregister_notifier(struct device *dev,
+                               struct extcon_dev *edev, unsigned int id,
+                               struct notifier_block *nb) { }
+
+static inline struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev,
+                                                           int index)
+{
+       return ERR_PTR(-ENODEV);
+}
+#endif /* CONFIG_EXTCON */
+
+/*
+ * Following structure and API are deprecated. EXTCON remains the function
+ * definition to prevent the build break.
+ */
+struct extcon_specific_cable_nb {
+       struct notifier_block *user_nb;
+       int cable_index;
+       struct extcon_dev *edev;
+       unsigned long previous_value;
+};
+
 static inline int extcon_register_interest(struct extcon_specific_cable_nb *obj,
-                                          const char *extcon_name,
-                                          const char *cable_name,
-                                          struct notifier_block *nb)
+                       const char *extcon_name, const char *cable_name,
+                       struct notifier_block *nb)
 {
-       return 0;
+       return -EINVAL;
 }
 
 static inline int extcon_unregister_interest(struct extcon_specific_cable_nb
                                                    *obj)
 {
-       return 0;
+       return -EINVAL;
 }
 
-static inline struct extcon_dev *extcon_get_edev_by_phandle(struct device *dev,
-                                                           int index)
+static inline int extcon_get_cable_state_(struct extcon_dev *edev, unsigned int id)
 {
-       return ERR_PTR(-ENODEV);
+       return extcon_get_state(edev, id);
+}
+
+static inline int extcon_set_cable_state_(struct extcon_dev *edev, unsigned int id,
+                                  bool cable_state)
+{
+       return extcon_set_state_sync(edev, id, cable_state);
 }
-#endif /* CONFIG_EXTCON */
 #endif /* __LINUX_EXTCON_H__ */