usb/core/usb.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 /*
0003  * Released under the GPLv2 only.
0004  */
0005
0006 #include <linux/pm.h>
0007 #include <linux/acpi.h>
0008
0009 struct usb_hub_descriptor;
0010 struct usb_dev_state;
0011
0012 /* Functions local to drivers/usb/core/ */
0013
0014 extern int usb_create_sysfs_dev_files(struct usb_device *dev);
0015 extern void usb_remove_sysfs_dev_files(struct usb_device *dev);
0016 extern void usb_create_sysfs_intf_files(struct usb_interface *intf);
0017 extern void usb_remove_sysfs_intf_files(struct usb_interface *intf);
0018 extern int usb_create_ep_devs(struct device *parent,
0019                 struct usb_host_endpoint *endpoint,
0020                 struct usb_device *udev);
0021 extern void usb_remove_ep_devs(struct usb_host_endpoint *endpoint);
0022
0023 extern void usb_enable_endpoint(struct usb_device *dev,
0024         struct usb_host_endpoint *ep, bool reset_toggle);
0025 extern void usb_enable_interface(struct usb_device *dev,
0026         struct usb_interface *intf, bool reset_toggles);
0027 extern void usb_disable_endpoint(struct usb_device *dev, unsigned int epaddr,
0028         bool reset_hardware);
0029 extern void usb_disable_interface(struct usb_device *dev,
0030         struct usb_interface *intf, bool reset_hardware);
0031 extern void usb_release_interface_cache(struct kref *ref);
0032 extern void usb_disable_device(struct usb_device *dev, int skip_ep0);
0033 extern int usb_deauthorize_device(struct usb_device *);
0034 extern int usb_authorize_device(struct usb_device *);
0035 extern void usb_deauthorize_interface(struct usb_interface *);
0036 extern void usb_authorize_interface(struct usb_interface *);
0037 extern void usb_detect_quirks(struct usb_device *udev);
0038 extern void usb_detect_interface_quirks(struct usb_device *udev);
0039 extern void usb_release_quirk_list(void);
0040 extern bool usb_endpoint_is_ignored(struct usb_device *udev,
0041         struct usb_host_interface *intf,
0042         struct usb_endpoint_descriptor *epd);
0043 extern int usb_remove_device(struct usb_device *udev);
0044
0045 extern int usb_get_device_descriptor(struct usb_device *dev,
0046         unsigned int size);
0047 extern int usb_set_isoch_delay(struct usb_device *dev);
0048 extern int usb_get_bos_descriptor(struct usb_device *dev);
0049 extern void usb_release_bos_descriptor(struct usb_device *dev);
0050 extern char *usb_cache_string(struct usb_device *udev, int index);
0051 extern int usb_set_configuration(struct usb_device *dev, int configuration);
0052 extern int usb_choose_configuration(struct usb_device *udev);
0053 extern int usb_generic_driver_probe(struct usb_device *udev);
0054 extern void usb_generic_driver_disconnect(struct usb_device *udev);
0055 extern int usb_generic_driver_suspend(struct usb_device *udev,
0056         pm_message_t msg);
0057 extern int usb_generic_driver_resume(struct usb_device *udev,
0058         pm_message_t msg);
0059
0060 static inline unsigned usb_get_max_power(struct usb_device *udev,
0061         struct usb_host_config *c)
0062 {
0063     /* SuperSpeed power is in 8 mA units; others are in 2 mA units */
0064     unsigned mul = (udev->speed >= USB_SPEED_SUPER ? 8 : 2);
0065
0066     return c->desc.bMaxPower * mul;
0067 }
0068
0069 extern void usb_kick_hub_wq(struct usb_device *dev);
0070 extern int usb_match_one_id_intf(struct usb_device *dev,
0071                  struct usb_host_interface *intf,
0072                  const struct usb_device_id *id);
0073 extern int usb_match_device(struct usb_device *dev,
0074                 const struct usb_device_id *id);
0075 extern const struct usb_device_id *usb_device_match_id(struct usb_device *udev,
0076                 const struct usb_device_id *id);
0077 extern bool usb_driver_applicable(struct usb_device *udev,
0078                   struct usb_device_driver *udrv);
0079 extern void usb_forced_unbind_intf(struct usb_interface *intf);
0080 extern void usb_unbind_and_rebind_marked_interfaces(struct usb_device *udev);
0081
0082 extern void usb_hub_release_all_ports(struct usb_device *hdev,
0083         struct usb_dev_state *owner);
0084 extern bool usb_device_is_owned(struct usb_device *udev);
0085
0086 extern int  usb_hub_init(void);
0087 extern void usb_hub_cleanup(void);
0088 extern int usb_major_init(void);
0089 extern void usb_major_cleanup(void);
0090 extern int usb_device_supports_lpm(struct usb_device *udev);
0091 extern int usb_port_disable(struct usb_device *udev);
0092
0093 #ifdef  CONFIG_PM
0094
0095 extern int usb_suspend(struct device *dev, pm_message_t msg);
0096 extern int usb_resume(struct device *dev, pm_message_t msg);
0097 extern int usb_resume_complete(struct device *dev);
0098
0099 extern int usb_port_suspend(struct usb_device *dev, pm_message_t msg);
0100 extern int usb_port_resume(struct usb_device *dev, pm_message_t msg);
0101
0102 extern void usb_autosuspend_device(struct usb_device *udev);
0103 extern int usb_autoresume_device(struct usb_device *udev);
0104 extern int usb_remote_wakeup(struct usb_device *dev);
0105 extern int usb_runtime_suspend(struct device *dev);
0106 extern int usb_runtime_resume(struct device *dev);
0107 extern int usb_runtime_idle(struct device *dev);
0108 extern int usb_enable_usb2_hardware_lpm(struct usb_device *udev);
0109 extern int usb_disable_usb2_hardware_lpm(struct usb_device *udev);
0110
0111 extern void usbfs_notify_suspend(struct usb_device *udev);
0112 extern void usbfs_notify_resume(struct usb_device *udev);
0113
0114 #else
0115
0116 static inline int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
0117 {
0118     return 0;
0119 }
0120
0121 static inline int usb_port_resume(struct usb_device *udev, pm_message_t msg)
0122 {
0123     return 0;
0124 }
0125
0126 #define usb_autosuspend_device(udev)        do {} while (0)
0127 static inline int usb_autoresume_device(struct usb_device *udev)
0128 {
0129     return 0;
0130 }
0131
0132 static inline int usb_enable_usb2_hardware_lpm(struct usb_device *udev)
0133 {
0134     return 0;
0135 }
0136
0137 static inline int usb_disable_usb2_hardware_lpm(struct usb_device *udev)
0138 {
0139     return 0;
0140 }
0141
0142 #endif
0143
0144 extern struct bus_type usb_bus_type;
0145 extern struct mutex usb_port_peer_mutex;
0146 extern struct device_type usb_device_type;
0147 extern struct device_type usb_if_device_type;
0148 extern struct device_type usb_ep_device_type;
0149 extern struct device_type usb_port_device_type;
0150 extern struct usb_device_driver usb_generic_driver;
0151
0152 static inline int is_usb_device(const struct device *dev)
0153 {
0154     return dev->type == &usb_device_type;
0155 }
0156
0157 static inline int is_usb_interface(const struct device *dev)
0158 {
0159     return dev->type == &usb_if_device_type;
0160 }
0161
0162 static inline int is_usb_endpoint(const struct device *dev)
0163 {
0164     return dev->type == &usb_ep_device_type;
0165 }
0166
0167 static inline int is_usb_port(const struct device *dev)
0168 {
0169     return dev->type == &usb_port_device_type;
0170 }
0171
0172 static inline int is_root_hub(struct usb_device *udev)
0173 {
0174     return (udev->parent == NULL);
0175 }
0176
0177 /* Do the same for device drivers and interface drivers. */
0178
0179 static inline int is_usb_device_driver(struct device_driver *drv)
0180 {
0181     return container_of(drv, struct usbdrv_wrap, driver)->
0182             for_devices;
0183 }
0184
0185 /* for labeling diagnostics */
0186 extern const char *usbcore_name;
0187
0188 /* sysfs stuff */
0189 extern const struct attribute_group *usb_device_groups[];
0190 extern const struct attribute_group *usb_interface_groups[];
0191
0192 /* usbfs stuff */
0193 extern struct usb_driver usbfs_driver;
0194 extern const struct file_operations usbfs_devices_fops;
0195 extern const struct file_operations usbdev_file_operations;
0196
0197 extern int usb_devio_init(void);
0198 extern void usb_devio_cleanup(void);
0199
0200 /*
0201  * Firmware specific cookie identifying a port's location. '0' == no location
0202  * data available
0203  */
0204 typedef u32 usb_port_location_t;
0205
0206 /* internal notify stuff */
0207 extern void usb_notify_add_device(struct usb_device *udev);
0208 extern void usb_notify_remove_device(struct usb_device *udev);
0209 extern void usb_notify_add_bus(struct usb_bus *ubus);
0210 extern void usb_notify_remove_bus(struct usb_bus *ubus);
0211 extern void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
0212         struct usb_hub_descriptor *desc);
0213
0214 #ifdef CONFIG_ACPI
0215 extern int usb_acpi_register(void);
0216 extern void usb_acpi_unregister(void);
0217 extern acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
0218     int port1);
0219 #else
0220 static inline int usb_acpi_register(void) { return 0; };
0221 static inline void usb_acpi_unregister(void) { };
0222 #endif