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