LXR linux/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
   9struct usb_hub_descriptor;
  10struct usb_dev_state;
  11
  12/* Functions local to drivers/usb/core/ */
  13
  14extern int usb_create_sysfs_dev_files(struct usb_device *dev);
  15extern void usb_remove_sysfs_dev_files(struct usb_device *dev);
  16extern void usb_create_sysfs_intf_files(struct usb_interface *intf);
  17extern void usb_remove_sysfs_intf_files(struct usb_interface *intf);
  18extern int usb_create_ep_devs(struct device *parent,
  19                                struct usb_host_endpoint *endpoint,
  20                                struct usb_device *udev);
  21extern void usb_remove_ep_devs(struct usb_host_endpoint *endpoint);
  22
  23extern void usb_enable_endpoint(struct usb_device *dev,
  24                struct usb_host_endpoint *ep, bool reset_toggle);
  25extern void usb_enable_interface(struct usb_device *dev,
  26                struct usb_interface *intf, bool reset_toggles);
  27extern void usb_disable_endpoint(struct usb_device *dev, unsigned int epaddr,
  28                bool reset_hardware);
  29extern void usb_disable_interface(struct usb_device *dev,
  30                struct usb_interface *intf, bool reset_hardware);
  31extern void usb_release_interface_cache(struct kref *ref);
  32extern void usb_disable_device(struct usb_device *dev, int skip_ep0);
  33extern int usb_deauthorize_device(struct usb_device *);
  34extern int usb_authorize_device(struct usb_device *);
  35extern void usb_deauthorize_interface(struct usb_interface *);
  36extern void usb_authorize_interface(struct usb_interface *);
  37extern void usb_detect_quirks(struct usb_device *udev);
  38extern void usb_detect_interface_quirks(struct usb_device *udev);
  39extern int usb_remove_device(struct usb_device *udev);
  40
  41extern int usb_get_device_descriptor(struct usb_device *dev,
  42                unsigned int size);
  43extern int usb_get_bos_descriptor(struct usb_device *dev);
  44extern void usb_release_bos_descriptor(struct usb_device *dev);
  45extern char *usb_cache_string(struct usb_device *udev, int index);
  46extern int usb_set_configuration(struct usb_device *dev, int configuration);
  47extern int usb_choose_configuration(struct usb_device *udev);
  48
  49static 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
  58extern void usb_kick_hub_wq(struct usb_device *dev);
  59extern int usb_match_one_id_intf(struct usb_device *dev,
  60                                 struct usb_host_interface *intf,
  61                                 const struct usb_device_id *id);
  62extern int usb_match_device(struct usb_device *dev,
  63                            const struct usb_device_id *id);
  64extern void usb_forced_unbind_intf(struct usb_interface *intf);
  65extern void usb_unbind_and_rebind_marked_interfaces(struct usb_device *udev);
  66
  67extern void usb_hub_release_all_ports(struct usb_device *hdev,
  68                struct usb_dev_state *owner);
  69extern bool usb_device_is_owned(struct usb_device *udev);
  70
  71extern int  usb_hub_init(void);
  72extern void usb_hub_cleanup(void);
  73extern int usb_major_init(void);
  74extern void usb_major_cleanup(void);
  75extern int usb_device_supports_lpm(struct usb_device *udev);
  76
  77#ifdef  CONFIG_PM
  78
  79extern int usb_suspend(struct device *dev, pm_message_t msg);
  80extern int usb_resume(struct device *dev, pm_message_t msg);
  81extern int usb_resume_complete(struct device *dev);
  82
  83extern int usb_port_suspend(struct usb_device *dev, pm_message_t msg);
  84extern int usb_port_resume(struct usb_device *dev, pm_message_t msg);
  85
  86extern void usb_autosuspend_device(struct usb_device *udev);
  87extern int usb_autoresume_device(struct usb_device *udev);
  88extern int usb_remote_wakeup(struct usb_device *dev);
  89extern int usb_runtime_suspend(struct device *dev);
  90extern int usb_runtime_resume(struct device *dev);
  91extern int usb_runtime_idle(struct device *dev);
  92extern int usb_set_usb2_hardware_lpm(struct usb_device *udev, int enable);
  93
  94#else
  95
  96static inline int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
  97{
  98        return 0;
  99}
 100
 101static 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)
 107static inline int usb_autoresume_device(struct usb_device *udev)
 108{
 109        return 0;
 110}
 111
 112static inline int usb_set_usb2_hardware_lpm(struct usb_device *udev, int enable)
 113{
 114        return 0;
 115}
 116
 117#endif
 118
 119extern struct bus_type usb_bus_type;
 120extern struct mutex usb_port_peer_mutex;
 121extern struct device_type usb_device_type;
 122extern struct device_type usb_if_device_type;
 123extern struct device_type usb_ep_device_type;
 124extern struct device_type usb_port_device_type;
 125extern struct usb_device_driver usb_generic_driver;
 126
 127static inline int is_usb_device(const struct device *dev)
 128{
 129        return dev->type == &usb_device_type;
 130}
 131
 132static inline int is_usb_interface(const struct device *dev)
 133{
 134        return dev->type == &usb_if_device_type;
 135}
 136
 137static inline int is_usb_endpoint(const struct device *dev)
 138{
 139        return dev->type == &usb_ep_device_type;
 140}
 141
 142static 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
 149static 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 */
 156extern const char *usbcore_name;
 157
 158/* sysfs stuff */
 159extern const struct attribute_group *usb_device_groups[];
 160extern const struct attribute_group *usb_interface_groups[];
 161
 162/* usbfs stuff */
 163extern struct mutex usbfs_mutex;
 164extern struct usb_driver usbfs_driver;
 165extern const struct file_operations usbfs_devices_fops;
 166extern const struct file_operations usbdev_file_operations;
 167extern void usbfs_conn_disc_event(void);
 168
 169extern int usb_devio_init(void);
 170extern void usb_devio_cleanup(void);
 171
 172/*
 173 * Firmware specific cookie identifying a port's location. '0' == no location
 174 * data available
 175 */
 176typedef u32 usb_port_location_t;
 177
 178/* internal notify stuff */
 179extern void usb_notify_add_device(struct usb_device *udev);
 180extern void usb_notify_remove_device(struct usb_device *udev);
 181extern void usb_notify_add_bus(struct usb_bus *ubus);
 182extern void usb_notify_remove_bus(struct usb_bus *ubus);
 183extern void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
 184                struct usb_hub_descriptor *desc);
 185
 186#ifdef CONFIG_ACPI
 187extern int usb_acpi_register(void);
 188extern void usb_acpi_unregister(void);
 189extern acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
 190        int port1);
 191#else
 192static inline int usb_acpi_register(void) { return 0; };
 193static inline void usb_acpi_unregister(void) { };
 194#endif
 195