drivers/usb/core/usb.h

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