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