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 int usb_remove_device(struct usb_device *udev);
  40
  41 extern int usb_get_device_descriptor(struct usb_device *dev,
  42                 unsigned int size);
  43 extern int usb_get_bos_descriptor(struct usb_device *dev);
  44 extern void usb_release_bos_descriptor(struct usb_device *dev);
  45 extern char *usb_cache_string(struct usb_device *udev, int index);
  46 extern int usb_set_configuration(struct usb_device *dev, int configuration);
  47 extern int usb_choose_configuration(struct usb_device *udev);
  48
  49 static inline unsigned usb_get_max_power(struct usb_device *udev,
  50                 struct usb_host_config *c)
  51 {
  52         /* SuperSpeed power is in 8 mA units; others are in 2 mA units */
  53         unsigned mul = (udev->speed >= USB_SPEED_SUPER ? 8 : 2);
  54
  55         return c->desc.bMaxPower * mul;
  56 }
  57
  58 extern void usb_kick_hub_wq(struct usb_device *dev);
  59 extern int usb_match_one_id_intf(struct usb_device *dev,
  60                                  struct usb_host_interface *intf,
  61                                  const struct usb_device_id *id);
  62 extern int usb_match_device(struct usb_device *dev,
  63                             const struct usb_device_id *id);
  64 extern void usb_forced_unbind_intf(struct usb_interface *intf);
  65 extern void usb_unbind_and_rebind_marked_interfaces(struct usb_device *udev);
  66
  67 extern void usb_hub_release_all_ports(struct usb_device *hdev,
  68                 struct usb_dev_state *owner);
  69 extern bool usb_device_is_owned(struct usb_device *udev);
  70
  71 extern int  usb_hub_init(void);
  72 extern void usb_hub_cleanup(void);
  73 extern int usb_major_init(void);
  74 extern void usb_major_cleanup(void);
  75 extern int usb_device_supports_lpm(struct usb_device *udev);
  76
  77 #ifdef  CONFIG_PM
  78
  79 extern int usb_suspend(struct device *dev, pm_message_t msg);
  80 extern int usb_resume(struct device *dev, pm_message_t msg);
  81 extern int usb_resume_complete(struct device *dev);
  82
  83 extern int usb_port_suspend(struct usb_device *dev, pm_message_t msg);
  84 extern int usb_port_resume(struct usb_device *dev, pm_message_t msg);
  85
  86 extern void usb_autosuspend_device(struct usb_device *udev);
  87 extern int usb_autoresume_device(struct usb_device *udev);
  88 extern int usb_remote_wakeup(struct usb_device *dev);
  89 extern int usb_runtime_suspend(struct device *dev);
  90 extern int usb_runtime_resume(struct device *dev);
  91 extern int usb_runtime_idle(struct device *dev);
  92 extern int usb_set_usb2_hardware_lpm(struct usb_device *udev, int enable);
  93
  94 #else
  95
  96 static inline int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
  97 {
  98         return 0;
  99 }
 100
 101 static inline int usb_port_resume(struct usb_device *udev, pm_message_t msg)
 102 {
 103         return 0;
 104 }
 105
 106 #define usb_autosuspend_device(udev)            do {} while (0)
 107 static inline int usb_autoresume_device(struct usb_device *udev)
 108 {
 109         return 0;
 110 }
 111
 112 static inline int usb_set_usb2_hardware_lpm(struct usb_device *udev, int enable)
 113 {
 114         return 0;
 115 }
 116
 117 #endif
 118
 119 extern struct bus_type usb_bus_type;
 120 extern struct mutex usb_port_peer_mutex;
 121 extern struct device_type usb_device_type;
 122 extern struct device_type usb_if_device_type;
 123 extern struct device_type usb_ep_device_type;
 124 extern struct device_type usb_port_device_type;
 125 extern struct usb_device_driver usb_generic_driver;
 126
 127 static inline int is_usb_device(const struct device *dev)
 128 {
 129         return dev->type == &usb_device_type;
 130 }
 131
 132 static inline int is_usb_interface(const struct device *dev)
 133 {
 134         return dev->type == &usb_if_device_type;
 135 }
 136
 137 static inline int is_usb_endpoint(const struct device *dev)
 138 {
 139         return dev->type == &usb_ep_device_type;
 140 }
 141
 142 static inline int is_usb_port(const struct device *dev)
 143 {
 144         return dev->type == &usb_port_device_type;
 145 }
 146
 147 /* Do the same for device drivers and interface drivers. */
 148
 149 static inline int is_usb_device_driver(struct device_driver *drv)
 150 {
 151         return container_of(drv, struct usbdrv_wrap, driver)->
 152                         for_devices;
 153 }
 154
 155 /* for labeling diagnostics */
 156 extern const char *usbcore_name;
 157
 158 /* sysfs stuff */
 159 extern const struct attribute_group *usb_device_groups[];
 160 extern const struct attribute_group *usb_interface_groups[];
 161
 162 /* usbfs stuff */
 163 extern struct mutex usbfs_mutex;
 164 extern struct usb_driver usbfs_driver;
 165 extern const struct file_operations usbfs_devices_fops;
 166 extern const struct file_operations usbdev_file_operations;
 167 extern void usbfs_conn_disc_event(void);
 168
 169 extern int usb_devio_init(void);
 170 extern void usb_devio_cleanup(void);
 171
 172 /*
 173  * Firmware specific cookie identifying a port's location. '0' == no location
 174  * data available
 175  */
 176 typedef u32 usb_port_location_t;
 177
 178 /* internal notify stuff */
 179 extern void usb_notify_add_device(struct usb_device *udev);
 180 extern void usb_notify_remove_device(struct usb_device *udev);
 181 extern void usb_notify_add_bus(struct usb_bus *ubus);
 182 extern void usb_notify_remove_bus(struct usb_bus *ubus);
 183 extern void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
 184                 struct usb_hub_descriptor *desc);
 185
 186 #ifdef CONFIG_ACPI
 187 extern int usb_acpi_register(void);
 188 extern void usb_acpi_unregister(void);
 189 extern acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
 190         int port1);
 191 #else
 192 static inline int usb_acpi_register(void) { return 0; };
 193 static inline void usb_acpi_unregister(void) { };
 194 #endif