include/linux/usb/phy.h

   1 /* USB OTG (On The Go) defines */
   2 /*
   3  *
   4  * These APIs may be used between USB controllers.  USB device drivers
   5  * (for either host or peripheral roles) don't use these calls; they
   6  * continue to use just usb_device and usb_gadget.
   7  */
   8
   9 #ifndef __LINUX_USB_PHY_H
  10 #define __LINUX_USB_PHY_H
  11
  12 #include <linux/notifier.h>
  13 #include <linux/usb.h>
  14
  15 enum usb_phy_interface {
  16         USBPHY_INTERFACE_MODE_UNKNOWN,
  17         USBPHY_INTERFACE_MODE_UTMI,
  18         USBPHY_INTERFACE_MODE_UTMIW,
  19         USBPHY_INTERFACE_MODE_ULPI,
  20         USBPHY_INTERFACE_MODE_SERIAL,
  21         USBPHY_INTERFACE_MODE_HSIC,
  22 };
  23
  24 enum usb_phy_events {
  25         USB_EVENT_NONE,         /* no events or cable disconnected */
  26         USB_EVENT_VBUS,         /* vbus valid event */
  27         USB_EVENT_ID,           /* id was grounded */
  28         USB_EVENT_CHARGER,      /* usb dedicated charger */
  29         USB_EVENT_ENUMERATED,   /* gadget driver enumerated */
  30 };
  31
  32 /* associate a type with PHY */
  33 enum usb_phy_type {
  34         USB_PHY_TYPE_UNDEFINED,
  35         USB_PHY_TYPE_USB2,
  36         USB_PHY_TYPE_USB3,
  37 };
  38
  39 /* OTG defines lots of enumeration states before device reset */
  40 enum usb_otg_state {
  41         OTG_STATE_UNDEFINED = 0,
  42
  43         /* single-role peripheral, and dual-role default-b */
  44         OTG_STATE_B_IDLE,
  45         OTG_STATE_B_SRP_INIT,
  46         OTG_STATE_B_PERIPHERAL,
  47
  48         /* extra dual-role default-b states */
  49         OTG_STATE_B_WAIT_ACON,
  50         OTG_STATE_B_HOST,
  51
  52         /* dual-role default-a */
  53         OTG_STATE_A_IDLE,
  54         OTG_STATE_A_WAIT_VRISE,
  55         OTG_STATE_A_WAIT_BCON,
  56         OTG_STATE_A_HOST,
  57         OTG_STATE_A_SUSPEND,
  58         OTG_STATE_A_PERIPHERAL,
  59         OTG_STATE_A_WAIT_VFALL,
  60         OTG_STATE_A_VBUS_ERR,
  61 };
  62
  63 struct usb_phy;
  64 struct usb_otg;
  65
  66 /* for transceivers connected thru an ULPI interface, the user must
  67  * provide access ops
  68  */
  69 struct usb_phy_io_ops {
  70         int (*read)(struct usb_phy *x, u32 reg);
  71         int (*write)(struct usb_phy *x, u32 val, u32 reg);
  72 };
  73
  74 struct usb_phy {
  75         struct device           *dev;
  76         const char              *label;
  77         unsigned int             flags;
  78
  79         enum usb_phy_type       type;
  80         enum usb_otg_state      state;
  81         enum usb_phy_events     last_event;
  82
  83         struct usb_otg          *otg;
  84
  85         struct device           *io_dev;
  86         struct usb_phy_io_ops   *io_ops;
  87         void __iomem            *io_priv;
  88
  89         /* for notification of usb_phy_events */
  90         struct atomic_notifier_head     notifier;
  91
  92         /* to pass extra port status to the root hub */
  93         u16                     port_status;
  94         u16                     port_change;
  95
  96         /* to support controllers that have multiple transceivers */
  97         struct list_head        head;
  98
  99         /* initialize/shutdown the OTG controller */
 100         int     (*init)(struct usb_phy *x);
 101         void    (*shutdown)(struct usb_phy *x);
 102
 103         /* enable/disable VBUS */
 104         int     (*set_vbus)(struct usb_phy *x, int on);
 105
 106         /* effective for B devices, ignored for A-peripheral */
 107         int     (*set_power)(struct usb_phy *x,
 108                                 unsigned mA);
 109
 110         /* for non-OTG B devices: set transceiver into suspend mode */
 111         int     (*set_suspend)(struct usb_phy *x,
 112                                 int suspend);
 113
 114         /* notify phy connect status change */
 115         int     (*notify_connect)(struct usb_phy *x,
 116                         enum usb_device_speed speed);
 117         int     (*notify_disconnect)(struct usb_phy *x,
 118                         enum usb_device_speed speed);
 119 };
 120
 121 /**
 122  * struct usb_phy_bind - represent the binding for the phy
 123  * @dev_name: the device name of the device that will bind to the phy
 124  * @phy_dev_name: the device name of the phy
 125  * @index: used if a single controller uses multiple phys
 126  * @phy: reference to the phy
 127  * @list: to maintain a linked list of the binding information
 128  */
 129 struct usb_phy_bind {
 130         const char      *dev_name;
 131         const char      *phy_dev_name;
 132         u8              index;
 133         struct usb_phy  *phy;
 134         struct list_head list;
 135 };
 136
 137 /* for board-specific init logic */
 138 extern int usb_add_phy(struct usb_phy *, enum usb_phy_type type);
 139 extern int usb_add_phy_dev(struct usb_phy *);
 140 extern void usb_remove_phy(struct usb_phy *);
 141
 142 /* helpers for direct access thru low-level io interface */
 143 static inline int usb_phy_io_read(struct usb_phy *x, u32 reg)
 144 {
 145         if (x && x->io_ops && x->io_ops->read)
 146                 return x->io_ops->read(x, reg);
 147
 148         return -EINVAL;
 149 }
 150
 151 static inline int usb_phy_io_write(struct usb_phy *x, u32 val, u32 reg)
 152 {
 153         if (x && x->io_ops && x->io_ops->write)
 154                 return x->io_ops->write(x, val, reg);
 155
 156         return -EINVAL;
 157 }
 158
 159 static inline int
 160 usb_phy_init(struct usb_phy *x)
 161 {
 162         if (x && x->init)
 163                 return x->init(x);
 164
 165         return 0;
 166 }
 167
 168 static inline void
 169 usb_phy_shutdown(struct usb_phy *x)
 170 {
 171         if (x && x->shutdown)
 172                 x->shutdown(x);
 173 }
 174
 175 static inline int
 176 usb_phy_vbus_on(struct usb_phy *x)
 177 {
 178         if (!x || !x->set_vbus)
 179                 return 0;
 180
 181         return x->set_vbus(x, true);
 182 }
 183
 184 static inline int
 185 usb_phy_vbus_off(struct usb_phy *x)
 186 {
 187         if (!x || !x->set_vbus)
 188                 return 0;
 189
 190         return x->set_vbus(x, false);
 191 }
 192
 193 /* for usb host and peripheral controller drivers */
 194 #if IS_ENABLED(CONFIG_USB_PHY)
 195 extern struct usb_phy *usb_get_phy(enum usb_phy_type type);
 196 extern struct usb_phy *devm_usb_get_phy(struct device *dev,
 197         enum usb_phy_type type);
 198 extern struct usb_phy *usb_get_phy_dev(struct device *dev, u8 index);
 199 extern struct usb_phy *devm_usb_get_phy_dev(struct device *dev, u8 index);
 200 extern struct usb_phy *devm_usb_get_phy_by_phandle(struct device *dev,
 201         const char *phandle, u8 index);
 202 extern void usb_put_phy(struct usb_phy *);
 203 extern void devm_usb_put_phy(struct device *dev, struct usb_phy *x);
 204 extern int usb_bind_phy(const char *dev_name, u8 index,
 205                                 const char *phy_dev_name);
 206 #else
 207 static inline struct usb_phy *usb_get_phy(enum usb_phy_type type)
 208 {
 209         return ERR_PTR(-ENXIO);
 210 }
 211
 212 static inline struct usb_phy *devm_usb_get_phy(struct device *dev,
 213         enum usb_phy_type type)
 214 {
 215         return ERR_PTR(-ENXIO);
 216 }
 217
 218 static inline struct usb_phy *usb_get_phy_dev(struct device *dev, u8 index)
 219 {
 220         return ERR_PTR(-ENXIO);
 221 }
 222
 223 static inline struct usb_phy *devm_usb_get_phy_dev(struct device *dev, u8 index)
 224 {
 225         return ERR_PTR(-ENXIO);
 226 }
 227
 228 static inline struct usb_phy *devm_usb_get_phy_by_phandle(struct device *dev,
 229         const char *phandle, u8 index)
 230 {
 231         return ERR_PTR(-ENXIO);
 232 }
 233
 234 static inline void usb_put_phy(struct usb_phy *x)
 235 {
 236 }
 237
 238 static inline void devm_usb_put_phy(struct device *dev, struct usb_phy *x)
 239 {
 240 }
 241
 242 static inline int usb_bind_phy(const char *dev_name, u8 index,
 243                                 const char *phy_dev_name)
 244 {
 245         return -EOPNOTSUPP;
 246 }
 247 #endif
 248
 249 static inline int
 250 usb_phy_set_power(struct usb_phy *x, unsigned mA)
 251 {
 252         if (x && x->set_power)
 253                 return x->set_power(x, mA);
 254         return 0;
 255 }
 256
 257 /* Context: can sleep */
 258 static inline int
 259 usb_phy_set_suspend(struct usb_phy *x, int suspend)
 260 {
 261         if (x && x->set_suspend != NULL)
 262                 return x->set_suspend(x, suspend);
 263         else
 264                 return 0;
 265 }
 266
 267 static inline int
 268 usb_phy_notify_connect(struct usb_phy *x, enum usb_device_speed speed)
 269 {
 270         if (x && x->notify_connect)
 271                 return x->notify_connect(x, speed);
 272         else
 273                 return 0;
 274 }
 275
 276 static inline int
 277 usb_phy_notify_disconnect(struct usb_phy *x, enum usb_device_speed speed)
 278 {
 279         if (x && x->notify_disconnect)
 280                 return x->notify_disconnect(x, speed);
 281         else
 282                 return 0;
 283 }
 284
 285 /* notifiers */
 286 static inline int
 287 usb_register_notifier(struct usb_phy *x, struct notifier_block *nb)
 288 {
 289         return atomic_notifier_chain_register(&x->notifier, nb);
 290 }
 291
 292 static inline void
 293 usb_unregister_notifier(struct usb_phy *x, struct notifier_block *nb)
 294 {
 295         atomic_notifier_chain_unregister(&x->notifier, nb);
 296 }
 297
 298 static inline const char *usb_phy_type_string(enum usb_phy_type type)
 299 {
 300         switch (type) {
 301         case USB_PHY_TYPE_USB2:
 302                 return "USB2 PHY";
 303         case USB_PHY_TYPE_USB3:
 304                 return "USB3 PHY";
 305         default:
 306                 return "UNKNOWN PHY TYPE";
 307         }
 308 }
 309 #endif /* __LINUX_USB_PHY_H */