usb.h 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. /*
  3. * Released under the GPLv2 only.
  4. */
  5. #include <linux/pm.h>
  6. #include <linux/acpi.h>
  7. struct usb_hub_descriptor;
  8. struct usb_dev_state;
  9. /* Functions local to drivers/usb/core/ */
  10. extern int usb_create_sysfs_dev_files(struct usb_device *dev);
  11. extern void usb_remove_sysfs_dev_files(struct usb_device *dev);
  12. extern void usb_create_sysfs_intf_files(struct usb_interface *intf);
  13. extern void usb_remove_sysfs_intf_files(struct usb_interface *intf);
  14. extern int usb_create_ep_devs(struct device *parent,
  15. struct usb_host_endpoint *endpoint,
  16. struct usb_device *udev);
  17. extern void usb_remove_ep_devs(struct usb_host_endpoint *endpoint);
  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_deauthorize_interface(struct usb_interface *);
  31. extern void usb_authorize_interface(struct usb_interface *);
  32. extern void usb_detect_quirks(struct usb_device *udev);
  33. extern void usb_detect_interface_quirks(struct usb_device *udev);
  34. extern void usb_release_quirk_list(void);
  35. extern bool usb_endpoint_is_ignored(struct usb_device *udev,
  36. struct usb_host_interface *intf,
  37. struct usb_endpoint_descriptor *epd);
  38. extern int usb_remove_device(struct usb_device *udev);
  39. extern int usb_get_device_descriptor(struct usb_device *dev,
  40. unsigned int size);
  41. extern int usb_set_isoch_delay(struct usb_device *dev);
  42. extern int usb_get_bos_descriptor(struct usb_device *dev);
  43. extern void usb_release_bos_descriptor(struct usb_device *dev);
  44. extern char *usb_cache_string(struct usb_device *udev, int index);
  45. extern int usb_set_configuration(struct usb_device *dev, int configuration);
  46. extern int usb_choose_configuration(struct usb_device *udev);
  47. extern int usb_generic_driver_probe(struct usb_device *udev);
  48. extern void usb_generic_driver_disconnect(struct usb_device *udev);
  49. extern int usb_generic_driver_suspend(struct usb_device *udev,
  50. pm_message_t msg);
  51. extern int usb_generic_driver_resume(struct usb_device *udev,
  52. pm_message_t msg);
  53. static inline unsigned usb_get_max_power(struct usb_device *udev,
  54. struct usb_host_config *c)
  55. {
  56. /* SuperSpeed power is in 8 mA units; others are in 2 mA units */
  57. unsigned mul = (udev->speed >= USB_SPEED_SUPER ? 8 : 2);
  58. return c->desc.bMaxPower * mul;
  59. }
  60. extern void usb_kick_hub_wq(struct usb_device *dev);
  61. extern int usb_match_one_id_intf(struct usb_device *dev,
  62. struct usb_host_interface *intf,
  63. const struct usb_device_id *id);
  64. extern int usb_match_device(struct usb_device *dev,
  65. const struct usb_device_id *id);
  66. extern const struct usb_device_id *usb_device_match_id(struct usb_device *udev,
  67. const struct usb_device_id *id);
  68. extern bool usb_driver_applicable(struct usb_device *udev,
  69. struct usb_device_driver *udrv);
  70. extern void usb_forced_unbind_intf(struct usb_interface *intf);
  71. extern void usb_unbind_and_rebind_marked_interfaces(struct usb_device *udev);
  72. extern void usb_hub_release_all_ports(struct usb_device *hdev,
  73. struct usb_dev_state *owner);
  74. extern bool usb_device_is_owned(struct usb_device *udev);
  75. extern int usb_hub_init(void);
  76. extern void usb_hub_cleanup(void);
  77. extern int usb_major_init(void);
  78. extern void usb_major_cleanup(void);
  79. extern int usb_device_supports_lpm(struct usb_device *udev);
  80. extern int usb_port_disable(struct usb_device *udev);
  81. #ifdef CONFIG_PM
  82. extern int usb_suspend(struct device *dev, pm_message_t msg);
  83. extern int usb_resume(struct device *dev, pm_message_t msg);
  84. extern int usb_resume_complete(struct device *dev);
  85. extern int usb_port_suspend(struct usb_device *dev, pm_message_t msg);
  86. extern int usb_port_resume(struct usb_device *dev, pm_message_t msg);
  87. extern void usb_autosuspend_device(struct usb_device *udev);
  88. extern int usb_autoresume_device(struct usb_device *udev);
  89. extern int usb_remote_wakeup(struct usb_device *dev);
  90. extern int usb_runtime_suspend(struct device *dev);
  91. extern int usb_runtime_resume(struct device *dev);
  92. extern int usb_runtime_idle(struct device *dev);
  93. extern int usb_enable_usb2_hardware_lpm(struct usb_device *udev);
  94. extern int usb_disable_usb2_hardware_lpm(struct usb_device *udev);
  95. extern void usbfs_notify_suspend(struct usb_device *udev);
  96. extern void usbfs_notify_resume(struct usb_device *udev);
  97. #else
  98. static inline int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
  99. {
  100. return 0;
  101. }
  102. static inline int usb_port_resume(struct usb_device *udev, pm_message_t msg)
  103. {
  104. return 0;
  105. }
  106. #define usb_autosuspend_device(udev) do {} while (0)
  107. static inline int usb_autoresume_device(struct usb_device *udev)
  108. {
  109. return 0;
  110. }
  111. static inline int usb_enable_usb2_hardware_lpm(struct usb_device *udev)
  112. {
  113. return 0;
  114. }
  115. static inline int usb_disable_usb2_hardware_lpm(struct usb_device *udev)
  116. {
  117. return 0;
  118. }
  119. #endif
  120. extern struct bus_type usb_bus_type;
  121. extern struct mutex usb_port_peer_mutex;
  122. extern struct device_type usb_device_type;
  123. extern struct device_type usb_if_device_type;
  124. extern struct device_type usb_ep_device_type;
  125. extern struct device_type usb_port_device_type;
  126. extern struct usb_device_driver usb_generic_driver;
  127. static inline int is_usb_device(const struct device *dev)
  128. {
  129. return dev->type == &usb_device_type;
  130. }
  131. static inline int is_usb_interface(const struct device *dev)
  132. {
  133. return dev->type == &usb_if_device_type;
  134. }
  135. static inline int is_usb_endpoint(const struct device *dev)
  136. {
  137. return dev->type == &usb_ep_device_type;
  138. }
  139. static inline int is_usb_port(const struct device *dev)
  140. {
  141. return dev->type == &usb_port_device_type;
  142. }
  143. static inline int is_root_hub(struct usb_device *udev)
  144. {
  145. return (udev->parent == NULL);
  146. }
  147. /* Do the same for device drivers and interface drivers. */
  148. static inline int is_usb_device_driver(struct device_driver *drv)
  149. {
  150. return container_of(drv, struct usbdrv_wrap, driver)->
  151. for_devices;
  152. }
  153. /* for labeling diagnostics */
  154. extern const char *usbcore_name;
  155. /* sysfs stuff */
  156. extern const struct attribute_group *usb_device_groups[];
  157. extern const struct attribute_group *usb_interface_groups[];
  158. /* usbfs stuff */
  159. extern struct usb_driver usbfs_driver;
  160. extern const struct file_operations usbfs_devices_fops;
  161. extern const struct file_operations usbdev_file_operations;
  162. extern int usb_devio_init(void);
  163. extern void usb_devio_cleanup(void);
  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. /* internal notify stuff */
  170. extern void usb_notify_add_device(struct usb_device *udev);
  171. extern void usb_notify_remove_device(struct usb_device *udev);
  172. extern void usb_notify_add_bus(struct usb_bus *ubus);
  173. extern void usb_notify_remove_bus(struct usb_bus *ubus);
  174. extern void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
  175. struct usb_hub_descriptor *desc);
  176. #ifdef CONFIG_ACPI
  177. extern int usb_acpi_register(void);
  178. extern void usb_acpi_unregister(void);
  179. extern acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
  180. int port1);
  181. #else
  182. static inline int usb_acpi_register(void) { return 0; };
  183. static inline void usb_acpi_unregister(void) { };
  184. #endif