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