drivers/usb/core/usb.h

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