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