xref: /openbmc/linux/drivers/usb/core/usb.h (revision 4f3db074)
1 #include <linux/pm.h>
2 #include <linux/acpi.h>
3 
4 struct usb_hub_descriptor;
5 struct usb_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_hub_wq(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_unbind_and_rebind_marked_interfaces(struct usb_device *udev);
59 
60 extern void usb_hub_release_all_ports(struct usb_device *hdev,
61 		struct usb_dev_state *owner);
62 extern bool usb_device_is_owned(struct usb_device *udev);
63 
64 extern int  usb_hub_init(void);
65 extern void usb_hub_cleanup(void);
66 extern int usb_major_init(void);
67 extern void usb_major_cleanup(void);
68 
69 #ifdef	CONFIG_PM
70 
71 extern int usb_suspend(struct device *dev, pm_message_t msg);
72 extern int usb_resume(struct device *dev, pm_message_t msg);
73 extern int usb_resume_complete(struct device *dev);
74 
75 extern int usb_port_suspend(struct usb_device *dev, pm_message_t msg);
76 extern int usb_port_resume(struct usb_device *dev, pm_message_t msg);
77 
78 extern void usb_autosuspend_device(struct usb_device *udev);
79 extern int usb_autoresume_device(struct usb_device *udev);
80 extern int usb_remote_wakeup(struct usb_device *dev);
81 extern int usb_runtime_suspend(struct device *dev);
82 extern int usb_runtime_resume(struct device *dev);
83 extern int usb_runtime_idle(struct device *dev);
84 extern int usb_set_usb2_hardware_lpm(struct usb_device *udev, int enable);
85 
86 #else
87 
88 static inline int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
89 {
90 	return 0;
91 }
92 
93 static inline int usb_port_resume(struct usb_device *udev, pm_message_t msg)
94 {
95 	return 0;
96 }
97 
98 #define usb_autosuspend_device(udev)		do {} while (0)
99 static inline int usb_autoresume_device(struct usb_device *udev)
100 {
101 	return 0;
102 }
103 
104 static inline int usb_set_usb2_hardware_lpm(struct usb_device *udev, int enable)
105 {
106 	return 0;
107 }
108 
109 #endif
110 
111 extern struct bus_type usb_bus_type;
112 extern struct mutex usb_port_peer_mutex;
113 extern struct device_type usb_device_type;
114 extern struct device_type usb_if_device_type;
115 extern struct device_type usb_ep_device_type;
116 extern struct device_type usb_port_device_type;
117 extern struct usb_device_driver usb_generic_driver;
118 
119 static inline int is_usb_device(const struct device *dev)
120 {
121 	return dev->type == &usb_device_type;
122 }
123 
124 static inline int is_usb_interface(const struct device *dev)
125 {
126 	return dev->type == &usb_if_device_type;
127 }
128 
129 static inline int is_usb_endpoint(const struct device *dev)
130 {
131 	return dev->type == &usb_ep_device_type;
132 }
133 
134 static inline int is_usb_port(const struct device *dev)
135 {
136 	return dev->type == &usb_port_device_type;
137 }
138 
139 /* Do the same for device drivers and interface drivers. */
140 
141 static inline int is_usb_device_driver(struct device_driver *drv)
142 {
143 	return container_of(drv, struct usbdrv_wrap, driver)->
144 			for_devices;
145 }
146 
147 /* for labeling diagnostics */
148 extern const char *usbcore_name;
149 
150 /* sysfs stuff */
151 extern const struct attribute_group *usb_device_groups[];
152 extern const struct attribute_group *usb_interface_groups[];
153 
154 /* usbfs stuff */
155 extern struct mutex usbfs_mutex;
156 extern struct usb_driver usbfs_driver;
157 extern const struct file_operations usbfs_devices_fops;
158 extern const struct file_operations usbdev_file_operations;
159 extern void usbfs_conn_disc_event(void);
160 
161 extern int usb_devio_init(void);
162 extern void usb_devio_cleanup(void);
163 
164 /*
165  * Firmware specific cookie identifying a port's location. '0' == no location
166  * data available
167  */
168 typedef u32 usb_port_location_t;
169 
170 /* internal notify stuff */
171 extern void usb_notify_add_device(struct usb_device *udev);
172 extern void usb_notify_remove_device(struct usb_device *udev);
173 extern void usb_notify_add_bus(struct usb_bus *ubus);
174 extern void usb_notify_remove_bus(struct usb_bus *ubus);
175 extern void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
176 		struct usb_hub_descriptor *desc);
177 
178 #ifdef CONFIG_ACPI
179 extern int usb_acpi_register(void);
180 extern void usb_acpi_unregister(void);
181 extern acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
182 	int port1);
183 #else
184 static inline int usb_acpi_register(void) { return 0; };
185 static inline void usb_acpi_unregister(void) { };
186 #endif
187