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