LXR linux/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
   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 void usb_release_quirk_list(void);
  40extern int usb_remove_device(struct usb_device *udev);
  41
  42extern int usb_get_device_descriptor(struct usb_device *dev,
  43                unsigned int size);
  44extern int usb_set_isoch_delay(struct usb_device *dev);
  45extern int usb_get_bos_descriptor(struct usb_device *dev);
  46extern void usb_release_bos_descriptor(struct usb_device *dev);
  47extern char *usb_cache_string(struct usb_device *udev, int index);
  48extern int usb_set_configuration(struct usb_device *dev, int configuration);
  49extern int usb_choose_configuration(struct usb_device *udev);
  50
  51static 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
  60extern void usb_kick_hub_wq(struct usb_device *dev);
  61extern int usb_match_one_id_intf(struct usb_device *dev,
  62                                 struct usb_host_interface *intf,
  63                                 const struct usb_device_id *id);
  64extern int usb_match_device(struct usb_device *dev,
  65                            const struct usb_device_id *id);
  66extern void usb_forced_unbind_intf(struct usb_interface *intf);
  67extern void usb_unbind_and_rebind_marked_interfaces(struct usb_device *udev);
  68
  69extern void usb_hub_release_all_ports(struct usb_device *hdev,
  70                struct usb_dev_state *owner);
  71extern bool usb_device_is_owned(struct usb_device *udev);
  72
  73extern int  usb_hub_init(void);
  74extern void usb_hub_cleanup(void);
  75extern int usb_major_init(void);
  76extern void usb_major_cleanup(void);
  77extern int usb_device_supports_lpm(struct usb_device *udev);
  78extern int usb_port_disable(struct usb_device *udev);
  79
  80#ifdef  CONFIG_PM
  81
  82extern int usb_suspend(struct device *dev, pm_message_t msg);
  83extern int usb_resume(struct device *dev, pm_message_t msg);
  84extern int usb_resume_complete(struct device *dev);
  85
  86extern int usb_port_suspend(struct usb_device *dev, pm_message_t msg);
  87extern int usb_port_resume(struct usb_device *dev, pm_message_t msg);
  88
  89extern void usb_autosuspend_device(struct usb_device *udev);
  90extern int usb_autoresume_device(struct usb_device *udev);
  91extern int usb_remote_wakeup(struct usb_device *dev);
  92extern int usb_runtime_suspend(struct device *dev);
  93extern int usb_runtime_resume(struct device *dev);
  94extern int usb_runtime_idle(struct device *dev);
  95extern int usb_enable_usb2_hardware_lpm(struct usb_device *udev);
  96extern int usb_disable_usb2_hardware_lpm(struct usb_device *udev);
  97
  98extern void usbfs_notify_suspend(struct usb_device *udev);
  99extern void usbfs_notify_resume(struct usb_device *udev);
 100
 101#else
 102
 103static inline int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
 104{
 105        return 0;
 106}
 107
 108static 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)
 114static inline int usb_autoresume_device(struct usb_device *udev)
 115{
 116        return 0;
 117}
 118
 119static inline int usb_enable_usb2_hardware_lpm(struct usb_device *udev)
 120{
 121        return 0;
 122}
 123
 124static inline int usb_disable_usb2_hardware_lpm(struct usb_device *udev)
 125{
 126        return 0;
 127}
 128
 129#endif
 130
 131extern struct bus_type usb_bus_type;
 132extern struct mutex usb_port_peer_mutex;
 133extern struct device_type usb_device_type;
 134extern struct device_type usb_if_device_type;
 135extern struct device_type usb_ep_device_type;
 136extern struct device_type usb_port_device_type;
 137extern struct usb_device_driver usb_generic_driver;
 138
 139static inline int is_usb_device(const struct device *dev)
 140{
 141        return dev->type == &usb_device_type;
 142}
 143
 144static inline int is_usb_interface(const struct device *dev)
 145{
 146        return dev->type == &usb_if_device_type;
 147}
 148
 149static inline int is_usb_endpoint(const struct device *dev)
 150{
 151        return dev->type == &usb_ep_device_type;
 152}
 153
 154static inline int is_usb_port(const struct device *dev)
 155{
 156        return dev->type == &usb_port_device_type;
 157}
 158
 159static 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
 166static 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 */
 173extern const char *usbcore_name;
 174
 175/* sysfs stuff */
 176extern const struct attribute_group *usb_device_groups[];
 177extern const struct attribute_group *usb_interface_groups[];
 178
 179/* usbfs stuff */
 180extern struct usb_driver usbfs_driver;
 181extern const struct file_operations usbfs_devices_fops;
 182extern const struct file_operations usbdev_file_operations;
 183extern void usbfs_conn_disc_event(void);
 184
 185extern int usb_devio_init(void);
 186extern void usb_devio_cleanup(void);
 187
 188/*
 189 * Firmware specific cookie identifying a port's location. '0' == no location
 190 * data available
 191 */
 192typedef u32 usb_port_location_t;
 193
 194/* internal notify stuff */
 195extern void usb_notify_add_device(struct usb_device *udev);
 196extern void usb_notify_remove_device(struct usb_device *udev);
 197extern void usb_notify_add_bus(struct usb_bus *ubus);
 198extern void usb_notify_remove_bus(struct usb_bus *ubus);
 199extern void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
 200                struct usb_hub_descriptor *desc);
 201
 202#ifdef CONFIG_ACPI
 203extern int usb_acpi_register(void);
 204extern void usb_acpi_unregister(void);
 205extern acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
 206        int port1);
 207#else
 208static inline int usb_acpi_register(void) { return 0; };
 209static inline void usb_acpi_unregister(void) { };
 210#endif
 211