xref: /openbmc/linux/drivers/usb/core/usb.h (revision 95298d63)
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_blacklisted(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 char *usb_cache_string(struct usb_device *udev, int index);
51 extern int usb_set_configuration(struct usb_device *dev, int configuration);
52 extern int usb_choose_configuration(struct usb_device *udev);
53 extern int usb_generic_driver_probe(struct usb_device *udev);
54 extern void usb_generic_driver_disconnect(struct usb_device *udev);
55 extern int usb_generic_driver_suspend(struct usb_device *udev,
56 		pm_message_t msg);
57 extern int usb_generic_driver_resume(struct usb_device *udev,
58 		pm_message_t msg);
59 
60 static inline unsigned usb_get_max_power(struct usb_device *udev,
61 		struct usb_host_config *c)
62 {
63 	/* SuperSpeed power is in 8 mA units; others are in 2 mA units */
64 	unsigned mul = (udev->speed >= USB_SPEED_SUPER ? 8 : 2);
65 
66 	return c->desc.bMaxPower * mul;
67 }
68 
69 extern void usb_kick_hub_wq(struct usb_device *dev);
70 extern int usb_match_one_id_intf(struct usb_device *dev,
71 				 struct usb_host_interface *intf,
72 				 const struct usb_device_id *id);
73 extern int usb_match_device(struct usb_device *dev,
74 			    const struct usb_device_id *id);
75 extern const struct usb_device_id *usb_device_match_id(struct usb_device *udev,
76 				const struct usb_device_id *id);
77 extern void usb_forced_unbind_intf(struct usb_interface *intf);
78 extern void usb_unbind_and_rebind_marked_interfaces(struct usb_device *udev);
79 
80 extern void usb_hub_release_all_ports(struct usb_device *hdev,
81 		struct usb_dev_state *owner);
82 extern bool usb_device_is_owned(struct usb_device *udev);
83 
84 extern int  usb_hub_init(void);
85 extern void usb_hub_cleanup(void);
86 extern int usb_major_init(void);
87 extern void usb_major_cleanup(void);
88 extern int usb_device_supports_lpm(struct usb_device *udev);
89 extern int usb_port_disable(struct usb_device *udev);
90 
91 #ifdef	CONFIG_PM
92 
93 extern int usb_suspend(struct device *dev, pm_message_t msg);
94 extern int usb_resume(struct device *dev, pm_message_t msg);
95 extern int usb_resume_complete(struct device *dev);
96 
97 extern int usb_port_suspend(struct usb_device *dev, pm_message_t msg);
98 extern int usb_port_resume(struct usb_device *dev, pm_message_t msg);
99 
100 extern void usb_autosuspend_device(struct usb_device *udev);
101 extern int usb_autoresume_device(struct usb_device *udev);
102 extern int usb_remote_wakeup(struct usb_device *dev);
103 extern int usb_runtime_suspend(struct device *dev);
104 extern int usb_runtime_resume(struct device *dev);
105 extern int usb_runtime_idle(struct device *dev);
106 extern int usb_enable_usb2_hardware_lpm(struct usb_device *udev);
107 extern int usb_disable_usb2_hardware_lpm(struct usb_device *udev);
108 
109 extern void usbfs_notify_suspend(struct usb_device *udev);
110 extern void usbfs_notify_resume(struct usb_device *udev);
111 
112 #else
113 
114 static inline int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
115 {
116 	return 0;
117 }
118 
119 static inline int usb_port_resume(struct usb_device *udev, pm_message_t msg)
120 {
121 	return 0;
122 }
123 
124 #define usb_autosuspend_device(udev)		do {} while (0)
125 static inline int usb_autoresume_device(struct usb_device *udev)
126 {
127 	return 0;
128 }
129 
130 static inline int usb_enable_usb2_hardware_lpm(struct usb_device *udev)
131 {
132 	return 0;
133 }
134 
135 static inline int usb_disable_usb2_hardware_lpm(struct usb_device *udev)
136 {
137 	return 0;
138 }
139 
140 #endif
141 
142 extern struct bus_type usb_bus_type;
143 extern struct mutex usb_port_peer_mutex;
144 extern struct device_type usb_device_type;
145 extern struct device_type usb_if_device_type;
146 extern struct device_type usb_ep_device_type;
147 extern struct device_type usb_port_device_type;
148 extern struct usb_device_driver usb_generic_driver;
149 
150 static inline int is_usb_device(const struct device *dev)
151 {
152 	return dev->type == &usb_device_type;
153 }
154 
155 static inline int is_usb_interface(const struct device *dev)
156 {
157 	return dev->type == &usb_if_device_type;
158 }
159 
160 static inline int is_usb_endpoint(const struct device *dev)
161 {
162 	return dev->type == &usb_ep_device_type;
163 }
164 
165 static inline int is_usb_port(const struct device *dev)
166 {
167 	return dev->type == &usb_port_device_type;
168 }
169 
170 static inline int is_root_hub(struct usb_device *udev)
171 {
172 	return (udev->parent == NULL);
173 }
174 
175 /* Do the same for device drivers and interface drivers. */
176 
177 static inline int is_usb_device_driver(struct device_driver *drv)
178 {
179 	return container_of(drv, struct usbdrv_wrap, driver)->
180 			for_devices;
181 }
182 
183 /* for labeling diagnostics */
184 extern const char *usbcore_name;
185 
186 /* sysfs stuff */
187 extern const struct attribute_group *usb_device_groups[];
188 extern const struct attribute_group *usb_interface_groups[];
189 
190 /* usbfs stuff */
191 extern struct usb_driver usbfs_driver;
192 extern const struct file_operations usbfs_devices_fops;
193 extern const struct file_operations usbdev_file_operations;
194 extern void usbfs_conn_disc_event(void);
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