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