drivers/usb/core/usb.h

   1 /*
   2  * Released under the GPLv2 only.
   3  * SPDX-License-Identifier: GPL-2.0
   4  */
   5
   6 #include <linux/pm.h>
   7 #include <linux/acpi.h>
   8
   9 struct usb_hub_descriptor;
  10 struct usb_dev_state;
  11
  12 /* Functions local to drivers/usb/core/ */
  13
  14 extern int usb_create_sysfs_dev_files(struct usb_device *dev);
  15 extern void usb_remove_sysfs_dev_files(struct usb_device *dev);
  16 extern void usb_create_sysfs_intf_files(struct usb_interface *intf);
  17 extern void usb_remove_sysfs_intf_files(struct usb_interface *intf);
  18 extern int usb_create_ep_devs(struct device *parent,
  19                                 struct usb_host_endpoint *endpoint,
  20                                 struct usb_device *udev);
  21 extern void usb_remove_ep_devs(struct usb_host_endpoint *endpoint);
  22
  23 extern void usb_enable_endpoint(struct usb_device *dev,
  24                 struct usb_host_endpoint *ep, bool reset_toggle);
  25 extern void usb_enable_interface(struct usb_device *dev,
  26                 struct usb_interface *intf, bool reset_toggles);
  27 extern void usb_disable_endpoint(struct usb_device *dev, unsigned int epaddr,
  28                 bool reset_hardware);
  29 extern void usb_disable_interface(struct usb_device *dev,
  30                 struct usb_interface *intf, bool reset_hardware);
  31 extern void usb_release_interface_cache(struct kref *ref);
  32 extern void usb_disable_device(struct usb_device *dev, int skip_ep0);
  33 extern int usb_deauthorize_device(struct usb_device *);
  34 extern int usb_authorize_device(struct usb_device *);
  35 extern void usb_deauthorize_interface(struct usb_interface *);
  36 extern void usb_authorize_interface(struct usb_interface *);
  37 extern void usb_detect_quirks(struct usb_device *udev);
  38 extern void usb_detect_interface_quirks(struct usb_device *udev);
  39 extern bool usb_endpoint_is_blacklisted(struct usb_device *udev,
  40                 struct usb_host_interface *intf,
  41                 struct usb_endpoint_descriptor *epd);
  42 extern int usb_remove_device(struct usb_device *udev);
  43
  44 extern int usb_get_device_descriptor(struct usb_device *dev,
  45                 unsigned int size);
  46 extern int usb_get_bos_descriptor(struct usb_device *dev);
  47 extern void usb_release_bos_descriptor(struct usb_device *dev);
  48 extern char *usb_cache_string(struct usb_device *udev, int index);
  49 extern int usb_set_configuration(struct usb_device *dev, int configuration);
  50 extern int usb_choose_configuration(struct usb_device *udev);
  51
  52 static inline unsigned usb_get_max_power(struct usb_device *udev,
  53                 struct usb_host_config *c)
  54 {
  55         /* SuperSpeed power is in 8 mA units; others are in 2 mA units */
  56         unsigned mul = (udev->speed >= USB_SPEED_SUPER ? 8 : 2);
  57
  58         return c->desc.bMaxPower * mul;
  59 }
  60
  61 extern void usb_kick_hub_wq(struct usb_device *dev);
  62 extern int usb_match_one_id_intf(struct usb_device *dev,
  63                                  struct usb_host_interface *intf,
  64                                  const struct usb_device_id *id);
  65 extern int usb_match_device(struct usb_device *dev,
  66                             const struct usb_device_id *id);
  67 extern void usb_forced_unbind_intf(struct usb_interface *intf);
  68 extern void usb_unbind_and_rebind_marked_interfaces(struct usb_device *udev);
  69
  70 extern void usb_hub_release_all_ports(struct usb_device *hdev,
  71                 struct usb_dev_state *owner);
  72 extern bool usb_device_is_owned(struct usb_device *udev);
  73
  74 extern int  usb_hub_init(void);
  75 extern void usb_hub_cleanup(void);
  76 extern int usb_major_init(void);
  77 extern void usb_major_cleanup(void);
  78 extern int usb_device_supports_lpm(struct usb_device *udev);
  79
  80 #ifdef  CONFIG_PM
  81
  82 extern int usb_suspend(struct device *dev, pm_message_t msg);
  83 extern int usb_resume(struct device *dev, pm_message_t msg);
  84 extern int usb_resume_complete(struct device *dev);
  85
  86 extern int usb_port_suspend(struct usb_device *dev, pm_message_t msg);
  87 extern int usb_port_resume(struct usb_device *dev, pm_message_t msg);
  88
  89 extern void usb_autosuspend_device(struct usb_device *udev);
  90 extern int usb_autoresume_device(struct usb_device *udev);
  91 extern int usb_remote_wakeup(struct usb_device *dev);
  92 extern int usb_runtime_suspend(struct device *dev);
  93 extern int usb_runtime_resume(struct device *dev);
  94 extern int usb_runtime_idle(struct device *dev);
  95 extern int usb_enable_usb2_hardware_lpm(struct usb_device *udev);
  96 extern int usb_disable_usb2_hardware_lpm(struct usb_device *udev);
  97
  98 #else
  99
 100 static inline int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
 101 {
 102         return 0;
 103 }
 104
 105 static inline int usb_port_resume(struct usb_device *udev, pm_message_t msg)
 106 {
 107         return 0;
 108 }
 109
 110 #define usb_autosuspend_device(udev)            do {} while (0)
 111 static inline int usb_autoresume_device(struct usb_device *udev)
 112 {
 113         return 0;
 114 }
 115
 116 static inline int usb_enable_usb2_hardware_lpm(struct usb_device *udev)
 117 {
 118         return 0;
 119 }
 120
 121 static inline int usb_disable_usb2_hardware_lpm(struct usb_device *udev)
 122 {
 123         return 0;
 124 }
 125
 126 #endif
 127
 128 extern struct bus_type usb_bus_type;
 129 extern struct mutex usb_port_peer_mutex;
 130 extern struct device_type usb_device_type;
 131 extern struct device_type usb_if_device_type;
 132 extern struct device_type usb_ep_device_type;
 133 extern struct device_type usb_port_device_type;
 134 extern struct usb_device_driver usb_generic_driver;
 135
 136 static inline int is_usb_device(const struct device *dev)
 137 {
 138         return dev->type == &usb_device_type;
 139 }
 140
 141 static inline int is_usb_interface(const struct device *dev)
 142 {
 143         return dev->type == &usb_if_device_type;
 144 }
 145
 146 static inline int is_usb_endpoint(const struct device *dev)
 147 {
 148         return dev->type == &usb_ep_device_type;
 149 }
 150
 151 static inline int is_usb_port(const struct device *dev)
 152 {
 153         return dev->type == &usb_port_device_type;
 154 }
 155
 156 /* Do the same for device drivers and interface drivers. */
 157
 158 static inline int is_usb_device_driver(struct device_driver *drv)
 159 {
 160         return container_of(drv, struct usbdrv_wrap, driver)->
 161                         for_devices;
 162 }
 163
 164 /* for labeling diagnostics */
 165 extern const char *usbcore_name;
 166
 167 /* sysfs stuff */
 168 extern const struct attribute_group *usb_device_groups[];
 169 extern const struct attribute_group *usb_interface_groups[];
 170
 171 /* usbfs stuff */
 172 extern struct mutex usbfs_mutex;
 173 extern struct usb_driver usbfs_driver;
 174 extern const struct file_operations usbfs_devices_fops;
 175 extern const struct file_operations usbdev_file_operations;
 176 extern void usbfs_conn_disc_event(void);
 177
 178 extern int usb_devio_init(void);
 179 extern void usb_devio_cleanup(void);
 180
 181 /*
 182  * Firmware specific cookie identifying a port's location. '0' == no location
 183  * data available
 184  */
 185 typedef u32 usb_port_location_t;
 186
 187 /* internal notify stuff */
 188 extern void usb_notify_add_device(struct usb_device *udev);
 189 extern void usb_notify_remove_device(struct usb_device *udev);
 190 extern void usb_notify_add_bus(struct usb_bus *ubus);
 191 extern void usb_notify_remove_bus(struct usb_bus *ubus);
 192 extern void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
 193                 struct usb_hub_descriptor *desc);
 194
 195 #ifdef CONFIG_ACPI
 196 extern int usb_acpi_register(void);
 197 extern void usb_acpi_unregister(void);
 198 extern acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
 199         int port1);
 200 #else
 201 static inline int usb_acpi_register(void) { return 0; };
 202 static inline void usb_acpi_unregister(void) { };
 203 #endif