Merge branch 'core-objtool-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[linux-block.git] / drivers / usb / core / usb.h
CommitLineData
aa1f3bb5 1// SPDX-License-Identifier: GPL-2.0
b65fba3d
GKH
2/*
3 * Released under the GPLv2 only.
b65fba3d
GKH
4 */
5
65bfd296 6#include <linux/pm.h>
d5575424 7#include <linux/acpi.h>
65bfd296 8
d2123fd9 9struct usb_hub_descriptor;
9b6f0c4b 10struct usb_dev_state;
336c5c31 11
1da177e4
LT
12/* Functions local to drivers/usb/core/ */
13
84cca820
GKH
14extern int usb_create_sysfs_dev_files(struct usb_device *dev);
15extern void usb_remove_sysfs_dev_files(struct usb_device *dev);
643de624 16extern void usb_create_sysfs_intf_files(struct usb_interface *intf);
84cca820 17extern void usb_remove_sysfs_intf_files(struct usb_interface *intf);
3b23dd6f 18extern int usb_create_ep_devs(struct device *parent,
84cca820 19 struct usb_host_endpoint *endpoint,
84412f62 20 struct usb_device *udev);
3b23dd6f 21extern void usb_remove_ep_devs(struct usb_host_endpoint *endpoint);
1da177e4 22
bdd016ba 23extern void usb_enable_endpoint(struct usb_device *dev,
2caf7fcd
AS
24 struct usb_host_endpoint *ep, bool reset_toggle);
25extern void usb_enable_interface(struct usb_device *dev,
26 struct usb_interface *intf, bool reset_toggles);
ddeac4e7
AS
27extern void usb_disable_endpoint(struct usb_device *dev, unsigned int epaddr,
28 bool reset_hardware);
84cca820 29extern void usb_disable_interface(struct usb_device *dev,
ddeac4e7 30 struct usb_interface *intf, bool reset_hardware);
1da177e4 31extern void usb_release_interface_cache(struct kref *ref);
84cca820
GKH
32extern void usb_disable_device(struct usb_device *dev, int skip_ep0);
33extern int usb_deauthorize_device(struct usb_device *);
34extern int usb_authorize_device(struct usb_device *);
b3910cef
SK
35extern void usb_deauthorize_interface(struct usb_interface *);
36extern void usb_authorize_interface(struct usb_interface *);
7ceec1f1 37extern void usb_detect_quirks(struct usb_device *udev);
80da2e0d 38extern void usb_detect_interface_quirks(struct usb_device *udev);
027bd6ca 39extern void usb_release_quirk_list(void);
73f8bda9
JH
40extern bool usb_endpoint_is_blacklisted(struct usb_device *udev,
41 struct usb_host_interface *intf,
42 struct usb_endpoint_descriptor *epd);
253e0572 43extern int usb_remove_device(struct usb_device *udev);
1da177e4
LT
44
45extern int usb_get_device_descriptor(struct usb_device *dev,
46 unsigned int size);
886ee36e 47extern int usb_set_isoch_delay(struct usb_device *dev);
3148bf04
AX
48extern int usb_get_bos_descriptor(struct usb_device *dev);
49extern void usb_release_bos_descriptor(struct usb_device *dev);
4f62efe6 50extern char *usb_cache_string(struct usb_device *udev, int index);
1da177e4 51extern int usb_set_configuration(struct usb_device *dev, int configuration);
b5ea060f 52extern int usb_choose_configuration(struct usb_device *udev);
ef0f7d18
BN
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);
1da177e4 59
8d8479db
SAS
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 */
8a1b2725 64 unsigned mul = (udev->speed >= USB_SPEED_SUPER ? 8 : 2);
8d8479db
SAS
65
66 return c->desc.bMaxPower * mul;
67}
68
59d48b3f 69extern void usb_kick_hub_wq(struct usb_device *dev);
80da2e0d
LP
70extern int usb_match_one_id_intf(struct usb_device *dev,
71 struct usb_host_interface *intf,
72 const struct usb_device_id *id);
bb417020
GKH
73extern int usb_match_device(struct usb_device *dev,
74 const struct usb_device_id *id);
aeebf2b5
BN
75extern const struct usb_device_id *usb_device_match_id(struct usb_device *udev,
76 const struct usb_device_id *id);
78d9a487 77extern void usb_forced_unbind_intf(struct usb_interface *intf);
6aec044c 78extern void usb_unbind_and_rebind_marked_interfaces(struct usb_device *udev);
1da177e4 79
336c5c31 80extern void usb_hub_release_all_ports(struct usb_device *hdev,
9b6f0c4b 81 struct usb_dev_state *owner);
7cbe5dca
AS
82extern bool usb_device_is_owned(struct usb_device *udev);
83
6d5e8254
GK
84extern int usb_hub_init(void);
85extern void usb_hub_cleanup(void);
86extern int usb_major_init(void);
87extern void usb_major_cleanup(void);
2d2a3167 88extern int usb_device_supports_lpm(struct usb_device *udev);
8dd8d2c9 89extern int usb_port_disable(struct usb_device *udev);
6d5e8254 90
d388dab7
AS
91#ifdef CONFIG_PM
92
f2189c47 93extern int usb_suspend(struct device *dev, pm_message_t msg);
65bfd296 94extern int usb_resume(struct device *dev, pm_message_t msg);
98d9a82e 95extern int usb_resume_complete(struct device *dev);
f2189c47 96
65bfd296
AS
97extern int usb_port_suspend(struct usb_device *dev, pm_message_t msg);
98extern int usb_port_resume(struct usb_device *dev, pm_message_t msg);
e0318ebf 99
ceb6c9c8
RW
100extern void usb_autosuspend_device(struct usb_device *udev);
101extern int usb_autoresume_device(struct usb_device *udev);
102extern int usb_remote_wakeup(struct usb_device *dev);
103extern int usb_runtime_suspend(struct device *dev);
104extern int usb_runtime_resume(struct device *dev);
105extern int usb_runtime_idle(struct device *dev);
7529b257
KHF
106extern int usb_enable_usb2_hardware_lpm(struct usb_device *udev);
107extern int usb_disable_usb2_hardware_lpm(struct usb_device *udev);
ceb6c9c8 108
7794f486
AS
109extern void usbfs_notify_suspend(struct usb_device *udev);
110extern void usbfs_notify_resume(struct usb_device *udev);
111
d388dab7
AS
112#else
113
65bfd296 114static inline int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
4956eccd
AS
115{
116 return 0;
117}
118
65bfd296 119static inline int usb_port_resume(struct usb_device *udev, pm_message_t msg)
4956eccd
AS
120{
121 return 0;
122}
123
19c26239 124#define usb_autosuspend_device(udev) do {} while (0)
94fcda1f 125static inline int usb_autoresume_device(struct usb_device *udev)
e0318ebf
AS
126{
127 return 0;
128}
645daaab 129
7529b257
KHF
130static inline int usb_enable_usb2_hardware_lpm(struct usb_device *udev)
131{
132 return 0;
133}
134
135static inline int usb_disable_usb2_hardware_lpm(struct usb_device *udev)
65580b43
AX
136{
137 return 0;
138}
ceb6c9c8 139
645daaab
AS
140#endif
141
36e56a34 142extern struct bus_type usb_bus_type;
d8521afe 143extern struct mutex usb_port_peer_mutex;
9f8b17e6
KS
144extern struct device_type usb_device_type;
145extern struct device_type usb_if_device_type;
55129666 146extern struct device_type usb_ep_device_type;
d5575424 147extern struct device_type usb_port_device_type;
8bb54ab5
AS
148extern struct usb_device_driver usb_generic_driver;
149
095bc335 150static inline int is_usb_device(const struct device *dev)
8bb54ab5 151{
9f8b17e6 152 return dev->type == &usb_device_type;
8bb54ab5
AS
153}
154
55129666
KS
155static inline int is_usb_interface(const struct device *dev)
156{
157 return dev->type == &usb_if_device_type;
158}
159
160static inline int is_usb_endpoint(const struct device *dev)
161{
162 return dev->type == &usb_ep_device_type;
163}
164
d5575424
LT
165static inline int is_usb_port(const struct device *dev)
166{
167 return dev->type == &usb_port_device_type;
168}
169
27709ae4
TW
170static inline int is_root_hub(struct usb_device *udev)
171{
172 return (udev->parent == NULL);
173}
174
8bb54ab5
AS
175/* Do the same for device drivers and interface drivers. */
176
177static inline int is_usb_device_driver(struct device_driver *drv)
178{
179 return container_of(drv, struct usbdrv_wrap, driver)->
180 for_devices;
181}
5edbfb7c 182
1da177e4
LT
183/* for labeling diagnostics */
184extern const char *usbcore_name;
185
2e5f10e4 186/* sysfs stuff */
a4dbd674
DB
187extern const struct attribute_group *usb_device_groups[];
188extern const struct attribute_group *usb_interface_groups[];
2e5f10e4 189
1da177e4
LT
190/* usbfs stuff */
191extern struct usb_driver usbfs_driver;
066202dd 192extern const struct file_operations usbfs_devices_fops;
9f8b17e6 193extern const struct file_operations usbdev_file_operations;
1da177e4
LT
194extern void usbfs_conn_disc_event(void);
195
9f8b17e6
KS
196extern int usb_devio_init(void);
197extern void usb_devio_cleanup(void);
6d5e8254 198
3bfd659b
DW
199/*
200 * Firmware specific cookie identifying a port's location. '0' == no location
201 * data available
202 */
203typedef u32 usb_port_location_t;
204
3099e75a
GKH
205/* internal notify stuff */
206extern void usb_notify_add_device(struct usb_device *udev);
207extern void usb_notify_remove_device(struct usb_device *udev);
208extern void usb_notify_add_bus(struct usb_bus *ubus);
209extern void usb_notify_remove_bus(struct usb_bus *ubus);
d2123fd9
LT
210extern void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
211 struct usb_hub_descriptor *desc);
3099e75a 212
da0af6e7
MG
213#ifdef CONFIG_ACPI
214extern int usb_acpi_register(void);
215extern void usb_acpi_unregister(void);
d5575424
LT
216extern acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
217 int port1);
da0af6e7
MG
218#else
219static inline int usb_acpi_register(void) { return 0; };
220static inline void usb_acpi_unregister(void) { };
221#endif